Allow cleaning when OUTTPUTYPE=wav
[abcde.git] / abcde.conf
1 # System defaults for abcde version 2.2.x
2 # Nothing in this file is uncommented by default.
3 #
4 # If you wish to override these system-wide settings, create your own
5 # .abcde.conf file in your home directory.
6
7 # CDDB options
8 # Choose whether you want to use CDDB or Musicbrainz. Default is CDDB
9 #CDDBMETHOD=cddb
10
11 # If you wish to use a different CDDB server, edit this line.
12 # If you just wanted to use a proxy server, just set your http_proxy
13 # environment variable - wget will use it correctly.
14 #CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
15
16 # The CDDB protocol level.
17 # Right now 5 is latin1 output and 6 is UTF8 encoding.
18 #CDDBPROTO=6
19
20 # The CDDB protocol requires hello information, including a valid username
21 # and hostname. If you feel paranoid about giving away such info, edit this
22 # line - the format is username@hostname.
23 #HELLOINFO="`whoami`@`hostname`"
24
25 # This controls the email address CDDB changes are submitted to.
26 #CDDBSUBMIT=freedb-submit@freedb.org
27
28 # The following options control whether or not fetched CDDB entries
29 # are cached locally in $CDDBLOCALDIR
30 #CDDBCOPYLOCAL="n"
31 #CDDBLOCALDIR="$HOME/.cddb"
32 #CDDBLOCALRECURSIVE="y"
33
34 # If NOSUBMIT is set to y, then abcde will never prompt asking if you
35 # wish to submit your edited cddb file.
36 #NOSUBMIT=n
37
38 # If NOCDDBQUERY is set to y, then abcde will never even try to access
39 # the CDDB server; running abcde will automatically drop you into a
40 # blank cddb file to edit at your leisure.  This is the same as the
41 # -n option.  NOCDDBQUERY=y implies NOSUBMIT=y.
42 #NOCDDBQUERY=n
43
44 # Select here if you want to use the locally stored CDDB entries.
45 # This is useful if you do a lot of editing to those CDDB entries.
46 # Also, other tools like Grip store CDDB entries under $HOME/.cddb,
47 # so they can be reused when ripping CDs. (If this is set to "y" make
48 # sure that CDDBLOCALRECURSIVE is also set to "y".)
49 #CDDBUSELOCAL="n"
50
51 # List, separated with a comma, the fields we want the parsing function to
52 # output. Defaults to YEAR and GENRE, for a complete list of fields provided by
53 # CDDB.
54 # The fields are not case sensitive. Actually, "y,g" will work as fine as "Y,G"
55 # or "YEAR, GENRE"
56 #SHOWCDDBFIELDS=year,genre
57
58 # Specify the style of encoder to use here -
59 # oggenc, vorbize - for OGGENCODERSYNTAX
60 # lame, gogo, bladeenc, l3enc, xingmp3enc, mp3enc - for MP3ENCODERSYNTAX
61 # flac - the only supported for FLACENCODERSYNTAX at the moment
62 # speexenc - the only encoder for SPEEXENCODERSYNTAX
63 # mpcenc - encoder for MPCENCODERSYNTAX
64 # wavpack - encoder for WVENCODER
65 # faac, neroAacEnc, fdkaac - for AACENCODER
66 # opusenc - for OPUSENCODER
67 # default is a valid option for oggenc, lame, flac, speexenc, mpcenc, wavpack, faac and opus.
68 # Currently this affects the default location of the binary, the variable
69 # to pick encoder command-line options from, and where the options are
70 # given.
71 #MP3ENCODERSYNTAX=default
72 #OGGENCODERSYNTAX=default
73 #FLACENCODERSYNTAX=default
74 #SPEEXENCODERSYNTAX=default
75 #MPCENCODERSYNTAX=default
76 #WVENCODERSYNTAX=default
77 #AACENCODERSYNTAX=default
78 #OPUSENCODERSYNTAX=default
79
80 # Specify the syntax of the normalize binary here - so far only 'normalize'
81 # is supported.
82 #NORMALIZERSYNTAX=default
83
84 # CD reader program to use - currently recognized options are 'cdparanoia',
85 # 'icedax', 'cdda2wav', 'dagrab', 'pird', 'cddafs' (Mac OS X only) and 'flac'.
86 #CDROMREADERSYNTAX=cdparanoia
87
88 # CUE reader syntax for the CUE reader program to use.
89 # abcde supports 2 CUE modes: 'mkcue' and 'abcde.mkcue' so you can set the
90 # MKCUE variable accordingly. The 'abcde.mkcue' uses an internal
91 # implementation, without the need of an external program.
92 #CUEREADERSYNTAX=default
93
94 # Specify the program to convert a CUE sheet back to a CD disc ID for CDDB queries.
95 # Select between '/path/to/cue2discid' (provided as an example) or
96 # 'abcde.cue2discid', implemented internaly.
97 #CUE2DISCID=abcde.cue2discid
98
99 # Keep the wav files after encoding. Set it to "y" and remove "clean" from
100 # the list of default actions, since we purge the temp directory as default.
101 #KEEPWAVS=n
102
103 # Track padding: force abcde to pad tracks using 0, so every song uses a two
104 # digit entry. If set to "y", even a single song encoding outputs a file like
105 # 01.my_song.ext
106 #PADTRACKS=n
107
108 # Define if you want abcde to be non-interactive.
109 # Keep in mind that there is no way to deactivate it right now in the command
110 # line, so setting this option makes abcde to be always non-interactive.
111 #INTERACTIVE=n
112
113 # Specify 'nice'ness of the encoder, the CD reader and the distmp3 proc.
114 # This is a relative 'nice'ness (that is, if the parent process is at a
115 # nice level of 12, and the ENCNICE is set to 3, then the encoder will
116 # run with an absolute nice value of 15. Note also, that setting these
117 # to be empty will result in some default niceness increase (4 in tcsh
118 # and 10 using the bsdutils' nice).
119 #ENCNICE=10
120 #READNICE=10
121 #DISTMP3NICE=10
122
123 # Paths of programs to use
124 #LAME=lame
125 #TOOLAME=toolame
126 #GOGO=gogo
127 #BLADEENC=bladeenc
128 #L3ENC=l3enc
129 #XINGMP3ENC=xingmp3enc
130 #MP3ENC=mp3enc
131 #VORBIZE=vorbize
132 #OGGENC=oggenc
133 #FLAC=flac
134 #SPEEXENC=speexenc
135 #MPCENC=mpcenc
136 #WVENC=wavpack
137 #AACENC=faac
138 #OPUSENC=opusenc
139
140 #ID3=id3
141 #ID3V2=id3v2
142 #EYED3=eyeD3
143 #CDPARANOIA=cdparanoia
144 #CDDA2WAV=icedax
145 #PIRD=pird
146 #CDDAFS=cp
147 #CDDISCID=cd-discid
148 #CDDBTOOL=cddb-tool
149 #EJECT=eject
150 #MD5SUM=md5sum
151 #DISTMP3=distmp3
152 #VORBISCOMMENT=vorbiscomment
153 #METAFLAC=metaflac
154 #NORMALIZE=normalize-audio
155 #CDSPEED=eject
156 #VORBISGAIN=vorbisgain
157 #MKCUE=mkcue
158 #MKTOC=cdrdao
159 #DIFF=diff
160
161 # Options to call programs with:
162
163 # If HTTPGET is modified, the HTTPGETOPTS options should also be defined
164 # accordingly. If HTTPGET is changed, the default options will be set,
165 # if HTTPGETOPTS is empty or not defined.
166 #HTTPGET=wget
167 # for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
168 # for wget: HTTPGETOPTS="-q -nv -O -"
169 # for curl (MacOSX): HTTPGETOPTS="-f -s"
170 #HTTPGETOPTS="-q -O -"
171
172 # MP3:
173 # For the best LAME encoder options have a look at:
174 # <http://wiki.hydrogenaudio.org/index.php?title=LAME#Recommended_encoder_settings>
175 # A good option is '-V 0' which gives Variable Bitrate Rate (VBR) recording
176 # with a target bitrate of ~245 Kbps and a bitrate range of 220...260 Kbps.
177 #LAMEOPTS=
178 #TOOLAMEOPTS=
179 #GOGOOPTS=
180 #BLADEENCOPTS=
181 #L3ENCOPTS=
182 #XINGMP3ENCOPTS=
183 #MP3ENCOPTS=
184
185 # Ogg:
186 #VORBIZEOPTS=
187 #OGGENCOPTS=
188
189 # FLAC:
190 # The flac option is a workaround for an error where flac fails
191 # to encode with error 'floating point exception'. This is flac 
192 # error in get_console_width(), corrected in flac 1.3.1
193 #FLACOPTS="--silent"
194
195 # Speex:
196 #SPEEXENCOPTS=
197
198 # MPP/MP+ (Musepack):
199 # For the encoder options look at 'mpcenc --longhelp', consider
200 # setting '--extreme' for a good quality encode.
201 #MPCENCOPTS=
202
203 # WavPack:
204 # Look at 'wavpack --help' for detailed options, consider using '-hx3' 
205 # for a good quality encode
206 #WVENCOPTS=
207
208 # M4A/AAC
209 # For faac options see 'faac --long-help' and consider
210 # using '-q 250' for a good quality encode.
211 # For neroAacEnc options see 'neroAacEnc -help' and
212 # consider using '-q 0.65' for a good quality encode.
213 # For fdkaac options see 'fdkaac --help' and consider using 
214 # '--profile 2 --bitrate-mode 5 --afterburner 1' for a
215 # good quaity encode.
216 #AACENCOPTS=
217
218 # OPUS
219 # For the encoder options look at: 'opusenc -h'
220 #OPUSENCOPTS=
221
222 # There are three ways to tag MP3 files: id3v1 (with id3), id3v2.3
223 # (with id3v2) and id3v2.4 (with eyeD3). Use ID3TAGV to select one of
224 # the older formats
225 #ID3TAGV=id3v2.4
226 #ID3OPTS=
227 #ID3V2OPTS=
228 #EYED3OPTS="--set-encoding=utf16-LE"
229 #CDPARANOIAOPTS=
230 #CDDA2WAVOPTS=
231 #PIRDOPTS="-p"
232 #CDDAFSOPTS="-f"
233 #CDDBTOOLOPTS=
234 #EJECTOPTS=
235 #DISTMP3OPTS=
236 #NORMALIZEOPTS=
237 #CDSPEEDOPTS="-x"
238 #CDSPEEDVALUE=""
239 #MKCUEOPTS=""
240 #MKTOCOPTS=""
241 #DIFFOPTS=""
242 #VORBISCOMMENTOPTS="-R"
243 #METAFLACOPTS="--no-utf8-convert"
244 #DIFFOPTS=""
245
246 # Actions to take
247 # Comma-separated list of one or more of the following:
248 #  cddb,cue,read,normalize,encode,tag,move,playlist,clean,default
249 #   encode implies read
250 #   normalize implies read
251 #   tag implies cddb,read,encode
252 #   move implies cddb,read,encode,tag
253 #   playlist implies cddb
254 # An action can be added to the "default" action by specifying it along with
255 # "default", without having to repeat the default ones:
256 #  ACTIONS=default,playlist
257 # The default action list (referenced as "default") is defined in the following
258 # comment:
259 #ACTIONS=cddb,read,encode,tag,move,clean
260
261 # CD device you want to read from
262 # It can be defined as a singletrack flac file, but since it might change from
263 # file to file it makes little sense to define it here.
264 #CDROM=/dev/cdrom
265 # If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
266 # If we are using the ide-scsi emulation layer, we need to define a "g"
267 #CDPARANOIACDROMBUS="d"
268
269 # If you'd like to make a default location that overrides the current
270 # directory for putting mp3's, uncomment this.
271 #OUTPUTDIR=`pwd`
272
273 # Or if you'd just like to put the temporary .wav files somewhere else
274 # you can specify that here
275 #WAVOUTPUTDIR=`pwd`
276
277 # OUTPUTTYPE can be any of a number of formats, either a single format
278 # (e.g. "ogg") or a combination of them separated with ","
279 # (e.g. "flac,mp3"). Currently recognised and supported are:
280 # "flac", "m4a", "mp3, "mpc", "ogg", "opus", "spx", "vorbis", "wav", "wv"
281 #OUTPUTTYPE=ogg
282
283 # Output filename format - change this to reflect your inner desire to
284 # organize things differently than everyone else :)
285 # You have the following variables at your disposal:
286 # OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, TRACKNUM and YEAR.
287 # Make sure to single-quote this variable. abcde will automatically create
288 # the directory portion of this filename.
289 # NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
290 # Since multiple-output was integrated we always append the file type
291 # to the files. Remove it from your user defined string if you are getting
292 # files like ".ogg.ogg".
293 #OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
294
295 # Like OUTPUTFORMAT but for Various Artists discs.
296 #VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
297
298 # Like OUTPUTFORMAT and VAOUTPUTFORMAT but for the ONEFILE rips.
299 #ONETRACKOUTPUTFORMAT=$OUTPUTFORMAT
300 #VAONETRACKOUTPUTFORMAT=$VAOUTPUTFORMAT
301
302 # Define how many encoders to run at once. This makes for huge speedups
303 # on SMP systems. Defaults to 1. Equivalent to -j.
304 #MAXPROCS=2
305
306 # Support for systems with low disk space:
307 # n:    Default parallelization (read entire CD in while encoding)
308 # y:    No parallelization (rip, encode, rip, encode...)
309 #LOWDISK=n
310
311 # If set to y, enables batch mode normalization, which preserves relative
312 # volume differences between tracks of an album.
313 #BATCHNORM=n
314
315 # Enables nogap encoding when using the 'lame' encoder.
316 #NOGAP=y
317
318 # Set the playlist file location format. Uses the same variables and format
319 # as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
320 # will be created for you and the playlist will reference files from that
321 # subdirectory.
322 #PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
323 # If you want to prefix every filename in a playlist with an arbitrary
324 # string (such as 'http://you/yourstuff/'), use this option
325 #PLAYLISTDATAPREFIX=''
326
327 #Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
328 #VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
329 #VAPLAYLISTDATAPREFIX=''
330
331 #This will give the playlist CR-LF line-endings, if set to "y".
332 #(some hardware players insist on CR-LF line-endings)
333 #DOSPLAYLIST=n
334
335 # Custom filename munging:
336 # By default, abcde will do the following to CDDB data to get a useful
337 # filename:
338 # * Translate colons to a space and a dash for Windows compatibility
339 # * Eat control characters, single quotes, and question marks
340 # * Translate spaces and forward slashes to underscores
341 # To change that, redefine the mungefilename function.
342 # mungefilename receives the CDDB data (artist, track, title, whatever)
343 # as $1 and outputs it on stdout.
344 #mungefilename ()
345 #{
346 #       echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
347 #}
348
349 # Custom genre munging:
350 # By default we just transform uppercase to lowercase. Not much of a fancy
351 # function, with not much use, but one can disable it or just turn the first
352 # Uppercase.
353 #mungegenre ()
354 #{
355 #       echo $CDGENRE | tr "[:upper:]" "[:lower:]"
356 #}
357
358
359 # Custom pre-read function
360 # By default it does nothing.
361 # You can set some things to get abcde function in better ways:
362 # * Close the CD tray using eject -t (if available in eject and supported by
363 #   your CD device.
364 # * Set the CD speed. You can also use the built-in options, but you can also
365 #   set it here. In Debian, eject -x and cdset -x do the job.
366 # KEEP IN MIND that executables included in pre_read must be in your $PATH or
367 # you have to define them with full /path/to/binary
368 # Uncomment and substitute the ":" with your commands.
369 #pre_read ()
370 #{
371 #:
372 #}
373
374 # Custom post-read function
375 # By default it does nothing.
376 # You can set some things to get abcde function in better ways:
377 # * Store a copy of the CD TOC.
378 # KEEP IN MIND that executables included in post_read must be in your $PATH or
379 # you have to define them with full /path/to/binary
380 # Uncomment and substitute the ":" with your commands.
381 #post_read ()
382 #{
383 #:
384 #}
385
386 # post_encode
387 # By default it does nothing.
388 # You can set some things to get abcde function in better ways:
389 # * Move the resulting directory over the network
390 # * Compare results with a previously made run, for tests
391 # KEEP IN MIND that executables included in post_encode must be in your $PATH or
392 # you have to define them with full /path/to/binary
393 # Uncomment and substitute the ":" with your commands.
394 #post_encode ()
395 #{
396 #:
397 #}
398
399 # If you'd like to have abcde eject the cdrom after all the tracks have been
400 # read, uncomment the following line.
401 #EJECTCD=y
402
403 # To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
404 # on the local machine (requires distmp3 to be installed on local machine and
405 # distmp3host to be installed and running on all remote machines - see README)
406 #REMOTEHOSTS=foo,bar,baz,quux,qiix
407
408 # Set to 1,2, etc. to obtain some information about actions happening in the background
409 # Useful if you have a slow network or CDDB servers seem unresponsive.
410 #EXTRAVERBOSE=0