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