OSDN Git Service

ebfa50c0492772b1fc53d3c58244cff14594e479
[timidity41/timidity41.git] / doc / C / timidity.1
1 .TH timidity 1 "March 25 2004" "2.13.0"
2 .SH NAME
3 TiMidity++ \- MIDI\-to\-WAVE converter and player
4 .SH SYNOPSIS
5 .B timidity
6 [options] filename [...]
7 .SH DESCRIPTION
8 \fBTiMidity++\fP is a converter that converts some of MIDI files
9 (supported formats: Standard MIDI files (*.mid), Recomposer files
10 (*.rcp, *.r36, *.g18, *.g36) and Module files (*.mod)) into formatted
11 audio files (e.g. RIFF WAVE).  \fBTiMidity++\fP uses Gravis
12 Ultrasound\-compatible patch files or Soundfonts (*.sfx, *.sf2) to
13 generate digital audio data from MIDI files.  The digital audio data
14 generated by \fBTiMidity++\fP can be stored in a file for processing,
15 or played in real time through an audio device.
16 .br
17 In real time playing, \fBTiMidity++\fP can show the lyrics contained
18 in KAR or WRD files.
19 .SH FILENAME
20 You can use the following expressions as the \fIfilename\fP argument:
21 .TP
22 .B \-
23 Read a MIDI file from standard input.
24 .TP
25 .B path/filename
26 Read a MIDI file from the specified path on a filesystem.
27 .TP
28 .B dir:directory
29 .br
30 .ns
31 .TP
32 .B directory/
33 Read and play all MIDI files in the specified \fIdirectory\fP.  For
34 example,
35 .sp
36 % timidity some/where/
37 .sp
38 plays all files in the directory \fBsome/where/\fP.
39 .TP
40 .B Archive File
41 Extract and play the file(s) in the archive.  If you want to specify a
42 certain MIDI file in the archive, append \fB#<MIDI\-filename>\fP to
43 the archive name.  The expression after `#' can use regular
44 expressions (case insensitive).
45 .br
46 You can use escape sequence \fB\\xHH\fP, where `HH' is a ASCII number
47 in hexadecimal integer.
48 .sp
49 For example:
50 .RS
51 .TP
52 % timidity file.zip#file.mid
53 Plays \fBfile.mid\fP in \fBfile.zip\fP
54 .TP
55 % timidity file.lzh#*.mid
56 Plays any files that match the regular expression \fB*.mid\fP in
57 \fBfile.lzh\fP
58 .TP
59 % timidity file.tgz#*
60 This expression is the same as \fBfile.tgz\fP
61 .LP
62 Since these mechanism are contained in \fBTiMidity++\fP itself, you
63 can use this syntax even in the MS Windows environment.
64 .sp
65 \fBTiMidity++\fP can handle the following archive formats:
66 .TP
67 .B tar (*.tar)
68 .TP
69 .B tar+gzip (*.tar.gz, *.tgz)
70 .TP
71 .B zip (*.zip)
72 .TP
73 .B lzh (*.lzh, *.lha)
74 (lh0, lh1, lh2, lh3, lh4, lh5, lh6, lz4, lzs and lz5 are available)
75 .LP
76 Other archives can be expanded if expander command is specified on the
77 compile phase.  \fBTiMidity++\fP will pipe that command.
78 .RE
79 .TP
80 .B news://news\-server[:port]/Message\-ID
81 .br
82 .ns
83 .TP
84 .B news://news\-server[:port]/newsgroup[/first\-last]
85 Play the MIDI file in the specified article on the news server.  If a
86 newsgroup is specified \fBTiMidity++\fP plays all MIDI files found in
87 any article posted to that newsgroup.
88 .br
89 \fBTiMidity++\fP parses MIME Multi\-part messages in case of
90 \fBnews://*\fP scheme, extracts MIDI file that was post to that group,
91 or in case of normal file, you can explicitly handle MIME documents by
92 naming that file with *.mime extension, or prefix that file with
93 \fBmime:\fP
94 .sp
95 The following MIME\-types are allowed:
96 .RS
97 .TP
98 .B uu\-encoded file
99 \fBbegin\fP
100 .br
101 is required
102 .TP
103 .B base64 encoded
104 \fBContent\-Transfer\-Encoding: base64\fP
105 .br
106 is required
107 .TP
108 .B quoted\-string
109 \fBContent\-Transfer\-Encoding: quoted\-string\fP
110 .br
111 is required
112 .TP
113 .B Mac BinHex format
114 only HQX format is available
115 .RE
116 .TP
117 .B http://address
118 .br
119 .ns
120 .TP
121 .B ftp://address
122 Play the file specified in the URL.
123 .sp
124 For example:
125 .RS
126 .TP
127 % timidity http://www.goice.co.jp/member/mo/dist/midi/impromptu.mid
128 plays the specified MIDI\-file directly from the network.
129 .LP
130 If these expression are used in the *.cfg files, you can even use
131 patch\-files (and others) from remote machines.
132 .RE
133 .SH INPUT FILE
134 \fBTiMidity++\fP can handle the following file formats:
135 .TP
136 .B .mid, .rmi (Format 0, 1, 2)
137 Standard MIDI File
138 .TP
139 .B .rcp, .r36, .g18, .g36 (Recomposer formats)
140 Recomposer format which is product for COME ON MUSIC co.
141 .TP
142 .B .mfi (MFi Version 3 \- Melody Format for i\-Mode)
143 i\-Mode is Japanese local mobile phone
144 .TP
145 .B .kar (Karaoke format)
146 Displays the lyrics as a Lyric Meta Event message.
147 .TP
148 .B .mod, mod.* (Module file)
149 .TP
150 .B .wrd (WRD format)
151 .SH OPTIONS
152 The following command line options are accepted by \fBTiMidity++\fP:
153 .TP
154 .BI "\-A " [n][,m](a)
155 .br
156 .ns
157 .TP
158 .BI "\-\-amplification " n
159 .br
160 .ns
161 .TP
162 .BI "\-\-drumpower " m
163 .br
164 .ns
165 .TP
166 .B \-\-[no\-]volume\-compensation
167 Multiplies the master volume by \fIn\fP%.  Default value is 70%.
168 Higher amplification makes louder sounds.  You can specify the drum
169 power, ratio of drum volume from the other channels.  The allowed
170 values of amplification range from \fB0\fP (no sound) to \fB800\fP.
171 .br
172 Optionally to put `a' character along with \fB\-a\fP option, or to use
173 \fB\-\-volume\-compensation\fP, instructs \fBTiMidity++\fP to
174 regularize the volume.  You can easily gain dynamic range.
175 .sp
176 For example:
177 .RS
178 .TP
179 .B \-A90
180 volume 90%, drum power 100%, compensation is off
181 .TP
182 .B \-A,120
183 volume 70%, drum power 120%, compensation is off
184 .TP
185 .B \-A90,120
186 volume 90%, drum power 120%, compensation is off
187 .TP
188 .B \-Aa
189 volume 70%, drum power 100%, compensation is on
190 .TP
191 .B \-A90a
192 volume 90%, drum power 100%, compensation is on
193 .TP
194 .B \-A,120a
195 volume 70%, drum power 120%, compensation is on
196 .TP
197 .B \-A90,120a
198 volume 90%, drum power 120%, compensation is on
199 .RE
200 .TP
201 .B \-a, \-\-[no\-]anti\-alias
202 Turns on antialiasing.  Samples are run through a lowpass filter
203 before playing, which reduces aliasing noise at low resampling
204 frequencies.
205 .TP
206 .BI "\-B, \-\-buffer\-fragments " n,m
207 For the Linux/FreeBSD/OSS/ALSA/Windows sound driver, selects the
208 number of buffer fragments in interactive mode.  Increasing the number
209 of fragments may reduce choppiness when many processes are running.
210 It will make \fBTiMidity++\fP seem to respond sluggishly to fast
211 forward, rewind, and volume controls, and it will throw the status
212 display off sync.  Specify a fragments number of 0 to use the maximum
213 number of fragments available.
214 .TP
215 .BI "\-C, \-\-control\-ratio " n
216 Sets the ratio of sampling and control frequencies.  This determines
217 how often envelopes are recalculated \-\- small ratios yield better
218 quality but use more CPU time.
219 .TP
220 .BI "\-c, \-\-config\-file " file
221 Reads an extra configuration file.
222 .TP
223 .BI "\-D, \-\-drum\-channel " n
224 Marks channel as a drum channel.  If channel is negative, channel
225 \-\fIn\fP is marked as an instrumental channel.  If \fIn\fP is
226 \fB0\fP, all channels are marked as instrumental.
227 .TP
228 .BI "\-d, \-\-interface\-path " dir
229 Specifies the directory containing installed dynamic\-link interface
230 modules.
231 .TP
232 .BI "\-E, \-\-ext " mode
233 Set \fBTiMidity++\fP extend modes.  The following modes are available
234 (capitalized switch means disable this feature):
235 .RS
236 .TP
237 .B w/W, \-\-[no\-]mod\-wheel
238 Enable/disable modulation controlling.
239 .TP
240 .B p/P, \-\-[no\-]portamento
241 Enable/disable portamento controlling.
242 .TP
243 .B v/V, \-\-[no\-]vibrato
244 Enable/disable NRPM vibration.
245 .TP
246 .B s/S, \-\-[no\-]ch\-pressure
247 Enable/disable channel pressure controlling.
248 .TP
249 .B e/E, \-\-[no\-]mod\-envelope
250 Enable/disable modulation envelope controlling.
251 .TP
252 .B t/T, \-\-[no\-]trace\-text\-meta
253 Enable/disable tracing all Text Meta Events.
254 .TP
255 .B o/O, \-\-[no\-]overlap\-voice
256 Accept/reject pronouncing multiple same notes.
257 .TP
258 .B z/Z, \-\-[no\-]temper\-control
259 Enable/disable MIDI Tuning Standard temperament controlling.
260 .TP
261 .BI "m, \-\-default\-mid " HH
262 Sets the manufacturer ID to \fIHH\fP (where \fIHH\fP are two
263 hex\-digits).
264 .br
265 \fIHH\fP values of \fBGS/gs\fP, \fBXG/xg\fP or \fBGM/gm\fP are
266 understood as \fB41\fP, \fB43\fP and \fB7e\fP respectively.
267 .TP
268 .BI "M, \-\-system\-mid " HH
269 Sets the system manufacturer ID to \fIHH\fP (where \fIHH\fP are two
270 hex\-digits).
271 .br
272 In this option, the manufacuture ID is set unchangable. Manufacuture
273 ID from the input file would be ignored.
274 .TP
275 .BI "b, \-\-default\-bank " n
276 Use tone bank \fIn\fP as the default.
277 .TP
278 .BI "B, \-\-force\-bank " n
279 Sets the bank number of all channels to \fIn\fP.
280 .TP
281 .BI "i, \-\-default\-program " n[/m]
282 Use the program number as the default instrument.  Any Program Change
283 events in MIDI files will override this option.
284 .br
285 If \fIn\fP is followed by \fI/m\fP the default program number of the
286 channel \fIm\fP is specified by \fIn\fP.
287 .TP
288 .BI "I, \-\-force\-program " n[/m]
289 Similar to \fB\-Ei\fP but this ignores all program changes.
290 .TP
291 .B "F " args
292 For effects.  See below.  In \fIargs\fP option, you can specify
293 following effect options:
294 .RS
295 .TP
296 .BI "delay=, \-\-delay " (d|l|r|b)[,msec]
297 Sets delay type.
298 .RS
299 .TP
300 .B d, 0
301 Disabled delay effect.
302 .TP
303 .B l, 1
304 Left delay.
305 .TP
306 .B r, 2
307 Right delay.
308 .TP
309 .B b, 3
310 Swap left & right.
311 .LP
312 Optional \fImsec\fP is the delay time.
313 .RE
314 .TP
315 .BI "chorus=, \-\-chorus " (d|n|s)[,level]
316 .RS
317 .TP
318 .B d, 0
319 Disable this effect.
320 .TP
321 .B n, 1
322 Enable MIDI chorus effect control.
323 .TP
324 .B s, 2
325 Surround sound, chorus detuned to a lesser degree (default).
326 .LP
327 The optional parameter \fIlevel\fP specifies the chorus level \fB0\fP
328 to \fB127\fP.
329 .RE
330 .TP
331 .BI "reverb=, \-\-reverb " (d|n|g|f|G)[,level]
332 .RS
333 .TP
334 .B d, 0
335 Disable MIDI reverb effect control.
336 .TP
337 .B n, 1
338 Enable MIDI reverb effect control.  This effect is only available in
339 stereo.
340 .TP
341 .B g, 2
342 Global reverb effect.
343 .TP
344 .B f, 3
345 Freeverb MIDI reverb effect control (default).
346 .TP
347 .B G, 4
348 Global freeverb effect.
349 .LP
350 The optional parameter \fIlevel\fP specifies the reverb level \fB0\fP
351 to \fB127\fP.
352 .RE
353 .TP
354 .BI "vlpf=, \-\-voice\-lpf " (d|c|m)
355 .RS
356 .TP
357 .B d, 0
358 Disable LPF effect.
359 .TP
360 .B c, 1
361 Chamberlin resonant LPF (12dB/oct) (default).
362 .TP
363 .B m, 2
364 Moog resonant low\-pass VCF (24dB/oct)
365 .RE
366 .TP
367 .BI "ns=, \-\-noise\-shaping " n
368 Enable the \fIn\fP th degree noiseshaping filter.  The distortion at
369 decay stage is improved, but the noise on human auditory feeling
370 increases because it shifts to a high frequency.  In case of 8\-bit
371 linear encoding, valid values of \fIn\fP are in the interval from
372 \fB0\fP (min) to \fB4\fP (max).  Default value is \fB4\fP.  In case of
373 16\-bit linear encoding, valid values of n are in the interval from
374 \fB0\fP to \fB4\fP.  According to the value, it works as following.
375 Default value is \fB4\fP.
376 .RS
377 .TP
378 .B 0
379 no noise shaping
380 .TP
381 .B 1
382 traditional noise shaping
383 .TP
384 .B 2
385 overdrive-like soft-clipping + new noise shaping
386 .TP
387 .B 3
388 tube-amplifier-like soft-clipping + new noise shaping
389 .TP
390 .B 4
391 new noise shaping
392 .RE
393 .TP
394 .BI "resamp=, \-\-resample " (d|l|c|L|n|g)
395 .RS
396 .TP
397 .B d, 0
398 No interpolation.
399 .TP
400 .B l, 1
401 Linear interpolation.
402 .TP
403 .B c, 2
404 Cubic spline interpolation.
405 .TP
406 .B L, 3
407 Lagrange method.
408 .TP
409 .B n, 4
410 Newton polynomial interpolation.
411 .TP
412 .B g, 5
413 Modified Gauss effect (default).
414 .LP
415 This option affects the behavior of \fB\-N\fP option.
416 .RE
417 .RE
418 .RE
419 .TP
420 .B \-e, \-\-evil
421 Make \fBTiMidity++\fP evil.  For the Win32 version, this increases the
422 task priority by one.  It can give better playback when you switch
423 tasks at the expense of slowing all other tasks down.
424 .TP
425 .B \-F, \-\-[no\-]fast\-panning
426 Turns on fast panning to accommodate MIDI pieces that expect panning
427 adjustments to affect notes that are already playing.  Some files that
428 don't expect this have a habit of flipping balance rapidly between
429 left and right, which can cause severe popping when the \fB\-F\fP flag
430 is used.
431 .br
432 In the current version of \fBTiMidity++\fP this option is a toggle.
433 .TP
434 .B \-f, \-\-[no\-]fast\-decay
435 Toggles fast envelopes.  This option makes \fBTiMidity++\fP faster but
436 the release time of the notes are shortened.
437 .TP
438 .BI "\-g, \-\-spectrogram " sec
439 Open the Sound\-Spectrogram window.  This option is activated if the
440 system has support for the X Window System.
441 .TP
442 .BI "\-H, \-\-force\-keysig " n
443 Specify the number of key signature.  MIDI file is performed with
444 transposition to the key of the number of sharp (when \fIn\fP is
445 positive) or flat (when \fIn\fP is negative).  Valid values of \fIn\fP
446 are in the interval from \fB\-7\fP to \fB7\fP.  For example, if \fIn\fP
447 is \fB1\fP, MIDI file with any tonality will be performed transposing
448 to \fB1\fP flat (i.e., F major or D minor).  Therefore, it is
449 convenient to use for the accompaniment when practicing a musical
450 instrument by the tonality which is easy to perform.
451 .TP
452 .B \-h, \-\-help
453 Show the help message.
454 .TP
455 .BI "\-i, \-\-interface " mode
456 .br
457 .ns
458 .TP
459 .BI "\-\-realtime\-priority " n
460 .br
461 .ns
462 .TP
463 .BI "\-\-sequencer\-ports " n
464 Selects the user interfaces from the compiled\-in alternatives.
465 \fImode\fP must be begun with one of the supported interface
466 identifiers.  Run \fBTiMidity++\fP with the \fB\-h\fP option to see a
467 list.
468 .br
469 For ALSA sequencer interface, optionally to use
470 \fB\-\-realtime\-priority\fP, set the realtime priority by \fIn\fP,
471 and to use \fB\-\-sequencer\-ports\fP, set the number of opened
472 sequencer ports.  Default value is \fB4\fP.
473 .br
474 The following identifiers may be available:
475 .RS
476 .TP
477 .B \-id
478 dumb interface
479 .TP
480 .B \-in
481 ncurses interface
482 .TP
483 .B \-is
484 S\-Lang interface
485 .TP
486 .B \-ia
487 X Athena Widget interface
488 .TP
489 .B \-ik
490 Tcl/Tk interface
491 .TP
492 .B \-im
493 Motif interface
494 .TP
495 .B \-iT
496 vt100 interface
497 .TP
498 .B \-ie
499 Emacs interface
500 .br
501 (use ``M\-x timidity'' in Emacs)
502 .TP
503 .B \-ii
504 skin interface
505 .br
506 Environment variable \fBTIMIDITY_SKIN\fP must be set to the path of
507 the skin data (compressed data are also supported).
508 .TP
509 .B \-ig
510 GTK+ interface
511 .TP
512 .B \-ir
513 Launch \fBTiMidity++\fP as MIDI server.
514 .TP
515 .B \-iA
516 Launch \fBTiMidity++\fP as ALSA sequencer client.
517 .TP
518 .B \-iW
519 Windodws synthesizer interface
520 .TP
521 .B \-iw
522 Windodws GUI interface
523 .TP
524 .B \-iP
525 PortMIDI synthesizer interface
526 .TP
527 .B \-ip
528 UMP interface
529 .TP
530 .B Interface options
531 Option characters may be added immediately after the interface
532 identifier.  The following options are recognized:
533 .RS
534 .TP
535 .B v, \-\-verbose=n
536 Increases verbosity level.  This option is cumulative.
537 .TP
538 .B q, \-\-quiet=n
539 Decreases verbosity level.  This option is cumulative.
540 .TP
541 .B t, \-\-[no\-]trace
542 Toggles trace mode.  In trace mode, \fBTiMidity++\fP attempts to
543 display its current state in real time.  For the Linux sound driver,
544 this is accomplished through the use of short DMA buffer fragments,
545 which can be tuned via the \fB\-B\fP option.
546 .TP
547 .B l, \-\-[no\-]loop
548 Loop playing (some interfaces ignore this option)
549 .TP
550 .B r, \-\-[no\-]random
551 Randomize file list arguments before playing
552 .TP
553 .B s, \-\-[no\-]sort
554 Sort file list arguments before playing
555 .TP
556 .B D, \-\-[no\-]background
557 Daemonize \fBTiMidity++\fP in background (for alsaseq only)
558 .RE
559 .RE
560 .TP
561 .B \-j, \-\-[no\-]realtime\-load
562 Enable the loading of patch files during play.
563 .TP
564 .BI "\-K, \-\-adjust\-key " n
565 Adjusts key (i.e., transposes the song) by \fIn\fP half tones.  Ranges
566 from \fB\-24\fP to \fB24\fP.
567 .TP
568 .BI "\-k, \-\-voice\-queue " msec
569 Specify audio queue time limit to reduce voices.  If the remaining
570 audio buffer is less than \fImsec\fP milliseconds, \fBTiMidity++\fP
571 tries to kill some voices.  This feature makes it possible to play
572 complicated MIDI files on slow CPUs.  Setting \fImsec\fP to zero tells
573 \fBTiMidity++\fP to never remove any voices.
574 .TP
575 .BI "\-L, \-\-patch\-path " path
576 Adds \fIpath\fP to the library path.  Patch, configuration, and MIDI
577 files are searched along this path.  Directories added last will be
578 searched first.  Note that the current directory is always searched
579 first before the library path.
580 .TP
581 .BI "\-M, \-\-pcm\-file " name
582 \fBTiMidity++\fP can play a PCM file instead of a MIDI file.  If
583 ``auto'' is specified, \fBTiMidity++\fP tries to open foo.mid.wav or
584 foo.mid.aiff when playing foo.mid.  If ``none'' is specified, this
585 feature is disabled.  Otherwise just plays \fIname\fP.
586 .TP
587 .BI "\-m, \-\-decay\-time " msec
588 Modify envelope volume decay time.  \fImsec\fP is the minimum number
589 of milliseconds to sustain a sustained note.
590 .RS
591 .TP
592 .B \-m0
593 Disable sustain ramping, causes constant volume sustains (default).
594 .TP
595 .B \-m1
596 Effectively behaves as if all sustains are ignored, volume ramping is
597 the same as normal stage 3.
598 .TP
599 .B \-m3000
600 A note at full volume will decay for \fB3\fP seconds once it begins to
601 be sustained (assuming the regular stage 3 rate would not cause it to
602 decay even longer).  Softer notes will of course die sooner.
603 .RE
604 .TP
605 .BI "\-N, \-\-interpolation " n
606 Sets interpolation parameter.  This option depends on the
607 \fB\-EFresamp\fP option's value.
608 .RS
609 .TP
610 .B cspline, lagrange
611 Toggles 4\-point linear interpolation (default is on).
612 .TP
613 .B newton
614 \fIn\fP point interpolation using Newton polynomials.  \fIn\fP must be
615 an odd number from \fB1\fP to \fB57\fP.
616 .TP
617 .B gauss
618 \fIn\fP+1 point modified Gauss interpolation.  Ranges \fB0\fP
619 (disable) to \fB34\fP (max), default to \fB25\fP.
620 .LP
621 In either way, linear interpolation is used if audio queue < 99%.
622 .RE
623 .TP
624 .BI "\-O, \-\-output\-mode " mode
625 Selects the output mode from the compiled\-in alternatives.
626 \fImode\fP must begin with one of the supported output mode
627 identifiers.  Run \fBTiMidity++\fP with the \fB\-h\fP option to see
628 the list.  The following identifiers are available in all versions:
629 .RS
630 .TP
631 .B \-Od
632 Outputs via audio device (default)
633 .TP
634 .B \-Os
635 Output to ALSA
636 .TP
637 .B \-Or
638 Generate raw waveform data.  All format options are supported.  Common
639 formats include:
640 .RS
641 .TP
642 .B \-OrU
643 u\-Law
644 .TP
645 .B \-Or1sl
646 16\-bit signed linear PCM
647 .TP
648 .B \-Or8ul
649 8\-bit unsigned linear PCM
650 .RE
651 .TP
652 .B \-Ou
653 Generate Sun Audio (au) data
654 .TP
655 .B \-Oa
656 Generate AIFF data
657 .TP
658 .B \-Ow
659 Generate RIFF WAVE format output.  If output is directed to a
660 non\-seekable file, or if \fBTiMidity++\fP is interrupted before
661 closing the file, the file header will contain 0xffffffff in the RIFF
662 and data block length fields.  The popular sound conversion utility
663 sox is able to read such malformed files, so you can pipe data
664 directly to sox for on\-the\-fly conversion to other formats.
665 .TP
666 .B \-Ol
667 List MIDI events
668 .TP
669 .B \-OM
670 MOD \-> MIDI conversion
671 .TP
672 .B \-Oe
673 EsounD
674 .TP
675 .B \-Op
676 PortAudio
677 .TP
678 .B \-Oj
679 JACK
680 .TP
681 .B \-Or
682 aRts
683 .TP
684 .B \-OA
685 Alib
686 .TP
687 .B \-Ov
688 ogg vorbis
689 .TP
690 .B Format options
691 Option characters may be added immediately after the mode identifier
692 to change the output format.  The following options are recognized:
693 .RS
694 .TP
695 .B S, \-\-output\-stereo
696 Stereo
697 .TP
698 .B M, \-\-output\-mono
699 Monophonic
700 .TP
701 .B s, \-\-output\-signed
702 Signed output
703 .TP
704 .B u, \-\-output\-unsigned
705 Unsigned output
706 .TP
707 .B 1, \-\-output\-16bit
708 16\-bit sample width
709 .TP
710 .B 2, \-\-output\-24bit
711 24\-bit sample width
712 .TP
713 .B 8, \-\-output\-8bit
714 8\-bit sample width
715 .TP
716 .B l, \-\-output\-linear
717 Linear encoding
718 .TP
719 .B U, \-\-output\-ulaw
720 u\-Law (8\-bit) encoding
721 .TP
722 .B A, \-\-output\-alaw
723 A\-Law encoding
724 .TP
725 .B x, \-\-[no\-]output\-swab
726 Byte\-swapped output
727 .LP
728 Note that some options have no effect on some modes.  For example, you
729 cannot generate a byte\-swapped RIFF WAVE file, or force uLaw output
730 on a Linux PCM device.
731 .RE
732 .RE
733 .TP
734 .BI "\-o, \-\-output\-file " file
735 Place output on \fIfile\fP, which may be a file, device, or HP\-UX
736 audio server, depending on the output mode selected with the \fB\-O\fP
737 option.  The special filename `\-' causes output to be placed on
738 stdout.
739 .TP
740 .BI "\-P, \-\-patch\-file " file
741 Use patch file for all programs.
742 .TP
743 .BI "\-p " [n](a)
744 .br
745 .ns
746 .TP
747 .BI "\-\-polyphony " n
748 .br
749 .ns
750 .TP
751 .B \-\-[no\-]polyphony\-reduction
752 Sets polyphony (maximum number of simultaneous voices) to \fIn\fP.
753 .br
754 Optionally to put `a' character along with \fB\-p\fP option, or to use
755 \fB\-\-polyphony\-reduction\fP, instructs \fBTiMidity++\fP to enable
756 automatic polyphony reduction algorithm.
757 .TP
758 .BI "\-Q " n[,...](t)
759 .br
760 .ns
761 .TP
762 .BI "\-\-mute " n[,...]
763 .br
764 .ns
765 .TP
766 .BI "\-\-temper\-mute " n[,...]
767 Cause channel \fIn\fP to be quiet.  \fIn\fP can carry out package
768 specification by `,'.  If \fIn\fP is \fB0\fP, all channels are turned
769 off.  Continuously, specifying \-\fIn\fP, channel \fIn\fP is turned
770 back on.
771 .br
772 On the other hand, to put `t' character after \fB\-Q\fP option or to
773 use \fB\-\-temper\-mute\fP describes temperament mute.  This mutes
774 channels of specific temperament type \fIn\fP.  For preset
775 temperament, \fIn\fP can range \fB0\fP to \fB3\fP.  For user\-defined
776 temperament, \fIn\fP can range \fB4\fP to \fB7\fP.
777 .TP
778 .BI "\-q, \-\-audio\-buffer " sec/n
779 Specify audio buffer in seconds.  \fIsec\fP maximum size of buffer,
780 \fIn\fP percentage filled at the beginning (default is \fB5.0/100\fP)
781 (size of 100% equals the whole device buffer size).
782 .TP
783 .BI "\-R " msec
784 Enables Pseudo Reverb Mode.  It sets every instrument's release to
785 \fImsec\fP ms.  If \fImsec\fP is \fB0\fP, \fImsec\fP is set to
786 \fB800\fP (default).
787 .TP
788 .BI "\-S, \-\-cache\-size " n
789 Sets the re\-sample cache size to \fIn\fP bytes.  If \fIn\fP equals
790 \fB0\fP any sample caches are disabled.  The default value of
791 \fIn\fP is \fB2097152\fP (2MB).
792 .TP
793 .BI "\-s, \-\-sampling\-freq " freq
794 Sets the resampling frequency (Hz or kHz).  Not all sound devices are
795 capable of all frequencies \-\- an approximate frequency may be
796 selected, depending on the implementation.
797 .TP
798 .BI "\-T, \-\-adjust\-tempo " n
799 Adjust tempo to \fIn\fP%; \fB120\fP play MOD files with an NTSC
800 Amiga's timing.
801 .TP
802 .BI "\-t, \-\-output\-charset " code
803 Sets output coding of Japanese text.  Possible values of \fIcode\fP
804 are:
805 .RS
806 .TP
807 .B auto
808 determined by the LANG environment variable.
809 .TP
810 .B ascii
811 Translates non\-ASCII code to period.
812 .TP
813 .B nocnv
814 No conversion.
815 .TP
816 .B 1251
817 Convert from windows\-1251 to koi8\-r.
818 .TP
819 .B euc
820 Outputs EUC (Japan) coding.
821 .TP
822 .B jis
823 Outputs JIS coding.
824 .TP
825 .B sjis
826 Outputs SJIS coding.
827 .RE
828 .TP
829 .B \-U, \-\-[no\-]unload\-instruments
830 Unload all instruments from memory between MIDI files.  This can
831 reduce memory requirements when playing many files in succession.
832 .TP
833 .BI "\-V, \-\-volume\-curve " power
834 Set the power of volume curve.  The total amplification becomes
835 volume^\fIpower\fP.  \fB0\fP (default) uses the regular tables.  Any
836 non\-zero value causes all midi to use the new user defined
837 velocity/volume/expression curve (linear: \fB1\fP, ideal:
838 ~\fB1.661\fP, GS: ~\fB2\fP).
839 .TP
840 .B \-v, \-\-version
841 Show the version string
842 .TP
843 .BI "\-W, \-\-wrd " mode
844 Play WRD file.
845 .sp
846 Allowed values of \fImode\fP are:
847 .RS
848 .TP
849 .B x
850 X Window System mode
851 .TP
852 .B w
853 Windows console mode
854 .TP
855 .B t
856 TTY mode
857 .TP
858 .B d
859 Dumb mode (outputs WRD events directory)
860 .TP
861 .B \-
862 do not trace WRD
863 .TP
864 .B R[opts]
865 Sets WRD options:
866 .RS
867 .TP
868 .B a1=b1,a2=b2,...
869 Sets the WRD options.  \fBan\fP is the name of option and \fBbn\fP is
870 the value.
871 .TP
872 .B d=n
873 Emulates timing (@WAIT, @WMODE) bugs of the original MIMPI player.
874 The emulation levels are:
875 .RS
876 .TP
877 .B \-WRd=0
878 do not emulate any bugs of MIMPI
879 .TP
880 .B \-WRd=1
881 only emulate some bugs (default)
882 .TP
883 .B \-WRd=2
884 emulate all known bugs
885 .RE
886 .TP
887 .B F=file
888 Use \fIfile\fP as WRD file only no file matching *.wrd is found.
889 .TP
890 .B f=file
891 Uses \fIfile\fP as WRD file.
892 .RE
893 .LP
894 WRD mode must also use trace mode (option \fB\-i?t\fP) or
895 the timing of the WRD events will be terrible.
896 .RE
897 .TP
898 .BI "\-w, \-\-rcpcv\-dll " mode
899 Extended mode for MS Windows.  The following options are available:
900 .RS
901 .TP
902 .BI "\-w " r
903 Use rcpcv.dll to play RCP/R36 files.
904 .TP
905 .BI "\-w " R
906 Do not use rcpcv.dll (default).
907 .RE
908 .TP
909 .BI "\-x \-\-config\-string " str
910 Configure \fBTiMidity++\fP with \fIstr\fP.  The format of \fIstr\fP is
911 the same as \fBtimidity.cfg\fP.
912 .sp
913 For example:
914 .br
915 \fB\-x'bank 0\\n0 violin.pat'\fP
916 .br
917 Sets the instrument number 0 to violin.
918 .br
919 Character `\\' (Ascii 0x5c) in the \fIstr\fP is treated as escape
920 character like in C literals.  For example \fB\\n\fP is treated as
921 carriage return.
922 .TP
923 .BI "\-Z, \-\-freq\-table " file
924 Cause the table of frequencies to be read from \fIfile\fP.  This is
925 useful to define a tuning different from 12\-equal temperament.  If
926 ``pure'' is specified, TiMidity++ plays in trial pure intonation.
927 .RS
928 .TP
929 .BI "\-Zpure, \-\-pure\-intonation " [n(m)]
930 Play in trial pure intonation by Key Signature meta\-event in the MIDI
931 file.  You can specify the initial keysig by hand, in case the MIDI
932 file does not contains the meta\-event.  Optionally, \fIn\fP is the
933 number of key signature.  In case of sharp, \fIn\fP is positive.  In
934 case of flat, \fIn\fP is negative.  Valid values of \fIn\fP are in the
935 interval from \fB\-7\fP to \fB7\fP.  In case of minor mode, you should
936 put `a' character along with \fB\-Zpure\fP option.
937 .RE
938 .TP
939 .BI "\-\-module=" n
940 Simulate behavior of specific synthesizer module as much as possible.
941 For the moment, the value of \fIn\fP defined is as follows:
942 .RS
943 .TP
944 .B 0
945 \fBTiMidity++\fP Default
946 .TP
947 .B 1
948 Roland SC\-55
949 .TP
950 .B 2
951 Roland SC\-88
952 .TP
953 .B 3
954 Roland SC\-88Pro
955 .TP
956 .B 4
957 Roland SC\-8850
958 .TP
959 .B 5\-15
960 Reserved for GS family
961 .TP
962 .B 16
963 YAMAHA MU\-50
964 .TP
965 .B 17
966 YAMAHA MU\-80
967 .TP
968 .B 18
969 YAMAHA MU\-90
970 .TP
971 .B 19
972 YAMAHA MU\-100
973 .TP
974 .B 20\-31
975 Reserved for XG family
976 .TP
977 .B 32
978 SoundBlaster Live!
979 .TP
980 .B 33
981 SoundBlaster Audigy
982 .TP
983 .B 34\-111
984 Reserved for other synthesizer modules
985 .TP
986 .B 112
987 \fBTiMidity++\fP Special 1
988 .TP
989 .B 113\-126
990 Reserved for \fBTiMidity++\fP specification purposes
991 .TP
992 .B 127
993 \fBTiMidity++\fP Debug
994 .RE
995 .SH SEE ALSO
996 lsmidiprog(1), mididump(1), patinfo(1), sf2text(1), wav2pat(1),
997 timidity.cfg(5)
998 .SH COPYRIGHT
999 Copyright (C) 1999\-2004 Masanao Izumo <iz@onicos.co.jp>
1000 .br
1001 Copyright (C) 1995 Tuukka Toivonen <tt@cgs.fi>
1002 .LP
1003 The original version was developed by Tuukka Toivonen <tt@cgs.fi>
1004 until the release of TiMidity\-0.2i.  His development was discontinued
1005 because of his being busy with work.
1006 .LP
1007 This program is free software; you can redistribute it and/or modify
1008 it under the terms of the \fIGNU General Public License\fP as
1009 published by the Free Software Foundation; either version 2 of the
1010 License, or (at your option) any later version.
1011 .LP
1012 This program is distributed in the hope that it will be useful, but
1013 WITHOUT ANY WARRANTY; without even the implied warranty of
1014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the \fIGNU
1015 General Public License\fP for more details.
1016 .LP
1017 You should have received a copy of the GNU General Public License
1018 along with this program; if not, write to the Free Software
1019 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111\-1307
1020 USA
1021 .SH AVAILABILITY
1022 The latest release is available on the \fBTiMidity++\fP Page,
1023 .LP
1024 URL http://www.timidity.jp/
1025 .SH BUGS
1026 Eats more CPU time than a small CPU\-time\-eating animal.
1027 .LP
1028 This man page was translated from Japanese to English by me with
1029 poor English skill :\-)
1030 .SH AUTHORS
1031 .TP
1032 .B Version 0.2i and earlier:
1033 Tuukka Toivonen <tt@cgs.fi>
1034 .br
1035 Vincent Pagel <pagel@loria.fr>
1036 .br
1037 Takashi Iwai <tiwai@suse.de>
1038 .br
1039 Davide Moretti <dave@rimini.com>
1040 .br
1041 Chi Ming HUNG <cmhung@insti.physics.sunysb.edu>
1042 .br
1043 Riccardo Facchetti <riccardo@cdc8g5.cdc.polimi.it>
1044 .TP
1045 .B TiMidity++:
1046 IZUMO Masanao <iz@onicos.co.jp>
1047 .br
1048 HARADA Tomokazu <harada@prince.pe.u\-tokyo.ac.jp>
1049 .br
1050 YAMATE Keiichirou <keiich\-y@is.aist\-nara.ac.jp>
1051 .br
1052 KIRYU Masaki <mkiryu@usa.net>
1053 .br
1054 AOKI Daisuke <dai@y7.net>
1055 .br
1056 MATSUMOTO Shoji <shom@i.h.kyoto\-u.ac.jp>
1057 .br
1058 KOYANAGI Masaaki <koyanagi@okilab.oki.co.jp>
1059 .br
1060 IMAI Kunihiko <imai@leo.ec.t.kanazawa\-u.ac.jp>
1061 .br
1062 NOGAMI Takaya <t\-nogami@happy.email.ne.jp>
1063 .br
1064 WATANABE Takanori <takawata@shidahara1.planet.kobe\-u.ac.jp>
1065 .br
1066 TAKEKAWA Hiroshi <sian@big.or.jp>
1067 .br
1068 NAGANO Daisuke <breeze.nagano@nifty.ne.jp>
1069 .br
1070 KINOSHITA kosuke <kino@krhm.jvc\-victor.co.jp>
1071 .br
1072 SHIGEMURA Norikatsu <nork@ninth\-nine.com>
1073 .br
1074 YAMAHATA Isaku <yamahata@kusm.kyoto\-u.ac.jp>
1075 .br
1076 ARAI Yoshishige <ryo2@on.rim.or.jp>
1077 .br
1078 Glenn Trigg <ggt@netspace.net.au>
1079 .br
1080 Tim Allen <thristian@usa.net>
1081 .br
1082 Michael Haardt <michael@moria.de>
1083 .br
1084 Eric A. Welsh <ewelsh@ccb.wustl.edu>
1085 .br
1086 Paolo Bonzini <bonzini@gnu.org>
1087 .br
1088 KIMOTO Masahiko <kimoto@ohnolab.org>
1089 .br
1090 IWAI Takashi <tiwai@suse.de>
1091 .br
1092 Saito <saito2@digitalme.com>
1093 .br
1094 SATO Kentaro <kentaro@ps.catv.ne.jp>
1095 .br
1096 TAMUKI Shoichi <tamuki@linet.gr.jp>
1097 .br
1098 URABE Shohei <root@mput.dip.jp>
1099 .br
1100 SUENAGA Keishi <s_keishi@mutt.freemail.ne.jp>
1101 .br
1102 SUZUKI Koji <k@kekyo.net>
1103 .LP
1104 (titles omitted and an order different)
1105 .LP
1106 and other many people sends information and bug\-fix codes.
1107 .LP
1108 The English version of this man page was written by NAGANO Daisuke
1109 <breeze.nagano@nifty.ne.jp>.
1110 .LP
1111 Now, TAMUKI Shoichi <tamuki@linet.gr.jp> and URABE Shohei
1112 <root@mput.dip.jp> are maintaining.
1113 .br
1114 If you have any comments or suggestions or complaints :) about this
1115 man page, please tell us it.