AXFX2ReverbGetMemSize

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  AXFX2ReverbGetMemSize  (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 AXFX2ReverbGetMemSize 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 AXFX2ReverbInit. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_REVERB structure.

Return Values

Sound 2 Library @ 32K
ModeBytes
2ch79336
4ch79336
6ch79980
Sound 2 Library @ 48K
ModeBytes
2ch118760
4ch118760
6ch119724

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Reverb Overview
AXFX2_REVERB
AXFX2ReverbInit
AXFX2ReverbShutdown
AXFX2ReverbParametersPreset
AXFX2ReverbSettingsUpdate
AXFX2ReverbSettingsUpdateNoReset
AXFX2ReverbCallback

Revision History

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


CONFIDENTIAL