Functions
static mm_word	mmReverbBufferSize (mm_word bit_depth, mm_word sampling_rate, mm_word delay)
	This calculates the amount of memory needed for the reverb buffer. More...

void	mmReverbConfigure (mm_reverb_cfg *config)
	Configures the reverb system. More...

void	mmReverbDisable (void)
	Disables the reverb system and restores the channels. More...

void	mmReverbEnable (void)
	Enables the reverb system. More...

void	mmReverbStart (mm_reverbch channels)
	Starts reverb output in the selected channels. More...

void	mmReverbStop (mm_reverbch channels)
	Stops reverb output for the selected channels. More...

Detailed Description

Function Documentation

static mm_word mmReverbBufferSize	(	mm_word	bit_depth,
		mm_word	sampling_rate,
		mm_word	delay
	)

inlinestatic

This calculates the amount of memory needed for the reverb buffer.

It calculates the reverb buffer size based on bit depth, delay and sampling rate.

Parameters

bit_depth	May be 8 or 16 to represent 8-bit or 16-bit bit-depth.
sampling_rate	Sampling rate in Hertz.
delay	Reverb delay value in milliseconds.

void mmReverbConfigure ( mm_reverb_cfg * config )

Configures the reverb system.

See the reverb tutorial for a full explanation of the configuration structure.

Parameters

config Reverb configuration structure.

void mmReverbDisable ( void )

Disables the reverb system and restores the channels.

Note: In the interpolated audio mode, the channels cannot be restored by this function and the mixer must be reset instead.

void mmReverbEnable ( void )

Enables the reverb system.

This function locks 2 channels (1 & 3) to reserve them for reverb output. This must be called before the configuration functions can be used.

If music is playing when this function is used, a note or two may be cut due to the locking.

void mmReverbStart ( mm_reverbch channels )

Starts reverb output in the selected channels.

Parameters

channels Reverb channel selection. Can use MMRC_LEFT or MMRC_RIGHT or (MMRC_LEFT|MMRC_RIGHT).

void mmReverbStop ( mm_reverbch channels )

Stops reverb output for the selected channels.

Can select left output, right output, or both.

Parameters

channels Reverb channel selection.