Embeddable SoundFont synthesizer. More...

Data Structures
struct	_fluid_synth_channel_info_t
	Channel information structure for fluid_synth_get_channel_info(). More...

Macros
#define	FLUID_SYNTH_CHANNEL_INFO_NAME_SIZE 32
	Length of channel info name field (including zero terminator)

#define	FLUID_REVERB_DEFAULT_ROOMSIZE 0.2f
	Default reverb room size.

#define	FLUID_REVERB_DEFAULT_DAMP 0.0f
	Default reverb damping.

#define	FLUID_REVERB_DEFAULT_WIDTH 0.5f
	Default reverb width.

#define	FLUID_REVERB_DEFAULT_LEVEL 0.9f
	Default reverb level.

#define	FLUID_CHORUS_DEFAULT_N 3
	Default chorus voice count.

#define	FLUID_CHORUS_DEFAULT_LEVEL 2.0f
	Default chorus level.

#define	FLUID_CHORUS_DEFAULT_SPEED 0.3f
	Default chorus speed.

#define	FLUID_CHORUS_DEFAULT_DEPTH 8.0f
	Default chorus depth.

#define	FLUID_CHORUS_DEFAULT_TYPE FLUID_CHORUS_MOD_SINE
	Default chorus waveform type.

#define	FLUID_INTERP_DEFAULT FLUID_INTERP_4THORDER
	Default interpolation method from fluid_interp. More...

#define	FLUID_INTERP_HIGHEST FLUID_INTERP_7THORDER
	Highest interpolation method from fluid_interp. More...

Typedefs
typedef int(*	fluid_audio_callback_t) (fluid_synth_t synth, int len, void out1, int loff, int lincr, void *out2, int roff, int rincr)
	Type definition of the synthesizer's audio callback function. More...

Enumerations
enum	fluid_midi_channel_type { CHANNEL_TYPE_MELODIC = 0, CHANNEL_TYPE_DRUM = 1 }
	The midi channel type used by fluid_synth_set_channel_type() More...

enum	fluid_chorus_mod { FLUID_CHORUS_MOD_SINE = 0, FLUID_CHORUS_MOD_TRIANGLE = 1 }
	Chorus modulation waveform type. More...

enum	fluid_interp { FLUID_INTERP_NONE = 0, FLUID_INTERP_LINEAR = 1, FLUID_INTERP_4THORDER = 4, FLUID_INTERP_7THORDER = 7 }
	Synthesis interpolation method. More...

Functions
FLUIDSYNTH_API fluid_synth_t *	new_fluid_synth (fluid_settings_t *settings)
	Create new FluidSynth instance. More...

FLUIDSYNTH_API int	delete_fluid_synth (fluid_synth_t *synth)
	Delete a FluidSynth instance. More...

FLUIDSYNTH_API fluid_settings_t *	fluid_synth_get_settings (fluid_synth_t *synth)
	Get settings assigned to a synth. More...

FLUIDSYNTH_API int	fluid_synth_noteon (fluid_synth_t *synth, int chan, int key, int vel)
	Send a note-on event to a FluidSynth object. More...

FLUIDSYNTH_API int	fluid_synth_noteoff (fluid_synth_t *synth, int chan, int key)
	Send a note-off event to a FluidSynth object. More...

FLUIDSYNTH_API int	fluid_synth_cc (fluid_synth_t *synth, int chan, int ctrl, int val)
	Send a MIDI controller event on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_get_cc (fluid_synth_t synth, int chan, int ctrl, int pval)
	Get current MIDI controller value on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_sysex (fluid_synth_t synth, const char data, int len, char response, int response_len, int *handled, int dryrun)
	Process a MIDI SYSEX (system exclusive) message. More...

FLUIDSYNTH_API int	fluid_synth_pitch_bend (fluid_synth_t *synth, int chan, int val)
	Set the MIDI pitch bend controller value on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_get_pitch_bend (fluid_synth_t synth, int chan, int ppitch_bend)
	Get the MIDI pitch bend controller value on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_pitch_wheel_sens (fluid_synth_t *synth, int chan, int val)
	Set MIDI pitch wheel sensitivity on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_get_pitch_wheel_sens (fluid_synth_t synth, int chan, int pval)
	Get MIDI pitch wheel sensitivity on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_program_change (fluid_synth_t *synth, int chan, int program)
	Send a program change event on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_channel_pressure (fluid_synth_t *synth, int chan, int val)
	Set the MIDI channel pressure controller value. More...

FLUIDSYNTH_API int	fluid_synth_bank_select (fluid_synth_t *synth, int chan, unsigned int bank)
	Set instrument bank number on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_sfont_select (fluid_synth_t *synth, int chan, unsigned int sfont_id)
	Set SoundFont ID on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_program_select (fluid_synth_t *synth, int chan, unsigned int sfont_id, unsigned int bank_num, unsigned int preset_num)
	Select an instrument on a MIDI channel by SoundFont ID, bank and program numbers. More...

FLUIDSYNTH_API int	fluid_synth_program_select_by_sfont_name (fluid_synth_t synth, int chan, const char sfont_name, unsigned int bank_num, unsigned int preset_num)
	Select an instrument on a MIDI channel by SoundFont name, bank and program numbers. More...

FLUIDSYNTH_API int	fluid_synth_get_program (fluid_synth_t synth, int chan, unsigned int sfont_id, unsigned int bank_num, unsigned int preset_num)
	Get current SoundFont ID, bank number and program number for a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_unset_program (fluid_synth_t *synth, int chan)
	Set the preset of a MIDI channel to an unassigned state. More...

FLUIDSYNTH_API FLUID_DEPRECATED int	fluid_synth_get_channel_info (fluid_synth_t synth, int chan, fluid_synth_channel_info_t info)
	Get information on the currently selected preset on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_program_reset (fluid_synth_t *synth)
	Resend a bank select and a program change for every channel and assign corresponding instruments. More...

FLUIDSYNTH_API int	fluid_synth_system_reset (fluid_synth_t *synth)
	Send MIDI system reset command (big red 'panic' button), turns off notes and resets controllers. More...

FLUIDSYNTH_API int	fluid_synth_all_notes_off (fluid_synth_t *synth, int chan)
	Turn off all notes on a MIDI channel (put them into release phase). More...

FLUIDSYNTH_API int	fluid_synth_all_sounds_off (fluid_synth_t *synth, int chan)
	Immediately stop all notes on a MIDI channel (skips release phase). More...

FLUIDSYNTH_API int	fluid_synth_set_channel_type (fluid_synth_t *synth, int chan, int type)
	Set midi channel type. More...

FLUIDSYNTH_API fluid_preset_t *	fluid_synth_get_channel_preset (fluid_synth_t *synth, int chan)
	Get active preset on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_start (fluid_synth_t synth, unsigned int id, fluid_preset_t preset, int audio_chan, int midi_chan, int key, int vel)
	Create and start voices using a preset and a MIDI note on event. More...

FLUIDSYNTH_API int	fluid_synth_stop (fluid_synth_t *synth, unsigned int id)
	Stop notes for a given note event voice ID. More...

FLUIDSYNTH_API int	fluid_synth_sfload (fluid_synth_t synth, const char filename, int reset_presets)
	Load a SoundFont file (filename is interpreted by SoundFont loaders). More...

FLUIDSYNTH_API int	fluid_synth_sfreload (fluid_synth_t *synth, unsigned int id)
	Reload a SoundFont. More...

FLUIDSYNTH_API int	fluid_synth_sfunload (fluid_synth_t *synth, unsigned int id, int reset_presets)
	Unload a SoundFont. More...

FLUIDSYNTH_API int	fluid_synth_add_sfont (fluid_synth_t synth, fluid_sfont_t sfont)
	Add a SoundFont. More...

FLUIDSYNTH_API void	fluid_synth_remove_sfont (fluid_synth_t synth, fluid_sfont_t sfont)
	Remove a SoundFont from the SoundFont stack without deleting it. More...

FLUIDSYNTH_API int	fluid_synth_sfcount (fluid_synth_t *synth)
	Count number of loaded SoundFont files. More...

FLUIDSYNTH_API fluid_sfont_t *	fluid_synth_get_sfont (fluid_synth_t *synth, unsigned int num)
	Get SoundFont by index. More...

FLUIDSYNTH_API fluid_sfont_t *	fluid_synth_get_sfont_by_id (fluid_synth_t *synth, unsigned int id)
	Get SoundFont by ID. More...

FLUIDSYNTH_API fluid_sfont_t *	fluid_synth_get_sfont_by_name (fluid_synth_t synth, const char name)
	Get SoundFont by name. More...

FLUIDSYNTH_API int	fluid_synth_set_bank_offset (fluid_synth_t *synth, int sfont_id, int offset)
	Offset the bank numbers of a loaded SoundFont, i.e. subtract `offset` from any bank number when assigning instruments. More...

FLUIDSYNTH_API int	fluid_synth_get_bank_offset (fluid_synth_t *synth, int sfont_id)
	Get bank offset of a loaded SoundFont. More...

FLUIDSYNTH_API void	fluid_synth_set_reverb (fluid_synth_t *synth, double roomsize, double damping, double width, double level)
	Set reverb parameters. More...

FLUIDSYNTH_API void	fluid_synth_set_reverb_on (fluid_synth_t *synth, int on)
	Enable or disable reverb effect. More...

FLUIDSYNTH_API double	fluid_synth_get_reverb_roomsize (fluid_synth_t *synth)
	Get reverb room size. More...

FLUIDSYNTH_API double	fluid_synth_get_reverb_damp (fluid_synth_t *synth)
	Get reverb damping. More...

FLUIDSYNTH_API double	fluid_synth_get_reverb_level (fluid_synth_t *synth)
	Get reverb level. More...

FLUIDSYNTH_API double	fluid_synth_get_reverb_width (fluid_synth_t *synth)
	Get reverb width. More...

FLUIDSYNTH_API void	fluid_synth_set_chorus (fluid_synth_t *synth, int nr, double level, double speed, double depth_ms, int type)
	Set chorus parameters. More...

FLUIDSYNTH_API void	fluid_synth_set_chorus_on (fluid_synth_t *synth, int on)
	Enable or disable chorus effect. More...

FLUIDSYNTH_API int	fluid_synth_get_chorus_nr (fluid_synth_t *synth)
	Get chorus voice number (delay line count) value. More...

FLUIDSYNTH_API double	fluid_synth_get_chorus_level (fluid_synth_t *synth)
	Get chorus level. More...

FLUIDSYNTH_API double	fluid_synth_get_chorus_speed_Hz (fluid_synth_t *synth)
	Get chorus speed in Hz. More...

FLUIDSYNTH_API double	fluid_synth_get_chorus_depth_ms (fluid_synth_t *synth)
	Get chorus depth. More...

FLUIDSYNTH_API int	fluid_synth_get_chorus_type (fluid_synth_t *synth)
	Get chorus waveform type. More...

FLUIDSYNTH_API int	fluid_synth_count_midi_channels (fluid_synth_t *synth)
	Get the total count of MIDI channels. More...

FLUIDSYNTH_API int	fluid_synth_count_audio_channels (fluid_synth_t *synth)
	Get the total count of audio channels. More...

FLUIDSYNTH_API int	fluid_synth_count_audio_groups (fluid_synth_t *synth)
	Get the total number of allocated audio channels. More...

FLUIDSYNTH_API int	fluid_synth_count_effects_channels (fluid_synth_t *synth)
	Get the total number of allocated effects channels. More...

FLUIDSYNTH_API void	fluid_synth_set_sample_rate (fluid_synth_t *synth, float sample_rate)
	Set sample rate of the synth. More...

FLUIDSYNTH_API void	fluid_synth_set_gain (fluid_synth_t *synth, float gain)
	Set synth output gain value. More...

FLUIDSYNTH_API float	fluid_synth_get_gain (fluid_synth_t *synth)
	Get synth output gain value. More...

FLUIDSYNTH_API int	fluid_synth_set_polyphony (fluid_synth_t *synth, int polyphony)
	Set synthesizer polyphony (max number of voices). More...

FLUIDSYNTH_API int	fluid_synth_get_polyphony (fluid_synth_t *synth)
	Get current synthesizer polyphony (max number of voices). More...

FLUIDSYNTH_API int	fluid_synth_get_active_voice_count (fluid_synth_t *synth)
	Get current number of active voices. More...

FLUIDSYNTH_API int	fluid_synth_get_internal_bufsize (fluid_synth_t *synth)
	Get the internal synthesis buffer size value. More...

FLUIDSYNTH_API int	fluid_synth_set_interp_method (fluid_synth_t *synth, int chan, int interp_method)
	Set synthesis interpolation method on one or all MIDI channels. More...

FLUIDSYNTH_API int	fluid_synth_set_gen (fluid_synth_t *synth, int chan, int param, float value)
	Set a SoundFont generator (effect) value on a MIDI channel in real-time. More...

FLUIDSYNTH_API FLUID_DEPRECATED int	fluid_synth_set_gen2 (fluid_synth_t *synth, int chan, int param, float value, int absolute, int normalized)
	Set a SoundFont generator (effect) value on a MIDI channel in real-time. More...

FLUIDSYNTH_API float	fluid_synth_get_gen (fluid_synth_t *synth, int chan, int param)
	Get generator value assigned to a MIDI channel. More...

FLUIDSYNTH_API FLUID_DEPRECATED int	fluid_synth_create_key_tuning (fluid_synth_t synth, int bank, int prog, const char name, const double *pitch)
	Set the tuning of the entire MIDI note scale. More...

FLUIDSYNTH_API int	fluid_synth_activate_key_tuning (fluid_synth_t synth, int bank, int prog, const char name, const double *pitch, int apply)
	Set the tuning of the entire MIDI note scale. More...

FLUIDSYNTH_API FLUID_DEPRECATED int	fluid_synth_create_octave_tuning (fluid_synth_t synth, int bank, int prog, const char name, const double *pitch)
	Apply an octave tuning to every octave in the MIDI note scale. More...

FLUIDSYNTH_API int	fluid_synth_activate_octave_tuning (fluid_synth_t synth, int bank, int prog, const char name, const double *pitch, int apply)
	Activate an octave tuning on every octave in the MIDI note scale. More...

FLUIDSYNTH_API int	fluid_synth_tune_notes (fluid_synth_t synth, int bank, int prog, int len, const int keys, const double *pitch, int apply)
	Set tuning values for one or more MIDI notes for an existing tuning. More...

FLUIDSYNTH_API FLUID_DEPRECATED int	fluid_synth_select_tuning (fluid_synth_t *synth, int chan, int bank, int prog)
	Select a tuning scale on a MIDI channel. More...

FLUIDSYNTH_API int	fluid_synth_activate_tuning (fluid_synth_t *synth, int chan, int bank, int prog, int apply)
	Activate a tuning scale on a MIDI channel. More...

FLUIDSYNTH_API FLUID_DEPRECATED int	fluid_synth_reset_tuning (fluid_synth_t *synth, int chan)
	Clear tuning scale on a MIDI channel (set it to the default equal tempered scale). More...

FLUIDSYNTH_API int	fluid_synth_deactivate_tuning (fluid_synth_t *synth, int chan, int apply)
	Clear tuning scale on a MIDI channel (use default equal tempered scale). More...

FLUIDSYNTH_API void	fluid_synth_tuning_iteration_start (fluid_synth_t *synth)
	Start tuning iteration. More...

FLUIDSYNTH_API int	fluid_synth_tuning_iteration_next (fluid_synth_t synth, int bank, int *prog)
	Advance to next tuning. More...

FLUIDSYNTH_API int	fluid_synth_tuning_dump (fluid_synth_t synth, int bank, int prog, char name, int len, double *pitch)
	Get the entire note tuning for a given MIDI bank and program. More...

FLUIDSYNTH_API double	fluid_synth_get_cpu_load (fluid_synth_t *synth)
	Get the synth CPU load value. More...

FLUIDSYNTH_API char *	fluid_synth_error (fluid_synth_t *synth)
	Get a textual representation of the last error. More...

FLUIDSYNTH_API int	fluid_synth_write_s16 (fluid_synth_t synth, int len, void lout, int loff, int lincr, void *rout, int roff, int rincr)
	Synthesize a block of 16 bit audio samples to audio buffers. More...

FLUIDSYNTH_API int	fluid_synth_write_float (fluid_synth_t synth, int len, void lout, int loff, int lincr, void *rout, int roff, int rincr)
	Synthesize a block of floating point audio samples to audio buffers. More...

FLUIDSYNTH_API int	fluid_synth_nwrite_float (fluid_synth_t synth, int len, float left, float right, float fx_left, float *fx_right)
	Synthesize a block of floating point audio to separate audio buffers (multichannel rendering). More...

FLUIDSYNTH_API int	fluid_synth_process (fluid_synth_t synth, int len, int nin, float in, int nout, float *out)
	Synthesize floating point audio to audio buffers. More...

FLUIDSYNTH_API void	fluid_synth_add_sfloader (fluid_synth_t synth, fluid_sfloader_t loader)
	Add a SoundFont loader to the synth. More...

FLUIDSYNTH_API fluid_voice_t *	fluid_synth_alloc_voice (fluid_synth_t synth, fluid_sample_t sample, int channum, int key, int vel)
	Allocate a synthesis voice. More...

FLUIDSYNTH_API void	fluid_synth_start_voice (fluid_synth_t synth, fluid_voice_t voice)
	Activate a voice previously allocated with fluid_synth_alloc_voice(). More...

FLUIDSYNTH_API void	fluid_synth_get_voicelist (fluid_synth_t synth, fluid_voice_t buf[], int bufsize, int ID)
	Get list of currently playing voices. More...

FLUIDSYNTH_API int	fluid_synth_handle_midi_event (void data, fluid_midi_event_t event)
	Handle MIDI event from MIDI router, used as a callback function. More...

FLUIDSYNTH_API FLUID_DEPRECATED void	fluid_synth_set_midi_router (fluid_synth_t synth, fluid_midi_router_t router)
	Assign a MIDI router to a synth. More...

Detailed Description

Embeddable SoundFont synthesizer.

You create a new synthesizer with new_fluid_synth() and you destroy if with delete_fluid_synth(). Use the settings structure to specify the synthesizer characteristics.

You have to load a SoundFont in order to hear any sound. For that you use the fluid_synth_sfload() function.

You can use the audio driver functions described below to open the audio device and create a background audio thread.

The API for sending MIDI events is probably what you expect: fluid_synth_noteon(), fluid_synth_noteoff(), ...

Macro Definition Documentation

◆ FLUID_INTERP_DEFAULT

#define FLUID_INTERP_DEFAULT FLUID_INTERP_4THORDER

Default interpolation method from fluid_interp.

◆ FLUID_INTERP_HIGHEST

#define FLUID_INTERP_HIGHEST FLUID_INTERP_7THORDER

Highest interpolation method from fluid_interp.

Typedef Documentation

◆ fluid_audio_callback_t

typedef int(* fluid_audio_callback_t) (fluid_synth_t *synth, int len, void *out1, int loff, int lincr, void *out2, int roff, int rincr)

Type definition of the synthesizer's audio callback function.

Parameters

synth	FluidSynth instance
len	Count of audio frames to synthesize
out1	Array to store left channel of audio to
loff	Offset index in 'out1' for first sample
lincr	Increment between samples stored to 'out1'
out2	Array to store right channel of audio to
roff	Offset index in 'out2' for first sample
rincr	Increment between samples stored to 'out2'

Enumeration Type Documentation

◆ fluid_midi_channel_type

enum fluid_midi_channel_type

The midi channel type used by fluid_synth_set_channel_type()

Enumerator
CHANNEL_TYPE_MELODIC	Melodic midi channel.
CHANNEL_TYPE_DRUM	Drum midi channel.

◆ fluid_chorus_mod

enum fluid_chorus_mod

Chorus modulation waveform type.

Enumerator
FLUID_CHORUS_MOD_SINE	Sine wave chorus modulation.
FLUID_CHORUS_MOD_TRIANGLE	Triangle wave chorus modulation.

◆ fluid_interp

enum fluid_interp

Synthesis interpolation method.

Enumerator
FLUID_INTERP_NONE	No interpolation: Fastest, but questionable audio quality.
FLUID_INTERP_LINEAR	Straight-line interpolation: A bit slower, reasonable audio quality.
FLUID_INTERP_4THORDER	Fourth-order interpolation, good quality, the default.
FLUID_INTERP_7THORDER	Seventh-order interpolation.

Function Documentation

◆ new_fluid_synth()

FLUIDSYNTH_API fluid_synth_t* new_fluid_synth ( fluid_settings_t * settings )

Create new FluidSynth instance.

Parameters

settings Configuration parameters to use (used directly).

Returns: New FluidSynth instance or NULL on error

Note: The settings parameter is used directly and should not be modified or freed independently.

Examples:: example.c, fluidsynth_arpeggio.c, fluidsynth_fx.c, fluidsynth_metronome.c, fluidsynth_register_adriver.c, and fluidsynth_simple.c.

References delete_fluid_synth(), FLUID_ERR, FLUID_REVERB_DEFAULT_DAMP, FLUID_REVERB_DEFAULT_LEVEL, FLUID_REVERB_DEFAULT_ROOMSIZE, FLUID_REVERB_DEFAULT_WIDTH, fluid_settings_getint(), fluid_settings_getnum(), fluid_settings_setint(), fluid_settings_str_equal(), fluid_synth_add_sfloader(), fluid_synth_set_chorus_on(), fluid_synth_set_reverb_on(), fluid_synth_set_sample_rate(), and FLUID_WARN.

◆ delete_fluid_synth()

FLUIDSYNTH_API int delete_fluid_synth ( fluid_synth_t * synth )

Delete a FluidSynth instance.

Parameters

synth FluidSynth instance to delete

Returns: FLUID_OK

Note: Other users of a synthesizer instance, such as audio and MIDI drivers, should be deleted prior to freeing the FluidSynth instance.

Examples:: example.c, fluidsynth_arpeggio.c, fluidsynth_fx.c, fluidsynth_metronome.c, fluidsynth_register_adriver.c, and fluidsynth_simple.c.

References FLUID_OK, and fluid_voice_is_playing().

Referenced by new_fluid_synth().

◆ fluid_synth_get_settings()

FLUIDSYNTH_API fluid_settings_t* fluid_synth_get_settings ( fluid_synth_t * synth )

Get settings assigned to a synth.

Parameters

synth FluidSynth instance

Returns: FluidSynth settings which are assigned to the synth

References FLUID_FAILED, fluid_settings_dupstr(), fluid_settings_getint(), fluid_settings_getnum(), fluid_settings_setint(), fluid_settings_setnum(), and fluid_settings_setstr().

◆ fluid_synth_noteon()

FLUIDSYNTH_API int fluid_synth_noteon	(	fluid_synth_t *	synth,
		int	chan,
		int	key,
		int	vel
	)

Send a note-on event to a FluidSynth object.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
key	MIDI note number (0-127)
vel	MIDI velocity (0-127, 0=noteoff)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Examples:: example.c, fluidsynth_fx.c, and fluidsynth_simple.c.

References FLUID_FAILED, and FLUID_INFO.

Referenced by fluid_get_sysconf(), fluid_sequencer_register_fluidsynth(), and fluid_synth_handle_midi_event().

◆ fluid_synth_noteoff()

FLUIDSYNTH_API int fluid_synth_noteoff	(	fluid_synth_t *	synth,
		int	chan,
		int	key
	)

Send a note-off event to a FluidSynth object.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
key	MIDI note number (0-127)

Returns: FLUID_OK on success, FLUID_FAILED otherwise (may just mean that no voices matched the note off event)

Examples:: example.c.

References FLUID_FAILED, FLUID_INFO, FLUID_OK, fluid_voice_get_channel(), fluid_voice_get_id(), fluid_voice_get_key(), fluid_voice_is_on(), fluid_voice_is_sostenuto(), and fluid_voice_is_sustained().

Referenced by fluid_get_sysconf(), fluid_sequencer_register_fluidsynth(), and fluid_synth_handle_midi_event().

◆ fluid_synth_cc()

FLUIDSYNTH_API int fluid_synth_cc	(	fluid_synth_t *	synth,
		int	chan,
		int	num,
		int	val
	)

Send a MIDI controller event on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
num	MIDI controller number (0-127)
val	MIDI controller value (0-127)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, FLUID_INFO, FLUID_OK, fluid_synth_activate_tuning(), GEN_COARSETUNE, GEN_FINETUNE, and GEN_LAST.

Referenced by fluid_get_sysconf(), fluid_sequencer_register_fluidsynth(), and fluid_synth_handle_midi_event().

◆ fluid_synth_get_cc()

FLUIDSYNTH_API int fluid_synth_get_cc	(	fluid_synth_t *	synth,
		int	chan,
		int	num,
		int *	pval
	)

Get current MIDI controller value on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
num	MIDI controller number (0-127)
pval	Location to store MIDI controller value (0-127)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_sysex()

FLUIDSYNTH_API int fluid_synth_sysex	(	fluid_synth_t *	synth,
		const char *	data,
		int	len,
		char *	response,
		int *	response_len,
		int *	handled,
		int	dryrun
	)

Process a MIDI SYSEX (system exclusive) message.

Parameters

synth	FluidSynth instance
data	Buffer containing SYSEX data (not including 0xF0 and 0xF7)
len	Length of data in buffer
response	Buffer to store response to or NULL to ignore
response_len	IN/OUT parameter, in: size of response buffer, out: amount of data written to response buffer (if FLUID_FAILED is returned and this value is non-zero, it indicates the response buffer is too small)
handled	Optional location to store boolean value if message was recognized and handled or not (set to TRUE if it was handled)
dryrun	TRUE to just do a dry run but not actually execute the SYSEX command (useful for checking if a SYSEX message would be handled)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

References FLUID_FAILED, FLUID_OK, fluid_synth_activate_octave_tuning(), fluid_synth_activate_tuning(), fluid_synth_tune_notes(), and fluid_synth_tuning_dump().

Referenced by fluid_synth_handle_midi_event().

◆ fluid_synth_pitch_bend()

FLUIDSYNTH_API int fluid_synth_pitch_bend	(	fluid_synth_t *	synth,
		int	chan,
		int	val
	)

Set the MIDI pitch bend controller value on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
val	MIDI pitch bend value (0-16383 with 8192 being center)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, FLUID_INFO, and FLUID_MOD_PITCHWHEEL.

Referenced by fluid_get_sysconf(), fluid_sequencer_register_fluidsynth(), and fluid_synth_handle_midi_event().

◆ fluid_synth_get_pitch_bend()

FLUIDSYNTH_API int fluid_synth_get_pitch_bend	(	fluid_synth_t *	synth,
		int	chan,
		int *	ppitch_bend
	)

Get the MIDI pitch bend controller value on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
ppitch_bend	Location to store MIDI pitch bend value (0-16383 with 8192 being center)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_pitch_wheel_sens()

FLUIDSYNTH_API int fluid_synth_pitch_wheel_sens	(	fluid_synth_t *	synth,
		int	chan,
		int	val
	)

Set MIDI pitch wheel sensitivity on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
val	Pitch wheel sensitivity value in semitones

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, FLUID_INFO, and FLUID_MOD_PITCHWHEELSENS.

Referenced by fluid_sequencer_register_fluidsynth().

◆ fluid_synth_get_pitch_wheel_sens()

FLUIDSYNTH_API int fluid_synth_get_pitch_wheel_sens	(	fluid_synth_t *	synth,
		int	chan,
		int *	pval
	)

Get MIDI pitch wheel sensitivity on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
pval	Location to store pitch wheel sensitivity value in semitones

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: Sometime AFTER v1.0 API freeze.

References FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_program_change()

FLUIDSYNTH_API int fluid_synth_program_change	(	fluid_synth_t *	synth,
		int	chan,
		int	prognum
	)

Send a program change event on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
prognum	MIDI program number (0-127)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References CHANNEL_TYPE_DRUM, FLUID_FAILED, FLUID_INFO, and FLUID_WARN.

Referenced by fluid_get_sysconf(), fluid_sequencer_register_fluidsynth(), fluid_synth_handle_midi_event(), fluid_synth_program_reset(), and fluid_synth_unset_program().

◆ fluid_synth_channel_pressure()

FLUIDSYNTH_API int fluid_synth_channel_pressure	(	fluid_synth_t *	synth,
		int	chan,
		int	val
	)

Set the MIDI channel pressure controller value.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
val	MIDI channel pressure value (0-127)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, FLUID_INFO, and FLUID_MOD_CHANNELPRESSURE.

Referenced by fluid_sequencer_register_fluidsynth(), and fluid_synth_handle_midi_event().

◆ fluid_synth_bank_select()

FLUIDSYNTH_API int fluid_synth_bank_select	(	fluid_synth_t *	synth,
		int	chan,
		unsigned int	bank
	)

Set instrument bank number on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
bank	MIDI bank number

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: This function does not change the instrument currently assigned to chan, as it is usually called prior to fluid_synth_program_change(). If you still want instrument changes to take effect immediately, call fluid_synth_program_reset() after having set up the bank configuration.

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_get_sysconf(), and fluid_sequencer_register_fluidsynth().

◆ fluid_synth_sfont_select()

FLUIDSYNTH_API int fluid_synth_sfont_select	(	fluid_synth_t *	synth,
		int	chan,
		unsigned int	sfont_id
	)

Set SoundFont ID on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
sfont_id	ID of a loaded SoundFont

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: This function does not change the instrument currently assigned to chan, as it is usually called prior to fluid_synth_bank_select() or fluid_synth_program_change(). If you still want instrument changes to take effect immediately, call fluid_synth_program_reset() after having selected the soundfont.

References FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_program_select()

FLUIDSYNTH_API int fluid_synth_program_select	(	fluid_synth_t *	synth,
		int	chan,
		unsigned int	sfont_id,
		unsigned int	bank_num,
		unsigned int	preset_num
	)

Select an instrument on a MIDI channel by SoundFont ID, bank and program numbers.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
sfont_id	ID of a loaded SoundFont
bank_num	MIDI bank number
preset_num	MIDI program number

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_ERR, and FLUID_FAILED.

Referenced by fluid_get_sysconf(), and fluid_sequencer_register_fluidsynth().

◆ fluid_synth_program_select_by_sfont_name()

FLUIDSYNTH_API int fluid_synth_program_select_by_sfont_name	(	fluid_synth_t *	synth,
		int	chan,
		const char *	sfont_name,
		unsigned int	bank_num,
		unsigned int	preset_num
	)

Select an instrument on a MIDI channel by SoundFont name, bank and program numbers.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
sfont_name	Name of a loaded SoundFont
bank_num	MIDI bank number
preset_num	MIDI program number

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

References FLUID_ERR, and FLUID_FAILED.

◆ fluid_synth_get_program()

FLUIDSYNTH_API int fluid_synth_get_program	(	fluid_synth_t *	synth,
		int	chan,
		unsigned int *	sfont_id,
		unsigned int *	bank_num,
		unsigned int *	preset_num
	)

Get current SoundFont ID, bank number and program number for a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
sfont_id	Location to store SoundFont ID
bank_num	Location to store MIDI bank number
preset_num	Location to store MIDI program number

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_unset_program()

FLUIDSYNTH_API int fluid_synth_unset_program	(	fluid_synth_t *	synth,
		int	chan
	)

Set the preset of a MIDI channel to an unassigned state.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.1

Note: Channel retains its SoundFont ID and bank numbers, while the program number is set to an "unset" state. MIDI program changes may re-assign a preset if one matches.

References FLUID_FAILED, and fluid_synth_program_change().

◆ fluid_synth_get_channel_info()

FLUIDSYNTH_API FLUID_DEPRECATED int fluid_synth_get_channel_info	(	fluid_synth_t *	synth,
		int	chan,
		fluid_synth_channel_info_t *	info
	)

Get information on the currently selected preset on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
info	Caller supplied structure to fill with preset information

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Deprecated:: Provides redundant functionality that can be achieved with fluid_synth_get_channel_preset() or fluid_synth_get_program().

Since: 1.1.1

References _fluid_synth_channel_info_t::assigned, _fluid_synth_channel_info_t::bank, FLUID_FAILED, FLUID_OK, FLUID_SYNTH_CHANNEL_INFO_NAME_SIZE, _fluid_sfont_t::id, _fluid_synth_channel_info_t::name, _fluid_synth_channel_info_t::program, _fluid_preset_t::sfont, and _fluid_synth_channel_info_t::sfont_id.

Referenced by fluid_get_sysconf().

◆ fluid_synth_program_reset()

FLUIDSYNTH_API int fluid_synth_program_reset ( fluid_synth_t * synth )

Resend a bank select and a program change for every channel and assign corresponding instruments.

Parameters

synth FluidSynth instance

Returns: FLUID_OK on success, FLUID_FAILED otherwise

This function is called mainly after a SoundFont has been loaded, unloaded or reloaded.

References FLUID_FAILED, FLUID_OK, and fluid_synth_program_change().

Referenced by fluid_get_sysconf(), fluid_synth_add_sfont(), fluid_synth_remove_sfont(), and fluid_synth_sfload().

◆ fluid_synth_system_reset()

FLUIDSYNTH_API int fluid_synth_system_reset ( fluid_synth_t * synth )

Send MIDI system reset command (big red 'panic' button), turns off notes and resets controllers.

Parameters

synth FluidSynth instance

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, FLUID_OK, fluid_voice_get_channel(), and fluid_voice_is_playing().

Referenced by fluid_player_add_mem(), fluid_sequencer_register_fluidsynth(), and fluid_synth_handle_midi_event().

◆ fluid_synth_all_notes_off()

FLUIDSYNTH_API int fluid_synth_all_notes_off	(	fluid_synth_t *	synth,
		int	chan
	)

Turn off all notes on a MIDI channel (put them into release phase).

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1), (chan=-1 selects all channels)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.4

References FLUID_FAILED, FLUID_OK, fluid_voice_get_channel(), and fluid_voice_is_playing().

◆ fluid_synth_all_sounds_off()

FLUIDSYNTH_API int fluid_synth_all_sounds_off	(	fluid_synth_t *	synth,
		int	chan
	)

Immediately stop all notes on a MIDI channel (skips release phase).

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1), (chan=-1 selects all channels)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.4

References FLUID_FAILED, FLUID_OK, fluid_voice_get_channel(), and fluid_voice_is_playing().

Referenced by fluid_sequencer_register_fluidsynth().

◆ fluid_synth_set_channel_type()

FLUIDSYNTH_API int fluid_synth_set_channel_type	(	fluid_synth_t *	synth,
		int	chan,
		int	type
	)

Set midi channel type.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
type	MIDI channel type (fluid_midi_channel_type)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.4

References CHANNEL_TYPE_DRUM, CHANNEL_TYPE_MELODIC, FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_get_channel_preset()

FLUIDSYNTH_API fluid_preset_t* fluid_synth_get_channel_preset	(	fluid_synth_t *	synth,
		int	chan
	)

Get active preset on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)

Returns: Preset or NULL if no preset active on chan

Note: Should only be called from within synthesis thread, which includes SoundFont loader preset noteon methods. Not thread safe otherwise.

◆ fluid_synth_start()

FLUIDSYNTH_API int fluid_synth_start	(	fluid_synth_t *	synth,
		unsigned int	id,
		fluid_preset_t *	preset,
		int	audio_chan,
		int	chan,
		int	key,
		int	vel
	)

Create and start voices using a preset and a MIDI note on event.

Parameters

synth	FluidSynth instance
id	Voice group ID to use (can be used with fluid_synth_stop()).
preset	Preset to synthesize
audio_chan	Unused currently, set to 0
chan	MIDI channel number (0 to MIDI channel count - 1)
key	MIDI note number (0-127)
vel	MIDI velocity number (1-127)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: Should only be called from within synthesis thread, which includes SoundFont loader preset noteon method.

References FLUID_FAILED.

◆ fluid_synth_stop()

FLUIDSYNTH_API int fluid_synth_stop	(	fluid_synth_t *	synth,
		unsigned int	id
	)

Stop notes for a given note event voice ID.

Parameters

synth	FluidSynth instance
id	Voice note event ID

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: In FluidSynth versions prior to 1.1.0 FLUID_FAILED would be returned if no matching voice note event ID was found. Versions after 1.1.0 only return FLUID_FAILED if an error occurs.

References FLUID_FAILED, FLUID_OK, fluid_voice_get_id(), and fluid_voice_is_on().

◆ fluid_synth_sfload()

FLUIDSYNTH_API int fluid_synth_sfload	(	fluid_synth_t *	synth,
		const char *	filename,
		int	reset_presets
	)

Load a SoundFont file (filename is interpreted by SoundFont loaders).

The newly loaded SoundFont will be put on top of the SoundFont stack. Presets are searched starting from the SoundFont on the top of the stack, working the way down the stack until a preset is found.

Parameters

synth	FluidSynth instance
filename	File to load
reset_presets	TRUE to re-assign presets for all MIDI channels (equivalent to calling fluid_synth_program_reset())

Returns: SoundFont ID on success, FLUID_FAILED on error

Examples:: example.c, fluidsynth_arpeggio.c, fluidsynth_fx.c, fluidsynth_metronome.c, and fluidsynth_simple.c.

References FLUID_ERR, FLUID_FAILED, fluid_synth_program_reset(), and _fluid_sfont_t::id.

Referenced by fluid_get_sysconf().

◆ fluid_synth_sfreload()

FLUIDSYNTH_API int fluid_synth_sfreload	(	fluid_synth_t *	synth,
		unsigned int	id
	)

Reload a SoundFont.

The SoundFont retains its ID and index on the SoundFont stack.

Parameters

synth	FluidSynth instance
id	ID of SoundFont to reload

Returns: SoundFont ID on success, FLUID_FAILED on error

References FLUID_FAILED.

Referenced by fluid_get_sysconf().

◆ fluid_synth_sfunload()

FLUIDSYNTH_API int fluid_synth_sfunload	(	fluid_synth_t *	synth,
		unsigned int	id,
		int	reset_presets
	)

Unload a SoundFont.

Parameters

synth	FluidSynth instance
id	ID of SoundFont to unload
reset_presets	TRUE to re-assign presets for all MIDI channels

Returns: FLUID_OK on success, FLUID_FAILED on error

References FLUID_FAILED.

Referenced by fluid_get_sysconf().

◆ fluid_synth_add_sfont()

FLUIDSYNTH_API int fluid_synth_add_sfont	(	fluid_synth_t *	synth,
		fluid_sfont_t *	sfont
	)

Add a SoundFont.

The SoundFont will be added to the top of the SoundFont stack.

Parameters

synth	FluidSynth instance
sfont	SoundFont to add

Returns: New assigned SoundFont ID or FLUID_FAILED on error

References FLUID_FAILED, fluid_synth_program_reset(), and _fluid_sfont_t::id.

◆ fluid_synth_remove_sfont()

FLUIDSYNTH_API void fluid_synth_remove_sfont	(	fluid_synth_t *	synth,
		fluid_sfont_t *	sfont
	)

Remove a SoundFont from the SoundFont stack without deleting it.

Parameters

synth	FluidSynth instance
sfont	SoundFont to remove

SoundFont is not freed and is left as the responsibility of the caller.

Note: The SoundFont should only be freed after there are no presets referencing it. This can only be ensured by the SoundFont loader and therefore this function should not normally be used.

References fluid_synth_program_reset().

◆ fluid_synth_sfcount()

FLUIDSYNTH_API int fluid_synth_sfcount ( fluid_synth_t * synth )

Count number of loaded SoundFont files.

Parameters

synth FluidSynth instance

Returns: Count of loaded SoundFont files.

Referenced by fluid_get_sysconf().

◆ fluid_synth_get_sfont()

FLUIDSYNTH_API fluid_sfont_t* fluid_synth_get_sfont	(	fluid_synth_t *	synth,
		unsigned int	num
	)

Get SoundFont by index.

Parameters

synth	FluidSynth instance
num	SoundFont index on the stack (starting from 0 for top of stack).

Returns: SoundFont instance or NULL if invalid index

Note: Caller should be certain that SoundFont is not deleted (unloaded) for the duration of use of the returned pointer.

Referenced by fluid_get_sysconf().

◆ fluid_synth_get_sfont_by_id()

FLUIDSYNTH_API fluid_sfont_t* fluid_synth_get_sfont_by_id	(	fluid_synth_t *	synth,
		unsigned int	id
	)

Get SoundFont by ID.

Parameters

synth	FluidSynth instance
id	SoundFont ID

Returns: SoundFont instance or NULL if invalid ID

Note: Caller should be certain that SoundFont is not deleted (unloaded) for the duration of use of the returned pointer.

Referenced by fluid_get_sysconf().

◆ fluid_synth_get_sfont_by_name()

FLUIDSYNTH_API fluid_sfont_t* fluid_synth_get_sfont_by_name	(	fluid_synth_t *	synth,
		const char *	name
	)

Get SoundFont by name.

Parameters

synth	FluidSynth instance
name	Name of SoundFont

Returns: SoundFont instance or NULL if invalid name

Since: 1.1.0

Note: Caller should be certain that SoundFont is not deleted (unloaded) for the duration of use of the returned pointer.

◆ fluid_synth_set_bank_offset()

FLUIDSYNTH_API int fluid_synth_set_bank_offset	(	fluid_synth_t *	synth,
		int	sfont_id,
		int	offset
	)

Offset the bank numbers of a loaded SoundFont, i.e. subtract offset from any bank number when assigning instruments.

Parameters

synth	FluidSynth instance
sfont_id	ID of a loaded SoundFont
offset	Bank offset value to apply to all instruments

References FLUID_FAILED.

Referenced by fluid_get_sysconf().

◆ fluid_synth_get_bank_offset()

FLUIDSYNTH_API int fluid_synth_get_bank_offset	(	fluid_synth_t *	synth,
		int	sfont_id
	)

Get bank offset of a loaded SoundFont.

Parameters

synth	FluidSynth instance
sfont_id	ID of a loaded SoundFont

Returns: SoundFont bank offset value

Referenced by fluid_get_sysconf().

◆ fluid_synth_set_reverb()

FLUIDSYNTH_API void fluid_synth_set_reverb	(	fluid_synth_t *	synth,
		double	roomsize,
		double	damping,
		double	width,
		double	level
	)

Set reverb parameters.

Parameters

synth	FluidSynth instance
roomsize	Reverb room size value (0.0-1.2)
damping	Reverb damping value (0.0-1.0)
width	Reverb width value (0.0-100.0)
level	Reverb level value (0.0-1.0)

Note: Not realtime safe and therefore should not be called from synthesis context at the risk of stalling audio output.

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_set_reverb_on().

◆ fluid_synth_set_reverb_on()

FLUIDSYNTH_API void fluid_synth_set_reverb_on	(	fluid_synth_t *	synth,
		int	on
	)

Enable or disable reverb effect.

Parameters

synth	FluidSynth instance
on	TRUE to enable reverb, FALSE to disable

References FLUID_FAILED, FLUID_OK, and fluid_synth_set_reverb().

Referenced by new_fluid_synth().

◆ fluid_synth_get_reverb_roomsize()

FLUIDSYNTH_API double fluid_synth_get_reverb_roomsize ( fluid_synth_t * synth )

Get reverb room size.

Parameters

synth FluidSynth instance

Returns: Reverb room size (0.0-1.2)

◆ fluid_synth_get_reverb_damp()

FLUIDSYNTH_API double fluid_synth_get_reverb_damp ( fluid_synth_t * synth )

Get reverb damping.

Parameters

synth FluidSynth instance

Returns: Reverb damping value (0.0-1.0)

◆ fluid_synth_get_reverb_level()

FLUIDSYNTH_API double fluid_synth_get_reverb_level ( fluid_synth_t * synth )

Get reverb level.

Parameters

synth FluidSynth instance

Returns: Reverb level value (0.0-1.0)

◆ fluid_synth_get_reverb_width()

FLUIDSYNTH_API double fluid_synth_get_reverb_width ( fluid_synth_t * synth )

Get reverb width.

Parameters

synth FluidSynth instance

Returns: Reverb width value (0.0-100.0)

◆ fluid_synth_set_chorus()

FLUIDSYNTH_API void fluid_synth_set_chorus	(	fluid_synth_t *	synth,
		int	nr,
		double	level,
		double	speed,
		double	depth_ms,
		int	type
	)

Set chorus parameters.

Parameters

synth	FluidSynth instance
nr	Chorus voice count (0-99, CPU time consumption proportional to this value)
level	Chorus level (0.0-10.0)
speed	Chorus speed in Hz (0.29-5.0)
depth_ms	Chorus depth (max value depends on synth sample rate, 0.0-21.0 is safe for sample rate values up to 96KHz)
type	Chorus waveform type (fluid_chorus_mod)

References FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_set_chorus_on()

FLUIDSYNTH_API void fluid_synth_set_chorus_on	(	fluid_synth_t *	synth,
		int	on
	)

Enable or disable chorus effect.

Parameters

synth	FluidSynth instance
on	TRUE to enable chorus, FALSE to disable

Referenced by new_fluid_synth().

◆ fluid_synth_get_chorus_nr()

FLUIDSYNTH_API int fluid_synth_get_chorus_nr ( fluid_synth_t * synth )

Get chorus voice number (delay line count) value.

Parameters

synth FluidSynth instance

Returns: Chorus voice count (0-99)

◆ fluid_synth_get_chorus_level()

FLUIDSYNTH_API double fluid_synth_get_chorus_level ( fluid_synth_t * synth )

Get chorus level.

Parameters

synth FluidSynth instance

Returns: Chorus level value (0.0-10.0)

◆ fluid_synth_get_chorus_speed_Hz()

FLUIDSYNTH_API double fluid_synth_get_chorus_speed_Hz ( fluid_synth_t * synth )

Get chorus speed in Hz.

Parameters

synth FluidSynth instance

Returns: Chorus speed in Hz (0.29-5.0)

◆ fluid_synth_get_chorus_depth_ms()

FLUIDSYNTH_API double fluid_synth_get_chorus_depth_ms ( fluid_synth_t * synth )

Get chorus depth.

Parameters

synth FluidSynth instance

Returns: Chorus depth

◆ fluid_synth_get_chorus_type()

FLUIDSYNTH_API int fluid_synth_get_chorus_type ( fluid_synth_t * synth )

Get chorus waveform type.

Parameters

synth FluidSynth instance

Returns: Chorus waveform type (fluid_chorus_mod)

References fluid_voice_get_channel(), fluid_voice_get_id(), fluid_voice_get_key(), fluid_voice_is_playing(), and fluid_voice_is_sostenuto().

◆ fluid_synth_count_midi_channels()

FLUIDSYNTH_API int fluid_synth_count_midi_channels ( fluid_synth_t * synth )

Get the total count of MIDI channels.

Parameters

synth FluidSynth instance

Returns: Count of MIDI channels

Referenced by fluid_get_sysconf().

◆ fluid_synth_count_audio_channels()

FLUIDSYNTH_API int fluid_synth_count_audio_channels ( fluid_synth_t * synth )

Get the total count of audio channels.

Parameters

synth FluidSynth instance

Returns: Count of audio channel stereo pairs (1 = 2 channels, 2 = 4, etc)

◆ fluid_synth_count_audio_groups()

FLUIDSYNTH_API int fluid_synth_count_audio_groups ( fluid_synth_t * synth )

Get the total number of allocated audio channels.

Usually identical to the number of audio channels. Can be employed by LADSPA effects subsystem.

Parameters

synth FluidSynth instance

Returns: Count of audio group stereo pairs (1 = 2 channels, 2 = 4, etc)

◆ fluid_synth_count_effects_channels()

FLUIDSYNTH_API int fluid_synth_count_effects_channels ( fluid_synth_t * synth )

Get the total number of allocated effects channels.

Parameters

synth FluidSynth instance

Returns: Count of allocated effects channels

◆ fluid_synth_set_sample_rate()

FLUIDSYNTH_API void fluid_synth_set_sample_rate	(	fluid_synth_t *	synth,
		float	sample_rate
	)

Set sample rate of the synth.

Note: This function is currently experimental and should only be used when no voices or notes are active, and before any rendering calls.

Parameters

synth	FluidSynth instance
sample_rate	New sample rate (Hz)

Since: 1.1.2

References fluid_settings_getint(), and fluid_synth_set_gain().

Referenced by new_fluid_synth().

◆ fluid_synth_set_gain()

FLUIDSYNTH_API void fluid_synth_set_gain	(	fluid_synth_t *	synth,
		float	gain
	)

Set synth output gain value.

Parameters

synth	FluidSynth instance
gain	Gain value (function clamps value to the range 0.0 to 10.0)

References fluid_voice_is_playing().

Referenced by fluid_synth_set_sample_rate().

◆ fluid_synth_get_gain()

FLUIDSYNTH_API float fluid_synth_get_gain ( fluid_synth_t * synth )

Get synth output gain value.

Parameters

synth FluidSynth instance

Returns: Synth gain value (0.0 to 10.0)

References fluid_synth_set_polyphony().

◆ fluid_synth_set_polyphony()

FLUIDSYNTH_API int fluid_synth_set_polyphony	(	fluid_synth_t *	synth,
		int	polyphony
	)

Set synthesizer polyphony (max number of voices).

Parameters

synth	FluidSynth instance
polyphony	Polyphony to assign

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.0.6

References FLUID_FAILED, FLUID_OK, and fluid_voice_is_playing().

Referenced by fluid_synth_get_gain().

◆ fluid_synth_get_polyphony()

FLUIDSYNTH_API int fluid_synth_get_polyphony ( fluid_synth_t * synth )

Get current synthesizer polyphony (max number of voices).

Parameters

synth FluidSynth instance

Returns: Synth polyphony value.

Since: 1.0.6

References FLUID_FAILED.

◆ fluid_synth_get_active_voice_count()

FLUIDSYNTH_API int fluid_synth_get_active_voice_count ( fluid_synth_t * synth )

Get current number of active voices.

I.e. the no. of voices that have been started and have not yet finished. Unless called from synthesis context, this number does not necessarily have to be equal to the number of voices currently processed by the DSP loop, see below.

Parameters

synth FluidSynth instance

Returns: Number of currently active voices.

Since: 1.1.0

Note: To generate accurate continuous statistics of the voice count, caller should ensure this function is called synchronously with the audio synthesis process. This can be done in the new_fluid_audio_driver2() audio callback function for example. Otherwise every call to this function may return different voice counts as it may change after any (concurrent) call to fluid_synth_write_*() made by e.g. an audio driver or the applications audio rendering thread.

References FLUID_FAILED.

◆ fluid_synth_get_internal_bufsize()

FLUIDSYNTH_API int fluid_synth_get_internal_bufsize ( fluid_synth_t * synth )

Get the internal synthesis buffer size value.

Parameters

synth FluidSynth instance

Returns: Internal buffer size in audio frames.

Audio is synthesized this number of frames at a time. Defaults to 64 frames.

◆ fluid_synth_set_interp_method()

FLUIDSYNTH_API int fluid_synth_set_interp_method	(	fluid_synth_t *	synth,
		int	chan,
		int	interp_method
	)

Set synthesis interpolation method on one or all MIDI channels.

Parameters

synth	FluidSynth instance
chan	MIDI channel to set interpolation method on or -1 for all channels
interp_method	Interpolation method (fluid_interp)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_ERR, FLUID_FAILED, and FLUID_OK.

◆ fluid_synth_set_gen()

FLUIDSYNTH_API int fluid_synth_set_gen	(	fluid_synth_t *	synth,
		int	chan,
		int	param,
		float	value
	)

Set a SoundFont generator (effect) value on a MIDI channel in real-time.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
param	SoundFont generator ID (fluid_gen_type)
value	Offset generator value to assign to the MIDI channel

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Parameter numbers and ranges are described in the SoundFont 2.01 specification PDF, paragraph 8.1.3, page 48. See fluid_gen_type.

References FLUID_FAILED, FLUID_OK, fluid_voice_get_channel(), and GEN_LAST.

◆ fluid_synth_set_gen2()

FLUIDSYNTH_API FLUID_DEPRECATED int fluid_synth_set_gen2	(	fluid_synth_t *	synth,
		int	chan,
		int	param,
		float	value,
		int	absolute,
		int	normalized
	)

Set a SoundFont generator (effect) value on a MIDI channel in real-time.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
param	SoundFont generator ID (fluid_gen_type)
value	Offset or absolute generator value to assign to the MIDI channel
absolute	0 to assign a relative value, non-zero to assign an absolute value
normalized	0 if value is specified in the native units of the generator, non-zero to take the value as a 0.0-1.0 range and apply it to the valid generator effect range (scaled and shifted as necessary).

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

Deprecated:: As of 1.1.9 this function is deprecated, because there doesn't seem to be a use-case for it.

This function allows for setting all effect parameters in real time on a MIDI channel. Setting absolute to non-zero will cause the value to override any generator values set in the instruments played on the MIDI channel. See SoundFont 2.01 spec, paragraph 8.1.3, page 48 for details on SoundFont generator parameters and valid ranges.

References FLUID_FAILED, FLUID_OK, and GEN_LAST.

◆ fluid_synth_get_gen()

FLUIDSYNTH_API float fluid_synth_get_gen	(	fluid_synth_t *	synth,
		int	chan,
		int	param
	)

Get generator value assigned to a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
param	SoundFont generator ID (fluid_gen_type)

Returns: Current generator value assigned to MIDI channel

References FLUID_FAILED, and GEN_LAST.

◆ fluid_synth_create_key_tuning()

FLUIDSYNTH_API FLUID_DEPRECATED int fluid_synth_create_key_tuning	(	fluid_synth_t *	synth,
		int	bank,
		int	prog,
		const char *	name,
		const double *	pitch
	)

Set the tuning of the entire MIDI note scale.

Parameters

synth	FluidSynth instance
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program
name	Label name for this tuning
pitch	Array of pitch values (length of 128, each value is number of cents, for example normally note 0 is 0.0, 1 is 100.0, 60 is 6000.0, etc). Pass NULL to create a equal tempered (normal) scale.

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: Tuning is not applied in realtime to existing notes of the replaced tuning (if any), use fluid_synth_activate_key_tuning() instead to specify this behavior.

Deprecated:: Use fluid_synth_activate_key_tuning(synth, bank, prog, name, pitch, FALSE) instead.

References fluid_synth_activate_key_tuning().

◆ fluid_synth_activate_key_tuning()

FLUIDSYNTH_API int fluid_synth_activate_key_tuning	(	fluid_synth_t *	synth,
		int	bank,
		int	prog,
		const char *	name,
		const double *	pitch,
		int	apply
	)

Set the tuning of the entire MIDI note scale.

Parameters

synth	FluidSynth instance
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program
name	Label name for this tuning
pitch	Array of pitch values (length of 128, each value is number of cents, for example normally note 0 is 0.0, 1 is 100.0, 60 is 6000.0, etc). Pass NULL to create a equal tempered (normal) scale.
apply	TRUE to apply new tuning in realtime to existing notes which are using the replaced tuning (if any), FALSE otherwise

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_create_key_tuning().

◆ fluid_synth_create_octave_tuning()

FLUIDSYNTH_API FLUID_DEPRECATED int fluid_synth_create_octave_tuning	(	fluid_synth_t *	synth,
		int	bank,
		int	prog,
		const char *	name,
		const double *	pitch
	)

Apply an octave tuning to every octave in the MIDI note scale.

Parameters

synth	FluidSynth instance
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program
name	Label name for this tuning
pitch	Array of pitch values (length of 12 for each note of an octave starting at note C, values are number of offset cents to add to the normal tuning amount)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: Tuning is not applied in realtime to existing notes of the replaced tuning (if any), use fluid_synth_activate_octave_tuning() instead to specify this behavior.

Deprecated:: Use fluid_synth_activate_octave_tuning(synth, bank, prog, name, pitch, FALSE) instead.

References fluid_synth_activate_octave_tuning().

◆ fluid_synth_activate_octave_tuning()

FLUIDSYNTH_API int fluid_synth_activate_octave_tuning	(	fluid_synth_t *	synth,
		int	bank,
		int	prog,
		const char *	name,
		const double *	pitch,
		int	apply
	)

Activate an octave tuning on every octave in the MIDI note scale.

Parameters

synth	FluidSynth instance
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program
name	Label name for this tuning
pitch	Array of pitch values (length of 12 for each note of an octave starting at note C, values are number of offset cents to add to the normal tuning amount)
apply	TRUE to apply new tuning in realtime to existing notes which are using the replaced tuning (if any), FALSE otherwise

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_create_octave_tuning(), and fluid_synth_sysex().

◆ fluid_synth_tune_notes()

FLUIDSYNTH_API int fluid_synth_tune_notes	(	fluid_synth_t *	synth,
		int	bank,
		int	prog,
		int	len,
		const int *	key,
		const double *	pitch,
		int	apply
	)

Set tuning values for one or more MIDI notes for an existing tuning.

Parameters

synth	FluidSynth instance
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program
len	Number of MIDI notes to assign
key	Array of MIDI key numbers (length of 'len', values 0-127)
pitch	Array of pitch values (length of 'len', values are number of cents from MIDI note 0)
apply	TRUE to apply tuning change in realtime to existing notes using the specified tuning, FALSE otherwise

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: Prior to version 1.1.0 it was an error to specify a tuning that didn't already exist. Starting with 1.1.0, the default equal tempered scale will be used as a basis, if no tuning exists for the given bank and prog.

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_sysex().

◆ fluid_synth_select_tuning()

FLUIDSYNTH_API FLUID_DEPRECATED int fluid_synth_select_tuning	(	fluid_synth_t *	synth,
		int	chan,
		int	bank,
		int	prog
	)

Select a tuning scale on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: This function does NOT activate tuning in realtime, use fluid_synth_activate_tuning() instead to specify whether tuning change should cause existing notes to update.; Prior to version 1.1.0 it was an error to select a tuning that didn't already exist. Starting with 1.1.0, a default equal tempered scale will be created, if no tuning exists for the given bank and prog.

Deprecated:: Use fluid_synth_activate_tuning(synth, chan, bank, prog, FALSE) instead.

References fluid_synth_activate_tuning().

◆ fluid_synth_activate_tuning()

FLUIDSYNTH_API int fluid_synth_activate_tuning	(	fluid_synth_t *	synth,
		int	chan,
		int	bank,
		int	prog,
		int	apply
	)

Activate a tuning scale on a MIDI channel.

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
bank	Tuning bank number (0-127), not related to MIDI instrument bank
prog	Tuning preset number (0-127), not related to MIDI instrument program
apply	TRUE to apply tuning change to active notes, FALSE otherwise

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

Note: A default equal tempered scale will be created, if no tuning exists on the given bank and prog.

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_cc(), fluid_synth_select_tuning(), and fluid_synth_sysex().

◆ fluid_synth_reset_tuning()

FLUIDSYNTH_API FLUID_DEPRECATED int fluid_synth_reset_tuning	(	fluid_synth_t *	synth,
		int	chan
	)

Clear tuning scale on a MIDI channel (set it to the default equal tempered scale).

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Note: This function does NOT activate tuning change in realtime, use fluid_synth_deactivate_tuning() instead to specify whether tuning change should cause existing notes to update.

Deprecated:: Use fluid_synth_deactivate_tuning(synth, chan, FALSE) instead.

References fluid_synth_deactivate_tuning().

◆ fluid_synth_deactivate_tuning()

FLUIDSYNTH_API int fluid_synth_deactivate_tuning	(	fluid_synth_t *	synth,
		int	chan,
		int	apply
	)

Clear tuning scale on a MIDI channel (use default equal tempered scale).

Parameters

synth	FluidSynth instance
chan	MIDI channel number (0 to MIDI channel count - 1)
apply	TRUE to apply tuning change to active notes, FALSE otherwise

Returns: FLUID_OK on success, FLUID_FAILED otherwise

Since: 1.1.0

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_reset_tuning().

◆ fluid_synth_tuning_iteration_start()

FLUIDSYNTH_API void fluid_synth_tuning_iteration_start ( fluid_synth_t * synth )

Start tuning iteration.

Parameters

synth FluidSynth instance

◆ fluid_synth_tuning_iteration_next()

FLUIDSYNTH_API int fluid_synth_tuning_iteration_next	(	fluid_synth_t *	synth,
		int *	bank,
		int *	prog
	)

Advance to next tuning.

Parameters

synth	FluidSynth instance
bank	Location to store MIDI bank number of next tuning scale
prog	Location to store MIDI program number of next tuning scale

Returns: 1 if tuning iteration advanced, 0 if no more tunings

◆ fluid_synth_tuning_dump()

FLUIDSYNTH_API int fluid_synth_tuning_dump	(	fluid_synth_t *	synth,
		int	bank,
		int	prog,
		char *	name,
		int	len,
		double *	pitch
	)

Get the entire note tuning for a given MIDI bank and program.

Parameters

synth	FluidSynth instance
bank	MIDI bank number of tuning
prog	MIDI program number of tuning
name	Location to store tuning name or NULL to ignore
len	Maximum number of chars to store to 'name' (including NULL byte)
pitch	Array to store tuning scale to or NULL to ignore (len of 128)

Returns: FLUID_OK if matching tuning was found, FLUID_FAILED otherwise

References FLUID_FAILED, and FLUID_OK.

Referenced by fluid_synth_sysex().

◆ fluid_synth_get_cpu_load()

FLUIDSYNTH_API double fluid_synth_get_cpu_load ( fluid_synth_t * synth )

Get the synth CPU load value.

Parameters

synth FluidSynth instance

Returns: Estimated CPU load value in percent (0-100)

References FLUID_FAILED, FLUID_OK, FLUID_PANIC, fluid_voice_is_on(), fluid_voice_update_param(), and GEN_PITCH.

◆ fluid_synth_error()

FLUIDSYNTH_API char* fluid_synth_error ( fluid_synth_t * synth )

Get a textual representation of the last error.

Parameters

synth FluidSynth instance

Returns: Pointer to string of last error message. Valid until the same calling thread calls another FluidSynth function which fails. String is internal and should not be modified or freed.

◆ fluid_synth_write_s16()

FLUIDSYNTH_API int fluid_synth_write_s16	(	fluid_synth_t *	synth,
		int	len,
		void *	lout,
		int	loff,
		int	lincr,
		void *	rout,
		int	roff,
		int	rincr
	)

Synthesize a block of 16 bit audio samples to audio buffers.

Parameters

synth	FluidSynth instance
len	Count of audio frames to synthesize
lout	Array of 16 bit words to store left channel of audio
loff	Offset index in 'lout' for first sample
lincr	Increment between samples stored to 'lout'
rout	Array of 16 bit words to store right channel of audio
roff	Offset index in 'rout' for first sample
rincr	Increment between samples stored to 'rout'

Returns: FLUID_OK on success, FLUID_FAIL otherwise

Useful for storing interleaved stereo (lout = rout, loff = 0, roff = 1, lincr = 2, rincr = 2).

Note: Should only be called from synthesis thread.; Reverb and Chorus are mixed to lout resp. rout.; Dithering is performed when converting from internal floating point to 16 bit audio.

References FLUID_DBG, fluid_settings_getnum(), fluid_voice_get_channel(), fluid_voice_get_id(), and fluid_voice_get_key().

Referenced by fluid_file_renderer_process_block().

◆ fluid_synth_write_float()

FLUIDSYNTH_API int fluid_synth_write_float	(	fluid_synth_t *	synth,
		int	len,
		void *	lout,
		int	loff,
		int	lincr,
		void *	rout,
		int	roff,
		int	rincr
	)

Synthesize a block of floating point audio samples to audio buffers.

Parameters

synth	FluidSynth instance
len	Count of audio frames to synthesize
lout	Array of floats to store left channel of audio
loff	Offset index in 'lout' for first sample
lincr	Increment between samples stored to 'lout'
rout	Array of floats to store right channel of audio
roff	Offset index in 'rout' for first sample
rincr	Increment between samples stored to 'rout'

Returns: FLUID_OK on success, FLUID_FAIL otherwise

Useful for storing interleaved stereo (lout = rout, loff = 0, roff = 1, lincr = 2, rincr = 2).

Note: Should only be called from synthesis thread.; Reverb and Chorus are mixed to lout resp. rout.

References FLUID_OK.

Referenced by fluid_file_renderer_process_block(), and fluid_synth_process().

◆ fluid_synth_nwrite_float()

FLUIDSYNTH_API int fluid_synth_nwrite_float	(	fluid_synth_t *	synth,
		int	len,
		float **	left,
		float **	right,
		float **	fx_left,
		float **	fx_right
	)

Synthesize a block of floating point audio to separate audio buffers (multichannel rendering).

First effect channel used by reverb, second for chorus.

Parameters

synth	FluidSynth instance
len	Count of audio frames to synthesize
left	Array of float buffers to store left channel of planar audio (as many as `synth.audio-channels` buffers, each of `len` in size)
right	Array of float buffers to store right channel of planar audio (size: dito)
fx_left	Since 1.1.7: If not `NULL`, array of float buffers to store left effect channels (as many as `synth.effects-channels` buffers, each of `len` in size)
fx_right	Since 1.1.7: If not `NULL`, array of float buffers to store right effect channels (size: dito)

Returns: FLUID_OK on success, FLUID_FAIL otherwise

Note: Should only be called from synthesis thread.

Usage example:

const int FramesToRender = 64;
int channels;
// retrieve number of stereo audio channels
fluid_settings_getint(settings, "synth.audio-channels", &channels);
// we need twice as many (mono-)buffers
channels *= 2;
// fluid_synth_nwrite_float renders planar audio, e.g. if synth.audio-channels==16: each midi channel gets rendered to its own stereo buffer, rather than having one buffer and interleaved PCM
float** mix_buf = new float*[channels];
for(int i = 0; i < channels; i++)
{
    mix_buf[i] = new float[FramesToRender];
}
// retrieve number of (stereo) effect channels (internally hardcoded to reverb (first chan) and chrous (second chan))
fluid_settings_getint(settings, "synth.effects-channels", &channels);
channels *= 2;
float** fx_buf = new float*[channels];
for(int i = 0; i < channels; i++)
{
    fx_buf[i] = new float[FramesToRender];
}
float** mix_buf_l = mix_buf;
float** mix_buf_r = &mix_buf[channels/2];
float** fx_buf_l = fx_buf;
float** fx_buf_r = &fx_buf[channels/2];
fluid_synth_nwrite_float(synth, FramesToRender, mix_buf_l, mix_buf_r, fx_buf_l, fx_buf_r)

References FLUID_OK.

Referenced by fluid_synth_process().

◆ fluid_synth_process()

FLUIDSYNTH_API int fluid_synth_process	(	fluid_synth_t *	synth,
		int	len,
		int	nin,
		float **	in,
		int	nout,
		float **	out
	)

Synthesize floating point audio to audio buffers.

Parameters

synth	FluidSynth instance
len	Count of audio frames to synthesize
nin	Ignored
in	Ignored
nout	Count of arrays in 'out'
out	Array of arrays to store audio to

Returns: FLUID_OK on success, FLUID_FAIL otherwise

This function implements the default interface defined in fluidsynth/audio.h.

Note: Should only be called from synthesis thread.

Examples:: fluidsynth_fx.c.

References FLUID_ERR, FLUID_FAILED, FLUID_OK, fluid_synth_nwrite_float(), and fluid_synth_write_float().

◆ fluid_synth_add_sfloader()

FLUIDSYNTH_API void fluid_synth_add_sfloader	(	fluid_synth_t *	synth,
		fluid_sfloader_t *	loader
	)

Add a SoundFont loader to the synth.

This function takes ownership of loader and frees it automatically upon synth destruction.

Parameters

synth	FluidSynth instance
loader	Loader API structure

SoundFont loaders are used to add custom instrument loading to FluidSynth. The caller supplied functions for loading files, allocating presets, retrieving information on them and synthesizing note-on events. Using this method even non SoundFont instruments can be synthesized, although limited to the SoundFont synthesis model.

Note: Should only be called before any SoundFont files are loaded.

Referenced by new_fluid_synth().

◆ fluid_synth_alloc_voice()

FLUIDSYNTH_API fluid_voice_t* fluid_synth_alloc_voice	(	fluid_synth_t *	synth,
		fluid_sample_t *	sample,
		int	chan,
		int	key,
		int	vel
	)

Allocate a synthesis voice.

Parameters

synth	FluidSynth instance
sample	Sample to assign to the voice
chan	MIDI channel number (0 to MIDI channel count - 1)
key	MIDI note number for the voice (0-127)
vel	MIDI velocity for the voice (0-127)

Returns: Allocated synthesis voice or NULL on error

This function is called by a SoundFont's preset in response to a noteon event. The returned voice comes with default modulators and generators. A single noteon event may create any number of voices, when the preset is layered.

Note: Should only be called from within synthesis thread, which includes SoundFont loader preset noteon method.

References FLUID_DBG, FLUID_INFO, FLUID_OK, FLUID_VOICE_DEFAULT, fluid_voice_get_channel(), fluid_voice_get_id(), fluid_voice_is_playing(), FLUID_WARN, and GEN_EXCLUSIVECLASS.

Referenced by fluid_ramsfont_izone_set_loop().

◆ fluid_synth_start_voice()

FLUIDSYNTH_API void fluid_synth_start_voice	(	fluid_synth_t *	synth,
		fluid_voice_t *	voice
	)

Activate a voice previously allocated with fluid_synth_alloc_voice().

Parameters

synth	FluidSynth instance
voice	Voice to activate

This function is called by a SoundFont's preset in response to a noteon event. Exclusive classes are processed here.

Note: Should only be called from within synthesis thread, which includes SoundFont loader preset noteon method.

Referenced by fluid_ramsfont_izone_set_loop().

◆ fluid_synth_get_voicelist()

FLUIDSYNTH_API void fluid_synth_get_voicelist	(	fluid_synth_t *	synth,
		fluid_voice_t *	buf[],
		int	bufsize,
		int	id
	)

Get list of currently playing voices.

Parameters

synth	FluidSynth instance
buf	Array to store voices to (NULL terminated if not filled completely)
bufsize	Count of indexes in buf
id	Voice ID to search for or < 0 to return list of all playing voices

Note: Should only be called from within synthesis thread, which includes SoundFont loader preset noteon methods. Voices are only guaranteed to remain unchanged until next synthesis process iteration.

References fluid_voice_is_playing().

◆ fluid_synth_handle_midi_event()

FLUIDSYNTH_API int fluid_synth_handle_midi_event	(	void *	data,
		fluid_midi_event_t *	event
	)

Handle MIDI event from MIDI router, used as a callback function.

Parameters

data	FluidSynth instance
event	MIDI event to handle

Returns: FLUID_OK on success, FLUID_FAILED otherwise

References FLUID_FAILED, fluid_midi_event_get_channel(), fluid_midi_event_get_control(), fluid_midi_event_get_key(), fluid_midi_event_get_pitch(), fluid_midi_event_get_program(), fluid_midi_event_get_type(), fluid_midi_event_get_value(), fluid_midi_event_get_velocity(), fluid_synth_cc(), fluid_synth_channel_pressure(), fluid_synth_noteoff(), fluid_synth_noteon(), fluid_synth_pitch_bend(), fluid_synth_program_change(), fluid_synth_sysex(), and fluid_synth_system_reset().

Referenced by fluid_midi_dump_postrouter(), and new_fluid_player().

◆ fluid_synth_set_midi_router()

FLUIDSYNTH_API FLUID_DEPRECATED void fluid_synth_set_midi_router	(	fluid_synth_t *	synth,
		fluid_midi_router_t *	router
	)

Assign a MIDI router to a synth.

Parameters

synth	FluidSynth instance
router	MIDI router to assign to the synth

Note: This should only be done once and prior to using the synth.

Deprecated:: This function is only used by shell command handler, which will be refactored in a future release.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ FLUID_INTERP_DEFAULT

◆ FLUID_INTERP_HIGHEST

Typedef Documentation

◆ fluid_audio_callback_t

Enumeration Type Documentation

◆ fluid_midi_channel_type

◆ fluid_chorus_mod

◆ fluid_interp

Function Documentation

◆ new_fluid_synth()

◆ delete_fluid_synth()

◆ fluid_synth_get_settings()

◆ fluid_synth_noteon()

◆ fluid_synth_noteoff()

◆ fluid_synth_cc()

◆ fluid_synth_get_cc()

◆ fluid_synth_sysex()

◆ fluid_synth_pitch_bend()

◆ fluid_synth_get_pitch_bend()

◆ fluid_synth_pitch_wheel_sens()

◆ fluid_synth_get_pitch_wheel_sens()

◆ fluid_synth_program_change()

◆ fluid_synth_channel_pressure()

◆ fluid_synth_bank_select()

◆ fluid_synth_sfont_select()

◆ fluid_synth_program_select()

◆ fluid_synth_program_select_by_sfont_name()

◆ fluid_synth_get_program()

◆ fluid_synth_unset_program()

◆ fluid_synth_get_channel_info()

◆ fluid_synth_program_reset()

◆ fluid_synth_system_reset()

◆ fluid_synth_all_notes_off()

◆ fluid_synth_all_sounds_off()

◆ fluid_synth_set_channel_type()

◆ fluid_synth_get_channel_preset()

◆ fluid_synth_start()

◆ fluid_synth_stop()

◆ fluid_synth_sfload()

◆ fluid_synth_sfreload()

◆ fluid_synth_sfunload()

◆ fluid_synth_add_sfont()

◆ fluid_synth_remove_sfont()

◆ fluid_synth_sfcount()

◆ fluid_synth_get_sfont()

◆ fluid_synth_get_sfont_by_id()

◆ fluid_synth_get_sfont_by_name()

◆ fluid_synth_set_bank_offset()

◆ fluid_synth_get_bank_offset()

◆ fluid_synth_set_reverb()

◆ fluid_synth_set_reverb_on()

◆ fluid_synth_get_reverb_roomsize()

◆ fluid_synth_get_reverb_damp()

◆ fluid_synth_get_reverb_level()

◆ fluid_synth_get_reverb_width()

◆ fluid_synth_set_chorus()

◆ fluid_synth_set_chorus_on()

◆ fluid_synth_get_chorus_nr()

◆ fluid_synth_get_chorus_level()

◆ fluid_synth_get_chorus_speed_Hz()

◆ fluid_synth_get_chorus_depth_ms()

◆ fluid_synth_get_chorus_type()

◆ fluid_synth_count_midi_channels()

◆ fluid_synth_count_audio_channels()

◆ fluid_synth_count_audio_groups()

◆ fluid_synth_count_effects_channels()

◆ fluid_synth_set_sample_rate()

◆ fluid_synth_set_gain()

◆ fluid_synth_get_gain()

◆ fluid_synth_set_polyphony()

◆ fluid_synth_get_polyphony()

◆ fluid_synth_get_active_voice_count()

◆ fluid_synth_get_internal_bufsize()