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