.TH timidity.cfg 5 "April 25 2004" "2.13.0".SH NAMEtimidity.cfg \- configure file of TiMidity++.SH DESCRIPTIONThe file \fBtimidity.cfg\fP describes the runtime environments oftimidity(1): that are the path of sound font, instrumentsconfigurations or else..br\fBTiMidity++\fP looks for the configuration file \fBtimidity.cfg\fPat startup, before processing any options.  If it can't be accessed,and the library path is changed with a \fB\-L\fP option on the commandline, then the default file will be sought again along the new librarypath after processing all options, unless another configuration filewas specified with the \fB\-c\fP option..brConfiguration files define the mapping of MIDI programs to instrumentfiles.  Multiple files may be specified, and statements in later oneswill override earlier ones..SH VARIABLEWhen alphanumeric and/or underscore `_' characters continue afterdollar sign `$', it is considered that the string is a variable andthe configuration file is processed, it is transposed to anotherstring.  The variable name can also be written with an insideparenthesis, in order to separate from a following character..spFor example:.br$variable.br${variable} # same as $variable.spFor the moment, the command which newly defines variables is notprepared.  The undifined variable is transposed to null string..brThe variable defined as a regular variable is the next only one..TP.B $basedirExpresses the directory where the configuration file exists.  By thecommand which mainly specifies a path, it uses in order to specify therelative path from a setting file..brWhen a blank may be included in $basedir, it is necessary to bundlewith ""..spFor example:.brIn /usr/local/share/timidity/timidity.cfg.brdir $basedir/inst # source /usr/local/share/timidity/inst.SH SYNTAXThe following statements can be used in a configuration file:.TP.BI "dir " "directory [...]"Adds \fIdirectory\fP to the search path in the same manner as the\fB\-L\fP command line option..brArchive file are also allowed..spFor example:.brdir /usr/local/share/timidity/inst/foo.zip#.brbank 0.br0 bar.pat.br1 baz.pat.br2 zoo.pat.spAt first, \fBdir\fP specifies the archive name (followed by `#') forthe path of patch files same as directory name (in this case,/usr/local/share/timidity/inst/foo.zip).  \fBTiMidity++\fP recognizethe path is an archive file if the expression has the last character`#', and also read the files contained in this archive file.  Inprevious example the patch files bar.pat, baz.pat and zoo.patcontained in the foo.zip are also installed..TP.BI "source " "file [...]"Reads another configuration file, then continues processing thecurrent one..TP.BI "progbase " numberSets and displays the tone number from \fInumber\fP to\fInumber\fP+128.  If \fBprogbase 1\fP are specified, tone numbersthat follow are set and displayed as the numbers from \fB1\fP to\fB128\fP..TP.BI "bank " "[MapID1] number"Selects the tone bank to modify.  Patch mappings that follow willaffect this tone bank.  You can indicate specific map as a target, byspecifing any ofthe following to \fIMapID1\fP: \fBgm2\fP, \fBsc55\fP,\fBsc88\fP, \fBsc88pro\fP, \fBsc8850\fP, \fBxg\fP and \fBxgsfx64\fP..TP.BI "drumset " "[MapID2] number"Selects the drum set to modify.  Patch mappings that follow willaffect this drum set.  You can indicate specific map as a target, byspecifing any ofthe following to \fIMapID2\fP: \fBgm2drum\fP,\fBsc55drum\fP, \fBsc88drum\fP, \fBsc88prodrum\fP, \fBsc8850drum\fP,\fBxgdrum\fP and \fBxgsfx126\fP..TP.BI "number " "file [options]".br.ns.TP.BI "number %font " "file bank prog [key] [options]".br.ns.TP.BI "number %sample " "file [options]"Specifies that the MIDI program number in the current tone bank ordrum set should be played using the patch file.  If \fIfile\fP isSoundFont, the specific instrument with \fIbank\fP, \fIprog\fP, and\fIkey\fP is taken out by the format of \fBnumber %font\fP.  If\fIfile\fP is linear AIFF or WAV sample data, the MIDI program numberis specified by the format of \fBnumber %sample\fP.  Options may beany of the following:.RS.TP.BI amp= amplificationAmplifies the instrument's volume by \fIamplification\fP percent.  Ifno value is specified, one will be automatically determined wheneverthe instrument is loaded..TP.BI note= noteSpecifies a fixed MIDI note to use when playing the instrument.  If\fInote\fP is \fB0\fP, the instrument will be played at whatever notethe Note On event triggering it has.  For percussion instruments, ifno value is specified in the configuration file, the default in thepatch file will be used..TP.BI pan= panningSets the instrument's default panning.  \fIpanning\fP may be\fBleft\fP, \fBright\fP, \fBcenter\fP, or an integer between\fB\-100\fP and \fB100\fP, designating full left and full rightrespectively.  If no value is specified, the default in the patch filewill be used.  Note that panning controls in MIDI files will overridethis value..TP.BI tune= tuning[,...]Adjust the instrument's root frequency.  \fBtune=1\fP causes \fB1\fPhalf tone higher.  Since a fraction is available for \fItuning\fP, itis possible to do fine tuning such as \fBtune=\-0.2\fP.  When two ormore sample data is contained, the arguments after the second canspecify different value respectively..TP.BI rate= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's ADSR rate.  Each value may be an integer between\fB0\fP and \fB255\fP.  When you set only sustain rate,.sp6 GUS/hrpschrd.pat rate=::60.spis available.  When you set only attack time fasten,.sp6 GUS/hrpschrd.pat rate=255.spis available.  When two or more sample data is contained, thearguments after the second can specify different value respectively..TP.BI offset= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's ADSR offset.  Each value may be an integerbetween \fB0\fP and \fB255\fP.  The format is same as \fBrate=\fP..TP.B keep={loop|env}By default, percussion instruments have their loop and envelopeinformation stripped.  Strangely shaped envelopes are removedautomatically from melodic instruments as well.  \fBkeep=\fP can beused to prevent stripping loop or envelope data.  For example, theShort and Long Whistle percussion instruments (General Midi numbers 71and 72) need to have `\fBkeep=loop keep=env\fP' specified in theconfiguration file..TP.B strip={loop|env|tail}Force removal of loop or envelope information from all patches in theinstrument, or strip the tail, i.e. all data after the loop.  Somethird\-party instruments have garbage after the loop, as evidenced bya clicking noise whenever the instrument is played, so adding the\fBstrip=tail\fP option will markedly improve sound quality..TP.BI tremolo= sweep_increment:control_ratio:depth[,...]Sets the instrument's tremolo.  Each value may be an integerbetween \fB0\fP and \fB255\fP.  The format is similar to \fBrate=\fP.\fIsweep_increment\fP is the time until tremolo is started.\fIcontrol_ratio\fP is the rate changing amplification.\fIdepth\fP is the depth changing amplification..TP.BI vibrato= sweep_increment:phase_increment:depth[,...]Sets the instrument's vibrato.  Each value may be an integerbetween \fB0\fP and \fB255\fP.  The format is similar to \fBrate=\fP.\fIsweep_increment\fP is the time until vibrato is started.\fIphase_increment\fP is the rate changing frequency.\fIdepth\fP is the depth changing frequency..TP.BI sclnote= note[,...]Sets the instrument's standard note for scale tuning.  For example,\fBsclnote=60\fP causes the center note C to be standard note forscale tuning.  When two or more sample data is contained, thearguments after the second can specify different value respectively..TP.BI scltune= tune[,...]Sets the instrument's scale tuning factor in cents.  For example,\fBscltune=50\fP causes the half tone steps as \fB50\fP cents.  Whentwo or more sample data is contained, the arguments after the secondcan specify different value respectively..TP.BI comm= commentSpecifies the comment \fIcomment\fP..TP.BI modrate= attack:decay:sustain:release1:release2:release3[,...].br.ns.TP.BI modoffset= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's behavior of change of modulation envelope.The format and values are fundamentally same as volume envelope.Except for some SoundFonts, even if it specifies only the option,nothing happens..TP.BI envkeyf= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's volume envelope key follow.  Based on\fBnote=60\fP, it changes envelope time according to note.  The unitis +\-cent/key.  For example, \fBenvkeyf=100\fP means that the attacktime will double when it goes up by 1 octave.  The format is similarto \fBrate=\fP.  The parameter of \fIdecay\fP and \fIsustain\fP may bepreset in some SoundFont..TP.BI envvelf= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's volume envelope velocity follow.  Based on\fBvelocity=64\fP, it changes envelope time according to velocity.The unit is +\-cent/velocity.  For example, \fBenvvelf=100\fP meansthat the attack time will 38 times at \fBvelocity=127\fP.  The formatis similar to \fBrate=\fP.  In the future, the specification of thisoption may be changed..TP.BI modkeyf= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's modulation envelope key follow.  Based on\fBnote=60\fP, it changes envelope time according to note.  The unitis +\-cent/key.  For example, \fBmodkeyf=100\fP means that the attacktime will double when it goes up by 1 octave.  The format is similarto \fBrate=\fP.  The parameter of \fIdecay\fP and \fIsustain\fP may bepreset in some SoundFont..TP.BI modvelf= attack:decay:sustain:release1:release2:release3[,...]Sets the instrument's modulation envelope velocity follow.  Based on\fBvelocity=64\fP, it changes envelope time according to velocity.The unit is +\-cent/velocity.  For example, \fBmodvelf=100\fP meansthat the attack time will 38 times at \fBvelocity=127\fP.  The formatis similar to \fBrate=\fP.  In the future, the specification of thisoption may be changed..TP.BI trempitch= num[,...]Sets the instrument's depth of changing pitch according to tremolo.The effect itself is same as vibrato, it uses to operate in another