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