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