maxmod.h File Reference

Global include of Maxmod for GBA. More...

#include <mm_types.h>

Enumerations
enum	mm_mixlen_enum {   MM_MIXLEN_8KHZ = 544 ,   MM_MIXLEN_10KHZ = 704 ,   MM_MIXLEN_13KHZ = 896 ,   MM_MIXLEN_16KHZ = 1056 ,   MM_MIXLEN_18KHZ = 1216 ,   MM_MIXLEN_21KHZ = 1408 ,   MM_MIXLEN_27KHZ = 1792 ,   MM_MIXLEN_31KHZ = 2112 }
	Precalculated mix buffer lengths (in bytes) More...

Functions
mm_bool	mmActive (void)
	Used to determine if a module is playing.
static mm_bool	mmActiveSub (void)
	Check if a jingle is playing or not.
mm_sfxhand	mmEffect (mm_word sample_ID)
	Plays a sound effect with default settings.
mm_bool	mmEffectActive (mm_sfxhand handle)
	Indicates if a sound effect is active or not.
mm_word	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.
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.
bool	mmEnd (void)
	Deinitializes Maxmod.
void	mmFrame (void) __attribute((long_call))
	This is the main routine-function that processes music and updates the sound output.
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	mmGetPosition (void)
	Get current pattern order being played.
mm_word	mmGetPositionRow (void)
	Get current row being played.
mm_word	mmGetPositionTick (void)
	Get current number of elapsed ticks in the row being played.
mm_word	mmGetSampleCount (void)
	Returns the number of samples available in the soundbank.
mm_voidfunc	mmGetVBlankHandler (void)
	Returns the VBlank handler previously installed by the user.
bool	mmInit (mm_gba_system *setup)
	Initializes Maxmod with the settings specified.
bool	mmInitDefault (mm_addr soundbank, mm_word number_of_channels)
	Initialize Maxmod with default settings.
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.
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.
void	mmPlayModule (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.
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	mmSetVBlankHandler (mm_voidfunc function)
	Installs a custom handler to be processed after the sound DMA is reset.
void	mmStart (mm_word module_ID, mm_pmode mode)
	Begins playback of a module.
void	mmStop (void)
	Stops playback of the active module.
void	mmVBlank (void)
	This function must be linked directly to the VBlank IRQ.

Detailed Description

Global include of Maxmod for GBA.

Global include of Maxmod headless.