AXFX API Migration Notes

A new, enhanced Sound-2 library has been introduced with a set of new features and performance improvements. It will replace the legacy sound-1 library after a short-term transition period. Refer to Sound API Function Libraries for more information. This migration note guides you through AXFX API changes. To use Sound-2 AXFX, developers should link to snduser2.rpl instead of snd_user.rpl.

The tables below show the changes to AXFX programming interfaces.

Function Category Sound-1 Disposition Sound-2 Migrate Example
MultiChChorus AXFXMultiChChorusGetMemSize Same AXFXMultiChChorusGetMemSize -
AXFXMultiChChorusInit Same AXFXMultiChChorusInit -
AXFXMultiChChorusShutdown Same AXFXMultiChChorusShutdown -
AXFXMultiChChorusSettings Same AXFXMultiChChorusSettings -
AXFXMultiChChorusCallback Same AXFXMultiChChorusCallback -
AXFXMultiChChorusSettingsUpdate Same AXFXMultiChChorusSettingsUpdate -
AXFXMultiChChorusSettingsUpdateNoReset Same AXFXMultiChChorusSettingsUpdateNoReset -
Chorus AXFXChorusGetMemSize Same AXFXChorusGetMemSize -
AXFXChorusInit Same AXFXChorusInit -
AXFXChorusSettings Same AXFXChorusSettings -
AXFXChorusShutdown Same AXFXChorusShutdown -
- New AXFX2ChorusCallback Alleffects.c
- New AXFX2ChorusInit Alleffects.c
- New AXFX2ChorusSettingsUpdateNoReset none
- New AXFX2ChorusGetMemSize none
- New AXFX2ChorusSettingsUpdate comment
- New AXFX2ChorusShutdown Alleffects.c
ChorusExp AXFXChorusExpCallback Same AXFXChorusExpCallback -
AXFXChorusExpGetMemSize Same AXFXChorusExpGetMemSize -
AXFXChorusExpInit Same AXFXChorusExpInit -
AXFXChorusExpSettings Same AXFXChorusExpSettings -
AXFXChorusExpSettingsUpdate Same AXFXChorusExpSettingsUpdate -
AXFXChorusExpShutdown Same AXFXChorusExpShutdown -
MultiChDelay AXFXMultiChDelayGetMemSize Same AXFXMultiChDelayGetMemSize -
AXFXMultiChDelayInit Same AXFXMultiChDelayInit -
AXFXMultiChDelayShutdown Same AXFXMultiChDelayShutdown -
AXFXMultiChDelaySettingsUpdate Same AXFXMultiChDelaySettingsUpdate -
AXFXMultiChDelayCallback Same AXFXMultiChDelayCallback -
AXFXMultiChDelaySettingsUpdateNoReset Same AXFXMultiChDelaySettingsUpdateNoReset -
Delay AXFXDelayCallback Same AXFXDelayCallback -
AXFXDelayGetMemSize Same AXFXDelayGetMemSize -
AXFXDelayInit Same AXFXDelayInit -
AXFXDelaySettings Same AXFXDelaySettings -
AXFXDelayShutdown Same AXFXDelayShutdown -
- New AXFX2DelayCallback Alleffects.c
- New AXFX2DelayInit Alleffects.c
- New AXFX2DelaySettingsUpdateNoReset none
- New AXFX2DelayGetMemSize none
- New AXFX2DelayShutdown Alleffects.c
- New AXFX2DelaySettingsUpdate comment
DelayExp AXFXDelayExpCallback Same AXFXDelayExpCallback -
AXFXDelayExpSettings Same AXFXDelayExpSettings -
AXFXDelayExpInit Same AXFXDelayExpInit -
AXFXDelayExpCallback Same AXFXDelayExpCallback -
AXFXDelayExpGetMemSize Same AXFXDelayExpGetMemSize -
AXFXDelayExpSettingsUpdate Same AXFXDelayExpSettingsUpdate -
AXFXDelayExpShutdown Same AXFXDelayExpShutdown -
Reverb AXFXMultiChReverbGetMemSize Same AXFXMultiChReverbGetMemSize -
AXFXMultiChReverbInit Same AXFXMultiChReverbInit -
AXFXMultiChReverbParametersPreset Same AXFXMultiChReverbParametersPreset -
AXFXMultiChReverbShutdown Same AXFXMultiChReverbShutdown -
AXFXMultiChReverbSettingsUpdate Same AXFXMultiChReverbSettingsUpdate -
AXFXMultiChReverbCallback Same AXFXMultiChReverbCallback -
AXFXMultiChReverbSettingsUpdateNoReset Same AXFXMultiChReverbSettingsUpdateNoReset -
AXFXReverbSettingsUpdate New AXFXMultiChReverbSettingsUpdate -
AXFXReverbSettingsUpdateNoReset New AXFXMultiChReverbSettingsUpdateNoReset -
- New AXFX2ReverbCallback Alleffects.c
- New AXFX2ReverbGetMemSize none
- New AXFX2ReverbInit Alleffects.c
- New AXFX2ReverbParametersPreset Axfx2effects.c
- New AXFX2ReverbSettingsUpdate Axfx2reverbs.c
- New AXFX2ReverbSettingsUpdateNoReset Axfx2reverbs.c
- New AXFX2ReverbShutdown Alleffects.c
ReverbI3dl2 - New AXFX2ReverbI3dl2Callback Alleffects.c
- New AXFX2ReverbI3dl2GetMemSize none
- New AXFX2ReverbI3dl2Init Alleffects.c
- New AXFX2ReverbI3dl2ParametersMigrateFromReverb none
- New AXFX2ReverbI3dl2ParametersPreset Axfx2effects.c
- New AXFX2ReverbI3dl2SettingsUpdate Axfx2reverbsi3dl2.c
- New AXFX2ReverbI3dl2SettingsUpdateNoReset none
- New AXFX2ReverbI3dl2Shutdown Alleffects.c
ReverbHi AXFXReverbHiCallback Same AXFXReverbHiCallback -
AXFXReverbHiInit Same AXFXReverbHiInit -
AXFXReverbHiGetMemSize Same AXFXReverbHiGetMemSize -
AXFXReverbHiShutdown Same AXFXReverbHiShutdown -
ReverbHiExp AXFXReverbHiExpCallback Same AXFXReverbHiExpCallback -
AXFXReverbHiExpGetMemSize Same AXFXReverbHiExpGetMemSize -
AXFXReverbHiExpInit Same AXFXReverbHiExpInit -
AXFXReverbHiExpSettings Same AXFXReverbHiExpSettings -
AXFXReverbHiExpSettingsUpdate Same AXFXReverbHiExpSettingsUpdate -
AXFXReverbHiExpShutdown Same AXFXReverbHiExpShutdown -
ReverbStd AXFXReverbStdCallback Same AXFXReverbStdCallback -
AXFXReverbStdGetMemSize Same AXFXReverbStdGetMemSize -
AXFXReverbStdSettings Same AXFXReverbStdSettings -
AXFXReverbStdShutdown Same AXFXReverbStdShutdown -
ReverbStdExp AXFXReverbStdExpCallback Same AXFXReverbStdExpCallback -
AXFXReverbStdExpGetMemSize Same AXFXReverbStdExpGetMemSize -
AXFXReverbStdExpInit Same AXFXReverbStdExpInit -
AXFXReverbStdExpSettings Same AXFXReverbStdExpSettings -
AXFXReverbStdExpSettingsUpdate Same AXFXReverbStdExpSettingsUpdate -
AXFXReverbStdExpShutdown Same AXFXReverbStdExpShutdown -
Compressor - New AXFX2CompressorCallback Alleffects.c
- New AXFX2CompressorGetMemSize none
- New AXFX2CompressorInit Alleffects.c
- New AXFX2CompressorSettingsUpdate Comment
- New AXFX2CompressorShutdown Alleffects.c
Flanger - New AXFX2FlangerCallback Alleffects.c
- New AXFX2FlangerGetMemSize none
- New AXFX2FlangerSettingsUpdate comment
- New AXFX2FlangerSettingsUpdateNoReset none
- New AXFX2FlangerInit Alleffects.c
- New AXFX2FlangerShutdown Alleffects.c
Overdrive - New AXFX2OverdriveCallback Alleffects.c
- New AXFX2OverdriveInit Alleffects.c
- New AXFX2OverdriveShutdown Alleffects.c
- New AXFX2OverdriveGetMemSize none
- New AXFX2OverdriveSettingsUpdate Comment
Pitchshift - New AXFX2PitchshiftCallback Alleffects.c
- New AXFX2PitchshiftSettingsUpdate Axfx2effects.c
- New AXFX2PitchshiftGetMemSize none
- New AXFX2PitchshiftSettingsUpdateNoReset Axfx2effects.c
- New AXFX2PitchshiftInit Alleffects.c
- New AXFX2PitchshiftShutdown Alleffects.c
Misc AXFXSetHooks Same AXFXSetHooks -
AXFXGetHooks Same AXFXGetHooks -
DeprecatedAXFX2chChorusCallbackDeprecated--
AXFX2chChorusGetMemSizeDeprecated--
AXFX2chChorusInitDeprecated--
AXFX2chChorusSettingsDeprecated--
AXFX2chChorusSettingsUpdateDeprecated--
AXFX2chChorusShutdownDeprecated--
AXFX2chMultiDelayCallbackDeprecated--
AXFX2chMultiDelayGetMemSizeDeprecated--
AXFX2chMultiDelayInitDeprecated--
AXFX2chMultiDelaySettingsUpdateDeprecated--
AXFX2chMultiDelayShutdownDeprecated--
AXFX2chReverbCallbackDeprecated--
AXFX2chReverbGetMemSizeDeprecated--
AXFX2chReverbInitDeprecated--
AXFX2chReverbParametersPresetDeprecated--
AXFX2chReverbSettingsUpdateDeprecated--
AXFX2chReverbShutdownDeprecated--
AXFX4chChorusCallbackDeprecated--
AXFX4chChorusGetMemSizeDeprecated--
AXFX4chChorusInitDeprecated--
AXFX4chChorusSettingsDeprecated--
AXFX4chChorusSettingsUpdateDeprecated--
AXFX4chChorusShutdownDeprecated--
AXFX4chMultiDelayCallbackDeprecated--
AXFX4chMultiDelayGetMemSizeDeprecated--
AXFX4chMultiDelayInitDeprecated--
AXFX4chMultiDelaySettingsUpdateDeprecated--
AXFX4chMultiDelayShutdownDeprecated--
AXFX4chReverbCallbackDeprecated--
AXFX4chReverbGetMemSizeDeprecated--
AXFX4chReverbInitDeprecated--
AXFX4chReverbParametersPresetDeprecated--
AXFX4chReverbSettingsUpdateDeprecated--
AXFX4chReverbShutdownDeprecated--
AXFX6ch6chReverbCallbackDeprecated--
AXFX6ch6chReverbGetMemSizeDeprecated--
AXFX6ch6chReverbInitDeprecated--
AXFX6ch6chReverbParametersPresetDeprecated--
AXFX6ch6chReverbSettingsUpdateDeprecated--
AXFX6ch6chReverbShutdownDeprecated--
AXFX6chChorusCallbackDeprecated--
AXFX6chChorusGetMemSizeDeprecated--
AXFX6chChorusInitDeprecated--
AXFX6chChorusSettingsDeprecated--
AXFX6chChorusSettingsUpdateDeprecated--
AXFX6chChorusShutdownDeprecated--
AXFX6chMultiDelayCallbackDeprecated--
AXFX6chMultiDelayGetMemSizeDeprecated--
AXFX6chMultiDelayInitDeprecated--
AXFX6chMultiDelaySettingsUpdateDeprecated--
AXFX6chMultiDelayShutdownDeprecated--
AXFX6chReverbCallbackDeprecated--
AXFX6chReverbGetMemSizeDeprecated--
AXFX6chReverbInitDeprecated--
AXFX6chReverbParametersPresetDeprecated--
AXFX6chReverbSettingsUpdateDeprecated--
AXFX6chReverbShutdownDeprecated--
AXFXChorusCallbackDpl2Deprecated--
AXFXChorusExpCallbackDpl2Deprecated--
AXFXChorusExpGetMemSizeDpl2Deprecated--
AXFXChorusExpInitDpl2Deprecated--
AXFXChorusExpSettingsDpl2Deprecated--
AXFXChorusExpSettingsUpdateDpl2Deprecated--
AXFXChorusExpShutdownDpl2Deprecated--
AXFXChorusGetMemSizeDpl2Deprecated--
AXFXChorusInitDpl2Deprecated--
AXFXChorusSettingsDpl2Deprecated--
AXFXChorusShutdownDpl2Deprecated--
AXFXDelayCallbackDpl2Deprecated--
AXFXDelayExpCallbackDpl2Deprecated--
AXFXDelayExpGetMemSizeDpl2Deprecated--
AXFXDelayExpInitDpl2Deprecated--
AXFXDelayExpSettingsDpl2Deprecated--
AXFXDelayExpSettingsUpdateDpl2Deprecated--
AXFXDelayExpShutdownDpl2Deprecated--
AXFXDelayGetMemSizeDpl2Deprecated--
AXFXDelayInitDpl2Deprecated--
AXFXDelaySettingsDpl2Deprecated--
AXFXDelayShutdownDpl2Deprecated--
AXFXReverbHiCallbackDpl2Deprecated--
AXFXReverbHiExpCallbackDpl2Deprecated--
AXFXReverbHiExpGetMemSizeDpl2Deprecated--
AXFXReverbHiExpInitDpl2Deprecated--
AXFXReverbHiExpSettingsDpl2Deprecated--
AXFXReverbHiExpSettingsUpdateDpl2Deprecated--
AXFXReverbHiExpShutdownDpl2Deprecated--
AXFXReverbHiGetMemSizeDpl2Deprecated--
AXFXReverbHiInitDpl2Deprecated--
AXFXReverbHiSettingsDpl2Deprecated--
AXFXReverbHiShutdownDpl2Deprecated--
AXFXReverbStdCallbackDpl2Deprecated--
AXFXReverbStdExpCallbackDpl2Deprecated--
AXFXReverbStdExpGetMemSizeDpl2Deprecated--
AXFXReverbStdExpInitDpl2Deprecated--
AXFXReverbStdExpSettingsDpl2Deprecated--
AXFXReverbStdExpSettingsUpdateDpl2Deprecated--
AXFXReverbStdExpShutdownDpl2Deprecated--
AXFXReverbStdGetMemSizeDpl2Deprecated--
AXFXReverbStdInitDpl2Deprecated--
AXFXReverbStdSettingsDpl2Deprecated--
AXFXReverbStdShutdownDpl2Deprecated--

To maintain backward compatibility, the function interfaces for these deprecated APIs are still available in Sound-2, but they cannot access all the new features in Sound-2.

Column Disposition: (Migration from the version on its left to the version on its right)

Column of libraries (Sound-1 and Sound-2)

Revision History

2013-07-30 Clean up to handle new 2.0 APIs.
2013-05-08 Automated cleanup pass.
2012-08-01 Cleanup Pass.
2012-01-26 Update to Audio API v2.0.
2011-02-21 Initial Version


CONFIDENTIAL