AXFX2FlangerGetMemSize

Syntax

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

typedef enum _AXFX_FLANGER_MODE
{
    AXFX_FLANGER_MODE_2CH,
    AXFX_FLANGER_MODE_4CH,
    AXFX_FLANGER_MODE_6CH,
} AXFX_FLANGER_MODE;

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2FlangerGetMemSize  (AXFX_FLANGER_MODE mode, AXFX_SAMPLE_RATE sampleRate);

Parameters

mode AXFX_FLANGER_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 flanger effect when initialized with the same arguments.

Description

The AXFX2FlangerGetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 flanger effect during initialization. The required memory size depends on the enum values AXFX_FLANGER_MODE and AXFX_SAMPLE_RATE passed to AXFX2FlangerInit. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_FLANGER structure.

Return Values

Sound 2 Library @ 32K
ModeBytes
2ch3928
4ch7648
6ch9508
Sound 2 Library @ 48K
ModeBytes
2ch5784
4ch11360
6ch14148

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Flanger Overview
AXFX2_FLANGER
AXFX2FlangerInit
AXFX2FlangerShutdown
AXFX2FlangerSettingsUpdate
AXFX2FlangerSettingsUpdateNoReset
AXFX2FlangerCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL