Maxmod Programming Reference

Function Reference

Initialization/Main Functions

NameDescription
mmInitDefaultInitialize Maxmod using default settings.
mmInitDefaultMemInitialize Maxmod using default settings.
mmInitInitiailize Maxmod.
mmInstallARM7 installation function.
mmSelectModeSelect audio mode.
mmLockChannelsLock audio channels.
mmUnlockChannelsUnlock audio channels.
mmVBlankVBlank interrupt handler.
mmSetVBlankHandlerInstall custom VBlank handler.
mmSetEventHandlerSetup event handler
mmFrameWork routine
mmSoundBankInFilesInstall default soundbank handler.
mmSoundBankInMemoryInstall default soundbank handler
mmSetCustomSoundBankHandlerInstall custom soundbank handler.

Module Playback

NameDescription
mmLoadLoad module into memory.
mmUnloadUnload module from memory.
mmStartStart module playback.
mmPausePause module playback.
mmResumeResume module playback.
mmStopStop module playback.
mmPositionSet module sequence position.
mmActiveCheck player active status.
mmJinglePlay jingle.
mmSetModuleVolumeSet music volume.
mmSetJingleVolumeSet master jingle volume.
mmSetModuleTempoSet master tempo for music.
mmSetModulePitchChange pitch scale for music.

Sound Effects

NameDescription
mmLoadEffectLoad sound effect into memory.
mmUnloadEffectUnload sound effect from memory.
mmEffectPlay sound effect with default parameters.
mmEffectExPlay sound effect with custom parameters.
mmEffectVolumeChange sound effect volume.
mmEffectPanningChange sound effect panning.
mmEffectRateChange sound effect rate/pitch.
mmEffectScaleRateScale sound effect rate.
mmEffectCancelStop sound effect.
mmEffectReleaseMark effect as low priority.
mmEffectCancelAllStop all sound effects.

Audio Streaming

NameDescription
mmStreamOpenOpen audio stream.
mmStreamUpdateFill audio stream.
mmStreamCloseClose audio stream.

Reverb

NameDescription
mmReverbEnableEnable reverb system.
mmReverbDisableDisable reverb system.
mmReverbConfigureConfigure reverb system.
mmReverbStartStart reverb output.
mmReverbStopStop reverb output.
mmReverbBufferSizeCalculate memory required for reverb buffer.

Definitions/Types

Type Definitions

NameDescription
mm_byte8-bit value.
mm_hword16-bit value.
mm_word32-bit value.
mm_boolBoolean value.
mm_addrMemory address.
mm_callbackCallback function.
mm_stream_funcAudio streaming function.
mm_sfxhandSound effect handle.

Structures

NameDescription
mm_sound_effectSound effect parameters.
mm_gba_systemGBA initialization parameters.
mm_ds_systemDS initialization parameters.
mm_streamSoftware stream information.
mm_ds_sampleDS audio sample.

Enumerations

NameDescription
mm_pmodeModule playback mode.
mm_mode_enumAudio mode selection.
mm_mixmodeSoftware mixing rate selection.
mm_stream_formatsAudio stream formats.
mm_stream_timerAudio stream timer selection.
mm_reverbflagsReverb configuration flags.
mm_reverbchReverb channel selection.
mm_reverb_cfgReverb configuration.

Song Events

NameDescription
MMCB_SONGMESSAGESong message.
MMCB_SONGFINISHEDModule has reached end marker.

Misc

Hardware Usage
Memory Usage
CPU Usage

Tutorials/Other Articles

DS Programming Guide
GBA Programming Guide
Using Song Events
Conversion Guide
Audio Streaming
Using Reverb
Getting Help