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