AXFX2ReverbI3dl2Init

Syntax

#include <cafe.h>
#include <cafe/axfx.h>

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


typedef enum _AXFX_REVERB_MODE
{
    AXFX_REVERB_MODE_2CH,
    AXFX_REVERB_MODE_4CH,
    AXFX_REVERB_MODE_6CH,
} AXFX_REVERB_MODE;

BOOL  AXFX2ReverbI3dl2Init  (AXFX2_REVERB_I3DL2 *reverb_i3dl2, AXFX_REVERB_MODE mode,
                             AXFX_SAMPLE_RATE sampleRate);

Parameters

reverb_i3dl2 Pointer to an AXFX2_REVERB_I3DL2 structure with valid user parameters set.
mode AXFX_REVERB_MODE enum specifying the number of channels to process.
sampleRate AXFX_SAMPLE_RATE enum specifying the sample rate of the audio signal.

Return Values

TRUE if successful; FALSE if a failure occurs or a parameter is invalid.

Description

The AXFX2ReverbI3dl2Init initializes a reverb effect given an AXFX2_REVERB_I3DL2 structure with valid user parameters, the number of channels (specified by mode), and the input signal sample rate (specified by sampleRate). This function allocates and initializes all the required runtime memory used by the delay lines and related processing steps. The user must configure the AXFX2_REVERB_I3DL2 structure's user parameters directly or with AXFX2ReverbI3dl2ParametersPreset prior to calling this function. This function should be called only once on a reverb structure. Generally the sample rate should match the sample rate initialized with AXGetInitWithParams and returned by AXGetInputSamplesPerSec.

Modes

AXFX_REVERB_MODE_2CH Two channel effect which processes two channels only.
AXFX_REVERB_MODE_4CH Four channel effect which processes four channels only.
AXFX_REVERB_MODE_6CH Six channel effect which processes six channels.

Sample Rates

AXFX_SAMPLE_RATE_32000 32kHz audio data.
AXFX_SAMPLE_RATE_48000 48kHz audio data.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Reverb I3DL2 Overview
AXFX2_REVERB_I3DL2
AXFX2ReverbI3dl2GetMemSize
AXFX2ReverbI3dl2Shutdown
AXFX2ReverbI3dl2ParametersPreset
AXFX2ReverbI3dl2ParametersMigrateFromReverb
AXFX2ReverbI3dl2SettingsUpdate
AXFX2ReverbI3dl2SettingsUpdateNoReset
AXFX2ReverbI3dl2Callback
AXGetInitWithParams
AXGetInputSamplesPerSec

Revision History

2014/02/12 mono-mixed removed
2014/01/17 Corrected audio rate.
2013/10/29 Removed 6ch reverb.
2013/08/26 Initial version.


CONFIDENTIAL