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