AXFX2DelayGetMemSize

Syntax

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

typedef enum _AXFX_DELAY_MODE
{
    AXFX_DELAY_MODE_2CH,
    AXFX_DELAY_MODE_4CH,
    AXFX_DELAY_MODE_6CH,
} AXFX_DELAY_MODE;

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2DelayGetMemSize  (AXFX2_DELAY *delay, AXFX_DELAY_MODE mode,
                            AXFX_SAMPLE_RATE sampleRate);

Parameters

delay AXFX2_DELAY struct with user-specified parameters set.
mode AXFX_DELAY_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 delay effect when initialized with the same arguments.

Description

The AXFX2DelayGetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 delay effect during initialization or call to AXFX2DelaySettings. The required memory size depends on the enum values AXFX_DELAY_MODE, AXFX_SAMPLE_RATE, and the user parameter max_delay_time set in the AXFX2_DELAY structure passed to AXFX2DelayInit.

Return Values

Sound 2 Library @ 32K
max_delay_time = 1000.0
ModeBytes
2ch256184
4ch512192
6ch768200
Sound 2 Library @ 48K
max_delay_time = 1000.0
ModeBytes
2ch384184
4ch768192
6ch1152200

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Delay Overview
AXFX2_DELAY
AXFX2DelayInit
AXFX2DelayShutdown
AXFX2DelaySettings
AXFX2DelaySettingsUpdate
AXFX2DelaySettingsUpdateNoReset
AXFX2DelayCallback

Revision History

2013/12/12 New max_delay_time parameter.
2013/08/26 Initial version.


CONFIDENTIAL