AXFX2OverdriveGetMemSize

Syntax

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

typedef enum _AXFX_OVERDRIVE_MODE
{
    AXFX_OVERDRIVE_MODE_2CH,
    AXFX_OVERDRIVE_MODE_4CH,
    AXFX_OVERDRIVE_MODE_6CH,
} AXFX_OVERDRIVE_MODE;

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2OverdriveGetMemSize  (AXFX_OVERDRIVE_MODE mode, AXFX_SAMPLE_RATE sampleRate);

Parameters

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

Description

The AXFX2OverdriveGetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 overdrive effect during initialization. The required memory size depends on the enum values AXFX_OVERDRIVE_MODE and AXFX_SAMPLE_RATE passed to AXFX2OverdriveInit. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_OVERDRIVE structure.

Return Values

Sound 2 Library @ 32K
ModeBytes
2ch112
4ch112
6ch112
Sound 2 Library @ 48K
ModeBytes
2ch112
4ch112
6ch112

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Overdrive Overview
AXFX2_OVERDRIVE
AXFX2OverdriveInit
AXFX2OverdriveShutdown
AXFX2OverdriveSettingsUpdate
AXFX2OverdriveCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL