SGDK/xgm2_8h_source.html

#ifndef _XGM2_H_

#define _XGM2_H_


void XGM2_loadDriver(bool waitReady);


bool XGM2_isPlaying(void);


void XGM2_load(const u8 *song);

void XGM2_load_FAR(const u8 *song, const u32 len);

void XGM2_playTrack(const u16 track);

void XGM2_play(const u8* song);

void XGM2_play_FAR(const u8* song, const u32 len);


void XGM2_stop(void);

void XGM2_pause(void);

void XGM2_resume(void);


u8 XGM2_isPlayingPCM(const u16 channel_mask);

bool XGM2_playPCM(const u8 *sample, const u32 len, const SoundPCMChannel channel);

bool XGM2_playPCMEx(const u8 *sample, const u32 len, const SoundPCMChannel channel, const u8 priority, const bool halfRate, const bool loop);

void XGM2_stopPCM(const SoundPCMChannel channel);


bool XGM2_isProcessingFade(void);

void XGM2_fadeIn(const u16 numFrame);

void XGM2_fadeOut(const u16 numFrame);

void XGM2_fadeOutAndStop(const u16 numFrame);

void XGM2_fadeOutAndPause(const u16 numFrame);

void XGM2_fadeTo(const u16 fmVolume, const u16 psgVolume, const u16 numFrame);


void XGM2_setLoopNumber(const s8 value);


u32 XGM2_getElapsed(void);


u16 XGM2_getMusicTempo(void);

void XGM2_setMusicTempo(const u16 value);


void XGM2_setFMVolume(const u16 value);

void XGM2_setPSGVolume(const u16 value);


bool XGM2_isPAL(const u8 *xgm2);


u16 XGM2_getCPULoad(const bool mean);

u16 XGM2_getDMAWaitTime(const bool mean);


u16 XGM2_getDebugFrameCounter(void);

u16 XGM2_getDebugPCMRate(void);

u8 XGM2_getDebugMissedFrames(void);

u8 XGM2_getDebugProcessDuration(const u16 ind);


#endif // _XGM2_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

XGM2_setPSGVolume
void XGM2_setPSGVolume(const u16 value)
Set the volume level for the PSG music part.
Definition xgm2.c:836

XGM2_pause
void XGM2_pause(void)
Pause playing music, music can be resumed by calling XGM2_resume().  Note that due to the nature of t...
Definition xgm2.c:453

XGM2_isProcessingFade
bool XGM2_isProcessingFade(void)
Definition xgm2.c:678

XGM2_loadDriver
void XGM2_loadDriver(bool waitReady)
Load the XGM2 sound driver.
Definition xgm2.c:212

XGM2_isPlaying
bool XGM2_isPlaying(void)
Returns play music state.
Definition xgm2.c:256

XGM2_getDebugProcessDuration
u8 XGM2_getDebugProcessDuration(const u16 ind)
Returns the ending process time in number of sample for the specified v-int process (v-int process nu...
Definition xgm2.c:974

XGM2_stopPCM
void XGM2_stopPCM(const SoundPCMChannel channel)
Stop play PCM on specified channel (XGM2 music player driver).  No effect if no sample was currently ...
Definition xgm2.c:643

XGM2_getDebugPCMRate
u16 XGM2_getDebugPCMRate(void)
Returns the real PCM playback rate (XGM2 driver).  Debug function to verify the driver is working opt...
Definition xgm2.c:938

XGM2_load
void XGM2_load(const u8 *song)
Load the specified XGM2 music blob (prepare for play, useful for multi tracks XGM2 music)
Definition xgm2.c:276

XGM2_fadeTo
void XGM2_fadeTo(const u16 fmVolume, const u16 psgVolume, const u16 numFrame)
Process a specific music volume "fade" effect.  Gradually change FM and PSG volume starting from curr...
Definition xgm2.c:703

XGM2_fadeOutAndPause
void XGM2_fadeOutAndPause(const u16 numFrame)
Process music volume "fade-out" effect and pause.  Gradually decrease FM and PSG volume starting from...
Definition xgm2.c:698

XGM2_fadeOut
void XGM2_fadeOut(const u16 numFrame)
Process music volume "fade-out" effect.  Gradually decrease FM and PSG volume starting from current l...
Definition xgm2.c:688

XGM2_resume
void XGM2_resume(void)
Resume playing music after pausing with XGM2_stop().  Note that due to the nature of the music chip (...
Definition xgm2.c:475

XGM2_playPCMEx
bool XGM2_playPCMEx(const u8 *sample, const u32 len, const SoundPCMChannel channel, const u8 priority, const bool halfRate, const bool loop)
Play a PCM sample on specified channel (XGM2 music player driver).  If a sample was currently playing...
Definition xgm2.c:572

XGM2_getCPULoad
u16 XGM2_getCPULoad(const bool mean)
Returns an estimation of the Z80 CPU load (XGM2 driver).
Definition xgm2.c:853

XGM2_getElapsed
u32 XGM2_getElapsed(void)
Return the elapsed play time since the last XGM2_play(..) call.  The returned value is in music frame...
Definition xgm2.c:761

XGM2_play
void XGM2_play(const u8 *song)
Start playing the specified XGM2 music blob (fast play for single track XGM2 music)
Definition xgm2.c:416

XGM2_play_FAR
void XGM2_play_FAR(const u8 *song, const u32 len)
Same as XGM2_play(..) except it supports music accessible through bank switch.
Definition xgm2.c:422

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

XGM2_playPCM
bool XGM2_playPCM(const u8 *sample, const u32 len, const SoundPCMChannel channel)
Play a PCM sample on specified channel (XGM2 music player driver).  The method use a default priority...
Definition xgm2.c:638

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

XGM2_getDebugMissedFrames
u8 XGM2_getDebugMissedFrames(void)
Returns the number of missed frames since last startPlay command.  Debug function to verify the drive...
Definition xgm2.c:956

XGM2_fadeOutAndStop
void XGM2_fadeOutAndStop(const u16 numFrame)
Process music volume "fade-out" effect and stop.  Gradually decrease FM and PSG volume starting from ...
Definition xgm2.c:693

XGM2_getDebugFrameCounter
u16 XGM2_getDebugFrameCounter(void)
Returns the internal frame counter (v-int process number).  Debug function to verify the driver is wo...
Definition xgm2.c:922

XGM2_playTrack
void XGM2_playTrack(const u16 track)
Start playing the specified track (need to call XGM2_load(..) first)
Definition xgm2.c:340

XGM2_isPlayingPCM
u8 XGM2_isPlayingPCM(const u16 channel_mask)
Return play status of specified PCM channel.
Definition xgm2.c:513

XGM2_fadeIn
void XGM2_fadeIn(const u16 numFrame)
Process music volume "fade-in" effect, must be called right after a "start play" or "resume" command....
Definition xgm2.c:683

XGM2_setMusicTempo
void XGM2_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 xgm2.c:754

XGM2_load_FAR
void XGM2_load_FAR(const u8 *song, const u32 len)
Same as XGM2_load(..) except it supports access through bank switch.
Definition xgm2.c:335

XGM2_stop
void XGM2_stop(void)
Stop playing music (cannot be resumed).
Definition xgm2.c:428

XGM2_setFMVolume
void XGM2_setFMVolume(const u16 value)
Set the volume level for the FM music part.
Definition xgm2.c:826

XGM2_getDMAWaitTime
u16 XGM2_getDMAWaitTime(const bool mean)
Returns an estimation of the Z80 CPU time spent in waiting for DMA completion (see Z80_setBusProtecti...
Definition xgm2.c:887

XGM2_isPAL
bool XGM2_isPAL(const u8 *xgm2)
Returns TRUE if specified xgm2 use PAL timing.
Definition xgm2.c:847