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