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