audio-channels int 1 1 128 By default, the synthesizer outputs a single stereo signal. Using this option, the synthesizer can output multi-channel audio. Sets the number of stereo channel pairs. So 1 is actually 2 channels (a stereo pair). audio-groups int 1 1 128 The output audio channel associated with a MIDI channel is wrapped around using the number of synth.audio-groups as modulo divider. This is typically the number of output channels on the sound card, as long as the LADSPA Fx unit is not used. In case of LADSPA unit, think of it as subgroups on a mixer. chorus.active bool 1 (TRUE) When set to 1 (TRUE) the chorus effects module is activated. Otherwise, no chorus will be added to the output signal. Note that the amount of signal sent to the chorus module depends on the "chorus send" generator defined in the SoundFont. chorus.depth num 8.0 0.0 256.0 Specifies the modulation depth of the chorus. chorus.level num 2.0 0.0 10.0 Specifies the output amplitude of the chorus signal. chorus.nr int 3 0 99 Sets the voice count of the chorus. chorus.speed num 0.3 0.1 5.0 Sets the modulation speed in Hz. cpu-cores int 1 1 256 Sets the number of synthesis CPU cores. If set to a value greater than 1, additional synthesis threads will be created to do the actual rendering work that is then returned synchronously by the render function. This has the affect of utilizing more of the total CPU for voices or decreasing render times when synthesizing audio. So for example, if you set cpu-cores to 4, fluidsynth will attempt to split the synthesis work it needs to do between the client's calling thread and three additional (internal) worker threads. As soon as all threads have done their work, their results are collected and the resulting buffer is returned to the caller. default-soundfont str C:\soundfonts\default.sf2 (Windows),
${CMAKE_INSTALL_PREFIX}/share/soundfonts/default.sf2 (all others)
The default soundfont file to use by the fluidsynth executable. The default value can be overridden during compilation time by setting the DEFAULT_SOUNDFONT cmake variable.
device-id int 0 0 126 Device identifier used for SYSEX commands, such as MIDI Tuning Standard commands. Fluidsynth will only process those SYSEX commands destined for this ID. Broadcast commands (with ID=127) will always be processed. dynamic-sample-loading bool 0 (FALSE) When set to 1 (TRUE), samples are loaded to and unloaded from memory on demand. effects-channels int 2 2 2 Specifies the number of effects per effects group. Currently this value can not be changed so there are always two effects per group available (reverb and chorus). effects-groups int 1 1 128 Specifies the number of effects groups. By default, the sound of all voices is rendered by one reverb and one chorus effect respectively (even for multi-channel rendering). This setting gives the user control which effects of a voice to render to which independent audio channels. E.g. setting synth.effects-groups == synth.midi-channels allows to render the effects of each MIDI channel to separate audio buffers. If synth.effects-groups is smaller than the number of MIDI channels, it will wrap around. Note that any value >1 will significantly increase CPU usage. gain num 0.2 0.0 10.0 The gain is applied to the final or master output of the synthesizer. It is set to a low value by default to avoid the saturation of the output when many notes are played. ladspa.active bool 0 (FALSE) When set to 1 (TRUE) the LADSPA subsystem will be enabled. This subsystem allows to load and interconnect LADSPA plug-ins. The output of the synthesizer is processed by the LADSPA subsystem. Note that the synthesizer has to be compiled with LADSPA support. More information about the LADSPA subsystem can be found in doc/ladspa.md or on the FluidSynth website. lock-memory bool 1 (TRUE) Page-lock memory that contains audio sample data, if true. midi-channels int 16 16 256 This setting defines the number of MIDI channels of the synthesizer. The MIDI standard defines 16 channels, so MIDI hardware is limited to this number. Internally FluidSynth can use more channels which can be mapped to different MIDI sources. midi-bank-select str gs gs, gm, xg, mma This setting defines how the synthesizer interprets Bank Select messages.
  • gs: (default) CC0 becomes the bank number, CC32 is ignored.
  • gm: ignores CC0 and CC32 messages.
  • xg: CC32 becomes the bank number, CC0 toggles between melodic or drum channel.
  • mma: bank is calculated as CC0*128+CC32.
min-note-length int 10 0 65535 Sets the minimum note duration in milliseconds. This ensures that really short duration note events, such as percussion notes, have a better chance of sounding as intended. Set to 0 to disable this feature. overflow.age num 1000.0 -10000.0 10000.0 This score is divided by the number of seconds this voice has been active and is added to the overflow priority. It is usually a positive value and gives voices which have just been started a higher priority, making them less likely to be killed in an overflow situation. overflow.important num 5000.0 -50000.0 50000.0 This score is added to voices on channels marked with the synth.overflow.important-channels setting. overflow.important-channels str (empty string) This setting is a comma-separated list of MIDI channel numbers that should be treated as "important" by the overflow calculation, adding the score set by synth.overflow.important to each voice on those channels. It can be used to make voices on particular MIDI channels less likely (synth.overflow.important > 0) or more likely (synth.overflow.important < 0) to be killed in an overflow situation. Channel numbers are 1-based, so the first MIDI channel is number 1. overflow.percussion num 4000.0 -10000.0 10000.0 Sets the overflow priority score added to voices on a percussion channel. This is usually a positive score, to give percussion voices a higher priority and less chance of being killed in an overflow situation. overflow.released num -2000.0 -10000.0 10000.0 Sets the overflow priority score added to voices that have already received a note-off event. This is usually a negative score, to give released voices a lower priority so that they are killed first in an overflow situation. overflow.sustained num -1000.0 -10000.0 10000.0 Sets the overflow priority score added to voices that are currently sustained. With the default value, sustained voices are considered less important and are more likely to be killed in an overflow situation. overflow.volume num 500.0 -10000.0 10000.0 Sets the overflow priority score added to voices based on their current volume. The voice volume is normalized to a value between 0 and 1 and multiplied with this setting. So voices with maximum volume get added the full score, voices with only half that volume get added half of this score. polyphony int 256 1 65535 The polyphony defines how many voices can be played in parallel. A note event produces one or more voices. Its good to set this to a value which the system can handle and will thus limit FluidSynth's CPU usage. When FluidSynth runs out of voices it will begin terminating lower priority voices for new note events. reverb.active bool 1 (TRUE) When set to 1 (TRUE) the reverb effects module is activated. Otherwise, no reverb will be added to the output signal. Note that the amount of signal sent to the reverb module depends on the "reverb send" generator defined in the SoundFont. reverb.damp num 0.0 0.0 1.0 Sets the amount of reverb damping. reverb.level num 0.9 0.0 1.0 Sets the reverb output amplitude. reverb.room-size num 0.2 0.0 1.0 Sets the room size (i.e. amount of wet) reverb. reverb.width num 0.5 0.0 100.0 Sets the stereo spread of the reverb signal. sample-rate num 44100.0 8000.0 96000.0 The sample rate of the audio generated by the synthesizer. For optimal performance, make sure this value equals the native output rate of the audio driver (in case you are using any of fluidsynth's audio drivers). Some drivers, such as Oboe, will interpolate sample-rates, whereas others, such as Jack, will override this setting, if a mismatch with the native output rate is detected. threadsafe-api bool 1 (TRUE) Controls whether the synth's public API is protected by a mutex or not. Default is on, turn it off for slightly better performance if you know you're only accessing the synth from one thread only, this could be the case in many embedded use cases for example. Note that libfluidsynth can use many threads by itself (shell is one, midi driver is one, midi player is one etc) so you should usually leave it on. verbose bool 0 (FALSE) When set to 1 (TRUE) the synthesizer will print out information about the received MIDI events to the stdout. This can be helpful for debugging. This setting cannot be changed after the synthesizer has started.
autoconnect bool 0 (FALSE) If 1 (TRUE), automatically connects FluidSynth to available MIDI input ports. alsa_seq, coremidi and jack are currently the only drivers making use of this. driver str alsa_seq (Linux),
winmidi (Windows),
jack (Mac OS X)
alsa_raw, alsa_seq, coremidi, jack, midishare, oss, winmidi The MIDI system to be used.
realtime-prio int 50 0 99 Sets the realtime scheduling priority of the MIDI thread (0 disables high priority scheduling). Linux is the only platform which currently makes use of different priority levels. Drivers which use this option: alsa_raw, alsa_seq, oss portname str (empty string) Used by coremidi and alsa_seq drivers for the portnames registered with the MIDI subsystem. alsa.device str default ALSA MIDI hardware device to use for RAW ALSA MIDI driver (not to be confused with the MIDI port). alsa_seq.device str default ALSA sequencer hardware device to use for ALSA sequencer driver (not to be confused with the MIDI port). alsa_seq.id str pid ID to use when registering ports with the ALSA sequencer driver. If set to "pid" then the ID will be "FLUID Synth (PID)", where PID is the FluidSynth process ID of the audio thread otherwise the provided string will be used in place of PID. coremidi.id str pid Client ID to use for CoreMIDI driver. 'pid' will use process ID as port of the client name. jack.server str (empty string) Jack server to connect to for Jack MIDI driver. If an empty string then the default server will be used. jack.id str fluidsynth-midi Client ID to use with the Jack MIDI driver. If jack is also used as audio driver and "midi.jack.server" and "audio.jack.server" are equal, this setting will be overridden by "audio.jack.id", because a client cannot have multiple names. oss.device str /dev/midi The hardware device to use for OSS MIDI driver (not to be confused with the MIDI port). winmidi.device str default The hardware device to use for Windows MIDI driver (not to be confused with the MIDI port). Multiple devices can be specified by a list of devices index separated by a semicolon (e.g "2;0", which is equivalent to one device with 32 MIDI channels).
reset-synth bool 1 (TRUE) If true, reset the synth before starting a new MIDI song, so the state of a previous song can't affect the new song. Turn it off for seamless looping of a song. timing-source str sample sample, system Determines the timing source of the player sequencer. 'sample' uses the sample clock (how much audio has been output) to sequence events, in which case audio is synchronized with MIDI events. 'system' uses the system clock, audio and MIDI are not synchronized exactly. prompt str (empty string) In dump mode we set the prompt to "" (empty string). The ui cannot easily handle lines, which don't end with cr. Changing the prompt cannot be done through a command, because the current shell does not handle empty arguments. port int 9800 1 65535 The shell can be used in a client/server mode. This setting controls what TCP/IP port the server uses.