AXFX2CompressorGetMemSize

Syntax

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

typedef enum _AXFX_COMPRESSOR_MODE
{
    AXFX_COMPRESSOR_MODE_2CH,
    AXFX_COMPRESSOR_MODE_4CH,
    AXFX_COMPRESSOR_MODE_6CH,
} AXFX_COMPRESSOR_MODE;

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


s32  AXFX2CompressorGetMemSize  (AXFX_COMPRESSOR_MODE mode, AXFX_SAMPLE_RATE sampleRate);

Parameters

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

Description

The AXFX2CompressorGetMemSize function returns the size of memory (in bytes) dynamically allocated by the sound 2 compressor effect during initialization. The required memory size depends on the enum values AXFX_COMPRESSOR_MODE and AXFX_SAMPLE_RATE passed to AXFX2CompressorInit. The memory size does not depend on the user configurable parameter values assigned to the AXFX2_COMPRESSOR structure.

Return Values

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

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Compressor Overview
AXFX2_COMPRESSOR
AXFX2CompressorInit
AXFX2CompressorShutdown
AXFX2CompressorSettingsUpdate
AXFX2CompressorCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL