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