| 1 |
============================================================================== |
| 2 |
TiMidity++ -- MIDI to WAVE converter and player |
| 3 |
|
| 4 |
Masanao Izumo |
| 5 |
<mo@goice.co.jp> |
| 6 |
Apr.28.1999 |
| 7 |
version 2.0.0 or lator |
| 8 |
============================================================================== |
| 9 |
|
| 10 |
This program is free software; you can redistribute it and/or |
| 11 |
modify it under the terms of the GNU General Public |
| 12 |
License as published by the Free Software Foundation; |
| 13 |
either version 2 of the License, or (at your option) any |
| 14 |
later version. |
| 15 |
|
| 16 |
This program is free software; you can redistribute it and/or |
| 17 |
modify it under the terms of the GNU General Public |
| 18 |
License as published by the Free Software Foundation; |
| 19 |
either version 2 of the License, or (at your option) any |
| 20 |
later version. |
| 21 |
|
| 22 |
The original version of this program was written by Tuuka Tiovonen |
| 23 |
<tt@cgs.fi> until TiMidity 0.2i (he discontinued development |
| 24 |
because he was too busy with work). Masanao Izumo <mo@goice.co.jp> and |
| 25 |
other people began to hack it, then we officially released the new |
| 26 |
version, which is called TiMidity++. |
| 27 |
|
| 28 |
TiMidity was originally a converter that converted MIDI files to WAV |
| 29 |
audio files. But now TiMidity++ is not only a converter but also a |
| 30 |
real-time player that can play a MIDI file in real time. TiMidity does |
| 31 |
not requires an external MIDI instrument module to play MIDI file; it can |
| 32 |
perform with software power only. |
| 33 |
|
| 34 |
TiMidity++ uses GUS/patch (Glavis Ultrasound) as the voice data to play. |
| 35 |
It can also handle SoundFont data for voice data. |
| 36 |
|
| 37 |
*Features of TiMidity++: |
| 38 |
- Plays MIDI files without external MIDI instruments |
| 39 |
- Converts MIDI files to various audio file formats |
| 40 |
(ex. wav, au, etc.) |
| 41 |
- Uses GUS/patch and SoundFont for voice data |
| 42 |
- Displays some information about the music data during playback |
| 43 |
- Various user interfaces are available (ncurses, motif, xaw, etc..) |
| 44 |
- Plays MIDI files over a network |
| 45 |
- Plays MIDI files in archive files |
| 46 |
- Plays not only SMF files but also MOD, RCP/R36/G18/G36 |
| 47 |
- Can handle 32 channel data |
| 48 |
- Can handle user interfaces as dynamically linked modules |
| 49 |
- Can display a sound spectrogram |
| 50 |
- Automatically detects the mode of a MIDI file (GM/GS/XG) |
| 51 |
- Automatically detects drum channels (GS/XG) |
| 52 |
- Trace playing |
| 53 |
- Low load |
| 54 |
- The following MIDI events are supported: |
| 55 |
NoteOn/Off, KeyPressure, Program, ChannelPressure, Pitchwheel, |
| 56 |
ToneBank, ModulationWheel, MainVolume, Panning, Expression, |
| 57 |
Sustain, Portamento, DataEntry, ReverbEffect, ChorusEffect, |
| 58 |
RPN+/-, NRPN, RPN, AllSoundsOff, ResetControllers, AllNotesOff, |
| 59 |
Mono/Poly Part, RandomPan, KeyShift, |
| 60 |
TempoChange, Lyric, InsertText, KARAOKE-Part(@KMIDI), |
| 61 |
MasterVolume, MIDI-Reset, SystemExclusiveMessages |
| 62 |
|
| 63 |
*Usage: |
| 64 |
-format: timidity [options] midi-filenames |
| 65 |
|
| 66 |
-option: |
| 67 |
-A amplification |
| 68 |
Multiplies the master volume by amplification %. |
| 69 |
Default value is 70%. The grater number of amplification |
| 70 |
makes louder sounds. Range of the amplification is from 0 to 800%. |
| 71 |
|
| 72 |
-a Turns on anti-aliasing. Samples are run through a |
| 73 |
low-pass filter before playing, which reduces aliasing |
| 74 |
noise at low resampling frequencies. |
| 75 |
|
| 76 |
-B fragments |
| 77 |
For the Linux / FreeBSD / OSS / Windows sound |
| 78 |
driver, selects the number of buffer fragments |
| 79 |
in interactive mode. Increasing the number of |
| 80 |
fragments may reduce choppiness when many proc- |
| 81 |
esses are running. It will make TiMidity++ seem to |
| 82 |
respond sluggishly to fast forward, rewind, and |
| 83 |
volume controls, and it will throw the status |
| 84 |
display off sync. Specify a fragments of 0 to use |
| 85 |
the maximum number of fragments available. |
| 86 |
|
| 87 |
-b mode |
| 88 |
|
| 89 |
Enables pseudo surround effects. mode parameters |
| 90 |
are the following: |
| 91 |
-bl Sounds are comes mainly from left. |
| 92 |
-br Sounds are comes mainly from right. |
| 93 |
-bb Sounds are comes left and right in random. |
| 94 |
-bc Disables this feature. |
| 95 |
|
| 96 |
-C ratio |
| 97 |
Sets the ratio of sampling and control frequencies. |
| 98 |
This determines how often envelopes are recalcu- |
| 99 |
lated -- small ratios yield better quality but use |
| 100 |
more CPU time. |
| 101 |
|
| 102 |
-c filename |
| 103 |
Reads an extra configuration file. |
| 104 |
|
| 105 |
-D channel |
| 106 |
Marks channel as a drum channel. If channel is |
| 107 |
negative, channel -channel is marked as an instru- |
| 108 |
mental channel. If channel is 0, all channels are |
| 109 |
marked as instrumental. |
| 110 |
|
| 111 |
-d dir Specifies the directory contains installed dynamic- |
| 112 |
link interface modules. |
| 113 |
|
| 114 |
|
| 115 |
-e Make TiMidity++ evil. On Win32 version, this |
| 116 |
increases the task priority by one. It can give |
| 117 |
better playback when you switch tasks at the |
| 118 |
expense of slowing all other tasks down. |
| 119 |
|
| 120 |
-E mode |
| 121 |
Set TiMidity++ extend modes. The following modes are |
| 122 |
available (capitalized switch means disable this |
| 123 |
feature): |
| 124 |
w/W Enables/disables modulation controlling. |
| 125 |
p/P Enables/disables portamento controlling. |
| 126 |
v/V Enables/disables NRPM vibration. |
| 127 |
r/R Enables/disables reverb effect controlling. |
| 128 |
c/C Enables/disables chorus effect controlling. |
| 129 |
c ratio |
| 130 |
Sets the chorus effect value of all channels |
| 131 |
to ratio. |
| 132 |
s/S Enables/disables channel pressure control- |
| 133 |
ling. |
| 134 |
t/T Enables/disables tracing all Text Meta |
| 135 |
Events. |
| 136 |
o/O Accepts/rejects pronouncing multiple same |
| 137 |
notes. |
| 138 |
m HH Sets the manufacture ID to HH ( HH is the |
| 139 |
two hex-digits ). |
| 140 |
In addition if HH is GM/gm , GS/gs or XG/xg |
| 141 |
that are same as to 41 , 43 and 7e. |
| 142 |
B bank Sets the bank number of all channels to |
| 143 |
bank. |
| 144 |
|
| 145 |
-F Turns on fast panning to accommodate MIDI pieces |
| 146 |
that expect panning adjustments to affect notes |
| 147 |
that are already playing. Some files that don't |
| 148 |
expect this have a habit of flipping balance |
| 149 |
rapidly between left and right, which can cause |
| 150 |
severe popping when the -F flag is used. |
| 151 |
In current versions of TiMidity++ this option are |
| 152 |
toggled. |
| 153 |
|
| 154 |
-f Toggles fast envelopes. This option makes TiMidity++ |
| 155 |
do fast but the release time of the notes are |
| 156 |
shorten. |
| 157 |
|
| 158 |
-g sec Open the Sound-Spectrogram window. This option is |
| 159 |
activated if the system has support for X Window |
| 160 |
System. |
| 161 |
|
| 162 |
-h Show the help message. |
| 163 |
|
| 164 |
-I voice[/c] |
| 165 |
Uses the program number as the default instrument. |
| 166 |
Any Program Change events in MIDI files will over- |
| 167 |
ride this option. |
| 168 |
If the voice followed by /c the default program |
| 169 |
number of the channel c is specified by the voice. |
| 170 |
|
| 171 |
-i interface |
| 172 |
Selects the user interfaces from the compiled-in |
| 173 |
alternatives. interface must be begun with one of |
| 174 |
the supported interface identifiers. Run TiMidity++ |
| 175 |
with the -h option to see a list. The following |
| 176 |
identifiers may be available: |
| 177 |
-id dumb interface |
| 178 |
-in ncurses interface |
| 179 |
-is slang interface |
| 180 |
-ia X Athena Widget interface |
| 181 |
-ik Tcl/Tk interface |
| 182 |
-im motif interface |
| 183 |
-iT vt100 interface |
| 184 |
-ie Emacs interface (press M-x timidity on |
| 185 |
Emacs) |
| 186 |
-ii skin interface |
| 187 |
Environment variable TIMIDITY_SKIN must be |
| 188 |
specified with path of the skin data(com- |
| 189 |
pressed data are also available). |
| 190 |
|
| 191 |
Interface options |
| 192 |
Option characters may be added immediately |
| 193 |
after the interface identifier. The follow- |
| 194 |
ing options are recognized: |
| 195 |
|
| 196 |
v Increases verbosity level. This option is |
| 197 |
cumulative. |
| 198 |
q Decreases verbosity level. This option is |
| 199 |
cumulative. |
| 200 |
t Toggles trace mode. In trace mode, TiMid- |
| 201 |
ity attempts to display its current state |
| 202 |
in real time. For the Linux sound driver, |
| 203 |
this is accomplished through the use of |
| 204 |
short DMA buffer fragments, which can be |
| 205 |
tuned via the -B option. |
| 206 |
|
| 207 |
-j This option enables to load the patch file while |
| 208 |
playing. |
| 209 |
|
| 210 |
-L directory |
| 211 |
Adds directory to the library path. Patch, config- |
| 212 |
uration, and MIDI files are searched along this |
| 213 |
path. Directories added last will be searched |
| 214 |
first. Note that the current directory is always |
| 215 |
searched first before the library path. |
| 216 |
|
| 217 |
-n degree |
| 218 |
Enables Noise Shaping Filter. degree is from 0(min) |
| 219 |
to 4(max). |
| 220 |
|
| 221 |
-O mode |
| 222 |
Selects the output mode from the compiled-in alter- |
| 223 |
natives. mode must begin with one of the supported |
| 224 |
output mode identifiers. Run TiMidity++ with the -h |
| 225 |
option to see a list. The following identifiers |
| 226 |
should be available in all versions: |
| 227 |
-Od Output via audio device (default) |
| 228 |
-Or Generate raw waveform data. All format |
| 229 |
options are supported. Common formats |
| 230 |
include: |
| 231 |
-OrU uLaw |
| 232 |
-Or1sl 16-bit signed linear PCM |
| 233 |
-Or8ul 8-bit unsigned linear PCM |
| 234 |
-Ou Generate Sun Audio (au) file |
| 235 |
-Oa Generate AIFF file |
| 236 |
-Ow Generate RIFF WAVE format output. If output |
| 237 |
is directed to a non-seekable file, or if |
| 238 |
TiMidity++ is interrupted before closing the |
| 239 |
file, the file header will contain |
| 240 |
0xFFFFFFFF in the RIFF and data block length |
| 241 |
fields. The popular sound conversion util- |
| 242 |
ity sox is able to read such malformed |
| 243 |
files, so you can pipe data directly to sox |
| 244 |
for on-the-fly conversion to other formats. |
| 245 |
Format options |
| 246 |
Option characters may be added immediately |
| 247 |
after the mode identifier to change the out- |
| 248 |
put format. The following options are rec- |
| 249 |
ognized: |
| 250 |
8 8-bit sample width |
| 251 |
1 6-bit sample width |
| 252 |
l Linear encoding |
| 253 |
U uLaw (8-bit) encoding |
| 254 |
M Monophonic |
| 255 |
S Stereo |
| 256 |
s Signed output |
| 257 |
u Unsigned output |
| 258 |
x Byte-swapped output |
| 259 |
Note that some options have no effect on some |
| 260 |
modes. For example, you cannot generate a byte- |
| 261 |
swapped RIFF WAVE file, or force uLaw output on a |
| 262 |
Linux PCM device. |
| 263 |
|
| 264 |
-o filename |
| 265 |
Place output on filename, which may be a file, |
| 266 |
device, or HP-UX audio server, depending on the |
| 267 |
output mode selected with the -O option. The spe- |
| 268 |
cial filename ``-'' causes output to be placed on |
| 269 |
stdout. |
| 270 |
|
| 271 |
-p voices |
| 272 |
Sets polyphony (maximum number of simultaneous |
| 273 |
voices) to voices. |
| 274 |
|
| 275 |
-Q channel |
| 276 |
Causes channel to be quiet. If channel is nega- |
| 277 |
tive, channel -channel is turned back on. If chan- |
| 278 |
nel is 0, all channels are turned on. |
| 279 |
|
| 280 |
-R value |
| 281 |
Enables Pseudo Reverb Mode. value are the follow- |
| 282 |
ing: |
| 283 |
0 Long slight release |
| 284 |
1 Long loud release |
| 285 |
2 Short release |
| 286 |
3 No release |
| 287 |
|
| 288 |
-r This options causes another reverb effects. |
| 289 |
|
| 290 |
-s frequency |
| 291 |
Sets the resampling frequency(Hz or kHz). Not all |
| 292 |
sound devices are capable of all frequencies -- an |
| 293 |
approximate frequency may be selected, depending on |
| 294 |
the implementation. |
| 295 |
|
| 296 |
-U Instructs TiMidity++ to unload all instruments from |
| 297 |
memory between MIDI files. This can reduce memory |
| 298 |
requirements when playing many files in succession. |
| 299 |
|
| 300 |
-w mode |
| 301 |
Extend mode for MS-Windows. The following options are |
| 302 |
available: |
| 303 |
-wr Use rcpcv.dll to play RCP/R36 files. |
| 304 |
-wR Not use rcpcv.dll (default). |
| 305 |
|
| 306 |
-W mode |
| 307 |
Play with WRD file. mode are the follwing: |
| 308 |
x X Window System mode |
| 309 |
t TTY mode |
| 310 |
d Dumb mode (outputs WRD events directry) |
| 311 |
- not traces WRD |
| 312 |
WRD mode must be with trace mode(option -i?t) or timing of |
| 313 |
WRD events are terrible. |
| 314 |
|
| 315 |
-WR[opts] |
| 316 |
Sets WRD options: |
| 317 |
|
| 318 |
a1=b1,a2=b2, ... |
| 319 |
Sets the WRD options. an is the name of option and |
| 320 |
bn is the value. |
| 321 |
|
| 322 |
-WRd=n |
| 323 |
Emulates timing(@WAIT,@WMODE) bugs of the original |
| 324 |
MIMPI player. The emulate level is following: |
| 325 |
-WRd=0 |
| 326 |
not emulates any bugs of MIMPI |
| 327 |
-WRd=1 |
| 328 |
only emulates some bugs (default) |
| 329 |
-WRd=2 |
| 330 |
emulates all known bugs |
| 331 |
-WRF=filename |
| 332 |
Uses filename as WRD file only |
| 333 |
(input-file-name):r.wrd (like csh syntax) is not |
| 334 |
available. |
| 335 |
-WRf=filename |
| 336 |
Uses filername as WRD file. |
| 337 |
|
| 338 |
-x string |
| 339 |
Configure TiMidity++ by the string. The format of |
| 340 |
string is the same as timidity.cfg. |
| 341 |
For example: |
| 342 |
-x'bank 0\n0 violin.pat' |
| 343 |
Sets the instrument number 0 to violin. |
| 344 |
|
| 345 |
*Play the MIDI file in archive file: |
| 346 |
|
| 347 |
TiMidity++ can play a file contained in various kinds of archive file. The |
| 348 |
following archive formats are supported: |
| 349 |
|
| 350 |
- tar (*.tar) |
| 351 |
- gzipped tar (*.tar.gz, *.tgz) |
| 352 |
- zip file (*.zip) |
| 353 |
- lzh file (*.lzh) |
| 354 |
|
| 355 |
If you want to specify a certain MIDI file in the archive, describe the |
| 356 |
#<MIDI-filename> expression following the archive name. The |
| 357 |
expressions after the # are allowed to use regular expressions (case |
| 358 |
insensitive). Note that the single quotes are needed to prevent the |
| 359 |
shell from misinterpreting the # character. For example: |
| 360 |
|
| 361 |
timidity 'file.zip#file.mid' |
| 362 |
Plays file.mid in file.zip |
| 363 |
|
| 364 |
timidity 'file.lzh#*.mid' |
| 365 |
Plays any files that match the regular |
| 366 |
expression '*.mid' in file.zip |
| 367 |
|
| 368 |
timidity 'file.tgz#*' |
| 369 |
This expression is the same as |
| 370 |
timidity 'file.tgz' |
| 371 |
|
| 372 |
*Play the MIDI file over a network |
| 373 |
TiMidity++ can access a file over a network. Supported network protocols |
| 374 |
include HTTP, FTP and NNTP(NetNews); specify these as http://foo, |
| 375 |
ftp://foo, and news://foo respectively. An archived file is also |
| 376 |
accessible over a network. |
| 377 |
|
| 378 |
With NNTP, if you specify a newsgroup in the message-ID field TiMidity++ |
| 379 |
plays all MIDI files posted in the specified newsgroup. These MIDI files |
| 380 |
must be encoded using uuencode or the Multipart encoded |
| 381 |
uuencode/base64/hexbin. |
| 382 |
|
| 383 |
*Availability: |
| 384 |
The latest release of TiMidity++ are available in these sites: |
| 385 |
|
| 386 |
http://www.goice.co.jp/member/mo/timidity/ |
| 387 |
(Unix version; the developer's site) |
| 388 |
|
| 389 |
http://www.asahi-net.or.jp/~gb7t-ngm/timidity/ |
| 390 |
(Macintosh version) |
| 391 |
|
| 392 |
http://www2.off.ne.jp/~dai/timidity/timidity-izumo.html |
| 393 |
(Windows version) |
| 394 |
|
| 395 |
|
| 396 |
------------------------------------------------------------------------- |
| 397 |
This document was translated from the original README.jp (written in Japanese). |
| 398 |
Translator: NAGANO Daisuke <breeze_geo@geocities.co.jp> |
| 399 |
(And modified by Masanao Izumo <mo@goice.co.jp>) |
| 400 |
Proofreader: Mike Vanier (mvanier@bbb.caltech.edu) |
| 401 |
If you have any comments on or corrections for this translation, |
| 402 |
please tell us. |