romdev-mcp 0.1.1

package/src/platforms/genesis/lib/sgdk/include/psg.h

@@ -0,0 +1,153 @@
+/**
+ *  \file psg.h
+ *  \brief PSG support
+ *  \author Stephane Dallongeville
+ *  \date 08/2011
+ *
+ * This unit provides access to the PSG through the 68000 CPU
+ */
+
+#ifndef _PSG_H_
+#define _PSG_H_
+
+/**
+ *  \brief
+ *      PSG port address.
+ */
+#define PSG_PORT            0xC00011
+
+/**
+ *  \brief
+ *      Minimum PSG envelope value.
+ */
+#define PSG_ENVELOPE_MIN    15
+/**
+ *  \brief
+ *      Maximum PSG envelope value.
+ */
+#define PSG_ENVELOPE_MAX    0
+
+/**
+ *  \brief
+ *      Periodic noise type (like low-frequency tone).
+ */
+#define PSG_NOISE_TYPE_PERIODIC 0
+/**
+ *  \brief
+ *      White noise type (hiss).
+ */
+#define PSG_NOISE_TYPE_WHITE    1
+
+/**
+ *  \brief
+ *      Noise frequency = PSG clock / 2 (less coarse).
+ */
+#define PSG_NOISE_FREQ_CLOCK2   0
+/**
+ *  \brief
+ *      Noise frequency = PSG clock / 4.
+ */
+#define PSG_NOISE_FREQ_CLOCK4   1
+/**
+ *  \brief
+ *      Noise frequency = PSG clock / 8 (more coarse).
+ */
+#define PSG_NOISE_FREQ_CLOCK8   2
+/**
+ *  \brief
+ *      Noise frequency = Tone generator #3.
+ */
+#define PSG_NOISE_FREQ_TONE3    3
+
+
+/**
+ *  \deprecated use PSG_reset() instead
+ */
+#define PSG_init()  _Pragma("GCC error \"This method is deprecated, use PSG_reset() instead.\"")
+
+/**
+ *  \brief
+ *      Reset PSG chip
+ */
+void PSG_reset(void);
+
+/**
+ *  \brief
+ *      Write to PSG port.
+ *
+ *  \param data
+ *      value to write to the port.
+ *
+ * Write the specified value to PSG data port.
+ *
+ */
+void PSG_write(u8 data);
+
+/**
+ *  \brief
+ *      Set envelope level.
+ *
+ *  \param channel
+ *      Channel we want to set envelope (0-3).
+ *  \param value
+ *      Envelope level to set (#PSG_ENVELOPE_MIN - #PSG_ENVELOPE_MAX).
+ *
+ * Set envelope level for the specified PSG channel.
+ */
+void PSG_setEnvelope(u8 channel, u8 value);
+/**
+ *  \brief
+ *      Set tone.
+ *
+ *  \param channel
+ *      Channel we want to set tone (0-3).
+ *  \param value
+ *      Tone value to set (0-1023).
+ *
+ * Set direct tone value for the specified PSG channel.
+ */
+void PSG_setTone(u8 channel, u16 value);
+/**
+ *  \brief
+ *      Partial set tone (low bit only b3-b0).
+ *
+ *  \param channel
+ *      Channel we want to set tone (0-3).
+ *  \param value
+ *      Low bit (b3-b0) of tone value to set (0-15)
+ *
+ * Set low part of tone value for the specified PSG channel.
+ */
+void PSG_setToneLow(u8 channel, u8 value);
+/**
+ *  \brief
+ *      Set frequency.
+ *
+ *  \param channel
+ *      Channel we want to set frequency (0-3).
+ *  \param value
+ *      Frequency value to set in Hz (0-4095).
+ *
+ * Set frequency for the specified PSG channel.<br>
+ * This method actually converts the specified frequency value in PSG tone value.
+ */
+void PSG_setFrequency(u8 channel, u16 value);
+/**
+ *  \brief
+ *      Set noise type and frequency.
+ *
+ *  \param type
+ *      Noise type, accepted values are:<br>
+ *      #PSG_NOISE_TYPE_PERIODIC<br>
+ *      #PSG_NOISE_TYPE_WHITE
+ *  \param frequency
+ *      Noise frequency, accepted values are:<br>
+ *      #PSG_NOISE_FREQ_CLOCK2<br>
+ *      #PSG_NOISE_FREQ_CLOCK4<br>
+ *      #PSG_NOISE_FREQ_CLOCK8<br>
+ *      #PSG_NOISE_FREQ_TONE3
+ */
+void PSG_setNoise(u8 type, u8 frequency);
+
+
+#endif // _PSG_H_

package/src/platforms/genesis/lib/sgdk/include/snd/pcm/snd_dpcm2.h

@@ -0,0 +1,79 @@
+/**
+ *  \file SND_DPCM2.h
+ *  \brief Z80_DRIVER_DPCM2 sound driver API
+ *  \author Stephane Dallongeville
+ *  \date 08/2011
+ *
+ * This unit provides playback method for the <b>Z80_DRIVER_DPCM2</b> sound driver.<br>
+ * Sound driver description:<br>
+ * 2 channels 4 bits DPCM sample driver, it can mix up to 2 DCPM samples at a fixed 22050 Hz Khz rate.<br>
+ * Address and size of samples have to be 256 bytes boundary.<br>
+ *<br>
+ * Note that SGDK sound drivers may not fit your needs so it's important to know<br>
+ * that some alternatives sound drivers exist (see SGDK readme.md for more info)
+ */
+
+#ifndef _SND_DPCM2_H_
+#define _SND_DPCM2_H_
+
+#define SND_isPlaying_2ADPCM    _Pragma("GCC error \"This method is deprecated, use SND_DPCM2_isPlaying instead.\"")
+#define SND_startPlay_2ADPCM    _Pragma("GCC error \"This method is deprecated, use SND_DPCM2_startPlay instead.\"")
+#define SND_stopPlay_2ADPCM     _Pragma("GCC error \"This method is deprecated, use SND_DPCM2_stopPlay instead.\"")
+
+/**
+ *  \brief
+ *      Load the Z80_DRIVER_DPCM2 sound driver.
+ */
+void SND_DPCM2_loadDriver(const bool waitReady);
+
+/**
+ *  \brief
+ *      Return play status of specified channel (2 channels ADPCM player driver).
+ *
+ *  \param channel_mask
+ *      Channel(s) we want to retrieve play state.<br>
+ *      SOUND_PCM_CH1_MSK    = channel 1<br>
+ *      SOUND_PCM_CH2_MSK    = channel 2<br>
+ *      <br>
+ *      You can combine mask to retrieve state of severals channels at once:<br>
+ *      <code>isPlaying_2ADPCM(SOUND_PCM_CH1_MSK | SOUND_PCM_CH2_MSK)</code><br>
+ *      will actually return play state for channel 1 and channel 2.
+ *
+ *  \return
+ *      Return TRUE if specified channel(s) is(are) playing.
+ */
+bool SND_DPCM2_isPlaying(const u16 channel_mask);
+/**
+ *  \brief
+ *      Start playing a sample on specified channel (2 channels ADPCM player driver).<br>
+ *      If a sample was currently playing on this channel then it's stopped and the new sample is played instead.
+ *
+ *  \param sample
+ *      Sample address, should be 128 bytes boundary aligned<br>
+ *      SGDK automatically align resource as needed
+ *  \param len
+ *      Size of sample in bytes, should be a multiple of 128<br>
+ *      SGDK automatically adjust resource size as needed
+ *  \param channel
+ *      Channel where we want to play sample, accepted values are:<br>
+ *      SOUND_PCM_CH_AUTO  = auto selection from current channel usage<br>
+ *      SOUND_PCM_CH1      = channel 1<br>
+ *      SOUND_PCM_CH2      = channel 2<br>
+ *  \param loop
+ *      Loop flag.<br>
+ *      If TRUE then the sample will be played in loop (else sample is played only once).
+ */
+void SND_DPCM2_startPlay(const u8 *sample, const u32 len, const SoundPCMChannel channel, const bool loop);
+/**
+ *  \brief
+ *      Stop playing the specified channel (2 channels ADPCM player driver).<br>
+ *      No effect if no sample was currently playing on this channel.
+ *
+ *  \param channel
+ *      Channel we want to stop, accepted values are:<br>
+ *      SOUND_PCM_CH1    = channel 1<br>
+ *      SOUND_PCM_CH2    = channel 2<br>
+ */
+void SND_DPCM2_stopPlay(const SoundPCMChannel channel);
+
+#endif // _SND_DPCM2_H_

package/src/platforms/genesis/lib/sgdk/include/snd/pcm/snd_pcm.h

@@ -0,0 +1,98 @@
+/**
+ *  \file snd_pcm.h
+ *  \brief Z80_DRIVER_PCM sound driver API
+ *  \author Stephane Dallongeville
+ *  \date 08/2011
+ *
+ * This unit provides playback method for the <b>Z80_DRIVER_PCM</b> sound driver.<br>
+ *<br>
+ * Sound driver description:<br>
+ * This sound driver allow Single PCM channel 8 bits signed sample driver.<br>
+ * It can play a sample (8 bit signed) from 8 Khz up to 32 Khz rate.<br>
+ *<br>
+ * Note that SGDK sound drivers may not fit your needs so it's important to know<br>
+ * that some alternatives sound drivers exist (see SGDK readme.md for more info)
+ */
+
+#ifndef _SND_PCM_H_
+#define _SND_PCM_H_
+
+/**
+ *  \brief
+ *      PCM sample rate values
+ */
+typedef enum
+{
+    SOUND_PCM_RATE_32000,   /** Best quality but take lot of rom space */
+    SOUND_PCM_RATE_22050,
+    SOUND_PCM_RATE_16000,
+    SOUND_PCM_RATE_13400,
+    SOUND_PCM_RATE_11025,
+    SOUND_PCM_RATE_8000     /** Worst quality but take less rom place */
+} SoundPcmSampleRate;
+
+
+#define SOUND_RATE_32000    _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_RATE_32000 instead.\"")
+#define SOUND_RATE_22050    _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_RATE_22050 instead.\"")
+#define SOUND_RATE_16000    _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_RATE_16000 instead.\"")
+#define SOUND_RATE_13400    _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_RATE_13400 instead.\"")
+#define SOUND_RATE_11025    _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_RATE_11025 instead.\"")
+#define SOUND_RATE_8000     _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_RATE_8000 instead.\"")
+
+
+#define SND_isPlaying_PCM   _Pragma("GCC error \"This method is deprecated, use SND_PCM_isPlaying instead.\"")
+#define SND_startPlay_PCM   _Pragma("GCC error \"This method is deprecated, use SND_PCM_startPlay instead.\"")
+#define SND_stopPlay_PCM    _Pragma("GCC error \"This method is deprecated, use SND_PCM_stopPlay instead.\"")
+
+/**
+ *  \brief
+ *      Load the Z80_DRIVER_PCM sound driver.
+ */
+void SND_PCM_loadDriver(const bool waitReady);
+
+/**
+ *  \brief
+ *      Return play status (Single channel PCM player driver).
+ *
+ *  \return
+ *      Return non zero if PCM player is currently playing a sample
+ */
+bool SND_PCM_isPlaying(void);
+/**
+ *  \brief
+ *      Start playing a sample (Single channel PCM player driver).<br>
+ *      If a sample was currently playing then it's stopped and the new sample is played instead.
+ *
+ *  \param sample
+ *      Sample address, should be 256 bytes boundary aligned<br>
+ *      SGDK automatically align resource as needed
+ *  \param len
+ *      Size of sample in bytes, should be a multiple of 256<br>
+ *      SGDK automatically adjust resource size as needed
+ *  \param rate
+ *      Playback rate :<br>
+ *      SOUND_PCM_RATE_32000 = 32 Khz (best quality but take lot of rom space)<br>
+ *      SOUND_PCM_RATE_22050 = 22 Khz<br>
+ *      SOUND_PCM_RATE_16000 = 16 Khz<br>
+ *      SOUND_PCM_RATE_13400 = 13.4 Khz<br>
+ *      SOUND_PCM_RATE_11025 = 11 Khz<br>
+ *      SOUND_PCM_RATE_8000  = 8 Khz (worst quality but take less rom place)<br>
+ *  \param pan
+ *      Panning :<br>
+ *      SOUND_PAN_NONE   = mute<br>
+ *      SOUND_PAN_LEFT   = play on left speaker<br>
+ *      SOUND_PAN_RIGHT  = play on right speaker<br>
+ *      SOUND_PAN_CENTER = play on both speaker<br>
+ *  \param loop
+ *      Loop flag.<br>
+ *      If TRUE then the sample will be played in loop (else sample is played only once).
+ */
+void SND_PCM_startPlay(const u8 *sample, const u32 len, const SoundPcmSampleRate rate, const SoundPanning pan, const bool loop);
+/**
+ *  \brief
+ *      Stop playing (Single channel PCM player driver).<br>
+ *      No effect if no sample was currently playing.
+ */
+void SND_PCM_stopPlay(void);
+
+#endif // _SND_PCM_H_

package/src/platforms/genesis/lib/sgdk/include/snd/pcm/snd_pcm4.h

@@ -0,0 +1,125 @@
+/**
+ *  \file snd_pcm4.h
+ *  \brief Z80_DRIVER_PCM4 sound driver API
+ *  \author Stephane Dallongeville
+ *  \date 08/2011
+ *
+ * This unit provides playback method for the <b>Z80_DRIVER_PCM4</b> sound driver.<br>
+ * Sound driver description:<br>
+ * 4 channels 8 bits signed sample driver with volume support.<br>
+ * It can mix up to 4 samples (8 bit signed) at a fixed 16 Khz rate.<br>
+ * with volume support (16 levels du to memory limitation).<br>
+ * Address and size of samples have to be 256 bytes boundary.<br>
+ * The driver does support "cutoff" when mixing so you can use true 8 bits samples :)<br>
+ *<br>
+ * Note that SGDK sound drivers may not fit your needs so it's important to know<br>
+ * that some alternatives sound drivers exist (see SGDK readme.md for more info)
+ */
+
+#ifndef _SND_PCM4_H_
+#define _SND_PCM4_H_
+
+#define SND_isPlaying_4PCM_ENV      _Pragma("GCC error \"This method is deprecated, use SND_PCM4_isPlaying instead.\"")
+#define SND_startPlay_4PCM_ENV      _Pragma("GCC error \"This method is deprecated, use SND_PCM4_startPlay instead.\"")
+#define SND_stopPlay_4PCM_ENV       _Pragma("GCC error \"This method is deprecated, use SND_PCM4_stopPlay instead.\"")
+#define SND_getVolume_4PCM_ENV      _Pragma("GCC error \"This method is deprecated, use SND_PCM4_getVolume instead.\"")
+#define SND_setVolume_4PCM_ENV      _Pragma("GCC error \"This method is deprecated, use SND_PCM4_setVolume instead.\"")
+
+#define SND_isPlaying_4PCM          _Pragma("GCC error \"This method is deprecated, use SND_PCM4_isPlaying instead.\"")
+#define SND_startPlay_4PCM          _Pragma("GCC error \"This method is deprecated, use SND_PCM4_startPlay instead.\"")
+#define SND_stopPlay_4PCM           _Pragma("GCC error \"This method is deprecated, use SND_PCM4_stopPlay instead.\"")
+#define SND_getVolume_4PCM          _Pragma("GCC error \"This method is deprecated, use SND_PCM4_getVolume instead.\"")
+#define SND_setVolume_4PCM          _Pragma("GCC error \"This method is deprecated, use SND_PCM4_setVolume instead.\"")
+
+/**
+ *  \brief
+ *      Load the Z80_DRIVER_PCM4 sound driver.
+ */
+void SND_PCM4_loadDriver(const bool waitReady);
+
+/**
+ *  \brief
+ *      Return play status of specified channel (4 channels PCM player driver).
+ *
+ *  \param channel_mask
+ *      Channel(s) we want to retrieve play state.<br>
+ *      SOUND_PCM_CH1_MSK    = channel 1<br>
+ *      SOUND_PCM_CH2_MSK    = channel 2<br>
+ *      SOUND_PCM_CH3_MSK    = channel 3<br>
+ *      SOUND_PCM_CH4_MSK    = channel 4<br>
+ *      <br>
+ *      You can combine mask to retrieve state of severals channels at once:<br>
+ *      <code>SND_PCM4_isPlaying(SOUND_PCM_CH1_MSK | SOUND_PCM_CH2_MSK)</code><br>
+ *      will actually return play state for channel 1 and channel 2.
+ *
+ *  \return
+ *      Return TRUE if specified channel(s) is(are) playing.
+ */
+bool SND_PCM4_isPlaying(const u16 channel_mask);
+/**
+ *  \brief
+ *      Start playing a sample on specified channel (4 channels PCM player driver).<br>
+ *      If a sample was currently playing on this channel then it's stopped and the new sample is played instead.
+ *
+ *  \param sample
+ *      Sample address, should be 256 bytes boundary aligned<br>
+ *      SGDK automatically align resource as needed
+ *  \param len
+ *      Size of sample in bytes, should be a multiple of 256<br>
+ *      SGDK automatically adjust resource size as needed
+ *  \param channel
+ *      Channel where we want to play sample, accepted values are:<br>
+ *      SOUND_PCM_CH_AUTO  = auto selection from current channel usage<br>
+ *      SOUND_PCM_CH1      = channel 1<br>
+ *      SOUND_PCM_CH2      = channel 2<br>
+ *      SOUND_PCM_CH3      = channel 3<br>
+ *      SOUND_PCM_CH4      = channel 4<br>
+ *  \param loop
+ *      Loop flag.<br>
+ *      If TRUE then the sample will be played in loop (else sample is played only once).
+ */
+void SND_PCM4_startPlay(const u8 *sample, const u32 len, const SoundPCMChannel channel, const bool loop);
+/**
+ *  \brief
+ *      Stop playing the specified channel (4 channels PCM player driver).<br>
+ *      No effect if no sample was currently playing on this channel.
+ *
+ *  \param channel
+ *      Channel we want to stop, accepted values are:<br>
+ *      SOUND_PCM_CH1    = channel 1<br>
+ *      SOUND_PCM_CH2    = channel 2<br>
+ *      SOUND_PCM_CH3    = channel 3<br>
+ *      SOUND_PCM_CH4    = channel 4<br>
+ */
+void SND_PCM4_stopPlay(const SoundPCMChannel channel);
+/**
+ *  \brief
+ *      Change envelop / volume of specified channel (4 channels PCM player driver).
+ *
+ *  \param channel
+ *      Channel we want to set envelop, accepted values are:<br>
+ *      SOUND_PCM_CH1    = channel 1<br>
+ *      SOUND_PCM_CH2    = channel 2<br>
+ *      SOUND_PCM_CH3    = channel 3<br>
+ *      SOUND_PCM_CH4    = channel 4<br>
+ *  \param volume
+ *      Volume to set: 16 possible level from 0 (minimum) to 15 (maximum).
+ */
+void SND_PCM4_setVolume(const SoundPCMChannel channel, const u8 volume);
+/**
+ *  \brief
+ *      Return envelop / volume level of specified channel (4 channels PCM player driver).
+ *
+ *  \param channel
+ *      Channel we want to retrieve envelop level, accepted values are:<br>
+ *      SOUND_PCM_CH1    = channel 1<br>
+ *      SOUND_PCM_CH2    = channel 2<br>
+ *      SOUND_PCM_CH3    = channel 3<br>
+ *      SOUND_PCM_CH4    = channel 4<br>
+ *  \return
+ *      Envelop of specified channel.<br>
+ *      The returned value is comprised between 0 (quiet) to 15 (loud).
+ */
+u8   SND_PCM4_getVolume(const SoundPCMChannel channel);
+
+#endif // _SND_PCM4_H_

package/src/platforms/genesis/lib/sgdk/include/snd/pcm/tab_vol.h

@@ -0,0 +1,6 @@
+#ifndef _TAB_VOL_H_
+#define _TAB_VOL_H_
+
+extern const u8 tab_vol[0x1000];
+
+#endif // _TAB_VOL_H_

package/src/platforms/genesis/lib/sgdk/include/snd/smp_null.h

@@ -0,0 +1,6 @@
+#ifndef _SMP_NULL_H_
+#define _SMP_NULL_H_
+
+extern const u8 smp_null[0x100];
+
+#endif // _SMP_NULL_H_

package/src/platforms/genesis/lib/sgdk/include/snd/smp_null_dpcm.h

@@ -0,0 +1,6 @@
+#ifndef _SMP_NULL_DPCM_H_
+#define _SMP_NULL_DPCM_H_
+
+extern const u8 smp_null_dpcm[0x80];
+
+#endif // _SMP_NULL_DPCM_H_

package/src/platforms/genesis/lib/sgdk/include/snd/sound.h

@@ -0,0 +1,70 @@
+/**
+ *  \file sound.h
+ *  \brief General / shared sound driver definitions
+ *  \author Stephane Dallongeville
+ *  \date 08/2011
+ *
+ * This unit provides basic definitions for sound drivers.<br>
+ */
+
+#ifndef _SOUND_H_
+#define _SOUND_H_
+
+/**
+ *  \brief
+ *      Sound PCM channel enum
+ */
+typedef enum
+{
+    SOUND_PCM_CH_AUTO = -1,       // auto-select
+    SOUND_PCM_CH1 = 0,            // channel 1
+    SOUND_PCM_CH2,                // channel 2
+    SOUND_PCM_CH3,                // channel 3
+    SOUND_PCM_CH4,                // channel 4
+} SoundPCMChannel;
+
+/**
+ *  \brief
+ *      Sound panning enum
+ */
+typedef enum
+{
+    SOUND_PAN_NONE = 0x00,        // mute
+    SOUND_PAN_RIGHT = 0x40,       // right speaker only
+    SOUND_PAN_LEFT = 0x80,        // left speaker only
+    SOUND_PAN_CENTER = 0xC0       // center (both speakers)
+} SoundPanning;
+
+/**
+ *  \brief
+ *      PCM channel 1 (first channel) selection mask.
+ */
+#define SOUND_PCM_CH1_MSK   (1 << SOUND_PCM_CH1)
+/**
+ *  \brief
+ *      PCM channel 2 selection mask.
+ */
+#define SOUND_PCM_CH2_MSK   (1 << SOUND_PCM_CH2)
+/**
+ *  \brief
+ *      PCM channel 3 selection mask.
+ */
+#define SOUND_PCM_CH3_MSK   (1 << SOUND_PCM_CH3)
+/**
+ *  \brief
+ *      PCM channel 4 selection mask.
+ */
+#define SOUND_PCM_CH4_MSK   (1 << SOUND_PCM_CH4)
+
+
+#define SOUND_PCM_AUTO      _Pragma("GCC error \"This method is deprecated, use SOUND_PCM_CH_AUTO instead.\"")
+
+
+/**
+ *  \brief
+ *      Load the dummy Z80 driver.
+ */
+void SND_NULL_loadDriver(void);
+
+
+#endif // _SOUND_H_