1TSE3PLAY(1) User Manuals TSE3PLAY(1)
2
6 tse3play - play/convert music files (MIDI or TSE3MDL) using the TSE3
7 sequencer engine library
8
10 tse3play [-h] [-ver] [-v] [-list] [-nv] [-np] [-l] [-omidi output-midi-
11 file ] [-omidi0] [-omidicomp] [-otse3mdl output-tse3mdl-file ] [-map
12 from-midi-channel to-midi-channel ] [-m] [-r] [-gmr] [-gsr] [-xgr]
13 [-unix] [-oss] [-alsa] [-arts] [-stream] [-s start-time ] [-solo track
14 ] [-sl usecs ] [ -stop ] [ -e ] [ -mute channel ] [ -pd dir ] file ] [
15 -port port ] [ -fast ]
16
18 tse3play plays TSE3MDL files and MIDI files using the TSE3 sequencer
19 engine. It was originally developed as a test application for the TSE3
20 engine, but is now a fully featured playback application.
21 tse3play can also convert files between the two supported formats.
23 Whilst playing it provides text based visual feedback, or can stream an
24 English representation of the contents of the file to standard output.
25 MIDI files are a standard file format for the storage of musical (song)
27 data that can be found in abundance on the internet. They don't contain
28 the actual sounds played, but instructions on how to recreate the song
29 (i.e. start note/stop note commands). MIDI files are most often created
30 by a sequencer application (akin to a word processor for music). MIDI
31 files often have the extension .mid or .midi
32 TSE3MDL ( TSE3 Music Description Langauge ) files are a similar form of
34 music file. They are created by sequencer applications based on the
35 TSE3 sequencer engine library. The file format contains a great deal
36 more information and harnesses the full power of the TSE3 library.
37 TSE3MDL files often have the extension .tse3
38 The type of the input file is automatically detected by tse3play
40 tse3play can also load legacy TSE2MDL files from sequencers based on
41 the older TSE2 sequencer library.
42
44 -h, --help
45 Provide help on the tse3play command line parameters.
46 -ver, --version
48 Print version number and exit.
49 -v, --verbose
51 Give verbose output on what tse3play is trying to do.
52 -list, --list-ports
54 Lists the port numbers available on your platform.
55 -nv, --novisual
57 Don't produce visual feedback (text-based output-level indica‐
58 tor).
59 -np, --noplay
61 Don't play the input file (only perform a conversion - if one is
62 specified).
63 -l, --loop
65 Loop playback of the input file.
66 -omidi, --out-midi <filename>
68 Convert the loaded file to MIDI. File type will be MIDI type 1
69 unless -omidi0 is specified. The filename of the output follows
70 this option. You can specify '-' to output on stdandard out.
71 -omidi0, --out-midi-format-0
73 If performing a MIDI conversion, produce an output file in MIDI
74 type 0 format. For most cases the default (type 1) is recom‐
75 mended.
76 -omidicomp, --out-midi-compact
78 Compact the converted MIDI file output. This removes any redun‐
79 dant information in the MIDI file that could be removed by using
80 MIDI running status.
81 -otse3mdl, --out-tse3mdl FILENAME
83 Convert the file to tse3mdl format. The filename of the output
84 follows this option. You can specify '-' to output on stdandard
85 out.
86 -map, --map-channel F T
88 During playback, map MIDI channel F to MIDI channel T. Channel
89 numbers start at zero.
90 -m, --metronome
92 During playback, produce a metronome tick.
93 -r, --reset
95 Send a basic MIDI reset message at playback start and end. This
96 will send a reset message even if -np is specified.
97 -gmr, --gmreset
99 Send a General MIDI reset message at playback start and end.
100 This will send a reset message even if -np is specified.
101 -gsr, --gsreset
103 Send a GS reset message at playback start and end. This will
104 send a reset message even if -np is specified.
105 -xgr, --xgreset
107 Send an XG reset message at playback start and end. This will
108 send a reset message even if -np is specified.
109 -unix, --unix-scheduler
111 Selects the best Unix scheduler device (either OSS or ALSA) as
112 the MIDI output method. This is the default behaviour.
113 -oss, --oss-scheduler
115 Selects the Open Sound System interface as the MIDI output
116 method.
117 -alsa, --alsa-scheduler
119 Selects the ALSA interface as the MIDI output method. This will
120 only work if you have ALSA installed on your computer.
121 -arts, --arts-scheduler
123 Selects the aRts interface as the MIDI output method. This will
124 only work if you have aRts installed on your computer.
125 -stream, --stream-scheduler
127 Selects the standard output stream as the MIDI output method. An
128 English interpretation of each MIDI command generated will
129 appear on standard out.
130 -s, --start
132 Begin playback at the specified clock pulse. The pulses are
133 divisions of quarter notes. tse3play works to a resolution of
134 96 PPQN.
135 -solo, --solo-track
137 Play with the specified input track 'soloed'. This will mute all
138 the other tracks. Note that this option will mute the input
139 track from the file, not the specified MIDI channel. Track num‐
140 bers start at zero.
141 -sl, --sleep
143 Sets the time period that tse3play returns control back to the
144 operating system between updates. The parameter is a number of
145 u-seconds. The default value is 100. Specifying a shorter time
146 will make the real time vu bars update more responsively. A
147 value of 0 disables the sleep.
148 -stop, --no-stop
150 Prevents tse3play from exiting once playback has finished. This
151 can be used in conjunction with --echo and no specified filename
152 to make the computer act as a MIDI Thru box.
153 -e, --echo
155 Enable the MIDI echo facility, which is a soft MIDI Thru port.
156 Anything received on the MIDI in connection will be immediately
157 echoed on the MIDI out.
158 -mute, --mute-track
160 Mutes the specified track in the input file. The first track is
161 track zero.
162 -pd, --patches-dir
164 Specifies the path to the directory in which FM or GUS patch
165 files are to be found. This is used by the OSS driver to load
166 sounds into the soundcard.
167 -port, --force-port
169 Forces all output to the specified port.
170 -fast, --fast-midi
172 Tells tse3play to use a faster MIDI file import routine. This
173 will make the MIDI file playback start almost instantaneously
174 (especially noticeable for very large MIDI files). You can only
175 use this if you are not converting a file.
176 It has a number of possible side effects; (i) The MIDI file's
178 last time stamp is trusted to be correct (it might not be) (ii)
179 Stopping playback half way through may produce 'hanging notes'
180
182 Naturally, tse3play is completely bug free. The TSE3 library upon which
183 it is based is also completely bug free. However, if you do find some‐
184 thing goes wrong then contact the author. The program can only be
185 improved with your feedback.
186
188 Copyright (c) 2000,2001 Pete Goodliffe. See the license file in the
189 TSE3 doc diirectory for a complete license statement.
190
192 Pete Goodliffe <pete@cthree.org>
193 Trax Software 2001
195
197 playmidi(1), TSE3(3)
198Trax Software FEBRUARY 2001 TSE3PLAY(1)