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