maxmod9.h File Reference

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

#include <mm_types.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_bool	mmActive (void)
	Used to determine if a module is playing.
mm_sfxhand	mmEffect (mm_word sample_ID)
	Plays a sound effect with default settings.
void	mmEffectCancel (mm_sfxhand handle)
	Stops a sound effect. The handle will be invalidated.
void	mmEffectCancelAll (void)
	Stop all sound effects and reset the effect system.
mm_sfxhand	mmEffectEx (mm_sound_effect *sound)
	Plays a sound effect with custom settings.
mm_sfxhand	mmEffectExt (mm_sound_effect *sound, mm_ds_sample *sample)
	Play external sound.
void	mmEffectPanning (mm_sfxhand handle, mm_byte panning)
	Changes the panning of a sound effect.
void	mmEffectRate (mm_sfxhand handle, mm_word rate)
	Changes the playback rate for a sound effect.
void	mmEffectRelease (mm_sfxhand handle)
	Marks a sound effect as unimportant.
void	mmEffectScaleRate (mm_sfxhand handle, mm_word factor)
	Scales the rate of the sound effect by a certain factor.
void	mmEffectVolume (mm_sfxhand handle, mm_word volume)
	Changes the volume of a sound effect.
mm_word	mmGetModuleCount (void)
	Returns the number of modules available in the soundbank.
mm_word	mmGetPosition (void)
	Get current pattern order being played.
mm_word	mmGetPositionRow (void)
	Get current row being played.
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.
static void	mmJingle (mm_word module_ID)
	Plays a jingle.
mm_bool	mmJingleActive (void)
	Check if a jingle is playing or not.
void	mmJinglePause (void)
	Pauses playback of the active jingle.
void	mmJingleResume (void)
	Resume jingle playback.
void	mmJingleStart (mm_word module_ID, mm_pmode mode)
	Plays a jingle.
void	mmJingleStop (void)
	Stops playback of the active jingle.
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.
void	mmPause (void)
	Pauses playback of the active module.
void	mmPlayMAS (uintptr_t address, mm_word mode, mm_word layer)
	Play individual MAS file from RAM.
static void	mmPosition (mm_word position)
	Set playback position.
void	mmResume (void)
	Resume module playback.
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	mmSetEffectsVolume (mm_word volume)
	Set master volume scale for effect playback.
void	mmSetEventHandler (mm_callback handler)
	Install handler to receive song events.
void	mmSetJingleVolume (mm_word volume)
	Use this function to change the master volume scale for jingle playback.
void	mmSetModulePitch (mm_word pitch)
	Change the master pitch scale for module playback.
void	mmSetModuleTempo (mm_word tempo)
	Change the master tempo for module playback.
void	mmSetModuleVolume (mm_word volume)
	Use this function to change the master volume scale for module playback.
static void	mmSetPosition (mm_word position)
	Set the current sequence [aka order-list] position for the active module.
void	mmSetPositionEx (mm_word position, mm_word row)
	Set the current playback position.
void	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	mmStart (mm_word module_ID, mm_pmode mode)
	Begins playback of a module.
void	mmStop (void)
	Stops playback of the active module.
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.
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).