.TH TiMidity++ 1 "Jan 06 1999" "1.0.0"
.SH NAME
TiMidity++ \- MIDI to WAV converter and player
.SH SYNOPSIS
.B timidity
[\-options] filename [filenames ...]
.P
.SH DESCRIPTION
TiMidity++ is a converter that converts some of MIDI files
( formats : Standard MIDI file (*.MID), Recomposer files (*.RCP, *.R36,
*.G18, *.G36) and Module file (*.mod) ) into formatted audio file
(ex. RIFF WAVE ).
TiMidity uses Gravis Ultrasound\-compatible patch files or 
Soundfonts( *.sfx, *.sf2 ) to generate digital audio data from MIDI files.
The digital audio data generated by TiMidity can be stored in a file for
processing, or played in real time through an audio device.
.br
In real time playing, TiMidity if able to show the lylic contained
in KAR file or WRD file.

.P
.SH FILENAME
You can use the following expressions in \fBfilename\fP fields
to specify the location of the file:
.TP
.B \-
Read a MIDI file from standard input.
.TP
.B /path/filename
Read a MIDI file on filesystems.
.TP
.BI dir: "directory"
.br
.ns
.TP
.B directory/
Read and play all MIDI files in specified directory.
.TP
.B Archive File
Extracts and play the file(s) in the archive.
If you want to specify a certain MIDI file in the archive,
describe the \fI#<MIDI\-filename>\fP expression following to the archive name.
The expressions after the \fI#\fP is allowed to use regular expressions
(case insensitive).

.RS
For Examples:
.TP
.B timidity "'file.zip#file.mid'"
Plays file.mid in file.zip
.TP
.B timidity "'file.lzh#*.mid'"
Plays any files that match the regular expression '*.mid' in file.zip
.TP
.B timidity "'file.tgz#*'"
This expression is same as
.br
\fBtimidity 'file.tgz'\fP
.PP
Since these mechanism are contained in TiMidity itself,
you can use it even if on MS Windows environment.
.PP

TiMidity can handle the following archive format:
.RS
.TP
\fBtar\fP (*.tar)
.TP
\fBtar + gzip\fP (*.tar.gz, *.tgz)
.TP
\fBzip\fP (*.zip)
.TP
.fBlzh\fP (*.lzh, *.lha)
(lh0, lh1, lh2, lh3, lh4, lh5, lh6, lzs, lz5, lz4 are available)
.RE
.RE

.TP
.B news://news\-server[:port]/Message\-ID
.br
.ns
.TP
.B news://news\-server[:port]/newsgroup[/first\-last]
Play the MIDI file in the specified article in news server.
If newsgroup is specified TiMidity plays (all) articles contains
MIDI files posted in the newsgroup.
.br
In this case TiMidity recognize the MIME Multi\-part message, and
extract the articles contains MIDI files and play.
.br
The following MIME\-type are allowed:
.RS
.TP
.B uu\-encoded file
"begin" is required
.TP
.B base64 encoded
"Content\-Transfer\-Encoding\: base64" is required
.TP
.B quoted\-string
"Content\-Transfer\-Encoding\: quoted\-string" is required
.TP
.B Mac BinHex format
only 'HQX' format is available
.RE

.TP
.B http://url
.br
.ns
.TP
.B ftp://url
Play the file specified these URLs.
.sp
For example:

"timidity http://www.goice.co.jp/member/mo/dist/midi/impromptu.mid"

.br
plays MIDI\-file via network.
.sp
If these expression are applied to the *.cfg files, you can use
patch\-files or else on the remote machines.

.P
.SH INPUT FILE
Timidity can handle the following file formats:
.TP
\fB .MID\fP ( Format 0, 1, 2 )
Standard MIDI File
.TP
\fB .RCP, .R36, .G18, .G36\fP ( formats of Recomposer (products of COME ON MUSIC co.) )
Windows version converts these with \fIrcpcv.dll\fP.
.TP
\fB .KAR\fP ( Karaoke format )
Displays lylics same as Lylic Meta Event message.
.TP
\fB .MOD, MOD.*\fP ( module file )
.TP
\fB .WRD\fP ( WRD format )

.P
.SH OPTIONS
The following command line optinos are accepted by TiMidity:

.TP
.B \-A \fIamplification\fP
Multiplies the master volume by \fIamplification\fP %.
Default value is 70%.
The grater number of amplification makes louder sounds. 
Range of the amplification is from 0 to 800%.

.TP
.B \-a
Turns on antialiasing. Samples are  run  through  a
lowpass filter before playing, which reduces aliasing
noise at low resampling frequencies.

.TP
.B \-B \fIfragments\fP
For the Linux / FreeBSD / OSS / Windows sound driver,
selects the number  of
buffer  fragments  in interactive mode.  Increasing
the number of fragments may reduce choppiness  when
many  processes are running.  It will make TiMidity
seem to respond sluggishly to fast forward, rewind,
and  volume  controls, and it will throw the status
display off sync.  Specify a fragments of 0 to  use
the maximum number of fragments available.

.TP
.B \-b \fImode\fP

Enables pseudo surround effects.
\fImode\fP parameters are the following:
.RS
.TP
.B \-bl
Sounds are comes mainly from left.
.TP
.B \-br
Sounds are comes mainly from right.
.TP
.B \-bb
Sounds are comes left and right in random.
.TP
.B \-bc
Disables this feature.
.RE

.TP
.BI \-C " ratio"

Sets the ratio of sampling and control frequencies.
This determines how often  envelopes  are  recalculated 
-- small ratios yield better quality but use
more CPU time.

.TP
.BI \-c " filename"
Reads an extra configuration file.

.TP
.BI \-D " channel"
Marks channel as a drum  channel.   If  channel  is
negative,  channel -channel is marked as an instru-
mental channel.  If channel is 0, all channels  are
marked as instrumental.

.TP
.BI \-d " dir"
Specifies the directory contains installed dynamic-link interface modules.

.TP
.B \-e
Make   TiMidity   evil.   On  Win32  version,  this
increases the task priority by  one.  It  can  give
better  playback  when  you  switch  tasks  at  the
expense of slowing all other tasks down.

.TP
.BI \-E " mode"
Set TiMidity extend modes. The following modes are available
(capitalized switch means disable this feature):
.RS
.TP
.B w/W
Enables/disables modulation controlling.
.TP
.B p/P
Enables/disables portamento controlling.
.TP
.B v/V
Enables/disables NRPM vibration.
.TP
.B r/R
Enables/disables reverb effect controlling.
.TP
.B c/C
Enables/disables chorus effect controlling.
.TP
.BI c " ratio"
Sets the chorus effect value of all channels to \fIratio\fP.
.TP
.B s/S
Enables/disables channel pressure controlling.
.TP
.B t/T
Enables/disables tracing all Text Meta Events.
.TP
.B o/O
Accepts/rejects pronouncing multiple same notes.
.TP
.BI m " HH"
Sets the manufacture ID to \fIHH\fP ( \fIHH\fP is the two hex-digits ).
.br
In addition if \fIHH\fP is \fIGM/gm\fP , \fIGS/gs\fP or  \fIXG/xg\fP
that are same as to \fI41\fP , \fI43\fP and \fI7e\fP.
.TP
.BI B " bank"
Sets the bank number of all channels to \fIbank\fP.
.RE

.TP
.B \-F
Turns  on  fast  panning to accommodate MIDI pieces
that expect panning  adjustments  to  affect  notes
that  are  already  playing.  Some files that don't
expect  this  have  a  habit  of  flipping  balance
rapidly  between  left  and  right, which can cause
severe popping when the -F flag is used.
.br
In current versions of TiMidity this option are toggled.

.TP
.B \-f
Toggles fast envelopes. This option makes TiMidity do fast
but the release time of the notes are shorten.

.TP
.BI \-g " sec"
Open the Sound-Spectrogram window. This option is activated if
the system has support for X Window System.

.TP
.B \-h
Show this help message.

.TP
.BI \-I " voice" [/c]
Uses the program number as the default  instrument.
Any  Program Change events in MIDI files will override
this option.
.br
If the \fIvoice\fP followed by \fI/c\fP the default program number
of the channel \fIc\fP is specified by the \fIvoice\fP.

.TP
.BI \-i " interface"
Selects the user interfaces from the compiled\-in
alternatives. \fIinterface\fP must be begun with one of the 
supported interface identifiers.  Run TiMidity with
the \-h option to see a list.  The following identifiers
may be available: 
.RS
.TP
.B \-id
dumb interface
.TP
.B \-in
ncurses interface(old version)
.TP
.B \-iN
NEW ncurses interface
.TP
.B \-is
slang interface
.TP
.B \-ia
X Ahtena Widget interface
.TP
.B \-ik
Tcl/Tk interface
.TP
.B \-im
motif interface
.TP
.B \-iT
vt100 interface
.TP
.B \-ie
Emacs interface (press \fBM\-x timidity\fP on \fIEmacs\fP)
.TP
.B \-ii
skin interface
.br
Environment variable \fBTIMIDITY_SKIN\fP must be specified with
path of the skin data(compressed data are also available).
.TP
.B Interface options
Option characters may be  added  immediately
after the interface identifier.  The following
options are recognized:
.PP
.TP
.B v
Increases verbosity level.  This option is cumulative.
.TP
.B q
Decreases verbosity level.  This option is cumulative.
.TP
.B t
Toggles trace mode.  In trace  mode,
TiMidity attempts  to  display  its
current state in real time.  For the
Linux  sound  driver, this is accomplished
through the use of short DMA
buffer fragments, which can be tuned
via the -B option.
.RE

.TP
.B \-j
This option enables to load the patch file while playing.

.TP
.B \-L " directory"
Adds \fIdirectory\fP to the library path.  Patch, configuration,
and  MIDI  files  are searched along this
path.  Directories  added  last  will  be  searched
first.   Note  that the current directory is always
searched first before the library path.

.TP
.BI \-n " degree"
Enables Noise Shaping Filter. \fIdegree\fP is from
\fI0\fP(min) to \fI4\fP(max).

.TP
.BI \-O " mode"
Selects the output mode from the compiled-in alternatives. 
mode must begin with one of the supported
output mode identifiers.  Run TiMidity with the  -h
option  to  see  a list.  The following identifiers
should be available in all versions:
.RS
.TP
.B \-Od
Outputs via audio device (default)
.TP
.B \-Or
Generate  raw  waveform  data.   All  format
options   are   supported.   Common  formats
include:
.RS
.TP
.B \-OrU
uLaw
.TP
.B \-Or1sl
16-bit signed linear PCM
.TP
.B \-Or8ul
8-bit unsigned linear PCM
.RE
.TP
.B \-Ou
Generate Sun Audio (au) file
.TP
.B \-Oa
Genetate AIFF file
.TP
.B \-Ow
Generate RIFF WAVE format output.  If output
is  directed  to  a non-seekable file, or if
TiMidity is interrupted before closing the
file, the file header will contain 0xFFFFFFFF in the RIFF and data
block length fields.  The popular sound conversion utility \fIsox\fP
is able to read such malformed files, so you can pipe data directly to
sox for on\-the\-fly conversion to other formats.
.TP
.B "Format options"
Option characters may be added immediately after the mode identifier
to change the output format.  The following options are recognized:
.RS
.LP
.TP
.B 8
8-bit sample width
.TP
.B 1
6-bit sample width
.TP
.B l
Linear encoding
.TP
.B U
uLaw (8-bit) encoding
.TP
.B M
Monophonic
.TP
.B S
Stereo
.TP
.B s
Signed output
.TP
.B u
Unsigned output
.TP
.B x
Byte-swapped output
.RE
.LP
Note that some options have no effect on some modes.  For example, you
cannot generate a byte-swapped RIFF WAVE file, or force uLaw output on
a Linux PCM device.
.RE
.LP
.TP
.BI \-o " filename"
Place output on \fIfilename\fP, which may be a file, device, or HP-UX
audio server, depending on the output mode selected with the \fB\-O\fP
option. The special filename ``\-'' causes output to be placed on
stdout.

.TP
.BI \-p " voices"
Sets polyphony (maximum number of simultaneous voices) to
\fIvoices\fP.

.TP
.BI \-Q " channel"
Causes \fIchannel\fP to be quiet.
If \fIchannel\fP is negative, channel \-\fIchannel\fP is turned back on.
If \fIchannel\fP is 0, all channels are turned on.
 
.TP
.BI \-R " value"
Enables Pseudo Reverb Mode. \fIvalue\fP are the following:
.RS
.TP
.B 0
Long slight release
.TP
.B 1
Long loud release
.TP
.B 2
Short release
.TP
.B 3
No release
.RE

.TP
.B \-r
This options causes another reverb effects.

.TP
.BI \-S " size"
Sets the re-sample cache size to \fIsize\fP bytes.
If \fIsize\fP equals to 0 any sample caches are disabled. 
Default value of \fIsize\fP is 2097152(2MB).

.TP
.BI \-s " frequency"
Sets the resampling frequency(\fBHz\fP or \fBkHz\fP). 
Not all sound devices are capable of all frequencies -- an approximate
frequency may be selected, depending on the implementation.

.TP
.BI -t " code"
Sets output coding of Japanese text. \fIcode\fP are the following:
.RS
.TP
.B auto
determined by \fILANG\fP environment variable.
.TP
.B ascii
Transrates non-ascii code to period.
.TP
.B euc
Outputs by EUC(Japan) coding.
.TP
.B jis
Outputs by JIS coding.
.TP
.B sjis
Outputs by SJIS coding.
.RE

.TP
.B \-U
Instructs TiMidity to unload all instruments from memory between
MIDI files.  This can reduce memory requirements when playing many
files in succession.

.TP
.BI \-w " mode"
Extend mode for MS\-Windows. The following options are available:
.RS
.TP
.BI \-w "r"
Use \fIrcpcv.dll\fP to play RCP/R36 files.
.TP
.BI \-w "R"
Not use \fIrcpcv.dll\fP (default).
.RE

.TP
.BI \-W " mode"
Play with WRD file.
\fImode\fP are the follwing:
.RS
.TP
.B x
X Window System mode
.TP
.B t
TTY mode
.TP
.B d
Dumb mode (outputs WRD events directry)
.TP
.B \-
not traces WRD
.RE
WRD mode must be with trace mode(option \fB\-i?t\fP) or 
timing of WRD events are terrible.

.TP
.B \-WR[opts]
Sets WRD options:
.RS
.TP
.B a1=b1,a2=b2, ...
Sets the WRD options. \fBan\fP is the name of option and \fBbn\fP is the
value.
.TP
.BI d="n"
Emulates timing(\fB@WAIT\fP,\fB@WMODE\fP) bugs of the original MIMPI player.
The emulate level is following:
.RS
.TP
.B -WRd=0
not emulates any bugs of MIMPI
.TP
.B -WRd=1
only emulates some bugs (default)
.TP
.B -WRd=2
emulates all known bugs
.RE

.TP
.BI F="filename"
Uses \fIfilename\fP as WRD file only  (input\-file\-name):r.wrd
(like csh syntax) is not available.
.TP
.BI f="filename"
Uses \fIfilername\fP as WRD file.
.RE

.TP
.BI \-x " string"
Configure TiMidity by the \fIstring\fP. The format of \fIstring\fP
is the same as timidity.cfg.
.br

For example:
.br
\fB\-x'bank 0\\n0 violin.pat'\fP
.br
Sets the instrument number 0 to violin.

Character \fB\\\fP(Ascii 0x5c) in the \fIstring\fP is treated 
as escape character like C literal. For example \fB\\n\fP is treated
as carridge return.
.RE

.TP
.BI \-Z " file"
Causes the table of frequencies to be read from \fIfile\fP. This is
useful to define a tuning different from the occidental temperate scale.

.P
.SH SEE ALSO
lsmidiprog(1), mididump(1), patinfo(1), sf2text(1), wav2pat(1), timidity.cfg(5)

.P
.SH COPYRIGHT
Copyright (C) 1999 Masanao Izumo <mo@goice.co.jp>
Copyright (C) 1995 Tuukka Toivonen <tt@cgs.fi>
.P
Original version was developed under the name of Tuukka Toivonen
<tt@cgs.fi> until the version of TiMidity-0.2i. His development was
discontinued because of his busy work.
.P
This program is free software; you can redistribute it and/or modify
it under the terms of the \fIGNU General Public License\fP as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.
.P
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the \fIGNU
General Public License\fP for more details.
.P
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


.SH AVAILABILITY
The latest release is available on the TiMidity++ Page,
.br
URL http://www.goice.co.jp/member/mo/timidity/
.br

.SH BUGS
8-bit and low-rate output sounds worse than it should.
.P
Eats more CPU time than a small CPU-time-eating animal.
.P
This man page translated from Japanese to English by me with
heavily poor English skill :-)

.P
.SH AUTHORS
\fBVersion 0.2i and earlier:\fP
.br
Tuukka Toivonen <toivonen@clinet.fi>
.br
Vincent Pagel <pagel@loria.fr>
.br
Takashi Iwai <iwai@dragon.mm.t.u-tokyo.ac.jp>
.br
Davide Moretti <dmoretti@iper.net>
.br
Chi Ming HUNG <cmhung@insti.physics.sunysb.edu>
.br
Riccardo Facchetti <riccardo@cdc8g5.cdc.polimi.it>
.P
\fBTiMidity++:\fP
.br
IZUMO Masanao <mo@goice.co.jp>
.br
HARADA Tomokazu <harada@prince.pe.u-tokyo.ac.jp>
.br
YAMATE Keiichirou <keiich-y@is.aist-nara.ac.jp>
.br
KIRYU Masaki <mkiryu@usa.net>
.br
AOKI Daisuke <dai@y7.net>
.br
MATSUMOTO Shoji <shom@i.h.kyoto-u.ac.jp>
.br
KOYANAGI Masaaki <koyanagi@okilab.oki.co.jp>
.br
IMAI Kunihiko <imai@leo.ec.t.kanazawa-u.ac.jp>
.br
NOGAMI Takaya <t-nogami@happy.email.ne.jp>
.br
WATANABE Takanori <takawata@shidahara1.planet.kobe-u.ac.jp>
.br
TAKEKAWA Hiroshi <sian@big.or.jp>
.br
NAGANO Daisuke <breeze.geo@geocities.co.jp> 
.br
YAMAHATA Isaku <yamahata@kusm.kyoto-u.ac.jp>
.br
KINOSHITA kosuke <kino@krhm.jvc-victor.co.jp>
.br
ARAI Yoshishige <ryo2@on.rim.or.jp>
.br
Glenn Trigg <ggt@netspace.net.au>
.P
and other many people sends information and bug\-fix codes.
.P

English version of this man page is written by
NAGANO Daisuke <breeze_geo@geocities.co.jp>.
.br
If any comments or suggestions or claims :) about this man page you have,
please tell me it.