AXFXMultiChReverbGetMemSize

Syntax

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

s32  AXFXMultiChReverbGetMemSize (AXFX_MULTI_CH_REVERB *reverb);

Parameters

reverb Pointer to an AXFX_MULTI_CH_REVERB structure with configured user parameters.

Return Values

Returns the size of memory required by the reverb effect structure.

Description

The AXFXMultiChReverbGetMemSize function returns the size of memory (in bytes) dynamically allocated by the multi channel reverb effect during initialization. The required memory size depends on the enum values AXFX_REVERB_MODE and AXFX_SAMPLE_RATE initially passed to AXFXMultiChReverbInit. The memory size does not depend on the user configurable parameter values set in the AXFX_MULTI_CH_REVERB structure.

Usage

This call can be made anytime after initializing the effect with AXFXMultiChReverbInit. If the effect has not been initialized, non-user parameters mode and fs must be set prior to calling this function. The following code demonstrates this situation:

AXFX_MULTI_CH_REVERB reverb;

// Choose mode which must match the parameter that will be passed to AXFXMultiChReverbInit.
// Either AXFX_REVERB_MODE_2CH, AXFX_REVERB_MODE_4CH, AXFX_REVERB_MODE_6CH, or AXFX_REVERB_MODE_6CH_MONO_MIXED.
reverb.mode = AXFX_REVERB_MODE_2CH;

// Choose a value which matches the rate parameter passed to AXFXMultiChReverbInit.
// Either 32000 or 48000.
reverb.fs = 32000;

s32 size = AXFXMultiChReverbGetMemSize(&reverb);
NOTE:
The above workaround does not apply to AXFX2 effects.

Return Values

Sound 1 Library
ModeBytes
2ch98096
4ch136504
6ch137148
6ch_MONO_MIXED79536
Sound 2 Library @ 32K
ModeBytes
2ch98096
4ch136504
6ch137148
6ch_MONO_MIXED79536
Sound 2 Library @ 48K
ModeBytes
2ch147120
4ch204728
6ch205692
6ch_MONO_MIXED119280

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_MULTI_CH_REVERB
AXFXMultiChReverbOverview
AXFXMultiChReverbParametersPreset
AXFXMultiChReverbInit
AXFXMultiChReverbShutdown
AXFXMultiChReverbSettingsUpdate
AXFXMultiChReverbSettingsUpdateNoReset
AXFXMultiChReverbCallback
axfxmulticheffects demo
axfxmultichreverbs demo
AXRegisterAuxCallback

Revision History

2014-02-26 Change related link.
2014-02-12 Pre-init usage example.
2013-05-08 Automated cleanup pass.
2013-03-04 New no-reset API.
2012-05-25 Simplified API.
2012-05-10 Added 2/4/6 channel effects.
2012-04-10 Initial version.


CONFIDENTIAL