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