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