SnesLab - User contributions [en]

David Whittaker Sound Engine

2025-07-22T23:58:49Z

KungFuFurby: Corrected the channel number that isn't affected by global transposition. This is because the channel IDs defined in this article started at 1, not zero.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta's Title Screen and ''Lawnmower Man/Virtual Wars''' US Beta
* ''Lemmings 2: The Tribes'' ' most common build and ''Riddick Bowe Boxing'''s Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| ''Dream TV'' || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| ''Krusty's Super Fun House'' || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| ''Kick Off/Super Kick Off'' || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| ''Batman: Revenge of the Joker'' || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| ''Super SWIV/Firepower 2000'' || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| ''Gods'' || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| ''World Class Rugby'' || 2.3 || <tt>0x0608</tt>/<tt>N/A</tt> || <tt>0x021D64</tt>/<tt>0x0B8000</tt> (all versions)
|-
| ''Battle Cars'' || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| ''Chavez/Riddick Bowe Boxing'' || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except ''Chavez'') (three unique build variants, one per version between ''Chavez'', US & Japanese versions)
|-
| ''Lawnmower Man/Virtual Wars'' || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| ''Apocalypse II'' || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| ''Elite Soccer/World Cup Striker'' || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| ''Kick Off 3'' (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| ''Lemmings 2: The Tribes'' || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| ''Porky Pig's Haunted Holiday'' (3/16/1994 Beta version only) || 3.1 || <tt>0x06BD</tt> || <tt>0x1E8000</tt>
|-
| ''Porky Pig's Haunted Holiday'' (5/24/1994 and 1/26/1995 Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| ''Shaq Fu'' || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| ''Michael Jordan: Chaos in the Windy City'' || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are also resent, given that they're also cleared out after use.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Main Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Main & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Main Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

''Riddick Bowe Boxing'' (US version) has additional behavior with command IDs <tt>$1A-$FF</tt>: it plays music with a fixed ID instead of a parameter.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta - 5/24/1994 and 1/26/1995) only)===
Crashes the sound driver. The only games that can do this are the 5/24/1994 and 1/26/1995 versions of Porky Pig's Haunted Holiday, and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* ''Apocalypse II'' (Opening logo)/''Lemmings 2: The Tribes'' (Opening logo)
* ''Kick Off 3'' (Beta) (In-Game)
* ''World Class Rugby'' (During a game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** ''Dream TV'' (beta and final): '''2X'''
*** All other games: '''4X'''
*** ''Batman: Revenge of the Joker'', ''Krusty's Super Fun House'', ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', ''Shaq-Fu'', ''Super SWIV/Firepower 2000'': '''8X'''

The following builds don't support this command:
* ''Gods'' (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Main & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the main volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** ''Batman: Revenge of the Joker'': '''1/4'''
*** ''Dream TV'': '''1/4'''
*** ''Gods'' (all builds): '''3/16'''
*** ''World Class Rugby'' (Outside of a game): '''3/16'''
*** ''Lawnmower Man/Virtual Wars'' (Driving): '''3/16'''
*** ''Lemmings 2: The Tribes'' (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* ''Batman: Revenge of the Joker''
* ''Dream TV''
* ''Gods'' (all builds)
* ''World Class Rugby'' (Outside of a game)
* ''Lawnmower Man/Virtual Wars'' (Driving)
* ''Lemmings 2: The Tribes'' (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* ''Battle Cars''
* ''Riddick Bowe Boxing/Chavez'' (all versions except Japanese)
* ''Shaq-Fu''

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

The following builds don't support this command:
* ''World Class Rugby'' (During a game)

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* ''Battle Cars''
* ''World Cup Striker'' (European version) (Title Screen)
* ''Elite Soccer/World Cup Striker'' (European version) (In-Game)
* ''Kick Off 3'' (beta) (In-Game)
* ''Kick Off 3'' (beta) (Title Screen)
* ''Porky Pig's Haunted Holiday'' (beta)
* ''Shaq-Fu''

Not all IDs are supported in these builds...
* ''Lawnmower Man/Virtual Wars'' (In-Game) ''(does not support $1A-$1D, not even in the code)''
* ''World Cup Striker (Japanese)'' (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For ''Dream TV'' Beta and ''Kick Off'', only five pointers are defined. For ''Krusty's Super Fun House'', only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (''Dream TV Beta'' and ''Kick Off'')
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (''Krusty's Super Fun House'')
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(''Krusty's Super Fun House'' only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Three builds don't support song entries at all:
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta (In-Game)
* ''World Class Rugby'' (During a game)

''World Class Rugby'' (During a game) also doesn't support the music format at all since the code was removed.

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Main Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Main Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 5 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine

2025-07-22T05:07:53Z

KungFuFurby: Found an invalid command ID difference with Riddick Bowe Boxing (US version): namely, it plays music with a fixed ID, assuming that the command ID is greater than or equal to $1A.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta's Title Screen and ''Lawnmower Man/Virtual Wars''' US Beta
* ''Lemmings 2: The Tribes'' ' most common build and ''Riddick Bowe Boxing'''s Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| ''Dream TV'' || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| ''Krusty's Super Fun House'' || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| ''Kick Off/Super Kick Off'' || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| ''Batman: Revenge of the Joker'' || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| ''Super SWIV/Firepower 2000'' || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| ''Gods'' || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| ''World Class Rugby'' || 2.3 || <tt>0x0608</tt>/<tt>N/A</tt> || <tt>0x021D64</tt>/<tt>0x0B8000</tt> (all versions)
|-
| ''Battle Cars'' || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| ''Chavez/Riddick Bowe Boxing'' || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except ''Chavez'') (three unique build variants, one per version between ''Chavez'', US & Japanese versions)
|-
| ''Lawnmower Man/Virtual Wars'' || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| ''Apocalypse II'' || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| ''Elite Soccer/World Cup Striker'' || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| ''Kick Off 3'' (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| ''Lemmings 2: The Tribes'' || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| ''Porky Pig's Haunted Holiday'' (3/16/1994 Beta version only) || 3.1 || <tt>0x06BD</tt> || <tt>0x1E8000</tt>
|-
| ''Porky Pig's Haunted Holiday'' (5/24/1994 and 1/26/1995 Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| ''Shaq Fu'' || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| ''Michael Jordan: Chaos in the Windy City'' || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are also resent, given that they're also cleared out after use.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Main Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Main & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Main Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

''Riddick Bowe Boxing'' (US version) has additional behavior with command IDs <tt>$1A-$FF</tt>: it plays music with a fixed ID instead of a parameter.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta - 5/24/1994 and 1/26/1995) only)===
Crashes the sound driver. The only games that can do this are the 5/24/1994 and 1/26/1995 versions of Porky Pig's Haunted Holiday, and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* ''Apocalypse II'' (Opening logo)/''Lemmings 2: The Tribes'' (Opening logo)
* ''Kick Off 3'' (Beta) (In-Game)
* ''World Class Rugby'' (During a game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** ''Dream TV'' (beta and final): '''2X'''
*** All other games: '''4X'''
*** ''Batman: Revenge of the Joker'', ''Krusty's Super Fun House'', ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', ''Shaq-Fu'', ''Super SWIV/Firepower 2000'': '''8X'''

The following builds don't support this command:
* ''Gods'' (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Main & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the main volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** ''Batman: Revenge of the Joker'': '''1/4'''
*** ''Dream TV'': '''1/4'''
*** ''Gods'' (all builds): '''3/16'''
*** ''World Class Rugby'' (Outside of a game): '''3/16'''
*** ''Lawnmower Man/Virtual Wars'' (Driving): '''3/16'''
*** ''Lemmings 2: The Tribes'' (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* ''Batman: Revenge of the Joker''
* ''Dream TV''
* ''Gods'' (all builds)
* ''World Class Rugby'' (Outside of a game)
* ''Lawnmower Man/Virtual Wars'' (Driving)
* ''Lemmings 2: The Tribes'' (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* ''Battle Cars''
* ''Riddick Bowe Boxing/Chavez'' (all versions except Japanese)
* ''Shaq-Fu''

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

The following builds don't support this command:
* ''World Class Rugby'' (During a game)

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* ''Battle Cars''
* ''World Cup Striker'' (European version) (Title Screen)
* ''Elite Soccer/World Cup Striker'' (European version) (In-Game)
* ''Kick Off 3'' (beta) (In-Game)
* ''Kick Off 3'' (beta) (Title Screen)
* ''Porky Pig's Haunted Holiday'' (beta)
* ''Shaq-Fu''

Not all IDs are supported in these builds...
* ''Lawnmower Man/Virtual Wars'' (In-Game) ''(does not support $1A-$1D, not even in the code)''
* ''World Cup Striker (Japanese)'' (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For ''Dream TV'' Beta and ''Kick Off'', only five pointers are defined. For ''Krusty's Super Fun House'', only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (''Dream TV Beta'' and ''Kick Off'')
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (''Krusty's Super Fun House'')
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(''Krusty's Super Fun House'' only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Three builds don't support song entries at all:
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta (In-Game)
* ''World Class Rugby'' (During a game)

''World Class Rugby'' (During a game) also doesn't support the music format at all since the code was removed.

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Main Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Main Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine

2025-07-21T17:49:55Z

KungFuFurby: Removing the P from "resent": clearing latches means the parameters are no longer present on the CPUIO registers because they're zeroed out.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta's Title Screen and ''Lawnmower Man/Virtual Wars''' US Beta
* ''Lemmings 2: The Tribes'' ' most common build and ''Riddick Bowe Boxing'''s Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| ''Dream TV'' || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| ''Krusty's Super Fun House'' || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| ''Kick Off/Super Kick Off'' || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| ''Batman: Revenge of the Joker'' || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| ''Super SWIV/Firepower 2000'' || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| ''Gods'' || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| ''World Class Rugby'' || 2.3 || <tt>0x0608</tt>/<tt>N/A</tt> || <tt>0x021D64</tt>/<tt>0x0B8000</tt> (all versions)
|-
| ''Battle Cars'' || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| ''Chavez/Riddick Bowe Boxing'' || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except ''Chavez'') (three unique build variants, one per version between ''Chavez'', US & Japanese versions)
|-
| ''Lawnmower Man/Virtual Wars'' || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| ''Apocalypse II'' || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| ''Elite Soccer/World Cup Striker'' || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| ''Kick Off 3'' (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| ''Lemmings 2: The Tribes'' || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| ''Porky Pig's Haunted Holiday'' (3/16/1994 Beta version only) || 3.1 || <tt>0x06BD</tt> || <tt>0x1E8000</tt>
|-
| ''Porky Pig's Haunted Holiday'' (5/24/1994 and 1/26/1995 Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| ''Shaq Fu'' || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| ''Michael Jordan: Chaos in the Windy City'' || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are also resent, given that they're also cleared out after use.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Main Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Main & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Main Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta - 5/24/1994 and 1/26/1995) only)===
Crashes the sound driver. The only games that can do this are the 5/24/1994 and 1/26/1995 versions of Porky Pig's Haunted Holiday, and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* ''Apocalypse II'' (Opening logo)/''Lemmings 2: The Tribes'' (Opening logo)
* ''Kick Off 3'' (Beta) (In-Game)
* ''World Class Rugby'' (During a game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** ''Dream TV'' (beta and final): '''2X'''
*** All other games: '''4X'''
*** ''Batman: Revenge of the Joker'', ''Krusty's Super Fun House'', ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', ''Shaq-Fu'', ''Super SWIV/Firepower 2000'': '''8X'''

The following builds don't support this command:
* ''Gods'' (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Main & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the main volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** ''Batman: Revenge of the Joker'': '''1/4'''
*** ''Dream TV'': '''1/4'''
*** ''Gods'' (all builds): '''3/16'''
*** ''World Class Rugby'' (Outside of a game): '''3/16'''
*** ''Lawnmower Man/Virtual Wars'' (Driving): '''3/16'''
*** ''Lemmings 2: The Tribes'' (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* ''Batman: Revenge of the Joker''
* ''Dream TV''
* ''Gods'' (all builds)
* ''World Class Rugby'' (Outside of a game)
* ''Lawnmower Man/Virtual Wars'' (Driving)
* ''Lemmings 2: The Tribes'' (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* ''Battle Cars''
* ''Riddick Bowe Boxing/Chavez'' (all versions except Japanese)
* ''Shaq-Fu''

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

The following builds don't support this command:
* ''World Class Rugby'' (During a game)

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* ''Battle Cars''
* ''World Cup Striker'' (European version) (Title Screen)
* ''Elite Soccer/World Cup Striker'' (European version) (In-Game)
* ''Kick Off 3'' (beta) (In-Game)
* ''Kick Off 3'' (beta) (Title Screen)
* ''Porky Pig's Haunted Holiday'' (beta)
* ''Shaq-Fu''

Not all IDs are supported in these builds...
* ''Lawnmower Man/Virtual Wars'' (In-Game) ''(does not support $1A-$1D, not even in the code)''
* ''World Cup Striker (Japanese)'' (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For ''Dream TV'' Beta and ''Kick Off'', only five pointers are defined. For ''Krusty's Super Fun House'', only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (''Dream TV Beta'' and ''Kick Off'')
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (''Krusty's Super Fun House'')
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(''Krusty's Super Fun House'' only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Three builds don't support song entries at all:
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta (In-Game)
* ''World Class Rugby'' (During a game)

''World Class Rugby'' (During a game) also doesn't support the music format at all since the code was removed.

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Main Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Main Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine/Build Sorting

2025-07-17T20:57:39Z

KungFuFurby: Updating due to new betas from Porky Pig's Haunted Holiday, resulting in a new non-unique build difference

{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Dream TV'' (Beta 2) || <tt>$0800</tt> || <tt>D0 E8 E8 ?? 3F ?? ??</tt> || <tt>$0BF4</tt> ||
|-
|''Kick Off'' || <tt>$0300</tt> || <tt>D0 F7 3F ?? ??</tt> || <tt>$079D</tt> ||
|-
|''Krusty's Super Fun House'' (version 1) ''(Only version used in the Japanese version)'' || <tt>$0300</tt> || <tt>D0 F7 3F ?? ??</tt> & <tt>D0 F5 3F ?? ??</tt> || <tt>$079D</tt> & <tt>$0994</tt> ||
|-
|''Krusty's Super Fun House'' (version 2) || <tt>$0300</tt> || <tt>D0 F7 3F ?? ??</tt> & <tt>D0 F5 3F ?? ??</tt> || <tt>$079D</tt> & <tt>$0999</tt> ||
|-
|''Gods'' (Ending) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$080D</tt> ||
|-
|''Gods'' (Title Screen & In-Game) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$090D</tt> || Two copies of the code found in ROM.
|-
|''World Class Rugby'' (Outside of a game)|| <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$0915</tt> ||
|-
|''Batman: Revenge of the Joker'' || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> & <tt>CD ?? 3F ?? ??</tt> || <tt>$091F</tt> & <tt>$05E4</tt> ||
|-
|''Gods'' (Opening) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> & <tt>CD ?? 3F ?? ??</tt> || <tt>$091F</tt> & <tt>$05EB</tt> ||
|-
|''Dream TV'' || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$0923</tt> ||
|-
|''Lemmings 2: The Tribes'' (Cavelem Tribe) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$09D8</tt> ||
|-
|''World Class Rugby'' (During a game) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$051C</tt> ||
|-
|''Super SWIV/Firepower 2000'' || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$08BC</tt> ||
|-
|''Apocalypse II'' (Opening Logo) ''Lemmings 2: The Tribes'' (Opening Logo)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$08F0</tt> ||
|-
|''Lemmings 2: The Tribes'' (Beach Tribe) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0950</tt> ||
|-
|''Lemmings 2: The Tribes'' (Title Screen) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0955</tt> ||
|-
|''Lemmings 2: The Tribes'' (Most common build used) ''Riddick Bowe Boxing'' (Japanese version) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0962</tt> || 12 copies of the code found in ROM for Lemmings 2: The Tribes.
|-
|''Apocalypse II'' (In-Game)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0965</tt> ||
|-
|''Kick Off 3'' (Beta) (In-Game)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0999</tt> ||
|-
|''Kick Off 3'' (Beta) (Title Screen) ''Lawnmower Man/Virtual Wars'' (US Beta) ''Porky Pig's Haunted Holiday'' (3/16/1994 Beta version only)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$09FE</tt> ||
|-
|''Porky Pig's Haunted Holiday'' (5/24/1994 and 1/26/1995 Beta version only)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0A0B</tt> || Contains an opening jump. 36 copies of the code found in ROM.
|-
|''Shaq Fu''|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0874</tt> ||
|-
|''Elite Soccer/World Cup Striker'' (Japanese version) (Title Screen)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0947</tt> ||
|-
|''Riddick Bowe Boxing'' (US version)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0947</tt> || Two copies of the code found in the ROM. Between the two, there were lots of memory location reference-related differences, but none were actual opcode-related executions, so it's considered a match.
|-
|''Chavez''|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$09B9</tt> ||
|-
|''Lawnmower Man/Virtual Wars'' (In-Game)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$09E0</tt> ||
|-
|''Elite Soccer/World Cup Striker'' (European version) (In-Game)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A3B</tt> ||
|-
|''Battle Cars''|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A3C</tt> ||
|-
|''World Cup Striker'' (Japanese version) (In-Game)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A3E</tt> ||
|-
|''World Cup Striker'' (European version) (Title Screen)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A47</tt> ||
|-
|''Lawnmower Man/Virtual Wars'' (Driving)|| <tt>$0200</tt> || <tt>E8 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A6F</tt> ||
|-
|''Michael Jordan: Chaos in the Windy City''|| <tt>$0200</tt> || <tt>CD ?? 3F ?? ??</tt> || <tt>$052E</tt> ||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

David Whittaker Sound Engine

2025-07-17T20:55:29Z

KungFuFurby: Updating due to new betas from Porky Pig's Haunted Holiday, resulting in a new non-unique build difference

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta's Title Screen and ''Lawnmower Man/Virtual Wars''' US Beta
* ''Lemmings 2: The Tribes'' ' most common build and ''Riddick Bowe Boxing'''s Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| ''Dream TV'' || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| ''Krusty's Super Fun House'' || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| ''Kick Off/Super Kick Off'' || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| ''Batman: Revenge of the Joker'' || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| ''Super SWIV/Firepower 2000'' || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| ''Gods'' || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| ''World Class Rugby'' || 2.3 || <tt>0x0608</tt>/<tt>N/A</tt> || <tt>0x021D64</tt>/<tt>0x0B8000</tt> (all versions)
|-
| ''Battle Cars'' || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| ''Chavez/Riddick Bowe Boxing'' || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except ''Chavez'') (three unique build variants, one per version between ''Chavez'', US & Japanese versions)
|-
| ''Lawnmower Man/Virtual Wars'' || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| ''Apocalypse II'' || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| ''Elite Soccer/World Cup Striker'' || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| ''Kick Off 3'' (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| ''Lemmings 2: The Tribes'' || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| ''Porky Pig's Haunted Holiday'' (3/16/1994 Beta version only) || 3.1 || <tt>0x06BD</tt> || <tt>0x1E8000</tt>
|-
| ''Porky Pig's Haunted Holiday'' (5/24/1994 and 1/26/1995 Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| ''Shaq Fu'' || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| ''Michael Jordan: Chaos in the Windy City'' || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are present.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Main Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Main & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Main Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta - 5/24/1994 and 1/26/1995) only)===
Crashes the sound driver. The only games that can do this are the 5/24/1994 and 1/26/1995 versions of Porky Pig's Haunted Holiday, and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* ''Apocalypse II'' (Opening logo)/''Lemmings 2: The Tribes'' (Opening logo)
* ''Kick Off 3'' (Beta) (In-Game)
* ''World Class Rugby'' (During a game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** ''Dream TV'' (beta and final): '''2X'''
*** All other games: '''4X'''
*** ''Batman: Revenge of the Joker'', ''Krusty's Super Fun House'', ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', ''Shaq-Fu'', ''Super SWIV/Firepower 2000'': '''8X'''

The following builds don't support this command:
* ''Gods'' (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Main & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the main volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** ''Batman: Revenge of the Joker'': '''1/4'''
*** ''Dream TV'': '''1/4'''
*** ''Gods'' (all builds): '''3/16'''
*** ''World Class Rugby'' (Outside of a game): '''3/16'''
*** ''Lawnmower Man/Virtual Wars'' (Driving): '''3/16'''
*** ''Lemmings 2: The Tribes'' (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* ''Batman: Revenge of the Joker''
* ''Dream TV''
* ''Gods'' (all builds)
* ''World Class Rugby'' (Outside of a game)
* ''Lawnmower Man/Virtual Wars'' (Driving)
* ''Lemmings 2: The Tribes'' (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* ''Battle Cars''
* ''Riddick Bowe Boxing/Chavez'' (all versions except Japanese)
* ''Shaq-Fu''

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

The following builds don't support this command:
* ''World Class Rugby'' (During a game)

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* ''Battle Cars''
* ''World Cup Striker'' (European version) (Title Screen)
* ''Elite Soccer/World Cup Striker'' (European version) (In-Game)
* ''Kick Off 3'' (beta) (In-Game)
* ''Kick Off 3'' (beta) (Title Screen)
* ''Porky Pig's Haunted Holiday'' (beta)
* ''Shaq-Fu''

Not all IDs are supported in these builds...
* ''Lawnmower Man/Virtual Wars'' (In-Game) ''(does not support $1A-$1D, not even in the code)''
* ''World Cup Striker (Japanese)'' (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For ''Dream TV'' Beta and ''Kick Off'', only five pointers are defined. For ''Krusty's Super Fun House'', only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (''Dream TV Beta'' and ''Kick Off'')
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (''Krusty's Super Fun House'')
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(''Krusty's Super Fun House'' only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Three builds don't support song entries at all:
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta (In-Game)
* ''World Class Rugby'' (During a game)

''World Class Rugby'' (During a game) also doesn't support the music format at all since the code was removed.

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Main Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Main Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

N-SPC Engine

2024-01-09T19:48:37Z

KungFuFurby: Caught a typo in Hong Kong '97 with its ID of the ESA DSP register. The other SM Choukyoushi Hitomi games are not affected.

__TOC__

'''Nintendo SPC Sound Engine''', abbreviated N-SPC and officially known as Kankichi-kun [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun], is the most common sound engine used in all of the SNES/SFC games. Only the music portion was initially provided in the source code included in the IS-Sound unit along with some templating for a protocol for music and sound effects [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system]: usually it was modified by developers on an individual basis, resulting in many different variants, some of them more heavily modifying the sound driver than others. Usually what was added on was sound effect support, but sometimes the music VCMDs were modified as well.

The following games are purely based off of the source code provided with the IS-Sound unit, and are either unmodified or barely modified, if at all:
{| class="wikitable sortable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Hong Kong '97'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0F800A</tt> (both versions)
|-
| ''SM Choukyoushi Hitomi - Bangai Hen'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x03801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2 Remix'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x018058</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1) || <tt>0x0DF0</tt>, relative to <tt>0x0D30</tt> || <tt>0x018076</tt>
|-
| ''Wheel of Fortune - Deluxe Edition'' ''(unused)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01D842</tt>
|}
Of the games listed here, three of them are very minor edits...
* ''Hong Kong '97'' has a typo in the ESA DSP register setup due to using register ID $FE instead of $6D that is not present in the others.
* ''Wheel of Fortune - Deluxe Edition'''s build is unused and is missing an opcode near the *Ver S1.20* string. In addition, that section is actually unused, because instead new code at $0700 is used to substitute for this one... which happens to be an exact match to the original IPL Boot ROM.
* ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1)'s program starts with a JMP opcode, and contains a NOP between the first and second opcodes of the actual program.

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

==Communication with the SNES==
NOTE: This is not representative of every single variant. Instead, it represents the collection of commands from the source code included in the IS-Sound unit, which in turn may be carried over to most variants.

The only register that is used for communication in the source build is $2140 (SNES side)/$F4 (SPC side), except for the load command. Other registers are not even read from, though the code itself sets up the framework to do so.

===Output to the SNES===
<pre>xx ?? ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.

===Command IDs===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

===Stop Music (Command <tt>$00</tt>)===
Initializes an invalid phrase pointer, then stops the previous piece of music. This is not compatible with the resume command, as it is irrevocable, unlike the other one.

===Play Music (Command <tt>$01-??</tt>)===
Stops a previous piece of music, then plays a piece of music by the ID specified in the command.

===Pause Music (Command <tt>$F0</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$F1</tt>)===
Resumes a paused song.

===Load New Data (Command <tt>$FF</tt>)===
Jumps to a modified copy of the IPL Boot ROM (except for Wheel of Fortune - Deluxe Edition, where there is an opcode missing, the jump location is different, and it contains an exact copy of the IPL Boot ROM).

''TODO Loading New Data (the loading protocol is nearly identical to IPL Boot ROM, with a couple of differences)''

==Instrument Format==
The instrument format is most commonly defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this....
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>%x</tt> is a [[S-DSP/Noise|noise clock]] switch.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is a fractional pitch base multiplier, defined in 256ths.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>$80 $00</tt> || Fast Forward On ||
|-
|<tt>$81 $00</tt> || Fast Forward Off ||
|-
|<tt>%1??????? $00</tt> <tt>$82-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$00 $01-$7F</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Fast Forward On (Command <tt>$00 $80</tt>)===
<pre>$80 $00</pre>
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (Command <tt>$00 $81</tt>)===
<pre>$81 $00</pre>
Disables Fast Forward and continues playing the song normally.

===Always Jump (Command <tt>$00 $82-$FF</tt>)===
<pre>%1??????? $00 xx xx</pre>
Only executes if the fast forward commands are not triggered.
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
NOTE: This is not representative of every single variant. Instead, it represents the collection of VCMDs from the source code included in the IS-Sound unit, which in turn is carried over to most variants.

{{N-SPC VCMD Set Table}}

===Invalid (VCMD <tt>$FF</tt>)===
Crashes the sound driver due to being outside of the array of pointers, and thus jumping to an invalid pointer.

===NOP (VCMD <tt>$FB</tt>)===
<pre>$FB ?? ??</pre>
Reads two bytes, then does absolutely nothing with the command.

===Phrase Termination/End of Subroutine (VCMD <tt>$00</tt>)===
This VCMD's operation depends on whether or not it is inside a subroutine or not.
If it is inside a subroutine, it exits the subroutine and song execution continues.
Otherwise, the phrase is terminated. This affects ''all'' channels in the music: any other channels still playing are interrupted.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (%0yyyzzzz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>%yyy</tt>, if the highest bit of the byte is not set, defines the quantization. It is an index value to a table of values that indicate, in 256ths, how far along the note to play before keying it off. This table can vary on a per-game basis.
* <tt>%zzzz</tt>, which is only defined if the highest bit of the byte is not set, defines the velocity. It is an index to a table of values that indicate the volume in a decibel-like number (due to the final volume calculation being multiplied by itself at the end). This table can vary on a per-game basis.

Notes and/or special VCMDs, by default, are forced after the parameter byte is read. Attempting to use <tt>$00-$7F</tt> again results in an invalid note.

===Note (VCMD <tt>$80-$C7</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Tie (VCMD <tt>$C8</tt>)===
Continues playing the previous note and delays the channel for one note length before reading another VCMD.

===Rest (VCMD <tt>$C9</tt>)===
Keys off the previous note and delays the channel for one note length before reading another VCMD.

===Percussion (VCMD <tt>$CA-$DF</tt>)===
Plays a percussion note.

By default, percussion uses the same instrument set as the song, and all percussion is keyed on with a note of <tt>$A4</tt>.
The starting ID to use for all channels can be redefined by VCMD <tt>$FA</tt>.

===Instrument (VCMD <tt>$E0</tt>)===
<pre>$E0 xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Panning (VCMD <tt>$E1</tt>)===
<pre>$E1 %xy?zzzzz</pre>
* <tt>%x</tt> defines a phase inversion switch for the left channel.
* <tt>%y</tt> defines a phase inversion switch for the right channel.
* <tt>%zzzzz</tt> is five bits for the panning. This refers to an array of values to multiply the volume by after calculating the voice volume via various other parameters set by the VCMDs. Under normal circumstances, center is defined as <tt>$0A</tt> and the maximum value is <tt>$14</tt>.

===Panning Fade (VCMD <tt>$E2</tt>)===
<pre>$E2 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target pan value. Phase inversion is ''not'' taken into account here, thus only the low five bits should be used here.

===Vibrato On (VCMD <tt>$E3</tt>)===
<pre>$E3 xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the vibrato for.
* <tt>yy</tt> is the rate of the vibrato: specifically, how much to change the pitch on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the vibrato: that is, the maximum pitch offset to use. <tt>$00-$F0</tt> are normal, but <tt>$F1</tt> and up act more like said value ANDed by <tt>$0F</tt> and multiplied by <tt>$0100</tt>, meaning the highest values have drastic differences compared to the lower ones.

===Vibrato Off (VCMD <tt>$E4</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Song Volume (VCMD <tt>$E5</tt>)===
<pre>$E5 xx</pre>
* <tt>xx</tt> is the song volume value. This sets the volume for all of the channels in the song. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Song Volume Fade (VCMD <tt>$E6</tt>)===
<pre>$E6 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target song volume.

===Tempo (VCMD <tt>$E7</tt>)===
<pre>$E7 xx</pre>
* <tt>xx</tt> defines one tempo tick as one timer 0 tick multiplied by <math>\frac{256}{x}</math>. Zero freezes the song.

===Tempo Fade (VCMD <tt>$E8</tt>)===
<pre>$E8 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target tempo.

===Global Absolute Transposition (VCMD <tt>$E9</tt>)===
<pre>$E9 xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes. Note that this affects all channels, not just one channel.

===Single Channel Absolute Transposition (VCMD <tt>$EA</tt>)===
<pre>$EA xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes.

===Tremolo On (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the tremolo for.
* <tt>yy</tt> is the rate of the tremolo: specifically, how much to change the volume on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the tremolo: that is, the maximum volume offset to use.

===Tremolo Off (VCMD <tt>$EC</tt>)===
Disables tremolo set by VCMD <tt>$EB</tt>.

===Volume (VCMD <tt>$ED</tt>)===
<pre>$ED xx</pre>
* <tt>xx</tt> is the volume value. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Volume Fade (VCMD <tt>$EE</tt>)===
<pre>$EE xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target volume.

===Subroutine (VCMD <tt>$EF</tt>)===
<pre>$EF xx xx yy</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer containing the section of music to play.
* <tt>yy</tt> is the number of times to loop the sub-routine.

===Vibrato Fade In (VCMD <tt>$F0</tt>)===
<pre>$F0 xx</pre>
* <tt>xx</tt> is the number of tempo ticks to fade the vibrato for.
The moment this VCMD is executed, the depth is faded in from zero.

===Note Pitch Envelope To (VCMD <tt>$F1</tt>)===
<pre>$F1 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note to.

===Note Pitch Envelope From (VCMD <tt>$F2</tt>)===
<pre>$F2 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note from: that is, unlike Note Pitch Envelope To (VCMD <tt>$F1</tt>), this is a starting note offset, rather than an end of pitch envelope note offset.

===Note Pitch Envelope Off (VCMD <tt>$F3</tt>)===
Disables a pitch envelope.

===Fine Tune (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines the amount to shift the pitch up. This is in 256ths of a semitone, albeit done via measuring the distance between note and multiplying it by this value.

===Echo Enable Bits and Volume (VCMD <tt>$F5</tt>)===
<pre>$F5 %xxxxxxxx yy zz</pre>
* <tt>%xxxxxxxx</tt> defines the channels to turn on for the echo (one per bit), which translates to a direct write to the EON DSP register.
* <tt>yy</tt> defines a value for EVOLL DSP register.
* <tt>zz</tt> defines a value for EVOLR DSP register.

===Echo Off (VCMD <tt>$F6</tt>)===
This disables echo for ''all'' channels, as well as zeroing out the echo volume and disabling echo writes.

===Echo Parameter Setup (VCMD <tt>$F7</tt>)===
<pre>$F7 xx yy zz</pre>
* <tt>xx</tt> defines a value for the EDL DSP register.
* <tt>yy</tt> defines a value for the EFB DSP register.
* <tt>zz</tt> defines an ID to an array of FIR coefficient values.

===Echo Volume Fade (VCMD <tt>$F8</tt>)===
<pre>$F8 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> defines the target value for EVOLL DSP register.
* <tt>zz</tt> defines the target value for EVOLR DSP register.

===Pitch Slide To Note (VCMD <tt>$F9</tt>)===
<pre>$F9 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to delay the slide for.
* <tt>yy</tt> defines the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is the target note.

===Percussion Base Instrument ID Redefine (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is the starting instrument ID. Note that this affects all channels.

===Channel Mute (VCMD <tt>$FC</tt>)===
Causes the channel to not key on subsequent notes.

===Fast Forward On (VCMD <tt>$FD</tt>)===
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (VCMD <tt>$FE</tt>)===
Disables Fast Forward and continues playing the song normally.

==Variants==
===Shijou Saikyou no Quiz Ou Ketteisen Super===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Shijou Saikyou no Quiz Ou Ketteisen Super'' || <tt>0x0DF7</tt>, relative to <tt>0x0D37</tt> || <tt>0x038062</tt>/<tt>0x04805C</tt>/<tt>0x058062</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

This is the closest match to a standard source N-SPC/Kankichi build used in a licensed game. This is because the only modifications made to it are to echo what was sent to any register to $2141/$F5 (although in practice only $2140/$F4 is read from, thus de facto giving it the same output, otherwise it would be cycling between the last register read code-wise as output) and zero out both $2140/$F4 and $2141/$F5 when the song is done playing when a zero pointer is read from a phase.

====Output to the SNES====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.
* <tt>yy</tt> is a de-facto mirror of <tt>xx</tt> output-wise. The feedback is a little faster, though, since the output is immediately upon $2140/$F4 being read, rather than when the music is initialized.

===Controller Test/World Class Service Super Nintendo Tester===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Controller Test || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x009319</tt> (Controller Test Cassette) <tt>0x00BFFF</tt> (SNES Burn-In Test Cartridge) <tt>0x00D8D2</tt> (World Class Service Super Nintendo Tester ''(not used)'')
|-
| World Class Service Super Nintendo Tester ''(only build used across all tests)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0B8068</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

These two sound driver builds (the one for the controller test being found in three different known testing cartridges, with one of them not used) merely have code optimizations in their sound code, thus making them completely identical execution-wise to the source build variant. In addition, the build used for World Class Service Super Nintendo Tester adds a BMI opcode in a readahead routine, but is otherwise identical.

===Subpages===
{{Subpages}}

Not created yet...
* [[N-SPC Engine/64WD Creation|64WD Creation]]
* [[N-SPC Engine/Advance Communication|Advance Communication]]
* [[N-SPC Engine/Aisystem Tokyo|Aisystem Tokyo]]
* [[N-SPC Engine/Argonaut|Argonaut]]
* [[N-SPC Engine/Axes Art Amuse|Axes Art Amuse]]
* [[N-SPC Engine/Bit Managers|Bit Managers]]
* [[N-SPC Engine/Capcom|Capcom]]
* [[N-SPC Engine/Chatnoir|Chatnoir]]
* [[N-SPC Engine/Chip Level Designs|Chip Level Designs]]
* [[N-SPC Engine/CP.BRAiN|CP.BRAiN]]
* [[N-SPC Engine/Cream|Cream]]
* [[N-SPC Engine/Crosstalk|Crosstalk]]
* [[N-SPC Engine/Cube|Cube]]
* [[N-SPC Engine/CUE|CUE]]
* [[N-SPC Engine/Culture Brain|Culture Brain]]
* [[N-SPC Engine/Daft|Daft]]
* [[N-SPC Engine/Data East|Data East]]
* [[N-SPC Engine/EJ Corporation|EJ Corporation]]
* [[N-SPC Engine/Electronic Arts|Electronic Arts]]
* [[N-SPC Engine/Falcom|Falcom]]
* [[N-SPC Engine/Funcom|Funcom]]
* [[N-SPC Engine/Gremlin|Gremlin]]
* [[N-SPC Engine/HAL|HAL]]
* [[N-SPC Engine/Hanari Exp|Hanari Exp]]
* [[N-SPC Engine/Hect|Hect]]
* [[N-SPC Engine/Hikoshi Hashimoto|Hikoshi Hashimoto]]
* [[N-SPC Engine/Home Data|Home Data]]
* [[N-SPC Engine/Human (earlier)|Human (earlier)]]
* [[N-SPC Engine/Human|Human]]
* [[N-SPC Engine/Imagesoft|Imagesoft]]
* [[N-SPC Engine/Infogrames|Infogrames]]
* [[N-SPC Engine/Intelligent Systems|Intelligent Systems]]
* [[N-SPC Engine/Japan Art Media|Japan Art Media]]
* [[N-SPC Engine/Jorudan|Jorudan]]
* [[N-SPC Engine/Kazuo Sawa|Kazuo Sawa]]
* [[N-SPC Engine/Kennosuke Suemura|Kennosuke Suemura]]
* [[N-SPC Engine/Khaos|Khaos]]
* [[N-SPC Engine/Koei|Koei]]
* [[N-SPC Engine/Konami|Konami]]
* [[N-SPC Engine/LaserSoft|LaserSoft]]
* [[N-SPC Engine/Make Software|Make Software]]
* [[N-SPC Engine/Metro|Metro]]
* [[N-SPC Engine/Mitsuhito Tanaka|Mitsuhito Tanaka]]
* [[N-SPC Engine/Monolith|Monolith]]
* [[N-SPC Engine/MSQ|MSQ]]
* [[N-SPC Engine/Namco|Namco]]
* [[N-SPC Engine/Naohisa Morota|Naohisa Morota]]
* [[N-SPC Engine/Natsume|Natsume]]
* [[N-SPC Engine/Nichibutsu or Make Software|Nichibutsu/Make Software]] (NOTE: Refers to three of the Super Nichibutsu Mahjong games)
* [[N-SPC Engine/Nova|Nova]]
* [[N-SPC Engine/Ocean|Ocean]]
* [[N-SPC Engine/Pure Sound|Pure Sound]]
* [[N-SPC Engine/Quest|Quest]]
* [[N-SPC Engine/Quintet|Quintet]]
* [[N-SPC Engine/Robert C. Ashworth|Robert C. Ashworth]]
* [[N-SPC Engine/Sakata SAS|Sakata SAS]]
* [[N-SPC Engine/Saurus|Saurus]]
* [[N-SPC Engine/Sunsoft|Sunsoft]]
* [[N-SPC Engine/Syscom|Syscom]]
* [[N-SPC Engine/System Sacom|System Sacom]]
* [[N-SPC Engine/Systemsoft|Systemsoft]]
* [[N-SPC Engine/T's Music|T's Music]]
* [[N-SPC Engine/TamTam|TamTam]]
* [[N-SPC Engine/Team X-Fade|Team X-Fade]]
* [[N-SPC Engine/Technos Japan|Technos Japan]]
* [[N-SPC Engine/Technosoft|Technosoft]]
* [[N-SPC Engine/Tecmo|Tecmo]]
* [[N-SPC Engine/Tose|Tose]]
* [[N-SPC Engine/Tsukasa Masuko|Tsukasa Masuko]]
* [[N-SPC Engine/Virgin|Virgin]]
* [[N-SPC Engine/Wave|Wave]]
* [[N-SPC Engine/Yoshikazu Yao|Yoshikazu Yao]]
* [[N-SPC Engine/Yoshiyuki Ishii|Yoshiyuki Ishii]]

''TODO: There are a lot of variants... these will be split into sub-pages depending on the modifications made''

==References==
* [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun Video Game Music Preservation Foundation - Kankichi-kun]
* [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system Retro Reversing - SNES (Super Famicom) Development Kit Hardware - Intelligent Systems SHVC Development System]
* [https://wiki.superfamicom.org/nintendo-music-format-(n-spc) Super Famicom Wiki - N-SPC]
* [http://gdri.smspower.org/wiki/index.php/Super_Famicom/Super_NES_Sound_Driver_List GDRI - Super Famicom/Super NES Sound Driver List]
* [https://github.com/vgmtrans/vgmtrans/issues/173 Github - N-SPC VCMD $FB-$FE identifications]
* [https://archive.org/details/GameBoyProgManVer1.1/page/n187/mode/2up Game Boy Development Manual - Super Game Boy Sound] (see pages 187-213)

[[Category:SPC Sound Engines]]

N-SPC Engine/Nintendo/Sound Module and Burn-In Test

2024-01-09T03:11:58Z

KungFuFurby: Adding a stub marker citing the under construction nature of this page.

Go back to [[N-SPC Engine/Nintendo]]

{{stub}}

'''Sound Module and Burn-In Test''' refers to a unique N-SPC/Kankichi-kun build created for testing the SPC700 hardware used in at least two different test cartridges.

__TOC__

{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Aging Cassette/Sound Module and Burn-In Test || <tt>0x0EE9</tt>, relative to <tt>0x0E29</tt> || <tt>0x0380BA</tt> (Aging Cassette) <tt>0x038792</tt> (SNES Burn-In Test Cartridge)
|}

The raw build sorting notes can be found [[N-SPC Engine/Nintendo/Build Sorting|here]] for all variants by Nintendo.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || Phrase Termination/End of Subroutine ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>(xy)</tt>
|-
|<tt>$80-$C7</tt> || Note ||
|-
|<tt>$C8</tt> || Tie ||
|-
|<tt>$C9</tt> || Rest ||
|-
|<tt>$CA-$DD</tt> || Percussion ||
|-
|<tt>$DE</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$DF</tt> || Panning || <tt>%xyzzzzz</tt>
|-
|<tt>$E0</tt> || Panning Fade || <tt>xx yy</tt>
|-
|<tt>$E1</tt> || Vibrato On || <tt>xx yy zz</tt>
|-
|<tt>$E2</tt> || Vibrato Off ||
|-
|<tt>$E3</tt> || Song Volume || <tt>xx</tt>
|-
|<tt>$E4</tt> || Song Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$E5</tt> || Tempo || <tt>xx</tt>
|-
|<tt>$E6</tt> || Tempo Fade || <tt>xx yy</tt>
|-
|<tt>$E7</tt> || Global Absolute Transposition || <tt>xx</tt>
|-
|<tt>$E8</tt> || Single Channel Absolute Transposition || <tt>xx</tt>
|-
|<tt>$E9</tt> || Tremolo On || <tt>xx yy zz</tt>
|-
|<tt>$EA</tt> || Tremolo Off ||
|-
|<tt>$EB</tt> || Volume || <tt>xx</tt>
|-
|<tt>$EC</tt> || Volume Fade || <tt>xx yy</tt>
|-
|<tt>$ED</tt> || Subroutine || <tt>xx xx yy</tt>
|-
|<tt>$EE</tt> || Vibrato Fade In || <tt>xx</tt>
|-
|<tt>$EF</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$F0</tt> || Note Pitch Envelope From || <tt>xx yy zz</tt>
|-
|<tt>$F1</tt> || Note Pitch Envelope Off ||
|-
|<tt>$F2</tt> || Fine Tune || <tt>xx</tt>
|-
|<tt>$F3</tt> || Echo On Bits and Volume || <tt>%xxxxxxxx yy zz</tt>
|-
|<tt>$F4</tt> || Echo Off ||
|-
|<tt>$F5</tt> || Echo Parameter Setup || <tt>xx yy zz</tt>
|-
|<tt>$F6</tt> || Echo Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$F7</tt> || Pitch Slide to Note || <tt>xx yy zz</tt>
|-
|<tt>$F8</tt> || Percussion Patch Base Redefine || <tt>xx</tt>
|-
|<tt>$F9</tt> || NOP || <tt>??</tt>
|-
|<tt>$FA</tt> || Channel Mute ||
|-
|<tt>$FB</tt> || Fast Forward On ||
|-
|<tt>$FC</tt> || Fast Forward Off ||
|-
|<tt>$FD</tt> || Main Volume Fade || xx yy
|-
|<tt>$FE</tt> || Mute Right Main Volume || xx
|-
|<tt>$FF</tt> || Noise Clock || %???xxxxx
|}
''TODO use template for the above table for standard VCMDs''

''TODO VCMD documentation via templating''

''TODO new music VCMDs (the standard set is offset backwards by two IDs, and three new VCMDs are added on)''

==Communication with the SNES==
All of the commands used are identical to the source N-SPC/Kankichi set with a set of new commands

{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$80</tt> || Run All Tests || <tt>$80 ?? ?? ??</tt>
|-
|<tt>$90</tt> || Memory Write Test || <tt>$90 ?? ?? ??</tt>
|-
|<tt>$91</tt> || ''TODO identify test'' || <tt>$91 ?? ?? ??</tt>
|-
|<tt>$92</tt> || ''TODO identify test'' || <tt>$92 ?? ?? ??</tt>
|-
|<tt>$93</tt> || ''TODO identify test'' || <tt>$93 ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}
''TODO new commands''

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

N-SPC Engine

2024-01-09T03:10:57Z

KungFuFurby: Corrected an error on bit notes for Panning

__TOC__

'''Nintendo SPC Sound Engine''', abbreviated N-SPC and officially known as Kankichi-kun [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun], is the most common sound engine used in all of the SNES/SFC games. Only the music portion was initially provided in the source code included in the IS-Sound unit along with some templating for a protocol for music and sound effects [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system]: usually it was modified by developers on an individual basis, resulting in many different variants, some of them more heavily modifying the sound driver than others. Usually what was added on was sound effect support, but sometimes the music VCMDs were modified as well.

The following games are purely based off of the source code provided with the IS-Sound unit, and are either unmodified or barely modified, if at all:
{| class="wikitable sortable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Hong Kong '97'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0F800A</tt> (both versions)
|-
| ''SM Choukyoushi Hitomi - Bangai Hen'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x03801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2 Remix'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x018058</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1) || <tt>0x0DF0</tt>, relative to <tt>0x0D30</tt> || <tt>0x018076</tt>
|-
| ''Wheel of Fortune - Deluxe Edition'' ''(unused)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01D842</tt>
|}
Of the games listed here, two of them are very minor edits...
* ''Wheel of Fortune - Deluxe Edition'''s build is unused and is missing an opcode near the *Ver S1.20* string. In addition, that section is actually unused, because instead new code at $0700 is used to substitute for this one... which happens to be an exact match to the original IPL Boot ROM.
* ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1)'s program starts with a JMP opcode, and contains a NOP between the first and second opcodes of the actual program.

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

==Communication with the SNES==
NOTE: This is not representative of every single variant. Instead, it represents the collection of commands from the source code included in the IS-Sound unit, which in turn may be carried over to most variants.

The only register that is used for communication in the source build is $2140 (SNES side)/$F4 (SPC side), except for the load command. Other registers are not even read from, though the code itself sets up the framework to do so.

===Output to the SNES===
<pre>xx ?? ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.

===Command IDs===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

===Stop Music (Command <tt>$00</tt>)===
Initializes an invalid phrase pointer, then stops the previous piece of music. This is not compatible with the resume command, as it is irrevocable, unlike the other one.

===Play Music (Command <tt>$01-??</tt>)===
Stops a previous piece of music, then plays a piece of music by the ID specified in the command.

===Pause Music (Command <tt>$F0</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$F1</tt>)===
Resumes a paused song.

===Load New Data (Command <tt>$FF</tt>)===
Jumps to a modified copy of the IPL Boot ROM (except for Wheel of Fortune - Deluxe Edition, where there is an opcode missing, the jump location is different, and it contains an exact copy of the IPL Boot ROM).

''TODO Loading New Data (the loading protocol is nearly identical to IPL Boot ROM, with a couple of differences)''

==Instrument Format==
The instrument format is most commonly defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this....
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>%x</tt> is a [[S-DSP/Noise|noise clock]] switch.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is a fractional pitch base multiplier, defined in 256ths.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>$80 $00</tt> || Fast Forward On ||
|-
|<tt>$81 $00</tt> || Fast Forward Off ||
|-
|<tt>%1??????? $00</tt> <tt>$82-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$00 $01-$7F</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Fast Forward On (Command <tt>$00 $80</tt>)===
<pre>$80 $00</pre>
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (Command <tt>$00 $81</tt>)===
<pre>$81 $00</pre>
Disables Fast Forward and continues playing the song normally.

===Always Jump (Command <tt>$00 $82-$FF</tt>)===
<pre>%1??????? $00 xx xx</pre>
Only executes if the fast forward commands are not triggered.
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
NOTE: This is not representative of every single variant. Instead, it represents the collection of VCMDs from the source code included in the IS-Sound unit, which in turn is carried over to most variants.

{{N-SPC VCMD Set Table}}

===Invalid (VCMD <tt>$FF</tt>)===
Crashes the sound driver due to being outside of the array of pointers, and thus jumping to an invalid pointer.

===NOP (VCMD <tt>$FB</tt>)===
<pre>$FB ?? ??</pre>
Reads two bytes, then does absolutely nothing with the command.

===Phrase Termination/End of Subroutine (VCMD <tt>$00</tt>)===
This VCMD's operation depends on whether or not it is inside a subroutine or not.
If it is inside a subroutine, it exits the subroutine and song execution continues.
Otherwise, the phrase is terminated. This affects ''all'' channels in the music: any other channels still playing are interrupted.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (%0yyyzzzz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>%yyy</tt>, if the highest bit of the byte is not set, defines the quantization. It is an index value to a table of values that indicate, in 256ths, how far along the note to play before keying it off. This table can vary on a per-game basis.
* <tt>%zzzz</tt>, which is only defined if the highest bit of the byte is not set, defines the velocity. It is an index to a table of values that indicate the volume in a decibel-like number (due to the final volume calculation being multiplied by itself at the end). This table can vary on a per-game basis.

Notes and/or special VCMDs, by default, are forced after the parameter byte is read. Attempting to use <tt>$00-$7F</tt> again results in an invalid note.

===Note (VCMD <tt>$80-$C7</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Tie (VCMD <tt>$C8</tt>)===
Continues playing the previous note and delays the channel for one note length before reading another VCMD.

===Rest (VCMD <tt>$C9</tt>)===
Keys off the previous note and delays the channel for one note length before reading another VCMD.

===Percussion (VCMD <tt>$CA-$DF</tt>)===
Plays a percussion note.

By default, percussion uses the same instrument set as the song, and all percussion is keyed on with a note of <tt>$A4</tt>.
The starting ID to use for all channels can be redefined by VCMD <tt>$FA</tt>.

===Instrument (VCMD <tt>$E0</tt>)===
<pre>$E0 xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Panning (VCMD <tt>$E1</tt>)===
<pre>$E1 %xy?zzzzz</pre>
* <tt>%x</tt> defines a phase inversion switch for the left channel.
* <tt>%y</tt> defines a phase inversion switch for the right channel.
* <tt>%zzzzz</tt> is five bits for the panning. This refers to an array of values to multiply the volume by after calculating the voice volume via various other parameters set by the VCMDs. Under normal circumstances, center is defined as <tt>$0A</tt> and the maximum value is <tt>$14</tt>.

===Panning Fade (VCMD <tt>$E2</tt>)===
<pre>$E2 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target pan value. Phase inversion is ''not'' taken into account here, thus only the low five bits should be used here.

===Vibrato On (VCMD <tt>$E3</tt>)===
<pre>$E3 xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the vibrato for.
* <tt>yy</tt> is the rate of the vibrato: specifically, how much to change the pitch on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the vibrato: that is, the maximum pitch offset to use. <tt>$00-$F0</tt> are normal, but <tt>$F1</tt> and up act more like said value ANDed by <tt>$0F</tt> and multiplied by <tt>$0100</tt>, meaning the highest values have drastic differences compared to the lower ones.

===Vibrato Off (VCMD <tt>$E4</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Song Volume (VCMD <tt>$E5</tt>)===
<pre>$E5 xx</pre>
* <tt>xx</tt> is the song volume value. This sets the volume for all of the channels in the song. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Song Volume Fade (VCMD <tt>$E6</tt>)===
<pre>$E6 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target song volume.

===Tempo (VCMD <tt>$E7</tt>)===
<pre>$E7 xx</pre>
* <tt>xx</tt> defines one tempo tick as one timer 0 tick multiplied by <math>\frac{256}{x}</math>. Zero freezes the song.

===Tempo Fade (VCMD <tt>$E8</tt>)===
<pre>$E8 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target tempo.

===Global Absolute Transposition (VCMD <tt>$E9</tt>)===
<pre>$E9 xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes. Note that this affects all channels, not just one channel.

===Single Channel Absolute Transposition (VCMD <tt>$EA</tt>)===
<pre>$EA xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes.

===Tremolo On (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the tremolo for.
* <tt>yy</tt> is the rate of the tremolo: specifically, how much to change the volume on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the tremolo: that is, the maximum volume offset to use.

===Tremolo Off (VCMD <tt>$EC</tt>)===
Disables tremolo set by VCMD <tt>$EB</tt>.

===Volume (VCMD <tt>$ED</tt>)===
<pre>$ED xx</pre>
* <tt>xx</tt> is the volume value. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Volume Fade (VCMD <tt>$EE</tt>)===
<pre>$EE xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target volume.

===Subroutine (VCMD <tt>$EF</tt>)===
<pre>$EF xx xx yy</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer containing the section of music to play.
* <tt>yy</tt> is the number of times to loop the sub-routine.

===Vibrato Fade In (VCMD <tt>$F0</tt>)===
<pre>$F0 xx</pre>
* <tt>xx</tt> is the number of tempo ticks to fade the vibrato for.
The moment this VCMD is executed, the depth is faded in from zero.

===Note Pitch Envelope To (VCMD <tt>$F1</tt>)===
<pre>$F1 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note to.

===Note Pitch Envelope From (VCMD <tt>$F2</tt>)===
<pre>$F2 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note from: that is, unlike Note Pitch Envelope To (VCMD <tt>$F1</tt>), this is a starting note offset, rather than an end of pitch envelope note offset.

===Note Pitch Envelope Off (VCMD <tt>$F3</tt>)===
Disables a pitch envelope.

===Fine Tune (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines the amount to shift the pitch up. This is in 256ths of a semitone, albeit done via measuring the distance between note and multiplying it by this value.

===Echo Enable Bits and Volume (VCMD <tt>$F5</tt>)===
<pre>$F5 %xxxxxxxx yy zz</pre>
* <tt>%xxxxxxxx</tt> defines the channels to turn on for the echo (one per bit), which translates to a direct write to the EON DSP register.
* <tt>yy</tt> defines a value for EVOLL DSP register.
* <tt>zz</tt> defines a value for EVOLR DSP register.

===Echo Off (VCMD <tt>$F6</tt>)===
This disables echo for ''all'' channels, as well as zeroing out the echo volume and disabling echo writes.

===Echo Parameter Setup (VCMD <tt>$F7</tt>)===
<pre>$F7 xx yy zz</pre>
* <tt>xx</tt> defines a value for the EDL DSP register.
* <tt>yy</tt> defines a value for the EFB DSP register.
* <tt>zz</tt> defines an ID to an array of FIR coefficient values.

===Echo Volume Fade (VCMD <tt>$F8</tt>)===
<pre>$F8 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> defines the target value for EVOLL DSP register.
* <tt>zz</tt> defines the target value for EVOLR DSP register.

===Pitch Slide To Note (VCMD <tt>$F9</tt>)===
<pre>$F9 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to delay the slide for.
* <tt>yy</tt> defines the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is the target note.

===Percussion Base Instrument ID Redefine (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is the starting instrument ID. Note that this affects all channels.

===Channel Mute (VCMD <tt>$FC</tt>)===
Causes the channel to not key on subsequent notes.

===Fast Forward On (VCMD <tt>$FD</tt>)===
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (VCMD <tt>$FE</tt>)===
Disables Fast Forward and continues playing the song normally.

==Variants==
===Shijou Saikyou no Quiz Ou Ketteisen Super===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Shijou Saikyou no Quiz Ou Ketteisen Super'' || <tt>0x0DF7</tt>, relative to <tt>0x0D37</tt> || <tt>0x038062</tt>/<tt>0x04805C</tt>/<tt>0x058062</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

This is the closest match to a standard source N-SPC/Kankichi build used in a licensed game. This is because the only modifications made to it are to echo what was sent to any register to $2141/$F5 (although in practice only $2140/$F4 is read from, thus de facto giving it the same output, otherwise it would be cycling between the last register read code-wise as output) and zero out both $2140/$F4 and $2141/$F5 when the song is done playing when a zero pointer is read from a phase.

====Output to the SNES====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.
* <tt>yy</tt> is a de-facto mirror of <tt>xx</tt> output-wise. The feedback is a little faster, though, since the output is immediately upon $2140/$F4 being read, rather than when the music is initialized.

===Controller Test/World Class Service Super Nintendo Tester===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Controller Test || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x009319</tt> (Controller Test Cassette) <tt>0x00BFFF</tt> (SNES Burn-In Test Cartridge) <tt>0x00D8D2</tt> (World Class Service Super Nintendo Tester ''(not used)'')
|-
| World Class Service Super Nintendo Tester ''(only build used across all tests)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0B8068</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

These two sound driver builds (the one for the controller test being found in three different known testing cartridges, with one of them not used) merely have code optimizations in their sound code, thus making them completely identical execution-wise to the source build variant. In addition, the build used for World Class Service Super Nintendo Tester adds a BMI opcode in a readahead routine, but is otherwise identical.

===Subpages===
{{Subpages}}

Not created yet...
* [[N-SPC Engine/64WD Creation|64WD Creation]]
* [[N-SPC Engine/Advance Communication|Advance Communication]]
* [[N-SPC Engine/Aisystem Tokyo|Aisystem Tokyo]]
* [[N-SPC Engine/Argonaut|Argonaut]]
* [[N-SPC Engine/Axes Art Amuse|Axes Art Amuse]]
* [[N-SPC Engine/Bit Managers|Bit Managers]]
* [[N-SPC Engine/Capcom|Capcom]]
* [[N-SPC Engine/Chatnoir|Chatnoir]]
* [[N-SPC Engine/Chip Level Designs|Chip Level Designs]]
* [[N-SPC Engine/CP.BRAiN|CP.BRAiN]]
* [[N-SPC Engine/Cream|Cream]]
* [[N-SPC Engine/Crosstalk|Crosstalk]]
* [[N-SPC Engine/Cube|Cube]]
* [[N-SPC Engine/CUE|CUE]]
* [[N-SPC Engine/Culture Brain|Culture Brain]]
* [[N-SPC Engine/Daft|Daft]]
* [[N-SPC Engine/Data East|Data East]]
* [[N-SPC Engine/EJ Corporation|EJ Corporation]]
* [[N-SPC Engine/Electronic Arts|Electronic Arts]]
* [[N-SPC Engine/Falcom|Falcom]]
* [[N-SPC Engine/Funcom|Funcom]]
* [[N-SPC Engine/Gremlin|Gremlin]]
* [[N-SPC Engine/HAL|HAL]]
* [[N-SPC Engine/Hanari Exp|Hanari Exp]]
* [[N-SPC Engine/Hect|Hect]]
* [[N-SPC Engine/Hikoshi Hashimoto|Hikoshi Hashimoto]]
* [[N-SPC Engine/Home Data|Home Data]]
* [[N-SPC Engine/Human (earlier)|Human (earlier)]]
* [[N-SPC Engine/Human|Human]]
* [[N-SPC Engine/Imagesoft|Imagesoft]]
* [[N-SPC Engine/Infogrames|Infogrames]]
* [[N-SPC Engine/Intelligent Systems|Intelligent Systems]]
* [[N-SPC Engine/Japan Art Media|Japan Art Media]]
* [[N-SPC Engine/Jorudan|Jorudan]]
* [[N-SPC Engine/Kazuo Sawa|Kazuo Sawa]]
* [[N-SPC Engine/Kennosuke Suemura|Kennosuke Suemura]]
* [[N-SPC Engine/Khaos|Khaos]]
* [[N-SPC Engine/Koei|Koei]]
* [[N-SPC Engine/Konami|Konami]]
* [[N-SPC Engine/LaserSoft|LaserSoft]]
* [[N-SPC Engine/Make Software|Make Software]]
* [[N-SPC Engine/Metro|Metro]]
* [[N-SPC Engine/Mitsuhito Tanaka|Mitsuhito Tanaka]]
* [[N-SPC Engine/Monolith|Monolith]]
* [[N-SPC Engine/MSQ|MSQ]]
* [[N-SPC Engine/Namco|Namco]]
* [[N-SPC Engine/Naohisa Morota|Naohisa Morota]]
* [[N-SPC Engine/Natsume|Natsume]]
* [[N-SPC Engine/Nichibutsu or Make Software|Nichibutsu/Make Software]] (NOTE: Refers to three of the Super Nichibutsu Mahjong games)
* [[N-SPC Engine/Nova|Nova]]
* [[N-SPC Engine/Ocean|Ocean]]
* [[N-SPC Engine/Pure Sound|Pure Sound]]
* [[N-SPC Engine/Quest|Quest]]
* [[N-SPC Engine/Quintet|Quintet]]
* [[N-SPC Engine/Robert C. Ashworth|Robert C. Ashworth]]
* [[N-SPC Engine/Sakata SAS|Sakata SAS]]
* [[N-SPC Engine/Saurus|Saurus]]
* [[N-SPC Engine/Sunsoft|Sunsoft]]
* [[N-SPC Engine/Syscom|Syscom]]
* [[N-SPC Engine/System Sacom|System Sacom]]
* [[N-SPC Engine/Systemsoft|Systemsoft]]
* [[N-SPC Engine/T's Music|T's Music]]
* [[N-SPC Engine/TamTam|TamTam]]
* [[N-SPC Engine/Team X-Fade|Team X-Fade]]
* [[N-SPC Engine/Technos Japan|Technos Japan]]
* [[N-SPC Engine/Technosoft|Technosoft]]
* [[N-SPC Engine/Tecmo|Tecmo]]
* [[N-SPC Engine/Tose|Tose]]
* [[N-SPC Engine/Tsukasa Masuko|Tsukasa Masuko]]
* [[N-SPC Engine/Virgin|Virgin]]
* [[N-SPC Engine/Wave|Wave]]
* [[N-SPC Engine/Yoshikazu Yao|Yoshikazu Yao]]
* [[N-SPC Engine/Yoshiyuki Ishii|Yoshiyuki Ishii]]

''TODO: There are a lot of variants... these will be split into sub-pages depending on the modifications made''

==References==
* [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun Video Game Music Preservation Foundation - Kankichi-kun]
* [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system Retro Reversing - SNES (Super Famicom) Development Kit Hardware - Intelligent Systems SHVC Development System]
* [https://wiki.superfamicom.org/nintendo-music-format-(n-spc) Super Famicom Wiki - N-SPC]
* [http://gdri.smspower.org/wiki/index.php/Super_Famicom/Super_NES_Sound_Driver_List GDRI - Super Famicom/Super NES Sound Driver List]
* [https://github.com/vgmtrans/vgmtrans/issues/173 Github - N-SPC VCMD $FB-$FE identifications]
* [https://archive.org/details/GameBoyProgManVer1.1/page/n187/mode/2up Game Boy Development Manual - Super Game Boy Sound] (see pages 187-213)

[[Category:SPC Sound Engines]]

N-SPC Engine/Nintendo/Koji Kondo/Prototype

2024-01-09T03:10:39Z

KungFuFurby: Corrected an error on bit notes for Panning

Go back to [[N-SPC Engine/Nintendo/Koji Kondo]]

__TOC__

The Prototype variant was used in two games: Super Mario World and Pilotwings. They are the only versions of the code that clearly pre-date the source code version provided with the IS-Sound unit. From a sound effect programming point of view, it can also be considered a predecessor to five other games that post-date the source code: SimCity, Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce, Star Fox/Star Wing, Super Mario All-Stars/Super Mario Collection and Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island.

{| class="wikitable sortable"
|-
! Game Name !! Music Version !! VCMD Table Location ($DA and up) !! ROM Offset
|-
| Super Mario World || 0.0 || <tt>0x0F90</tt>, relative to <tt>0x0EDC</tt> (all other versions) <tt>0x0FC4</tt>, relative to <tt>0x0F10</tt> (Super Mario All Stars + Super Mario World) || <tt>0x0E8000</tt> (all other versions) <tt>0x4E8000</tt> (Super Mario All-Stars + Super Mario World)
|-
| Pilotwings || 0.1 || <tt>0x1317</tt>, relative to <tt>0x1263</tt> (US and Japanese versions) <tt>0x12B4</tt>, relative to <tt>0x1200</tt> (European version) || <tt>0x0C8000</tt> (all versions)
|}

The build difference between the standalone Super Mario World and its variant in Super Mario All-Stars is an extra command for $2141/$F5: $F0. This command zeroes out the echo volume DSP registers, keys off all notes, zeroes out several memory locations then activates and jumps to the IPL boot program. The copy itself used for the $FF command is stored at $FE00 rather than in the middle of the program.

The build difference between the other versions and the European version of Pilotwings is similar to Super Mario All Stars and Super Mario World, except it's more like a complete replacement since it changes the operation of the $FF command for $2141/$F5. The echo volume DSP registers are zeroed out, all notes are keyed off, the EON register is cleared, echo writes are disabled, then we activate and jump to the IPL boot program instead of using a variant of it embedded in the program.

The raw build sorting notes can be found [[N-SPC Engine/Prototype/Build Sorting|here]].

==Communication with the SNES==
The communication protocol is game-specific. Both games have dedicated uses for each CPUIO register.

===Super Mario World===
====CPUIO0 ($2140/$F4)====
This register controls the SFX to play on channel 5.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%0xxxxxxx</tt> <tt>$01-$7F</tt> || Play SFX Sequence Set 1
|-
|<tt>%1???????</tt> <tt>$80-$FF</tt> || Hurry Up!
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence Set 1 (Command <tt>$01-$7F</tt>)=====
<pre>%0xxxxxxx</pre>

* <tt>%xxxxxxx</tt> is the SFX ID to play. The ID currently playing is echoed back to $2140 on the SNES.
** <tt>$11</tt> mutes the amplifiers and pauses the music once it finishes playing. Any SFX from SFX Sequence 1 will unpause the music and unmute the amplifiers, while any noise SFX from SFX Sequence Set 2 will unmute the amplifiers, but not unpause the music.
** <tt>$11</tt> and <tt>$1D</tt> do not permit the Hurry Up! SFX command to be played until it is finished. They also cannot be interrupted, except by <tt>$11</tt> or <tt>$12</tt>.

The <tt>$FF</tt> VCMD for this set only is programmed to restart the SFX from the beginning.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

=====Hurry Up! (Command <tt>$80-$FF</tt>)=====
Plays SFX ID <tt>$1D</tt> on both SFX sequence sets and offsets the tempo by <tt>$0A</tt> without overflow checks. This can stack if it is played multiple times, but only the first one will remain in effect until forced off.

====CPUIO1 ($2141/$F5)====
This register controls the SFX on channel 8 and the Yoshi drums on channel 6.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>$01</tt> || Jump
|-
|<tt>$02</tt> || Enable Yoshi Drums
|-
|<tt>$03</tt> || Disable Yoshi Drums
|-
|<tt>$04</tt> || Two-Note SFX
|-
|<tt>$05-$EF</tt> || NOP
|-
|<tt>$F0</tt> || Go to IPL Boot ROM (All-Stars variant only)
|-
|<tt>$F1-$FE</tt> || NOP
|-
|<tt>$FF</tt> || Load New Data
|}

=====NOP (Command <tt>$00</tt>, <tt>$05-$EF</tt>, <tt>$F1-$FE</tt>)=====
Does absolutely nothing.

=====Jump (Command <tt>$01</tt>)=====
Plays Mario's jumping SFX on channel 8. The value is echoed back to the SNES via $2141 while the SFX is playing.

=====Enable Yoshi Drums (Command <tt>$02</tt>)=====
Enables Yoshi drums. This is not echoed back to the SNES.

Yoshi drums are only supported on music IDs <tt>$01-$03</tt> and <tt>$06</tt>. Channel 6 is set to SFX instrument ID <tt>$09</tt> if this is true.

=====Disable Yoshi Drums (Command <tt>$03</tt>)=====
Disables Yoshi drums. This is not echoed back to the SNES.

=====Two-Note SFX (Command <tt>$04</tt>)=====
Plays two notes on channel 8. The value is echoed back to the SNES via $2141 while the SFX is playing.

=====Go to IPL Boot ROM (Command <tt>$F0</tt>)=====
This only works in the build variant used in Super Mario All Stars + Super Mario World.

''TODO go into specifics on what exactly is cleared out here before going to the loader''

=====Load New Data (Command <tt>$FF</tt>)=====
''TODO go into specifics on what exactly is cleared out here before going to the loader'' 
See [[N-SPC_Engine#Load_New_Data_.28Command_.24FF.29|the source build's Load New Data command]] for the loading protocol, as it is identical binary-wise to the copy used in this one minus the *Ver S1.20* string.

====CPUIO2 ($2142/$F6)====
This register controls the music.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%0xxxxxxx</tt> <tt>$00-$7F</tt> || Play Music
|-
|<tt>%1???????</tt> <tt>$80-$FF</tt> || Fade Out
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play Music (Command <tt>$01-$7F</tt>)=====
<pre>%0xxxxxxx</pre>

* <tt>%xxxxxxx</tt> is the music ID to play. The ID currently playing is echoed back to $2142 on the SNES.
** <tt>$09-$0C</tt>, <tt>$0F</tt>, <tt>$10</tt> and <tt>$16</tt> reset the tempo speedup effect done by the Hurry Up! command.

=====Fade Out (Command <tt>$80-$FF</tt>)=====
<pre>%1???????</pre>
Fades out the music by sliding the song volume to zero over 240 tempo ticks.

====CPUIO3 ($2143/$F7)====
This register controls the SFX to play on channel 7.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>xx</tt> <tt>$01-$FF</tt> || Play SFX Sequence Set 2
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence Set 2 (Command <tt>$01-$FF</tt>)=====
<pre>xx</pre>

* <tt>xx</tt> is the SFX ID to play. The ID currently playing is echoed back to $2143 on the SNES.
** <tt>$05</tt>, <tt>$1D</tt> and <tt>$24</tt> cannot be interrupted by any other instances. In order of priority, though, <tt>$24</tt> can interrupt <tt>$1D</tt>, which in turn can interrupt <tt>$05</tt>.

The <tt>$FF</tt> VCMD for this set only is programmed to move the pointer back one byte instead of forward.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

===Pilotwings===
====CPUIO0 ($2140/$F4)====
This register plays the music and controls the BRR wind noise.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%xyyzzzzz</tt> <tt>$01-$FE</tt> || Play Music/BRR Wind Noise Frequency
|-
|<tt>$FF</tt> || Fade Out
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play Music/BRR Wind Noise Frequency (Command <tt>$01-$FE</tt>)=====
Input<pre>%xyzaaaaa</pre>
Output<pre>%000aaaaa</pre>
Plays a piece of music.
* <tt>%x</tt> disables BRR wind noise playback on channel 8. This is forced on IDs <tt>$02</tt>, <tt>$0D</tt> and <tt>$11</tt> if <tt>%x</tt>, <tt>%y</tt> and <tt>%z</tt> are all zero.
* <tt>%y</tt>, with <tt>%x</tt> cleared, enables a higher-frequency wind noise. This takes precedence over <tt>%z</tt>.
* <tt>%z</tt>, with <tt>%x</tt> cleared, enables a lower-frequency wind noise.
* <tt>%aaaaa</tt> is the music ID. If zero, then the music will keep playing normally. Although the absolute limit is <tt>$1F</tt>, in reality it's <tt>$15</tt> because the song table only goes that high up ID-wise. The ID currently playing is echoed back to $2140 on the SNES.

=====Fade Out (Command <tt>$FF</tt>)=====
Fades out the music by sliding the song volume to zero over 192 tempo ticks.

====CPUIO1 ($2141/$F5)====
This register controls the sound effects in channels 3 and 8.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>xy</tt> <tt>$01-$FE</tt> || Play SFX Sequence
|-
|<tt>$FF</tt> || Load Data
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence (Command <tt>$01-$FE</tt>)=====
Input<pre>xy</pre>
Output<pre>0y</pre>

Two SFX can be triggered at once. Plus, each one has its own SFX collection to use.

* <tt>x</tt> is a four-bit/one nibble SFX ID for channel 8.
** <tt>$E</tt> mutes all other channels sound upon playing the SFX (including the music, which causes new values to not be acknowledged). Any other ID played afterwards unmutes the music. This also cannot be interrupted by other SFX value entered here except for <tt>$F</tt>.
** <tt>$1</tt> cannot be interrupted by other SFX in this same area except for <tt>$E</tt> and <tt>$F</tt>.
** <tt>$5</tt> plays nothing, although it still works for unmuting music and other channels.
* <tt>y</tt> is a four-bit/one nibble SFX ID for channel 3. The ID currently playing is echoed back to $2141 on the SNES.
** Some SFX are not interruptible. In order of uninterruptibility priority with other SFX IDs, we have <tt>$A</tt>, <tt>$7</tt> (<tt>$5</tt> is allowed to overwrite <tt>$7</tt> in this instance), then <tt>$9</tt>.
** <tt>$F</tt> plays nothing.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

=====Load Data (Command <tt>$FF</tt>)=====
The operation is slightly different depending on what build you're using. Both clean up DSP registers first: specifically by keying off all notes and zeroing out the EVOL DSP registers, along with disabling echo writes. Additionally, the European version clears out the EON DSP register, and the other versions mute the amplifier until the loading routine exits.

The European version jumps directly to the IPL Boot ROM, while all other versions instead use a modified copy.

See [[N-SPC_Engine#Load_New_Data_.28Command_.24FF.29|the source build's Load New Data command]] command for the loading protocol for the non-European versions, as it is identical binary-wise to the copy used in this one minus the *Ver S1.20* string.

====CPUIO2 ($2142/$F6)====
This controls the aircraft engine noise in channels 5 and 6.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%0xyyyyyy</tt> <tt>$00-$7F</tt> || Engine Control
|-
|<tt>%10xxxxxx</tt> <tt>$80-$BF</tt> || Break
|-
|<tt>%11??????</tt> <tt>$C0-$FE</tt> || Skid
|-
|<tt>$FF</tt> || Stop Engine
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Engine Control (Command <tt>$01-$7F</tt>)=====
<pre>%0xyyyyyy</pre>

The current engine value is echoed back to $2142 on the SNES.

* <tt>%x</tt>, when starting the aircraft engine, determines what kind of noise it makes. A different command (other than NOP) must be used before changing the engine noise.
* <tt>%yyyyyy</tt> controls the engine noise frequency.

=====Break (Command <tt>$80-$BF</tt>)=====
<pre>%10xxxxxx</pre>

* <tt>%xxxxxx</tt> only does something different when set to <tt>$01</tt>, which is a slight pitch variant. Otherwise, there's not much control here.

=====Skid (Command <tt>$C0-$FE</tt>)=====
<pre>%11??????</pre>

=====Stop Engine (Command <tt>$FF</tt>)=====
Basically acts as a reset for the aircraft engine back to default settings, in addition to stopping it.

====CPUIO3 ($2143/$F7)====
This controls a couple of pieces of miscellaneous SFX on channel 4. The ID currently playing is echoed back to $2143 on the SNES.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt>, <tt>$03-$FF</tt> || NOP
|-
|<tt>$01</tt> || Engine-Controlled SFX
|-
|<tt>$02</tt> || Beep
|}

=====NOP (Command <tt>$00</tt>, <tt>$03-$FF</tt>)=====
Does absolutely nothing.

=====Engine-Controlled SFX (Command <tt>$01</tt>)=====
Plays a fixed sequence of notes on channel 4 at a variable note length controlled by the engine frequency that goes faster the higher the frequency. Only works with a CPUIO2 value of <tt>$02-$11</tt>: otherwise, it's a NOP.

The note length used is defined as <tt>$1B</tt> minus the frequency of the engine shifted right. This value is decremented twice on the last note.

=====Beep (Command <tt>$02</tt>)=====
Plays a single note on channel 4. No other conditions are required here.

==Instrument Format==
Compared to common N-SPC, this is mostly the same, except it is missing the pitch base fractional multiplier, and V0.0 doesn't have noise support. Otherwise, it's the same as before, defined as following... 

V0.0
<pre>yy zz aa bb cc</pre>
V0.1
<pre>%xyyyyyyy zz aa bb cc</pre>
* <tt>x</tt> is a noise clock switch. This is only valid in V0.1.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> (or just <tt>yy</tt> for V0.0) is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.

==Percussion Format==
Percussion is stored separately from the instrument format in the prototype version, because its format is nearly identical to an instrument, but it contains an extra byte at the end that defines the note to play. Thus, these bytes are defined as following... 
V0.0
<pre>yy zz aa bb cc dd</pre>
V0.1
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>x</tt> is a noise clock switch. This is only valid in V0.1.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> (or just <tt>yy</tt> for V0.0) is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is the note to play the percussion note at.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play. This is mostly identical to standard N-SPC, except it doesn't have fast forward commands.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>%1??????? $00</tt> <tt>$80-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$01-$7F $00</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Always Jump (Command <tt>$80-$FF $00</tt>)===
<pre>%1??????? $00 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
The IDs are different due to being an earlier version, and some VCMDs may not be defined yet. The ones that are used are listed below.

{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || Phrase Termination/End of Subroutine ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>xy</tt>
|-
|<tt>$80-$C5</tt> || Note ||
|-
|<tt>$C6</tt> || Tie ||
|-
|<tt>$C7-$CF</tt> || Rest ||
|-
|<tt>$D0-$D9</tt> || Percussion ||
|-
|<tt>$DA</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$DB</tt> || Panning || <tt>%xy?zzzzz</tt>
|-
|<tt>$DC</tt> || Panning Fade || <tt>xx yy</tt>
|-
|<tt>$DD</tt> || Pitch Slide to Note || <tt>xx yy zz</tt>
|-
|<tt>$DE</tt> || Vibrato On || <tt>xx yy zz</tt>
|-
|<tt>$DF</tt> || Vibrato Off ||
|-
|<tt>$E0</tt> || Song Volume || <tt>xx</tt>
|-
|<tt>$E1</tt> || Song Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$E2</tt> || Tempo || <tt>xx</tt>
|-
|<tt>$E3</tt> || Tempo Fade || <tt>xx yy</tt>
|-
|<tt>$E4</tt> || Global Absolute Transposition || <tt>xx</tt>
|-
|<tt>$E5</tt> || Tremolo On || <tt>xx yy zz</tt>
|-
|<tt>$E6</tt> || Tremolo Off ||
|-
|<tt>$E7</tt> || Volume || <tt>xx</tt>
|-
|<tt>$E8</tt> || Volume Fade || <tt>xx yy</tt>
|-
|<tt>$E9</tt> || Subroutine || <tt>xx xx yy</tt>
|-
|<tt>$EA</tt> || Vibrato Fade In || <tt>xx</tt>
|-
|<tt>$EB</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$EC</tt> || Note Pitch Envelope From || <tt>xx yy zz</tt>
|-
|<tt>$ED</tt> || Invalid (supposed to be Note Pitch Envelope Off) ||
|-
|<tt>$EE</tt> || Fine Tune || <tt>xx</tt>
|-
|<tt>$EF</tt> || Echo Enable Bits and Volume || <tt>%xxxxxxxx yy zz</tt>
|-
|<tt>$F0</tt> || Echo Off ||
|-
|<tt>$F1</tt> || Echo Parameter Setup || <tt>xx yy zz</tt>
|-
|<tt>$F2</tt> || Echo Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$F3-$FF</tt> || Invalid ||
|}

''TODO use a template for the above table for standard VCMDs''

Most of these essentially act identically to the common versions (refer back to the main page for info on those), but two of the VCMDs don't work properly: Note Pitch Envelope Off, which has a zeroed out pointer but the code does exist, and Tremolo On, which has a memory location definition bug for one of the parameters that conflicts with an internal value utilized by the tremolo, causing constant overwriting and making the command not work in general.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

Template:N-SPC VCMD Set Table

2024-01-09T03:10:25Z

KungFuFurby: Corrected an error on bit notes for Panning

<noinclude>
This template is designed to quickly show a VCMD set for each N-SPC variant. This is currently a WIP on the customizability side, since it needs to be adapted for each and every N-SPC variant as needed.
</noinclude><includeonly>{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || Phrase Termination/End of Subroutine ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>(%0yyyzzzz)</tt>
|-
|<tt>$80-$C7</tt> || Note ||
|-
|<tt>$C8</tt> || Tie ||
|-
|<tt>$C9</tt> || Rest ||
|-
|<tt>$CA-$DF</tt> || Percussion ||
|-
|<tt>$E0</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$E1</tt> || Panning || <tt>%xy?zzzzz</tt>
|-
|<tt>$E2</tt> || Panning Fade || <tt>xx yy</tt>
|-
|<tt>$E3</tt> || Vibrato On || <tt>xx yy zz</tt>
|-
|<tt>$E4</tt> || Vibrato Off ||
|-
|<tt>$E5</tt> || Song Volume || <tt>xx</tt>
|-
|<tt>$E6</tt> || Song Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$E7</tt> || Tempo || <tt>xx</tt>
|-
|<tt>$E8</tt> || Tempo Fade || <tt>xx yy</tt>
|-
|<tt>$E9</tt> || Global Absolute Transposition || <tt>xx</tt>
|-
|<tt>$EA</tt> || Single Channel Absolute Transposition || <tt>xx</tt>
|-
|<tt>$EB</tt> || Tremolo On || <tt>xx yy zz</tt>
|-
|<tt>$EC</tt> || Tremolo Off ||
|-
|<tt>$ED</tt> || Volume || <tt>xx</tt>
|-
|<tt>$EE</tt> || Volume Fade || <tt>xx yy</tt>
|-
|<tt>$EF</tt> || Subroutine || <tt>xx xx yy</tt>
|-
|<tt>$F0</tt> || Vibrato Fade In || <tt>xx</tt>
|-
|<tt>$F1</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$F2</tt> || Note Pitch Envelope From || <tt>xx yy zz</tt>
|-
|<tt>$F3</tt> || Note Pitch Envelope Off ||
|-
|<tt>$F4</tt> || Fine Tune || <tt>xx</tt>
|-
|<tt>$F5</tt> || Echo Enable Bits and Volume || <tt>%xxxxxxxx yy zz</tt>
|-
|<tt>$F6</tt> || Echo Off ||
|-
|<tt>$F7</tt> || Echo Parameter Setup || <tt>xx yy zz</tt>
|-
|<tt>$F8</tt> || Echo Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$F9</tt> || Pitch Slide to Note || <tt>xx yy zz</tt>
|-
|<tt>$FA</tt> || Percussion Base Instrument ID Redefine || <tt>xx</tt>
|-
|<tt>$FB</tt> || NOP || <tt>?? ??</tt>
|-
|<tt>$FC</tt> || Channel Mute ||
|-
|<tt>$FD</tt> || Fast Forward On ||
|-
|<tt>$FE</tt> || Fast Forward Off ||
|-
|<tt>$FF</tt> || Invalid ||
|}</includeonly>

N-SPC Engine/Nintendo/Koji Kondo/SFX Sequence Format

2024-01-09T03:08:23Z

KungFuFurby: Adding a stub marker citing the under construction nature of this page.

Go back to [[N-SPC Engine/Nintendo/Koji Kondo]]

{{stub}}

__TOC__

'''NOTE: This page is under construction. The later Koji Kondo games use the same format for the most part (except for ''Star Fox 2'', which has a more massive overhaul), but adapted to modern N-SPC VCMD IDs, and they may have some extra per-entry parameters.'''

''TODO insert table here containing a list of games and their version''

The SFX sequence data is slightly modified compared to the standard N-SPC's voice command format. These are headerless, unlike a song, and they only support one channel at a time, with the channel used being fixed. Both games have almost the same command set except for VCMD <tt>$FF</tt>.

All SFX are initially handled at a tempo of <tt>$38</tt>. ''TODO double check for all games''

==SFX Instrument Format==
''TODO Star Glider, Star Fox, Yoshi's Island and Star Fox 2 don't use this instrument format: instead they're standard Kankichi-kun, so TODO note this once the versioning info is implemented''

The SFX instrument format, shared among all SFX but not consistently stored in terms of memory location, consists of a series of bytes as following...
<pre>xx yy zz aa bb cc dd ee ff</pre>
* <tt>xx</tt> is a direct write to the VxVOLL DSP register.
* <tt>yy</tt> is a direct write to the VxVOLR DSP register.
* <tt>zz</tt> is a direct write to the VxPITCHL DSP register.
* <tt>aa</tt> is a direct write to the VxPITCHH DSP register.
* <tt>bb</tt> is a direct write to the VxSRCN DSP register.
* <tt>cc</tt> is a direct write to the VxADSR1 DSP register.
* <tt>dd</tt> is a direct write to the VxADSR2 DSP register.
* <tt>ee</tt> is a direct write to the VxGAIN DSP register.
* <tt>ff</tt> is a pitch base multiplier.

==SFX Percussion Format==
See [[N-SPC Engine/Prototype#Percussion Format|the music percussion format]], as the format is identical.

==SFX Voice Command Format==
===V0.0-V0.1===
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || End of SFX ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>(xx) (yy)</tt>
|-
|<tt>$80-$C5</tt> || Note ||
|-
|<tt>$C6-$CF</tt> || Retrigger Note ||
|-
|<tt>$D0-$D9</tt> || Percussion ||
|-
|<tt>$DA</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$DA</tt> || Noise Instrument (Super Mario World CPUIO3) || <tt>%1??xxxxx yy</tt>
|-
|<tt>$DB-$DC</tt> || Invalid Note ||
|-
|<tt>$DD</tt> || Note + Pitch Slide to Note || <tt>xx yy zz aa</tt>
|-
|<tt>$DE-$EA</tt> || Invalid Note ||
|-
|<tt>$EB</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$EC-$FE</tt> || Invalid Note ||
|-
|<tt>$FF</tt> || Restart SFX (Super Mario World CPUIO0) ||
|-
|<tt>$FF</tt> || Jump Back One Byte (Super Mario World CPUIO3) ||
|-
|<tt>$FF</tt> || Jump to SFX ID (Pilotwings) || <tt>xx</tt>
|}

===V1.0 and up===
''TODO add table here: the IDs now reflect modern N-SPC''

''TODO Star Fox 2'' (has a massive overhaul to the VCMD format)

===Invalid Note (VCMD <tt>$DB-$DC</tt>, <tt>$DE-$EA</tt>, <tt>$EC-$FE</tt>)===
Doesn't crash the sound driver, but does play an invalid note.

===End of SFX (VCMD <tt>$00</tt>)===
Terminates the SFX.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (yy) (zz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>yy</tt>, if less than <tt>$80</tt>, represents the volume of the note. If a second byte is defined, this is done for the left channel, otherwise it is for both channels.
* <tt>zz</tt>, if less than <tt>$80</tt>, represents the right volume of the note.

===Note (VCMD <tt>$80-$C5</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Retrigger Note (VCMD <tt>$C6-$CF</tt>)===
Retriggers the previous note and delays the channel for one note length before reading another VCMD.

Note that as a side effect of this, there is no tie or rest command. Rests can be emulated via a zero volume note. Ties... well, officially they're not supported at all, but if the pitch slide length equals or exceeds the note duration, then the note won't be keyed off once the note length has elapsed.

===Percussion (VCMD <tt>$D0-$D9</tt>)===
Plays a percussion note. Unlike SFX, percussion uses the same set that the music uses, and thus has the same instrument format as that.

===Instrument (VCMD <tt>$DA</tt>)===
<pre>$DA xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See SFX Instrument Format above for the format.

===Noise Instrument (VCMD <tt>$DA</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO3 register.

<pre>$DA %1??xxxxx yy</pre>

* <tt>%xxxxx</tt> contains the noise clock rate.
* <tt>yy</tt> is an instrument ID to an array of instruments. See SFX Instrument Format above for the format. This must be <tt>$7F</tt> or less, otherwise the noise clock rate is overwritten and more bytes will be fetched until a non-noise clock value is given.

===Note + Pitch Slide To Note (VCMD <tt>$DD</tt>)===
<pre>$DD xx yy zz aa</pre>
* <tt>xx</tt> is the starting note.
* <tt>yy</tt> defines the number of tempo ticks to delay the slide for... at least in theory. In reality, this never works, and the pitch slide executes instantly in all cases.
* <tt>zz</tt> defines the length of the pitch slide in tempo ticks. If this is equal or greater than the overall note length, the note won't key off at the end, thus allowing for multiple pitch envelopes to be chained at once.
* <tt>aa</tt> is the target note.

===Note Pitch Envelope To (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of ticks to delay before applying the pitch envelope... at least in theory. In reality, this never works, and the pitch slide executes instantly in all cases.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks. If this is equal or greater than the overall note length, the note won't key off at the end, thus allowing for multiple pitch envelopes to be chained at once.
* <tt>zz</tt> is the target note.

===Restart SFX (VCMD <tt>$FF</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO0 register.

Restarts the SFX from the beginning.

===Jump Back One Byte (VCMD <tt>$FF</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO3 register.

Normally, the pointer is incremented upon reading the VCMD. This causes the inverse to happen, and sets the pointer to one byte before this VCMD.

===Jump to SFX ID (VCMD <tt>$FF</tt>)===
Only compatible with Pilotwings.

<pre>$FF xx</pre>
* <tt>xx</tt> is the SFX ID to jump to. The array used depends on which set of sequences you're using, as the two of them use different sets.

Template:N-SPC VCMD Set Table

2024-01-07T23:43:13Z

KungFuFurby: Made an error on the NOP command with the source variant (it skips two bytes, not one)

<noinclude>
This template is designed to quickly show a VCMD set for each N-SPC variant. This is currently a WIP on the customizability side, since it needs to be adapted for each and every N-SPC variant as needed.
</noinclude><includeonly>{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || Phrase Termination/End of Subroutine ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>(%0yyyzzzz)</tt>
|-
|<tt>$80-$C7</tt> || Note ||
|-
|<tt>$C8</tt> || Tie ||
|-
|<tt>$C9</tt> || Rest ||
|-
|<tt>$CA-$DF</tt> || Percussion ||
|-
|<tt>$E0</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$E1</tt> || Panning || <tt>%xyzzzzz</tt>
|-
|<tt>$E2</tt> || Panning Fade || <tt>xx yy</tt>
|-
|<tt>$E3</tt> || Vibrato On || <tt>xx yy zz</tt>
|-
|<tt>$E4</tt> || Vibrato Off ||
|-
|<tt>$E5</tt> || Song Volume || <tt>xx</tt>
|-
|<tt>$E6</tt> || Song Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$E7</tt> || Tempo || <tt>xx</tt>
|-
|<tt>$E8</tt> || Tempo Fade || <tt>xx yy</tt>
|-
|<tt>$E9</tt> || Global Absolute Transposition || <tt>xx</tt>
|-
|<tt>$EA</tt> || Single Channel Absolute Transposition || <tt>xx</tt>
|-
|<tt>$EB</tt> || Tremolo On || <tt>xx yy zz</tt>
|-
|<tt>$EC</tt> || Tremolo Off ||
|-
|<tt>$ED</tt> || Volume || <tt>xx</tt>
|-
|<tt>$EE</tt> || Volume Fade || <tt>xx yy</tt>
|-
|<tt>$EF</tt> || Subroutine || <tt>xx xx yy</tt>
|-
|<tt>$F0</tt> || Vibrato Fade In || <tt>xx</tt>
|-
|<tt>$F1</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$F2</tt> || Note Pitch Envelope From || <tt>xx yy zz</tt>
|-
|<tt>$F3</tt> || Note Pitch Envelope Off ||
|-
|<tt>$F4</tt> || Fine Tune || <tt>xx</tt>
|-
|<tt>$F5</tt> || Echo Enable Bits and Volume || <tt>%xxxxxxxx yy zz</tt>
|-
|<tt>$F6</tt> || Echo Off ||
|-
|<tt>$F7</tt> || Echo Parameter Setup || <tt>xx yy zz</tt>
|-
|<tt>$F8</tt> || Echo Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$F9</tt> || Pitch Slide to Note || <tt>xx yy zz</tt>
|-
|<tt>$FA</tt> || Percussion Base Instrument ID Redefine || <tt>xx</tt>
|-
|<tt>$FB</tt> || NOP || <tt>?? ??</tt>
|-
|<tt>$FC</tt> || Channel Mute ||
|-
|<tt>$FD</tt> || Fast Forward On ||
|-
|<tt>$FE</tt> || Fast Forward Off ||
|-
|<tt>$FF</tt> || Invalid ||
|}</includeonly>

N-SPC Engine

2024-01-07T18:59:41Z

KungFuFurby: /* Tremolo Off (VCMD $EC) */

__TOC__

'''Nintendo SPC Sound Engine''', abbreviated N-SPC and officially known as Kankichi-kun [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun], is the most common sound engine used in all of the SNES/SFC games. Only the music portion was initially provided in the source code included in the IS-Sound unit along with some templating for a protocol for music and sound effects [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system]: usually it was modified by developers on an individual basis, resulting in many different variants, some of them more heavily modifying the sound driver than others. Usually what was added on was sound effect support, but sometimes the music VCMDs were modified as well.

The following games are purely based off of the source code provided with the IS-Sound unit, and are either unmodified or barely modified, if at all:
{| class="wikitable sortable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Hong Kong '97'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0F800A</tt> (both versions)
|-
| ''SM Choukyoushi Hitomi - Bangai Hen'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x03801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2 Remix'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x018058</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1) || <tt>0x0DF0</tt>, relative to <tt>0x0D30</tt> || <tt>0x018076</tt>
|-
| ''Wheel of Fortune - Deluxe Edition'' ''(unused)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01D842</tt>
|}
Of the games listed here, two of them are very minor edits...
* ''Wheel of Fortune - Deluxe Edition'''s build is unused and is missing an opcode near the *Ver S1.20* string. In addition, that section is actually unused, because instead new code at $0700 is used to substitute for this one... which happens to be an exact match to the original IPL Boot ROM.
* ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1)'s program starts with a JMP opcode, and contains a NOP between the first and second opcodes of the actual program.

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

==Communication with the SNES==
NOTE: This is not representative of every single variant. Instead, it represents the collection of commands from the source code included in the IS-Sound unit, which in turn may be carried over to most variants.

The only register that is used for communication in the source build is $2140 (SNES side)/$F4 (SPC side), except for the load command. Other registers are not even read from, though the code itself sets up the framework to do so.

===Output to the SNES===
<pre>xx ?? ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.

===Command IDs===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

===Stop Music (Command <tt>$00</tt>)===
Initializes an invalid phrase pointer, then stops the previous piece of music. This is not compatible with the resume command, as it is irrevocable, unlike the other one.

===Play Music (Command <tt>$01-??</tt>)===
Stops a previous piece of music, then plays a piece of music by the ID specified in the command.

===Pause Music (Command <tt>$F0</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$F1</tt>)===
Resumes a paused song.

===Load New Data (Command <tt>$FF</tt>)===
Jumps to a modified copy of the IPL Boot ROM (except for Wheel of Fortune - Deluxe Edition, where there is an opcode missing, the jump location is different, and it contains an exact copy of the IPL Boot ROM).

''TODO Loading New Data (the loading protocol is nearly identical to IPL Boot ROM, with a couple of differences)''

==Instrument Format==
The instrument format is most commonly defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this....
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>%x</tt> is a [[S-DSP/Noise|noise clock]] switch.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is a fractional pitch base multiplier, defined in 256ths.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>$80 $00</tt> || Fast Forward On ||
|-
|<tt>$81 $00</tt> || Fast Forward Off ||
|-
|<tt>%1??????? $00</tt> <tt>$82-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$00 $01-$7F</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Fast Forward On (Command <tt>$00 $80</tt>)===
<pre>$80 $00</pre>
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (Command <tt>$00 $81</tt>)===
<pre>$81 $00</pre>
Disables Fast Forward and continues playing the song normally.

===Always Jump (Command <tt>$00 $82-$FF</tt>)===
<pre>%1??????? $00 xx xx</pre>
Only executes if the fast forward commands are not triggered.
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
NOTE: This is not representative of every single variant. Instead, it represents the collection of VCMDs from the source code included in the IS-Sound unit, which in turn is carried over to most variants.

{{N-SPC VCMD Set Table}}

===Invalid (VCMD <tt>$FF</tt>)===
Crashes the sound driver due to being outside of the array of pointers, and thus jumping to an invalid pointer.

===NOP (VCMD <tt>$FB</tt>)===
<pre>$FB ?? ??</pre>
Reads two bytes, then does absolutely nothing with the command.

===Phrase Termination/End of Subroutine (VCMD <tt>$00</tt>)===
This VCMD's operation depends on whether or not it is inside a subroutine or not.
If it is inside a subroutine, it exits the subroutine and song execution continues.
Otherwise, the phrase is terminated. This affects ''all'' channels in the music: any other channels still playing are interrupted.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (%0yyyzzzz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>%yyy</tt>, if the highest bit of the byte is not set, defines the quantization. It is an index value to a table of values that indicate, in 256ths, how far along the note to play before keying it off. This table can vary on a per-game basis.
* <tt>%zzzz</tt>, which is only defined if the highest bit of the byte is not set, defines the velocity. It is an index to a table of values that indicate the volume in a decibel-like number (due to the final volume calculation being multiplied by itself at the end). This table can vary on a per-game basis.

Notes and/or special VCMDs, by default, are forced after the parameter byte is read. Attempting to use <tt>$00-$7F</tt> again results in an invalid note.

===Note (VCMD <tt>$80-$C7</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Tie (VCMD <tt>$C8</tt>)===
Continues playing the previous note and delays the channel for one note length before reading another VCMD.

===Rest (VCMD <tt>$C9</tt>)===
Keys off the previous note and delays the channel for one note length before reading another VCMD.

===Percussion (VCMD <tt>$CA-$DF</tt>)===
Plays a percussion note.

By default, percussion uses the same instrument set as the song, and all percussion is keyed on with a note of <tt>$A4</tt>.
The starting ID to use for all channels can be redefined by VCMD <tt>$FA</tt>.

===Instrument (VCMD <tt>$E0</tt>)===
<pre>$E0 xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Panning (VCMD <tt>$E1</tt>)===
<pre>$E1 %xyzzzzz</pre>
* <tt>%x</tt> defines a phase inversion switch for the left channel.
* <tt>%y</tt> defines a phase inversion switch for the right channel.
* <tt>%zzzzz</tt> is five bits for the panning. This refers to an array of values to multiply the volume by after calculating the voice volume via various other parameters set by the VCMDs. Under normal circumstances, center is defined as <tt>$0A</tt> and the maximum value is <tt>$14</tt>.

===Panning Fade (VCMD <tt>$E2</tt>)===
<pre>$E2 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target pan value. Phase inversion is ''not'' taken into account here, thus only the low five bits should be used here.

===Vibrato On (VCMD <tt>$E3</tt>)===
<pre>$E3 xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the vibrato for.
* <tt>yy</tt> is the rate of the vibrato: specifically, how much to change the pitch on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the vibrato: that is, the maximum pitch offset to use. <tt>$00-$F0</tt> are normal, but <tt>$F1</tt> and up act more like said value ANDed by <tt>$0F</tt> and multiplied by <tt>$0100</tt>, meaning the highest values have drastic differences compared to the lower ones.

===Vibrato Off (VCMD <tt>$E4</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Song Volume (VCMD <tt>$E5</tt>)===
<pre>$E5 xx</pre>
* <tt>xx</tt> is the song volume value. This sets the volume for all of the channels in the song. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Song Volume Fade (VCMD <tt>$E6</tt>)===
<pre>$E6 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target song volume.

===Tempo (VCMD <tt>$E7</tt>)===
<pre>$E7 xx</pre>
* <tt>xx</tt> defines one tempo tick as one timer 0 tick multiplied by <math>\frac{256}{x}</math>. Zero freezes the song.

===Tempo Fade (VCMD <tt>$E8</tt>)===
<pre>$E8 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target tempo.

===Global Absolute Transposition (VCMD <tt>$E9</tt>)===
<pre>$E9 xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes. Note that this affects all channels, not just one channel.

===Single Channel Absolute Transposition (VCMD <tt>$EA</tt>)===
<pre>$EA xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes.

===Tremolo On (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the tremolo for.
* <tt>yy</tt> is the rate of the tremolo: specifically, how much to change the volume on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the tremolo: that is, the maximum volume offset to use.

===Tremolo Off (VCMD <tt>$EC</tt>)===
Disables tremolo set by VCMD <tt>$EB</tt>.

===Volume (VCMD <tt>$ED</tt>)===
<pre>$ED xx</pre>
* <tt>xx</tt> is the volume value. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Volume Fade (VCMD <tt>$EE</tt>)===
<pre>$EE xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target volume.

===Subroutine (VCMD <tt>$EF</tt>)===
<pre>$EF xx xx yy</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer containing the section of music to play.
* <tt>yy</tt> is the number of times to loop the sub-routine.

===Vibrato Fade In (VCMD <tt>$F0</tt>)===
<pre>$F0 xx</pre>
* <tt>xx</tt> is the number of tempo ticks to fade the vibrato for.
The moment this VCMD is executed, the depth is faded in from zero.

===Note Pitch Envelope To (VCMD <tt>$F1</tt>)===
<pre>$F1 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note to.

===Note Pitch Envelope From (VCMD <tt>$F2</tt>)===
<pre>$F2 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note from: that is, unlike Note Pitch Envelope To (VCMD <tt>$F1</tt>), this is a starting note offset, rather than an end of pitch envelope note offset.

===Note Pitch Envelope Off (VCMD <tt>$F3</tt>)===
Disables a pitch envelope.

===Fine Tune (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines the amount to shift the pitch up. This is in 256ths of a semitone, albeit done via measuring the distance between note and multiplying it by this value.

===Echo Enable Bits and Volume (VCMD <tt>$F5</tt>)===
<pre>$F5 %xxxxxxxx yy zz</pre>
* <tt>%xxxxxxxx</tt> defines the channels to turn on for the echo (one per bit), which translates to a direct write to the EON DSP register.
* <tt>yy</tt> defines a value for EVOLL DSP register.
* <tt>zz</tt> defines a value for EVOLR DSP register.

===Echo Off (VCMD <tt>$F6</tt>)===
This disables echo for ''all'' channels, as well as zeroing out the echo volume and disabling echo writes.

===Echo Parameter Setup (VCMD <tt>$F7</tt>)===
<pre>$F7 xx yy zz</pre>
* <tt>xx</tt> defines a value for the EDL DSP register.
* <tt>yy</tt> defines a value for the EFB DSP register.
* <tt>zz</tt> defines an ID to an array of FIR coefficient values.

===Echo Volume Fade (VCMD <tt>$F8</tt>)===
<pre>$F8 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> defines the target value for EVOLL DSP register.
* <tt>zz</tt> defines the target value for EVOLR DSP register.

===Pitch Slide To Note (VCMD <tt>$F9</tt>)===
<pre>$F9 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to delay the slide for.
* <tt>yy</tt> defines the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is the target note.

===Percussion Base Instrument ID Redefine (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is the starting instrument ID. Note that this affects all channels.

===Channel Mute (VCMD <tt>$FC</tt>)===
Causes the channel to not key on subsequent notes.

===Fast Forward On (VCMD <tt>$FD</tt>)===
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (VCMD <tt>$FE</tt>)===
Disables Fast Forward and continues playing the song normally.

==Variants==
===Shijou Saikyou no Quiz Ou Ketteisen Super===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Shijou Saikyou no Quiz Ou Ketteisen Super'' || <tt>0x0DF7</tt>, relative to <tt>0x0D37</tt> || <tt>0x038062</tt>/<tt>0x04805C</tt>/<tt>0x058062</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

This is the closest match to a standard source N-SPC/Kankichi build used in a licensed game. This is because the only modifications made to it are to echo what was sent to any register to $2141/$F5 (although in practice only $2140/$F4 is read from, thus de facto giving it the same output, otherwise it would be cycling between the last register read code-wise as output) and zero out both $2140/$F4 and $2141/$F5 when the song is done playing when a zero pointer is read from a phase.

====Output to the SNES====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.
* <tt>yy</tt> is a de-facto mirror of <tt>xx</tt> output-wise. The feedback is a little faster, though, since the output is immediately upon $2140/$F4 being read, rather than when the music is initialized.

===Controller Test/World Class Service Super Nintendo Tester===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Controller Test || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x009319</tt> (Controller Test Cassette) <tt>0x00BFFF</tt> (SNES Burn-In Test Cartridge) <tt>0x00D8D2</tt> (World Class Service Super Nintendo Tester ''(not used)'')
|-
| World Class Service Super Nintendo Tester ''(only build used across all tests)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0B8068</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

These two sound driver builds (the one for the controller test being found in three different known testing cartridges, with one of them not used) merely have code optimizations in their sound code, thus making them completely identical execution-wise to the source build variant. In addition, the build used for World Class Service Super Nintendo Tester adds a BMI opcode in a readahead routine, but is otherwise identical.

===Subpages===
{{Subpages}}

Not created yet...
* [[N-SPC Engine/64WD Creation|64WD Creation]]
* [[N-SPC Engine/Advance Communication|Advance Communication]]
* [[N-SPC Engine/Aisystem Tokyo|Aisystem Tokyo]]
* [[N-SPC Engine/Argonaut|Argonaut]]
* [[N-SPC Engine/Axes Art Amuse|Axes Art Amuse]]
* [[N-SPC Engine/Bit Managers|Bit Managers]]
* [[N-SPC Engine/Capcom|Capcom]]
* [[N-SPC Engine/Chatnoir|Chatnoir]]
* [[N-SPC Engine/Chip Level Designs|Chip Level Designs]]
* [[N-SPC Engine/CP.BRAiN|CP.BRAiN]]
* [[N-SPC Engine/Cream|Cream]]
* [[N-SPC Engine/Crosstalk|Crosstalk]]
* [[N-SPC Engine/Cube|Cube]]
* [[N-SPC Engine/CUE|CUE]]
* [[N-SPC Engine/Culture Brain|Culture Brain]]
* [[N-SPC Engine/Daft|Daft]]
* [[N-SPC Engine/Data East|Data East]]
* [[N-SPC Engine/EJ Corporation|EJ Corporation]]
* [[N-SPC Engine/Electronic Arts|Electronic Arts]]
* [[N-SPC Engine/Falcom|Falcom]]
* [[N-SPC Engine/Funcom|Funcom]]
* [[N-SPC Engine/Gremlin|Gremlin]]
* [[N-SPC Engine/HAL|HAL]]
* [[N-SPC Engine/Hanari Exp|Hanari Exp]]
* [[N-SPC Engine/Hect|Hect]]
* [[N-SPC Engine/Hikoshi Hashimoto|Hikoshi Hashimoto]]
* [[N-SPC Engine/Home Data|Home Data]]
* [[N-SPC Engine/Human (earlier)|Human (earlier)]]
* [[N-SPC Engine/Human|Human]]
* [[N-SPC Engine/Imagesoft|Imagesoft]]
* [[N-SPC Engine/Infogrames|Infogrames]]
* [[N-SPC Engine/Intelligent Systems|Intelligent Systems]]
* [[N-SPC Engine/Japan Art Media|Japan Art Media]]
* [[N-SPC Engine/Jorudan|Jorudan]]
* [[N-SPC Engine/Kazuo Sawa|Kazuo Sawa]]
* [[N-SPC Engine/Kennosuke Suemura|Kennosuke Suemura]]
* [[N-SPC Engine/Khaos|Khaos]]
* [[N-SPC Engine/Koei|Koei]]
* [[N-SPC Engine/Konami|Konami]]
* [[N-SPC Engine/LaserSoft|LaserSoft]]
* [[N-SPC Engine/Make Software|Make Software]]
* [[N-SPC Engine/Metro|Metro]]
* [[N-SPC Engine/Mitsuhito Tanaka|Mitsuhito Tanaka]]
* [[N-SPC Engine/Monolith|Monolith]]
* [[N-SPC Engine/MSQ|MSQ]]
* [[N-SPC Engine/Namco|Namco]]
* [[N-SPC Engine/Naohisa Morota|Naohisa Morota]]
* [[N-SPC Engine/Natsume|Natsume]]
* [[N-SPC Engine/Nichibutsu or Make Software|Nichibutsu/Make Software]] (NOTE: Refers to three of the Super Nichibutsu Mahjong games)
* [[N-SPC Engine/Nova|Nova]]
* [[N-SPC Engine/Ocean|Ocean]]
* [[N-SPC Engine/Pure Sound|Pure Sound]]
* [[N-SPC Engine/Quest|Quest]]
* [[N-SPC Engine/Quintet|Quintet]]
* [[N-SPC Engine/Robert C. Ashworth|Robert C. Ashworth]]
* [[N-SPC Engine/Sakata SAS|Sakata SAS]]
* [[N-SPC Engine/Saurus|Saurus]]
* [[N-SPC Engine/Sunsoft|Sunsoft]]
* [[N-SPC Engine/Syscom|Syscom]]
* [[N-SPC Engine/System Sacom|System Sacom]]
* [[N-SPC Engine/Systemsoft|Systemsoft]]
* [[N-SPC Engine/T's Music|T's Music]]
* [[N-SPC Engine/TamTam|TamTam]]
* [[N-SPC Engine/Team X-Fade|Team X-Fade]]
* [[N-SPC Engine/Technos Japan|Technos Japan]]
* [[N-SPC Engine/Technosoft|Technosoft]]
* [[N-SPC Engine/Tecmo|Tecmo]]
* [[N-SPC Engine/Tose|Tose]]
* [[N-SPC Engine/Tsukasa Masuko|Tsukasa Masuko]]
* [[N-SPC Engine/Virgin|Virgin]]
* [[N-SPC Engine/Wave|Wave]]
* [[N-SPC Engine/Yoshikazu Yao|Yoshikazu Yao]]
* [[N-SPC Engine/Yoshiyuki Ishii|Yoshiyuki Ishii]]

''TODO: There are a lot of variants... these will be split into sub-pages depending on the modifications made''

==References==
* [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun Video Game Music Preservation Foundation - Kankichi-kun]
* [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system Retro Reversing - SNES (Super Famicom) Development Kit Hardware - Intelligent Systems SHVC Development System]
* [https://wiki.superfamicom.org/nintendo-music-format-(n-spc) Super Famicom Wiki - N-SPC]
* [http://gdri.smspower.org/wiki/index.php/Super_Famicom/Super_NES_Sound_Driver_List GDRI - Super Famicom/Super NES Sound Driver List]
* [https://github.com/vgmtrans/vgmtrans/issues/173 Github - N-SPC VCMD $FB-$FE identifications]
* [https://archive.org/details/GameBoyProgManVer1.1/page/n187/mode/2up Game Boy Development Manual - Super Game Boy Sound] (see pages 187-213)

[[Category:SPC Sound Engines]]

N-SPC Engine/Nintendo/Koji Kondo/Prototype

2024-01-07T18:42:53Z

KungFuFurby: /* Instrument Format */ Removed an accidentally included fractional pitch base multiplier from the instrument section.

Go back to [[N-SPC Engine/Nintendo/Koji Kondo]]

__TOC__

The Prototype variant was used in two games: Super Mario World and Pilotwings. They are the only versions of the code that clearly pre-date the source code version provided with the IS-Sound unit. From a sound effect programming point of view, it can also be considered a predecessor to five other games that post-date the source code: SimCity, Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce, Star Fox/Star Wing, Super Mario All-Stars/Super Mario Collection and Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island.

{| class="wikitable sortable"
|-
! Game Name !! Music Version !! VCMD Table Location ($DA and up) !! ROM Offset
|-
| Super Mario World || 0.0 || <tt>0x0F90</tt>, relative to <tt>0x0EDC</tt> (all other versions) <tt>0x0FC4</tt>, relative to <tt>0x0F10</tt> (Super Mario All Stars + Super Mario World) || <tt>0x0E8000</tt> (all other versions) <tt>0x4E8000</tt> (Super Mario All-Stars + Super Mario World)
|-
| Pilotwings || 0.1 || <tt>0x1317</tt>, relative to <tt>0x1263</tt> (US and Japanese versions) <tt>0x12B4</tt>, relative to <tt>0x1200</tt> (European version) || <tt>0x0C8000</tt> (all versions)
|}

The build difference between the standalone Super Mario World and its variant in Super Mario All-Stars is an extra command for $2141/$F5: $F0. This command zeroes out the echo volume DSP registers, keys off all notes, zeroes out several memory locations then activates and jumps to the IPL boot program. The copy itself used for the $FF command is stored at $FE00 rather than in the middle of the program.

The build difference between the other versions and the European version of Pilotwings is similar to Super Mario All Stars and Super Mario World, except it's more like a complete replacement since it changes the operation of the $FF command for $2141/$F5. The echo volume DSP registers are zeroed out, all notes are keyed off, the EON register is cleared, echo writes are disabled, then we activate and jump to the IPL boot program instead of using a variant of it embedded in the program.

The raw build sorting notes can be found [[N-SPC Engine/Prototype/Build Sorting|here]].

==Communication with the SNES==
The communication protocol is game-specific. Both games have dedicated uses for each CPUIO register.

===Super Mario World===
====CPUIO0 ($2140/$F4)====
This register controls the SFX to play on channel 5.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%0xxxxxxx</tt> <tt>$01-$7F</tt> || Play SFX Sequence Set 1
|-
|<tt>%1???????</tt> <tt>$80-$FF</tt> || Hurry Up!
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence Set 1 (Command <tt>$01-$7F</tt>)=====
<pre>%0xxxxxxx</pre>

* <tt>%xxxxxxx</tt> is the SFX ID to play. The ID currently playing is echoed back to $2140 on the SNES.
** <tt>$11</tt> mutes the amplifiers and pauses the music once it finishes playing. Any SFX from SFX Sequence 1 will unpause the music and unmute the amplifiers, while any noise SFX from SFX Sequence Set 2 will unmute the amplifiers, but not unpause the music.
** <tt>$11</tt> and <tt>$1D</tt> do not permit the Hurry Up! SFX command to be played until it is finished. They also cannot be interrupted, except by <tt>$11</tt> or <tt>$12</tt>.

The <tt>$FF</tt> VCMD for this set only is programmed to restart the SFX from the beginning.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

=====Hurry Up! (Command <tt>$80-$FF</tt>)=====
Plays SFX ID <tt>$1D</tt> on both SFX sequence sets and offsets the tempo by <tt>$0A</tt> without overflow checks. This can stack if it is played multiple times, but only the first one will remain in effect until forced off.

====CPUIO1 ($2141/$F5)====
This register controls the SFX on channel 8 and the Yoshi drums on channel 6.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>$01</tt> || Jump
|-
|<tt>$02</tt> || Enable Yoshi Drums
|-
|<tt>$03</tt> || Disable Yoshi Drums
|-
|<tt>$04</tt> || Two-Note SFX
|-
|<tt>$05-$EF</tt> || NOP
|-
|<tt>$F0</tt> || Go to IPL Boot ROM (All-Stars variant only)
|-
|<tt>$F1-$FE</tt> || NOP
|-
|<tt>$FF</tt> || Load New Data
|}

=====NOP (Command <tt>$00</tt>, <tt>$05-$EF</tt>, <tt>$F1-$FE</tt>)=====
Does absolutely nothing.

=====Jump (Command <tt>$01</tt>)=====
Plays Mario's jumping SFX on channel 8. The value is echoed back to the SNES via $2141 while the SFX is playing.

=====Enable Yoshi Drums (Command <tt>$02</tt>)=====
Enables Yoshi drums. This is not echoed back to the SNES.

Yoshi drums are only supported on music IDs <tt>$01-$03</tt> and <tt>$06</tt>. Channel 6 is set to SFX instrument ID <tt>$09</tt> if this is true.

=====Disable Yoshi Drums (Command <tt>$03</tt>)=====
Disables Yoshi drums. This is not echoed back to the SNES.

=====Two-Note SFX (Command <tt>$04</tt>)=====
Plays two notes on channel 8. The value is echoed back to the SNES via $2141 while the SFX is playing.

=====Go to IPL Boot ROM (Command <tt>$F0</tt>)=====
This only works in the build variant used in Super Mario All Stars + Super Mario World.

''TODO go into specifics on what exactly is cleared out here before going to the loader''

=====Load New Data (Command <tt>$FF</tt>)=====
''TODO go into specifics on what exactly is cleared out here before going to the loader'' 
See [[N-SPC_Engine#Load_New_Data_.28Command_.24FF.29|the source build's Load New Data command]] for the loading protocol, as it is identical binary-wise to the copy used in this one minus the *Ver S1.20* string.

====CPUIO2 ($2142/$F6)====
This register controls the music.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%0xxxxxxx</tt> <tt>$00-$7F</tt> || Play Music
|-
|<tt>%1???????</tt> <tt>$80-$FF</tt> || Fade Out
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play Music (Command <tt>$01-$7F</tt>)=====
<pre>%0xxxxxxx</pre>

* <tt>%xxxxxxx</tt> is the music ID to play. The ID currently playing is echoed back to $2142 on the SNES.
** <tt>$09-$0C</tt>, <tt>$0F</tt>, <tt>$10</tt> and <tt>$16</tt> reset the tempo speedup effect done by the Hurry Up! command.

=====Fade Out (Command <tt>$80-$FF</tt>)=====
<pre>%1???????</pre>
Fades out the music by sliding the song volume to zero over 240 tempo ticks.

====CPUIO3 ($2143/$F7)====
This register controls the SFX to play on channel 7.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>xx</tt> <tt>$01-$FF</tt> || Play SFX Sequence Set 2
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence Set 2 (Command <tt>$01-$FF</tt>)=====
<pre>xx</pre>

* <tt>xx</tt> is the SFX ID to play. The ID currently playing is echoed back to $2143 on the SNES.
** <tt>$05</tt>, <tt>$1D</tt> and <tt>$24</tt> cannot be interrupted by any other instances. In order of priority, though, <tt>$24</tt> can interrupt <tt>$1D</tt>, which in turn can interrupt <tt>$05</tt>.

The <tt>$FF</tt> VCMD for this set only is programmed to move the pointer back one byte instead of forward.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

===Pilotwings===
====CPUIO0 ($2140/$F4)====
This register plays the music and controls the BRR wind noise.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%xyyzzzzz</tt> <tt>$01-$FE</tt> || Play Music/BRR Wind Noise Frequency
|-
|<tt>$FF</tt> || Fade Out
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play Music/BRR Wind Noise Frequency (Command <tt>$01-$FE</tt>)=====
Input<pre>%xyzaaaaa</pre>
Output<pre>%000aaaaa</pre>
Plays a piece of music.
* <tt>%x</tt> disables BRR wind noise playback on channel 8. This is forced on IDs <tt>$02</tt>, <tt>$0D</tt> and <tt>$11</tt> if <tt>%x</tt>, <tt>%y</tt> and <tt>%z</tt> are all zero.
* <tt>%y</tt>, with <tt>%x</tt> cleared, enables a higher-frequency wind noise. This takes precedence over <tt>%z</tt>.
* <tt>%z</tt>, with <tt>%x</tt> cleared, enables a lower-frequency wind noise.
* <tt>%aaaaa</tt> is the music ID. If zero, then the music will keep playing normally. Although the absolute limit is <tt>$1F</tt>, in reality it's <tt>$15</tt> because the song table only goes that high up ID-wise. The ID currently playing is echoed back to $2140 on the SNES.

=====Fade Out (Command <tt>$FF</tt>)=====
Fades out the music by sliding the song volume to zero over 192 tempo ticks.

====CPUIO1 ($2141/$F5)====
This register controls the sound effects in channels 3 and 8.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>xy</tt> <tt>$01-$FE</tt> || Play SFX Sequence
|-
|<tt>$FF</tt> || Load Data
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence (Command <tt>$01-$FE</tt>)=====
Input<pre>xy</pre>
Output<pre>0y</pre>

Two SFX can be triggered at once. Plus, each one has its own SFX collection to use.

* <tt>x</tt> is a four-bit/one nibble SFX ID for channel 8.
** <tt>$E</tt> mutes all other channels sound upon playing the SFX (including the music, which causes new values to not be acknowledged). Any other ID played afterwards unmutes the music. This also cannot be interrupted by other SFX value entered here except for <tt>$F</tt>.
** <tt>$1</tt> cannot be interrupted by other SFX in this same area except for <tt>$E</tt> and <tt>$F</tt>.
** <tt>$5</tt> plays nothing, although it still works for unmuting music and other channels.
* <tt>y</tt> is a four-bit/one nibble SFX ID for channel 3. The ID currently playing is echoed back to $2141 on the SNES.
** Some SFX are not interruptible. In order of uninterruptibility priority with other SFX IDs, we have <tt>$A</tt>, <tt>$7</tt> (<tt>$5</tt> is allowed to overwrite <tt>$7</tt> in this instance), then <tt>$9</tt>.
** <tt>$F</tt> plays nothing.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

=====Load Data (Command <tt>$FF</tt>)=====
The operation is slightly different depending on what build you're using. Both clean up DSP registers first: specifically by keying off all notes and zeroing out the EVOL DSP registers, along with disabling echo writes. Additionally, the European version clears out the EON DSP register, and the other versions mute the amplifier until the loading routine exits.

The European version jumps directly to the IPL Boot ROM, while all other versions instead use a modified copy.

See [[N-SPC_Engine#Load_New_Data_.28Command_.24FF.29|the source build's Load New Data command]] command for the loading protocol for the non-European versions, as it is identical binary-wise to the copy used in this one minus the *Ver S1.20* string.

====CPUIO2 ($2142/$F6)====
This controls the aircraft engine noise in channels 5 and 6.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%0xyyyyyy</tt> <tt>$00-$7F</tt> || Engine Control
|-
|<tt>%10xxxxxx</tt> <tt>$80-$BF</tt> || Break
|-
|<tt>%11??????</tt> <tt>$C0-$FE</tt> || Skid
|-
|<tt>$FF</tt> || Stop Engine
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Engine Control (Command <tt>$01-$7F</tt>)=====
<pre>%0xyyyyyy</pre>

The current engine value is echoed back to $2142 on the SNES.

* <tt>%x</tt>, when starting the aircraft engine, determines what kind of noise it makes. A different command (other than NOP) must be used before changing the engine noise.
* <tt>%yyyyyy</tt> controls the engine noise frequency.

=====Break (Command <tt>$80-$BF</tt>)=====
<pre>%10xxxxxx</pre>

* <tt>%xxxxxx</tt> only does something different when set to <tt>$01</tt>, which is a slight pitch variant. Otherwise, there's not much control here.

=====Skid (Command <tt>$C0-$FE</tt>)=====
<pre>%11??????</pre>

=====Stop Engine (Command <tt>$FF</tt>)=====
Basically acts as a reset for the aircraft engine back to default settings, in addition to stopping it.

====CPUIO3 ($2143/$F7)====
This controls a couple of pieces of miscellaneous SFX on channel 4. The ID currently playing is echoed back to $2143 on the SNES.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt>, <tt>$03-$FF</tt> || NOP
|-
|<tt>$01</tt> || Engine-Controlled SFX
|-
|<tt>$02</tt> || Beep
|}

=====NOP (Command <tt>$00</tt>, <tt>$03-$FF</tt>)=====
Does absolutely nothing.

=====Engine-Controlled SFX (Command <tt>$01</tt>)=====
Plays a fixed sequence of notes on channel 4 at a variable note length controlled by the engine frequency that goes faster the higher the frequency. Only works with a CPUIO2 value of <tt>$02-$11</tt>: otherwise, it's a NOP.

The note length used is defined as <tt>$1B</tt> minus the frequency of the engine shifted right. This value is decremented twice on the last note.

=====Beep (Command <tt>$02</tt>)=====
Plays a single note on channel 4. No other conditions are required here.

==Instrument Format==
Compared to common N-SPC, this is mostly the same, except it is missing the pitch base fractional multiplier, and V0.0 doesn't have noise support. Otherwise, it's the same as before, defined as following... 

V0.0
<pre>yy zz aa bb cc</pre>
V0.1
<pre>%xyyyyyyy zz aa bb cc</pre>
* <tt>x</tt> is a noise clock switch. This is only valid in V0.1.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> (or just <tt>yy</tt> for V0.0) is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.

==Percussion Format==
Percussion is stored separately from the instrument format in the prototype version, because its format is nearly identical to an instrument, but it contains an extra byte at the end that defines the note to play. Thus, these bytes are defined as following... 
V0.0
<pre>yy zz aa bb cc dd</pre>
V0.1
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>x</tt> is a noise clock switch. This is only valid in V0.1.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> (or just <tt>yy</tt> for V0.0) is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is the note to play the percussion note at.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play. This is mostly identical to standard N-SPC, except it doesn't have fast forward commands.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>%1??????? $00</tt> <tt>$80-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$01-$7F $00</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Always Jump (Command <tt>$80-$FF $00</tt>)===
<pre>%1??????? $00 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
The IDs are different due to being an earlier version, and some VCMDs may not be defined yet. The ones that are used are listed below.

{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || Phrase Termination/End of Subroutine ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>xy</tt>
|-
|<tt>$80-$C5</tt> || Note ||
|-
|<tt>$C6</tt> || Tie ||
|-
|<tt>$C7-$CF</tt> || Rest ||
|-
|<tt>$D0-$D9</tt> || Percussion ||
|-
|<tt>$DA</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$DB</tt> || Panning || <tt>%xyzzzzz</tt>
|-
|<tt>$DC</tt> || Panning Fade || <tt>xx yy</tt>
|-
|<tt>$DD</tt> || Pitch Slide to Note || <tt>xx yy zz</tt>
|-
|<tt>$DE</tt> || Vibrato On || <tt>xx yy zz</tt>
|-
|<tt>$DF</tt> || Vibrato Off ||
|-
|<tt>$E0</tt> || Song Volume || <tt>xx</tt>
|-
|<tt>$E1</tt> || Song Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$E2</tt> || Tempo || <tt>xx</tt>
|-
|<tt>$E3</tt> || Tempo Fade || <tt>xx yy</tt>
|-
|<tt>$E4</tt> || Global Absolute Transposition || <tt>xx</tt>
|-
|<tt>$E5</tt> || Tremolo On || <tt>xx yy zz</tt>
|-
|<tt>$E6</tt> || Tremolo Off ||
|-
|<tt>$E7</tt> || Volume || <tt>xx</tt>
|-
|<tt>$E8</tt> || Volume Fade || <tt>xx yy</tt>
|-
|<tt>$E9</tt> || Subroutine || <tt>xx xx yy</tt>
|-
|<tt>$EA</tt> || Vibrato Fade In || <tt>xx</tt>
|-
|<tt>$EB</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$EC</tt> || Note Pitch Envelope From || <tt>xx yy zz</tt>
|-
|<tt>$ED</tt> || Invalid (supposed to be Note Pitch Envelope Off) ||
|-
|<tt>$EE</tt> || Fine Tune || <tt>xx</tt>
|-
|<tt>$EF</tt> || Echo Enable Bits and Volume || <tt>%xxxxxxxx yy zz</tt>
|-
|<tt>$F0</tt> || Echo Off ||
|-
|<tt>$F1</tt> || Echo Parameter Setup || <tt>xx yy zz</tt>
|-
|<tt>$F2</tt> || Echo Volume Fade || <tt>xx yy zz</tt>
|-
|<tt>$F3-$FF</tt> || Invalid ||
|}

''TODO use a template for the above table for standard VCMDs''

Most of these essentially act identically to the common versions (refer back to the main page for info on those), but two of the VCMDs don't work properly: Note Pitch Envelope Off, which has a zeroed out pointer but the code does exist, and Tremolo On, which has a memory location definition bug for one of the parameters that conflicts with an internal value utilized by the tremolo, causing constant overwriting and making the command not work in general.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

David Whittaker Sound Engine

2023-09-23T22:05:18Z

KungFuFurby: Adding info for a second build found in World Class Rugby

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta's Title Screen and ''Lawnmower Man/Virtual Wars''' US Beta
* ''Lemmings 2: The Tribes'' ' most common build and ''Riddick Bowe Boxing'''s Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| ''Dream TV'' || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| ''Krusty's Super Fun House'' || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| ''Kick Off/Super Kick Off'' || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| ''Batman: Revenge of the Joker'' || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| ''Super SWIV/Firepower 2000'' || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| ''Gods'' || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| ''World Class Rugby'' || 2.3 || <tt>0x0608</tt>/<tt>N/A</tt> || <tt>0x021D64</tt>/<tt>0x0B8000</tt> (all versions)
|-
| ''Battle Cars'' || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| ''Chavez/Riddick Bowe Boxing'' || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except ''Chavez'') (three unique build variants, one per version between ''Chavez'', US & Japanese versions)
|-
| ''Lawnmower Man/Virtual Wars'' || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| ''Apocalypse II'' || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| ''Elite Soccer/World Cup Striker'' || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| ''Kick Off 3'' (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| ''Lemmings 2: The Tribes'' || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| ''Porky Pig's Haunted Holiday'' (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| ''Shaq Fu'' || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| ''Michael Jordan: Chaos in the Windy City'' || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are present.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Main Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Main & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Main Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* ''Apocalypse II'' (Opening logo)/''Lemmings 2: The Tribes'' (Opening logo)
* ''Kick Off 3'' (Beta) (In-Game)
* ''World Class Rugby'' (During a game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** ''Dream TV'' (beta and final): '''2X'''
*** All other games: '''4X'''
*** ''Batman: Revenge of the Joker'', ''Krusty's Super Fun House'', ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', ''Shaq-Fu'', ''Super SWIV/Firepower 2000'': '''8X'''

The following builds don't support this command:
* ''Gods'' (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Main & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the main volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** ''Batman: Revenge of the Joker'': '''1/4'''
*** ''Dream TV'': '''1/4'''
*** ''Gods'' (all builds): '''3/16'''
*** ''World Class Rugby'' (Outside of a game): '''3/16'''
*** ''Lawnmower Man/Virtual Wars'' (Driving): '''3/16'''
*** ''Lemmings 2: The Tribes'' (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* ''Batman: Revenge of the Joker''
* ''Dream TV''
* ''Gods'' (all builds)
* ''World Class Rugby'' (Outside of a game)
* ''Lawnmower Man/Virtual Wars'' (Driving)
* ''Lemmings 2: The Tribes'' (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* ''Battle Cars''
* ''Riddick Bowe Boxing/Chavez'' (all versions except Japanese)
* ''Shaq-Fu''

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

The following builds don't support this command:
* ''World Class Rugby'' (During a game)

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* ''Battle Cars''
* ''World Cup Striker'' (European version) (Title Screen)
* ''Elite Soccer/World Cup Striker'' (European version) (In-Game)
* ''Kick Off 3'' (beta) (In-Game)
* ''Kick Off 3'' (beta) (Title Screen)
* ''Porky Pig's Haunted Holiday'' (beta)
* ''Shaq-Fu''

Not all IDs are supported in these builds...
* ''Lawnmower Man/Virtual Wars'' (In-Game) ''(does not support $1A-$1D, not even in the code)''
* ''World Cup Striker (Japanese)'' (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For ''Dream TV'' Beta and ''Kick Off'', only five pointers are defined. For ''Krusty's Super Fun House'', only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (''Dream TV Beta'' and ''Kick Off'')
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (''Krusty's Super Fun House'')
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(''Krusty's Super Fun House'' only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Three builds don't support song entries at all:
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta (In-Game)
* ''World Class Rugby'' (During a game)

''World Class Rugby'' (During a game) also doesn't support the music format at all since the code was removed.

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Main Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Main Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine/Build Sorting

2023-09-23T21:58:46Z

KungFuFurby: One new build and changing formatting to match other wiki pages' game highlighting

{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Dream TV'' (Beta 2) || <tt>$0800</tt> || <tt>D0 E8 E8 ?? 3F ?? ??</tt> || <tt>$0BF4</tt> ||
|-
|''Kick Off'' || <tt>$0300</tt> || <tt>D0 F7 3F ?? ??</tt> || <tt>$079D</tt> ||
|-
|''Krusty's Super Fun House'' (version 1) ''(Only version used in the Japanese version)'' || <tt>$0300</tt> || <tt>D0 F7 3F ?? ??</tt> & <tt>D0 F5 3F ?? ??</tt> || <tt>$079D</tt> & <tt>$0994</tt> ||
|-
|''Krusty's Super Fun House'' (version 2) || <tt>$0300</tt> || <tt>D0 F7 3F ?? ??</tt> & <tt>D0 F5 3F ?? ??</tt> || <tt>$079D</tt> & <tt>$0999</tt> ||
|-
|''Gods'' (Ending) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$080D</tt> ||
|-
|''Gods'' (Title Screen & In-Game) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$090D</tt> || Two copies of the code found in ROM.
|-
|''World Class Rugby'' (Outside of a game)|| <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$0915</tt> ||
|-
|''Batman: Revenge of the Joker'' || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> & <tt>CD ?? 3F ?? ??</tt> || <tt>$091F</tt> & <tt>$05E4</tt> ||
|-
|''Gods'' (Opening) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> & <tt>CD ?? 3F ?? ??</tt> || <tt>$091F</tt> & <tt>$05EB</tt> ||
|-
|''Dream TV'' || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$0923</tt> ||
|-
|''Lemmings 2: The Tribes'' (Cavelem Tribe) || <tt>$0200</tt> || <tt>D0 F4 3F ?? ??</tt> || <tt>$09D8</tt> ||
|-
|''World Class Rugby'' (During a game) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$051C</tt> ||
|-
|''Super SWIV/Firepower 2000'' || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$08BC</tt> ||
|-
|''Apocalypse II'' (Opening Logo) ''Lemmings 2: The Tribes'' (Opening Logo)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$08F0</tt> ||
|-
|''Lemmings 2: The Tribes'' (Beach Tribe) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0950</tt> ||
|-
|''Lemmings 2: The Tribes'' (Title Screen) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0955</tt> ||
|-
|''Lemmings 2: The Tribes'' (Most common build used) ''Riddick Bowe Boxing'' (Japanese version) || <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0962</tt> || 12 copies of the code found in ROM for Lemmings 2: The Tribes.
|-
|''Apocalypse II'' (In-Game)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0965</tt> ||
|-
|''Kick Off 3'' (Beta) (In-Game)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0999</tt> ||
|-
|''Kick Off 3'' (Beta) (Title Screen) ''Lawnmower Man/Virtual Wars'' (US Beta)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$09FE</tt> ||
|-
|''Porky Pig's Haunted Holiday'' (Beta)|| <tt>$0200</tt> || <tt>D0 FA 3F ?? ??</tt> || <tt>$0A0B</tt> || Contains an opening jump. 36 copies of the code found in ROM.
|-
|''Shaq Fu''|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0874</tt> ||
|-
|''Elite Soccer/World Cup Striker'' (Japanese version) (Title Screen)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0947</tt> ||
|-
|''Riddick Bowe Boxing'' (US version)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0947</tt> || Two copies of the code found in the ROM. Between the two, there were lots of memory location reference-related differences, but none were actual opcode-related executions, so it's considered a match.
|-
|''Chavez''|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$09B9</tt> ||
|-
|''Lawnmower Man/Virtual Wars'' (In-Game)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$09E0</tt> ||
|-
|''Elite Soccer/World Cup Striker'' (European version) (In-Game)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A3B</tt> ||
|-
|''Battle Cars''|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A3C</tt> ||
|-
|''World Cup Striker'' (Japanese version) (In-Game)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A3E</tt> ||
|-
|''World Cup Striker'' (European version) (Title Screen)|| <tt>$0200</tt> || <tt>E8 ?? C4 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A47</tt> ||
|-
|''Lawnmower Man/Virtual Wars'' (Driving)|| <tt>$0200</tt> || <tt>E8 ?? 8D ?? 3F ?? ??</tt> || <tt>$0A6F</tt> ||
|-
|''Michael Jordan: Chaos in the Windy City''|| <tt>$0200</tt> || <tt>CD ?? 3F ?? ??</tt> || <tt>$052E</tt> ||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine

2023-09-10T19:40:31Z

KungFuFurby: Made an error on the NOP command with the source variant (it skips two bytes, not one)

__TOC__

'''Nintendo SPC Sound Engine''', abbreviated N-SPC and officially known as Kankichi-kun [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun], is the most common sound engine used in all of the SNES/SFC games. Only the music portion was initially provided in the source code included in the IS-Sound unit along with some templating for a protocol for music and sound effects [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system]: usually it was modified by developers on an individual basis, resulting in many different variants, some of them more heavily modifying the sound driver than others. Usually what was added on was sound effect support, but sometimes the music VCMDs were modified as well.

The following games are purely based off of the source code provided with the IS-Sound unit, and are either unmodified or barely modified, if at all:
{| class="wikitable sortable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Hong Kong '97'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0F800A</tt> (both versions)
|-
| ''SM Choukyoushi Hitomi - Bangai Hen'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x03801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 2 Remix'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x018058</tt>
|-
| ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1) || <tt>0x0DF0</tt>, relative to <tt>0x0D30</tt> || <tt>0x018076</tt>
|-
| ''Wheel of Fortune - Deluxe Edition'' ''(unused)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01D842</tt>
|}
Of the games listed here, two of them are very minor edits...
* ''Wheel of Fortune - Deluxe Edition'''s build is unused and is missing an opcode near the *Ver S1.20* string. In addition, that section is actually unused, because instead new code at $0700 is used to substitute for this one... which happens to be an exact match to the original IPL Boot ROM.
* ''SM Choukyoushi Hitomi Vol. 3'' (Alt 1)'s program starts with a JMP opcode, and contains a NOP between the first and second opcodes of the actual program.

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

==Communication with the SNES==
NOTE: This is not representative of every single variant. Instead, it represents the collection of commands from the source code included in the IS-Sound unit, which in turn may be carried over to most variants.

The only register that is used for communication in the source build is $2140 (SNES side)/$F4 (SPC side), except for the load command. Other registers are not even read from, though the code itself sets up the framework to do so.

===Output to the SNES===
<pre>xx ?? ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.

===Command IDs===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

===Stop Music (Command <tt>$00</tt>)===
Initializes an invalid phrase pointer, then stops the previous piece of music. This is not compatible with the resume command, as it is irrevocable, unlike the other one.

===Play Music (Command <tt>$01-??</tt>)===
Stops a previous piece of music, then plays a piece of music by the ID specified in the command.

===Pause Music (Command <tt>$F0</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$F1</tt>)===
Resumes a paused song.

===Load New Data (Command <tt>$FF</tt>)===
Jumps to a modified copy of the IPL Boot ROM (except for Wheel of Fortune - Deluxe Edition, where there is an opcode missing, the jump location is different, and it contains an exact copy of the IPL Boot ROM).

''TODO Loading New Data (the loading protocol is nearly identical to IPL Boot ROM, with a couple of differences)''

==Instrument Format==
The instrument format is most commonly defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this....
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>%x</tt> is a [[S-DSP/Noise|noise clock]] switch.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is a fractional pitch base multiplier, defined in 256ths.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>$80 $00</tt> || Fast Forward On ||
|-
|<tt>$81 $00</tt> || Fast Forward Off ||
|-
|<tt>%1??????? $00</tt> <tt>$82-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$00 $01-$7F</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Fast Forward On (Command <tt>$00 $80</tt>)===
<pre>$80 $00</pre>
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (Command <tt>$00 $81</tt>)===
<pre>$81 $00</pre>
Disables Fast Forward and continues playing the song normally.

===Always Jump (Command <tt>$00 $82-$FF</tt>)===
<pre>%1??????? $00 xx xx</pre>
Only executes if the fast forward commands are not triggered.
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
NOTE: This is not representative of every single variant. Instead, it represents the collection of VCMDs from the source code included in the IS-Sound unit, which in turn is carried over to most variants.

{{N-SPC VCMD Set Table}}

===Invalid (VCMD <tt>$FF</tt>)===
Crashes the sound driver due to being outside of the array of pointers, and thus jumping to an invalid pointer.

===NOP (VCMD <tt>$FB</tt>)===
<pre>$FB ?? ??</pre>
Reads two bytes, then does absolutely nothing with the command.

===Phrase Termination/End of Subroutine (VCMD <tt>$00</tt>)===
This VCMD's operation depends on whether or not it is inside a subroutine or not.
If it is inside a subroutine, it exits the subroutine and song execution continues.
Otherwise, the phrase is terminated. This affects ''all'' channels in the music: any other channels still playing are interrupted.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (%0yyyzzzz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>%yyy</tt>, if the highest bit of the byte is not set, defines the quantization. It is an index value to a table of values that indicate, in 256ths, how far along the note to play before keying it off. This table can vary on a per-game basis.
* <tt>%zzzz</tt>, which is only defined if the highest bit of the byte is not set, defines the velocity. It is an index to a table of values that indicate the volume in a decibel-like number (due to the final volume calculation being multiplied by itself at the end). This table can vary on a per-game basis.

Notes and/or special VCMDs, by default, are forced after the parameter byte is read. Attempting to use <tt>$00-$7F</tt> again results in an invalid note.

===Note (VCMD <tt>$80-$C7</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Tie (VCMD <tt>$C8</tt>)===
Continues playing the previous note and delays the channel for one note length before reading another VCMD.

===Rest (VCMD <tt>$C9</tt>)===
Keys off the previous note and delays the channel for one note length before reading another VCMD.

===Percussion (VCMD <tt>$CA-$DF</tt>)===
Plays a percussion note.

By default, percussion uses the same instrument set as the song, and all percussion is keyed on with a note of <tt>$A4</tt>.
The starting ID to use for all channels can be redefined by VCMD <tt>$FA</tt>.

===Instrument (VCMD <tt>$E0</tt>)===
<pre>$E0 xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Panning (VCMD <tt>$E1</tt>)===
<pre>$E1 %xyzzzzz</pre>
* <tt>%x</tt> defines a phase inversion switch for the left channel.
* <tt>%y</tt> defines a phase inversion switch for the right channel.
* <tt>%zzzzz</tt> is five bits for the panning. This refers to an array of values to multiply the volume by after calculating the voice volume via various other parameters set by the VCMDs. Under normal circumstances, center is defined as <tt>$0A</tt> and the maximum value is <tt>$14</tt>.

===Panning Fade (VCMD <tt>$E2</tt>)===
<pre>$E2 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target pan value. Phase inversion is ''not'' taken into account here, thus only the low five bits should be used here.

===Vibrato On (VCMD <tt>$E3</tt>)===
<pre>$E3 xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the vibrato for.
* <tt>yy</tt> is the rate of the vibrato: specifically, how much to change the pitch on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the vibrato: that is, the maximum pitch offset to use. <tt>$00-$F0</tt> are normal, but <tt>$F1</tt> and up act more like said value ANDed by <tt>$0F</tt> and multiplied by <tt>$0100</tt>, meaning the highest values have drastic differences compared to the lower ones.

===Vibrato Off (VCMD <tt>$E4</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Song Volume (VCMD <tt>$E5</tt>)===
<pre>$E5 xx</pre>
* <tt>xx</tt> is the song volume value. This sets the volume for all of the channels in the song. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Song Volume Fade (VCMD <tt>$E6</tt>)===
<pre>$E6 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target song volume.

===Tempo (VCMD <tt>$E7</tt>)===
<pre>$E7 xx</pre>
* <tt>xx</tt> defines one tempo tick as one timer 0 tick multiplied by <math>\frac{256}{x}</math>. Zero freezes the song.

===Tempo Fade (VCMD <tt>$E8</tt>)===
<pre>$E8 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target tempo.

===Global Absolute Transposition (VCMD <tt>$E9</tt>)===
<pre>$E9 xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes. Note that this affects all channels, not just one channel.

===Single Channel Absolute Transposition (VCMD <tt>$EA</tt>)===
<pre>$EA xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes.

===Tremolo On (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the tremolo for.
* <tt>yy</tt> is the rate of the tremolo: specifically, how much to change the volume on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the tremolo: that is, the maximum volume offset to use.

===Tremolo Off (VCMD <tt>$EC</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Volume (VCMD <tt>$ED</tt>)===
<pre>$ED xx</pre>
* <tt>xx</tt> is the volume value. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Volume Fade (VCMD <tt>$EE</tt>)===
<pre>$EE xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target volume.

===Subroutine (VCMD <tt>$EF</tt>)===
<pre>$EF xx xx yy</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer containing the section of music to play.
* <tt>yy</tt> is the number of times to loop the sub-routine.

===Vibrato Fade In (VCMD <tt>$F0</tt>)===
<pre>$F0 xx</pre>
* <tt>xx</tt> is the number of tempo ticks to fade the vibrato for.
The moment this VCMD is executed, the depth is faded in from zero.

===Note Pitch Envelope To (VCMD <tt>$F1</tt>)===
<pre>$F1 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note to.

===Note Pitch Envelope From (VCMD <tt>$F2</tt>)===
<pre>$F2 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note from: that is, unlike Note Pitch Envelope To (VCMD <tt>$F1</tt>), this is a starting note offset, rather than an end of pitch envelope note offset.

===Note Pitch Envelope Off (VCMD <tt>$F3</tt>)===
Disables a pitch envelope.

===Fine Tune (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines the amount to shift the pitch up. This is in 256ths of a semitone, albeit done via measuring the distance between note and multiplying it by this value.

===Echo Enable Bits and Volume (VCMD <tt>$F5</tt>)===
<pre>$F5 %xxxxxxxx yy zz</pre>
* <tt>%xxxxxxxx</tt> defines the channels to turn on for the echo (one per bit), which translates to a direct write to the EON DSP register.
* <tt>yy</tt> defines a value for EVOLL DSP register.
* <tt>zz</tt> defines a value for EVOLR DSP register.

===Echo Off (VCMD <tt>$F6</tt>)===
This disables echo for ''all'' channels, as well as zeroing out the echo volume and disabling echo writes.

===Echo Parameter Setup (VCMD <tt>$F7</tt>)===
<pre>$F7 xx yy zz</pre>
* <tt>xx</tt> defines a value for the EDL DSP register.
* <tt>yy</tt> defines a value for the EFB DSP register.
* <tt>zz</tt> defines an ID to an array of FIR coefficient values.

===Echo Volume Fade (VCMD <tt>$F8</tt>)===
<pre>$F8 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> defines the target value for EVOLL DSP register.
* <tt>zz</tt> defines the target value for EVOLR DSP register.

===Pitch Slide To Note (VCMD <tt>$F9</tt>)===
<pre>$F9 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to delay the slide for.
* <tt>yy</tt> defines the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is the target note.

===Percussion Base Instrument ID Redefine (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is the starting instrument ID. Note that this affects all channels.

===Channel Mute (VCMD <tt>$FC</tt>)===
Causes the channel to not key on subsequent notes.

===Fast Forward On (VCMD <tt>$FD</tt>)===
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (VCMD <tt>$FE</tt>)===
Disables Fast Forward and continues playing the song normally.

==Variants==
===Shijou Saikyou no Quiz Ou Ketteisen Super===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Shijou Saikyou no Quiz Ou Ketteisen Super'' || <tt>0x0DF7</tt>, relative to <tt>0x0D37</tt> || <tt>0x038062</tt>/<tt>0x04805C</tt>/<tt>0x058062</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

This is the closest match to a standard source N-SPC/Kankichi build used in a licensed game. This is because the only modifications made to it are to echo what was sent to any register to $2141/$F5 (although in practice only $2140/$F4 is read from, thus de facto giving it the same output, otherwise it would be cycling between the last register read code-wise as output) and zero out both $2140/$F4 and $2141/$F5 when the song is done playing when a zero pointer is read from a phase.

====Output to the SNES====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.
* <tt>yy</tt> is a de-facto mirror of <tt>xx</tt> output-wise. The feedback is a little faster, though, since the output is immediately upon $2140/$F4 being read, rather than when the music is initialized.

===Controller Test/World Class Service Super Nintendo Tester===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Controller Test || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x009319</tt> (Controller Test Cassette) <tt>0x00BFFF</tt> (SNES Burn-In Test Cartridge) <tt>0x00D8D2</tt> (World Class Service Super Nintendo Tester ''(not used)'')
|-
| World Class Service Super Nintendo Tester ''(only build used across all tests)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0B8068</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

These two sound driver builds (the one for the controller test being found in three different known testing cartridges, with one of them not used) merely have code optimizations in their sound code, thus making them completely identical execution-wise to the source build variant. In addition, the build used for World Class Service Super Nintendo Tester adds a BMI opcode in a readahead routine, but is otherwise identical.

===Subpages===
{{Subpages}}

Not created yet...
* [[N-SPC Engine/64WD Creation|64WD Creation]]
* [[N-SPC Engine/Advance Communication|Advance Communication]]
* [[N-SPC Engine/Aisystem Tokyo|Aisystem Tokyo]]
* [[N-SPC Engine/Argonaut|Argonaut]]
* [[N-SPC Engine/Axes Art Amuse|Axes Art Amuse]]
* [[N-SPC Engine/Bit Managers|Bit Managers]]
* [[N-SPC Engine/Capcom|Capcom]]
* [[N-SPC Engine/Chatnoir|Chatnoir]]
* [[N-SPC Engine/Chip Level Designs|Chip Level Designs]]
* [[N-SPC Engine/CP.BRAiN|CP.BRAiN]]
* [[N-SPC Engine/Cream|Cream]]
* [[N-SPC Engine/Crosstalk|Crosstalk]]
* [[N-SPC Engine/Cube|Cube]]
* [[N-SPC Engine/CUE|CUE]]
* [[N-SPC Engine/Culture Brain|Culture Brain]]
* [[N-SPC Engine/Daft|Daft]]
* [[N-SPC Engine/Data East|Data East]]
* [[N-SPC Engine/EJ Corporation|EJ Corporation]]
* [[N-SPC Engine/Electronic Arts|Electronic Arts]]
* [[N-SPC Engine/Falcom|Falcom]]
* [[N-SPC Engine/Funcom|Funcom]]
* [[N-SPC Engine/Gremlin|Gremlin]]
* [[N-SPC Engine/HAL|HAL]]
* [[N-SPC Engine/Hanari Exp|Hanari Exp]]
* [[N-SPC Engine/Hect|Hect]]
* [[N-SPC Engine/Hikoshi Hashimoto|Hikoshi Hashimoto]]
* [[N-SPC Engine/Home Data|Home Data]]
* [[N-SPC Engine/Human (earlier)|Human (earlier)]]
* [[N-SPC Engine/Human|Human]]
* [[N-SPC Engine/Imagesoft|Imagesoft]]
* [[N-SPC Engine/Infogrames|Infogrames]]
* [[N-SPC Engine/Intelligent Systems|Intelligent Systems]]
* [[N-SPC Engine/Japan Art Media|Japan Art Media]]
* [[N-SPC Engine/Jorudan|Jorudan]]
* [[N-SPC Engine/Kazuo Sawa|Kazuo Sawa]]
* [[N-SPC Engine/Kennosuke Suemura|Kennosuke Suemura]]
* [[N-SPC Engine/Khaos|Khaos]]
* [[N-SPC Engine/Koei|Koei]]
* [[N-SPC Engine/Konami|Konami]]
* [[N-SPC Engine/LaserSoft|LaserSoft]]
* [[N-SPC Engine/Make Software|Make Software]]
* [[N-SPC Engine/Metro|Metro]]
* [[N-SPC Engine/Mitsuhito Tanaka|Mitsuhito Tanaka]]
* [[N-SPC Engine/Monolith|Monolith]]
* [[N-SPC Engine/MSQ|MSQ]]
* [[N-SPC Engine/Namco|Namco]]
* [[N-SPC Engine/Naohisa Morota|Naohisa Morota]]
* [[N-SPC Engine/Natsume|Natsume]]
* [[N-SPC Engine/Nichibutsu or Make Software|Nichibutsu/Make Software]] (NOTE: Refers to three of the Super Nichibutsu Mahjong games)
* [[N-SPC Engine/Nova|Nova]]
* [[N-SPC Engine/Ocean|Ocean]]
* [[N-SPC Engine/Pure Sound|Pure Sound]]
* [[N-SPC Engine/Quest|Quest]]
* [[N-SPC Engine/Quintet|Quintet]]
* [[N-SPC Engine/Robert C. Ashworth|Robert C. Ashworth]]
* [[N-SPC Engine/Sakata SAS|Sakata SAS]]
* [[N-SPC Engine/Saurus|Saurus]]
* [[N-SPC Engine/Sunsoft|Sunsoft]]
* [[N-SPC Engine/Syscom|Syscom]]
* [[N-SPC Engine/System Sacom|System Sacom]]
* [[N-SPC Engine/Systemsoft|Systemsoft]]
* [[N-SPC Engine/T's Music|T's Music]]
* [[N-SPC Engine/TamTam|TamTam]]
* [[N-SPC Engine/Team X-Fade|Team X-Fade]]
* [[N-SPC Engine/Technos Japan|Technos Japan]]
* [[N-SPC Engine/Technosoft|Technosoft]]
* [[N-SPC Engine/Tecmo|Tecmo]]
* [[N-SPC Engine/Tose|Tose]]
* [[N-SPC Engine/Tsukasa Masuko|Tsukasa Masuko]]
* [[N-SPC Engine/Virgin|Virgin]]
* [[N-SPC Engine/Wave|Wave]]
* [[N-SPC Engine/Yoshikazu Yao|Yoshikazu Yao]]
* [[N-SPC Engine/Yoshiyuki Ishii|Yoshiyuki Ishii]]

''TODO: There are a lot of variants... these will be split into sub-pages depending on the modifications made''

==References==
* [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun Video Game Music Preservation Foundation - Kankichi-kun]
* [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system Retro Reversing - SNES (Super Famicom) Development Kit Hardware - Intelligent Systems SHVC Development System]
* [https://wiki.superfamicom.org/nintendo-music-format-(n-spc) Super Famicom Wiki - N-SPC]
* [http://gdri.smspower.org/wiki/index.php/Super_Famicom/Super_NES_Sound_Driver_List GDRI - Super Famicom/Super NES Sound Driver List]
* [https://github.com/vgmtrans/vgmtrans/issues/173 Github - N-SPC VCMD $FB-$FE identifications]
* [https://archive.org/details/GameBoyProgManVer1.1/page/n187/mode/2up Game Boy Development Manual - Super Game Boy Sound] (see pages 187-213)

[[Category:SPC Sound Engines]]

N-SPC Engine/Nintendo/Build Sorting

2023-09-04T17:40:00Z

KungFuFurby:

__TOC__

==Unique cases==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Aging Cassette'' ''SNES Burn-In Test Cartridge''|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$113A</tt>||For distinguishing purposes, known outside of these notes as ''Sound Module and Burn-In Test'' to refer to the copy found in the ''SNES Burn-In Test Cartridge''.
|-
|''Nintendo Power Menu Program'' || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|}

==F-Zero Builds==
This game has multiple revisional builds known.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''F-Zero'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1776</tt>||
|-
|''F-Zero'' (Beta)|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1778</tt>||
|}

==Tetris & Dr. Mario Builds==
These builds are unique to one game, but unlike Super Scope 6 (which you may have noticed that LazerBlazer and Blastris are separated due to different SFX execution), they also match in general execution.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Tetris and Dr. Mario'' (Mixed Match) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$118F</tt>||
|-
|''Tetris and Dr. Mario'' (Dr. Mario) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$1199</tt>||
|-
|''Tetris and Dr. Mario'' (Tetris) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$11A1</tt>||
|}

==Akito Nakatsuka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Scope 6'' (LazerBlazer) (US version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B33</tt>||
|-
|''Super Scope 6'' (LazerBlazer) (Japanese and European version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B37</tt>||
|-
|''Super Game Boy'' ''Super Game Boy 2'' || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0A5D</tt>||
|-
|''BS-X BIOS'' ''Cassette Kensaki - NUS-you S Cassette'' || <tt>$0370</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$04AB</tt>||
|-
|''JRA PAT'' ''JRA PAT - Wide Taiouban'' || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$0739</tt>||
|-
|''Sutte Hakkun'' || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$074C</tt>||
|}

===Yuichi Ozaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Marvelous - Mouhitotsu no Takara-jima'' || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0BC5</tt>||
|-
|''SA-1 Demo'' || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B23</tt>||
|-
|''Heisei Shin Onigashima - Kouhen'' ''Heisei Shin Onigashima - Zenpen'' || <tt>$0400</tt> || <tt>D0 F3 8F ?? ?? BC 3F ?? ??</tt> || <tt>$0C8D</tt>||
|}

==Hirokazu Tanaka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Mario Paint'' (Beta) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? C4 ?? 3F ?? ??</tt> || <tt>$2625</tt>||
|-
|''Mario Paint'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$1430</tt>||
|-
|''Mother 2/Earthbound'' || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16A5</tt>||
|-
|''Snoopy Concert'' || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16EB</tt>||
|}

==Kenji Yamamoto==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Metroid'' || <tt>$1500</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1ED7</tt>||
|}

==Koji Kondo==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island'' || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0A96</tt>||
|-
|''Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island'' (beta version) || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B08</tt>||
|-
|''Star Fox/Star Wing'' || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B14</tt>||
|-
|''Super Mario All-Stars/Super Mario Collection'' || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0C11</tt>||
|-
|''Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E22</tt>||
|-
|''Star Glider'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E97</tt>|| Prototype of ''Star Fox/Star Wing''.
|-
|''SimCity'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$175D</tt>||
|-
|''Super Donkey 1'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$1DC9</tt>|| Sound driver build is a prototype of ''Legend of Zelda - A Link to the Past'''s.
|}

===Prototype===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Mario World'' (all other versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BC0</tt> ||
|-
|''Super Mario World'' (Super Mario All-Stars + Super Mario World) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BF4</tt> ||
|-
|''Pilotwings'' (European version) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$126A</tt> ||
|-
|''Pilotwings'' (US & Japanese versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$12CD</tt> ||
|}

===Yoji Inagaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Star Fox 2'' (1994-04-01) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>||
|-
|''Star Fox 2'' (1994-04-15) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>|| Except for a single opcode's difference at $064C, all of the code differences are after the SFX data, and thus pointers cannot be fully factored in.
|-
|''Star Fox 2'' (1994-05-06 and 1994-05-13) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B62</tt>||
|-
|''Star Fox 2'' (1994-08-31) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6D</tt>||
|-
|''Star Fox 2'' (1994-12-28) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B9C</tt>||
|-
|''Star Fox 2'' (1995-06-08) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD4</tt>||
|-
|''Star Fox 2'' (1995-06-22) Star Fox 2 (1995-06-27) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD7</tt>|| These builds are identical to each other minus pointers placed after the SFX data.
|-
|''Star Fox 2'' (1995-07-25) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BDA</tt>||
|-
|''Star Fox 2'' || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0BDF</tt>||
|}

==Taro Bando==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Mario Kart'' (beta version) (1992-01-21 build) || <tt>$0800</tt> || <tt>2F ?? BC 3F ?? ??</tt> || <tt>$0E3D</tt> || Refers to a sound.bin file with this timestamp that was not embedded in a known prototype build.
|-
|''Super Mario Kart'' (beta version) (mkart) || <tt>$0800</tt> || <tt>E8 ?? BC 3F ?? ??</tt> || <tt>$0D79</tt>|| Refers to a prototype from April 13, 1992.
|-
|''Super Mario Kart'' (beta version) (mario_kart-01) || <tt>$0800</tt> || <tt>C5 ?? ?? E8 ?? 3F ?? ??</tt> || <tt>$0D65</tt> || Refers to what is known as the Enigma prototype build.
|-
|''Super Mario Kart'' (beta version) (mario_kart) || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$0D74</tt> || Refers to a prototype from late June 1992, created before kar4t.
|-
|''Super Mario Kart'' (beta version) (kar4t) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1598</tt> || Refers to a prototype from late June 1992, created after mario_kart.
|-
|''Super Mario Kart'' (US version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19B4</tt>||
|-
|''Super Mario Kart'' (Japanese and European version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19BA</tt>||
|-
|''FX Trax'' || <tt>$0800</tt> || <tt>D0 F7 E8 ?? 3F ?? ??</tt> || <tt>$0D61</tt>|| Prototype of ''Wild Trax/Stunt Race FX''.
|-
|''Wild Trax/Stunt Race FX'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D73</tt>|| Loading program at $0675 before the actual start location
|}

==Yumiko Kanki==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Special Tee Shot'' (Prototype) || <tt>$0460</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0A78</tt>||
|-
|''Special Tee Shot'' (BS-X version) || <tt>$0400</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0B86</tt>||
|}

==Unknown==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''SNES Burn-In Test Cartridge'' || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0D6D</tt>||For distinguishing purposes, known outside of these notes as ''Super Scope Test''.
|-
|''Super Scope 6'' (Blastris) || <tt>$0800</tt> || <tt>90 F8 BC 3F ?? ??</tt> || <tt>$0D89</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine/Source Variant Build Sorting

2023-09-02T17:36:26Z

KungFuFurby:

{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Controller Test Cassette'' ''SNES Burn-In Test Cartridge'' ''(one of three different builds)'' ''World Class Service Super Nintendo Tester'' ''(one of three different builds, unused)'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt> || <tt>$0D35</tt>, <tt>$0FD7</tt> || For distinguishing purposes, known outside of these notes as simply Controller Test.
|-
|''World Class Service Super Nintendo Tester'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt> || <tt>$0D35</tt>, <tt>$0FD9</tt> ||
|-
|''Wheel of Fortune - Deluxe Edition'' ''(unused)'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt>, <tt>3F ?? ??</tt> at <tt>$09C8</tt> || <tt>$0D35</tt>, <tt>$1004</tt>, <tt>$0700</tt> ||
|-
|''Hong Kong '97'' ''SM Choukyoushi Hitomi - Bangai Hen'' ''SM Choukyoushi Hitomi Vol. 2'' Trial Version ''SM Choukyoushi Hitomi Vol. 2'' ''SM Choukyoushi Hitomi Vol. 2 Remix'' ''SM Choukyoushi Hitomi Vol. 3'' Trial Version || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt>, <tt>3F ?? ??</tt> at <tt>$09C8</tt> || <tt>$0D35</tt>, <tt>$1004</tt>, <tt>$1511</tt> ||
|-
|''SM Choukyoushi Hitomi Vol. 3'' (Alt 1) || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D39</tt> ||
|-
|''Shijou Saikyou no Quiz Ou Ketteisen Super'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D40</tt> ||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

Blargg's trick

2023-07-03T20:40:49Z

KungFuFurby: Go into a little bit more specific detail on how to pull this off...

'''Blargg's trick''' is scene slang for writing to [[DSPRAM]] without writing any [[SPC700]] code by only using the [[SPC700/IPL ROM|IPL ROM]] itself to upload sample data and the directory, then writing directly to the memory locations that the DSP registers are located in $00F2-$00F3 to produce sound.

=== References ===
* https://wiki.superfamicom.org/how-to-write-to-dsp-registers-without-any-spc-700-code

SPC700/IPL ROM

2023-07-03T20:28:02Z

KungFuFurby: Rename step 3 to receive and specify that the SNES is the source

__TOC__

The '''Initial Program Loader Boot ROM''', or IPL ROM, is the very first program executed by the [[SPC700]] on power on. It clears memory locations $00-$EF, then once it does so, it sends a signal to the SNES through two of the CPUIO registers. $0000-$0001 are reserved to hold the pointer, but all other memory locations can be written to. The IPL ROM itself is read-only: if written to, it simply writes to the same memory location that can be accessed when bit 7 of the CONTROL I/O port ($F1) is cleared. It is 64 bytes in size.

The transfer routine at $FFD6 runs once per downloaded block.

At the beginning of the transfer routine, the SPC's [[Y index register]] is used to watch Port 0 until the 5A22 writes a zero to it, which indicates it has uploaded byte 0 of the block to Port 1. Then we enter the inner byte-downloading loop at $FFDA, where Y remembers the less significant byte of the index into the block currently being being downloaded (the "expected byte index" as anomie calls it). The 5A22 sends the less significant byte of the actual index (the "next byte/end" signal as anomie calls it) over Port 0. Y is then incremented.

==Communication with the SNES==
===Step 1 (SPC700 Initializes Itself)===
Output
<pre>$AA $BB ?? ??</pre>
The very first step is for the SPC700 to output two values to $2140/$F4 and $2141/$F5. The SNES must ensure that the SPC700 has finished initializing itself (and clearing out memory locations $0000-$00EF) by confirming these two values are present in those two registers: only then may the SNES send commands.

===Step 2 (Execute Command)===
Input
<pre>$CC xx yy yy</pre>
* <tt>xx</tt> indicates what you want to do. If this is zero, then the program jumps to <tt>yy yy</tt>. Otherwise, <tt>yy yy</tt> is the starting memory location of the next block, and we go to step 3.
* <tt>yy yy</tt> is a [[little endian]] pointer. See <tt>xx</tt> for more details.
$CC should be sent last in this case.

Output
<pre>$CC $BB ?? ??</pre>

===Step 3 (Receive Block from SNES)===
Input
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a byte counter, and this should be sent last on byte ordering. Zero must be sent first to indicate that this is the first block. If this is greater (from a signed comparison, thus no greater than $80 more than the expected value: otherwise, the command won't work) than the value that was last sent to the SNES, then we go to step 4.
* <tt>yy</tt> is the input byte to send. The pointer is incremented.

Output
<pre>xx $BB ?? ??</pre>
* <tt>xx</tt> is the next byte ID to send over. This is incremented per byte sent.

This step repeats until <tt>xx</tt> is sent a value that is greater than the initially expected value, then we go to step 4.

===Step 4 (Terminate Block)===
Input
<pre>xx yy zz zz</pre>
* <tt>xx</tt> must be greater (from a signed comparison, thus no greater than $80 more than the expected value: otherwise, the command won't work) than the last value that the SPC700 sent to the SNES. This byte should be sent last order-wise. Note that if this is zero (only occurs if the counter was previously $80-$FF), you'll instantly send a byte if <tt>yy</tt> is non-zero and start your next block right away (the zero case still jumps as per the usual).
* <tt>yy</tt> indicates what to do next. If this is zero, then the program jumps to <tt>zz zz</tt>. Otherwise, <tt>zz zz</tt> is the starting memory location of the next block, and we go to step 3.
* <tt>zz zz</tt> is a [[little endian]] pointer. See <tt>yy</tt> for more details.

Output
<pre>xx $BB ?? ??</pre>
* <tt>xx</tt> is the ID that was sent to terminate the block.

'''Note if you choose to jump to the program, then depending on the program, your acknowledgement from the IPL Boot ROM may end up being very short. Thus, unless your program accounts for this, make sure to disable your interrupts prior to performing this critical step.'''

==Trivia==
* On reset, Mesen 2 sets the SPC700's program counter to $FFC5, skipping the stack setup.

==References==
* [https://problemkaputt.de/fullsnes.htm#snesapumaincpucommunicationport Fullsnes - Boot ROM Disassembly]
* [https://wiki.superfamicom.org/spc700-reference#ipl-rom-1567 Super Famicom Wiki - IPL ROM]

[[Category:Audio]]

N-SPC Engine/Imagitec Design

2023-06-13T23:25:31Z

KungFuFurby: Adding Dragon's Magic (Konami logo), which branched off of American Gladiators.

Go back to [[N-SPC Engine]]

__TOC__

''Imagitec Design'' is a company that used the N-SPC engine for most of its games. Most of these games don't actually support music and sound effects played together: only the earliest version does.

{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| ''Top Gear/Top Racer'' || 1.0 || <tt>0x0B89</tt>, relative to <tt>0x0AC9</tt> || <tt>0x0DE000</tt> (all versions)
|-
| ''American Gladiators'' || 2.0 || <tt>0x0B87</tt>, relative to <tt>0x0AC7</tt> || <tt>0x1E8000</tt>
|-
| ''The Humans'' || 2.0 || <tt>0x0B87</tt>, relative to <tt>0x0AC7</tt> || <tt>0x048000</tt>/<tt>0x058000</tt>/<tt>0x12C0FE</tt> ''(RNC compressed)''
|-
| ''Dragon's Magic'' (Konami logo) || 2.0 (Motivetime branch) || <tt>0x0B80</tt>, relative to <tt>0x0AC0</tt> || <tt>0x08C2BB</tt>
|-
| ''Wheel of Fortune'' (Title Screen) ''Wheel of Fortune - Deluxe Edition'' (Title Screen) || 3.0a || <tt>0x0BAF</tt>, relative to <tt>0x0AEF</tt> || <tt>0x0FB59C</tt> (all versions)
|-
| ''Wheel of Fortune'' (In-Game) ''Wheel of Fortune - Deluxe Edition'' (In-Game) || 3.0b || <tt>0x0775</tt>, relative to <tt>0x06B5</tt> || <tt>0x0C8000</tt>/<tt>0x0DD7D3</tt> (all versions)
|}

The raw build sorting notes can be found [[N-SPC Engine/Imagitec Design/Build Sorting|here]].

The only modification made to the VCMD formats are to remove the fast forward and channel mute VCMDs and fast forward phrase commands, and to allow the end phrase command (and/or a second note duration/quantization/velocity combo) to execute rather than playing an invalid note.

==Communication with the SNES==
All values are usually echoed back straight to the SNES on the register they were written to.

===Commands (V1.0)===
This is the only version to support playing sound effects in tandem with the music.

====CPUIO0 ($2140/$F4)====
This register is purely responsible for controlling the music. <tt>$00</tt> stops the music, while <tt>$01-$FF</tt> play music.

====CPUIO1 ($2141/$F5)====
This register is constantly polled every tempo tick.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Pass-Through || <tt>?? $00 ?? ??</tt>
|-
|<tt>$01</tt> || Stop Sound (Channels 5-8) || <tt>?? $01 ?? ??</tt>
|-
|<tt>$02</tt> || Car Engine Init (Channel 5) || <tt>?? $02 ?? ??</tt>
|-
|<tt>$03</tt> || Car Engine Speed (Channel 5) || <tt>?? $03 xx yy</tt>
|-
|<tt>$04</tt> || Pass-Through || <tt>?? $04 ?? ??</tt>
|-
|<tt>$05</tt> || Play SFX (Channel 6) || <tt>?? $05 ?? ??</tt>
|-
|<tt>$06</tt> || Stop Sound (Channels 6-8) || <tt>?? $06 ?? ??</tt>
|-
|<tt>$07</tt> || Play SFX (Channel 5) || <tt>?? $07 ?? ??</tt>
|-
|<tt>$08</tt> || Play SFX (Channel 6) || <tt>?? $08 ?? ??</tt>
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>?? $09 ?? ??</tt>
|-
|<tt>$0A</tt> || Play SFX (Channel 6) || <tt>?? $0A ?? ??</tt>
|-
|<tt>$0B</tt> || Play SFX (Channel 6) || <tt>?? $0B ?? ??</tt>
|-
|<tt>$0C</tt> || Pass-Through || <tt>?? $0C ?? ??</tt>
|-
|<tt>$0D</tt> || Car Engine Init (Channel 7) || <tt>?? $0D ?? ??</tt>
|-
|<tt>$0E</tt> || Car Engine Speed (Channel 7) || <tt>?? $0E xx yy</tt>
|-
|<tt>$0F</tt> || Pass-Through || <tt>?? $0F ?? ??</tt>
|-
|<tt>$10</tt> || Play SFX (Channel 8) || <tt>?? $10 ?? ??</tt>
|-
|<tt>$11</tt> || Stop Sound (Channels 6) || <tt>?? $11 ?? ??</tt>
|-
|<tt>$12</tt> || Play SFX (Channel 7) || <tt>?? $12 ?? ??</tt>
|-
|<tt>$13</tt> || Play SFX (Channel 8) || <tt>?? $13 ?? ??</tt>
|-
|<tt>$14</tt> || Play SFX (Channel 8) || <tt>?? $14 ?? ??</tt>
|-
|<tt>$15</tt> || Play SFX (Channel 8) || <tt>?? $15 ?? ??</tt>
|-
|<tt>$16</tt> || Play SFX (Channel 8) || <tt>?? $16 ?? ??</tt>
|-
|<tt>$17</tt> || Play SFX (Channel 8) || <tt>?? $17 ?? ??</tt>
|-
|<tt>$18</tt> || Stop Music + Go to IPL Boot ROM || <tt>?? $18 ?? ??</tt>
|-
|<tt>$19</tt> || Pause Sound || <tt>?? $19 ?? ??</tt>
|-
|<tt>$1A</tt> || Play SFX (Channel 6) || <tt>?? $1A ?? ??</tt>
|-
|<tt>$1B</tt> || Play SFX (Channel 8) || <tt>?? $1B ?? ??</tt>
|-
|<tt>$1C</tt> || Play SFX (Channel 6) || <tt>?? $1C ?? ??</tt>
|-
|<tt>$1D</tt> || Play SFX (Channel 8) || <tt>?? $1D ?? ??</tt>
|-
|<tt>$1E-$FF</tt> || Pass-Through || <tt>?? ?? ?? ??</tt>
|}

=====Pass-Through=====
Effectively a NOP, doing nothing.

=====Stop Sound=====
Disables the channel(s) indicated by ID as long as this command is the last ID sent...
* <tt>$01</tt> - Channels 5-8
* <tt>$06</tt> - Channels 6-8
* <tt>$11</tt> - Channel 6

=====Play SFX=====
Plays a piece of SFX. It seems like an array could be used here, but it isn't: instead, it's just an 8-byte entry to a series of DSP register writes to the Vx DSP registers before keying it on, with the channel and sound used varying by ID.

=====Car Engine Init (Command <tt>$02, $0D</tt>)=====
<pre>?? ii ?? ??</pre>
* <tt>ii</tt>, the command ID used for the SFX, defines the channel used.
** Channel 5: <tt>$02</tt>
** Channel 7: <tt>$0D</tt>

=====Car Engine Speed (Command <tt>$03, $0E</tt>)=====
<pre>?? ii xx yy</pre>
* <tt>ii</tt>, the command ID used for the SFX, defines the channel used.
** Channel 5 (V4PITCH): <tt>$03</tt>
** Channel 7 (V6PITCH): <tt>$0E</tt>
* <tt>xx</tt> is a direct write to the VxPITCHL DSP register.
* <tt>yy</tt> is a direct write to the VxPITCHH DSP register.

=====Pause Sound (Command <tt>$19</tt>)=====
Mutes everything while this command is the last ID sent.

=====Stop Music + Go to IPL Boot ROM (Command <tt>$18</tt>)=====
Uses the FLG DSP register to disable echo writes, mute the amplifier and key off all voices, then jumps to the [[SPC700/IPL ROM|IPL Boot ROM]].

===Commands (V2.0)===
This code is nearly identical to Controller Test, except for the VCMD differences mentioned above, this command set, and a couple of other minor differences.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Sound || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Go to IPL Boot ROM || <tt>$FF ?? ?? ??</tt>
|}

====Commands (V2.0 Motivetime Branch)====
The only difference is that Go to IPL Boot ROM is instead executed through VCMD $E2 (overwriting it in the process), along with stopping the sound.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Sound || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|}

===Commands (V3.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Sound || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-$7F</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$41</tt> || Mute || <tt>$41 xx ?? ??</tt>
|-
|<tt>$41</tt> || Mute + Go To IPL Boot ROM || <tt>$41 $58 ?? ??</tt>
|-
|<tt>$80-$FF</tt> || NOP || <tt>?? ?? ?? ??</tt>
|}
====NOP====
Does absolutely nothing. Doesn't even acknowledge.
====Mute====
Mutes the sound by zeroing out the main volume and zeroing out the DSP registers.

<pre>$41 xx ?? ??</pre>
* <tt>xx</tt>, when set to <tt>$58</tt>, jumps to the [[SPC700/IPL ROM|IPL Boot ROM]]. Interestingly, that means that this command spells out <tt>AX</tt> in ASCII.

===Commands (V3.0b)===
The phrase format has been massively modified to only have one channel, meaning the pointer goes directly to pattern data. You can still loop the now one-channel phrase pointer, though. The sub-routine command becomes a straight-up jump command due to the phrase termination command (ID <tt>$00</tt>) having been stripped of handling sub-routine code.

===Commands (V3.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Sound || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-$0F</tt> || Play Sound || <tt>$0x ?? ?? ??</tt>
|-
|<tt>$10-$40</tt> || NOP || <tt>?? ?? ?? ??</tt>
|-
|<tt>$41</tt> || Mute || <tt>$41 xx ?? ??</tt>
|-
|<tt>$41</tt> || Mute + Go To IPL Boot ROM || <tt>$41 $58 ?? ??</tt>
|-
|<tt>$42-$FF</tt> || NOP || <tt>?? ?? ?? ??</tt>
|}

====NOP====
Does absolutely nothing. Doesn't even acknowledge.

====Play Sound====
<pre>$0x ?? ?? ??</pre>
* <tt>x</tt> is the sound ID. All sounds play on channel 1. These are uninterruptible unless stopped with the <tt>$00</tt> command first.

====Mute====
Mutes the sound by zeroing out the main volume and zeroing out the DSP registers.

<pre>$41 xx ?? ??</pre>
* <tt>xx</tt>, when set to <tt>$58</tt>, jumps to the [[SPC700/IPL ROM|IPL Boot ROM]]. Interestingly, that means that this command spells out <tt>AX</tt> in ASCII.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

N-SPC Engine/Imagitec Design/Build Sorting

2023-06-13T23:12:59Z

KungFuFurby: Found a new N-SPC build in Dragon's Magic (JP version of Dragon's Lair) at the Konami logo. Mostly similar to American Gladiators, which is already barebones to begin with... so it's marked as a branch.

{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''American Gladiators The Humans'' || <tt>$0800</tt> || <tt>D0 E8 BC 3F ?? ??</tt> || <tt>$0DA3</tt>||
|-
|''Top Gear/Top Racer'' || <tt>$0800</tt> || <tt>D0 E8 BC 3F ?? ??</tt> || <tt>$0DA5</tt>||
|-
|''Wheel of Fortune'' (Title Screen) ''Wheel of Fortune - Deluxe Edition'' (Title Screen) || <tt>$0800</tt> || <tt>D0 E8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|-
|''Wheel of Fortune'' (In Game) ''Wheel of Fortune - Deluxe Edition'' (In Game) || <tt>$0400</tt> || <tt>D0 F4 BC 3F ?? ??</tt> || <tt>$0991</tt>||
|}

==Motivetime Branch==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Dragon's Magic'' (Konami logo) || <tt>$0800</tt> || <tt>D0 E8 BC 3F ?? ??</tt> || <tt>$0DC1</tt>||
|}

[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine/Kemco

2023-05-21T02:25:25Z

KungFuFurby: Master Volume -> Main Volume

Go back to [[N-SPC Engine]]

__TOC__

Kemco is the first company outside of Nintendo themselves to release a game using their own variant of N-SPC (that being Bombuzal). The main customization that they did was to have the CPUIO registers play sounds on specific channels, and only the channels on the phrase list specified to be used by the corresponding CPUIO register would be used. All non-music CPUIO registers, when processing phrase data, also did not support the fast forward phrase commands. One other CPUIO register was allocated mainly to perform volume fades.

{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Bombuzal || 1.0 || <tt>0x10EB</tt>, relative to <tt>0x102B</tt> || <tt>0x04807A</tt>
|-
| Lagoon || 2.0 || <tt>0x1156</tt>, relative to <tt>0x1096</tt> || <tt>0x0D80A4</tt> (all versions)
|-
| Drakkhen || 3.0 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x1C805C</tt> (all versions)
|-
| Ka-blooey || 3.0 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x048080</tt>
|-
| First Samurai || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x0DB15E</tt> (all versions)
|-
| Phalanx - The Enforce Fighter A-144 || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x1EB23E</tt> (all versions)
|-
| Super Drakkhen/Dragon View || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x09B6F6</tt> (all versions)
|-
| Super Full Metal || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x0C80B6</tt>
|-
| X Zone || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x0FAEE6</tt> (all versions)
|-
| Kid Klown in Crazy Chase || 4.0 || <tt>0x12A1</tt>, relative to <tt>0x11E1</tt> || <tt>0x1EC1E0</tt> (all versions)
|}

The raw build sorting notes can be found [[N-SPC Engine/Kemco/Build Sorting|here]].

==Communication with the SNES==
Each CPUIO register has an individual use. 
===CPUIO0 ($2140/$F4)===
This register always controls which sound ID will play out of channels 1-6, regardless of which sound driver version is used. It also supports the [[N-SPC_Engine#Communication_with_the_SNES|source build's N-SPC/Kankichi commands]]. These same commands are not present in the other CPUIO ports that control the channels, and instead you can only play or stop them.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Sound || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Sound (Channels 1-6) || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Sound (Channels 1-6) || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Sound (Channels 1-6) || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

The output to $2140/$F4 is as following...
* <tt>$00</tt> - Sound is not playing (usually caused by the zero command)
* <tt>$3F</tt> - Usually on the first tempo tick only, or sound is paused (caused by commands <tt>$F0</tt> and <tt>$FF</tt>)
* <tt>$40</tt> - Sound is playing on channels 1-6
===CPUIO1 ($2141/$F5)===
This register controls which sound ID will play of of the following channel IDs, depending on the version...
* V1.0, V3.0: Channels 7-8
* V2.0, V4.0: Channel 7
The output is as following...
* <tt>$00</tt> - Most common output with V1.0 and V3.0 (even if sound is playing). Otherwise indicates that a sound is not playing.
* <tt>$40</tt> - Usually on the first tempo tick only for V2.0 and V4.0 after the sound is activated.
* <tt>$80</tt> - Sound is playing on channel 7.
* <tt>$FF</tt> - Usually on the first tempo tick only for V1.0 and V3.0 after the sound is activated.

===CPUIO2 ($2142/$F6)===
Only used in V2.0 and V4.0. This register always controls which sound ID will play out of channel 8. 
This register always outputs a zero on V1.0 and V3.0-V3.1. Otherwise, when it is used, the output is...
* <tt>$00</tt> - Most common output, even if sound is playing.
* <tt>$80</tt> - Usually on the first tempo tick only after the sound is activated.

===CPUIO3 ($2143/$F7)===
Never used in V2.0. It does output a value, though: namely, whatever you sent in $2142/$F6. 
This CPUIO register is used to perform volume fades on either the note volumes of channels 1-8 or the MVOL DSP registers (The EVOL DSP registers are modified as well, but they get overwritten shortly afterwards). The values supported depend on the sound driver version.
====Commands (V1.0)====
{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00-$9F</tt> || Pause Volume Operations + Acknowledge
|-
|<tt>$A0</tt> || Reset Volume Operations (Channels 1-6)
|-
|<tt>$A1</tt> || Fade Out (Channels 1-6)
|-
|<tt>$A2</tt> || Fade In (Channels 1-6)
|-
|<tt>$A3</tt> || Zero Volume (Channels 1-6)
|-
|<tt>$A4</tt> || Volume Restore (Channels 7-8)
|-
|<tt>$A5</tt> || Reset Volume Operations (Channels 7-8)
|-
|<tt>$A6</tt> || Fade Out (Channels 7-8)
|-
|<tt>$A7</tt> || Fade In (Channels 7-8)
|-
|<tt>$A8</tt> || Zero Volume (Channels 7-8)
|-
|<tt>$A9</tt> || Volume Restore (Channels 7-8)
|-
|<tt>$AA-$FF</tt> || Pause Volume Operations + Acknowledge
|}
====Commands (V3.0-V4.0)====
{| class="wikitable sortable"
|-
! Command ID !! Description !! Versions Supported
|-
|<tt>$00-$7F</tt> || Pause Volume Operations + Acknowledge ||
|-
|<tt>$80</tt> || Reset Volume Operations (Channels 1-6) || V3.0-V3.1
|-
|<tt>$81</tt> || Fade Out (Channels 1-6) || V3.0-V3.1
|-
|<tt>$82</tt> || Fade In (Channels 1-6) || V3.0-V3.1
|-
|<tt>$83</tt> || Zero Volume (Channels 1-6) || V3.0-V3.1
|-
|<tt>$84</tt> || Volume Restore (Channels 1-6) || V3.0-V3.1
|-
|<tt>$85-$9F</tt> || Pause Volume Operations + Acknowledge ||
|-
|<tt>$A0</tt> || Reset Volume Operations (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A1</tt> || Fade Out (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A2</tt> || Fade In (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A3</tt> || Zero Volume (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A4</tt> || Volume Restore (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A5-$DF</tt> || Pause Volume Operations + Acknowledge ||
|-
|<tt>$E0</tt> || Reset Volume Operations (Main Volume) || V3.0-V4.0
|-
|<tt>$E1</tt> || Fade Out (Main Volume) || V3.0-V4.0
|-
|<tt>$E2</tt> || Fade In (Main Volume) || V3.0-V4.0
|-
|<tt>$E3</tt> || Zero Volume (Main Volume) || V3.0-V4.0
|-
|<tt>$E4</tt> || Volume Restore (Main Volume) || V3.0-V4.0
|-
|<tt>$E5-$FF</tt> || Pause Volume Operations + Acknowledge ||
|}

For V3.0-V3.1, <tt>$80</tt> and up can be transformed into this binary-based notation instead:
<pre>%1yyxxxxx</pre>
* <tt>%xxxxx</tt> is a command ID. The commands are as following...
** <tt>%00000</tt> (<tt>$00</tt>) - Reset Volume Operations
** <tt>%00001</tt> (<tt>$01</tt>) - Fade Out
** <tt>%00010</tt> (<tt>$02</tt>) - Fade In
** <tt>%00011</tt> (<tt>$03</tt>) - Zero Volume
** <tt>%00100</tt> (<tt>$04</tt>) - Volume Restore
** Any other value (<tt>$05-$1F</tt>) - Pause Volume Operations + Acknowledge
* <tt>%yy</tt> defines what will be affected by the command. The values are...
** <tt>%00</tt> (<tt>$0</tt>) - Channels 1-6
** <tt>%01</tt> (<tt>$1</tt>) - Channels 7-8
** <tt>%10</tt> (<tt>$2</tt>) - Invalid (causes all values to merely acknowledge)
** <tt>%11</tt> (<tt>$3</tt>) - Main Volume

====Pause Volume Operations + Acknowledge====
Echoes back the value you just sent to $2143/$F7. All volume operations are also paused, which includes fades, since the register is constantly polled.

====Reset Volume Operations====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A0</tt>
* V3.0-V3.1: <tt>$80</tt>
Channels 7-8
* V1.0: <tt>$A5</tt>
* V3.0-V3.1: <tt>$A0</tt>
Main Volume
* V3.0-V4.0: <tt>$E0</tt>

This command resets all volume-related operations, specifically by resetting the flags that they were triggered for the first time. This also pauses fades. $2143/$F7 outputs a zero.

====Fade Out====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A1</tt>
* V3.0-V3.1: <tt>$81</tt>
Channels 7-8
* V1.0: <tt>$A6</tt>
* V3.0-V3.1: <tt>$A1</tt>
Main Volume
* V3.0-V4.0: <tt>$E1</tt>

Fades out the volume to 0. On V1.0, this is done at a rate of 3 per tempo tick: on other versions, it's 1 per tempo tick. On V3.0 and later, the original volume value is saved. $2143/$F7 outputs the current volume value of the last channel in the set (or the intended right echo volume value in the main volume's case). 
The command does not properly function past V1.0 for channels 1-6. Technically it still works, but a wrong branching location causes the channel ID to use (and the number of channels to copy) to not be initialized properly, which causes the volume values to not be saved.

====Fade In====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A2</tt>
* V3.0-V3.1: <tt>$82</tt>
Channels 7-8
* V1.0: <tt>$A7</tt>
* V3.0-V3.1: <tt>$A2</tt>
Main Volume
* V3.0-V4.0: <tt>$E2</tt>

Fades in the volume to the original volume at a rate of 1 per tempo tick. If no value was saved beforehand, this can overflow back to zero. $2143/$F7 outputs the current volume value of the last channel in the set (or the intended right echo volume value in the main volume's case).

====Zero Volume====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A3</tt>
* V3.0-V3.1: <tt>$83</tt>
Channels 7-8
* V1.0: <tt>$A8</tt>
* V3.0-V3.1: <tt>$A3</tt>
Main Volume
* V3.0-V4.0: <tt>$E3</tt>

Zeroes out the volume, saving the original volume for restoration later on. Unless this is done on the main volume, you must reset volume operations to use this command again. $2143/$F7 outputs the current volume value (or the intended right echo volume value in the main volume's case) for one tempo tick, then a $01 (or, for the main volume, always outputs a zero). 
The command does not properly function past V1.0 for channels 1-6 due to a wrong branching location.

====Volume Restore====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A4</tt>
* V3.0-V3.1: <tt>$84</tt>
Channels 7-8
* V1.0: <tt>$A9</tt>
* V3.0-V3.1: <tt>$A4</tt>
Main Volume
* V3.0-V4.0: <tt>$E4</tt>

Restores the volumes to the saved value. Unless this is done on the main volume, you must reset volume operations to use this command again. $2143/$F7 outputs the current volume value for one tempo tick, then a $01 (or, for the main volume, always outputs the intended right echo volume value... which is saved to the left main volume by mistake). 
The command does not properly function past V1.0 for channels 1-6 due to a wrong branching location. 
The main volume variant does not work properly due to a typo in the code: specifically, the right echo volume gets copied to the left main volume by mistake, overwriting the correct value that was copied earlier.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

David Whittaker Sound Engine

2023-05-21T01:29:36Z

KungFuFurby: Italicizing game names

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta's Title Screen and ''Lawnmower Man/Virtual Wars''' US Beta
* ''Lemmings 2: The Tribes''' most common build and ''Riddick Bowe Boxing'''s Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| ''Dream TV'' || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| ''Krusty's Super Fun House'' || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| ''Kick Off/Super Kick Off'' || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| ''Batman: Revenge of the Joker'' || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| ''Super SWIV/Firepower 2000'' || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| ''Gods'' || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| ''World Class Rugby'' || 2.3 || <tt>0x0608</tt> || <tt>0x0B8000</tt> (all versions)
|-
| ''Battle Cars'' || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| ''Chavez/Riddick Bowe Boxing'' || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except ''Chavez'') (three unique build variants, one per version between ''Chavez'', US & Japanese versions)
|-
| ''Lawnmower Man/Virtual Wars'' || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| ''Apocalypse II'' || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| ''Elite Soccer/World Cup Striker'' || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| ''Kick Off 3'' (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| ''Lemmings 2: The Tribes'' || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| ''Porky Pig's Haunted Holiday'' (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| ''Shaq Fu'' || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| ''Michael Jordan: Chaos in the Windy City'' || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are resent.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Master Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Master & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Master Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* ''Apocalypse II'' (Opening logo)/''Lemmings 2: The Tribes'' (Opening logo)
* ''Kick Off 3'' (Beta) (In-Game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** ''Dream TV'' (beta and final): '''2X'''
*** All other games: '''4X'''
*** ''Batman: Revenge of the Joker'', ''Krusty's Super Fun House'', ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', ''Shaq-Fu'', ''Super SWIV/Firepower 2000'': '''8X'''

The following builds don't support this command:
* ''Gods'' (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Master & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the master volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** ''Batman: Revenge of the Joker'': '''1/4'''
*** ''Dream TV'': '''1/4'''
*** ''Gods'' (all builds): '''3/16'''
*** ''World Class Rugby'': '''3/16'''
*** ''Lawnmower Man/Virtual Wars'' (Driving): '''3/16'''
*** ''Lemmings 2: The Tribes'' (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* ''Batman: Revenge of the Joker''
* ''Dream TV''
* ''Gods'' (all builds)
* ''World Class Rugby''
* ''Lawnmower Man/Virtual Wars'' (Driving)
* ''Lemmings 2: The Tribes'' (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* ''Battle Cars''
* ''Riddick Bowe Boxing/Chavez'' (all versions except Japanese)
* ''Shaq-Fu''

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** ''Michael Jordan Chaos in the Windy City'' ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* ''Battle Cars''
* ''World Cup Striker'' (European version) (Title Screen)
* ''Elite Soccer/World Cup Striker'' (European version) (In-Game)
* ''Kick Off 3'' (beta) (In-Game)
* ''Kick Off 3'' (beta) (Title Screen)
* ''Porky Pig's Haunted Holiday'' (beta)
* ''Shaq-Fu''

Not all IDs are supported in these builds...
* ''Lawnmower Man/Virtual Wars'' (In-Game) ''(does not support $1A-$1D, not even in the code)''
* ''World Cup Striker (Japanese)'' (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For ''Dream TV'' Beta and ''Kick Off'', only five pointers are defined. For ''Krusty's Super Fun House'', only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (''Dream TV Beta'' and ''Kick Off'')
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (''Krusty's Super Fun House'')
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(''Krusty's Super Fun House'' only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Two builds don't support song entries at all:
* The opening logos for ''Lemmings 2: The Tribes'' and ''Apocalypse II''
* ''Kick Off 3'' Beta (In-Game)

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Master Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Master Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

N-SPC Engine/Nintendo/Koji Kondo

2023-05-21T01:23:15Z

KungFuFurby: Replacing my under construction note with the standard stub template.

Go back to [[N-SPC Engine/Nintendo]]

{{stub}}

'''Koji Kondo''' is the first user of the N-SPC engine, having used its earliest known version in two games.

__TOC__

''TODO insert table here''

The raw build sorting notes can be found [[N-SPC Engine/Nintendo/Build Sorting|here]] for all variants by Nintendo.

==Communication with the SNES==
For Super Mario World and Pilotwings, see [[N-SPC_Engine/Nintendo/Koji_Kondo/Prototype#Communication_with_the_SNES|the Prototype Variant's page]].

===Super Mario All-Stars===
The protocol in general is mostly adapted from Super Mario World's, though with some differences here and there, most notably in the triggering of the Hurry Up! SFX and the SFX sequences in general.
====CPUIO0 ($2140/$F4)====
This register controls the SFX to play on channel 5.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%?xxxxxxx</tt> <tt>$01-$7E/$81-$FE</tt> || Play SFX Sequence Set 1
|-
|<tt>%?1111111</tt> <tt>$7F/$FF</tt> || Hurry Up!
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence Set 1 (Command <tt>$01-$7E/$81-$FE</tt>)=====
<pre>%?xxxxxxx</pre>

* <tt>%xxxxxxx</tt> is the SFX ID to play. The ID currently playing is echoed back to $2140 on the SNES, including the highest bit (which otherwise can be toggled for retriggering purposes, but otherwise doesn't actually do anything.
** <tt>$11</tt> keys off all notes and pauses the music once it has finished playing. <tt>$12</tt> will unpause the music.
** <tt>$11</tt> and <tt>$1D</tt> cannot be interrupted except by <tt>$43</tt>, <tt>$11</tt> or <tt>$12</tt>.
** <tt>$3B</tt> and <tt>$43</tt> force echo off while they are playing.

The <tt>$FF</tt> VCMD for this set only is programmed to restart the SFX from the beginning.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

=====Hurry Up! (Command <tt>$7F/$FF</tt>)=====
Plays SFX ID <tt>$1D</tt> on both SFX sequence sets and offsets the tempo by <tt>$0A</tt> without overflow checks. This can stack if it is played multiple times, but only the first one will remain in effect until forced off.

====CPUIO1 ($2141/$F5)====
This register controls some hard-coded SFX on channel 8.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>xy</tt> <tt>$01-$EF, $F1-$FE</tt> || Hard-coded SFX + BRR Wind Control
|-
|<tt>$F0</tt> || Go to IPL Boot ROM
|-
|<tt>$FF</tt> || Load New Data
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Hard-coded SFX + Noise BRR Wind Control (Command <tt>$01-$EF</tt>, <tt>$F1-$FE</tt>)=====
Input<pre>xy</pre>
Output<pre>%000xyyyy</pre>
* <tt>x</tt> controls the BRR wind on channel 6 as following...
** <tt>$1</tt> activates BRR wind on channel 6. The upper four bits will output a $1 to $2141 on the SNES.
** <tt>$2</tt> deactivates BRR wind. This clears the output of the upper four bits for $2141.
* <tt>y</tt> plays hard-coded SFX on channel 8 as following...
** <tt>$1</tt> plays Mario's jumping SFX on channel 8. The value is echoed back to the SNES via $2141 while the SFX is playing.
** <tt>$4</tt> plays the turnaround SFX. The value is echoed back to the SNES via $2141 while the SFX is playing.
** All other values are NOPs.

=====Go to IPL Boot ROM (Command <tt>$F0</tt>)=====
''TODO go into specifics on what exactly is cleared out here before going to the loader''

=====Load New Data (Command <tt>$FF</tt>)=====
''TODO go into specifics on what exactly is cleared out here before going to the loader''

====CPUIO2 ($2142/$F6)====
This register controls the music.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%01-$72</tt> || Play Music
|-
|<tt>$73-$EF</tt> || Stop Noise BRR Wind + Fade Out
|-
|<tt>$F0</tt> || Stop Music
|-
|<tt>$F1</tt> || Fade Song Volume
|-
|<tt>$F2</tt> || Restore Song Volume
|-
|<tt>$F3</tt> || Stop Noise BRR Wind + Fade Out + Reset Tempo Speedup
|-
|<tt>$F4-$FF</tt> || NOP
|}

=====NOP (Command <tt>$00</tt>, <tt>$F4-$FF</tt>)=====
Does absolutely nothing.

=====Play Music (Command <tt>$01-$72</tt>)=====
* The command ID provided is the music ID to play. The ID currently playing is echoed back to $2142 on the SNES.
** <tt>$07</tt>, <tt>$09</tt>, <tt>$0D</tt>, <tt>$11-$12</tt> and <tt>$14</tt> reset the tempo speedup effect done by the Hurry Up! command.

=====Stop Noise BRR Wind + Fade Out (Command <tt>$73-$EF</tt>)=====
Fades out the song volume to zero over 144 tempo ticks. The Noise BRR Wind is also halted.
======Reset Tempo Speedup (Command <tt>$F3</tt>)======
Identical to the fade out command above, except the tempo speedup effect done by the Hurry Up! command is also reset, effective next tempo change or when another song is played.

======Fade Song Volume (Command <tt>$F1</tt>)======
Sets the song volume to $70.

======Restore Song Volume (Command <tt>$F2</tt>)======
Restores the song volume from a backup created from the $F1 command. If the backup turns out to be a zero volume case, this doesn't work.

====CPUIO3 ($2143/$F7)====
This register controls the SFX to play on channel 7.

{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00</tt> || NOP
|-
|<tt>%?xxxxxxx</tt> <tt>$01-$FF</tt> || Play SFX Sequence Set 2
|}

=====NOP (Command <tt>$00</tt>)=====
Does absolutely nothing.

=====Play SFX Sequence Set 2 (Command <tt>$01-$FF</tt>)=====
<pre>%?xxxxxxx</pre>

* <tt>%xxxxxxx</tt> is the SFX ID to play. The ID currently playing is echoed back to $2143 on the SNES, including the highest bit (which otherwise can be toggled for retriggering purposes, but otherwise doesn't actually do anything.
** <tt>$05</tt> and <tt>$1D</tt> cannot be interrupted by any other instances. <tt>$1D</tt>, however, can interrupt <tt>$05</tt>.

The <tt>$FF</tt> VCMD for this set only is programmed to move the pointer back one byte instead of forward.

======SFX Sequence Format======
See the [[N-SPC Engine/Prototype/SFX Sequence Format|SFX Sequence Format]] subpage.

===SimCity===
This is the earliest released game to not have a command to load new data at all. Therefore, there is no way to switch sound drivers or even go back to the IPL ROM. 
''TODO insert protocol here''

===Super Donkey 1===
''TODO insert protocol here''

===Legend of Zelda - A Link To The Past===
''TODO insert protocol here''

===Star Glider===
''TODO insert protocol here''

===Star Fox/Star Wing===
''TODO insert protocol here''

===Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island===
''TODO insert protocol here''

===Star Fox 2===
''TODO insert protocol here (there may be quite a few revisions)''

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

N-SPC Engine/Source Variant Build Sorting

2023-05-21T01:13:59Z

KungFuFurby: Completing the italicization process

{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Controller Test Cassette'' ''SNES Burn-In Test Cartridge'' ''(one of three different builds)'' World Class Service Super Nintendo Tester ''(one of three different builds, unused)'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt> || <tt>$0D35</tt>, <tt>$0FD7</tt> || For distinguishing purposes, known outside of these notes as simply Controller Test.
|-
|''World Class Service Super Nintendo Tester'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt> || <tt>$0D35</tt>, <tt>$0FD9</tt> ||
|-
|''Wheel of Fortune - Deluxe Edition'' ''(unused)'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt>, <tt>3F ?? ??</tt> at <tt>$09C8</tt> || <tt>$0D35</tt>, <tt>$1004</tt>, <tt>$0700</tt> ||
|-
|''Hong Kong '97'' ''SM Choukyoushi Hitomi - Bangai Hen'' ''SM Choukyoushi Hitomi Vol. 2'' Trial Version ''SM Choukyoushi Hitomi Vol. 2'' ''SM Choukyoushi Hitomi Vol. 2 Remix'' ''SM Choukyoushi Hitomi Vol. 3'' Trial Version || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt>, <tt>F0 03 3F ?? ??</tt>, <tt>3F ?? ??</tt> at <tt>$09C8</tt> || <tt>$0D35</tt>, <tt>$1004</tt>, <tt>$1511</tt> ||
|-
|''SM Choukyoushi Hitomi Vol. 3'' (Alt 1) || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D39</tt> ||
|-
|''Shijou Saikyou no Quiz Ou Ketteisen Super'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D40</tt> ||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine/Nintendo/Build Sorting

2023-05-21T01:12:59Z

KungFuFurby: If game names are being italicized, you're going to need a lot more italics than what you came up with.

__TOC__

==Unique cases==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Aging Cassette'' ''SNES Burn-In Test Cartridge''|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$113A</tt>||For distinguishing purposes, known outside of these notes as ''Sound Module and Burn-In Test'' to refer to the copy found in the ''SNES Burn-In Test Cartridge''.
|-
|''Nintendo Power Menu Program'' || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|}

==F-Zero Builds==
This game has multiple revisional builds known.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''F-Zero'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1776</tt>||
|-
|''F-Zero'' (Beta)|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1778</tt>||
|}

==Tetris & Dr. Mario Builds==
These builds are unique to one game, but unlike Super Scope 6 (which you may have noticed that LazerBlazer and Blastris are separated due to different SFX execution), they also match in general execution.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Tetris and Dr. Mario'' (Mixed Match) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$118F</tt>||
|-
|''Tetris and Dr. Mario'' (Dr. Mario) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$1199</tt>||
|-
|''Tetris and Dr. Mario'' (Tetris) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$11A1</tt>||
|}

==Akito Nakatsuka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Scope 6'' (LazerBlazer) (US version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B33</tt>||
|-
|''Super Scope 6'' (LazerBlazer) (Japanese and European version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B37</tt>||
|-
|''Super Game Boy'' ''Super Game Boy 2'' || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0A5D</tt>||
|-
|''BS-X BIOS'' ''Cassette Kensaki - NUS-you S Cassette'' || <tt>$0370</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$04AB</tt>||
|-
|''JRA PAT'' ''JRA PAT - Wide Taiouban'' || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$0739</tt>||
|-
|''Sutte Hakkun'' || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$074C</tt>||
|}

===Yuichi Ozaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Marvelous - Mouhitotsu no Takara-jima'' || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0BC5</tt>||
|-
|''SA-1 Demo'' || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B23</tt>||
|-
|''Heisei Shin Onigashima - Kouhen'' ''Heisei Shin Onigashima - Zenpen'' || <tt>$0400</tt> || <tt>D0 F3 8F ?? ?? BC 3F ?? ??</tt> || <tt>$0C8D</tt>||
|}

==Hirokazu Tanaka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Mario Paint'' (Beta) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? C4 ?? 3F ?? ??</tt> || <tt>$2625</tt>||
|-
|''Mario Paint'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$1430</tt>||
|-
|''Mother 2/Earthbound'' || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16A5</tt>||
|-
|''Snoopy Concert'' || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16EB</tt>||
|}

==Kenji Yamamoto==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Metroid'' || <tt>$1500</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1ED7</tt>||
|}

==Koji Kondo==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island'' || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0A96</tt>||
|-
|''Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island'' (beta version) || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B08</tt>||
|-
|''Star Fox/Star Wing'' || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B14</tt>||
|-
|''Super Mario All-Stars/Super Mario Collection'' || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0C11</tt>||
|-
|''Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E22</tt>||
|-
|''Star Glider'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E97</tt>|| Prototype of Star Fox/Star Wing.
|-
|''SimCity'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$175D</tt>||
|-
|''Super Donkey 1'' || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$1DC9</tt>|| Sound driver build is a prototype of Legend of Zelda - A Link to the Past's.
|}

===Prototype===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Mario World'' (all other versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BC0</tt> ||
|-
|''Super Mario World'' (Super Mario All-Stars + Super Mario World) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BF4</tt> ||
|-
|''Pilotwings'' (European version) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$126A</tt> ||
|-
|''Pilotwings'' (US & Japanese versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$12CD</tt> ||
|}

===Yoji Inagaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Star Fox 2'' (1994-04-01) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>||
|-
|''Star Fox 2'' (1994-04-15) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>|| Except for a single opcode's difference at $064C, all of the code differences are after the SFX data, and thus pointers cannot be fully factored in.
|-
|''Star Fox 2'' (1994-05-06 and 1994-05-13) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B62</tt>||
|-
|''Star Fox 2'' (1994-08-31) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6D</tt>||
|-
|''Star Fox 2'' (1994-12-28) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B9C</tt>||
|-
|''Star Fox 2'' (1995-06-08) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD4</tt>||
|-
|''Star Fox 2'' (1995-06-22) Star Fox 2 (1995-06-27) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD7</tt>|| These builds are identical to each other minus pointers placed after the SFX data.
|-
|''Star Fox 2'' (1995-07-25) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BDA</tt>||
|-
|''Star Fox 2'' || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0BDF</tt>||
|}

==Taro Bando==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Super Mario Kart'' (beta version) (1992-01-21 build) || <tt>$0800</tt> || <tt>2F ?? BC 3F ?? ??</tt> || <tt>$0E3D</tt> || Refers to a sound.bin file with this timestamp that was not embedded in a known prototype build.
|-
|''Super Mario Kart'' (beta version) (mkart) || <tt>$0800</tt> || <tt>E8 ?? BC 3F ?? ??</tt> || <tt>$0D79</tt>|| Refers to a prototype from April 13, 1992.
|-
|''Super Mario Kart'' (beta version) (mario_kart-01) || <tt>$0800</tt> || <tt>C5 ?? ?? E8 ?? 3F ?? ??</tt> || <tt>$0D65</tt> || Refers to what is known as the Enigma prototype build.
|-
|''Super Mario Kart'' (beta version) (mario_kart) || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$0D74</tt> || Refers to a prototype from late June 1992, created before kar4t.
|-
|''Super Mario Kart'' (beta version) (kar4t) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1598</tt> || Refers to a prototype from late June 1992, created after mario_kart.
|-
|''Super Mario Kart'' (US version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19B4</tt>||
|-
|''Super Mario Kart'' (Japanese and European version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19BA</tt>||
|-
|''FX Trax'' || <tt>$0800</tt> || <tt>D0 F7 E8 ?? 3F ?? ??</tt> || <tt>$0D61</tt>|| Prototype of Wild Trax/Stunt Race FX.
|-
|''Wild Trax/Stunt Race FX'' || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D73</tt>|| Loading program at $0675 before the actual start location
|}

==Yumiko Kanki==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''Special Tee Shot'' (Prototype) || <tt>$0460</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0A78</tt>||
|-
|''Special Tee Shot'' (BS-X version) || <tt>$0400</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0B86</tt>||
|}

==Unknown==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|''SNES Burn-In Test Cartridge'' || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0D6D</tt>||For distinguishing purposes, known outside of these notes as Super Scope Test.
|-
|''Super Scope 6'' (Blastris) || <tt>$0800</tt> || <tt>90 F8 BC 3F ?? ??</tt> || <tt>$0D89</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

Category:MIDI-Based SPC Sound Engines

2023-02-26T17:56:37Z

KungFuFurby: Re-adding Accolade, mostly as a result of tracing finding a VCMD that was also from MIDI (meaning it had a mixture of actual MIDI and unofficial MIDI).

This contains a list of [[:Category:SPC Sound Engines|SPC Sound Engines]] whose internal VCMD format contains a match to [[MIDI]]'s own format (at least as far as being able to generally identify it). Except for Loriciel and Silicon Sorcery's SPC sound engines, the header generally does not match MIDI's own format. They may contain custom and/or relocated VCMDs in place of standard MIDI features in some cases.

The following SPC sound engine pages that satisfy this criteria have not been created yet:
* [[ACID]] (Realtime Associates)
* [[Advanced Real-time Dynamic Interplay]] ('''Not''' RPM Racing, Wolfenstein 3D or Super 3D Noah's Ark)
* [[Game Studio Engine]]
* [[Loriciel Engine]]
* [[Mindscape Engine]]
* [[Silicon Sorcery Engine]]
* [[Super Music Driver]] (Haüs Teknikka)

These SPC engines almost match, but the highest bit of a VCMD has a different meaning:
* [[Accolade Engine]] ''(uses the highest bit to indicate whether there is a delay or not)''
* [[Alfa System Engine]] ''(allows VCMD ID duplication through not setting the highest bit and also contains an option via the track header to use compressed data instead, therefore the internal compression format must be recorded as well)''
* [[Bits Studios Engine]] ''(allows VCMD ID duplication through not setting the highest bit)''
* [[Eurocom Engine]] ''(allows VCMD ID duplication through not setting the highest bit: the sound driver contains the ability to use backreferencing, somewhat akin to SNESGSS's, though I need to do some more analysis of this one, as this one has some more features... and nesting support)''

[[Category:SPC Sound Engines]]

Category:MIDI-Based SPC Sound Engines

2023-01-21T18:25:10Z

KungFuFurby: Removed Accolade and added Game Studio, also sorted out Alfa System and Eurocom.

This contains a list of [[:Category:SPC Sound Engines|SPC Sound Engines]] whose internal VCMD format contains a match to [[MIDI]]'s own format (at least as far as being able to generally identify it). Except for Loriciel and Silicon Sorcery's SPC sound engines, the header generally does not match MIDI's own format. They may contain custom and/or relocated VCMDs in place of standard MIDI features in some cases.

The following SPC sound engine pages that satisfy this criteria have not been created yet:
* [[ACID]] (Realtime Associates)
* [[Advanced Real-time Dynamic Interplay]] ('''Not''' RPM Racing, Wolfenstein 3D or Super 3D Noah's Ark)
* [[Game Studio Engine]]
* [[Loriciel Engine]]
* [[Mindscape Engine]]
* [[Silicon Sorcery Engine]]
* [[Super Music Driver]] (Haüs Teknikka)

These SPC engines almost match, but the highest bit of a VCMD has a different meaning:
* [[Alfa System Engine]] ''(allows VCMD ID duplication through not setting the highest bit and also contains an option via the track header to use compressed data instead, therefore the internal compression format must be recorded as well)''
* [[Bits Studios Engine]] ''(allows VCMD ID duplication through not setting the highest bit)''
* [[Eurocom Engine]] ''(allows VCMD ID duplication through not setting the highest bit: the sound driver contains the ability to use backreferencing, somewhat akin to SNESGSS's, though I need to do some more analysis of this one, as this one has some more features... and nesting support)''

[[Category:SPC Sound Engines]]

N-SPC Engine/Nintendo/Build Sorting

2022-11-23T18:04:20Z

KungFuFurby: Adding Yumiko Kanki to the Nintendo section for build sorting

__TOC__

==Unique cases==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Aging Cassette SNES Burn-In Test Cartridge|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$113A</tt>||For distinguishing purposes, known outside of these notes as Sound Module and Burn-In Test to refer to the copy found in the SNES Burn-In Test Cartridge.
|-
|Nintendo Power Menu Program || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|}

==F-Zero Builds==
This game has multiple revisional builds known.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|F-Zero || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1776</tt>||
|-
|F-Zero (Beta)|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1778</tt>||
|}

==Tetris & Dr. Mario Builds==
These builds are unique to one game, but unlike Super Scope 6 (which you may have noticed that LazerBlazer and Blastris are separated due to different SFX execution), they also match in general execution.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Tetris and Dr. Mario (Mixed Match) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$118F</tt>||
|-
|Tetris and Dr. Mario (Dr. Mario) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$1199</tt>||
|-
|Tetris and Dr. Mario (Tetris) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$11A1</tt>||
|}

==Akito Nakatsuka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Scope 6 (LazerBlazer) (US version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B33</tt>||
|-
|Super Scope 6 (LazerBlazer) (Japanese and European version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B37</tt>||
|-
|Super Game Boy Super Game Boy 2 || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0A5D</tt>||
|-
|BS-X BIOS Cassette Kensaki - NUS-you S Cassette || <tt>$0370</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$04AB</tt>||
|-
|JRA PAT JRA PAT - Wide Taiouban || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$0739</tt>||
|-
|Sutte Hakkun || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$074C</tt>||
|}

===Yuichi Ozaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Marvelous - Mouhitotsu no Takara-jima || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0BC5</tt>||
|-
|SA-1 Demo || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B23</tt>||
|-
|Heisei Shin Onigashima - Kouhen Heisei Shin Onigashima - Zenpen || <tt>$0400</tt> || <tt>D0 F3 8F ?? ?? BC 3F ?? ??</tt> || <tt>$0C8D</tt>||
|}

==Hirokazu Tanaka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Mario Paint (Beta) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? C4 ?? 3F ?? ??</tt> || <tt>$2625</tt>||
|-
|Mario Paint || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$1430</tt>||
|-
|Mother 2/Earthbound || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16A5</tt>||
|-
|Snoopy Concert || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16EB</tt>||
|}

==Kenji Yamamoto==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Metroid || <tt>$1500</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1ED7</tt>||
|}

==Koji Kondo==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0A96</tt>||
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island (beta version) || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B08</tt>||
|-
|Star Fox/Star Wing || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B14</tt>||
|-
|Super Mario All-Stars/Super Mario Collection || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0C11</tt>||
|-
|Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E22</tt>||
|-
|Star Glider || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E97</tt>|| Prototype of Star Fox/Star Wing.
|-
|SimCity || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$175D</tt>||
|-
|Super Donkey 1 || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$1DC9</tt>|| Sound driver build is a prototype of Legend of Zelda - A Link to the Past's.
|}

===Prototype===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario World (all other versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BC0</tt> ||
|-
|Super Mario World (Super Mario All-Stars + Super Mario World) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BF4</tt> ||
|-
|Pilotwings (European version) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$126A</tt> ||
|-
|Pilotwings (US & Japanese versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$12CD</tt> ||
|}

===Yoji Inagaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Star Fox 2 (1994-04-01) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>||
|-
|Star Fox 2 (1994-04-15) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>|| Except for a single opcode's difference at $064C, all of the code differences are after the SFX data, and thus pointers cannot be fully factored in.
|-
|Star Fox 2 (1994-05-06 and 1994-05-13) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B62</tt>||
|-
|Star Fox 2 (1994-08-31) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6D</tt>||
|-
|Star Fox 2 (1994-12-28) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B9C</tt>||
|-
|Star Fox 2 (1995-06-08) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD4</tt>||
|-
|Star Fox 2 (1995-06-22) Star Fox 2 (1995-06-27) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD7</tt>|| These builds are identical to each other minus pointers placed after the SFX data.
|-
|Star Fox 2 (1995-07-25) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BDA</tt>||
|-
|Star Fox 2 || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0BDF</tt>||
|}

==Taro Bando==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario Kart (beta version) (1992-01-21 build) || <tt>$0800</tt> || <tt>2F ?? BC 3F ?? ??</tt> || <tt>$0E3D</tt> || Refers to a sound.bin file with this timestamp that was not embedded in a known prototype build.
|-
|Super Mario Kart (beta version) (mkart) || <tt>$0800</tt> || <tt>E8 ?? BC 3F ?? ??</tt> || <tt>$0D79</tt>|| Refers to a prototype from April 13, 1992.
|-
|Super Mario Kart (beta version) (mario_kart-01) || <tt>$0800</tt> || <tt>C5 ?? ?? E8 ?? 3F ?? ??</tt> || <tt>$0D65</tt> || Refers to what is known as the Enigma prototype build.
|-
|Super Mario Kart (beta version) (mario_kart) || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$0D74</tt> || Refers to a prototype from late June 1992, created before kar4t.
|-
|Super Mario Kart (beta version) (kar4t) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1598</tt> || Refers to a prototype from late June 1992, created after mario_kart.
|-
|Super Mario Kart (US version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19B4</tt>||
|-
|Super Mario Kart (Japanese and European version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19BA</tt>||
|-
|FX Trax || <tt>$0800</tt> || <tt>D0 F7 E8 ?? 3F ?? ??</tt> || <tt>$0D61</tt>|| Prototype of Wild Trax/Stunt Race FX.
|-
|Wild Trax/Stunt Race FX || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D73</tt>|| Loading program at $0675 before the actual start location
|}

==Yumiko Kanki==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Special Tee Shot (Prototype) || <tt>$0460</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0A78</tt>||
|-
|Special Tee Shot (BS-X version) || <tt>$0400</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0B86</tt>||
|}

==Unknown==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|SNES Burn-In Test Cartridge || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0D6D</tt>||For distinguishing purposes, known outside of these notes as Super Scope Test.
|-
|Super Scope 6 (Blastris) || <tt>$0800</tt> || <tt>90 F8 BC 3F ?? ??</tt> || <tt>$0D89</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine/Nintendo

2022-11-23T18:02:22Z

KungFuFurby: Marking this under the Unique cases instead because it is a one-game case (only found in Special Tee Shot, but it has two builds)...

Go back to [[N-SPC Engine]] 

__TOC__

Nintendo is the first user of the N-SPC engine, both at launch and with the prototype variant. There are a variety of game-specific or programmer-specific cases in here, and thus have been sorted accordingly for disambiguation reasons.

The raw build sorting notes can be found [[N-SPC Engine/Nintendo/Build Sorting|here]] for all variants by Nintendo.

==Unique Cases==
* [[N-SPC Engine/Nintendo/F-Zero|F-Zero]]
* [[N-SPC Engine/Nintendo/Sound Module and Burn-In Test|Sound Module and Burn-In Test]]
* [[N-SPC Engine/Nintendo/Mario Paint|Mario Paint]]
* [[N-SPC Engine/Nintendo/Super Metroid|Super Metroid]]
* [[N-SPC Engine/Nintendo/Tetris and Dr. Mario|Tetris and Dr. Mario]]
* [[N-SPC Engine/Nintendo/Nintendo Power Menu Program|Nintendo Power Menu Program]]
* [[N-SPC Engine/Nintendo/Special Tee Shot|Special Tee Shot]]
* [[N-SPC Engine/Nintendo/Super Scope 6 (Blastris)|Super Scope 6 (Blastris)]]

==Multi-Game Cases==
* [[N-SPC Engine/Nintendo/Akito Nakatsuka|Akito Nakatsuka]]
* [[N-SPC Engine/Nintendo/Hirokazu Tanaka|Hirokazu Tanaka]]
* [[N-SPC Engine/Nintendo/Koji Kondo|Koji Kondo]]
** [[N-SPC Engine/Nintendo/Koji Kondo/Prototype|Prototype]]
* [[N-SPC Engine/Nintendo/Taro Bando|Taro Bando]]

The raw build sorting notes can be found [[N-SPC Engine/Nintendo/Build Sorting|here]] for all variants by Nintendo.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

N-SPC Engine/Nintendo

2022-11-23T18:01:13Z

KungFuFurby: Adding Yumiko Kanki to the Nintendo section

Go back to [[N-SPC Engine]] 

__TOC__

Nintendo is the first user of the N-SPC engine, both at launch and with the prototype variant. There are a variety of game-specific or programmer-specific cases in here, and thus have been sorted accordingly for disambiguation reasons.

The raw build sorting notes can be found [[N-SPC Engine/Nintendo/Build Sorting|here]] for all variants by Nintendo.

==Unique Cases==
* [[N-SPC Engine/Nintendo/F-Zero|F-Zero]]
* [[N-SPC Engine/Nintendo/Sound Module and Burn-In Test|Sound Module and Burn-In Test]]
* [[N-SPC Engine/Nintendo/Mario Paint|Mario Paint]]
* [[N-SPC Engine/Nintendo/Super Metroid|Super Metroid]]
* [[N-SPC Engine/Nintendo/Tetris and Dr. Mario|Tetris and Dr. Mario]]
* [[N-SPC Engine/Nintendo/Nintendo Power Menu Program|Nintendo Power Menu Program]]
* [[N-SPC Engine/Nintendo/Super Scope 6 (Blastris)|Super Scope 6 (Blastris)]]

==Multi-Game Cases==
* [[N-SPC Engine/Nintendo/Akito Nakatsuka|Akito Nakatsuka]]
* [[N-SPC Engine/Nintendo/Hirokazu Tanaka|Hirokazu Tanaka]]
* [[N-SPC Engine/Nintendo/Koji Kondo|Koji Kondo]]
** [[N-SPC Engine/Nintendo/Koji Kondo/Prototype|Prototype]]
* [[N-SPC Engine/Nintendo/Taro Bando|Taro Bando]]
* [[N-SPC Engine/Nintendo/Yumiko Kanki|Yumiko Kanki]]

The raw build sorting notes can be found [[N-SPC Engine/Nintendo/Build Sorting|here]] for all variants by Nintendo.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

David Whittaker Sound Engine

2022-08-18T15:01:20Z

KungFuFurby: Discovered Set Tempo sound driver command was not present in V2.3 (referring to Gods) either. Huh.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta's Title Screen and Lawnmower Man/Virtual Wars' US Beta
* Lemmings 2: The Tribes' most common build and Riddick Bowe Boxing's Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| Dream TV || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| Krusty's Super Fun House || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| Kick Off/Super Kick Off || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| Batman: Revenge of the Joker || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| Super SWIV/Firepower 2000 || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| Gods || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| World Class Rugby || 2.3 || <tt>0x0608</tt> || <tt>0x0B8000</tt> (all versions)
|-
| Battle Cars || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| Chavez/Riddick Bowe Boxing || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except Chavez) (three unique build variants, one per version between Chavez, US & Japanese versions)
|-
| Lawnmower Man/Virtual Wars || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| Apocalypse II || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| Elite Soccer/World Cup Striker || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| Kick Off 3 (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| Lemmings 2: The Tribes || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| Porky Pig's Haunted Holiday (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| Shaq Fu || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| Michael Jordan: Chaos in the Windy City || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are resent.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Master Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Master & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Master Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* Apocalypse II (Opening logo)/Lemmings 2: The Tribes (Opening logo)
* Kick Off 3 (Beta) (In-Game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** Dream TV (beta and final): '''2X'''
*** All other games: '''4X'''
*** Batman: Revenge of the Joker, Krusty's Super Fun House, Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu, Super SWIV/Firepower 2000: '''8X'''

The following builds don't support this command:
* Gods (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Master & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the master volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** Batman: Revenge of the Joker: '''1/4'''
*** Dream TV: '''1/4'''
*** Gods (all builds): '''3/16'''
*** World Class Rugby: '''3/16'''
*** Lawnmower Man/Virtual Wars (Driving): '''3/16'''
*** Lemmings 2: The Tribes (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* Batman: Revenge of the Joker
* Dream TV
* Gods (all builds)
* World Class Rugby
* Lawnmower Man/Virtual Wars (Driving)
* Lemmings 2: The Tribes (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* Battle Cars
* Riddick Bowe Boxing/Chavez (all versions except Japanese)
* Shaq-Fu

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V2.2, V3.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* Battle Cars
* World Cup Striker (European version) (Title Screen)
* Elite Soccer/World Cup Striker (European version) (In-Game)
* Kick Off 3 (beta) (In-Game)
* Kick Off 3 (beta) (Title Screen)
* Porky Pig's Haunted Holiday (beta)
* Shaq-Fu

Not all IDs are supported in these builds...
* Lawnmower Man/Virtual Wars (In-Game) ''(does not support $1A-$1D, not even in the code)''
* World Cup Striker (Japanese) (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For Dream TV Beta and Kick Off, only five pointers are defined. For Krusty's Super Fun House, only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (Dream TV Beta and Kick Off)
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (Krusty's Super Fun House)
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(Krusty's Super Fun House only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Two builds don't support song entries at all:
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta (In-Game)

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Master Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Master Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine

2022-08-13T02:36:41Z

KungFuFurby: /* L/R Voice Volume (VCMD $F3) */ Correct an accidental self-reference when describing the scaling behavior for later versions.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta's Title Screen and Lawnmower Man/Virtual Wars' US Beta
* Lemmings 2: The Tribes' most common build and Riddick Bowe Boxing's Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| Dream TV || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| Krusty's Super Fun House || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| Kick Off/Super Kick Off || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| Batman: Revenge of the Joker || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| Super SWIV/Firepower 2000 || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| Gods || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| World Class Rugby || 2.3 || <tt>0x0608</tt> || <tt>0x0B8000</tt> (all versions)
|-
| Battle Cars || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| Chavez/Riddick Bowe Boxing || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except Chavez) (three unique build variants, one per version between Chavez, US & Japanese versions)
|-
| Lawnmower Man/Virtual Wars || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| Apocalypse II || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| Elite Soccer/World Cup Striker || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| Kick Off 3 (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| Lemmings 2: The Tribes || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| Porky Pig's Haunted Holiday (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| Shaq Fu || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| Michael Jordan: Chaos in the Windy City || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are resent.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Master Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Master & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Master Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* Apocalypse II (Opening logo)/Lemmings 2: The Tribes (Opening logo)
* Kick Off 3 (Beta) (In-Game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** Dream TV (beta and final): '''2X'''
*** All other games: '''4X'''
*** Batman: Revenge of the Joker, Krusty's Super Fun House, Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu, Super SWIV/Firepower 2000: '''8X'''

The following builds don't support this command:
* Gods (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Master & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the master volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** Batman: Revenge of the Joker: '''1/4'''
*** Dream TV: '''1/4'''
*** Gods (all builds): '''3/16'''
*** World Class Rugby: '''3/16'''
*** Lawnmower Man/Virtual Wars (Driving): '''3/16'''
*** Lemmings 2: The Tribes (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* Batman: Revenge of the Joker
* Dream TV
* Gods (all builds)
* World Class Rugby
* Lawnmower Man/Virtual Wars (Driving)
* Lemmings 2: The Tribes (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* Battle Cars
* Riddick Bowe Boxing/Chavez (all versions except Japanese)
* Shaq-Fu

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* Battle Cars
* World Cup Striker (European version) (Title Screen)
* Elite Soccer/World Cup Striker (European version) (In-Game)
* Kick Off 3 (beta) (In-Game)
* Kick Off 3 (beta) (Title Screen)
* Porky Pig's Haunted Holiday (beta)
* Shaq-Fu

Not all IDs are supported in these builds...
* Lawnmower Man/Virtual Wars (In-Game) ''(does not support $1A-$1D, not even in the code)''
* World Cup Striker (Japanese) (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For Dream TV Beta and Kick Off, only five pointers are defined. For Krusty's Super Fun House, only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (Dream TV Beta and Kick Off)
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (Krusty's Super Fun House)
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(Krusty's Super Fun House only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Two builds don't support song entries at all:
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta (In-Game)

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Master Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Master Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$EE</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$EE</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine

2022-08-12T22:56:06Z

KungFuFurby: Discovered Set Tempo sound driver command was not present in V2.0

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta's Title Screen and Lawnmower Man/Virtual Wars' US Beta
* Lemmings 2: The Tribes' most common build and Riddick Bowe Boxing's Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| Dream TV || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| Krusty's Super Fun House || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| Kick Off/Super Kick Off || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| Batman: Revenge of the Joker || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| Super SWIV/Firepower 2000 || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| Gods || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| World Class Rugby || 2.3 || <tt>0x0608</tt> || <tt>0x0B8000</tt> (all versions)
|-
| Battle Cars || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| Chavez/Riddick Bowe Boxing || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except Chavez) (three unique build variants, one per version between Chavez, US & Japanese versions)
|-
| Lawnmower Man/Virtual Wars || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| Apocalypse II || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| Elite Soccer/World Cup Striker || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| Kick Off 3 (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| Lemmings 2: The Tribes || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| Porky Pig's Haunted Holiday (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| Shaq Fu || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| Michael Jordan: Chaos in the Windy City || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are resent.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Master Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Master & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.1
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Master Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* Apocalypse II (Opening logo)/Lemmings 2: The Tribes (Opening logo)
* Kick Off 3 (Beta) (In-Game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** Dream TV (beta and final): '''2X'''
*** All other games: '''4X'''
*** Batman: Revenge of the Joker, Krusty's Super Fun House, Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu, Super SWIV/Firepower 2000: '''8X'''

The following builds don't support this command:
* Gods (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Master & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the master volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** Batman: Revenge of the Joker: '''1/4'''
*** Dream TV: '''1/4'''
*** Gods (all builds): '''3/16'''
*** World Class Rugby: '''3/16'''
*** Lawnmower Man/Virtual Wars (Driving): '''3/16'''
*** Lemmings 2: The Tribes (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* Batman: Revenge of the Joker
* Dream TV
* Gods (all builds)
* World Class Rugby
* Lawnmower Man/Virtual Wars (Driving)
* Lemmings 2: The Tribes (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* Battle Cars
* Riddick Bowe Boxing/Chavez (all versions except Japanese)
* Shaq-Fu

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.1-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* Battle Cars
* World Cup Striker (European version) (Title Screen)
* Elite Soccer/World Cup Striker (European version) (In-Game)
* Kick Off 3 (beta) (In-Game)
* Kick Off 3 (beta) (Title Screen)
* Porky Pig's Haunted Holiday (beta)
* Shaq-Fu

Not all IDs are supported in these builds...
* Lawnmower Man/Virtual Wars (In-Game) ''(does not support $1A-$1D, not even in the code)''
* World Cup Striker (Japanese) (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For Dream TV Beta and Kick Off, only five pointers are defined. For Krusty's Super Fun House, only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (Dream TV Beta and Kick Off)
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (Krusty's Super Fun House)
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(Krusty's Super Fun House only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Two builds don't support song entries at all:
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta (In-Game)

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Master Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Master Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$F3</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$F3</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine

2022-08-12T19:27:19Z

KungFuFurby: /* V2.0-V4.0a */ Accidentally got these two backwards.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta's Title Screen and Lawnmower Man/Virtual Wars' US Beta
* Lemmings 2: The Tribes' most common build and Riddick Bowe Boxing's Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| Dream TV || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| Krusty's Super Fun House || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| Kick Off/Super Kick Off || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| Batman: Revenge of the Joker || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| Super SWIV/Firepower 2000 || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| Gods || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| World Class Rugby || 2.3 || <tt>0x0608</tt> || <tt>0x0B8000</tt> (all versions)
|-
| Battle Cars || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| Chavez/Riddick Bowe Boxing || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except Chavez) (three unique build variants, one per version between Chavez, US & Japanese versions)
|-
| Lawnmower Man/Virtual Wars || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| Apocalypse II || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| Elite Soccer/World Cup Striker || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| Kick Off 3 (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| Lemmings 2: The Tribes || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| Porky Pig's Haunted Holiday (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| Shaq Fu || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| Michael Jordan: Chaos in the Windy City || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are resent.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Master Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Master & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.0
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Master Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* Apocalypse II (Opening logo)/Lemmings 2: The Tribes (Opening logo)
* Kick Off 3 (Beta) (In-Game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** Dream TV (beta and final): '''2X'''
*** All other games: '''4X'''
*** Batman: Revenge of the Joker, Krusty's Super Fun House, Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu, Super SWIV/Firepower 2000: '''8X'''

The following builds don't support this command:
* Gods (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Master & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the master volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** Batman: Revenge of the Joker: '''1/4'''
*** Dream TV: '''1/4'''
*** Gods (all builds): '''3/16'''
*** World Class Rugby: '''3/16'''
*** Lawnmower Man/Virtual Wars (Driving): '''3/16'''
*** Lemmings 2: The Tribes (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* Batman: Revenge of the Joker
* Dream TV
* Gods (all builds)
* World Class Rugby
* Lawnmower Man/Virtual Wars (Driving)
* Lemmings 2: The Tribes (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* Battle Cars
* Riddick Bowe Boxing/Chavez (all versions except Japanese)
* Shaq-Fu

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* Battle Cars
* World Cup Striker (European version) (Title Screen)
* Elite Soccer/World Cup Striker (European version) (In-Game)
* Kick Off 3 (beta) (In-Game)
* Kick Off 3 (beta) (Title Screen)
* Porky Pig's Haunted Holiday (beta)
* Shaq-Fu

Not all IDs are supported in these builds...
* Lawnmower Man/Virtual Wars (In-Game) ''(does not support $1A-$1D, not even in the code)''
* World Cup Striker (Japanese) (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For Dream TV Beta and Kick Off, only five pointers are defined. For Krusty's Super Fun House, only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (Dream TV Beta and Kick Off)
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (Krusty's Super Fun House)
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(Krusty's Super Fun House only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Two builds don't support song entries at all:
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta (In-Game)

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Master Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Master Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$F3</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$F3</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

David Whittaker Sound Engine

2022-08-08T22:56:26Z

KungFuFurby: Corrected $F5 VCMD notes and added some fine print for global transposition, since on earlier versions one of the channels is not affected.

__TOC__

'''David Whittaker Sound Engine''' is a sound driver for the SPC700 programmed by David Whittaker.

Many games have multiple different builds stored in the game at once, sometimes with code differences. Almost every single game has at least one unique build not shared by any of the other games: the exceptions are...
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta's Title Screen and Lawnmower Man/Virtual Wars' US Beta
* Lemmings 2: The Tribes' most common build and Riddick Bowe Boxing's Japanese version

The raw build sorting notes can be found [[David Whittaker Sound Engine/Build Sorting|here]].

These are the games where the sound engine was used:
{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Code Location !! ROM Offset
|-
| Dream TV || 0.0 (Beta 2) 2.1 (all other versions) || <tt>0x098A</tt> (Beta 2) <tt>0x0614</tt> (all other versions) || <tt>0x0196A2</tt> (Beta 2, uncompressed) <tt>0x039B16</tt> (all other versions, ''RNC compressed'')
|-
| Krusty's Super Fun House || 1.0 || <tt>0x04F1</tt> || <tt>0x0E8000</tt> (all versions)
|-
| Kick Off/Super Kick Off || 1.0 || <tt>0x04E6</tt> || <tt>0x098000</tt> (all versions)
|-
| Batman: Revenge of the Joker || 2.0 || <tt>0x0610</tt> || <tt>0x068000</tt>
|-
| Super SWIV/Firepower 2000 || 2.2 || <tt>0x06AD</tt> || <tt>0x158000</tt>
|-
| Gods || 2.3 || <tt>0x0500</tt>/<tt>0x0600</tt>/<tt>0x0612</tt> || <tt>0x980000</tt>/<tt>0x98AFAC</tt>/<tt>0x99D448</tt>/<tt>0x9A8000</tt> (all versions, three unique build variants, ''RNC compressed'')
|-
| World Class Rugby || 2.3 || <tt>0x0608</tt> || <tt>0x0B8000</tt> (all versions)
|-
| Battle Cars || 3.0 || <tt>0x0717</tt> || <tt>0x0A8000</tt>
|-
| Chavez/Riddick Bowe Boxing || 3.0 (US version) 3.1 (all other versions) || <tt>0x0621</tt> (Japanese version) <tt>0x067C</tt> (US version) <tt>0x067D</tt> (Chavez) || <tt>0x0D8000</tt> (all versions)/<tt>0x0E8000</tt> (all versions except Chavez) (three unique build variants, one per version between Chavez, US & Japanese versions)
|-
| Lawnmower Man/Virtual Wars || 3.1 || <tt>0x06BD</tt> (US beta) <tt>0x06A4</tt> (all other versions) || <tt>0x9C8000</tt> (all versions except US beta)/<tt>0x9E8000</tt> (all versions)
|-
| Apocalypse II || 3.1 || <tt>0x05AF</tt>/<tt>0x0624</tt> || <tt>0x118000</tt>/<tt>0x168000</tt>
|-
| Elite Soccer/World Cup Striker || 3.1 || <tt>0x0601</tt> (US and European version In-Game) <tt>0x060B</tt> (US and Japanese version Title Screen) <tt>0x0704</tt> (Japanese version In-Game) <tt>0x070B</tt> (European version Title Screen) || <tt>0x1B8000</tt> (all versions)/<tt>0x08D500</tt> (US & Japanese version)/<tt>0x08D550</tt> (European beta version)/<tt>0x08D640</tt> (European version) (Four unique build variants: two Title Screen (US/JP compared to EU) and two In-Game (US/EU compare to JP))
|-
| Kick Off 3 (Beta version only) || 3.1 || <tt>0x0658</tt>/<tt>0x06BD</tt> || <tt>0x1A8000</tt>/<tt>0x1D8000</tt>
|-
| Lemmings 2: The Tribes || 3.1 || <tt>0x05AF</tt>/<tt>0x060F</tt>/<tt>0x0614</tt>/<tt>0x0621</tt>/<tt>0x0697</tt> || ''(omitted for now: there are 16 copies of the code in the ROM, with five different build variants being present: four of them are used in one instance each, that being the opening logo, the Title Screen, the Beach Tribe and the Cavelem Tribe, and the others use a single common copy of the code with modifications of constants and non-code pointers)''
|-
| Porky Pig's Haunted Holiday (Beta version only) || 3.1 || <tt>0x06CA</tt> || ''(omitted for now: there are 36 copies of the code in the ROM, none of which are unique except for the sound data and modifications of constants and non-code pointers)''
|-
| Shaq Fu || 4.0a || <tt>0x0539</tt> || <tt>0xD96408</tt> (all versions)
|-
| Michael Jordan: Chaos in the Windy City || 4.0b || <tt>0x0539</tt> || <tt>0xD2B18F</tt> (all versions)
|}

==Communication with the SNES==
Each command is triggered by sending the parameters to $2141-$2143 first, then the command ID to $2140. The latches are cleared afterwards on all registers, which means the same command IDs can be sent again, provided the parameters are resent.

===Output to the SNES===
====V0.0====
There is no acknowledgement to the SNES beyond the latches being cleared. 
====V1.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141. 
After the first command ID is sent, $2140-$2142 are updated every time a command ID is sent, and $2143 is updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.
<pre>xx yy zz %00000abc</pre>
* <tt>xx</tt> is the command ID that was just sent.
* <tt>yy</tt> is a parameter that was sent to $2141 to execute the command.
* <tt>zz</tt> is the command ID that was just sent.
* <tt>%a</tt> indicates that a piece of SFX is playing on channel 7.
* <tt>%b</tt> indicates that a piece of SFX is playing on channel 8.
* <tt>%c</tt> indicates that music is playing.

====V2.0-V4.0====
On initialization, initially $2140-$2141 are sent a zero while the sound driver sets itself up. When initialization finishes, a <tt>$55</tt> is sent to $2140-$2141, and the internal command counter is initialized to the same value. 
After the first command ID is sent, $2140 is updated every time a command ID is sent, and $2141-$2143 are updated every timer 0 tick. 
When a command ID is sent, the latches are cleared, allowing the SNES to send the same command ID again. However, this also means that the parameters have to be resent if the same parameters are to be used again.

=====V2.0-V4.0a=====
<pre>xx %yyyyyyyy zz %aaaaaaaa</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>%yyyyyyyy</tt> is a set of bits for each channel that is playing SFX. These bits are cleared only when the SFX has elapsed all of its ticks, not when the sample is done playing if non-looping. ''Not used in V4.0a.''
* <tt>zz</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.
* <tt>%aaaaaaaa</tt> is a set of bits for each channel that is playing a note for music. ''Not used in V4.0a.''

=====V4.0b=====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a counter that is incremented every time a command is received.
* <tt>yy</tt> indicates whether or not music is playing. It is <tt>$FF</tt> when music is playing, and zero otherwise.

===Command IDs (V0.0-V1.0)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 7) || <tt>$04 xx yz ??</tt> || 0.0
|-
|<tt>$05</tt> || Play SFX (Channel 8) || <tt>$05 xx yz ??</tt> || 0.0
|-
|<tt>$06</tt> || Fast Forward On || <tt>$06 ?? ?? ??</tt> || 0.0
|-
|<tt>$07</tt> || Fast Forward Off || <tt>$07 ?? ?? ??</tt> || 0.0
|-
|<tt>$08</tt> || Master Volume || <tt>$08 xx ?? ??</tt> || 1.0
|-
|<tt>$09-$FF</tt> || Latch Clear || <tt>$09-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V2.0-V4.0a)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments !! Minimum Version
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt> || 0.0
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt> || 0.0
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt> || 0.0
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt> || 0.0
|-
|<tt>$04</tt> || Play SFX (Channel 1) || <tt>$04 xx yz ??</tt> || 2.0
|-
|<tt>$05</tt> || Play SFX (Channel 2) || <tt>$05 xx yz ??</tt> || 2.0
|-
|<tt>$06</tt> || Play SFX (Channel 3) || <tt>$06 xx yz ??</tt> || 2.0
|-
|<tt>$07</tt> || Play SFX (Channel 4) || <tt>$07 xx yz ??</tt> || 2.0
|-
|<tt>$08</tt> || Play SFX (Channel 5) || <tt>$08 xx yz ??</tt> || 2.0
|-
|<tt>$09</tt> || Play SFX (Channel 6) || <tt>$09 xx yz ??</tt> || 2.0
|-
|<tt>$0A</tt> || Play SFX (Channel 7) || <tt>$0A xx yz ??</tt> || 2.0
|-
|<tt>$0B</tt> || Play SFX (Channel 8) || <tt>$0B xx yz ??</tt> || 2.0
|-
|<tt>$0C</tt> || Fast Forward On || <tt>$0C ?? ?? ??</tt> || 2.0
|-
|<tt>$0D</tt> || Fast Forward Off || <tt>$0D ?? ?? ??</tt> || 2.0
|-
|<tt>$0E</tt> || Master & Echo Volume || <tt>$0E xx ?? ??</tt> || 2.0
|-
|<tt>$0F</tt> || Echo Feedback || <tt>$0F xx ?? ??</tt> || 2.0
|-
|<tt>$10</tt> || Go to IPL Boot Program || <tt>$10 ?? ?? ??</tt> || 2.0
|-
|<tt>$11</tt> || Set Tempo || <tt>$11 xx ?? ??</tt> || 2.0
|-
|<tt>$12</tt> || Set SFX Volume (Channel 1) || <tt>$12 ?? xy ??</tt> || 3.0
|-
|<tt>$13</tt> || Set SFX Volume (Channel 2) || <tt>$13 ?? xy ??</tt> || 3.0
|-
|<tt>$14</tt> || Set SFX Volume (Channel 3) || <tt>$14 ?? xy ??</tt> || 3.0
|-
|<tt>$15</tt> || Set SFX Volume (Channel 4) || <tt>$15 ?? xy ??</tt> || 3.0
|-
|<tt>$16</tt> || Set SFX Volume (Channel 5) || <tt>$16 ?? xy ??</tt> || 3.0
|-
|<tt>$17</tt> || Set SFX Volume (Channel 6) || <tt>$17 ?? xy ??</tt> || 3.0
|-
|<tt>$18</tt> || Set SFX Volume (Channel 7) || <tt>$18 ?? xy ??</tt> || 3.0
|-
|<tt>$19</tt> || Set SFX Volume (Channel 8) || <tt>$19 ?? xy ??</tt> || 3.0
|-
|<tt>$1A</tt> || Set SFX Pitch (Channel 1) || <tt>$1A xx yy ??</tt> || 3.0
|-
|<tt>$1B</tt> || Set SFX Pitch (Channel 2) || <tt>$1B xx yy ??</tt> || 3.0
|-
|<tt>$1C</tt> || Set SFX Pitch (Channel 3) || <tt>$1C xx yy ??</tt> || 3.0
|-
|<tt>$1D</tt> || Set SFX Pitch (Channel 4) || <tt>$1D xx yy ??</tt> || 3.0
|-
|<tt>$1E</tt> || Set SFX Pitch (Channel 5) || <tt>$1E xx yy ??</tt> || 3.0
|-
|<tt>$1F</tt> || Set SFX Pitch (Channel 6) || <tt>$1F xx yy ??</tt> || 3.0
|-
|<tt>$20</tt> || Set SFX Pitch (Channel 7) || <tt>$20 xx yy ??</tt> || 3.0
|-
|<tt>$21</tt> || Set SFX Pitch (Channel 8) || <tt>$21 xx yy ??</tt> || 3.0
|-
|<tt>$22-$23</tt> || Load New Data || <tt>$22-$23 xx yy ??</tt> || 4.0a
|-
|<tt>$24-$FF</tt> || Latch Clear/Increment Counter || <tt>$24-$FF ?? ?? ??</tt> || 0.0
|}

===Command IDs (V4.0b)===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || NOP || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01</tt> || Play Music || <tt>$01 xx ?? ??</tt>
|-
|<tt>$02</tt> || Pause Music || <tt>$02 ?? ?? ??</tt>
|-
|<tt>$03</tt> || Continue Music || <tt>$03 ?? ?? ??</tt>
|-
|<tt>$04</tt> || Play SFX || <tt>$04 xx yz ??</tt>
|-
|<tt>$05</tt> || Stop All SFX || <tt>$05 ?? ?? ??</tt>
|-
|<tt>$06</tt> || Master Volume || <tt>$06 xx ?? ??</tt>
|-
|<tt>$07</tt> || Set Tempo || <tt>$07 xx ?? ??</tt>
|-
|<tt>$08</tt> || Fast Forward On || <tt>$08 xx ?? ??</tt>
|-
|<tt>$09</tt> || Fast Forward Off || <tt>$09 xx ?? ??</tt>
|-
|<tt>$0A</tt> || Stop Music & Load New Data || <tt>$0A ?? ?? ??</tt>
|-
|<tt>$0B</tt> || Load New Data || <tt>$0B ?? ?? ??</tt>
|-
|<tt>$0C</tt> || Panning Separation || <tt>$0C xx ?? ??</tt>
|-
|<tt>$0D-$FF</tt> || Latch Clear/Increment Counter || <tt>$0D-$FF ?? ?? ??</tt>
|}

===Latch Clear/Increment Counter===
Clears the latches on the CPUIO registers and does nothing else except increment the counter on V2.0 and up, thus making this effectively a NOP. This occurs on almost all invalid command IDs: there is exactly one exception, noted under Invalid.

===Invalid (Command <tt>$22</tt> - Porky Pig's Haunted Holiday (beta) only)===
Crashes the sound driver. The only game that can do this is Porky Pig's Haunted Holiday (beta), and it is because it jumps directly to a RET opcode on an empty stack, thus causing a stack underflow and a jump to a memory location not used for code.

===NOP (Command <tt>$00</tt>)===
Does absolutely nothing.

===Play Music (Command <tt>$01</tt>)===
<pre>$01 xx ?? ??</pre>

Stops a previous piece of music, then plays a piece of music.

* <tt>xx</tt> is the music ID.
** V1.0 and up have boundary checks that prevent invalid music IDs from being played.

The following builds don't support this command because it effectively turns it into a NOP:
* Apocalypse II (Opening logo)/Lemmings 2: The Tribes (Opening logo)
* Kick Off 3 (Beta) (In-Game)

===Pause Music (Command <tt>$02</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$03</tt>)===
Resumes a paused song.

===Play SFX (Command <tt>$04-$05</tt> (V0.0-V1.0), <tt>$04-$0B</tt> (V2.0-V4.0a), <tt>$04</tt> (V4.0b))===
<pre>ii xx yz ??</pre>
Plays a piece of SFX.

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** V0.0-V1.0:
*** Channels 1-6: Not supported
*** Channel 7: <tt>$04</tt>
*** Channel 8: <tt>$05</tt>
** V2.0-V4.0a:
*** Channel 1: <tt>$04</tt>
*** Channel 2: <tt>$05</tt>
*** Channel 3: <tt>$06</tt>
*** Channel 4: <tt>$07</tt>
*** Channel 5: <tt>$08</tt>
*** Channel 6: <tt>$09</tt>
*** Channel 7: <tt>$0A</tt>
*** Channel 8: <tt>$0B</tt>
** V4.0b instead dynamically allocates the channel that the SFX is played on across channels 5-8, and has a fixed ID of <tt>$04</tt>.
* <tt>xx</tt> defines the SFX ID. Setting the highest bit (covering IDs <tt>$80-$FF</tt>) keys off the SFX instead of playing it.
** V1.0 and up have boundary checks that prevent invalid SFX IDs from being played, and only accept <tt>$FF</tt> as an ID to key off SFX on that channel. V4.0b doesn't support <tt>$80-$FF</tt> at all.
* <tt>y</tt> defines the left volume. This is not signed.
* <tt>z</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** Dream TV (beta and final): '''2X'''
*** All other games: '''4X'''
*** Batman: Revenge of the Joker, Krusty's Super Fun House, Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu, Super SWIV/Firepower 2000: '''8X'''

The following builds don't support this command:
* Gods (Ending)

====SFX Data Format====
Each SFX entry is a pointer to a 14-byte entry containing a series of parameters to utilize on a per-SFX basis. Only one channel's worth is defined here.

<pre>xx yy zz aa bb cc dd ee ff gg hh ii jj kk</pre>

* <tt>xx</tt> is the number of timer 0 ticks (times 10) to play the SFX for.
* <tt>yy</tt> is the number of timer 0 ticks (times 10) to slide pitches before resetting and doing the slide again.
* <tt>zz</tt> is a starting value for either the PITCHL DSP register or a noise frequency.
* <tt>aa</tt> is a starting value for the PITCHH DSP register.
* <tt>bb</tt> is the offset to apply to either the PITCHL DSP register or noise frequency per step.
* <tt>cc</tt> is a offset to apply to the PITCHH DSP register per step.
* <tt>dd</tt> is a direct write to the SRCN DSP register. <tt>$80</tt> and up instead cause this to use noise.
* <tt>ee</tt> modifies the pitch using RNG using a non-zero value (except for V3.0 and up, this value is any non-zero value). How it is modified depends on the version.
** V0.0-V2.0 overwrites the pitch settings and instead uses two bytes of RNG values for the pitch on a per-step basis.
** V2.1 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the high byte of the final pitch output on a per-step basis.
** V2.2 adds a random offset of the RNG value ANDed by <tt>$3F</tt> to the low byte of the starting pitch for the first step only.
** V2.3 does nothing.
** V3.0 and up apply a random offset of the RNG value ANDed by <tt>ee</tt> to the low byte of the starting pitch for the first step only.
* <tt>ff</tt> defines the sign for the pitch offset.
** <tt>$00</tt> turns off pitch slides for the SFX.
** <tt>$01-$7F</tt> apply a positive offset.
** <tt>$80-$FF</tt> apply a negative offset.
* <tt>gg</tt> is the number of timer 0 ticks (times 10) to perform the pitch slide for.
* <tt>hh</tt> is a direct write to the ADSR1 DSP register.
* <tt>ii</tt> is a direct write to the ADSR2 DSP register.
* <tt>jj</tt> is generally an endless flag, but its operation differs between versions.
** For V0.0-V4.0a, when this value is non-zero, it causes the SFX to be played endlessly until keyed off or interrupted. It also causes pitch slides to run forever.
** For V4.0b, this acts as SFX priority. If all four channels are being used for SFX and the priority of the incoming SFX is greater than the SFX currently played, then the SFX is overwritten. The SFX plays forever if this value is greater than <tt>$7F</tt>, like what is done in V0.0-V4.0a.
* <tt>kk</tt> is the number of timer 0 ticks (times 10) per step.

===Stop All SFX (Command <tt>$05</tt> (V4.0b))===
Stops all SFX from playing in channels 5-8.

===Fast Forward On (Command <tt>$06</tt> (V0.0-V1.0), <tt>$0C</tt> (V2.0-V4.0a), <tt>$08</tt> (V4.0b))===
Causes the music to play at maximum tempo... which means every ten timer 0 ticks. This is equivalent to a tempo of 256.

===Fast Forward Off (Command <tt>$07</tt> (V0.0-V1.0), <tt>$0D</tt> (V2.0-V4.0a), <tt>$09</tt> (V4.0b))===
Causes the music to play at normal tempo.

===Master & Echo Volume (Command <tt>$08</tt> (V1.0), <tt>$0E</tt> (V2.0-V4.0a), <tt>$06</tt> (V4.0b))===
<pre>ii xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the MVOLL and MVOLR DSP registers.
** V2.0 and up may also set the EVOLL and EVOLR DSP registers, but only if echo is supported in that build. It is always scaled by the master volume. The scaler multiplier (actually done with shifts) is as following, sorted by build...
*** Batman: Revenge of the Joker: '''1/4'''
*** Dream TV: '''1/4'''
*** Gods (all builds): '''3/16'''
*** World Class Rugby: '''3/16'''
*** Lawnmower Man/Virtual Wars (Driving): '''3/16'''
*** Lemmings 2: The Tribes (Cavelem Tribe): '''3/16'''

===Echo Feedback (Command <tt>$0F</tt> (V2.0-V4.0a))===
<pre>$0F xx ?? ??</pre>

* <tt>xx</tt> is a direct write to the EFB DSP register.

This is only ever supported if echo is supported in the ROM. That means only these builds support this command:
* Batman: Revenge of the Joker
* Dream TV
* Gods (all builds)
* World Class Rugby
* Lawnmower Man/Virtual Wars (Driving)
* Lemmings 2: The Tribes (Cavelem Tribe)

These other games have a reference for the ID, but effectively make it a NOP:
* Battle Cars
* Riddick Bowe Boxing/Chavez (all versions except Japanese)
* Shaq-Fu

===Go to IPL Boot Program (Command <tt>$10</tt> (V2.0-V4.0a))===
Jumps directly to the [[SPC700/IPL ROM|IPL Boot Program]].

===Set Tempo (Command <tt>$11</tt> (V2.0-V4.0a))===
<pre>$11 xx ?? ??</pre>

* <tt>xx</tt> is the tempo to set the song at. This overwrites the song's tempo settings.

===Set SFX Volume (Command <tt>$12-$19</tt> (V3.0-V4.0a))===
<pre>ii ?? xy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$12</tt>
** Channel 2: <tt>$13</tt>
** Channel 3: <tt>$14</tt>
** Channel 4: <tt>$15</tt>
** Channel 5: <tt>$16</tt>
** Channel 6: <tt>$17</tt>
** Channel 7: <tt>$18</tt>
** Channel 8: <tt>$19</tt>
* <tt>x</tt> defines the left volume. This is not signed.
* <tt>y</tt> defines the right volume. This is not signed.
** For both volume values, the 4-bit values are translated into the raw values for the VxVOLL/VxVOLR DSP registers via the following multipliers (in actuality, using XCNs and shift opcodes) on a per-game basis...
*** All other games: '''4X'''
*** Michael Jordan Chaos in the Windy City ''(SFX IDs <tt>$00</tt> and <tt>$4B</tt> only)'', Shaq-Fu: '''8X'''

===Set SFX Pitch (Command <tt>$1A-$21</tt> (V3.0-V4.0a))===
<pre>ii xx yy ??</pre>

* <tt>ii</tt>, the command ID used for the SFX, defines the channel used. 
** Channel 1: <tt>$1A</tt>
** Channel 2: <tt>$1B</tt>
** Channel 3: <tt>$1C</tt>
** Channel 4: <tt>$1D</tt>
** Channel 5: <tt>$1E</tt>
** Channel 6: <tt>$1F</tt>
** Channel 7: <tt>$20</tt>
** Channel 8: <tt>$21</tt>
* <tt>xx</tt> overwrites the PITCHL value used in the SFX data.
* <tt>yy</tt> overwrites the PITCHH value used in the SFX data.

This command is only supported in the following builds...
* Battle Cars
* World Cup Striker (European version) (Title Screen)
* Elite Soccer/World Cup Striker (European version) (In-Game)
* Kick Off 3 (beta) (In-Game)
* Kick Off 3 (beta) (Title Screen)
* Porky Pig's Haunted Holiday (beta)
* Shaq-Fu

Not all IDs are supported in these builds...
* Lawnmower Man/Virtual Wars (In-Game) ''(does not support $1A-$1D, not even in the code)''
* World Cup Striker (Japanese) (In-Game) ''(skips over $1A-$1D via a longer branding distance, though the code still exists)''

===Load New Data (Command <tt>$22-$23</tt> (V4.0a), <tt>$0B</tt> (V4.0b))===
Loads new data from the SNES using an IPL Boot ROM variant. 
''TODO Loading New Data (the loading protocol should be nearly identical to IPL Boot ROM with a few differences or so, since the program seems like it's using a similar variant)''

===Stop Music & Load New Data (Command <tt>$0A</tt> (V4.0b))===
Stops the music, then loads new data from the SNES using an IPL Boot ROM variant.

===Panning Separation (Command <tt>$0C</tt> (V4.0b))===
<pre>$0C xx ?? ??</pre>

* <tt>xx</tt> sets the amount that the panning will influence the left and right volumes. The maximum is zero, while the minimum is <tt>$FF</tt>, making it effectively mono.

==Song Entry==
For each song entry in an array of song definitions, one byte is defined as a starting tempo, followed by a series of pointers defined [[little endian]] style for each channel. For Dream TV Beta and Kick Off, only five pointers are defined. For Krusty's Super Fun House, only six pointers are defined. For all other games, eight pointers are defined.

Pre-V2.0 (Dream TV Beta and Kick Off)
<pre>xx yy yy zz zz aa aa bb bb cc cc</pre>
Pre-V2.0 (Krusty's Super Fun House)
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd</pre>
V2.0 and up
<pre>xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee ff ff</pre>
* <tt>xx</tt> is the starting tempo.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 1.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 2.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 3.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 4.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 5.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 6. ''(Krusty's Super Fun House only pre-V2.0)''
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 7. ''(not supported pre-V2.0)''
* <tt>ff ff</tt> is a [[little endian]] pointer to a pattern order list for channel 8. ''(not supported pre-V2.0)''

Two builds don't support song entries at all:
* The opening logos for Lemmings 2: The Tribes and Apocalypse II
* Kick Off 3 Beta (In-Game)

==Pattern Order List==
Each channel has a list of [[little endian]] pointers on a per-channel basis. If the pointer is zero, then you jump back to either the beginning of the pattern order list for that channel, or to the loop marker that was set by the $F5 VCMD.

==Instrument Format==
The instrument format at V0.0 is N-SPC/Kankichi-kun compatible minus noise support for SRCN values above 127. Post V1.0, one of the bytes loses its usage.

The instrument format is defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this... 
V0.0-V1.0
<pre>xx yy zz aa bb cc</pre>
V2.0 and up
<pre>xx yy zz ?? bb cc</pre>
* <tt>xx</tt> is a direct write to the VxSRCN DSP register.
* <tt>yy</tt> is a direct write to the VxADSR1 DSP register.
* <tt>zz</tt> is a direct write to the VxADSR2 DSP register.
* <tt>aa</tt> is a direct write to the VxGAIN DSP register... but only for V1.0 and older. Otherwise, it's an unused byte.
* <tt>bb</tt> is a pitch base multiplier.
* <tt>cc</tt> is a fractional pitch base multiplier, defined in 256ths.

==Voice Command Format==
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments !! Minimum Version
|-
| <tt>$00-$5F</tt> || Note || || 0.0
|-
| <tt>%011xxxxx</tt> <tt>$60-$7F</tt> || Note Length || || 0.0
|-
| <tt>$80-$EC</tt> || Invalid || || 0.0
|-
| <tt>$ED</tt> || Instant Pitch Change to Note || <tt>xx</tt> || 4.0a only
|-
| <tt>$ED</tt> || Set Master Volume || <tt>xx</tt> || 4.0b only
|-
| <tt>$EE</tt> || Volume Scaler by Fraction ||<tt>xx yy</tt> || 3.0
|-
| <tt>$EF</tt> || Set ADSR ||<tt>xx yy</tt> || 2.0
|-
| <tt>$F0</tt> || Fine Tune ||<tt>xx</tt> || 1.0
|-
| <tt>$F1</tt> || Pitch Bend ||<tt>xx</tt> || 1.0
|-
| <tt>$F2</tt> || Pitch Envelope ID ||<tt>xx</tt> || 0.0
|-
| <tt>$F3</tt> || L/R Voice Volume ||<tt>xx yy</tt> || 0.0
|-
| <tt>$F4</tt> || Tempo ||<tt>xx</tt> || 0.0
|-
| <tt>$F5</tt> || Jump to Pattern in Order List + Mark Loop Point ||<tt>xx xx</tt> || 0.0
|-
| <tt>$F6-$F7</tt> || Invalid || || 0.0
|-
| <tt>$F8</tt> || Key Off || || 0.0
|-
| <tt>$F9</tt> || One Note Delay || || 0.0
|-
| <tt>$FA</tt> || Instrument ||<tt>xx</tt> || 0.0
|-
| <tt>$FB</tt> || Absolute Global Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FC</tt> || Absolute Transposition ||<tt>xx</tt> || 0.0
|-
| <tt>$FD</tt> || Invalid || || 0.0
|-
| <tt>$FE</tt> || Song End || || 0.0
|-
| <tt>$FF</tt> || Pattern End || || 0.0
|}

===Invalid (VCMDs <tt>$80-$EC</tt>, <tt>$F6-$F7</tt>, <tt>$FD</tt>, <tt>$ED</tt> (pre-V4.0), <tt>$EE</tt> (pre-V3.0), <tt>$EF</tt> (pre-V2.0), <tt>$F0-$F1</tt> (pre-V1.0))===
The sound driver deliberately freezes itself via an infinite branch always loop rather than crashing or skipping the byte. This also takes up VCMD slots that are not filled in earlier versions.

===Note (VCMDs <tt>$00-$5F</tt>)===
Plays a note and delays the channel for one note length.

The initial pitch of the note is calculated using a pitch table that contains one octave (and a note)'s worth of pitch values. This value is shifted according to the octave used, and multiplied that by the instrument's pitch base to get the pitch for the note.

===Note Length (VCMDs <tt>$60-$7F</tt>)===
<pre>%011xxxxx</pre>
* <tt>%xxxxx</tt> represents your note length (as five bits).
Note lengths are defined as the number of tempo ticks plus one. Notes are keyed off either on another note or on the key off VCMD (<tt>$F9</tt>).

===Instant Pitch Change to Note (VCMD <tt>$ED</tt> (V4.0a))===
Requires V4.0a to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the note to change the pitch to.

===Set Master Volume (VCMD <tt>$ED</tt> (V4.0b))===
Requires V4.0b to use. Lower versions freeze the sound driver instead.

<pre>$ED xx</pre>

* <tt>xx</tt> defines the value to directly write to the MVOL DSP registers.

===Volume Scaler by Fraction (VCMD <tt>$EE</tt>)===
Requires V3.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EE xx yy</pre>

* <tt>xx</tt> is the numerator, and is the value to multiply the volume by. The scaling process is skipped if this is zero.
* <tt>yy</tt> is the denominator, and is the value to divide the multiplied volume by.
Put the two together, and you get the current volume multiplied by <math>\frac{x}{y}</math>.

===Set ADSR (VCMD <tt>$EF</tt>)===
Requires V2.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$EF xx yy</pre>
* <tt>xx</tt> is a direct write to the VxADSR1 DSP register.
* <tt>yy</tt> is a direct write to the VxADSR2 DSP register.

===Fine Tune (VCMD <tt>$F0</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F0 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

===Pitch Bend (VCMD <tt>$F1</tt>)===
Requires V1.0 or later to use. Lower versions freeze the sound driver instead.

<pre>$F1 xx</pre>
* <tt>xx</tt> is a signed delta value for the pitch. These are in units used directly for the VxPITCH DSP registers.

Pitch bends are performed every 10 timer 0 ticks independently of the tempo. They are automatically terminated after one note.

===Pitch Envelope ID (VCMD <tt>$F2</tt>)===
<pre>$F2 xx</pre>
* <tt>xx</tt> is an index to an array to a pointer of pitch envelopes. The pitch envelopes always loop and are clocked at a rate of 10 timer 0 ticks independently of the tempo ticker.

====Pitch Envelope Format====
=====Pitch Offset Tick (CMD <tt>$00-$7F</tt>, <tt>$81-$FF</tt>)=====
<pre>xx</pre>
* <tt>xx</tt> is a signed offset in units used directly for the VxPITCH DSP registers.

=====Restart Pitch Envelope (CMD <tt>$80</tt>)=====
<pre>$80</pre>
Jumps back to the beginning of the pitch envelope.

===L/R Voice Volume (VCMD <tt>$F3</tt>)===
<pre>$F3 xx yy</pre>
* This is a direct DSP register write to the VxVOL registers, with <tt>xx</tt> being the left volume and <tt>yy</tt> being the right volume.
This VCMD's operation changes depending on the version:
* V0.0-V2.2: Just a straight write with no modifications made to the input.
* V2.3: The input values are shifted left once.
* V3.0-V4.0b: The input values are scaled by VCMD <tt>$F3</tt>, then shifted left once.
* V4.0a: The input values are scaled by the values used for VCMD <tt>$F3</tt>. The shifting operation is not done here.

===Tempo (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines one tempo tick as <math>10*\frac{256}{x}</math> timer 0 ticks. Zero freezes the song except for pitch bends and envelopes, which are not affected by the tempo ticker.

===Jump to Pattern in Order List + Mark Loop Point (VCMD <tt>$F5</tt>)===
<pre>$F5 xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern pointer in the order list. The loop point is marked here.

===Key Off (VCMD <tt>$F8</tt>)===
Keys off the note and delays the channel for one note length.

===One Note Delay (VCMD <tt>$F9</tt>)===
Delays the channel for one note length.

===Instrument (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Absolute Global Transposition (VCMD <tt>$FB</tt>)===
<pre>$FB xx</pre>
* <tt>xx</tt> is a signed note offset to apply for all channels for the music.
Global transpsition is not applied to channel 4 for V0.0-2.1.

===Absolute Transposition (VCMD <tt>$FC</tt>)===
<pre>$FC xx</pre>
* <tt>xx</tt> is a signed note offset to apply for the channel.

===Song End (VCMD <tt>$FE</tt>)===
Terminates the song for all of the channels.

===Pattern End (VCMD <tt>$FF</tt>)===
Ends the pattern and goes to the pattern order list to fetch another pattern.

[[Category:SPC Sound Engines]]

Category:MIDI-Based SPC Sound Engines

2022-06-26T19:34:59Z

KungFuFurby: Adding Mindscape, courtesy of discovering a MIDI-based VCMD set for Mario's Early Years (though some extra lookup may need to be done, critically the key on/off commands and that familiar $FF $2F EOF command is there).

This contains a list of [[:Category:SPC Sound Engines|SPC Sound Engines]] whose internal VCMD format contains a match to [[MIDI]]'s own format (at least as far as being able to generally identify it). Except for Loriciel and Silicon Sorcery's SPC sound engines, the header generally does not match MIDI's own format.

The following SPC sound engine pages that satisfy this criteria have not been created yet:
* [[ACID]] (Realtime Associates)
* [[Advanced Real-time Dynamic Interplay]] ('''Not''' RPM Racing, Wolfenstein 3D or Super 3D Noah's Ark)
* [[Loriciel Engine]]
* [[Mindscape Engine]]
* [[Silicon Sorcery Engine]]
* [[Super Music Driver]] (Haüs Teknikka)

These SPC engines almost match, but the highest bit of a VCMD has a different meaning:
* [[Accolade Engine]] ''(uses the highest bit to indicate whether there is a delay or not)''
* [[Bits Studios Engine]] ''(allows VCMD ID duplication through not setting the highest bit)''

Further investigation is required for these cases...
* [[Alfa System Engine]] ''(contains an option via the track header to use compressed data instead, therefore the internal compression format must be recorded as well)''
* [[Eurocom Engine]] ''(the sound driver contains the ability to use backreferencing, somewhat akin to SNESGSS's, though I need to do some more analysis of this one, as this one has some more features... and nesting support)''

[[Category:SPC Sound Engines]]

N-SPC Engine

2022-06-16T15:31:21Z

KungFuFurby:

__TOC__

'''Nintendo SPC Sound Engine''', abbreviated N-SPC and officially known as Kankichi-kun [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun], is the most common sound engine used in all of the SNES/SFC games. Only the music portion was initially provided in the source code included in the IS-Sound unit along with some templating for a protocol for music and sound effects [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system]: usually it was modified by developers on an individual basis, resulting in many different variants, some of them more heavily modifying the sound driver than others. Usually what was added on was sound effect support, but sometimes the music VCMDs were modified as well.

The following games are purely based off of the source code provided with the IS-Sound unit, and are either unmodified or barely modified, if at all:
{| class="wikitable sortable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Hong Kong '97 || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0F800A</tt> (both versions)
|-
| SM Choukyoushi Hitomi - Bangai Hen || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 2 Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 2 || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x03801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 2 Remix || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 3 Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x018058</tt>
|-
| SM Choukyoushi Hitomi Vol. 3 (Alt 1) || <tt>0x0DF0</tt>, relative to <tt>0x0D30</tt> || <tt>0x018076</tt>
|-
| Wheel of Fortune - Deluxe Edition ''(unused)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01D842</tt>
|}
Of the games listed here, two of them are very minor edits...
* Wheel of Fortune - Deluxe Edition's build is unused and is missing an opcode near the *Ver S1.20* string. In addition, that section is actually unused, because instead new code at $0700 is used to substitute for this one... which happens to be an exact match to the original IPL Boot ROM.
* SM Choukyoushi Hitomi Vol. 3 (Alt 1)'s program starts with a JMP opcode, and contains a NOP between the first and second opcodes of the actual program.

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

==Communication with the SNES==
NOTE: This is not representative of every single variant. Instead, it represents the collection of commands from the source code included in the IS-Sound unit, which in turn may be carried over to most variants.

The only register that is used for communication in the source build is $2140 (SNES side)/$F4 (SPC side), except for the load command. Other registers are not even read from, though the code itself sets up the framework to do so.

===Output to the SNES===
<pre>xx ?? ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.

===Command IDs===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

===Stop Music (Command <tt>$00</tt>)===
Initializes an invalid phrase pointer, then stops the previous piece of music. This is not compatible with the resume command, as it is irrevocable, unlike the other one.

===Play Music (Command <tt>$01-??</tt>)===
Stops a previous piece of music, then plays a piece of music by the ID specified in the command.

===Pause Music (Command <tt>$F0</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$F1</tt>)===
Resumes a paused song.

===Load New Data (Command <tt>$FF</tt>)===
Jumps to a modified copy of the IPL Boot ROM (except for Wheel of Fortune - Deluxe Edition, where there is an opcode missing, the jump location is different, and it contains an exact copy of the IPL Boot ROM).

''TODO Loading New Data (the loading protocol is nearly identical to IPL Boot ROM, with a couple of differences)''

==Instrument Format==
The instrument format is most commonly defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this....
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>%x</tt> is a noise clock switch.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is a fractional pitch base multiplier, defined in 256ths.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>$80 $00</tt> || Fast Forward On ||
|-
|<tt>$81 $00</tt> || Fast Forward Off ||
|-
|<tt>%1??????? $00</tt> <tt>$82-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$00 $01-$7F</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Fast Forward On (Command <tt>$00 $80</tt>)===
<pre>$80 $00</pre>
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (Command <tt>$00 $81</tt>)===
<pre>$81 $00</pre>
Disables Fast Forward and continues playing the song normally.

===Always Jump (Command <tt>$00 $82-$FF</tt>)===
<pre>%1??????? $00 xx xx</pre>
Only executes if the fast forward commands are not triggered.
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
NOTE: This is not representative of every single variant. Instead, it represents the collection of VCMDs from the source code included in the IS-Sound unit, which in turn is carried over to most variants.

{{N-SPC VCMD Set Table}}

===Invalid (VCMD <tt>$FF</tt>)===
Crashes the sound driver due to being outside of the array of pointers, and thus jumping to an invalid pointer.

===NOP (VCMD <tt>$FB</tt>)===
<pre>$FB ??</pre>
Reads a single byte, then does absolutely nothing with the command.

===Phrase Termination/End of Subroutine (VCMD <tt>$00</tt>)===
This VCMD's operation depends on whether or not it is inside a subroutine or not.
If it is inside a subroutine, it exits the subroutine and song execution continues.
Otherwise, the phrase is terminated. This affects ''all'' channels in the music: any other channels still playing are interrupted.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (%0yyyzzzz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>%yyy</tt>, if the highest bit of the byte is not set, defines the quantization. It is an index value to a table of values that indicate, in 256ths, how far along the note to play before keying it off. This table can vary on a per-game basis.
* <tt>%zzzz</tt>, which is only defined if the highest bit of the byte is not set, defines the velocity. It is an index to a table of values that indicate the volume in a decibel-like number (due to the final volume calculation being multiplied by itself at the end). This table can vary on a per-game basis.

Notes and/or special VCMDs, by default, are forced after the parameter byte is read. Attempting to use <tt>$00-$7F</tt> again results in an invalid note.

===Note (VCMD <tt>$80-$C7</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Tie (VCMD <tt>$C8</tt>)===
Continues playing the previous note and delays the channel for one note length before reading another VCMD.

===Rest (VCMD <tt>$C9</tt>)===
Keys off the previous note and delays the channel for one note length before reading another VCMD.

===Percussion (VCMD <tt>$CA-$DF</tt>)===
Plays a percussion note.

By default, percussion uses the same instrument set as the song, and all percussion is keyed on with a note of <tt>$A4</tt>.
The starting ID to use for all channels can be redefined by VCMD <tt>$FA</tt>.

===Instrument (VCMD <tt>$E0</tt>)===
<pre>$E0 xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Panning (VCMD <tt>$E1</tt>)===
<pre>$E1 %xyzzzzz</pre>
* <tt>%x</tt> defines a phase inversion switch for the left channel.
* <tt>%y</tt> defines a phase inversion switch for the right channel.
* <tt>%zzzzz</tt> is five bits for the panning. This refers to an array of values to multiply the volume by after calculating the voice volume via various other parameters set by the VCMDs. Under normal circumstances, center is defined as <tt>$0A</tt> and the maximum value is <tt>$14</tt>.

===Panning Fade (VCMD <tt>$E2</tt>)===
<pre>$E2 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target pan value. Phase inversion is ''not'' taken into account here, thus only the low five bits should be used here.

===Vibrato On (VCMD <tt>$E3</tt>)===
<pre>$E3 xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the vibrato for.
* <tt>yy</tt> is the rate of the vibrato: specifically, how much to change the pitch on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the vibrato: that is, the maximum pitch offset to use. <tt>$00-$F0</tt> are normal, but <tt>$F1</tt> and up act more like said value ANDed by <tt>$0F</tt> and multiplied by <tt>$0100</tt>, meaning the highest values have drastic differences compared to the lower ones.

===Vibrato Off (VCMD <tt>$E4</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Song Volume (VCMD <tt>$E5</tt>)===
<pre>$E5 xx</pre>
* <tt>xx</tt> is the song volume value. This sets the volume for all of the channels in the song. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Song Volume Fade (VCMD <tt>$E6</tt>)===
<pre>$E6 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target song volume.

===Tempo (VCMD <tt>$E7</tt>)===
<pre>$E7 xx</pre>
* <tt>xx</tt> defines one tempo tick as one timer 0 tick multiplied by <math>\frac{256}{x}</math>. Zero freezes the song.

===Tempo Fade (VCMD <tt>$E8</tt>)===
<pre>$E8 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target tempo.

===Global Absolute Transposition (VCMD <tt>$E9</tt>)===
<pre>$E9 xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes. Note that this affects all channels, not just one channel.

===Single Channel Absolute Transposition (VCMD <tt>$EA</tt>)===
<pre>$EA xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes.

===Tremolo On (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the tremolo for.
* <tt>yy</tt> is the rate of the tremolo: specifically, how much to change the volume on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the tremolo: that is, the maximum volume offset to use.

===Tremolo Off (VCMD <tt>$EC</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Volume (VCMD <tt>$ED</tt>)===
<pre>$ED xx</pre>
* <tt>xx</tt> is the volume value. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Volume Fade (VCMD <tt>$EE</tt>)===
<pre>$EE xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target volume.

===Subroutine (VCMD <tt>$EF</tt>)===
<pre>$EF xx xx yy</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer containing the section of music to play.
* <tt>yy</tt> is the number of times to loop the sub-routine.

===Vibrato Fade In (VCMD <tt>$F0</tt>)===
<pre>$F0 xx</pre>
* <tt>xx</tt> is the number of tempo ticks to fade the vibrato for.
The moment this VCMD is executed, the depth is faded in from zero.

===Note Pitch Envelope To (VCMD <tt>$F1</tt>)===
<pre>$F1 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note to.

===Note Pitch Envelope From (VCMD <tt>$F2</tt>)===
<pre>$F2 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note from: that is, unlike Note Pitch Envelope To (VCMD <tt>$F1</tt>), this is a starting note offset, rather than an end of pitch envelope note offset.

===Note Pitch Envelope Off (VCMD <tt>$F3</tt>)===
Disables a pitch envelope.

===Fine Tune (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines the amount to shift the pitch up. This is in 256ths of a semitone, albeit done via measuring the distance between note and multiplying it by this value.

===Echo Enable Bits and Volume (VCMD <tt>$F5</tt>)===
<pre>$F5 %xxxxxxxx yy zz</pre>
* <tt>%xxxxxxxx</tt> defines the channels to turn on for the echo (one per bit), which translates to a direct write to the EON DSP register.
* <tt>yy</tt> defines a value for EVOLL DSP register.
* <tt>zz</tt> defines a value for EVOLR DSP register.

===Echo Off (VCMD <tt>$F6</tt>)===
This disables echo for ''all'' channels, as well as zeroing out the echo volume and disabling echo writes.

===Echo Parameter Setup (VCMD <tt>$F7</tt>)===
<pre>$F7 xx yy zz</pre>
* <tt>xx</tt> defines a value for the EDL DSP register.
* <tt>yy</tt> defines a value for the EFB DSP register.
* <tt>zz</tt> defines an ID to an array of FIR coefficient values.

===Echo Volume Fade (VCMD <tt>$F8</tt>)===
<pre>$F8 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> defines the target value for EVOLL DSP register.
* <tt>zz</tt> defines the target value for EVOLR DSP register.

===Pitch Slide To Note (VCMD <tt>$F9</tt>)===
<pre>$F9 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to delay the slide for.
* <tt>yy</tt> defines the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is the target note.

===Percussion Base Instrument ID Redefine (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is the starting instrument ID. Note that this affects all channels.

===Channel Mute (VCMD <tt>$FC</tt>)===
Causes the channel to not key on subsequent notes.

===Fast Forward On (VCMD <tt>$FD</tt>)===
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (VCMD <tt>$FE</tt>)===
Disables Fast Forward and continues playing the song normally.

==Variants==
===Shijou Saikyou no Quiz Ou Ketteisen Super===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Shijou Saikyou no Quiz Ou Ketteisen Super || <tt>0x0DF7</tt>, relative to <tt>0x0D37</tt> || <tt>0x038062</tt>/<tt>0x04805C</tt>/<tt>0x058062</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

This is the closest match to a standard source N-SPC/Kankichi build used in a licensed game. This is because the only modifications made to it are to echo what was sent to any register to $2141/$F5 (although in practice only $2140/$F4 is read from, thus de facto giving it the same output, otherwise it would be cycling between the last register read code-wise as output) and zero out both $2140/$F4 and $2141/$F5 when the song is done playing when a zero pointer is read from a phase.

====Output to the SNES====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.
* <tt>yy</tt> is a de-facto mirror of <tt>xx</tt> output-wise. The feedback is a little faster, though, since the output is immediately upon $2140/$F4 being read, rather than when the music is initialized.

===Controller Test/World Class Service Super Nintendo Tester===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Controller Test || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x009319</tt> (Controller Test Cassette) <tt>0x00BFFF</tt> (SNES Burn-In Test Cartridge) <tt>0x00D8D2</tt> (World Class Service Super Nintendo Tester ''(not used)'')
|-
| World Class Service Super Nintendo Tester ''(only build used across all tests)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0B8068</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

These two sound driver builds (the one for the controller test being found in three different known testing cartridges, with one of them not used) merely have code optimizations in their sound code, thus making them completely identical execution-wise to the source build variant. In addition, the build used for World Class Service Super Nintendo Tester adds a BMI opcode in a readahead routine, but is otherwise identical.

===Subpages===
{{Subpages}}

Not created yet...
* [[N-SPC Engine/64WD Creation|64WD Creation]]
* [[N-SPC Engine/Advance Communication|Advance Communication]]
* [[N-SPC Engine/Aisystem Tokyo|Aisystem Tokyo]]
* [[N-SPC Engine/Argonaut|Argonaut]]
* [[N-SPC Engine/Axes Art Amuse|Axes Art Amuse]]
* [[N-SPC Engine/Bit Managers|Bit Managers]]
* [[N-SPC Engine/Capcom|Capcom]]
* [[N-SPC Engine/Chatnoir|Chatnoir]]
* [[N-SPC Engine/Chip Level Designs|Chip Level Designs]]
* [[N-SPC Engine/CP.BRAiN|CP.BRAiN]]
* [[N-SPC Engine/Cream|Cream]]
* [[N-SPC Engine/Crosstalk|Crosstalk]]
* [[N-SPC Engine/Cube|Cube]]
* [[N-SPC Engine/CUE|CUE]]
* [[N-SPC Engine/Culture Brain|Culture Brain]]
* [[N-SPC Engine/Daft|Daft]]
* [[N-SPC Engine/Data East|Data East]]
* [[N-SPC Engine/EJ Corporation|EJ Corporation]]
* [[N-SPC Engine/Electronic Arts|Electronic Arts]]
* [[N-SPC Engine/Falcom|Falcom]]
* [[N-SPC Engine/Funcom|Funcom]]
* [[N-SPC Engine/Gremlin|Gremlin]]
* [[N-SPC Engine/HAL|HAL]]
* [[N-SPC Engine/Hanari Exp|Hanari Exp]]
* [[N-SPC Engine/Hect|Hect]]
* [[N-SPC Engine/Hikoshi Hashimoto|Hikoshi Hashimoto]]
* [[N-SPC Engine/Home Data|Home Data]]
* [[N-SPC Engine/Human (earlier)|Human (earlier)]]
* [[N-SPC Engine/Human|Human]]
* [[N-SPC Engine/Imagesoft|Imagesoft]]
* [[N-SPC Engine/Infogrames|Infogrames]]
* [[N-SPC Engine/Intelligent Systems|Intelligent Systems]]
* [[N-SPC Engine/Japan Art Media|Japan Art Media]]
* [[N-SPC Engine/Jorudan|Jorudan]]
* [[N-SPC Engine/Kazuo Sawa|Kazuo Sawa]]
* [[N-SPC Engine/Kennosuke Suemura|Kennosuke Suemura]]
* [[N-SPC Engine/Khaos|Khaos]]
* [[N-SPC Engine/Koei|Koei]]
* [[N-SPC Engine/Konami|Konami]]
* [[N-SPC Engine/LaserSoft|LaserSoft]]
* [[N-SPC Engine/Make Software|Make Software]]
* [[N-SPC Engine/Metro|Metro]]
* [[N-SPC Engine/Mitsuhito Tanaka|Mitsuhito Tanaka]]
* [[N-SPC Engine/Monolith|Monolith]]
* [[N-SPC Engine/MSQ|MSQ]]
* [[N-SPC Engine/Namco|Namco]]
* [[N-SPC Engine/Naohisa Morota|Naohisa Morota]]
* [[N-SPC Engine/Natsume|Natsume]]
* [[N-SPC Engine/Nichibutsu or Make Software|Nichibutsu/Make Software]] (NOTE: Refers to three of the Super Nichibutsu Mahjong games)
* [[N-SPC Engine/Nova|Nova]]
* [[N-SPC Engine/Ocean|Ocean]]
* [[N-SPC Engine/Pure Sound|Pure Sound]]
* [[N-SPC Engine/Quest|Quest]]
* [[N-SPC Engine/Quintet|Quintet]]
* [[N-SPC Engine/Robert C. Ashworth|Robert C. Ashworth]]
* [[N-SPC Engine/Sakata SAS|Sakata SAS]]
* [[N-SPC Engine/Saurus|Saurus]]
* [[N-SPC Engine/Sunsoft|Sunsoft]]
* [[N-SPC Engine/Syscom|Syscom]]
* [[N-SPC Engine/System Sacom|System Sacom]]
* [[N-SPC Engine/Systemsoft|Systemsoft]]
* [[N-SPC Engine/T's Music|T's Music]]
* [[N-SPC Engine/TamTam|TamTam]]
* [[N-SPC Engine/Team X-Fade|Team X-Fade]]
* [[N-SPC Engine/Technos Japan|Technos Japan]]
* [[N-SPC Engine/Technosoft|Technosoft]]
* [[N-SPC Engine/Tecmo|Tecmo]]
* [[N-SPC Engine/Tose|Tose]]
* [[N-SPC Engine/Tsukasa Masuko|Tsukasa Masuko]]
* [[N-SPC Engine/Virgin|Virgin]]
* [[N-SPC Engine/Wave|Wave]]
* [[N-SPC Engine/Yoshikazu Yao|Yoshikazu Yao]]
* [[N-SPC Engine/Yoshiyuki Ishii|Yoshiyuki Ishii]]

''TODO: There are a lot of variants... these will be split into sub-pages depending on the modifications made''

==References==
* [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun Video Game Music Preservation Foundation - Kankichi-kun]
* [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system Retro Reversing - SNES (Super Famicom) Development Kit Hardware - Intelligent Systems SHVC Development System]
* [https://wiki.superfamicom.org/nintendo-music-format-(n-spc) Super Famicom Wiki - N-SPC]
* [http://gdri.smspower.org/wiki/index.php/Super_Famicom/Super_NES_Sound_Driver_List GDRI - Super Famicom/Super NES Sound Driver List]
* [https://github.com/vgmtrans/vgmtrans/issues/173 Github - N-SPC VCMD $FB-$FE identifications]
* [https://archive.org/details/GameBoyProgManVer1.1/page/n187/mode/2up Game Boy Development Manual - Super Game Boy Sound] (see pages 187-213)

[[Category:SPC Sound Engines]]

N-SPC Engine

2022-06-10T01:14:08Z

KungFuFurby: Change Michelle Simon/Tommy Tallarico to Virgin, citing a sound driver credit for Matt From in Super Slap Shot's instruction manual.

__TOC__

'''Nintendo SPC Sound Engine''', abbreviated N-SPC and officially known as Kankichi-kun [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun], is the most common sound engine used in all of the SNES/SFC games. Only the music portion was initially provided in the source code included in the IS-Sound unit along with some templating for a protocol for music and sound effects [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system]: usually it was modified by developers on an individual basis, resulting in many different variants, some of them more heavily modifying the sound driver than others. Usually what was added on was sound effect support, but sometimes the music VCMDs were modified as well.

The following games are purely based off of the source code provided with the IS-Sound unit, and are either unmodified or barely modified, if at all:
{| class="wikitable sortable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Hong Kong '97 || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0F800A</tt> (both versions)
|-
| SM Choukyoushi Hitomi - Bangai Hen || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 2 Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 2 || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x03801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 2 Remix || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01801C</tt>
|-
| SM Choukyoushi Hitomi Vol. 3 Trial Version || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x018058</tt>
|-
| SM Choukyoushi Hitomi Vol. 3 (Alt 1) || <tt>0x0DF0</tt>, relative to <tt>0x0D30</tt> || <tt>0x018076</tt>
|-
| Wheel of Fortune - Deluxe Edition ''(unused)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x01D842</tt>
|}
Of the games listed here, two of them are very minor edits...
* Wheel of Fortune - Deluxe Edition's build is unused and is missing an opcode near the *Ver S1.20* string. In addition, that section is actually unused, because instead new code at $0700 is used to substitute for this one... which happens to be an exact match to the original IPL Boot ROM.
* SM Choukyoushi Hitomi Vol. 3 (Alt 1)'s program starts with a JMP opcode, and contains a NOP between the first and second opcodes of the actual program.

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

==Communication with the SNES==
NOTE: This is not representative of every single variant. Instead, it represents the collection of commands from the source code included in the IS-Sound unit, which in turn may be carried over to most variants.

The only register that is used for communication in the source build is $2140 (SNES side)/$F4 (SPC side), except for the load command. Other registers are not even read from, though the code itself sets up the framework to do so.

===Output to the SNES===
<pre>xx ?? ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.

===Command IDs===
{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Music || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Music || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Music || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Music || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

===Stop Music (Command <tt>$00</tt>)===
Initializes an invalid phrase pointer, then stops the previous piece of music. This is not compatible with the resume command, as it is irrevocable, unlike the other one.

===Play Music (Command <tt>$01-??</tt>)===
Stops a previous piece of music, then plays a piece of music by the ID specified in the command.

===Pause Music (Command <tt>$F0</tt>)===
Stops music, allowing it to be resumed later.

===Continue Music (Command <tt>$F1</tt>)===
Resumes a paused song.

===Load New Data (Command <tt>$FF</tt>)===
Jumps to a modified copy of the IPL Boot ROM (except for Wheel of Fortune - Deluxe Edition, where there is an opcode missing, the jump location is different, and it contains an exact copy of the IPL Boot ROM).

''TODO Loading New Data (the loading protocol is nearly identical to IPL Boot ROM, with a couple of differences)''

==Instrument Format==
The instrument format is most commonly defined as direct writes to DSP registers for the first four bytes, followed by two pitch-related bytes. They are defined like this....
<pre>%xyyyyyyy zz aa bb cc dd</pre>
* <tt>%x</tt> is a noise clock switch.
** If set, noise is used and <tt>%??yyyyy</tt> represents the noise clock rate.
** If cleared, <tt>%0yyyyyyy</tt> is a direct write to the VxSRCN DSP register.
* <tt>zz</tt> is a direct write to the VxADSR1 DSP register.
* <tt>aa</tt> is a direct write to the VxADSR2 DSP register.
* <tt>bb</tt> is a direct write to the VxGAIN DSP register.
* <tt>cc</tt> is a pitch base multiplier.
* <tt>dd</tt> is a fractional pitch base multiplier, defined in 256ths.

==Phrase Format==
Song entries, stored as [[little endian]] pointers, point to a list of phrases for the song to play.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Arguments
|-
|<tt>$00 $00</tt> || End of Song ||
|-
|<tt>%0xxxxxxx $00</tt> <tt>$01-$7F $00</tt>|| Jump x Times || <tt>yy yy</tt>
|-
|<tt>$80 $00</tt> || Fast Forward On ||
|-
|<tt>$81 $00</tt> || Fast Forward Off ||
|-
|<tt>%1??????? $00</tt> <tt>$82-$FF $00</tt> || Always Jump || <tt>xx xx</tt>
|-
|<tt>xx xx</tt> || Play Pattern || <tt>xx xx</tt>
|}

===Play Pattern===
<pre>xx xx</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a set of eight pointers to track data, one for each channel.

====Pattern Entry Format====
<pre>xx xx yy yy zz zz aa aa bb bb cc cc dd dd ee ee</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer to a pattern order list for channel 1. If the pointer is zero, there is no track data.
* <tt>yy yy</tt> is a [[little endian]] pointer to a pattern order list for channel 2. If the pointer is zero, there is no track data.
* <tt>zz zz</tt> is a [[little endian]] pointer to a pattern order list for channel 3. If the pointer is zero, there is no track data.
* <tt>aa aa</tt> is a [[little endian]] pointer to a pattern order list for channel 4. If the pointer is zero, there is no track data.
* <tt>bb bb</tt> is a [[little endian]] pointer to a pattern order list for channel 5. If the pointer is zero, there is no track data.
* <tt>cc cc</tt> is a [[little endian]] pointer to a pattern order list for channel 6. If the pointer is zero, there is no track data.
* <tt>dd dd</tt> is a [[little endian]] pointer to a pattern order list for channel 7. If the pointer is zero, there is no track data.
* <tt>ee ee</tt> is a [[little endian]] pointer to a pattern order list for channel 8. If the pointer is zero, there is no track data.

===End of Song (Command <tt>$00 $00</tt>)===
<pre>$00 $00</pre>
Terminates the song.

===Jump x Times (Command <tt>$00 $01-$7F</tt>)===
<pre>%0xxxxxxx $00 yy yy</pre>
* <tt>%xxxxxxx</tt> is the number of times to jump.
* <tt>yy yy</tt> is a [[little endian]] pointer to a phrase to jump to.

===Fast Forward On (Command <tt>$00 $80</tt>)===
<pre>$80 $00</pre>
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (Command <tt>$00 $81</tt>)===
<pre>$81 $00</pre>
Disables Fast Forward and continues playing the song normally.

===Always Jump (Command <tt>$00 $82-$FF</tt>)===
<pre>%1??????? $00 xx xx</pre>
Only executes if the fast forward commands are not triggered.
* <tt>xx xx</tt> is a [[little endian]] pointer to a phrase to jump to.

==Voice Command Format==
NOTE: This is not representative of every single variant. Instead, it represents the collection of VCMDs from the source code included in the IS-Sound unit, which in turn is carried over to most variants.

{{N-SPC VCMD Set Table}}

===Invalid (VCMD <tt>$FF</tt>)===
Crashes the sound driver due to being outside of the array of pointers, and thus jumping to an invalid pointer.

===NOP (VCMD <tt>$FB</tt>)===
<pre>$FB ??</pre>
Reads a single byte, then does absolutely nothing with the command.

===Phrase Termination/End of Subroutine (VCMD <tt>$00</tt>)===
This VCMD's operation depends on whether or not it is inside a subroutine or not.
If it is inside a subroutine, it exits the subroutine and song execution continues.
Otherwise, the phrase is terminated. This affects ''all'' channels in the music: any other channels still playing are interrupted.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (%0yyyzzzz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>%yyy</tt>, if the highest bit of the byte is not set, defines the quantization. It is an index value to a table of values that indicate, in 256ths, how far along the note to play before keying it off. This table can vary on a per-game basis.
* <tt>%zzzz</tt>, which is only defined if the highest bit of the byte is not set, defines the velocity. It is an index to a table of values that indicate the volume in a decibel-like number (due to the final volume calculation being multiplied by itself at the end). This table can vary on a per-game basis.

Notes and/or special VCMDs, by default, are forced after the parameter byte is read. Attempting to use <tt>$00-$7F</tt> again results in an invalid note.

===Note (VCMD <tt>$80-$C7</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Tie (VCMD <tt>$C8</tt>)===
Continues playing the previous note and delays the channel for one note length before reading another VCMD.

===Rest (VCMD <tt>$C9</tt>)===
Keys off the previous note and delays the channel for one note length before reading another VCMD.

===Percussion (VCMD <tt>$CA-$DF</tt>)===
Plays a percussion note.

By default, percussion uses the same instrument set as the song, and all percussion is keyed on with a note of <tt>$A4</tt>.
The starting ID to use for all channels can be redefined by VCMD <tt>$FA</tt>.

===Instrument (VCMD <tt>$E0</tt>)===
<pre>$E0 xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See Instrument Format above for the format.

===Panning (VCMD <tt>$E1</tt>)===
<pre>$E1 %xyzzzzz</pre>
* <tt>%x</tt> defines a phase inversion switch for the left channel.
* <tt>%y</tt> defines a phase inversion switch for the right channel.
* <tt>%zzzzz</tt> is five bits for the panning. This refers to an array of values to multiply the volume by after calculating the voice volume via various other parameters set by the VCMDs. Under normal circumstances, center is defined as <tt>$0A</tt> and the maximum value is <tt>$14</tt>.

===Panning Fade (VCMD <tt>$E2</tt>)===
<pre>$E2 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target pan value. Phase inversion is ''not'' taken into account here, thus only the low five bits should be used here.

===Vibrato On (VCMD <tt>$E3</tt>)===
<pre>$E3 xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the vibrato for.
* <tt>yy</tt> is the rate of the vibrato: specifically, how much to change the pitch on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the vibrato: that is, the maximum pitch offset to use. <tt>$00-$F0</tt> are normal, but <tt>$F1</tt> and up act more like said value ANDed by <tt>$0F</tt> and multiplied by <tt>$0100</tt>, meaning the highest values have drastic differences compared to the lower ones.

===Vibrato Off (VCMD <tt>$E4</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Song Volume (VCMD <tt>$E5</tt>)===
<pre>$E5 xx</pre>
* <tt>xx</tt> is the song volume value. This sets the volume for all of the channels in the song. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Song Volume Fade (VCMD <tt>$E6</tt>)===
<pre>$E6 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target song volume.

===Tempo (VCMD <tt>$E7</tt>)===
<pre>$E7 xx</pre>
* <tt>xx</tt> defines one tempo tick as one timer 0 tick multiplied by <math>\frac{256}{x}</math>. Zero freezes the song.

===Tempo Fade (VCMD <tt>$E8</tt>)===
<pre>$E8 xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target tempo.

===Global Absolute Transposition (VCMD <tt>$E9</tt>)===
<pre>$E9 xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes. Note that this affects all channels, not just one channel.

===Single Channel Absolute Transposition (VCMD <tt>$EA</tt>)===
<pre>$EA xx</pre>
* <tt>xx</tt> is a signed value defining the number of semitones to transpose subsequent notes.

===Tremolo On (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of tempo ticks to delay the tremolo for.
* <tt>yy</tt> is the rate of the tremolo: specifically, how much to change the volume on a per-tempo tick basis.
* <tt>zz</tt> is the depth of the tremolo: that is, the maximum volume offset to use.

===Tremolo Off (VCMD <tt>$EC</tt>)===
Disables vibrato set by VCMD <tt>$E3</tt>.

===Volume (VCMD <tt>$ED</tt>)===
<pre>$ED xx</pre>
* <tt>xx</tt> is the volume value. The value used is a decibel-like value due to the final volume being multiplied by itself to get the final result.

===Volume Fade (VCMD <tt>$EE</tt>)===
<pre>$EE xx yy</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> is the target volume.

===Subroutine (VCMD <tt>$EF</tt>)===
<pre>$EF xx xx yy</pre>
* <tt>xx xx</tt> is a [[little endian]] pointer containing the section of music to play.
* <tt>yy</tt> is the number of times to loop the sub-routine.

===Vibrato Fade In (VCMD <tt>$F0</tt>)===
<pre>$F0 xx</pre>
* <tt>xx</tt> is the number of tempo ticks to fade the vibrato for.
The moment this VCMD is executed, the depth is faded in from zero.

===Note Pitch Envelope To (VCMD <tt>$F1</tt>)===
<pre>$F1 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note to.

===Note Pitch Envelope From (VCMD <tt>$F2</tt>)===
<pre>$F2 xx yy zz</pre>
This VCMD is applied to all subsequent notes until turned off or overwritten.
* <tt>xx</tt> is the number of tempo ticks to delay before applying the pitch envelope.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is a signed offset in semitones to slide the note from: that is, unlike Note Pitch Envelope To (VCMD <tt>$F1</tt>), this is a starting note offset, rather than an end of pitch envelope note offset.

===Note Pitch Envelope Off (VCMD <tt>$F3</tt>)===
Disables a pitch envelope.

===Fine Tune (VCMD <tt>$F4</tt>)===
<pre>$F4 xx</pre>
* <tt>xx</tt> defines the amount to shift the pitch up. This is in 256ths of a semitone, albeit done via measuring the distance between note and multiplying it by this value.

===Echo Enable Bits and Volume (VCMD <tt>$F5</tt>)===
<pre>$F5 %xxxxxxxx yy zz</pre>
* <tt>%xxxxxxxx</tt> defines the channels to turn on for the echo (one per bit), which translates to a direct write to the EON DSP register.
* <tt>yy</tt> defines a value for EVOLL DSP register.
* <tt>zz</tt> defines a value for EVOLR DSP register.

===Echo Off (VCMD <tt>$F6</tt>)===
This disables echo for ''all'' channels, as well as zeroing out the echo volume and disabling echo writes.

===Echo Parameter Setup (VCMD <tt>$F7</tt>)===
<pre>$F7 xx yy zz</pre>
* <tt>xx</tt> defines a value for the EDL DSP register.
* <tt>yy</tt> defines a value for the EFB DSP register.
* <tt>zz</tt> defines an ID to an array of FIR coefficient values.

===Echo Volume Fade (VCMD <tt>$F8</tt>)===
<pre>$F8 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to fade for.
* <tt>yy</tt> defines the target value for EVOLL DSP register.
* <tt>zz</tt> defines the target value for EVOLR DSP register.

===Pitch Slide To Note (VCMD <tt>$F9</tt>)===
<pre>$F9 xx yy zz</pre>
* <tt>xx</tt> defines the number of tempo ticks to delay the slide for.
* <tt>yy</tt> defines the length of the pitch slide in tempo ticks.
* <tt>zz</tt> is the target note.

===Percussion Base Instrument ID Redefine (VCMD <tt>$FA</tt>)===
<pre>$FA xx</pre>
* <tt>xx</tt> is the starting instrument ID. Note that this affects all channels.

===Channel Mute (VCMD <tt>$FC</tt>)===
Causes the channel to not key on subsequent notes.

===Fast Forward On (VCMD <tt>$FD</tt>)===
Fast Forward causes the song to stop playing and the player rapidly progresses throughout the song. Thus, this can effectively act as a skip.

===Fast Forward Off (VCMD <tt>$FE</tt>)===
Disables Fast Forward and continues playing the song normally.

==Variants==
===Shijou Saikyou no Quiz Ou Ketteisen Super===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Shijou Saikyou no Quiz Ou Ketteisen Super || <tt>0x0DF7</tt>, relative to <tt>0x0D37</tt> || <tt>0x038062</tt>/<tt>0x04805C</tt>/<tt>0x058062</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

This is the closest match to a standard source N-SPC/Kankichi build used in a licensed game. This is because the only modifications made to it are to echo what was sent to any register to $2141/$F5 (although in practice only $2140/$F4 is read from, thus de facto giving it the same output, otherwise it would be cycling between the last register read code-wise as output) and zero out both $2140/$F4 and $2141/$F5 when the song is done playing when a zero pointer is read from a phase.

====Output to the SNES====
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is the currently piece of music playing. It takes a couple of tempo ticks for this to echo back after initializing the music.
* <tt>yy</tt> is a de-facto mirror of <tt>xx</tt> output-wise. The feedback is a little faster, though, since the output is immediately upon $2140/$F4 being read, rather than when the music is initialized.

===Controller Test/World Class Service Super Nintendo Tester===
{| class="wikitable"
|-
! Game Name !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Controller Test || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x009319</tt> (Controller Test Cassette) <tt>0x00BFFF</tt> (SNES Burn-In Test Cartridge) <tt>0x00D8D2</tt> (World Class Service Super Nintendo Tester ''(not used)'')
|-
| World Class Service Super Nintendo Tester ''(only build used across all tests)'' || <tt>0x0DEC</tt>, relative to <tt>0x0D2C</tt> || <tt>0x0B8068</tt>
|}

The raw build sorting notes can be found [[N-SPC Engine/Source Variant Build Sorting|here]] (along with all of the other source variant builds that don't have a significant enough difference execution-wise).

These two sound driver builds (the one for the controller test being found in three different known testing cartridges, with one of them not used) merely have code optimizations in their sound code, thus making them completely identical execution-wise to the source build variant. In addition, the build used for World Class Service Super Nintendo Tester adds a BMI opcode in a readahead routine, but is otherwise identical.

===Subpages===
{{Subpages}}

Not created yet...
* [[N-SPC Engine/64WD Creation|64WD Creation]]
* [[N-SPC Engine/Advance Communication|Advance Communication]]
* [[N-SPC Engine/Aisystem Tokyo|Aisystem Tokyo]]
* [[N-SPC Engine/Argonaut|Argonaut]]
* [[N-SPC Engine/Axes Art Amuse|Axes Art Amuse]]
* [[N-SPC Engine/Bit Managers|Bit Managers]]
* [[N-SPC Engine/Capcom|Capcom]]
* [[N-SPC Engine/Chatnoir|Chatnoir]]
* [[N-SPC Engine/Chip Level Designs|Chip Level Designs]]
* [[N-SPC Engine/CP.BRAiN|CP.BRAiN]]
* [[N-SPC Engine/Cream|Cream]]
* [[N-SPC Engine/Crosstalk|Crosstalk]]
* [[N-SPC Engine/Cube|Cube]]
* [[N-SPC Engine/CUE|CUE]]
* [[N-SPC Engine/Culture Brain|Culture Brain]]
* [[N-SPC Engine/Daft|Daft]]
* [[N-SPC Engine/Data East|Data East]]
* [[N-SPC Engine/EJ Corporation|EJ Corporation]]
* [[N-SPC Engine/Electronic Arts|Electronic Arts]]
* [[N-SPC Engine/Falcom|Falcom]]
* [[N-SPC Engine/Funcom|Funcom]]
* [[N-SPC Engine/Gremlin|Gremlin]]
* [[N-SPC Engine/HAL|HAL]]
* [[N-SPC Engine/Hanari Exp|Hanari Exp]]
* [[N-SPC Engine/Hect|Hect]]
* [[N-SPC Engine/Hikoshi Hashimoto|Hikoshi Hashimoto]]
* [[N-SPC Engine/Home Data|Home Data]]
* [[N-SPC Engine/Human (earlier)|Human (earlier)]]
* [[N-SPC Engine/Human|Human]]
* [[N-SPC Engine/Imagesoft|Imagesoft]]
* [[N-SPC Engine/Infogrames|Infogrames]]
* [[N-SPC Engine/Intelligent Systems|Intelligent Systems]]
* [[N-SPC Engine/Japan Art Media|Japan Art Media]]
* [[N-SPC Engine/Jorudan|Jorudan]]
* [[N-SPC Engine/Kazuo Sawa|Kazuo Sawa]]
* [[N-SPC Engine/Kennosuke Suemura|Kennosuke Suemura]]
* [[N-SPC Engine/Khaos|Khaos]]
* [[N-SPC Engine/Koei|Koei]]
* [[N-SPC Engine/Konami|Konami]]
* [[N-SPC Engine/LaserSoft|LaserSoft]]
* [[N-SPC Engine/Make Software|Make Software]]
* [[N-SPC Engine/Metro|Metro]]
* [[N-SPC Engine/Mitsuhiko Tanaka|Mitsuhiko Tanaka]]
* [[N-SPC Engine/Monolith|Monolith]]
* [[N-SPC Engine/MSQ|MSQ]]
* [[N-SPC Engine/Namco|Namco]]
* [[N-SPC Engine/Naohisa Morota|Naohisa Morota]]
* [[N-SPC Engine/Natsume|Natsume]]
* [[N-SPC Engine/Nichibutsu or Make Software|Nichibutsu/Make Software]] (NOTE: Refers to three of the Super Nichibutsu Mahjong games)
* [[N-SPC Engine/Nova|Nova]]
* [[N-SPC Engine/Ocean|Ocean]]
* [[N-SPC Engine/Pure Sound|Pure Sound]]
* [[N-SPC Engine/Quest|Quest]]
* [[N-SPC Engine/Quintet|Quintet]]
* [[N-SPC Engine/Robert C. Ashworth|Robert C. Ashworth]]
* [[N-SPC Engine/Sakata SAS|Sakata SAS]]
* [[N-SPC Engine/Saurus|Saurus]]
* [[N-SPC Engine/Sunsoft|Sunsoft]]
* [[N-SPC Engine/Syscom|Syscom]]
* [[N-SPC Engine/System Sacom|System Sacom]]
* [[N-SPC Engine/Systemsoft|Systemsoft]]
* [[N-SPC Engine/T's Music|T's Music]]
* [[N-SPC Engine/TamTam|TamTam]]
* [[N-SPC Engine/Team X-Fade|Team X-Fade]]
* [[N-SPC Engine/Technos Japan|Technos Japan]]
* [[N-SPC Engine/Technosoft|Technosoft]]
* [[N-SPC Engine/Tecmo|Tecmo]]
* [[N-SPC Engine/Tose|Tose]]
* [[N-SPC Engine/Tsukasa Masuko|Tsukasa Masuko]]
* [[N-SPC Engine/Virgin|Virgin]]
* [[N-SPC Engine/Wave|Wave]]
* [[N-SPC Engine/Yoshikazu Yao|Yoshikazu Yao]]
* [[N-SPC Engine/Yoshiyuki Ishii|Yoshiyuki Ishii]]

''TODO: There are a lot of variants... these will be split into sub-pages depending on the modifications made''

==References==
* [http://vgmpf.com/Wiki/index.php?title=Kankichi-kun Video Game Music Preservation Foundation - Kankichi-kun]
* [https://www.retroreversing.com/super-famicom-snes-development-kit/#intelligent-systems-shvc-development-system Retro Reversing - SNES (Super Famicom) Development Kit Hardware - Intelligent Systems SHVC Development System]
* [https://wiki.superfamicom.org/nintendo-music-format-(n-spc) Super Famicom Wiki - N-SPC]
* [http://gdri.smspower.org/wiki/index.php/Super_Famicom/Super_NES_Sound_Driver_List GDRI - Super Famicom/Super NES Sound Driver List]
* [https://github.com/vgmtrans/vgmtrans/issues/173 Github - N-SPC VCMD $FB-$FE identifications]
* [https://archive.org/details/GameBoyProgManVer1.1/page/n187/mode/2up Game Boy Development Manual - Super Game Boy Sound] (see pages 187-213)

[[Category:SPC Sound Engines]]

SPC700/IPL ROM

2022-06-06T16:25:04Z

KungFuFurby: /* Step 1 (SPC700 Initializes Itself) */

__TOC__

The '''Initial Program Loader Boot ROM''', or IPL ROM, is the very first program executed by the [[SPC700]] on power on. It clears memory locations $00-$EF, then once it does so, it sends a signal to the SNES through two of the CPUIO registers. $0000-$0001 are reserved to hold the pointer, but all other memory locations can be written to. The IPL ROM itself is read-only: if written to, it simply writes to the same memory location that can be accessed when bit 7 of the CONTROL I/O port ($F1) is cleared.

==Communication with the SNES==
===Step 1 (SPC700 Initializes Itself)===
Output
<pre>$AA $BB ?? ??</pre>
The very first step is for the SPC700 to output two values to $2140/$F4 and $2141/$F5. The SNES must ensure that the SPC700 has finished initializing itself (and clearing out memory locations $0000-$00EF) by confirming these two values are present in those two registers: only then may the SNES send commands.

===Step 2 (Execute Command)===
Input
<pre>$CC xx yy yy</pre>
* <tt>xx</tt> indicates what you want to do. If this is zero, then the program jumps to <tt>yy yy</tt>. Otherwise, <tt>yy yy</tt> is the starting memory location of the next block, and we go to step 3.
* <tt>yy yy</tt> is a [[little endian]] pointer. See <tt>xx</tt> for more details.
$CC should be sent last in this case.

Output
<pre>$CC $BB ?? ??</pre>

===Step 3 (Send Block)===
Input
<pre>xx yy ?? ??</pre>
* <tt>xx</tt> is a byte counter, and this should be sent last on byte ordering. Zero must be sent first to indicate that this is the first block. If this is greater (from a signed comparison, thus no greater than $80 more than the expected value: otherwise, the command won't work) than the value that was last sent to the SNES, than we go to step 4.
* <tt>yy</tt> is the input byte to send. The pointer is incremented.

Output
<pre>xx $BB ?? ??</pre>
* <tt>xx</tt> is the next byte ID to send over. This is incremented per byte sent.

This step repeats until <tt>xx</tt> is sent a value that is greater than the initially expected value, then we go to step 4.

===Step 4 (Terminate Block)===
Input
<pre>xx yy zz zz</pre>
* <tt>xx</tt> must be greater (from a signed comparison, thus no greater than $80 more than the expected value: otherwise, the command won't work) than the last value that the SPC700 sent to the SNES. This byte should be sent last order-wise. Note that if this is zero (only occurs if the counter was previously $80-$FF), you'll instantly send a byte if <tt>yy</tt> is non-zero and start your next block right away (the zero case still jumps as per the usual).
* <tt>yy</tt> indicates what to do next. If this is zero, then the program jumps to <tt>zz zz</tt>. Otherwise, <tt>zz zz</tt> is the starting memory location of the next block, and we go to step 3.
* <tt>zz zz</tt> is a [[little endian]] pointer. See <tt>yy</tt> for more details.

Output
<pre>xx $BB ?? ??</pre>
* <tt>xx</tt> is the ID that was sent to terminate the block.

'''Note if you choose to jump to the program, then depending on the program, your acknowledgement from the IPL Boot ROM may end up being very short. Thus, unless your program accounts for this, make sure to disable your interrupts prior to performing this critical step.'''

==References==
* [https://problemkaputt.de/fullsnes.htm#snesapumaincpucommunicationport Fullsnes - Boot ROM Disassembly]
* [https://wiki.superfamicom.org/spc700-reference#ipl-rom-1567 Super Famicom Wiki - IPL ROM]

N-SPC Engine/Nintendo/Build Sorting

2022-06-01T05:06:35Z

KungFuFurby: Adding Gigaleak-era F-Zero build

__TOC__

==Unique cases==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Aging Cassette SNES Burn-In Test Cartridge|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$113A</tt>||For distinguishing purposes, known outside of these notes as Sound Module and Burn-In Test to refer to the copy found in the SNES Burn-In Test Cartridge.
|-
|Nintendo Power Menu Program || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|}

==F-Zero Builds==
This game has multiple revisional builds known.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|F-Zero || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1776</tt>||
|-
|F-Zero (Beta)|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> & <tt>A2 ?? 3F ?? ??</tt> || <tt>$0E3D</tt> & <tt>$1778</tt>||
|}

==Tetris & Dr. Mario Builds==
These builds are unique to one game, but unlike Super Scope 6 (which you may have noticed that LazerBlazer and Blastris are separated due to different SFX execution), they also match in general execution.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Tetris and Dr. Mario (Mixed Match) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$118F</tt>||
|-
|Tetris and Dr. Mario (Dr. Mario) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$1199</tt>||
|-
|Tetris and Dr. Mario (Tetris) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$11A1</tt>||
|}

==Akito Nakatsuka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Scope 6 (LazerBlazer) (US version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B33</tt>||
|-
|Super Scope 6 (LazerBlazer) (Japanese and European version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B37</tt>||
|-
|Super Game Boy Super Game Boy 2 || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0A5D</tt>||
|-
|BS-X BIOS Cassette Kensaki - NUS-you S Cassette || <tt>$0370</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$04AB</tt>||
|-
|JRA PAT JRA PAT - Wide Taiouban || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$0739</tt>||
|-
|Sutte Hakkun || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$074C</tt>||
|}

===Yuichi Ozaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Marvelous - Mouhitotsu no Takara-jima || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0BC5</tt>||
|-
|SA-1 Demo || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B23</tt>||
|-
|Heisei Shin Onigashima - Kouhen Heisei Shin Onigashima - Zenpen || <tt>$0400</tt> || <tt>D0 F3 8F ?? ?? BC 3F ?? ??</tt> || <tt>$0C8D</tt>||
|}

==Hirokazu Tanaka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Mario Paint (Beta) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? C4 ?? 3F ?? ??</tt> || <tt>$2625</tt>||
|-
|Mario Paint || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$1430</tt>||
|-
|Mother 2/Earthbound || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16A5</tt>||
|-
|Snoopy Concert || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16EB</tt>||
|}

==Kenji Yamamoto==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Metroid || <tt>$1500</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1ED7</tt>||
|}

==Koji Kondo==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0A96</tt>||
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island (beta version) || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B08</tt>||
|-
|Star Fox/Star Wing || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B14</tt>||
|-
|Super Mario All-Stars/Super Mario Collection || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0C11</tt>||
|-
|Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E22</tt>||
|-
|Star Glider || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E97</tt>|| Prototype of Star Fox/Star Wing.
|-
|SimCity || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$175D</tt>||
|-
|Super Donkey 1 || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$1DC9</tt>|| Sound driver build is a prototype of Legend of Zelda - A Link to the Past's.
|}

===Prototype===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario World (all other versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BC0</tt> ||
|-
|Super Mario World (Super Mario All-Stars + Super Mario World) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BF4</tt> ||
|-
|Pilotwings (European version) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$126A</tt> ||
|-
|Pilotwings (US & Japanese versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$12CD</tt> ||
|}

===Yoji Inagaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Star Fox 2 (1994-04-01) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>||
|-
|Star Fox 2 (1994-04-15) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>|| Except for a single opcode's difference at $064C, all of the code differences are after the SFX data, and thus pointers cannot be fully factored in.
|-
|Star Fox 2 (1994-05-06 and 1994-05-13) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B62</tt>||
|-
|Star Fox 2 (1994-08-31) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6D</tt>||
|-
|Star Fox 2 (1994-12-28) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B9C</tt>||
|-
|Star Fox 2 (1995-06-08) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD4</tt>||
|-
|Star Fox 2 (1995-06-22) Star Fox 2 (1995-06-27) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD7</tt>|| These builds are identical to each other minus pointers placed after the SFX data.
|-
|Star Fox 2 (1995-07-25) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BDA</tt>||
|-
|Star Fox 2 || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0BDF</tt>||
|}

==Taro Bando==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario Kart (beta version) (1992-01-21 build) || <tt>$0800</tt> || <tt>2F ?? BC 3F ?? ??</tt> || <tt>$0E3D</tt> || Refers to a sound.bin file with this timestamp that was not embedded in a known prototype build.
|-
|Super Mario Kart (beta version) (mkart) || <tt>$0800</tt> || <tt>E8 ?? BC 3F ?? ??</tt> || <tt>$0D79</tt>|| Refers to a prototype from April 13, 1992.
|-
|Super Mario Kart (beta version) (mario_kart-01) || <tt>$0800</tt> || <tt>C5 ?? ?? E8 ?? 3F ?? ??</tt> || <tt>$0D65</tt> || Refers to what is known as the Enigma prototype build.
|-
|Super Mario Kart (beta version) (mario_kart) || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$0D74</tt> || Refers to a prototype from late June 1992, created before kar4t.
|-
|Super Mario Kart (beta version) (kar4t) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1598</tt> || Refers to a prototype from late June 1992, created after mario_kart.
|-
|Super Mario Kart (US version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19B4</tt>||
|-
|Super Mario Kart (Japanese and European version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19BA</tt>||
|-
|FX Trax || <tt>$0800</tt> || <tt>D0 F7 E8 ?? 3F ?? ??</tt> || <tt>$0D61</tt>|| Prototype of Wild Trax/Stunt Race FX.
|-
|Wild Trax/Stunt Race FX || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D73</tt>|| Loading program at $0675 before the actual start location
|}

==Unknown==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|SNES Burn-In Test Cartridge || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0D6D</tt>||For distinguishing purposes, known outside of these notes as Super Scope Test.
|-
|Super Scope 6 (Blastris) || <tt>$0800</tt> || <tt>90 F8 BC 3F ?? ??</tt> || <tt>$0D89</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

AddMusicK

2022-04-08T17:00:51Z

KungFuFurby: Clarification on how AddmusicK came to be after digging out that Discord message from the SMWCentral server that clarified its origins somewhat...

[[AddMusicK]] is an open-source tool that modifies the music in [[Super Mario World]]. AddMusicK is an extension of the [[AddMusic]] family and was developed by [https://www.smwcentral.net/?p=profile&id=9822 Kipernal].

[[An SMW Central Production#Sequel | SMW Central Production 2 Project]]'s development initially inspired the creation of [[AddMusicK]] in order to combine the pros of [[AddmusicM]] and [[Addmusic405]] into one package after a debate over which Addmusic should be used for the project.

== Notable Features ==
* The usage is user-friendly.
* Backwards compatible with AddMusic 4.05 and AddMusicM ports by adding special headers to old MML files.
* Porters can define their custom N-SPC instruments in an official way, plus 16-bit tuning value support like the standard version of N-SPC.

== Issues ==
* The song can encounter [https://smwc.me/1501654 noticeable slowdown] easily if too many N-SPC effect used at once. '''This issue is fixed since 1.0.6.'''
* The game will experience a long period of lag while loading a non-global song.
* When pressing a P-Switch while one is already active, the P-Switch music will not restart from the beginning. This is because AMK's development was short and Kipernal worked mostly to fix bugs and incompatibilities, so this vanilla feature was left out. KevinM made a fix that works with modern versions of AMK, including 1.0.8: https://bin.smwcentral.net/u/25222/patch.asm
Alternatively, if necessary for some reason, [https://mega.nz/file/oJMXRQoY#K-bEF7jC0KAmMRbTTh1y4Wjh5gjMPaYxIonpZfP8R5M a custom version of AddMusicK 1.0.5 was created by another individual to solve this problem.]
* The jump sound is slightly inaccurate to the original. This is because the original sound has no note data (according to LadiesMan217) so Kipernal couldn't directly rip it during AMK's development and thus he had to recreate it. This is rather unknown by the majority of hackers as the inaccuracy is not that noticeable unless heard very carefully. A fix was made by KungFuFurby below. The contents of '35 Jump.txt' and '2B Jump.txt' in the '1DFC' and '1DF9' folders respectively should be replaced with the fix:

<pre>$DA $08
$05 $38
$DD $B2 $00 $05 $B5
$2A
$EB $00 $12 $B9</pre>
* (TBD)

== AddMusicK 1.1 ==
[https://smwc.me/1419112 AddMusicK 1.1] is an unofficial improved version of the original AddMusicK by [https://www.smwcentral.net/?p=profile&id=30594 Codec], with more new features and bug fixes. However, there is no information regarding whenever it will be officially released.

[[Category:AddMusic]]

N-SPC Engine/Nintendo/Build Sorting

2022-03-10T15:03:11Z

KungFuFurby: Adding beta version of Mario Paint

__TOC__

==Unique cases==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|F-Zero || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0E3D</tt>||
|-
|Aging Cassette SNES Burn-In Test Cartridge|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$113A</tt>||For distinguishing purposes, known outside of these notes as Sound Module and Burn-In Test to refer to the copy found in the SNES Burn-In Test Cartridge.
|-
|Nintendo Power Menu Program || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|}

==Tetris & Dr. Mario Builds==
These builds are unique to one game, but unlike Super Scope 6 (which you may have noticed that LazerBlazer and Blastris are separated due to different SFX execution), they also match in general execution.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Tetris and Dr. Mario (Mixed Match) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$118F</tt>||
|-
|Tetris and Dr. Mario (Dr. Mario) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$1199</tt>||
|-
|Tetris and Dr. Mario (Tetris) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$11A1</tt>||
|}

==Akito Nakatsuka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Scope 6 (LazerBlazer) (US version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B33</tt>||
|-
|Super Scope 6 (LazerBlazer) (Japanese and European version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B37</tt>||
|-
|Super Game Boy Super Game Boy 2 || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0A5D</tt>||
|-
|BS-X BIOS Cassette Kensaki - NUS-you S Cassette || <tt>$0370</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$04AB</tt>||
|-
|JRA PAT JRA PAT - Wide Taiouban || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$0739</tt>||
|-
|Sutte Hakkun || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$074C</tt>||
|}

===Yuichi Ozaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Marvelous - Mouhitotsu no Takara-jima || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0BC5</tt>||
|-
|SA-1 Demo || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B23</tt>||
|-
|Heisei Shin Onigashima - Kouhen Heisei Shin Onigashima - Zenpen || <tt>$0400</tt> || <tt>D0 F3 8F ?? ?? BC 3F ?? ??</tt> || <tt>$0C8D</tt>||
|}

==Hirokazu Tanaka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Mario Paint (Beta) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? C4 ?? 3F ?? ??</tt> || <tt>$2625</tt>||
|-
|Mario Paint || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$1430</tt>||
|-
|Mother 2/Earthbound || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16A5</tt>||
|-
|Snoopy Concert || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16EB</tt>||
|}

==Kenji Yamamoto==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Metroid || <tt>$1500</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1ED7</tt>||
|}

==Koji Kondo==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0A96</tt>||
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island (beta version) || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B08</tt>||
|-
|Star Fox/Star Wing || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B14</tt>||
|-
|Super Mario All-Stars/Super Mario Collection || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0C11</tt>||
|-
|Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E22</tt>||
|-
|Star Glider || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E97</tt>|| Prototype of Star Fox/Star Wing.
|-
|SimCity || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$175D</tt>||
|-
|Super Donkey 1 || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$1DC9</tt>|| Sound driver build is a prototype of Legend of Zelda - A Link to the Past's.
|}

===Prototype===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario World (all other versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BC0</tt> ||
|-
|Super Mario World (Super Mario All-Stars + Super Mario World) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BF4</tt> ||
|-
|Pilotwings (European version) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$126A</tt> ||
|-
|Pilotwings (US & Japanese versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$12CD</tt> ||
|}

===Yoji Inagaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Star Fox 2 (1994-04-01) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>||
|-
|Star Fox 2 (1994-04-15) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>|| Except for a single opcode's difference at $064C, all of the code differences are after the SFX data, and thus pointers cannot be fully factored in.
|-
|Star Fox 2 (1994-05-06 and 1994-05-13) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B62</tt>||
|-
|Star Fox 2 (1994-08-31) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6D</tt>||
|-
|Star Fox 2 (1994-12-28) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B9C</tt>||
|-
|Star Fox 2 (1995-06-08) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD4</tt>||
|-
|Star Fox 2 (1995-06-22) Star Fox 2 (1995-06-27) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD7</tt>|| These builds are identical to each other minus pointers placed after the SFX data.
|-
|Star Fox 2 (1995-07-25) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BDA</tt>||
|-
|Star Fox 2 || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0BDF</tt>||
|}

==Taro Bando==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario Kart (beta version) (1992-01-21 build) || <tt>$0800</tt> || <tt>2F ?? BC 3F ?? ??</tt> || <tt>$0E3D</tt> || Refers to a sound.bin file with this timestamp that was not embedded in a known prototype build.
|-
|Super Mario Kart (beta version) (mkart) || <tt>$0800</tt> || <tt>E8 ?? BC 3F ?? ??</tt> || <tt>$0D79</tt>|| Refers to a prototype from April 13, 1992.
|-
|Super Mario Kart (beta version) (mario_kart-01) || <tt>$0800</tt> || <tt>C5 ?? ?? E8 ?? 3F ?? ??</tt> || <tt>$0D65</tt> || Refers to what is known as the Enigma prototype build.
|-
|Super Mario Kart (beta version) (mario_kart) || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$0D74</tt> || Refers to a prototype from late June 1992, created before kar4t.
|-
|Super Mario Kart (beta version) (kar4t) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1598</tt> || Refers to a prototype from late June 1992, created after mario_kart.
|-
|Super Mario Kart (US version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19B4</tt>||
|-
|Super Mario Kart (Japanese and European version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19BA</tt>||
|-
|FX Trax || <tt>$0800</tt> || <tt>D0 F7 E8 ?? 3F ?? ??</tt> || <tt>$0D61</tt>|| Prototype of Wild Trax/Stunt Race FX.
|-
|Wild Trax/Stunt Race FX || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D73</tt>|| Loading program at $0675 before the actual start location
|}

==Unknown==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|SNES Burn-In Test Cartridge || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0D6D</tt>||For distinguishing purposes, known outside of these notes as Super Scope Test.
|-
|Super Scope 6 (Blastris) || <tt>$0800</tt> || <tt>90 F8 BC 3F ?? ??</tt> || <tt>$0D89</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine/Nintendo/Build Sorting

2022-03-10T15:02:10Z

KungFuFurby: Moving Mario Paint back under Hirokazu Tanaka after confirming that there is leftover code from Mario Paint still inside it (along with the resulting ARAM map matches).

__TOC__

==Unique cases==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|F-Zero || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0E3D</tt>||
|-
|Aging Cassette SNES Burn-In Test Cartridge|| <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$113A</tt>||For distinguishing purposes, known outside of these notes as Sound Module and Burn-In Test to refer to the copy found in the SNES Burn-In Test Cartridge.
|-
|Nintendo Power Menu Program || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0DCB</tt>||
|}

==Tetris & Dr. Mario Builds==
These builds are unique to one game, but unlike Super Scope 6 (which you may have noticed that LazerBlazer and Blastris are separated due to different SFX execution), they also match in general execution.
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Tetris and Dr. Mario (Mixed Match) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$118F</tt>||
|-
|Tetris and Dr. Mario (Dr. Mario) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$1199</tt>||
|-
|Tetris and Dr. Mario (Tetris) || <tt>$0800</tt> || <tt>C5 ?? ?? C5 ?? ?? BC 3F ?? ??</tt> & <tt>84 ?? C4 ?? 90 19 3F ?? ??</tt> || <tt>$0D5C</tt> & <tt>$11A1</tt>||
|}

==Akito Nakatsuka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Scope 6 (LazerBlazer) (US version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B33</tt>||
|-
|Super Scope 6 (LazerBlazer) (Japanese and European version) || <tt>$0500</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B37</tt>||
|-
|Super Game Boy Super Game Boy 2 || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0A5D</tt>||
|-
|BS-X BIOS Cassette Kensaki - NUS-you S Cassette || <tt>$0370</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$04AB</tt>||
|-
|JRA PAT JRA PAT - Wide Taiouban || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$0739</tt>||
|-
|Sutte Hakkun || <tt>$06E0</tt> || <tt>8F ?? ?? 8F ?? ?? 3F ?? ??</tt> || <tt>$074C</tt>||
|}

===Yuichi Ozaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Marvelous - Mouhitotsu no Takara-jima || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0BC5</tt>||
|-
|SA-1 Demo || <tt>$0400</tt> || <tt>D0 F3 BC 3F ?? ??</tt> || <tt>$0B23</tt>||
|-
|Heisei Shin Onigashima - Kouhen Heisei Shin Onigashima - Zenpen || <tt>$0400</tt> || <tt>D0 F3 8F ?? ?? BC 3F ?? ??</tt> || <tt>$0C8D</tt>||
|}

==Hirokazu Tanaka==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Mario Paint || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$1430</tt>||
|-
|Mother 2/Earthbound || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16A5</tt>||
|-
|Snoopy Concert || <tt>$0500</tt> || <tt>D0 FB 3F ?? ??</tt> || <tt>$16EB</tt>||
|}

==Kenji Yamamoto==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Metroid || <tt>$1500</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1ED7</tt>||
|}

==Koji Kondo==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0A96</tt>||
|-
|Super Mario: Yoshi Island/Super Mario World 2: Yoshi's Island (beta version) || <tt>$0400</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B08</tt>||
|-
|Star Fox/Star Wing || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0B14</tt>||
|-
|Super Mario All-Stars/Super Mario Collection || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0C11</tt>||
|-
|Legend of Zelda - A Link to the Past/Zelda no Densetsu - Kamigami no Triforce || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E22</tt>||
|-
|Star Glider || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0E97</tt>|| Prototype of Star Fox/Star Wing.
|-
|SimCity || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$175D</tt>||
|-
|Super Donkey 1 || <tt>$0800</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$1DC9</tt>|| Sound driver build is a prototype of Legend of Zelda - A Link to the Past's.
|}

===Prototype===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario World (all other versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BC0</tt> ||
|-
|Super Mario World (Super Mario All-Stars + Super Mario World) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$0697</tt> & <tt>$0BF4</tt> ||
|-
|Pilotwings (European version) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$126A</tt> ||
|-
|Pilotwings (US & Japanese versions) || <tt>$0500</tt> || <tt>CD 0B F5 ?? ?? FD F5 ?? ?? 3F ?? ??</tt> & <tt>E5 ?? ?? D0 03 3F ?? ??</tt> || <tt>$06A3</tt> & <tt>$12CD</tt> ||
|}

===Yoji Inagaki===
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Star Fox 2 (1994-04-01) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>||
|-
|Star Fox 2 (1994-04-15) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6F</tt>|| Except for a single opcode's difference at $064C, all of the code differences are after the SFX data, and thus pointers cannot be fully factored in.
|-
|Star Fox 2 (1994-05-06 and 1994-05-13) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B62</tt>||
|-
|Star Fox 2 (1994-08-31) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B6D</tt>||
|-
|Star Fox 2 (1994-12-28) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0B9C</tt>||
|-
|Star Fox 2 (1995-06-08) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD4</tt>||
|-
|Star Fox 2 (1995-06-22) Star Fox 2 (1995-06-27) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BD7</tt>|| These builds are identical to each other minus pointers placed after the SFX data.
|-
|Star Fox 2 (1995-07-25) || <tt>$0500</tt> || <tt>D0 F7 BC 3F ?? ??</tt> || <tt>$0BDA</tt>||
|-
|Star Fox 2 || <tt>$0500</tt> || <tt>D0 FA BC 3F ?? ??</tt> || <tt>$0BDF</tt>||
|}

==Taro Bando==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Super Mario Kart (beta version) (1992-01-21 build) || <tt>$0800</tt> || <tt>2F ?? BC 3F ?? ??</tt> || <tt>$0E3D</tt> || Refers to a sound.bin file with this timestamp that was not embedded in a known prototype build.
|-
|Super Mario Kart (beta version) (mkart) || <tt>$0800</tt> || <tt>E8 ?? BC 3F ?? ??</tt> || <tt>$0D79</tt>|| Refers to a prototype from April 13, 1992.
|-
|Super Mario Kart (beta version) (mario_kart-01) || <tt>$0800</tt> || <tt>C5 ?? ?? E8 ?? 3F ?? ??</tt> || <tt>$0D65</tt> || Refers to what is known as the Enigma prototype build.
|-
|Super Mario Kart (beta version) (mario_kart) || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$0D74</tt> || Refers to a prototype from late June 1992, created before kar4t.
|-
|Super Mario Kart (beta version) (kar4t) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1598</tt> || Refers to a prototype from late June 1992, created after mario_kart.
|-
|Super Mario Kart (US version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19B4</tt>||
|-
|Super Mario Kart (Japanese and European version) || <tt>$0800</tt> || <tt>E8 ?? C4 ?? 3F ?? ??</tt> & <tt>C4 ?? 90 0A 3F ?? ??</tt> & <tt>7D C4 ?? 5F ?? ??</tt> || <tt>$0D6A</tt> & <tt>$1664</tt> & <tt>$19BA</tt>||
|-
|FX Trax || <tt>$0800</tt> || <tt>D0 F7 E8 ?? 3F ?? ??</tt> || <tt>$0D61</tt>|| Prototype of Wild Trax/Stunt Race FX.
|-
|Wild Trax/Stunt Race FX || <tt>$0800</tt> || <tt>D0 FB BC 3F ?? ??</tt> || <tt>$0D73</tt>|| Loading program at $0675 before the actual start location
|}

==Unknown==
{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|SNES Burn-In Test Cartridge || <tt>$0800</tt> || <tt>D0 F8 BC 3F ?? ??</tt> || <tt>$0D6D</tt>||For distinguishing purposes, known outside of these notes as Super Scope Test.
|-
|Super Scope 6 (Blastris) || <tt>$0800</tt> || <tt>90 F8 BC 3F ?? ??</tt> || <tt>$0D89</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]

N-SPC Engine/Kemco

2022-02-23T01:57:25Z

KungFuFurby: Updating $2143/$F7 to account for some updates on some command specifications as well as confirming that the values that otherwise do nothing also technically act as a pause due to the polling nature of $2143/$F7.

Go back to [[N-SPC Engine]]

__TOC__

Kemco is the first company outside of Nintendo themselves to release a game using their own variant of N-SPC (that being Bombuzal). The main customization that they did was to have the CPUIO registers play sounds on specific channels, and only the channels on the phrase list specified to be used by the corresponding CPUIO register would be used. All non-music CPUIO registers, when processing phrase data, also did not support the fast forward phrase commands. One other CPUIO register was allocated mainly to perform volume fades.

{| class="wikitable sortable"
|-
! Game Name !! Version !! VCMD Table Location ($E0 and up) !! ROM Offset
|-
| Bombuzal || 1.0 || <tt>0x10EB</tt>, relative to <tt>0x102B</tt> || <tt>0x04807A</tt>
|-
| Lagoon || 2.0 || <tt>0x1156</tt>, relative to <tt>0x1096</tt> || <tt>0x0D80A4</tt> (all versions)
|-
| Drakkhen || 3.0 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x1C805C</tt> (all versions)
|-
| Ka-blooey || 3.0 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x048080</tt>
|-
| First Samurai || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x0DB15E</tt> (all versions)
|-
| Phalanx - The Enforce Fighter A-144 || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x1EB23E</tt> (all versions)
|-
| Super Drakkhen/Dragon View || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x09B6F6</tt> (all versions)
|-
| Super Full Metal || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x0C80B6</tt>
|-
| X Zone || 3.1 || <tt>0x129E</tt>, relative to <tt>0x11DE</tt> || <tt>0x0FAEE6</tt> (all versions)
|-
| Kid Klown in Crazy Chase || 4.0 || <tt>0x12A1</tt>, relative to <tt>0x11E1</tt> || <tt>0x1EC1E0</tt> (all versions)
|}

The raw build sorting notes can be found [[N-SPC Engine/Kemco/Build Sorting|here]].

==Communication with the SNES==
Each CPUIO register has an individual use. 
===CPUIO0 ($2140/$F4)===
This register always controls which sound ID will play out of channels 1-6, regardless of which sound driver version is used. It also supports the [[N-SPC_Engine#Communication_with_the_SNES|source build's N-SPC/Kankichi commands]]. These same commands are not present in the other CPUIO ports that control the channels, and instead you can only play or stop them.

{| class="wikitable sortable"
|-
! Command ID !! Description !! Register Values & Arguments
|-
|<tt>$00</tt> || Stop Sound || <tt>$00 ?? ?? ??</tt>
|-
|<tt>$01-??</tt> || Play Sound (Channels 1-6) || <tt>xx ?? ?? ??</tt>
|-
|<tt>$F0</tt> || Pause Sound (Channels 1-6) || <tt>$F0 ?? ?? ??</tt>
|-
|<tt>$F1</tt> || Continue Sound (Channels 1-6) || <tt>$F1 ?? ?? ??</tt>
|-
|<tt>$FF</tt> || Load New Data || <tt>$FF ?? xx xx</tt>
|}

The output to $2140/$F4 is as following...
* <tt>$00</tt> - Sound is not playing (usually caused by the zero command)
* <tt>$3F</tt> - Usually on the first tempo tick only, or sound is paused (caused by commands <tt>$F0</tt> and <tt>$FF</tt>)
* <tt>$40</tt> - Sound is playing on channels 1-6
===CPUIO1 ($2141/$F5)===
This register controls which sound ID will play of of the following channel IDs, depending on the version...
* V1.0, V3.0: Channels 7-8
* V2.0, V4.0: Channel 7
The output is as following...
* <tt>$00</tt> - Most common output with V1.0 and V3.0 (even if sound is playing). Otherwise indicates that a sound is not playing.
* <tt>$40</tt> - Usually on the first tempo tick only for V2.0 and V4.0 after the sound is activated.
* <tt>$80</tt> - Sound is playing on channel 7.
* <tt>$FF</tt> - Usually on the first tempo tick only for V1.0 and V3.0 after the sound is activated.

===CPUIO2 ($2142/$F6)===
Only used in V2.0 and V4.0. This register always controls which sound ID will play out of channel 8. 
This register always outputs a zero on V1.0 and V3.0-V3.1. Otherwise, when it is used, the output is...
* <tt>$00</tt> - Most common output, even if sound is playing.
* <tt>$80</tt> - Usually on the first tempo tick only after the sound is activated.

===CPUIO3 ($2143/$F7)===
Never used in V2.0. It does output a value, though: namely, whatever you sent in $2142/$F6. 
This CPUIO register is used to perform volume fades on either the note volumes of channels 1-8 or the MVOL DSP registers (The EVOL DSP registers are modified as well, but they get overwritten shortly afterwards). The values supported depend on the sound driver version.
====Commands (V1.0)====
{| class="wikitable sortable"
|-
! Command ID !! Description
|-
|<tt>$00-$9F</tt> || Pause Volume Operations + Acknowledge
|-
|<tt>$A0</tt> || Reset Volume Operations (Channels 1-6)
|-
|<tt>$A1</tt> || Fade Out (Channels 1-6)
|-
|<tt>$A2</tt> || Fade In (Channels 1-6)
|-
|<tt>$A3</tt> || Zero Volume (Channels 1-6)
|-
|<tt>$A4</tt> || Volume Restore (Channels 7-8)
|-
|<tt>$A5</tt> || Reset Volume Operations (Channels 7-8)
|-
|<tt>$A6</tt> || Fade Out (Channels 7-8)
|-
|<tt>$A7</tt> || Fade In (Channels 7-8)
|-
|<tt>$A8</tt> || Zero Volume (Channels 7-8)
|-
|<tt>$A9</tt> || Volume Restore (Channels 7-8)
|-
|<tt>$AA-$FF</tt> || Pause Volume Operations + Acknowledge
|}
====Commands (V3.0-V4.0)====
{| class="wikitable sortable"
|-
! Command ID !! Description !! Versions Supported
|-
|<tt>$00-$7F</tt> || Pause Volume Operations + Acknowledge ||
|-
|<tt>$80</tt> || Reset Volume Operations (Channels 1-6) || V3.0-V3.1
|-
|<tt>$81</tt> || Fade Out (Channels 1-6) || V3.0-V3.1
|-
|<tt>$82</tt> || Fade In (Channels 1-6) || V3.0-V3.1
|-
|<tt>$83</tt> || Zero Volume (Channels 1-6) || V3.0-V3.1
|-
|<tt>$84</tt> || Volume Restore (Channels 1-6) || V3.0-V3.1
|-
|<tt>$85-$9F</tt> || Pause Volume Operations + Acknowledge ||
|-
|<tt>$A0</tt> || Reset Volume Operations (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A1</tt> || Fade Out (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A2</tt> || Fade In (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A3</tt> || Zero Volume (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A4</tt> || Volume Restore (Channels 7-8) || V3.0-V3.1
|-
|<tt>$A5-$DF</tt> || Pause Volume Operations + Acknowledge ||
|-
|<tt>$E0</tt> || Reset Volume Operations (Master Volume) || V3.0-V4.0
|-
|<tt>$E1</tt> || Fade Out (Master Volume) || V3.0-V4.0
|-
|<tt>$E2</tt> || Fade In (Master Volume) || V3.0-V4.0
|-
|<tt>$E3</tt> || Zero Volume (Master Volume) || V3.0-V4.0
|-
|<tt>$E4</tt> || Volume Restore (Master Volume) || V3.0-V4.0
|-
|<tt>$E5-$FF</tt> || Pause Volume Operations + Acknowledge ||
|}

For V3.0-V3.1, <tt>$80</tt> and up can be transformed into this binary-based notation instead:
<pre>%1yyxxxxx</pre>
* <tt>%xxxxx</tt> is a command ID. The commands are as following...
** <tt>%00000</tt> (<tt>$00</tt>) - Reset Volume Operations
** <tt>%00001</tt> (<tt>$01</tt>) - Fade Out
** <tt>%00010</tt> (<tt>$02</tt>) - Fade In
** <tt>%00011</tt> (<tt>$03</tt>) - Zero Volume
** <tt>%00100</tt> (<tt>$04</tt>) - Volume Restore
** Any other value (<tt>$05-$1F</tt>) - Pause Volume Operations + Acknowledge
* <tt>%yy</tt> defines what will be affected by the command. The values are...
** <tt>%00</tt> (<tt>$0</tt>) - Channels 1-6
** <tt>%01</tt> (<tt>$1</tt>) - Channels 7-8
** <tt>%10</tt> (<tt>$2</tt>) - Invalid (causes all values to merely acknowledge)
** <tt>%11</tt> (<tt>$3</tt>) - Master Volume

====Pause Volume Operations + Acknowledge====
Echoes back the value you just sent to $2143/$F7. All volume operations are also paused, which includes fades, since the register is constantly polled.

====Reset Volume Operations====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A0</tt>
* V3.0-V3.1: <tt>$80</tt>
Channels 7-8
* V1.0: <tt>$A5</tt>
* V3.0-V3.1: <tt>$A0</tt>
Master Volume
* V3.0-V4.0: <tt>$E0</tt>

This command resets all volume-related operations, specifically by resetting the flags that they were triggered for the first time. This also pauses fades. $2143/$F7 outputs a zero.

====Fade Out====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A1</tt>
* V3.0-V3.1: <tt>$81</tt>
Channels 7-8
* V1.0: <tt>$A6</tt>
* V3.0-V3.1: <tt>$A1</tt>
Master Volume
* V3.0-V4.0: <tt>$E1</tt>

Fades out the volume to 0. On V1.0, this is done at a rate of 3 per tempo tick: on other versions, it's 1 per tempo tick. On V3.0 and later, the original volume value is saved. $2143/$F7 outputs the current volume value of the last channel in the set (or the intended right echo volume value in the master volume's case). 
The command does not properly function past V1.0 for channels 1-6. Technically it still works, but a wrong branching location causes the channel ID to use (and the number of channels to copy) to not be initialized properly, which causes the volume values to not be saved.

====Fade In====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A2</tt>
* V3.0-V3.1: <tt>$82</tt>
Channels 7-8
* V1.0: <tt>$A7</tt>
* V3.0-V3.1: <tt>$A2</tt>
Master Volume
* V3.0-V4.0: <tt>$E2</tt>

Fades in the volume to the original volume at a rate of 1 per tempo tick. If no value was saved beforehand, this can overflow back to zero. $2143/$F7 outputs the current volume value of the last channel in the set (or the intended right echo volume value in the master volume's case).

====Zero Volume====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A3</tt>
* V3.0-V3.1: <tt>$83</tt>
Channels 7-8
* V1.0: <tt>$A8</tt>
* V3.0-V3.1: <tt>$A3</tt>
Master Volume
* V3.0-V4.0: <tt>$E3</tt>

Zeroes out the volume, saving the original volume for restoration later on. Unless this is done on the master volume, you must reset volume operations to use this command again. $2143/$F7 outputs the current volume value (or the intended right echo volume value in the master volume's case) for one tempo tick, then a $01 (or, for the master volume, always outputs a zero). 
The command does not properly function past V1.0 for channels 1-6 due to a wrong branching location.

====Volume Restore====
The command ID used depends on the version... 
Channels 1-6
* V1.0: <tt>$A4</tt>
* V3.0-V3.1: <tt>$84</tt>
Channels 7-8
* V1.0: <tt>$A9</tt>
* V3.0-V3.1: <tt>$A4</tt>
Master Volume
* V3.0-V4.0: <tt>$E4</tt>

Restores the volumes to the saved value. Unless this is done on the master volume, you must reset volume operations to use this command again. $2143/$F7 outputs the current volume value for one tempo tick, then a $01 (or, for the master volume, always outputs the intended right echo volume value... which is saved to the left master volume by mistake). 
The command does not properly function past V1.0 for channels 1-6 due to a wrong branching location. 
The master volume variant does not work properly due to a typo in the code: specifically, the right echo volume gets copied to the left master volume by mistake, overwriting the correct value that was copied earlier.

[[Category:SPC Sound Engines]]
[[Category:N-SPC Variants]]

N-SPC Engine/Nintendo/Koji Kondo/SFX Sequence Format

2022-02-21T18:32:51Z

KungFuFurby:

Go back to [[N-SPC Engine/Nintendo/Koji Kondo]]

__TOC__

'''NOTE: This page is under construction. The later Koji Kondo games use the same format for the most part (except for Star Fox 2, which has a more massive overhaul), but adapted to modern N-SPC VCMD IDs, and they may have some extra per-entry parameters.'''

''TODO insert table here containing a list of games and their version''

The SFX sequence data is slightly modified compared to the standard N-SPC's voice command format. These are headerless, unlike a song, and they only support one channel at a time, with the channel used being fixed. Both games have almost the same command set except for VCMD <tt>$FF</tt>.

All SFX are initially handled at a tempo of <tt>$38</tt>. ''TODO double check for all games''

==SFX Instrument Format==
''TODO Star Glider, Star Fox, Yoshi's Island and Star Fox 2 don't use this instrument format: instead they're standard Kankichi-kun, so TODO note this once the versioning info is implemented''

The SFX instrument format, shared among all SFX but not consistently stored in terms of memory location, consists of a series of bytes as following...
<pre>xx yy zz aa bb cc dd ee ff</pre>
* <tt>xx</tt> is a direct write to the VxVOLL DSP register.
* <tt>yy</tt> is a direct write to the VxVOLR DSP register.
* <tt>zz</tt> is a direct write to the VxPITCHL DSP register.
* <tt>aa</tt> is a direct write to the VxPITCHH DSP register.
* <tt>bb</tt> is a direct write to the VxSRCN DSP register.
* <tt>cc</tt> is a direct write to the VxADSR1 DSP register.
* <tt>dd</tt> is a direct write to the VxADSR2 DSP register.
* <tt>ee</tt> is a direct write to the VxGAIN DSP register.
* <tt>ff</tt> is a pitch base multiplier.

==SFX Percussion Format==
See [[N-SPC Engine/Prototype#Percussion Format|the music percussion format]], as the format is identical.

==SFX Voice Command Format==
===V0.0-V0.1===
{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || End of SFX ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>(xx) (yy)</tt>
|-
|<tt>$80-$C5</tt> || Note ||
|-
|<tt>$C6-$CF</tt> || Retrigger Note ||
|-
|<tt>$D0-$D9</tt> || Percussion ||
|-
|<tt>$DA</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$DA</tt> || Noise Instrument (Super Mario World CPUIO3) || <tt>%1??xxxxx yy</tt>
|-
|<tt>$DB-$DC</tt> || Invalid Note ||
|-
|<tt>$DD</tt> || Note + Pitch Slide to Note || <tt>xx yy zz aa</tt>
|-
|<tt>$DE-$EA</tt> || Invalid Note ||
|-
|<tt>$EB</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$EC-$FE</tt> || Invalid Note ||
|-
|<tt>$FF</tt> || Restart SFX (Super Mario World CPUIO0) ||
|-
|<tt>$FF</tt> || Jump Back One Byte (Super Mario World CPUIO3) ||
|-
|<tt>$FF</tt> || Jump to SFX ID (Pilotwings) || <tt>xx</tt>
|}

===V1.0 and up===
''TODO add table here: the IDs now reflect modern N-SPC''

''TODO Star Fox 2'' (has a massive overhaul to the VCMD format)

===Invalid Note (VCMD <tt>$DB-$DC</tt>, <tt>$DE-$EA</tt>, <tt>$EC-$FE</tt>)===
Doesn't crash the sound driver, but does play an invalid note.

===End of SFX (VCMD <tt>$00</tt>)===
Terminates the SFX.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (yy) (zz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>yy</tt>, if less than <tt>$80</tt>, represents the volume of the note. If a second byte is defined, this is done for the left channel, otherwise it is for both channels.
* <tt>zz</tt>, if less than <tt>$80</tt>, represents the right volume of the note.

===Note (VCMD <tt>$80-$C5</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Retrigger Note (VCMD <tt>$C6-$CF</tt>)===
Retriggers the previous note and delays the channel for one note length before reading another VCMD.

Note that as a side effect of this, there is no tie or rest command. Rests can be emulated via a zero volume note. Ties... well, officially they're not supported at all, but if the pitch slide length equals or exceeds the note duration, then the note won't be keyed off once the note length has elapsed.

===Percussion (VCMD <tt>$D0-$D9</tt>)===
Plays a percussion note. Unlike SFX, percussion uses the same set that the music uses, and thus has the same instrument format as that.

===Instrument (VCMD <tt>$DA</tt>)===
<pre>$DA xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See SFX Instrument Format above for the format.

===Noise Instrument (VCMD <tt>$DA</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO3 register.

<pre>$DA %1??xxxxx yy</pre>

* <tt>%xxxxx</tt> contains the noise clock rate.
* <tt>yy</tt> is an instrument ID to an array of instruments. See SFX Instrument Format above for the format. This must be <tt>$7F</tt> or less, otherwise the noise clock rate is overwritten and more bytes will be fetched until a non-noise clock value is given.

===Note + Pitch Slide To Note (VCMD <tt>$DD</tt>)===
<pre>$DD xx yy zz aa</pre>
* <tt>xx</tt> is the starting note.
* <tt>yy</tt> defines the number of tempo ticks to delay the slide for... at least in theory. In reality, this never works, and the pitch slide executes instantly in all cases.
* <tt>zz</tt> defines the length of the pitch slide in tempo ticks. If this is equal or greater than the overall note length, the note won't key off at the end, thus allowing for multiple pitch envelopes to be chained at once.
* <tt>aa</tt> is the target note.

===Note Pitch Envelope To (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of ticks to delay before applying the pitch envelope... at least in theory. In reality, this never works, and the pitch slide executes instantly in all cases.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks. If this is equal or greater than the overall note length, the note won't key off at the end, thus allowing for multiple pitch envelopes to be chained at once.
* <tt>zz</tt> is the target note.

===Restart SFX (VCMD <tt>$FF</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO0 register.

Restarts the SFX from the beginning.

===Jump Back One Byte (VCMD <tt>$FF</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO3 register.

Normally, the pointer is incremented upon reading the VCMD. This causes the inverse to happen, and sets the pointer to one byte before this VCMD.

===Jump to SFX ID (VCMD <tt>$FF</tt>)===
Only compatible with Pilotwings.

<pre>$FF xx</pre>
* <tt>xx</tt> is the SFX ID to jump to. The array used depends on which set of sequences you're using, as the two of them use different sets.

N-SPC Engine/Nintendo/Koji Kondo/SFX Sequence Format

2022-02-21T18:25:41Z

KungFuFurby: Updating this to go to the Koji Kondo page instead

Go back to [[N-SPC Engine/Nintendo/Koji Kondo]]

__TOC__

'''NOTE: This page is under construction. The later Koji Kondo games use the same format for the most part (except for Star Fox 2, which has a more massive overhaul), but adapted to modern N-SPC VCMD IDs, and they may have some extra per-entry parameters.'''

The SFX sequence data is slightly modified compared to the standard N-SPC's voice command format. These are headerless, unlike a song, and they only support one channel at a time, with the channel used being fixed. Both games have almost the same command set except for VCMD <tt>$FF</tt>.

All SFX are initially handled at a tempo of <tt>$38</tt>.

{| class="wikitable sortable"
|-
! VCMD ID !! Description !! Arguments
|-
|<tt>$00</tt> || End of SFX ||
|-
|<tt>$01-$7F</tt> || Note Duration || <tt>(xx) (yy)</tt>
|-
|<tt>$80-$C5</tt> || Note ||
|-
|<tt>$C6-$CF</tt> || Retrigger Note ||
|-
|<tt>$D0-$D9</tt> || Percussion ||
|-
|<tt>$DA</tt> || Instrument || <tt>xx</tt>
|-
|<tt>$DA</tt> || Noise Instrument (Super Mario World CPUIO3) || <tt>%1??xxxxx yy</tt>
|-
|<tt>$DB-$DC</tt> || Invalid Note ||
|-
|<tt>$DD</tt> || Note + Pitch Slide to Note || <tt>xx yy zz aa</tt>
|-
|<tt>$DE-$EA</tt> || Invalid Note ||
|-
|<tt>$EB</tt> || Note Pitch Envelope To || <tt>xx yy zz</tt>
|-
|<tt>$EC-$FE</tt> || Invalid Note ||
|-
|<tt>$FF</tt> || Restart SFX (Super Mario World CPUIO0) ||
|-
|<tt>$FF</tt> || Jump Back One Byte (Super Mario World CPUIO3) ||
|-
|<tt>$FF</tt> || Jump to SFX ID (Pilotwings) || <tt>xx</tt>
|}

==SFX Instrument Format==
The SFX instrument format, shared among all SFX but not consistently stored in terms of memory location, consists of a series of bytes as following...
<pre>xx yy zz aa bb cc dd ee ff</pre>
* <tt>xx</tt> is a direct write to the VxVOLL DSP register.
* <tt>yy</tt> is a direct write to the VxVOLR DSP register.
* <tt>zz</tt> is a direct write to the VxPITCHL DSP register.
* <tt>aa</tt> is a direct write to the VxPITCHH DSP register.
* <tt>bb</tt> is a direct write to the VxSRCN DSP register.
* <tt>cc</tt> is a direct write to the VxADSR1 DSP register.
* <tt>dd</tt> is a direct write to the VxADSR2 DSP register.
* <tt>ee</tt> is a direct write to the VxGAIN DSP register.
* <tt>ff</tt> is a pitch base multiplier.

==SFX Percussion Format==
See [[N-SPC Engine/Prototype#Percussion Format|the music percussion format]], as the format is identical.

==SFX Voice Command Format==
===Invalid Note (VCMD <tt>$DB-$DC</tt>, <tt>$DE-$EA</tt>, <tt>$EC-$FE</tt>)===
Doesn't crash the sound driver, but does play an invalid note.

===End of SFX (VCMD <tt>$00</tt>)===
Terminates the SFX.

===Note Duration (VCMD <tt>$01-$7F</tt>)===
<pre>%0xxxxxxx (yy) (zz)</pre>

* <tt>%xxxxxxx</tt> represents your note length (as seven bits) in tempo ticks.
* <tt>yy</tt>, if less than <tt>$80</tt>, represents the volume of the note. If a second byte is defined, this is done for the left channel, otherwise it is for both channels.
* <tt>zz</tt>, if less than <tt>$80</tt>, represents the right volume of the note.

===Note (VCMD <tt>$80-$C5</tt>)===
Plays a note and delays the channel for one note length before reading another VCMD.

===Retrigger Note (VCMD <tt>$C6-$CF</tt>)===
Retriggers the previous note and delays the channel for one note length before reading another VCMD.

Note that as a side effect of this, there is no tie or rest command. Rests can be emulated via a zero volume note. Ties... well, officially they're not supported at all, but if the pitch slide length equals or exceeds the note duration, then the note won't be keyed off once the note length has elapsed.

===Percussion (VCMD <tt>$D0-$D9</tt>)===
Plays a percussion note. Unlike SFX, percussion uses the same set that the music uses, and thus has the same instrument format as that.

===Instrument (VCMD <tt>$DA</tt>)===
<pre>$DA xx</pre>

* <tt>xx</tt> is an instrument ID to an array of instruments. See SFX Instrument Format above for the format.

===Noise Instrument (VCMD <tt>$DA</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO3 register.

<pre>$DA %1??xxxxx yy</pre>

* <tt>%xxxxx</tt> contains the noise clock rate.
* <tt>yy</tt> is an instrument ID to an array of instruments. See SFX Instrument Format above for the format. This must be <tt>$7F</tt> or less, otherwise the noise clock rate is overwritten and more bytes will be fetched until a non-noise clock value is given.

===Note + Pitch Slide To Note (VCMD <tt>$DD</tt>)===
<pre>$DD xx yy zz aa</pre>
* <tt>xx</tt> is the starting note.
* <tt>yy</tt> defines the number of tempo ticks to delay the slide for... at least in theory. In reality, this never works, and the pitch slide executes instantly in all cases.
* <tt>zz</tt> defines the length of the pitch slide in tempo ticks. If this is equal or greater than the overall note length, the note won't key off at the end, thus allowing for multiple pitch envelopes to be chained at once.
* <tt>aa</tt> is the target note.

===Note Pitch Envelope To (VCMD <tt>$EB</tt>)===
<pre>$EB xx yy zz</pre>
* <tt>xx</tt> is the number of ticks to delay before applying the pitch envelope... at least in theory. In reality, this never works, and the pitch slide executes instantly in all cases.
* <tt>yy</tt> is the length of the pitch slide in tempo ticks. If this is equal or greater than the overall note length, the note won't key off at the end, thus allowing for multiple pitch envelopes to be chained at once.
* <tt>zz</tt> is the target note.

===Restart SFX (VCMD <tt>$FF</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO0 register.

Restarts the SFX from the beginning.

===Jump Back One Byte (VCMD <tt>$FF</tt>)===
Only compatible with Super Mario World when playing SFX through the CPUIO3 register.

Normally, the pointer is incremented upon reading the VCMD. This causes the inverse to happen, and sets the pointer to one byte before this VCMD.

===Jump to SFX ID (VCMD <tt>$FF</tt>)===
Only compatible with Pilotwings.

<pre>$FF xx</pre>
* <tt>xx</tt> is the SFX ID to jump to. The array used depends on which set of sequences you're using, as the two of them use different sets.

N-SPC Engine/Yoshidayama-Workshop/Build Sorting

2022-02-21T18:19:18Z

KungFuFurby: Adding category that was accidentally omitted

{| class="wikitable sortable"
|-
! Game Name(s) !! Starting Memory Location !! Sorting Signature(s) || Memory Locations Noted || Extra notes
|-
|Zootto Mahjong! || <tt>$0800</tt> || <tt>E8 ?? C5 ?? ?? 3F ?? ??</tt> || <tt>$1042</tt>||
|}
[[Category:SPC Sound Engine Build Sorting Pages]]