3 abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format.
8 Ordinarily, the process of grabbing the data off a CD and encoding it, then
9 tagging or commenting it, is very involved.
11 is designed to automate this. It will take an entire CD and convert it into
12 a compressed audio format - Ogg/Vorbis, MPEG Audio Layer III, Free Lossless
13 Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack) and/or M4A (AAC) format(s).
14 With one command, it will:
17 Do a CDDB or Musicbrainz query over the Internet to look up your CD or use a locally stored CDDB entry
20 Grab an audio track (or all the audio CD tracks) from your CD
23 Normalize the volume of the individual file (or the album as a single unit)
26 Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) and/or M4A format(s), all in one CD read
29 Comment or ID3/ID3v2 tag
32 Give an intelligible filename
35 Calculate replaygain values for the individual file (or the album as a single unit)
38 Delete the intermediate WAV file (or save it for later use)
45 can also grab a CD and turn it into a single FLAC file with an embedded
46 cuesheet which can be user later on as a source for other formats, and will be
47 treated as if it was the original CD. In a way,
49 can take a compressed backup of your CD collection.
53 Encode the whole CD in a single file. The resulting file uses the CD title
54 for tagging. If the resulting format is a flac file with an embedded cuesheet,
55 the file can be used as a source for creating other formats. Use "\-1 \-o
56 flac \-a default,cue" for obtaining such a file.
59 Comma-delimited list of actions to perform. Can be one or more of: cddb, cue,
60 read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize and
61 encode imply read. Tag implies cddb, read, encode. Move implies cddb, read,
62 encode, tag. Replaygain implies cddb, read, encode, tag and move. Playlist
63 implies cddb. The default is to do all actions except cue, normalize,
64 replaygain and playlist.
67 Enable batch mode normalization. See the BATCHNORM configuration variable.
70 Disable batch mode replaygain. It processes file by file to add the replaygain
71 information. See the NOBATCHREPLAYGAIN configuration variable.
74 Specifies an additional configuration file to parse. Configuration options
75 in this file override those in \fI/etc/abcde.conf\fR or \fI$HOME/.abcde.conf\fR.
78 Allows you to resume a session for
80 when you no longer have the CD available (\fBabcde\fR will automatically resume if
81 you still have the CD in the drive). You must have already finished at
82 least the "read" action during the previous session.
84 .B \-d [devicename | filename]
85 CD\-ROM block device that contains audio tracks to be read. Alternatively, a
86 single-track flac file with embedded cuesheet.
89 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
93 Erase information about encoded tracks from the internal status file, to enable
94 other encodings if the wav files have been kept.
97 Force the removal of the temporary ABCDETEMPDIR directory, even when we have
98 not finished. For example, one can read and encode several formats, including
99 \'.ogg\', and later on execute a \'move\' action with only one of the given
100 formats. On a normal situation it would erase the rest of those encoded
101 formats. In this case, \fBabcde\fR will refuse to execute such command, except if \-f
105 Enable lame's \-\-nogap option. See the NOGAP variable. WARNING: lame's
106 \-\-nogap disables the Xing mp3 tag. This tag is required for mp3 players to
107 correctly display track lengths when playing variable-bit-rate mp3 files.
110 Get help information.
113 Start [number] encoder processes at once. Useful for SMP systems. Overrides
114 the MAXPROCS configuration variable. Set it to "0" when using \fBdistmp3\fR to avoid
115 local encoding processes.
118 Keep the wav files after encoding.
121 Use the low-diskspace algorithm. See the LOWDISK configuration variable.
124 Use a local CDDB repository. See CDDBLOCALDIR variable.
127 Do not query CDDB database. Create and use a template. Edit the template to
128 provide song names, artist(s), ...
131 Non interactive mode. Do not ask anything from the user. Just go ahead.
134 Create DOS-style playlists, modifying the resulting one by adding CRLF line
135 endings. Some hardware players insist on having those to work.
137 .B \-o [filetype][:filetypeoptions]
138 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
139 "m4a" or "wav". Specify a comma-delimited list of output types to obtain all
140 specified types. See the OUTPUTTYPE configuration variable. One can pass
141 options to the encoder for a specific filetype on the command line separating
142 them with a colon. The options must be escaped with double-quotes.
145 Pads track numbers with 0\'s.
148 Use Unix PIPES to read and encode in one step. It disables multiple encodings,
149 since the WAV audio file is never stored in the disc.
152 Use a pre-defined quality level for the encoding process. Defined as low,
153 medium or high. The "medium" value is used to reset the default values if other
154 are used in the config file(s).
157 Remote encode on this comma-delimited list of machines using \fBdistmp3\fR. See
158 the REMOTEHOSTS configuration variable.
161 When CDDBLOCALDIR and CDDBUSELOCAL are defined, search recursively under the
162 defined directory for matches of the CDDB entry.
165 List, separated by commas, the fields to be shown in the CDDB parsed entries.
166 Right now it only uses "year" and "genre".
169 Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
170 and both the program and device must support the capability.
173 Start the numbering of the tracks at a given number. It only affects the
174 filenames and the playlist. Internal (tag) numbering remains the same.
177 Same as \-t but changes also the internal (tag) numbering. Keep in mind that
178 the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
181 Set CDDBPROTO to version 5, so that we retrieve ISO-8859-15 encoded CDDB
182 information, and we tag and add comments with Latin1 encoding.
185 Show the version and exit
188 Be a bit more verbose. On slow networks the CDDB requests might give the
189 sensation nothing is happening.
192 Eject the CD when all tracks have been read. See the EJECTCD configuration
196 Use an alternative "cue2discid" implementation. The name of the binary must be
197 exactly that. \fBabcde\fR comes with an implementation in python under the examples
198 directory. The special keyword "builtin" forces the usage of the internal
199 (default) implementation in shell script.
202 Add a comment to the tracks ripped from the CD.
205 Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
206 to modify the numbering of the tracks, starting with "#01". For Ogg/Vorbis and
207 FLAC files, it also defines a DISCNUMBER tag.
210 DEBUG mode: it will rip, using \fBcdparanoia\fR, the very first second of each track
211 and proceed with the actions requested very quickly, also providing some
212 "hidden" information about what happens on the background. CAUTION: IT WILL
213 ERASE ANY EXISTING RIPS WITHOUT WARNING!
216 A list of tracks you want \fBabcde\fR to process. If this isn't specified, \fBabcde\fR
217 will process the entire CD. Accepts ranges of track numbers -
218 "abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5, 7, and 9.
220 Each track is, by default, placed in a separate file named after the track
221 in a subdirectory named after the artist under the current directory.
222 This can be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT
223 variables in your \fIabcde.conf\fR. Each file is given an extension identifying
224 its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.aac' or '.wav'.
226 \fBabcde\fR sources two configuration files on startup - \fI/etc/abcde.conf\fR and
227 \fI$HOME/.abcde.conf\fR, in that order.
229 The configuration options stated in those files can be overridden by providing
230 the appropriate flags at runtime.
232 The configuration variables have to be set as follows:
235 Except when "value" needs to be quoted or otherwise interpreted. If other
236 variables within "value" are to be expanded upon reading the configuration
237 file, then double quotes should be used. If they are only supposed to be
238 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
240 All shell escaping/quoting rules apply.
242 Here is a list of options \fBabcde\fR recognizes:
245 Specifies the method we want to use to retrieve the track information. Two
246 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
247 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
248 the Perl helper script \fBabcde-musicbrainz-tool\fR to establish a
249 conversation with the Musicbrainz server for information retrieval.
252 Specifies a server to use for CDDB lookups.
255 Specifies the protocol version used for the CDDB retrieval of results. Version
256 6 retrieves CDDB entries in UTF-8 format.
259 Specifies the Hello information to send to the CDDB server. The CDDB
260 protocol requires you to send a valid username and hostname each time you
261 connect. The format of this is username@hostname.
264 Specifies a directory where we store a local CDDB repository. The entries must
265 be standard CDDB entries, with the filename being the DISCID value. Other
266 CD playing and ripping programs (like Grip) store the entries under \fI~/.cddb\fR
267 and we can make use of those entries.
269 .B CDDBLOCALRECURSIVE
270 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
271 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
272 is selected, it will be copied to the root of the CDDBLOCALDIR if
273 CDDBLOCALPOLICY is "modified" or "new".
276 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
277 possible policies are: "net" for a CDDB entry which has been received from the
278 net (overwriting any possible local CDDB entry); "new" for a CDDB entry which
279 was received from the net, but will request confirmation to overwrite a local
280 CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a
281 CDDB entry found in the local repository but which has been modified by the
282 user; and "always" which forces the CDDB entry to be stored back in the root of
283 the CDDBLOCALDIR no matter where it was found, and no matter it was not edited.
284 This last option will always overwrite the one found in the root of the local
285 repository (if any). STILL NOT WORKING!!
288 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
291 Actually use the stored copies of the CDDB entries. Can be overridden using the
292 "\-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
293 the choice of retrieving a CDDB entry from the internet.
296 Coma-separated list of fields we want to parse during the CDDB parsing.
297 Defaults to "year,genre".
300 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
301 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
302 This affects the default location of the binary,
303 the variable to pick encoder command-line options from, and where the options
307 Specifies the style of encoder to use for the MP3 encoder. Valid options are
308 \'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
309 Affects the same way as explained above for Ogg/Vorbis.
312 Specifies the style of encoder to use for the FLAC encoder. At this point only
313 \'flac\' is available for FLAC encoding.
315 .B SPEEXENCODERSYNTAX
316 Specifies the style of encoder to use for Speex encoder. At this point only
317 \'speexenc\' is available for Ogg/Speex encoding.
320 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
321 point we only have \'mppenc\' available, from corecodecs.org.
324 Specifies the style of encoder to use for M4A (AAC) encoder. At this point we
325 only support \'faac\', so \'default\' points to it.
328 Specifies the style of normalizer to use. Valid options are \'default\'
329 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
333 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
334 \'debug\' and \'flac\'. It is used for querying the CDROM and obtain a list of
335 valid tracks and DATA tracks. The special \'flac\' case is used to "rip" CD
336 tracks from a single-track flac file.
339 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
340 we only support \'mkcue\', but in the future other readers might be used.
343 It defaults to no, so if you want to keep those wavs ripped from your CD,
344 set it to "y". You can use the "\-k" switch in the command line. The default
345 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
346 files even you have requested the "clean" action.
349 If set to "y", it adds 0's to the file numbers to complete a two-number
350 holder. Useful when encoding tracks 1-9.
353 Set to "n" if you want to perform automatic rips, without user intervention.
356 Define the values for priorities (nice values) for the different CPU-hungry
357 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
358 with \fBdistmp3\fR (DISTMP3NICE).
361 The following configuration file options specify the pathnames of their
362 respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
363 VORBIZE, OGGENC, FLAC, SPEEXENC, MPPENC, AACEND, ID3, ID3V2, EYED3, METAFLAC,
364 CDPARANOIA, CDDA2WAV, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3,
365 VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC,
366 CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
368 .B COMMAND-LINE OPTIONS
369 If you wish to specify command-line options to any of the programs \fBabcde\fR uses,
370 set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
371 BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, OGGENCOPTS,
372 FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, AACENCOPTS, ID3OPTS, ID3V2OPTS, MP3GAINOPTS,
373 CDPARANOIAOPTS, CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS,
374 NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, VORBISCOMMMENTOPTS, METAFLACOPTS,
375 DIFFOPTS, FLACGAINOPTS, VORBISGAINOPTS and HTTPGETOPTS.
378 Set the value of the CDROM speed. The default is to read the disc as fast as
379 the reading program and the system permits. The steps are defined as 150kB/s
383 The default actions to be performed when reading a disc.
386 If set, it points to the CD-Rom device which has to be used for audio
387 extraction. Abcde tries to guess the right device, but it may fail. The special
388 \'flac\' option is defined to extract tracks from a single-track flac file.
390 .B CDPARANOIACDROMBUS
391 Defined as "d" when using \fBcdparanoia\fR with an IDE bus and as "g" when using
392 \fBcdparanoia\fR with the ide-scsi emulation layer.
395 Specifies the directory to place completed tracks/playlists in.
398 Specifies the temporary directory to store .wav files in. Abcde may use up
399 to 700MB of temporary space for each session (although it is rare to use
400 over 100MB for a machine that can encode music as fast as it can read it).
403 Specifies the encoding format to output, as well as the default extension and
404 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
405 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
406 Codec), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack)), "m4a" (for M4A (AAC)) or
407 "wav" (Microsoft Waveform). Values like "vorbis,mp3" encode the tracks in both
408 Ogg/Vorbis and MP3 formats. For example
410 OUTPUTTYPE=vorbis,flac
412 For each value in OUTPUTTYPE, \fBabcde\fR expands a different process for encoding,
413 tagging and moving, so you can use the format placeholder, OUTPUT, to create
414 different subdirectories to hold the different types. The variable OUTPUT will
415 be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a' and/or 'wav', depending on the
416 OUTPUTTYPE you define. For example
418 OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
421 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+
422 (Musepack) or M4A filenames. Variables are included using standard shell
423 syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE,
424 TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'.
425 Make sure to use single quotes around this variable. TRACKNUM is automatically
426 zero-padded, when the number of encoded tracks is higher than 9. When lower,
427 you can force with '\-p' in the command line.
430 Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
432 .B ONETRACKOUTPUTFORMAT
433 Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
435 .B VAONETRACKOUTPUTFORMAT
436 Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
439 Defines how many encoders to run at once. This makes for huge speedups
440 on SMP systems. You should run one encoder per CPU at once for maximum
441 efficiency, although more doesn't hurt very much. Set it "0" when using
442 mp3dist to avoid getting encoding processes in the local host.
445 If set to y, conserves disk space by encoding tracks immediately after
446 reading them. This is substantially slower than normal operation but
447 requires several hundred MB less space to complete the encoding of an
448 entire CD. Use only if your system is low on space and cannot encode as
449 quickly as it can read.
451 Note that this option may also help when reading
452 a CD with errors. This is because on a scratchy disk reading is quite timing
453 sensitive and this option reduces the background load on the system which
454 allows the ripping program more precise control.
457 If set to y, enables batch mode normalization, which preserves relative
458 volume differences between tracks of an album. Also enables nogap encoding
459 when using the \'lame\' encoder.
462 Activate the lame's \-\-nogap option, that allows files found in CDs with no
463 silence between songs (such as live concerts) to be encoded without noticeable
464 gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag. This tag is
465 required for mp3 players to correctly display track lengths when playing
466 variable-bit-rate mp3 files.
469 Specifies the format for completed playlist filenames. Works like the
470 OUTPUTFORMAT configuration variable. Default is
471 \'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
472 Make sure to use single quotes around this variable.
474 .B PLAYLISTDATAPREFIX
475 Specifies a prefix for filenames within a playlist. Useful for http
479 If set, the resulting playlist will have CR-LF line endings, needed by some
480 hardware-based players.
483 Specifies a comment to embed in the ID3 or Ogg comment field of each
484 finished track. Can be up to 28 characters long. Supports the same
485 syntax as OUTPUTFORMAT. Does not currently support ID3v2.
488 Specifies a comma-delimited list of systems to use for remote encoding using
489 \fBdistmp3\fR. Equivalent to \-r.
492 mungefilename() is an \fBabcde\fR shell function that can be overridden via
493 \fIabcde.conf\fR. It takes CDDB data as $1 and outputs the resulting filename on
494 stdout. It defaults to eating control characters, apostrophes and
495 question marks, translating spaces and forward slashes to underscores, and
496 translating colons to an underscore and a hyphen.
498 If you modify this function, it is probably a good idea to keep the forward
499 slash munging (UNIX cannot store a file with a '/' char in it) as well as
500 the control character munging (NULs can't be in a filename either, and
501 newlines and such in filenames are typically not desirable).
504 mungegenre () is a shell function used to modify the $GENRE variable. As
505 a default action, it takes $GENRE as $1 and outputs the resulting value
506 to stdout converting all UPPERCASE characters to lowercase.
509 pre_read () is a shell function which is executed before the CDROM is read
510 for the first time, during \fBabcde\fR execution. It can be used to close the CDROM
511 tray, to set its speed (via "setcd" or via "eject", if available) and other
512 preparation actions. The default function is empty.
515 post_read () is a shell function which is executed after the CDROM is read
516 (and, if applies, before the CDROM is ejected). It can be used to read a TOC
517 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
518 The default function is empty.
521 If set to "y", \fBabcde\fR will call \fBeject\fR(1) to eject the cdrom from the drive
522 after all tracks have been read. It has no effect when CDROM is set to a flac
526 If set to "y", some operations which are usually now shown to the end user
527 are visible, such as CDDB queries. Useful for initial debug and if your
528 network/CDDB server is slow.
530 Possible ways one can call \fBabcde\fR:
533 Will work in most systems
535 .B abcde \-d /dev/cdrom2
536 If the CDROM you are reading from is not the standard \fI/dev/cdrom\fR (in GNU/Linux systems)
538 .B abcde \-o vorbis,flac
539 Will create both Ogg/Vorbis and Ogg/FLAC files.
541 .B abcde \-o vorbis:"-b 192"
542 Will pass "\-b 192" to the Ogg/Vorbis encoder, without having to modify the
546 For double+ CD settings: will create the 1st CD starting with the track number
547 101, and will add a comment "CD 1" to the tracks, the second starting with 201
550 .B abcde \-d singletrack.flac
551 Will extract the files contained in singletrack using the embedded cuesheet.
553 \fBabcde\fR requires the following backend tools to work:
556 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) or M4A encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc, faac)
559 An audio CD reading utility (cdparanoia, icedax, cdda2wav, dagrab)
562 cd-discid, a CDDB DiscID reading program.
565 An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X,
566 among others). Alternatively, abcde-musicbrainz-tool (which depends on
567 Perl and some Musicbrainz libraries) can be used to retrieve CDDB
568 information about the CD.
571 (for MP3s) id3 or id3v2, id3 v1 and v2 tagging programs.
574 (optional) distmp3, a client/server for distributed mp3 encoding.
577 (optional) normalize-audio, a WAV file volume normalizer.
580 (optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, replaygain),
583 (optional) mkcue, a CD cuesheet extractor.
589 .BR normalize-audio (1),
609 Robert Woodcock <rcw@debian.org>,
610 Jesus Climent <jesus.climent@hispalinux.es>,
611 Colin Tuckley <colint@debian.org>,
612 Steve McIntyre <93sam@debian.org> and contributions from many others.
HCoop / clinton / abcde.git / blob