Maxmod
Loading...
Searching...
No Matches
Macros | Functions
maxmod9.h File Reference

Global include of Maxmod for DS (ARM9 side). More...

#include <mm_types.h>
#include <maxmod_common.h>

Macros

#define MMCB_DELETESAMPLE   0x1D
 Command ID to free a sample. See mmSetCustomSoundBankHandler().
 
#define MMCB_DELETESONG   0x1C
 Command ID to free a song. See mmSetCustomSoundBankHandler().
 
#define MMCB_SAMPREQUEST   0x1B
 Command ID to load a sample. See mmSetCustomSoundBankHandler().
 
#define MMCB_SONGREQUEST   0x1A
 Command ID to load a song. See mmSetCustomSoundBankHandler().
 

Functions

mm_callback mmGetEventHandler (void)
 Returns the event handler previously installed by the user.
 
mm_word mmGetModuleCount (void)
 Returns the number of modules available in the soundbank.
 
mm_word mmGetSampleCount (void)
 Returns the number of samples available in the soundbank.
 
bool mmInit (mm_ds_system *system)
 Initializes Maxmod with the settings specified.
 
bool mmInitDefault (const char *soundbank_file)
 Initialize Maxmod with default settings.
 
bool mmInitDefaultMem (mm_addr soundbank)
 Initialize Maxmod with default settings.
 
bool mmInitNoSoundbank (void)
 Initializes Maxmod without a soundbank.
 
mm_word mmLoad (mm_word module_ID)
 Loads a module into memory for playback.
 
mm_word mmLoadEffect (mm_word sample_ID)
 Loads a sound effect into memory for playback.
 
void mmLockChannels (mm_word bitmask)
 Lock audio channels to prevent Maxmod from using them.
 
static mm_word mmReverbBufferSize (mm_word bit_depth, mm_word sampling_rate, mm_word delay)
 This calculates the amount of memory needed for the reverb buffer.
 
void mmReverbConfigure (mm_reverb_cfg *config)
 Configures the reverb system.
 
void mmReverbDisable (void)
 Disables the reverb system and restores the channels.
 
void mmReverbEnable (void)
 Enables the reverb system.
 
void mmReverbStart (mm_reverbch channels)
 Starts reverb output in the selected channels.
 
void mmReverbStop (mm_reverbch channels)
 Stops reverb output for the selected channels.
 
void mmSelectMode (mm_mode_enum mode)
 Switches the audio mode for Maxmod DS.
 
void mmSetCustomSoundBankHandler (mm_callback p_loader)
 Install a custom routine to interface with the soundbank data.
 
void mmSetEventHandler (mm_callback handler)
 Install handler to receive song events.
 
mm_bool mmSoundBankInFiles (const char *filename)
 Setup the standard interface for a soundbank that is loaded in the file system.
 
void mmSoundBankInMemory (mm_addr address)
 Enable the standard interface for a soundbank that is loaded into memory.
 
void mmStreamClose (void)
 Close audio stream.
 
mm_word mmStreamGetPosition (void)
 Get number of samples elapsed since the stream was opened.
 
void mmStreamOpen (mm_stream *stream)
 Opens an audio stream.
 
void mmStreamUpdate (void)
 Check buffering state and fill stream with data.
 
void mmStreamVolume (mm_byte volume)
 Changes the volume of the audio stream.
 
mm_word mmUnload (mm_word module_ID)
 Unloads and frees memory space occupied by a module.
 
mm_word mmUnloadEffect (mm_word sample_ID)
 Unloads a sound effect and frees the memory if the reference count becomes zero.
 
void mmUnlockChannels (mm_word bitmask)
 Unlocks audio channels to allow Maxmod to use them.
 

Detailed Description

Global include of Maxmod for DS (ARM9 side).