opensnes/snesmod_8h.html

#include <snes.h>

#include <snes/snesmod.h>

#include "soundbank.h"  // Generated by smconv


extern u8 soundbank[];


int main(void) {

    // Initialize video...


    snesmodInit();

    snesmodSetSoundbank(soundbank);

    snesmodLoadModule(MOD_MUSIC);  // From soundbank.h

    snesmodPlay(0);


    while (1) {

        WaitForVBlank();

        snesmodProcess();  // MUST call every frame!


        if (padPressed(0) & KEY_A) {

            snesmodPlayEffect(SFX_JUMP, 127, 128, 0x1000);

        }

    }

}

main
int main(void)
Entry point — initialize audio, display controls, run transport loop.
Definition main.c:37

WaitForVBlank
void WaitForVBlank(void)
Wait for next VBlank period.

KEY_A
#define KEY_A
Definition input.h:81

snesmodSetSoundbank
void snesmodSetSoundbank(u8 bank)
Set the soundbank bank number.

snesmodInit
void snesmodInit(void)
Initialize SNESMOD audio engine.

snesmodPlay
void snesmodPlay(u8 startPosition)
Start module playback.

snesmodLoadModule
void snesmodLoadModule(u16 moduleId)
Load a module from the soundbank.

snesmodProcess
void snesmodProcess(void)
Process audio commands.

snesmodPlayEffect
u8 snesmodPlayEffect(u16 effectId, u8 volume, u8 pan, u16 pitch)
Play a sound effect.

u8
unsigned char u8
8-bit unsigned integer (0 to 255)
Definition types.h:46

padPressed
u16 padPressed(u8 pad)
Get buttons pressed this frame.

snes.h
OpenSNES Master Header.

snesmod.h
SNESMOD - Tracker-based Audio Engine.
Macros
#define	SNESMOD_PITCH_HIGH 12

#define	SNESMOD_PITCH_LOW 4
	Standard pitch values (sample rate multiplier, 0-15 range)

#define	SNESMOD_PITCH_NORMAL 8
Functions
void	snesmodAllocateSoundRegion (u8 size)
	Allocate SPC RAM for streaming buffer.

void	snesmodFadeVolume (u8 targetVolume, u8 speed)
	Fade module volume.

void	snesmodFlush (void)
	Wait for command queue to empty.

u8	snesmodGetPosition (void)
	Get current module position.

void	snesmodInit (void)
	Initialize SNESMOD audio engine.

u8	snesmodLoadEffect (u16 sfxIndex)
	Load a sound effect from the soundbank.

void	snesmodLoadModule (u16 moduleId)
	Load a module from the soundbank.

void	snesmodPause (void)
	Pause module playback.

void	snesmodPlay (u8 startPosition)
	Start module playback.

u8	snesmodPlayEffect (u16 effectId, u8 volume, u8 pan, u16 pitch)
	Play a sound effect.

void	snesmodProcess (void)
	Process audio commands.

void	snesmodResume (void)
	Resume module playback.

void	snesmodSetModuleVolume (u8 volume)
	Set module volume.

void	snesmodSetSoundbank (u8 bank)
	Set the soundbank bank number.

void	snesmodSetSoundTable (const u8 *table)
	Set the streaming sound table.

void	snesmodStop (void)
	Stop module playback.