AXFX2PitchshiftGetMemSize

Syntax

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

typedef enum _AXFX_PITCHSHIFT_MODE
{
    AXFX_PITCHSHIFT_MODE_2CH,
    AXFX_PITCHSHIFT_MODE_4CH,
    AXFX_PITCHSHIFT_MODE_6CH,
} AXFX_PITCHSHIFT_MODE;

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2PitchshiftGetMemSize  (AXFX_PITCHSHIFT_MODE mode, AXFX_SAMPLE_RATE sampleRate);

Parameters

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

Description

The AXFX2PitchshiftGetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 pitchshift effect during initialization. The required memory size depends on the enum values AXFX_PITCHSHIFT_MODE and AXFX_SAMPLE_RATE passed to AXFX2PitchshiftInit. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_PITCHSHIFT structure.

Return Values

Sound 2 Library @ 32K
ModeBytes
2ch13048
4ch25856
6ch38664
Sound 2 Library @ 48K
ModeBytes
2ch19448
4ch38656
6ch57864

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Pitchshift Overview
AXFX2_PITCHSHIFT
AXFX2PitchshiftInit
AXFX2PitchshiftShutdown
AXFX2PitchshiftSettingsUpdate
AXFX2PitchshiftSettingsUpdateNoReset
AXFX2PitchshiftCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL