docs/sgdk/xgm_8h_source.html

00001
00013 #ifndef _XGM_H_
00014 #define _XGM_H_
00015
00016
00020 #define SND_isPlaying_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_isPlaying() instead.\"")
00021
00024 #define SND_startPlay_XGM(song)     _Pragma("GCC error \"This method is deprecated, use XGM_startPlay(..) instead.\"")
00025
00028 #define SND_stopPlay_XGM()          _Pragma("GCC error \"This method is deprecated, use XGM_stopPlay() instead.\"")
00029
00032 #define SND_pausePlay_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_pausePlay() instead.\"")
00033
00036 #define SND_resumePlay_XGM()        _Pragma("GCC error \"This method is deprecated, use XGM_resumePlay() instead.\"")
00037
00041 #define SND_isPlayingPCM_XGM(channel_mask)  _Pragma("GCC error \"This method is deprecated, use XGM_isPlayingPCM(..) instead.\"")
00042
00045 #define SND_setPCM_XGM(id, sample, len)     _Pragma("GCC error \"This method is deprecated, use XGM_setPCM(..) instead.\"")
00046
00049 #define SND_setPCMFast_XGM(id, sample, len) _Pragma("GCC error \"This method is deprecated, use XGM_setPCMFast(..) instead.\"")
00050
00053 #define SND_startPlayPCM_XGM(id, prio, ch)  _Pragma("GCC error \"This method is deprecated, use XGM_startPlayPCM(..) instead.\"")
00054
00057 #define SND_stopPlayPCM_XGM(channel)        _Pragma("GCC error \"This method is deprecated, use XGM_stopPlayPCM(..) instead.\"")
00058
00062 #define SND_getMusicTempo_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_getMusicTempo() instead.\"")
00063
00066 #define SND_setMusicTempo_XGM(value)    _Pragma("GCC error \"This method is deprecated, use XGM_setMusicTempo(..) instead.\"")
00067
00071 #define SND_getManualSync_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_getManualSync() instead.\"")
00072
00075 #define SND_setManualSync_XGM()         _Pragma("GCC error \"This method is deprecated, use XGM_setManualSync() instead.\"")
00076
00079 #define SND_nextFrame_XGM()             _Pragma("GCC error \"This method is deprecated, use XGM_nextFrame() instead.\"")
00080
00083 #define SND_nextXFrame_XGM(num)         _Pragma("GCC error \"This method is deprecated, use XGM_nextXFrame(..) instead.\"")
00084
00088 #define SND_setLoopNumber_XGM(value)    _Pragma("GCC error \"This method is deprecated, use XGM_setLoopNumber(..) instead.\"")
00089
00093 #define SND_set68KBUSProtection_XGM(value)  _Pragma("GCC error \"This method is deprecated, use XGM_set68KBUSProtection(..) instead.\"")
00094
00097 #define SND_getForceDelayDMA_XGM()          _Pragma("GCC error \"This method is deprecated, use XGM_getForceDelayDMA() instead.\"")
00098
00101 #define SND_setForceDelayDMA_XGM(value)     _Pragma("GCC error \"This method is deprecated, use XGM_setForceDelayDMA(..) instead.\"")
00102
00105 #define SND_getCPULoad_XGM()                _Pragma("GCC error \"This method is deprecated, use XGM_getCPULoad() instead.\"")
00106
00107
00114 void XGM_loadDriver(const bool waitReady);
00121 void XGM_unloadDriver(void);
00122
00127 bool XGM_isPlaying(void);
00140 void XGM_startPlay(const u8 *song);
00155 void XGM_startPlay_FAR(const u8 *song, u32 size);
00156
00163 void XGM_stopPlay(void);
00173 void XGM_pausePlay(void);
00183 void XGM_resumePlay(void);
00184
00204 u8 XGM_isPlayingPCM(const u16 channel_mask);
00223 void XGM_setPCM(const u8 id, const u8 *sample, const u32 len);
00241 void XGM_setPCMFast(const u8 id, const u8 *sample, const u32 len);
00246 void XGM_setPCM_FAR(const u8 id, const u8 *sample, const u32 len);
00251 void XGM_setPCMFast_FAR(const u8 id, const u8 *sample, const u32 len);
00270 void XGM_startPlayPCM(const u8 id, const u8 priority, const SoundPCMChannel channel);
00283 void XGM_stopPlayPCM(const SoundPCMChannel channel);
00284
00293 u32 XGM_getElapsed(void);
00306 u16 XGM_getMusicTempo(void);
00319 void XGM_setMusicTempo(const u16 value);
00320
00327 u16 XGM_getManualSync(void);
00336 void XGM_setManualSync(const bool value);
00357 #define XGM_nextFrame()  XGM_nextXFrame(1)
00358
00364 void XGM_nextXFrame(const u16 num);
00365
00372 void XGM_setLoopNumber(const s8 value);
00373
00380 void XGM_set68KBUSProtection(const bool value);
00387 bool XGM_getForceDelayDMA(void);
00392 void XGM_setForceDelayDMA(const bool value);
00393
00405 u32 XGM_getCPULoad(void);
00406
00407
00408 #endif // _XGM_H_