AXFXChorusExpGetMemSizeDpl2 DEPRECATED

Syntax

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

s32  AXFXChorusExpGetMemSizeDpl2 (AXFX_CHORUS_EXP_DPL2 *chorus);

Parameters

chorus Pointer to AXFX_CHORUS_EXP_DPL2 structure with configured user parameters.

Return Values

Returns the size of memory required by the Dolby Pro Logic II (DPL2) version of the Chorus Expansion.

Description

The AXFXChorusExpGetMemSizeDpl2 function returns the size of memory required by the Chorus Expansion DPL2-version. The required memory size varies according to the settings in the AXFX_CHORUS_EXP_DPL2 structure. The user must configure the AXFX_CHORUS_EXP_DPL2 structure's user parameters prior to calling this function.

The memory of the size returned by this function is allocated when the Chorus Expansion DPL2-version is initialized using the AXFXChorusExpInitDpl2 or AXFXChorusExpSettingsDpl2 functions.

NOTE:
Current specifications have fixed the memory size. It is unaffected by parameter values.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

Deprecated Do not call this function in new code.

See Also

AXFX_CHORUS_EXP_DPL2
AXFXChorusExpInitDpl2
AXFXChorusExpSettingsDpl2

Revision History

2013-05-08 Automated cleanup pass.
2008-06-05 Added notes.
2007-08-10 Initial version.


CONFIDENTIAL