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