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