AXFX2ReverbI3dl2GetMemSize

Syntax

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

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

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2ReverbI3dl2GetMemSize  (AXFX_REVERB_MODE mode, AXFX_SAMPLE_RATE sampleRate);

Parameters

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

Returns the size of memory required by the reverb effect when initialized with the same arguments.

Description

The AXFX2ReverbI3dl2GetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 reverb effect during initialization. The required memory size depends on the enum values AXFX_REVERB_MODE and AXFX_SAMPLE_RATE passed to AXFX2ReverbI3dl2Init. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_REVERB_I3DL2 structure.

Return Values

Sound 2 Library @ 32K
ModeBytes
2ch134036
4ch134036
6ch134680
Sound 2 Library @ 48K
ModeBytes
2ch200720
4ch200720
6ch201684

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
AXFX2ReverbI3dl2Init
AXFX2ReverbI3dl2Shutdown
AXFX2ReverbI3dl2ParametersPreset
AXFX2ReverbI3dl2ParametersMigrateFromReverb
AXFX2ReverbI3dl2SettingsUpdate
AXFX2ReverbI3dl2SettingsUpdateNoReset
AXFX2ReverbI3dl2Callback

Revision History

2013/10/29 Removed 6ch reverb.
2013/08/26 Initial version.


CONFIDENTIAL