24
24
<holder>Urs Fleisch</holder>
26
26
<legalnotice>&FDLNotice;</legalnotice>
28
<date>25/07/2004</date>
29
<releaseinfo>0.5</releaseinfo>
28
<date>18/10/2005</date>
29
<releaseinfo>0.6</releaseinfo>
33
33
&kid3; is an application to edit the ID3v1 and ID3v2 tags in MP3 files in
34
an efficient way. It is easy to set tags of multiple files to the same
34
an efficient way. Also tags in Ogg/Vorbis and FLAC files are supported.
35
It is easy to set tags of multiple files to the same
35
36
values (e.g. album, artist, year and genre in all files of the same album) and
36
37
generate the tags from the file name or vice versa.
55
59
&kid3; is an application to edit the ID3v1 and ID3v2 tags in MP3 files in
56
60
an efficient way. These tags can be edited by most MP3 players, but not in
57
a very comfortable and efficient way.
61
a very comfortable and efficient way. Moreover the tags in Ogg/Vorbis and FLAC
62
files are supported too.
60
65
&kid3; does not grab, encode nor play
79
84
The tag information for full albums can be taken from
80
<ulink url="http://freedb.org">freedb.org</ulink> or other sources of
85
<ulink url="http://freedb.org">freedb.org</ulink>, <ulink
86
url="http://musicbrainz.org">MusicBrainz</ulink> or other sources of
81
87
track lists. The import format is freely configurable by regular expressions.
95
101
<listitem><para>Edit all ID3v2.3 frames</para></listitem>
96
102
<listitem><para>Edit tags of multiple files</para></listitem>
97
103
<listitem><para>Convert between ID3v1.1 and ID3v2.3 tags</para></listitem>
104
<listitem><para>Edit Ogg/Vorbis tags</para></listitem>
105
<listitem><para>Edit FLAC tags</para></listitem>
98
106
<listitem><para>Generate tags from filename</para></listitem>
99
107
<listitem><para>Generate filename from tags</para></listitem>
100
108
<listitem><para>Generate and change directory names from tags</para></listitem>
101
109
<listitem><para>Generate playlist file</para></listitem>
102
110
<listitem><para>Automatic case conversion and string translation</para></listitem>
103
<listitem><para>Import from <ulink url="http://freedb.org">freedb.org</ulink>
111
<listitem><para>Import from <ulink url="http://freedb.org">freedb.org</ulink>,
112
<ulink url="http://musicbrainz.org">MusicBrainz</ulink>
104
113
and other data sources</para></listitem>
159
168
<title>The GUI Elements</title>
161
The &kid3; GUI is separated in four sections: At the left is the file
162
listbox, the right side contains the <guilabel>Filename</guilabel>,
170
The &kid3; GUI is separated in five sections: At the left are the file
171
and directory listboxes, the right side contains the <guilabel>Filename</guilabel>,
163
172
<guilabel>ID3v1.1</guilabel> and <guilabel>ID3v2.3</guilabel> sections.
171
180
The file list contains the names of all the files in the opened
172
181
directory which match the selected file name filter (typically
173
<filename>*.mp3</filename>). A single or multiple files can be selected. To
182
<filename>*.mp3 *.ogg *.flac</filename>). A single or multiple files can be selected. To
174
183
select no file, click into the empty area after the listbox entries. The
175
184
selection determines the files which are affected by the operations which
176
185
are available by using the buttons described below.
195
<varlistentry><term>Directory List</term>
198
The directory list contains the names of the directories in the opened
199
directory, as well as the current (<filename>.</filename>) and the parent
200
(<filename>..</filename>) directory. It allows to quickly change the directory
201
without using the <guimenuitem>Open...</guimenuitem> command or drag and drop.
187
207
<term><guilabel>Filename</guilabel></term>
233
This format is also used to generate the tags from the filename. If the format
234
of the filename does not match this pattern, a few other commonly used formats
213
239
Some commonly used filename formats are already available in the combo box,
214
240
but it is also possible to type in some special format into the line edit.
227
<guibutton>Info</guibutton>: Shows information about MPEG version and layer,
253
<guibutton>Info</guibutton>: Shows information about the encoding (MP3, Ogg, FLAC),
228
254
bitrate, sample rate, channels and the length of the file.
254
280
an empty selected value for the <guilabel>Genre</guilabel>
255
281
combo box. The values can be changed and if the corresponding check box is
256
282
checked, they will be set for the selected file after the selection is
257
changed. The file is then marked as modified by an asterisk in the file
283
changed. The file is then marked as modified by a disk symbol in the file
258
284
listbox but remains unchanged until the <guimenuitem>Save</guimenuitem>
268
294
<guimenuitem>Save</guimenuitem> command.
297
The check boxes also control the operation of most commands affecting the
298
tags, such as copy, paste and transfer between V1 and V2 tags. To make it
299
easier to use with multiple files where all check boxes are unchecked, these
300
commands behave in the same way when all check boxes are checked and when all
301
check boxes are unchecked.
271
304
<guibutton>From Filename</guibutton>: The tags are set from the filename.
272
The filename should be in one of the supported formats:
305
First, the format specified in <guilabel>Format</guilabel> is used. If the
306
existing filename does not match this format, the following formats
274
<listitem><para><filename>Artist - Album/Track Song.mp3</filename></para></listitem>
275
<listitem><para><filename>Album/Track - Artist - Song.mp3</filename></para></listitem>
276
<listitem><para><filename>/Artist - Album - Track - Song.mp3</filename></para></listitem>
277
<listitem><para><filename>Album/Artist - Track - Song.mp3</filename></para></listitem>
278
<listitem><para><filename>Album/Artist - Song.mp3</filename></para></listitem>
309
<listitem><para><filename>Artist - Album/Track Song</filename></para></listitem>
310
<listitem><para><filename>Album/Track - Artist - Song</filename></para></listitem>
311
<listitem><para><filename>/Artist - Album - Track - Song</filename></para></listitem>
312
<listitem><para><filename>Album/Artist - Track - Song</filename></para></listitem>
313
<listitem><para><filename>Album/Artist - Song</filename></para></listitem>
314
<listitem><para><filename>Artist/Album/Track Song</filename></para></listitem>
280
316
If a single file is selected, the GUI controls are filled with the values
281
extraced from the filename. If multiple files are selected, the tags of the
317
extracted from the filename. If multiple files are selected, the tags of the
282
318
files are directly set according to the filenames.
388
424
<guimenuitem>Import...</guimenuitem>
389
425
</menuchoice></term>
390
426
<listitem><para>The <action>Import dialog</action> can be used to import data
391
directly from a freedb.org server, from the
392
Web-interface of <ulink url="http://freedb.org">freedb.org</ulink> or other
427
directly from a freedb.org server, from the Web-interface of <ulink
428
url="http://freedb.org">freedb.org</ulink>, from a MusicBrainz server or other
393
429
sources of album track lists in textual format.
410
446
<guibutton>OK</guibutton>.
449
Import from a MusicBrainz server is possible using the dialog which appears when
450
<guibutton>From MusicBrainz</guibutton> is selected. Server and proxy can be
451
selected as in the freedb import dialog. Below is a table displaying the
452
imported track data. The right column shows the state of the MusicBrainz
453
query, which starts with "Pending" when the dialog is opened. Then the TRM
454
fingerprint is looked up and if it does not yield a result, another lookup
455
using the tags in the file is tried. Thus it can be helpful for a successful
456
MusicBrainz query to store known information (e.g. artist and album) in the
457
tags before the import. If a result was found, the search ends in the state
458
"Recognized", otherwise nothing was found or multiple ambiguous results and one
459
of them has to be selected by the user.
460
<guibutton>OK</guibutton> and <guibutton>Apply</guibutton> use the imported
461
data, <guibutton>Cancel</guibutton> closes the dialog. The closing can take a
462
while since the whole MusicBrainz machinery has to be shut down.
413
465
For the import of textual data, several preconfigured import formats are
414
466
available. The first, "freedb HTML
415
467
text", can be used to copy information from an HTML page of
441
493
from the start of the document to the end to get track data, usually number
442
494
and title. The regular expressions include all the features offered by Qt,
443
495
which is most of the what Perl offers. Bracketing constructs "(..)" create
444
capture buffers for the fields to import and are preceeded by &kid3; specific
496
capture buffers for the fields to import and are preceded by &kid3; specific
445
497
codes to specify which field to capture. The codes are the same as used for
446
498
the filename format:
471
523
duration of the imported tracks can be compared with the duration of the
472
524
files. This option can be enabled with the checkbox <guibutton>Check maximum
473
525
allowable time difference</guibutton> and the maximum tolerated difference in
474
time can be set in seconds. If a mismatch in a length or in the number of
475
tracks is detected, it will be reported and the import can be canceled.
526
time can be set in seconds. If a mismatch in a length is detected, the length
527
is displayed with a red background in the preview table.
484
536
</menuchoice></term>
485
537
<listitem><para><action>Creates an M3U playlist.</action> The file will be stored in
486
538
the opened directory and have the same name as the directory, followed by
487
an .m3u extension. The file simly contains the names of the files displayed
539
an .m3u extension. The file simply contains the names of the files displayed
488
540
in the file listbox, no special EXTM3U or EXTINFO lines are generated.
489
541
If all files of an album are stored in a separate directory, this function
490
542
can be used to generate a playlist for an album.</para></listitem>
591
643
<guimenu>Settings</guimenu>
592
644
<guimenuitem>Configure Kid3...</guimenuitem>
593
645
</menuchoice></term>
594
<listitem><para>Opens the <action>configuration dialog</action>, which is used
646
<listitem><para>Opens the <action>configuration dialog</action>, which
647
consists of two pages, one for general settings and one, which is used
595
648
to set the format for the strings in the tag fields and the filename.
651
On the page <guilabel>General</guilabel> the check box <guilabel>Preserve file
652
timestamp</guilabel> can be marked to preserve the file modification time
653
stamp. The check box <guilabel>Use track/total number of tracks
654
format</guilabel> controls whether the track number field of ID3v2 tags
655
contains simply the track number or additionally the total number of tracks in
656
the directory. The combo box <guilabel>Comment Field Name</guilabel> is only
657
relevant for Ogg/Vorbis and FLAC files and sets the name of the field used for
658
comments. Different applications seem to use different names, "COMMENT" for
659
instance is used by xmms, whereas amaroK uses "DESCRIPTION".
660
The <guilabel>Context Menu Commands</guilabel> table contains the commands
661
which can be used from the context menu of the file list. For critical
662
operations such as deleting files, it is advisable to mark
663
<guilabel>Confirm</guilabel> to pop up a confirmation dialog before executing
664
the command. To add and delete entries in this table, a context menu can be
668
The page <guilabel>Format</guilabel> contains options for the format of
598
670
When <guilabel>Format while editing</guilabel> is checked, the format
599
671
configuration is automatically used while editing text in the line edits. The
600
672
format can be set separately for filenames and ID3 tags.
702
774
<ulink url="http://www.trolltech.com/qt/">Qt</ulink>. <ulink
703
775
url="http://www.kde.org">KDE</ulink> is recommended but not necessary, as
704
776
&kid3; can also be compiled as a Qt application. &kid3; can be compiled for
705
systems where these libraries are available, e.g. for Linux and Windows.
777
systems where these libraries are available, e.g. for GNU/Linux and Windows.
778
To tag Ogg/Vorbis files, libogg, libvorbis and libvorbisfile are
779
required, for FLAC files libFLAC++ and libFLAC. For MusicBrainz support,
780
libtunepimp is used. As there does not exist a tunepimp SDK for Windows at the
781
moment, the Windows version is compiled without MusicBrainz import.
708
784
&kid3; was tested with
720
796
Qt 3.1.x, Qt 3.2.x, Qt 3.3.2
723
Windows NT 4.0: id3lib 3.8.0, id3lib 3.8.2, id3lib 3.8.3, non-commercial Qt version 2.3.0.
799
Debian GNU/Linux 3.1: id3lib 3.8.3, KDE 3.3.2, Qt 3.3.4, libvorbis 1.1.0,
800
libogg 1.1.2, libflac++ 1.1.1, libtunepimp 0.3.0
803
Ubuntu 5.10: id3lib 3.8.3, KDE 3.4.3, Qt 3.3.4, libvorbis 1.1.0,
804
libogg 1.1.2, libflac++ 1.1.2, libtunepimp 0.3.0
807
Windows NT 4.0: id3lib 3.8.0, id3lib 3.8.2, id3lib 3.8.3, non-commercial Qt version 2.3.0
810
Windows 2000, XP: id3lib 3.8.3, non-commercial Qt Version 2.3.0,
811
non-commercial Qt Version 3.2.1, libvorbis 1.1.0, libogg 1.1.2, FLAC 1.1.2
added
removed
doc/en/index.docbook
