SGDK/xgm_8h_source.html

#ifndef _XGM_H_

#define _XGM_H_


#define SND_isPlaying_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_isPlaying() instead.\"")

#define SND_startPlay_XGM(song)     _Pragma("GCC error \"This method is deprecated, use XGM_startPlay(..) instead.\"")

#define SND_stopPlay_XGM()          _Pragma("GCC error \"This method is deprecated, use XGM_stopPlay() instead.\"")

#define SND_pausePlay_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_pausePlay() instead.\"")

#define SND_resumePlay_XGM()        _Pragma("GCC error \"This method is deprecated, use XGM_resumePlay() instead.\"")


#define SND_isPlayingPCM_XGM(channel_mask)  _Pragma("GCC error \"This method is deprecated, use XGM_isPlayingPCM(..) instead.\"")

#define SND_setPCM_XGM(id, sample, len)     _Pragma("GCC error \"This method is deprecated, use XGM_setPCM(..) instead.\"")

#define SND_setPCMFast_XGM(id, sample, len) _Pragma("GCC error \"This method is deprecated, use XGM_setPCMFast(..) instead.\"")

#define SND_startPlayPCM_XGM(id, prio, ch)  _Pragma("GCC error \"This method is deprecated, use XGM_startPlayPCM(..) instead.\"")

#define SND_stopPlayPCM_XGM(channel)        _Pragma("GCC error \"This method is deprecated, use XGM_stopPlayPCM(..) instead.\"")


#define SND_getMusicTempo_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_getMusicTempo() instead.\"")

#define SND_setMusicTempo_XGM(value)    _Pragma("GCC error \"This method is deprecated, use XGM_setMusicTempo(..) instead.\"")


#define SND_getManualSync_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_getManualSync() instead.\"")

#define SND_setManualSync_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_setManualSync() instead.\"")

#define SND_nextFrame_XGM()             _Pragma("GCC error \"This method is deprecated, use XGM_nextFrame() instead.\"")

#define SND_nextXFrame_XGM(num)         _Pragma("GCC error \"This method is deprecated, use XGM_nextXFrame(..) instead.\"")


#define SND_setLoopNumber_XGM(value)    _Pragma("GCC error \"This method is deprecated, use XGM_setLoopNumber(..) instead.\"")


#define SND_set68KBUSProtection_XGM(value)  _Pragma("GCC error \"This method is deprecated, use XGM_set68KBUSProtection(..) instead.\"")

#define SND_getForceDelayDMA_XGM()          _Pragma("GCC error \"This method is deprecated, use XGM_getForceDelayDMA() instead.\"")

#define SND_setForceDelayDMA_XGM(value)     _Pragma("GCC error \"This method is deprecated, use XGM_setForceDelayDMA(..) instead.\"")

#define SND_getCPULoad_XGM()                _Pragma("GCC error \"This method is deprecated, use XGM_getCPULoad() instead.\"")


void XGM_loadDriver(const bool waitReady);

void XGM_unloadDriver(void);


bool XGM_isPlaying(void);

void XGM_startPlay(const u8 *song);

void XGM_startPlay_FAR(const u8 *song, u32 size);


void XGM_stopPlay(void);

void XGM_pausePlay(void);

void XGM_resumePlay(void);


u8 XGM_isPlayingPCM(const u16 channel_mask);

void XGM_setPCM(const u8 id, const u8 *sample, const u32 len);

void XGM_setPCMFast(const u8 id, const u8 *sample, const u32 len);

void XGM_setPCM_FAR(const u8 id, const u8 *sample, const u32 len);

void XGM_setPCMFast_FAR(const u8 id, const u8 *sample, const u32 len);

void XGM_startPlayPCM(const u8 id, const u8 priority, const SoundPCMChannel channel);

void XGM_stopPlayPCM(const SoundPCMChannel channel);


u32 XGM_getElapsed(void);

u16 XGM_getMusicTempo(void);

void XGM_setMusicTempo(const u16 value);


u16 XGM_getManualSync(void);

void XGM_setManualSync(const bool value);

#define XGM_nextFrame()  XGM_nextXFrame(1)

void XGM_nextXFrame(const u16 num);


void XGM_setLoopNumber(const s8 value);


void XGM_set68KBUSProtection(const bool value);

bool XGM_getForceDelayDMA(void);

void XGM_setForceDelayDMA(const bool value);


u32 XGM_getCPULoad(void);


#endif // _XGM_H_

SoundPCMChannel
SoundPCMChannel
Sound PCM channel enum.
Definition sound.h:18

u32
unsigned long u32
Definition types.h:105

s8
char s8
Definition types.h:79

u16
unsigned short u16
Definition types.h:100

u8
unsigned char u8
Definition types.h:95

XGM_setPCMFast
void XGM_setPCMFast(const u8 id, const u8 *sample, const u32 len)
Same as XGM_setPCM but fast version.  This method assume that XGM driver is loaded and that 68000 has...
Definition xgm.c:327

XGM_set68KBUSProtection
void XGM_set68KBUSProtection(const bool value)
Same as Z80_setBusProtection(..) (generic version of the method)
Definition xgm.c:447

XGM_stopPlay
void XGM_stopPlay(void)
Stop playing music (XGM music player driver).
Definition xgm.c:199

XGM_setPCMFast_FAR
void XGM_setPCMFast_FAR(const u8 id, const u8 *sample, const u32 len)
Same as XGM_setPCMFast(..) allowing PCM access through bank switch.
Definition xgm.c:355

XGM_isPlayingPCM
u8 XGM_isPlayingPCM(const u16 channel_mask)
Return play status of specified PCM channel (XGM music player driver).
Definition xgm.c:287

XGM_unloadDriver
void XGM_unloadDriver(void)
Unload the XGM sound driver.
Definition xgm.c:94

XGM_stopPlayPCM
void XGM_stopPlayPCM(const SoundPCMChannel channel)
Stop play PCM on specified channel (XGM music player driver).  No effect if no sample was currently p...
Definition xgm.c:397

XGM_resumePlay
void XGM_resumePlay(void)
Resume playing music after pausing with XGM_pausePlay (XGM music player driver).  Note that due to th...
Definition xgm.c:260

XGM_loadDriver
void XGM_loadDriver(const bool waitReady)
Load the XGM sound driver.
Definition xgm.c:54

XGM_startPlay_FAR
void XGM_startPlay_FAR(const u8 *song, u32 size)
Same as XGM_startPlay(..) except it supports music accessible through bank switch.
Definition xgm.c:194

XGM_setManualSync
void XGM_setManualSync(const bool value)
Set manual sync mode of XGM driver (by default auto sync is used).
Definition xgm.c:458

XGM_getCPULoad
u32 XGM_getCPULoad(void)
Returns an estimation of the Z80 CPU load (XGM driver).  The low 16 bits returns the estimated Z80 CP...
Definition xgm.c:535

XGM_isPlaying
bool XGM_isPlaying(void)
Returns play music state (XGM music player driver).
Definition xgm.c:103

XGM_getElapsed
u32 XGM_getElapsed(void)
Return the elapsed play time since the last XGM_startPlay(..) call.  The returned value is in music f...
Definition xgm.c:500

XGM_startPlay
void XGM_startPlay(const u8 *song)
Start playing the specified XGM track (XGM music player driver).
Definition xgm.c:127

XGM_startPlayPCM
void XGM_startPlayPCM(const u8 id, const u8 priority, const SoundPCMChannel channel)
Play a PCM sample on specified channel (XGM music player driver).  If a sample was currently playing ...
Definition xgm.c:369

XGM_setForceDelayDMA
void XGM_setForceDelayDMA(const bool value)
Same as Z80_setForceDelayDMA(..) (generic version of the method)
Definition xgm.c:483

XGM_pausePlay
void XGM_pausePlay(void)
Pause playing music, music can be resumed by calling XGM_resumePlay (XGM music player driver)....
Definition xgm.c:236

XGM_setMusicTempo
void XGM_setMusicTempo(const u16 value)
Set the music tempo (in tick per second).  Default value is 60 or 50 depending the system is NTSC or ...
Definition xgm.c:493

XGM_setPCM
void XGM_setPCM(const u8 id, const u8 *sample, const u32 len)
Declare a new PCM sample (maximum = 255) for the XGM music player driver.  Sample id < 64 are reserve...
Definition xgm.c:311

XGM_nextXFrame
void XGM_nextXFrame(const u16 num)
Same as XGM_nextFrame() except you can specify the numer of frame.
Definition xgm.c:644

XGM_setPCM_FAR
void XGM_setPCM_FAR(const u8 id, const u8 *sample, const u32 len)
Same as XGM_setPCM(..) allowing PCM access through bank switch.
Definition xgm.c:339

XGM_getForceDelayDMA
bool XGM_getForceDelayDMA(void)
Same as Z80_getForceDelayDMA() (generic version of the method)
Definition xgm.c:478

XGM_getManualSync
u16 XGM_getManualSync(void)
Returns manual sync mode state of XGM driver (by default auto sync is used).
Definition xgm.c:453

XGM_setLoopNumber
void XGM_setLoopNumber(const s8 value)
Set the loop number for music with loop command.  Default value is -1 for pseudo unfinite (255) loops...
Definition xgm.c:425

XGM_getMusicTempo
u16 XGM_getMusicTempo(void)
Get the current music tempo (in tick per second).  Default value is 60 or 50 depending the system is ...
Definition xgm.c:488