Added a missing $.
[clinton/abcde.git] / README
CommitLineData
c9c2ca27 1ABCDE
2=====
3
4abcde is a frontend command-line utility (actually, a shell script) that
1b94d6b7 5grabs tracks off a CD or a singletrack flac file with an embeded cuesheet,
6encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack)
7format, and tags them, all in one go.
c9c2ca27 8
79e3928b 9Your finished Ogg/MP3/FLAC/Speex/MPP's are, by default, stored in a subdirectory
9f659ada 10of the current directory (named after the artist) with a filename based on the
79e3928b 11track title. Spaces are replaced by underscores, and apostrophes and control
12codes are filtered out. Colons are replaced with an underscore and a hyphen. The
13end result usually looks like: Our_Lady_Peace/01.Supermans_Dead.ogg This
14filename munging is customizable - edit the mungefilename function in your
15abcde.conf to change it.
c9c2ca27 16
b7f1cc84 17Many of the questions related of problems executing abcde have been moved to the
18FAQ, which should be distributed along with this package. Reffer to that file
1b94d6b7 19for more help.
c9c2ca27 20
c9c2ca27 21MAJOR CHANGES
22=============
9ff5088c 23Changes in 2.4:
24* Read TOC entries from the CD. The default uses cdrdao.
25* Possibility to use CDDBCHOICE1,CDDBCHOICE2 (i.e., 1,3) to get a diff of two
26 parsed CDDB entries.
27* Added SHOWCDDBFIELDS to define wether to show the YEAR and GENRE fields from
28 the CDDB output.
1b94d6b7 29* Added the possibility of using a singletrack flac file with an embeded
30 cuesheet as a source to extract tracks from.
31
b82e2042 32Changes in 2.3:
6119aaa1 33* Support for mkcue, to create a CUE sheet of the CD structure. It can be used
34 with "-1" to create a backup, so that later on the original CD can be
35 recreated.
24f444d7 36* New -o <output(1)>:<options(1)>,... way of passing specific options to an
37 output. Now we can pass specific options without having to modify a config
bef9c2d8 38 file. This feature was already present in the last versions of the 2.2 cycle.
6119aaa1 39* Unix PIPEs, as a second way to encode files with a low disc space.
40* Option to erase the "encoded" entries from the status file. Allows one to
41 encode the wav files (in case they were not erased) into another format. This
42 is needed until status information is stored for each format.
b82e2042 43* The "ogg" output mode will be substituted for "vorbis" in the near future.
44 This release adds a compatibility layer so that both entries work.
6119aaa1 45* The FLAC encoder forces the files to be overwritten, in case they previously
46 exists. This avoids a half-through abcde run to continue without errors in
47 case it was cancelled during the FLAC encoding.
4c2499e1 48* Added a post_read() function so that we can do things with the CD before we
49 eject it.
24f444d7 50
81bc6204 51Changes in 2.2:
99d009fa 52
81bc6204 53* Support for MPP/MP+(Musepack) format. It can be downloaded from
79e3928b 54 corecodecs.org. It is supposed to be Free (not only free), and released under
55 the GPL...
81bc6204 56* New "-t <number>" option for starting the numbering of the output files at a
57 given starting number. Ideal for albums with more than one CD.
58* New "-T <number>" option, similar to "-t" but also modifies the tag entries
79e3928b 59 on the files themselves.
81bc6204 60* New "-w <COMMENT>" to add a comment to the tracks of a given CD rip. Use
61 quotes.
62* New "-W <number>" option to combine both a comment with "CD #number" and a
63 starting number for both the tracks and the tags with "#01" (that is, 101 for
64 the 1st CD, 201 for the second...)
40c61684 65* Support for keeping an existing playlist (and not add new entries to it),
66 erase the existing one (overwrite) or append new entries to the existing
67 one.
7acef70b 68* Under ./examples you will find a very basic way to make abcde run in the
69 background and start a non-interactive rip of a CD, if it can find an
70 audio CD in the tray.
71 The abcded script depends on eject and cdparanoia being installed in your
72 system.
73* New mungegenre function to switch off (or modify) the default behaviour of
74 transforming uppercase characters to lowercase.
99d009fa 75* cdparanoia permits performing a query to the CD drive and obtain a list of
76 valid audio tracks. So, now we perform such query and process the results.
77* Support for "None of the above" has been added with the "0" selection. A
78 template is created, and the selection to edit it is defaulted to "y".
79
c9c2ca27 80New options in 2.1.19:
81
82* ONETRACK mode has been introduced. Setting the flag "-1" will create a
83 single file with all the tracks from the CD.
84
85Changes in 2.1.18:
86
87* CDSPEED option defaults to eject. However, since cdparanoia has a built-in
79e3928b 88 option to set the speed, we use it. There is not way (right now) to force the
89 use of eject, but it will be introduced in a future release. Also one can use
90 the pre_read function to set the speed with other program.
c9c2ca27 91
92New options in 2.1.16:
93
79e3928b 94* -S, CDSPEED and CDSPEEDOPTS for setting the speed of the CDROM. One can set
95 the options in abcde.conf and pass the value on the command line. This option
96 can be used with "eject -x <speed>", "setcd -x <speed>" or the built-in
97 cdparanoia option "-S <speed>", if the CD reader supports it.
c9c2ca27 98* Added a pre-read function. Modify it at your pleasure in abcde.conf
99 One can use it to close the CD drive.
79e3928b 100* -m option, to modify the playlist to include CRLF in every line. Some players
101 insist on having those to work properly with playlists.
c9c2ca27 102
103New options in 2.1.15:
104
105* -V can be used to obtain some more information about the CDDB queries.
106* -v shows the version, basic help, and exits.
107
108New options from 2.1.10 to 2.1.13:
109
110* CDROMID has been introduced for cdda2wav use with SCSI devices.
111* Use -L to retrieve the CDDB entries from a local repository (also one can
112 set CDDBUSELOCAL in the config file).
113* If CDDBCOPYLOCAL is set to "y" we store copies of the CDDB entries, under
114 CDDBLOCALDIR (defaults to "~/.cddb).
115
116Modifications from 2.1.9 to 2.1.10:
117
118* Initial (still incomplete) MacOSX support is on the works.
119* A new tool (curl) has been added for MacOSX compatibility, as HTTPGET
120 option.
121
122Options modified from 2.1.8 to 2.1.9:
123
124* KEEPWAVS option now sets the clean to "no".
125
126Options added/modified from 2.1.3 to 2.1.5:
127
128* Ogg/Speex added. Use "-o spx" to rip your audiobooks, for instance.
129
130Options added/modified from 2.1.1 to 2.1.3:
131
132* WGET has been substituted by HTTPGET. Now we support fetch as retrieval
133 program.
134* KEEPWAVS has been introduced. Set it to "y" and the wav tracks will be
135 kept.
136* CDDBPROTO is used to specify the protocol level in the CDDB retrieval.
137* DAGRAB has been introduced as a cd ripper.
138
139Options added/modified from 2.0.3 to 2.1.x:
140
72d7162b 141* -b use batch processing. It uses normalize-audio to adjust the volume of
142 the songs, and a -g gapless option from lame to remove gaps. Only available
c9c2ca27 143 for mp3+lame combination.
144* a new "normalize" option has been added to -a, to normalize the volume.
145* -o works now with a combination of the different outputs: ogg, mp3, flac.
146 Combine them separated by ",". Example: "-o ogg,flac".
79e3928b 147* OUTPUTTYPE is no longer used for the output file type. From version 2.1 abcde
148 implements multiple-output and the file type is always appended at the end of
149 the file. The OUTPUT variable can be used in the PLAYLISTFORMAT and
150 OUTPUTFORMAT to create different directory structures and playlist names for
151 each of the output formats selected.
152
153* DYEAR can be used as DiskYear value in CDDB data. If the data is not supplied
154 by the CDDB server, it can be added.
c9c2ca27 155
156Other options that changed from 1.x to 2.x:
157
158* -e doesn't exist anymore, abcde now presents you with all of the cddb data
159 and asks you if you want to edit it. If you don't want to be asked,
160 use -N or INTERACTIVE=n
161* The output type defaults to Ogg/Vorbis. Specify -o mp3 or OUTPUTTYPE=mp3
162 if you still want to output mp3's.
163* -l 2 is now just -l, LOWDISK=2 should now be LOWDISK=y
164* -V and -v are gone, abcde will now prompt you if you'd like to use Various
165 Artists handling, after showing you the cddb data.
166* -P is now '-a playlist,clean', PLAYLISTONLY=y is now
167 ACTIONS=playlist,clean
168* -p is now '-a playlist,move,clean', PLAYLIST=y is now
169 ACTIONS=playlist,move,clean
170* cddb-tool has been cleaned up a little bit. 'get' is now 'query' and
171 'read', and the tempfile handling has been removed.
172* ID3COMMENT is now COMMENT.
173* FreeDB is now the default CDDB database.
174
175
176REQUIREMENTS
177============
178
179abcde requires the following backend tools to work:
180
181* An Ogg/Vorbis encoder (oggenc, the default, or vorbize) or:
182* An MP3 encoder (lame, gogo, bladeenc, l3enc, etc). Any MP3 encoder that
183 takes two filenames on the command line, one for input, one for output,
184 will work.
185 You can get lame at: http://www.mp3dev.org/mp3/
186 You can get gogo at: http://homepage1.nifty.com/herumi/gogo_e.html
187 You can get BladeEnc at: http://bladeenc.mp3.no/
188 You can get a trial version of mp3enc at:
189 http://www.iis.fhg.de/amm/download/ or:
190* FLAC encoder (flac) or:
9f659ada 191* Ogg/Speex encoder (speexenc) or:
192* MPP/MP+(Musepack) encoder (mppenc)
72d7162b 193* normalize-audio for volume normalization.
c9c2ca27 194* CD Paranoia, an audio CD reading utility,
195* Or cdda2wav, the audio CD reading utility cdparanoia was born from,
196* Or dagrab, another audio CD reading utility.
197* cd-discid, a CDDB DiscID reading program. Formerly bundled with abcde.
198 It's available in Debian or http://www.hispalinux.es/~data/files/cd-discid/
199* An HTTP retrieval program: wget, fetch (FreeBSD) or curl (MacOSX)
200* id3, an id3 tagging program. Available at: http://lly.org/~rcw/id3/
201* id3v2, an id3 version 2.0 tagger. http://id3v2.sourceforge.net/
202* (optional) distmp3, a client/server for distributed mp3 encoding.
203 You can get distmp3 at http://wlug.westbo.se/medlprog/medlprog.html
204
c9c2ca27 205Abcde's new mailing list is abcde@listas.hispalinux.es. So far has not
206been actively used.
207The posts from non-subscribers are moderated to prevent spam.
208
209Archives of the old list are publically available at:
210http://lly.org/~rcw/abcde/list/current/threads.html
211
212Abcde's current page is at http://www.hispalinux.es/~data/abcde.php
c9c2ca27 213Abcde's old homepage is at http://lly.org/~rcw/abcde/page/.
214--
c9c2ca27 215Jesus Climent <jesus.climent@hispalinux.es>
79e3928b 216
b7f1cc84 217abcde was originally created by Robert Woodcock <rcw@debian.org>
79e3928b 218