AXFX2ChorusGetMemSize

Syntax

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

typedef enum _AXFX_CHORUS_MODE
{
    AXFX_CHORUS_MODE_2CH,
    AXFX_CHORUS_MODE_4CH,
    AXFX_CHORUS_MODE_6CH,
} AXFX_CHORUS_MODE;

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2ChorusGetMemSize  (AXFX_CHORUS_MODE mode, AXFX_SAMPLE_RATE sampleRate);

Parameters

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

Description

The AXFX2ChorusGetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 chorus effect during initialization. The required memory size depends on the enum values AXFX_CHORUS_MODE and AXFX_SAMPLE_RATE passed to AXFX2ChorusInit. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_CHORUS structure.

Return Values

Sound 2 Library @ 32K
ModeBytes
2ch25180
4ch50148
6ch62632
Sound 2 Library @ 48K
ModeBytes
2ch37660
4ch75108
6ch93832

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Chorus Overview
AXFX2_CHORUS
AXFX2ChorusInit
AXFX2ChorusShutdown
AXFX2ChorusSettingsUpdate
AXFX2ChorusSettingsUpdateNoReset
AXFX2ChorusCallback

Revision History

2013-08-26 Initial version.


CONFIDENTIAL