Sound-1 AXFX API Functions

Concepts

AX AUX Bus Effects Overview Describes the set of premade effects that are provided by the AX AUX Bus Effects (AXFX) library that may be applied to groups of AX voices.

AXFX Allocator

AXFXGetHooks Obtains pointers to memory allocation- or deallocation-related functions currently registered to the AXFX Library.
AXFXSetHooks Registers to the AXFX Library the memory allocation/deallocation functions in use.
AXFX2GetMemAllocFns Obtains pointers to memory allocation- or deallocation-related functions currently registered to the AXFX Library.
AXFX2SetMemAllocFns Registers to the AXFX Library the memory allocation/deallocation functions in use.

AXFX Chorus

AXFX_CHORUS When using Chorus, you must assign appropriate values to the various parameters of the AXFX_CHORUS or AXFX_CHORUS_DPL2 structure.
AXFXChorusInit Initializes Chorus based on user parameters in the AXFX_CHORUS structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXChorusGetMemSize Returns the size of memory required by Chorus.
AXFXChorusCallback AUX callback for Chorus that applies Chorus processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXChorusSettings Used when changing parameters of an initialized Chorus. When this function is called, the current Chorus is shut down, the memory allocated to it at initialization is freed, and then Chorus is reinitialized based on new user parameters.
AXFXChorusShutdown Shuts down Chorus and frees any memory allocated internally by the AXFXChorusInit and AXFXChorusSettings functions.
AXFX_CHORUS_EXP Assigns present values to the various parameters of the AXFX_CHORUS_EXP or AXFX_CHORUS_EXP_DPL2 structure.
AXFX_CHORUS_EXP_preset Assigns appropriate values in the axfx_presets.h file to the various parameters of the AXFX_CHORUS_EXP or AXFX_CHORUS_EXP_DPL2 structure.
AXFXChorusExpGetMemSize Returns the size of memory required by the Chorus Expansion.
AXFXChorusExpInit Initializes Chorus Expansion based on user parameters in the AXFX_CHORUS_EXP structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXChorusExpCallback AUX callback for Chorus Expansion that applies Chorus Expansion processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXChorusExpSettings Used when changing parameters of the initialized Chorus Expansion. When this function is called, the current Chorus Expansion is shut down, the memory allocated to it at initialization is freed, and then Chorus Expansion is reinitialized based on new user parameters.
AXFXChorusExpSettingsUpdate Changes parameters of the initialized Chorus Expansion. When this function is called, the current Chorus Expansion is shut down, then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.
AXFXChorusExpShutdown Shuts down Chorus Expansion and frees any memory allocated internally by the AXFXChorusExpInit and AXFXChorusExpSettings functions.

AXFX Delay

AXFX_DELAY When using Delay, you must assign appropriate values to the various parameters of the AXFX_DELAY or AXFX_DELAY_DPL2 structure.
AXFXDelayGetMemSize Returns the size of memory required by Delay.
AXFXDelayInit Initializes Delay based on user parameters in the AXFX_DELAY structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXDelayCallback AUX callback for Delay that applies Delay processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXDelaySettings Changes parameters of the initialized Delay. When this function is called, the current Delay is shut down, the memory allocated to it at initialization is freed, and then Delay is reinitialized based on new user parameters.
AXFXDelayShutdown Shuts down Delay and frees any memory allocated internally by the AXFXDelayInit and AXFXDelaySettings functions.
AXFX_DELAY_EXP When using Delay Expansion, you must assign appropriate values to the various parameters of the AXFX_DELAY_EXP or AXFX_DELAY_EXP_DPL2 structure.
AXFXDelayExpGetMemSize Returns the size of memory required by Delay Expansion.
AXFX_DELAY_EXP_preset Assigns appropriate values in the axfx_presets.h file to the various parameters of the AXFX_DELAY_EXP or AXFX_DELAY_EXP_DPL2 structure.
AXFXDelayExpInit Initializes Delay Expansion based on user parameters in the AXFX_DELAY_EXP structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXDelayExpCallback AUX callback for Delay Expansion that applies Delay Expansion processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXDelayExpSettings Changes parameters of the initialized Delay Expansion. When this function is called, the current Delay Expansion is shut down, the memory allocated to it at initialization is freed, and then Delay Expansion is reinitialized based on new user parameters.
AXFXDelayExpSettingsUpdate Changes parameters of the initialized Delay Expansion. When this function is called, the current Delay Expansion is shut down, then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.
AXFXDelayExpShutdown Shuts down Delay Expansion and frees any memory allocated internally by the AXFXDelayExpInit and AXFXDelayExpSettings functions.

AXFX Reverb

AXFX_REVERBSTD When using Standard Reverb, you must assign appropriate values to the various parameters of the AXFX_REVERBSTD or AXFX_REVERBSTD_DPL2 structure.
AXFXReverbStdGetMemSize Returns the size of memory required by Standard Reverb.
AXFXReverbStdInit Initializes Standard Reverb based on user parameters in the AXFX_REVERBSTD structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXReverbStdCallback AUX callback for Reverb Standard that applies Reverb Standard processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXReverbStdSettings Changes parameters of the initialized Reverb Standard. When this function is called, the current Reverb Standard is shut down, the memory allocated to it at initialization is freed, and then Reverb Standard is reinitialized based on new user parameters.
AXFXReverbStdShutdown Shuts down Reverb Standard and frees any memory allocated internally by the AXFXReverbStdInit and AXFXReverbStdSettings functions.
AXFX_REVERBSTD_EXP When using Standard Reverb Expansion, you must assign appropriate values to the various parameters of the AXFX_REVERBSTD_EXP or AXFX_REVERBSTD_EXP_DPL2 structure.
AXFX_REVERBSTD_EXP_preset Assigns appropriate values in the axfx_presets.h file to the various parameters of the AXFX_REVERBSTD_EXP or AXFX_REVERBSTD_EXP_DPL2 structure.
AXFXReverbStdExpGetMemSize Returns the size of memory required by Standard Reverb Expansion.
AXFXReverbStdExpInit Initializes Standard Reverb Expansion based on user parameters in the AXFX_REVERBSTD_EXP structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXReverbStdExpCallback AUX callback for Reverb Standard Expansion that applies Reverb Standard Expansion processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXReverbStdExpSettings Changes parameters of the initialized Reverb Standard Expansion. When this function is called, the current Reverb Standard Expansion is shut down, the memory allocated to it at initialization is freed, and then Reverb Standard Expansion is reinitialized based on new user parameters.
AXFXReverbStdExpSettingsUpdate Changes parameters of the initialized Reverb Standard Expansion. When this function is called, the current Reverb Standard Expansion is shut down, then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.
AXFXReverbStdExpShutdown Shuts down Reverb Standard Expansion and frees any memory allocated internally by the AXFXReverbStdExpInit and AXFXReverbStdExpSettings functions.

AXFX Reverb Hi

AXFX_REVERBHI When using High-Quality Reverb, you must assign appropriate values to the various parameters of the AXFX_REVERBHI or AXFX_REVERBHI_DPL2 structure.
AXFXReverbHiGetMemSize Returns the size of memory required by High-Quality Reverb.
AXFXReverbHiInit Initializes High-Qualaity Reverb based on user parameters in the AXFX_REVERBHI structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXReverbHiCallback AUX callback for High-Quality Reverb that applies High-Quality Reverb processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXReverbHiSettings Changes parameters of the initialized High-Quality Reverb. When this function is called, the current High-Quality Reverb is shut down, the memory allocated to it at initialization is freed, and then High-Quality Reverb is reinitialized based on new user parameters.
AXFXReverbHiShutdown Shuts down High-Quality Reverb and frees any memory allocated internally by the AXFXReverbHiInit and AXFXReverbHiSettings functions.
AXFX_REVERBHI_EXP When using High-Quality Reverb Expansion, you must assign appropriate values to the various parameters of the AXFX_REVERBHI_EXP or AXFX_REVERBHI_EXP_DPL2 structure.
AXFX_REVERBHI_EXP_preset Assigns appropriate values in the axfx_presets.h file to the various parameters of the AXFX_REVERBHI_EXP or AXFX_REVERBHI_EXP_DPL2 structure.
AXFXReverbHiExpGetMemSize Returns the size of memory required by High-Quality Reverb Expansion.
AXFXReverbHiExpInit Initializes High-Qualaity Reverb Expansion based on user parameters in the AXFX_REVERBHI_EXP structure. This function also allocates and initializes the memory used by the delay line and similar processing steps.
AXFXReverbHiExpCallback AUX callback for High-Quality Reverb Expansion that applies High-Quality Reverb Expansion processing to data in the buffer designated by the AXFX_BUFFERUPDATE structure.
AXFXReverbHiExpSettings Changes parameters of the initialized High-Quality Reverb Expansion. When this function is called, the current High-Quality Reverb Expansion is shut down, the memory allocated to it at initialization is freed, and then High-Quality Reverb Expansion is reinitialized based on new user parameters.
AXFXReverbHiExpSettingsUpdate Changes parameters of the initialized High-Quality Reverb Expansion. When this function is called, the current High-Quality Reverb Expansion is shut down, then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.
AXFXReverbHiExpShutdown Shuts down High-Quality Reverb Expansion and frees any memory allocated internally by the AXFXReverbHiExpInit and AXFXReverbHiExpSettings functions.

Multi-Channel Chorus

AXFX_MULTI_CH_CHORUS There are two main classes of chorus effects which use the original algorithm or optimized algorithm. For each of the two classes, there are three types of chorus effects which process 2, 4, or 6 individual channels. When using this chorus effect, you must assign appropriate values to the various parameters of the AXFX_MULTI_CH_CHORUS structure before initializing with AXFXMultiChChorusInit.
AXFXMultiChChorusGetMemSize Returns the size of memory (in bytes) dynamically allocated by the multi-channel chorus effect during initialization.
AXFXMultiChChorusInit Initializes the chorus effect for the specified number of channels and user parameters in the AXFX_MULTI_CH_CHORUS structure. This function also allocates and initializes the memory used by the delay lines and related processing steps.
AXFXMultiChChorusCallback An AUX callback for the chorus effect that applies chorus processing to all channels in the buffer designated by the AXFX_6CH_BUFFERUPDATE structure.
AXFXMultiChChorusSettings Changes parameters of the initialized chorus. When this function is called, the current chorus effect is shut down and the memory allocated to it at initialization is freed, and then the chorus is reinitialized based on new user parameters.
AXFXMultiChChorusSettingsUpdate Changes parameters of the initialized chorus. When this function is called, the current multi-channel chorus is shut down, then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.
AXFXMultiChChorusSettingsUpdateNoReset Changes parameters of the initialized chorus. When this function is called, the internal settings of the effect are immediately updated based on the current user parameters. The internal delay lines are not cleared. Memory is not freed and reallocated during this process.
AXFXMultiChChorusShutdown Shuts down the multi-channel chorus effect and frees any memory allocated internally by the AXFXMultiChChorusInit function.

Multi-Channel Delay

AXFX_MULTI_CH_DELAY Appropriate values must be assigned to the parameters of the AXFX_MULTI_CH_DELAY structure before calling AXFXMultiChDelayInit. The parameters affect each channel equally.
AXFXMultiChDelayGetMemSize returns the size of memory (in bytes) dynamically allocated by the multi-channel delay effect during initialization.
AXFXMultiChDelayInit Initializes the delay structure for the specified number of channels and user parameters in the AXFX_MULTI_CH_DELAY structure. This function also allocates and initializes the memory used by the delay line and related processing steps.
AXFXMultiChDelayCallback AUX callback for the multi-channel channel delay that applies a delay effect to the channels in the buffer designated by the AXFX_6CH_BUFFERUPDATE structure.
AXFXMultiChDelaySettingsUpdate Used after changing or setting parameters for the initialized multi-channel delay structure. When this function is called, the internal delay parameters are reinitialized based on the current user parameters. Memory is not freed nor reallocated during this process.
AXFXMultiChDelaySettingsUpdateNoReset Used after changing parameters of the initialized multi-channel delay structure. When this function is called, the internal delay settings of the effect are immediately updated based on the current user parameters. The internal delay lines are not cleared. Memory is not freed nor reallocated during this process.
AXFXMultiChDelayShutdown Shuts down the multi-channel delay effect and frees any memory allocated internally by the AXFXMultiChDelayInit function.

Multi-Channel Reverb

AXFX_MULTI_CH_REVERB Appropriate values must be assigned to the parameters of the AXFX_MULTI_CH_REVERB structure or one of five presets assigned using the AXFXReverbParametersPreset function before the call to AXFXMultiChReverbInit.
AXFXMultiChReverbParametersPreset Used to assign predefined reverb settings to an AXFX_MULTI_CH_REVERB structure.
AXFXMultiChReverbGetMemSize Returns the size of memory (in bytes) dynamically allocated by the multi-channel reverb effect during initialization.
AXFXMultiChReverbInit Initializes the reverb effect channels for the specified number of channels and user parameters in the AXFX_MULTI_CH_REVERB structure. This function also allocates and initializes the memory used by the delay line and related processing steps.
AXFXMultiChReverbCallback AUX callback for the reverb effect that applies a reverb effect to the channels in the buffer designated by the AXFX_MULTI_BUFFERUPDATE structure.
AXFXMultiChReverbSettingsUpdate Used after changing or setting parameters for the initialized reverb structure. When this function is called, the internal reverb parameters are reinitialized based on the current user parameters. Memory is not freed nor reallocated during this process.
AXFXMultiChReverbSettingsUpdateNoReset Used when changing parameters of the initialized reverb structure. When this function is called, the internal delay settings of the effect are immediately updated based on the current user parameters. The internal delay lines are not cleared. Memory is not freed nor reallocated during this process.
AXFXMultiChReverbShutdown Shuts down the reverb effect and frees any memory allocated internally by the AXFXMultiChReverbInit function.

Revision History

2013/08/26 Add AXFX2 APIs.
2013/06/01 Initial version.


CONFIDENTIAL