1fluidsynth(1.0) fluidsynth(1.0)
2
6 fluidsynth - a SoundFont synthesizer
7
9 fluidsynth [options] [ soundfonts ] [ midifiles ]
10
12 fluidsynth is a real-time MIDI synthesizer based on the SoundFont(R) 2
13 specifications. It can be used to render MIDI input or MIDI files to
14 audio. The MIDI events are read from a MIDI device. The sound is ren‐
15 dered in real-time to the sound output device.
16 The easiest way to start the synthesizer is to give it a SoundFont on
18 the command line: 'fluidsynth soundfont.sf2'. fluidsynth will load the
19 SoundFont and read MIDI events from the default MIDI device using the
20 default MIDI driver. Once fluidsynth is running, it reads commands
21 from the stdin. There are commands to send MIDI events manually, to
22 load or unload SoundFonts, andsoforth. All the available commands are
23 discussed below.
24 fluidsynth can also be used to play a list of MIDI files. Simply run
26 fluidsynth with the SoundFont and the list of MIDI files to play. In
27 this case you might not want to open the MIDI device to read external
28 events. Use the -n option to deactivate MIDI input. If you also want to
29 deactivate the use of the shell, start fluidsynth with the -i option:
30 'fluidsynth -ni soundfont.sf2 midifile1.mid midifile2.mid'.
31 Run fluidsynth with the --help option to check for changes in the list
33 of options.
34
36 fluidsynth accepts the following options:
37 -h, --help
39 Show summary of options.
40 -V, --version
42 Show version of program.
43 -n, --no-midi-in
45 Don't create a midi driver to read MIDI input events [default =
46 yes]
47 -m, --midi-driver=[label]
49 The name of the midi driver to use [oss,alsa,alsa_seq,win‐
50 midi,...]
51 -K, --midi-channels=[num]
53 The number of midi channels [default = 16]
54 -a, --audio-driver=[label]
56 The audio driver [alsa,jack,oss,dsound,...]
57 -L, --audio-channels=[num]
59 The number of audio channels [default = 1]
60 -G, --audio-groups=[num]
62 The number of audio groups
63 -z, --audio-bufsize=[size]
65 Size of each audio buffer [default = %d]
66 -c, --audio-bufcount=[count]
68 Number of audio buffers [default = %d]
69 -r, --sample-rate
71 Set the sample rate
72 -R, --reverb
74 Turn the reverb on or off [0|1|yes|no, default = on]
75 -C, --chorus
77 Turn the chorus on or off [0|1|yes|no, default = on]
78 -g, --gain
80 Set the master gain [0 < gain < 10, default = 0.2]
81 -o setting=value
83 Set the value of the setting. Can be used any number of times.
84 Ex. -o midi.oss.device=/dev/midi00
85 -i, --no-shell
87 Don't read commands from the shell [default = yes]
88 -s, --server
90 Start a TCP/IP server for remote shells [default=no, port=9800]
91 -v, --verbose
93 Print out verbose messages about midi events
94
96 GENERAL
97 help Prints out a summary of the main commands
99 quit Quit the synthesizer
101 SOUNDFONTS
103 load filename
105 Load a SoundFont
106 unload number
108 Unload a SoundFont. The number is the index of the SoundFont on
109 the stack.
110 fonts Lists the current SoundFonts on the stack
112 inst number
114 Print out the available instruments for the SoundFont.
115 MIDI MESSAGES
117 noteon channel key velocity
119 Send a note-on event
120 noteoff channel key
122 Send a note-off event
123 cc channel ctrl value
125 Send a control change event
126 prog chan num
128 Send program-change message
129 select chan sfont bank prog
131 Combination of bank-select and program-change
132 channels
134 Print out the presets of all channels.
135 AUDIO SYNTHESIS
137 gain value
139 Set the master gain (0 < gain < 5)
140 interp num
142 Choose interpolation method for all channels
143 interpc chan num
145 Choose interpolation method for one channel
146 REVERB
148 reverb [0|1|on|off]
150 Turn the reverb on or off
151 rev_preset num
153 Load preset num into the reverb unit
154 rev_setroomsize num
156 Change reverb room size
157 rev_setdamp num
159 Change reverb damping
160 rev_setwidth num
162 Change reverb width
163 rev_setlevel num
165 Change reverb level
166 CHORUS
168 chorus [0|1|on|off]
170 Turn the chorus on or off
171 cho_set_nr n
173 Use n delay lines (default 3)
174 cho_set_level num
176 Set output level of each chorus line to num
177 cho_set_speed num
179 Set mod speed of chorus to num (Hz)
180 cho_set_depth num
182 Set chorus modulation depth to num (ms)
183 MIDI ROUTER
185 router_default
187 Reloads the default MIDI routing rules (input channels are
188 mapped 1:1 to the synth)
189 router_clear
191 Deletes all MIDI routing rules.
192 router_begin [note|cc|prog|pbend|cpress|kpress]
194 Starts a new routing rule for events of the given type
195 router_chan min max mul add
197 Limits the rule for events on min <= chan <= max. If the chan‐
198 nel falls into the window, it is multiplied by 'mul', then
199 router_par1 min max mul add
201 Limits parameter 1 (for example note number in a note events).
202 Similar to router_chan.
203 router_par2 min max mul add
205 Limits parameter 2 (for example velocity in a note event). Simi‐
206 lar to router_chan
207 router_end
209 Finishes the current rule and adds it to the router.
210 Router examples
212 router_clear
214 router_begin note
216 router_chan 0 7 0 15
218 router_end
220 Will accept only note events from the lower 8 MIDI
222 channels. Regardless of the channel, the synthesizer plays the
223 note on ch 15 (synthchannel=midichannel*0+15)
224 router_begin cc
226 router_chan 0 7 0 15
228 router_par1 1 1 0 64
230 router_add
232 Configures the modulation wheel to act as sustain pedal (trans‐
233 forms CC 1 to CC 64 on the lower 8 MIDI channels, routes to ch
234 15)
235
238 Peter Hanappe <hanappe@fluid-synth.org>
239 Markus Nentwig <nentwig@users.sourceforge.net>
240 Antoine Schmitt <as@gratin.org>
241 Josh Green <jgreen@users.sourceforge.net>
242 Stephane Letz <letz@grame.fr>
243 Please check the AUTHORS and THANKS files for all credits
245
247 SoundFont(R) is a registered trademark of E-mu Systems, Inc.
248 March 12, 2003 fluidsynth(1.0)