snesmod.h

Go to the documentation of this file.

 
#ifndef OPENSNES_SNESMOD_H
#define OPENSNES_SNESMOD_H
 
#include <snes/types.h>
 
/* Removed on 2026-10-05 (1.0 plan, lot C): snesmodSetSoundTable, snesmodAllocateSoundRegion.
 * The replacements are in docs/UPGRADING.md; `make check-upgrade` names them. */
 
/*============================================================================
 * Initialization
 *============================================================================*/


void snesmodInit(void);

void snesmodSetSoundbank(u8 bank);

 
/*============================================================================
 * Module Playback
 *============================================================================*/


void snesmodLoadModule(u16 moduleId);

void snesmodPlay(u8 startPosition);

void snesmodStop(void);

void snesmodPause(void);

void snesmodResume(void);

u8 snesmodGetPosition(void);

 
/*============================================================================
 * Sound Effects
 *============================================================================*/


u8 snesmodLoadEffect(u16 sfxIndex);

u8 snesmodPlayEffect(u16 effectId, u8 volume, u8 pan, u16 pitch);

 
/*============================================================================
 * Volume Control
 *============================================================================*/


void snesmodSetModuleVolume(u8 volume);

void snesmodFadeVolume(u8 targetVolume, u8 speed);

 
/*============================================================================
 * Processing
 *============================================================================*/


void snesmodProcess(void);

void snesmodFlush(void);

 
/*============================================================================
 * Streaming Audio
 *============================================================================*/


 
/*============================================================================
 * Pitch Constants
 *============================================================================*/


#define SNESMOD_PITCH_LOW       4       
#define SNESMOD_PITCH_NORMAL    8       
#define SNESMOD_PITCH_HIGH      12      

 
#endif /* OPENSNES_SNESMOD_H */