Maxmod Programming Reference

Function Reference

Initialization/Main Functions

Name	Description
mmInitDefault	Initialize Maxmod using default settings.
mmInitDefaultMem	Initialize Maxmod using default settings.
mmInit	Initiailize Maxmod.
mmInstall	ARM7 installation function.
mmSelectMode	Select audio mode.
mmLockChannels	Lock audio channels.
mmUnlockChannels	Unlock audio channels.
mmVBlank	VBlank interrupt handler.
mmSetVBlankHandler	Install custom VBlank handler.
mmSetEventHandler	Setup event handler
mmFrame	Work routine
mmSoundBankInFiles	Install default soundbank handler.
mmSoundBankInMemory	Install default soundbank handler
mmSetCustomSoundBankHandler	Install custom soundbank handler.

Module Playback

Name	Description
mmLoad	Load module into memory.
mmUnload	Unload module from memory.
mmStart	Start module playback.
mmPause	Pause module playback.
mmResume	Resume module playback.
mmStop	Stop module playback.
mmPosition	Set module sequence position.
mmActive	Check player active status.
mmJingle	Play jingle.
mmSetModuleVolume	Set music volume.
mmSetJingleVolume	Set master jingle volume.
mmSetModuleTempo	Set master tempo for music.
mmSetModulePitch	Change pitch scale for music.

Sound Effects

Name	Description
mmLoadEffect	Load sound effect into memory.
mmUnloadEffect	Unload sound effect from memory.
mmEffect	Play sound effect with default parameters.
mmEffectEx	Play sound effect with custom parameters.
mmEffectVolume	Change sound effect volume.
mmEffectPanning	Change sound effect panning.
mmEffectRate	Change sound effect rate/pitch.
mmEffectScaleRate	Scale sound effect rate.
mmEffectCancel	Stop sound effect.
mmEffectRelease	Mark effect as low priority.
mmEffectCancelAll	Stop all sound effects.

Audio Streaming

Name	Description
mmStreamOpen	Open audio stream.
mmStreamUpdate	Fill audio stream.
mmStreamClose	Close audio stream.

Reverb

Name	Description
mmReverbEnable	Enable reverb system.
mmReverbDisable	Disable reverb system.
mmReverbConfigure	Configure reverb system.
mmReverbStart	Start reverb output.
mmReverbStop	Stop reverb output.
mmReverbBufferSize	Calculate memory required for reverb buffer.

Definitions/Types

Type Definitions

Name	Description
mm_byte	8-bit value.
mm_hword	16-bit value.
mm_word	32-bit value.
mm_bool	Boolean value.
mm_addr	Memory address.
mm_callback	Callback function.
mm_stream_func	Audio streaming function.
mm_sfxhand	Sound effect handle.

Structures

Name	Description
mm_sound_effect	Sound effect parameters.
mm_gba_system	GBA initialization parameters.
mm_ds_system	DS initialization parameters.
mm_stream	Software stream information.
mm_ds_sample	DS audio sample.

Enumerations

Name	Description
mm_pmode	Module playback mode.
mm_mode_enum	Audio mode selection.
mm_mixmode	Software mixing rate selection.
mm_stream_formats	Audio stream formats.
mm_stream_timer	Audio stream timer selection.
mm_reverbflags	Reverb configuration flags.
mm_reverbch	Reverb channel selection.
mm_reverb_cfg	Reverb configuration.

Song Events

Misc

Tutorials/Other Articles