3b8e48920f9c4c4f22892af4d8f8397504f1483b
[abcde.git] / abcde.conf
1 # System defaults for abcde version 2.7.1
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 # currently recognized options are 'cddb' and 'musicbrainz'
10 #CDDBMETHOD=cddb
11
12 # If you wish to use a different CDDB server, edit this line.
13 # If you just wanted to use a proxy server, just set your http_proxy
14 # environment variable - wget will use it correctly.
15 #CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
16
17 # The CDDB protocol level.
18 # Right now 5 is latin1 output and 6 is UTF8 encoding.
19 #CDDBPROTO=6
20
21 # The CDDB protocol requires hello information, including a valid username
22 # and hostname. If you feel paranoid about giving away such info, edit this
23 # line - the format is username@hostname.
24 #HELLOINFO="`whoami`@`hostname`"
25
26 # This controls the email address CDDB changes are submitted to.
27 #CDDBSUBMIT=freedb-submit@freedb.org
28
29 # The following options control whether or not fetched CDDB entries
30 # are cached locally in $CDDBLOCALDIR
31 #CDDBCOPYLOCAL="n"
32 #CDDBLOCALDIR="$HOME/.cddb"
33 #CDDBLOCALRECURSIVE="y"
34
35 # If NOSUBMIT is set to y, then abcde will never prompt asking if you
36 # wish to submit your edited cddb file.
37 #NOSUBMIT=n
38
39 # If NOCDDBQUERY is set to y, then abcde will never even try to access
40 # the CDDB server; running abcde will automatically drop you into a
41 # blank cddb file to edit at your leisure.  This is the same as the
42 # -n option.  NOCDDBQUERY=y implies NOSUBMIT=y.
43 #NOCDDBQUERY=n
44
45 # Select here if you want to use the locally stored CDDB entries.
46 # This is useful if you do a lot of editing to those CDDB entries.
47 # Also, other tools like Grip store CDDB entries under $HOME/.cddb,
48 # so they can be reused when ripping CDs. (If this is set to "y" make
49 # sure that CDDBLOCALRECURSIVE is also set to "y".)
50 #CDDBUSELOCAL="n"
51
52 # List, separated with a comma, the fields we want the parsing function to
53 # output. Defaults to YEAR and GENRE, for a complete list of fields provided by
54 # CDDB.
55 # The fields are not case sensitive. Actually, "y,g" will work as fine as "Y,G"
56 # or "YEAR, GENRE"
57 #SHOWCDDBFIELDS=year,genre
58
59 # Specify the style of encoder to use here -
60 # oggenc, vorbize - for OGGENCODERSYNTAX
61 # lame, gogo, bladeenc, l3enc, xingmp3enc, mp3enc - for MP3ENCODERSYNTAX
62 # flac - the only supported for FLACENCODERSYNTAX at the moment
63 # speexenc - the only encoder for SPEEXENCODERSYNTAX
64 # mpcenc - encoder for MPCENCODERSYNTAX
65 # wavpack, ffmpeg - encoder for WVENCODERSYNTAX
66 # mac - for APENCODERSYNTAX
67 # faac, neroAacEnc, fdkaac, qaac, fhgaacenc, ffmpeg - for AACENCODERSYNTAX
68 # opusenc - for OPUSENCODERSYNTAX
69 # twolame - for MP2ENCODERSYNTAX
70 # default is a valid option for oggenc, lame, flac, speexenc, mpcenc, wavpack,
71 # faac, opus and twolame. Currently this affects the default location of the
72 # binary, the variable to pick encoder command-line options from, and where
73 # the options are given.
74 #MP3ENCODERSYNTAX=default
75 #OGGENCODERSYNTAX=default
76 #FLACENCODERSYNTAX=default
77 #SPEEXENCODERSYNTAX=default
78 #MPCENCODERSYNTAX=default
79 #WVENCODERSYNTAX=default
80 #APENCODERSYNTAX=default
81 #AACENCODERSYNTAX=default
82 #OPUSENCODERSYNTAX=default
83 #MP2ENCODERSYNTAX=default
84
85 # Specify the syntax of the normalize binary here - so far only 'normalize'
86 # is supported.
87 #NORMALIZERSYNTAX=default
88
89 # CD reader program to use - currently recognized options are 'cdparanoia',
90 # 'libcdio' (cd-paranoia),'icedax', 'cdda2wav', 'dagrab', 'pird',
91 # 'cddafs' (Mac OS X only) and 'flac'.
92 #CDROMREADERSYNTAX=cdparanoia
93
94 # CUE reader syntax for the CUE reader program to use.
95 # abcde supports 2 CUE modes: 'mkcue' and 'abcde.mkcue' so you can set the
96 # MKCUE variable accordingly. The 'abcde.mkcue' uses an internal
97 # implementation, without the need of an external program.
98 #CUEREADERSYNTAX=default
99
100 # Specify the program to convert a CUE sheet back to a CD disc ID for CDDB queries.
101 # Select between '/path/to/cue2discid' (provided as an example) or
102 # 'abcde.cue2discid', implemented internaly.
103 #CUE2DISCID=abcde.cue2discid
104
105 # Keep the wav files after encoding. Set it to "y" and remove "clean" from
106 # the list of default actions, since we purge the temp directory as default.
107 #KEEPWAVS=n
108
109 # Track padding: force abcde to pad tracks using 0, so every song uses a two
110 # digit entry. If set to "y", even a single song encoding outputs a file like
111 # 01.my_song.ext
112 #PADTRACKS=n
113
114 # Define if you want abcde to be non-interactive.
115 # Keep in mind that there is no way to deactivate it right now in the command
116 # line, so setting this option makes abcde to be always non-interactive.
117 #INTERACTIVE=n
118
119 # Specify 'nice'ness of the encoder, the CD reader and the distmp3 proc.
120 # This is a relative 'nice'ness (that is, if the parent process is at a
121 # nice level of 12, and the ENCNICE is set to 3, then the encoder will
122 # run with an absolute nice value of 15. Note also, that setting these
123 # to be empty will result in some default niceness increase (4 in tcsh
124 # and 10 using the bsdutils' nice).
125 #ENCNICE=10
126 #READNICE=10
127 #DISTMP3NICE=10
128
129 # Paths of programs to use
130
131 # Encoders:
132 #LAME=lame
133 #GOGO=gogo
134 #BLADEENC=bladeenc
135 #L3ENC=l3enc
136 #XINGMP3ENC=xingmp3enc
137 #MP3ENC=mp3enc
138 #VORBIZE=vorbize
139 #OGGENC=oggenc
140 #FLAC=flac
141 #SPEEXENC=speexenc
142 #MPCENC=mpcenc
143 #WVENC=wavpack
144 #APENC=mac
145 #FAAC=faac
146 #NEROAACENC=neroAacEnc
147 #FDKAAC=fdkaac
148 #OPUSENC=opusenc
149 #TWOLAME=twolame
150 # Note that if you use avconv rather than FFmpeg give the
151 # path to avconv here (e.g. FFMPEG=/usr/bin/avconv):
152 # FFMPEG=ffmpeg
153
154 # The path for qaac, refalac and fhgaacenc  can be problematic as abcde
155 # cannot cope with the 'standard' Wine location with spaces. For example:
156 # "$HOME/.wine/drive_c/Program\ Files/qaac/qaac.exe" is problematic. Try instead:
157 # "$HOME/.wine/drive_c/qaac/qaac.exe"
158 # Installation instructions for qaac, refalac and fhgaacenc here:
159 #    http://www.andrews-corner.org/qaac.html
160 #    http://www.andrews-corner.org/fhgaacenc.html
161 # (Hint: Use QAAC=refalac to use the Open Source alac encoder...)
162 #QAAC=qaac
163 #FHGAACENC=fhgaacenc
164
165 # Taggers, rippers, replaygain etc:
166 #ID3=id3
167 #ID3V2=id3v2
168 #MID3V2=mid3v2
169 #EYED3=eyeD3
170 #CDPARANOIA=cdparanoia
171 #CD_PARANOIA=cd-paranoia
172 #CDDA2WAV=icedax
173 #PIRD=pird
174 #CDDAFS=cp
175 #CDDISCID=cd-discid
176 #CDDBTOOL=cddb-tool
177 #EJECT=eject
178 #MD5SUM=md5sum
179 #DISTMP3=distmp3
180 #VORBISCOMMENT=vorbiscomment
181 #METAFLAC=metaflac
182 #NORMALIZE=normalize-audio
183 #CDSPEED=eject
184 #VORBISGAIN=vorbisgain
185 #MKCUE=mkcue
186 #MKTOC=cdrdao
187 #DIFF=diff
188 #WVGAIN=wvgain
189 #APETAG=apetag
190 #GLYRC=glyrc
191 #IDENTIFY=identify
192 #CONVERT=convert
193 #DISPLAYCMD=display
194 #WINE=wine
195
196 # Options to call programs with:
197
198 # If HTTPGET is modified, the HTTPGETOPTS options should also be defined
199 # accordingly. If HTTPGET is changed, the default options will be set,
200 # if HTTPGETOPTS is empty or not defined.
201 #HTTPGET=wget
202 # for fetch (FreeBSD): HTTPGETOPTS="-q -o -"
203 # for wget: HTTPGETOPTS="-q -nv -O -"
204 # for curl (MacOSX): HTTPGETOPTS="-f -s"
205 #HTTPGETOPTS="-q -O -"
206
207 # MP3:
208 # For the best LAME encoder options have a look at:
209 # <http://wiki.hydrogenaudio.org/index.php?title=LAME#Recommended_encoder_settings>
210 # A good option is '-V 0' which gives Variable Bitrate Rate (VBR) recording
211 # with a target bitrate of ~245 Kbps and a bitrate range of 220...260 Kbps.
212 #LAMEOPTS=
213 #GOGOOPTS=
214 # Bladeenc still works with abcde in 2015, and the last release of bladeenc
215 # was in 2001! Settings that will produce a great encode are: '-br 192' 
216 #BLADEENCOPTS=
217 # L3enc still works with abcde in 2015, pretty amazing when you realise 
218 # that the last release of l3enc was in 1997! Settings that will produce 
219 # a great encode are: '-br 256000 -hq -crc'
220 #L3ENCOPTS=
221 #XINGMP3ENCOPTS=
222 # And mp3enc also still works with abcde in 2015 with the last release
223 # of mp3enc in 1998! Settings that will produce a great encode, albeit
224 # a slow one, are: '-v -br 256000 -qual 9 -no-is -bw 16500'
225 #MP3ENCOPTS=
226
227 # Ogg:
228 #VORBIZEOPTS=
229 #OGGENCOPTS=
230
231 # FLAC:
232 # The flac option is a workaround for an error where flac fails
233 # to encode with error 'floating point exception'. This is flac 
234 # error in get_console_width(), corrected in flac 1.3.1
235 #FLACOPTS="--silent"
236
237 # Speex:
238 #SPEEXENCOPTS=
239
240 # MPP/MP+ (Musepack):
241 # For the encoder options look at 'mpcenc --longhelp', consider
242 # setting '--extreme' for a good quality encode.
243 #MPCENCOPTS=
244
245 # WavPack:
246 # Look at 'wavpack --help' for detailed options, consider using '-hx3' 
247 # for a good quality encode
248 #WAVENCOPTS=
249 # For Wavpack replay gain we set both the default of 'track gain' 
250 # as well as this option for 'album gain'. Better media players
251 # such as vlc can select either or neither.    
252 #WVGAINOPTS='-a'
253
254 # Monkey's Audio (ape)
255 # Without this set mac chokes unfortunately. Choices
256 # are from 1000 to 5000.
257 #APENCOPTS='-c4000'
258
259 # M4A/AAC
260 # There are now 5 AAC encoders available to abcde. (FFmpeg
261 # is also available for the m4a container...)
262 # Note that the old AACENCOPTS has been rendered obsolete by
263 # the following options, new to abcde 2.7:
264 #  1. faac: see 'faac --long-help' and consider
265 #     using '-q 250' for a good quality encode.
266 #FAACENCOPTS=
267 #  2. neroAacEnc: see 'neroAacEnc -help' and
268 #     consider using '-q 0.65' for a good quality encode.
269 #NEROAACENCOPTS=
270 #  3. fdkaac: see 'fdkaac --help' and consider using 
271 #     '--profile 2 --bitrate-mode 5 --afterburner 1'
272 #     for a good quality encode. 
273 #FDKAACENCOPTS='--bitrate 192k'
274 #  4. qaac: simply run 'wine qaac.exe' to see all options and
275 #     consider using '--tvbr 100' for a good quality
276 #     encode or '--alac' for Apple Lossless Audio Codec.
277 #QAACENCOPTS=
278 #  5. fhgaacenc: simply run 'wine fhgaacenc.exe' to see all options.
279 #     consider using '--vbr 4' for a decent quality encode.
280 #FHGAACENCOPTS=
281
282 # OPUS
283 # For the encoder options look at: 'opusenc -h'
284 #OPUSENCOPTS=
285
286 # MP2
287 # Currently uses only twolame, for options look at: 'twolame --help',
288 # a highly recommended setting is "--bitrate 320".
289 #TWOLAMENCOPTS=
290
291 # FFmpeg or avconv can be used for several audio codecs:
292 # 1. Encoding to WavPack (FFmpeg only: avconv does not have a native encoder).
293 #    Consider setting the following with a compression_level between 0-8:
294 #    FFMPEGENCOPTS="-c:a wavpack -compression_level 6"
295 # 2. Encoding to ALAC (both FFmpeg and avconv have a native encoder).
296 #    Consider using the following for both FFmpeg and avconv:
297 #    FFMPEGENCOPTS="-c:a alac" 
298 #FFMPEGENCOPTS=
299
300 # mp3 tagging:
301 # There are three ways to tag MP3 files:
302 #   1. id3v1 (with id3)
303 #   2. id3v2.3 (with id3v2)
304 #   3. id3v2.4 (with eyeD3) This is the default
305 # Use ID3TAGV to select one of the older formats:
306 #ID3TAGV=id3v2.4
307 #ID3OPTS=
308 #ID3V2OPTS=
309 #EYED3OPTS="--set-encoding=utf16-LE"
310
311 # Other options:
312 # The variable CDPARANOIOPTS is also used by GNU's cd-paranoia,
313 # so use this when setting CDROMREADERSYNTX=libcdio.
314 #CDPARANOIAOPTS=
315 #CDDA2WAVOPTS=
316 #PIRDOPTS="-p"
317 #CDDAFSOPTS="-f"
318 #CDDBTOOLOPTS=
319 #EJECTOPTS=
320 #DISTMP3OPTS=
321 #NORMALIZEOPTS=
322 #CDSPEEDOPTS="-x"
323 #CDSPEEDVALUE=""
324 #MKCUEOPTS=""
325 #MKTOCOPTS=""
326 #DIFFOPTS=""
327 #VORBISCOMMENTOPTS="-R"
328 #METAFLACOPTS="--no-utf8-convert"
329 # Bear in mind that the AtomicParsley option '--overWrite' is already
330 # used in abcde...
331 #ATOMICPARSLEYOPTS=
332
333 # Actions to take
334 # Comma-separated list of one or more of the following:
335 #  cddb,cue,read,normalize,encode,tag,move,replaygain,playlist,getalbumart,clean,default
336 #   encode implies read
337 #   normalize implies read
338 #   tag implies cddb,read,encode
339 #   move implies cddb,read,encode,tag
340 #   replaygain implies cddb,read,encode,tag,move
341 #   playlist implies cddb
342 # An action can be added to the "default" action by specifying it along with
343 # "default", without having to repeat the default ones:
344 #  ACTIONS=default,playlist
345 # The default action list (referenced as "default") is defined in the following
346 # comment:
347 #ACTIONS=cddb,read,encode,tag,move,clean
348
349 # CD device you want to read from
350 # It can be defined as a singletrack flac file, but since it might change from
351 # file to file it makes little sense to define it here.
352 #CDROM=/dev/cdrom
353 # If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
354 # If we are using the ide-scsi emulation layer, we need to define a "g"
355 #CDPARANOIACDROMBUS="d"
356
357 # If you'd like to make a default location that overrides the current
358 # directory for putting mp3's, uncomment this.
359 #OUTPUTDIR=`pwd`
360
361 # Or if you'd just like to put the temporary .wav files somewhere else
362 # you can specify that here
363 #WAVOUTPUTDIR=`pwd`
364
365 # OUTPUTTYPE can be any of a number of formats, either a single format
366 # (e.g. "ogg") or a combination of them separated with ","
367 # (e.g. "flac,mp3"). Currently recognised and supported are:
368 # "flac", "m4a", "mp3, "mpc", "ogg", "opus", "spx", "vorbis", "wav", "wv", "ape"
369 #OUTPUTTYPE=ogg
370
371 # Output filename format - change this to reflect your inner desire to
372 # organize things differently than everyone else :)
373 # You have the following variables at your disposal:
374 # OUTPUT, GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, TRACKNUM and YEAR.
375 # Make sure to single-quote this variable. abcde will automatically create
376 # the directory portion of this filename.
377 # NOTICE: OUTPUTTYPE has been deprecated in the OUTPUTFORMAT string.
378 # Since multiple-output was integrated we always append the file type
379 # to the files. Remove it from your user defined string if you are getting
380 # files like ".ogg.ogg".
381 #OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
382
383 # Like OUTPUTFORMAT but for Various Artists discs.
384 #VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
385
386 # Like OUTPUTFORMAT and VAOUTPUTFORMAT but for the ONEFILE rips.
387 #ONETRACKOUTPUTFORMAT=$OUTPUTFORMAT
388 #VAONETRACKOUTPUTFORMAT=$VAOUTPUTFORMAT
389
390 # Define how many encoders to run at once. This makes for huge speedups
391 # on SMP systems. Defaults to 1. Equivalent to -j.
392 #MAXPROCS=2
393
394 # Support for systems with low disk space:
395 # n:    Default parallelization (read entire CD in while encoding)
396 # y:    No parallelization (rip, encode, rip, encode...)
397 #LOWDISK=n
398
399 # If set to y, enables batch mode normalization, which preserves relative
400 # volume differences between tracks of an album.
401 #BATCHNORM=n
402
403 # Enables nogap encoding when using the 'lame' encoder.
404 #NOGAP=y
405
406 # Set the playlist file location format. Uses the same variables and format
407 # as OUTPUTFORMAT. If the playlist is specified to be in a subdirectory, it
408 # will be created for you and the playlist will reference files from that
409 # subdirectory.
410 #PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
411 # If you want to prefix every filename in a playlist with an arbitrary
412 # string (such as 'http://you/yourstuff/'), use this option
413 #PLAYLISTDATAPREFIX=''
414
415 #Like PLAYLIST{FORMAT,DATAPREFIX} but for Various Artists discs:
416 #VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
417 #VAPLAYLISTDATAPREFIX=''
418
419 #This will give the playlist CR-LF line-endings, if set to "y".
420 #(some hardware players insist on CR-LF line-endings)
421 #DOSPLAYLIST=n
422
423 # album art download options (see glyrc's help for details with more detailed 
424 # examples here: https://github.com/sahib/glyr/wiki/Commandline-arguments).
425 # For example use '--formats jpg;jpeg' to only search for JPEG images
426 # These options: '--from <provider>' and '--lang <langcode>' might also be useful
427 #GLYRCOPTS=
428 #ALBUMARTFILE="cover.jpg"
429 #ALBUMARTTYPE="JPEG"
430
431 # Options for ImageMagick commands used by album art processing when available
432 # For example: CONVERTOPTS="-colorspace RGB -resize 600x600>"
433 # to make the image RGB and fit inside 600x600 while keeping the aspect ratio
434 #IDENTIFYOPTS=
435 #CONVERTOPTS=
436 #DISPLAYCMDOPTS="-resize 512x512 -title abcde_album_art"
437 # By default convert is only called when the image type is different from
438 # ALBUMARTTYPE, use ALBUMARTALWAYSCONVERT="y" to always call convert
439 #ALBUMARTALWAYSCONVERT="n"
440
441 # Custom filename munging:
442 # By default, abcde will do the following to CDDB data to get a useful filename:
443 # 1. Delete any dots preceding the title (first sed command)
444 # 2. Replace all spaces with an underscore (second sed command). Simply remove
445 #   this if you prefer spaces.
446 # 3. Delete a grab bag of characters which variously Windows and Linux do not permit 
447 #   (tr command). Remove any of these from the list if you wish to actually use them.
448 #   
449 #mungefilename ()
450 #{
451 #       echo "$@" | sed -e 's/^\.*//' -e 's/ /_/g' | tr -d ":><|*/\"'?[:cntrl:]"
452 #}
453
454 # Custom genre munging:
455 # By default we just transform uppercase to lowercase. Not much of a fancy
456 # function, with not much use, but one can disable it or just turn the first
457 # Uppercase.
458 #mungegenre ()
459 #{
460 #       echo $CDGENRE | tr "[:upper:]" "[:lower:]"
461 #}
462
463
464 # Custom pre-read function
465 # By default it does nothing.
466 # You can set some things to get abcde function in better ways:
467 # * Close the CD tray using eject -t (if available in eject and supported by
468 #   your CD device.
469 # * Set the CD speed. You can also use the built-in options, but you can also
470 #   set it here. In Debian, eject -x and cdset -x do the job.
471 # KEEP IN MIND that executables included in pre_read must be in your $PATH or
472 # you have to define them with full /path/to/binary
473 # Uncomment and substitute the ":" with your commands.
474 #pre_read ()
475 #{
476 #:
477 #}
478
479 # Custom post-read function
480 # By default it does nothing.
481 # You can set some things to get abcde function in better ways:
482 # * Store a copy of the CD TOC.
483 # KEEP IN MIND that executables included in post_read must be in your $PATH or
484 # you have to define them with full /path/to/binary
485 # Uncomment and substitute the ":" with your commands.
486 #post_read ()
487 #{
488 #:
489 #}
490
491 # post_encode
492 # By default it does nothing.
493 # You can set some things to get abcde function in better ways:
494 # * Move the resulting directory over the network
495 # * Compare results with a previously made run, for tests
496 # KEEP IN MIND that executables included in post_encode must be in your $PATH or
497 # you have to define them with full /path/to/binary
498 # Uncomment and substitute the ":" with your commands.
499 #post_encode ()
500 #{
501 #:
502 #}
503
504 # If you'd like to have abcde eject the cdrom after all the tracks have been
505 # read, uncomment the following line.
506 #EJECTCD=y
507
508 # To encode on the remote machines foo, bar, baz, quux, and qiix, as well as
509 # on the local machine (requires distmp3 to be installed on local machine and
510 # distmp3host to be installed and running on all remote machines - see README)
511 #REMOTEHOSTS=foo,bar,baz,quux,qiix
512
513 # Set to 1,2, etc. to obtain some information about actions happening in the background
514 # Useful if you have a slow network or CDDB servers seem unresponsive.
515 #EXTRAVERBOSE=0