libfluidsynth  2.2.4
Effect - Reverb

Functions for configuring the built-in reverb effect. More...

Functions

double fluid_synth_get_reverb_damp (fluid_synth_t *synth)
 Get reverb damping of all fx groups. More...
 
int fluid_synth_get_reverb_group_damp (fluid_synth_t *synth, int fx_group, double *damping)
 get reverb damp of one or all groups. More...
 
int fluid_synth_get_reverb_group_level (fluid_synth_t *synth, int fx_group, double *level)
 get reverb level of one or all groups. More...
 
int fluid_synth_get_reverb_group_roomsize (fluid_synth_t *synth, int fx_group, double *roomsize)
 get reverb roomsize of one or all groups. More...
 
int fluid_synth_get_reverb_group_width (fluid_synth_t *synth, int fx_group, double *width)
 get reverb width of one or all groups More...
 
double fluid_synth_get_reverb_level (fluid_synth_t *synth)
 Get reverb level of all fx groups. More...
 
double fluid_synth_get_reverb_roomsize (fluid_synth_t *synth)
 Get reverb room size of all fx groups. More...
 
double fluid_synth_get_reverb_width (fluid_synth_t *synth)
 Get reverb width of all fx groups. More...
 
int fluid_synth_reverb_on (fluid_synth_t *synth, int fx_group, int on)
 Enable or disable reverb on one fx group unit. More...
 
int fluid_synth_set_reverb (fluid_synth_t *synth, double roomsize, double damping, double width, double level)
 Set reverb parameters to all groups. More...
 
int fluid_synth_set_reverb_damp (fluid_synth_t *synth, double damping)
 Set reverb damping of all groups. More...
 
int fluid_synth_set_reverb_group_damp (fluid_synth_t *synth, int fx_group, double damping)
 Set reverb damp to one or all fx groups. More...
 
int fluid_synth_set_reverb_group_level (fluid_synth_t *synth, int fx_group, double level)
 Set reverb level to one or all fx groups. More...
 
int fluid_synth_set_reverb_group_roomsize (fluid_synth_t *synth, int fx_group, double roomsize)
 Set reverb roomsize to one or all fx groups. More...
 
int fluid_synth_set_reverb_group_width (fluid_synth_t *synth, int fx_group, double width)
 Set reverb width to one or all fx groups. More...
 
int fluid_synth_set_reverb_level (fluid_synth_t *synth, double level)
 Set reverb level of all groups. More...
 
void fluid_synth_set_reverb_on (fluid_synth_t *synth, int on)
 Enable or disable reverb effect. More...
 
int fluid_synth_set_reverb_roomsize (fluid_synth_t *synth, double roomsize)
 Set reverb roomsize of all groups. More...
 
int fluid_synth_set_reverb_width (fluid_synth_t *synth, double width)
 Set reverb width of all groups. More...
 

Detailed Description

Functions for configuring the built-in reverb effect.

Function Documentation

◆ fluid_synth_get_reverb_damp()

double fluid_synth_get_reverb_damp ( fluid_synth_t synth)

Get reverb damping of all fx groups.

Parameters
synthFluidSynth instance
Returns
Reverb damping value (0.0-1.0)
Deprecated:
Use fluid_synth_get_reverb_group_damp() in new code instead.

◆ fluid_synth_get_reverb_group_damp()

int fluid_synth_get_reverb_group_damp ( fluid_synth_t synth,
int  fx_group,
double *  damping 
)

get reverb damp of one or all groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter common to all fx groups is fetched.
dampingvalid pointer on the value to return.
Returns
FLUID_OK on success, FLUID_FAILED otherwise.

◆ fluid_synth_get_reverb_group_level()

int fluid_synth_get_reverb_group_level ( fluid_synth_t synth,
int  fx_group,
double *  level 
)

get reverb level of one or all groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter common to all fx groups is fetched.
levelvalid pointer on the value to return.
Returns
FLUID_OK on success, FLUID_FAILED otherwise.

◆ fluid_synth_get_reverb_group_roomsize()

int fluid_synth_get_reverb_group_roomsize ( fluid_synth_t synth,
int  fx_group,
double *  roomsize 
)

get reverb roomsize of one or all groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter common to all fx groups is fetched.
roomsizevalid pointer on the value to return.
Returns
FLUID_OK on success, FLUID_FAILED otherwise

◆ fluid_synth_get_reverb_group_width()

int fluid_synth_get_reverb_group_width ( fluid_synth_t synth,
int  fx_group,
double *  width 
)

get reverb width of one or all groups

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter common to all fx groups is fetched.
widthvalid pointer on the value to return.
Returns
FLUID_OK on success, FLUID_FAILED otherwise.

◆ fluid_synth_get_reverb_level()

double fluid_synth_get_reverb_level ( fluid_synth_t synth)

Get reverb level of all fx groups.

Parameters
synthFluidSynth instance
Returns
Reverb level value (0.0-1.0)
Deprecated:
Use fluid_synth_get_reverb_group_level() in new code instead.

◆ fluid_synth_get_reverb_roomsize()

double fluid_synth_get_reverb_roomsize ( fluid_synth_t synth)

Get reverb room size of all fx groups.

Parameters
synthFluidSynth instance
Returns
Reverb room size (0.0-1.2)
Deprecated:
Use fluid_synth_get_reverb_group_roomsize() in new code instead.

◆ fluid_synth_get_reverb_width()

double fluid_synth_get_reverb_width ( fluid_synth_t synth)

Get reverb width of all fx groups.

Parameters
synthFluidSynth instance
Returns
Reverb width value (0.0-100.0)
Deprecated:
Use fluid_synth_get_reverb_group_width() in new code instead.

◆ fluid_synth_reverb_on()

int fluid_synth_reverb_on ( fluid_synth_t synth,
int  fx_group,
int  on 
)

Enable or disable reverb on one fx group unit.

Parameters
synthFluidSynth instance
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter will be applied to all fx groups.
onTRUE to enable reverb, FALSE to disable
Returns
FLUID_OK on success, FLUID_FAILED otherwise

◆ fluid_synth_set_reverb()

int fluid_synth_set_reverb ( fluid_synth_t synth,
double  roomsize,
double  damping,
double  width,
double  level 
)

Set reverb parameters to all groups.

Parameters
synthFluidSynth instance
roomsizeReverb room size value (0.0-1.0)
dampingReverb damping value (0.0-1.0)
widthReverb width value (0.0-100.0)
levelReverb level value (0.0-1.0)
Returns
FLUID_OK on success, FLUID_FAILED otherwise
Deprecated:
Use the individual reverb setter functions in new code instead.

◆ fluid_synth_set_reverb_damp()

int fluid_synth_set_reverb_damp ( fluid_synth_t synth,
double  damping 
)

Set reverb damping of all groups.

Parameters
synthFluidSynth instance
dampingReverb damping value (0.0-1.0)
Returns
FLUID_OK on success, FLUID_FAILED otherwise
Deprecated:
Use fluid_synth_set_reverb_group_damp() in new code instead.

◆ fluid_synth_set_reverb_group_damp()

int fluid_synth_set_reverb_group_damp ( fluid_synth_t synth,
int  fx_group,
double  damping 
)

Set reverb damp to one or all fx groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter will be applied to all fx groups.
dampingdamping value to set. Must be in the range indicated by synth.reverb.damp setting.
Returns
FLUID_OK on success, FLUID_FAILED otherwise.

◆ fluid_synth_set_reverb_group_level()

int fluid_synth_set_reverb_group_level ( fluid_synth_t synth,
int  fx_group,
double  level 
)

Set reverb level to one or all fx groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter will be applied to all fx groups.
leveloutput level to set. Must be in the range indicated by synth.reverb.level setting.
Returns
FLUID_OK on success, FLUID_FAILED otherwise.

◆ fluid_synth_set_reverb_group_roomsize()

int fluid_synth_set_reverb_group_roomsize ( fluid_synth_t synth,
int  fx_group,
double  roomsize 
)

Set reverb roomsize to one or all fx groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter will be applied to all fx groups.
roomsizeroomsize value to set. Must be in the range indicated by synth.reverb.room-size setting.
Returns
FLUID_OK on success, FLUID_FAILED otherwise

◆ fluid_synth_set_reverb_group_width()

int fluid_synth_set_reverb_group_width ( fluid_synth_t synth,
int  fx_group,
double  width 
)

Set reverb width to one or all fx groups.

Parameters
synthFluidSynth instance.
fx_groupIndex of the fx group. Must be in the range -1 to (fluid_synth_count_effects_groups()-1). If -1 the parameter will be applied to all fx groups.
widthwidth value to set. Must be in the range indicated by synth.reverb.width setting.
Returns
FLUID_OK on success, FLUID_FAILED otherwise.

◆ fluid_synth_set_reverb_level()

int fluid_synth_set_reverb_level ( fluid_synth_t synth,
double  level 
)

Set reverb level of all groups.

Parameters
synthFluidSynth instance
levelReverb level value (0.0-1.0)
Returns
FLUID_OK on success, FLUID_FAILED otherwise
Deprecated:
Use fluid_synth_set_reverb_group_level() in new code instead.

◆ fluid_synth_set_reverb_on()

void fluid_synth_set_reverb_on ( fluid_synth_t synth,
int  on 
)

Enable or disable reverb effect.

Parameters
synthFluidSynth instance
onTRUE to enable chorus, FALSE to disable
Deprecated:
Use fluid_synth_reverb_on() instead.

◆ fluid_synth_set_reverb_roomsize()

int fluid_synth_set_reverb_roomsize ( fluid_synth_t synth,
double  roomsize 
)

Set reverb roomsize of all groups.

Parameters
synthFluidSynth instance
roomsizeReverb room size value (0.0-1.0)
Returns
FLUID_OK on success, FLUID_FAILED otherwise
Deprecated:
Use fluid_synth_set_reverb_group_roomsize() in new code instead.

◆ fluid_synth_set_reverb_width()

int fluid_synth_set_reverb_width ( fluid_synth_t synth,
double  width 
)

Set reverb width of all groups.

Parameters
synthFluidSynth instance
widthReverb width value (0.0-100.0)
Returns
FLUID_OK on success, FLUID_FAILED otherwise
Deprecated:
Use fluid_synth_set_reverb_group_width() in new code instead.