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