Difference between revisions of "SMPS"

From Sega Retro

old>Tweaker
m (+xm3smps mention)
m (Use proper references to link to developers' tweets and the SMPS source code release.)
(32 intermediate revisions by 12 users not shown)
Line 1: Line 1:
−
The '''Sample Music Playback System''' is a sound engine used in several games for the [[Sega Mega Drive/Genesis]] and the [[Sega 32X]], including all the major ''Sonic'' games except ''Sonic Spinball'', which uses [[GEMS]] instead.
+
'''Sample Music Playback System''' ('''SMPS''') is the common name of a family of audio playback engines (or "drivers") and storage formats used by various [[Sega]] consoles (including the [[Sega Mega Drive]], [[Sega Mega-CD]], [[Sega 32X]], [[Sega Master System]], [[Sega Game Gear]], and [[Sega Pico]]). "SMPS" is thought to be a colloquial term - there is no evidence to suggest this was the naming scheme of any official drivers, but is the most widely accepted name for the system.
−
A few version of this engine exist; most notably, both a 68K and a Z80 version were developed.
 
−
It is possible to port songs between two games that uses the SMPS engine; however, several games use a slightly different revision of the format, and the chance that the ported song will need extensive editings by hand (usually with an hex editor) is really high.
 
  
−
Many sceners have been working on the SMPS format, doing an extensive work of research. Most credit should be given to [[Saxman]], the man who started it all, but a lot of hackers continued his work up to our days, including [[Puto]] and [[Tweaker]].
+
Like other sound drivers, SMPS was designed as a means of processing audio information, allowing a console's CPU to communicate with sound chips on the board and create audible sound (i.e. "driving" the sound). It is usually associated with first-party Japanese Mega Drive games (where it was most predominantly used) - analogous to [[Sega of America]]'s use of the [[GEMS]] driver, and began appearing in games from the late 1980s until the aforementioned consoles bowed out of the market.
  
−
We now have a quite complete knowledge of this format, and several tools are available to hackers who want to tweak the music in their hacks. In particular, the [[Xm3smps]] tool, created by [[Nineko]], allows music to be imported into the SMPS format with ease, generally having very favorable results.
+
By sharing drivers between games, developers could create tools to quickly produce audio, and it allows for music and sound effects to be more easily ported between games.
  
−
It should be noted that both [[GYM]] and [[VGM]] files are logs of the data sent to the sound chipset rather than a dump of the sound data itself.
+
==Variants==
 +
===Mega Drive and 32X===
 +
Mega Drive (and by extension, 32X) developers had a choice of which processor to run SMPS on; the 16-bit [[68000]], or the 8-bit [[Z80]]. The driver variants are known as '''SMPS 68000''' and '''SMPS Z80''' respectively.
  
−
== See also ==
+
Some developers, such as [[Treasure]], chose to modify the driver, effectively making their own variants. Individual games such as ''[[Ristar]]'' also have their own modified drivers.
−
*[[SCHG:Music Hacking]]  
+
 
−
:A very comprehensive guide detailing the SMPS format; mainly focused to ''Sonic'' games, though it contains a few resources for other games as well.
+
====Source code====
 +
The source code to both SMPS-68000 and SMPS-Z80 was found and released by Hidden Palace in 2020<ref>https://hiddenpalace.org/News/Sega_of_Japan_Sound_Documents_and_Source_Code</ref>. The versions of the two drivers appear to be SMPS-68000 Type 1B and SMPS-Z80 Type 2 DAC.
 +
 
 +
{{Download
 +
| title=SMPS-68000 source code
 +
| file=SMPS-68000_source_code.zip
 +
}}
 +
{{Download
 +
| title=SMPS-Z80 source code
 +
| file=SMPS-Z80_source_code.zip
 +
}}
 +
 
 +
====Games which use SMPS 68000====
 +
=====Mega Drive=====
 +
{{SoundDriverList|SMPS 68000|MD}}
 +
 
 +
=====32X=====
 +
{{SoundDriverList|SMPS 68000|32X}}
 +
 
 +
====Games which use SMPS Z80====
 +
=====Mega Drive=====
 +
{{SoundDriverList|SMPS Z80|MD}}
 +
 
 +
=====32X=====
 +
{{SoundDriverList|SMPS Z80|32X}}
 +
 
 +
===Mega-CD===
 +
'''SMPS-PCM''' is  variant of SMPS-68000 designed to work on the Mega-CD's second 68000 processor, giving it access to the system's [[RF5C164]] PCM chip.
 +
 
 +
===Master System and Game Gear===
 +
SMPS drivers designed to work on the Z80 processors of the Master System and Game Gear were also produced. These tap into the two consoles' [[SN76489]] chip.
 +
 
 +
===Pico===
 +
'''SMPS-Pico''' is a variant of SMPS-68000 that targets the Sega Pico. It plays audio using the [[SN76489]] and the Pico-specific [[UPD7759]] chip.
 +
 
 +
The source code to this particular SMPS variant was released on AssemblerGames some time around 2016.
 +
 
 +
{{Download
 +
| title=Sega Pico Dev Tools
 +
| file=SEGA_Pico_dev_tools.zip
 +
}}
 +
 
 +
==Naming==
 +
The 'true' name of SMPS has been a subject of debate. Analysis of the source code reveals various possible names:
 +
 
 +
{| class="prettytable" style="width:auto;"
 +
! Name !! Usage
 +
|-
 +
| Sound
 +
| Appears frequently in documentation (m5_edit.jxw, ver11.doc, etc.). In the source code, this is the name of the label that marks the driver's entry point (m5cnt13.src, mdcnt11.asm).
 +
|-
 +
| Sound-Sorce
 +
| Appears in the header at the top of SMPS-Z80's source code files. Included with the source code is a [[wikipedia:sed|sed]] script that replaces the instances of this name with a parameter that is labelled 'game name'. This script was seemingly used on a handful of files, replacing 'Sound-Sorce' with 'MODEM_BOOT_ROM' and 'DICK_TRACY'.
 +
|-
 +
| Sound-Source
 +
| Appears in the header at the top of SMPS-68000's and SMPS-Pico's source code files. It is also the name used by some developers who had used SMPS back in the 90s<ref>https://web.archive.org/web/20191006015702/https://twitter.com/Hikoshi_H/status/1180661206253596672</ref><ref>https://web.archive.org/web/20190920174036/https://twitter.com/Hikoshi_H/status/1169707879164608513</ref><ref>https://web.archive.org/web/20200719143541/https://twitter.com/Mazin__/status/105869176442331136</ref>. Included with the source code is a sed script that replaces the instances of this name with a parameter that is labelled 'game name'.
 +
|-
 +
| Sound-Sample
 +
| Written on the SMPS-68000 and SMPS-Z80 source code's floppy disks. The SMPS-68000 source code has a Batch script (fmk.bat) that uses the aforementioned sed script to replace 'Sound-Source' with 'Sound-Sample'.
 +
|-
 +
| EASYSND
 +
| The name of the zip file that holds another zip file which contains the SMPS-Pico source code.
 +
|-
 +
| PICOSND
 +
| The name of the zip file which contains the SMPS-Pico source code. Also appears in various filenames and build scripts.
 +
|-
 +
| The PICO sound driver
 +
| Used by SMPS-Pico's GENERIC.MAK and PICOSND.MAK files.
 +
|}
 +
 
 +
==Developers==
 +
The names of several developers appear in SMPS' source code:
 +
{| class="prettytable" style="width:auto;"
 +
! Name !! Role !! Source
 +
|-
 +
| [[Tokuhiko Uwabo]] || Maintainer of SMPS-Z80. || The header of each source code file. Also mentioned by his Japanese name in the 'm5_bord.jxw' document.
 +
|-
 +
| [[Hiroshi Kubota]] || Maintainer of SMPS-68000. || The header of each source code file. Also mentioned by his Japanese name in the 'readme.txt' document.
 +
|-
 +
| "M.Nagao" (presumably [[Masayuki Nagao]]) || Maintainer of SMPS-Pico. || The header of each source code file.
 +
|-
 +
| [[Ken Chao]] || 'Cleaned-up' the SMPS-Pico source code for use by U.S. and European developers. || The 'README.1ST' document.
 +
|}
 +
 
 +
==Technical details==
 +
*[[SMPS/Headers|Headers]]
 +
*[[SMPS/Voices and samples|Voices and samples]]
 +
*[[SMPS/Song data|Song data]]
 +
 
 +
==Tools==
 +
*[[xm4smps]]
 +
*[[xm3smps/oerg]] (official improved branch of [[xm3smps]])
  
 
== External links ==
 
== External links ==
−
*[http://gdri.smspower.org/wiki/index.php/Mega_Drive/Genesis_Sound_Engine_List A list of the sound engines used on the Genesis]
+
*[http://gdri.smspower.org/wiki/index.php/Mega_Drive/Genesis_Sound_Engine_List A list of the sound engines used on the Mega Drive]
  
−
[[Category:Hacking Information]]
+
==References==
 +
<references />
 +
[[Category:Mega Drive sound drivers]]
 +
[[Category:SMPS]]

Revision as of 07:43, 30 March 2024

Sample Music Playback System (SMPS) is the common name of a family of audio playback engines (or "drivers") and storage formats used by various Sega consoles (including the Sega Mega Drive, Sega Mega-CD, Sega 32X, Sega Master System, Sega Game Gear, and Sega Pico). "SMPS" is thought to be a colloquial term - there is no evidence to suggest this was the naming scheme of any official drivers, but is the most widely accepted name for the system.

Like other sound drivers, SMPS was designed as a means of processing audio information, allowing a console's CPU to communicate with sound chips on the board and create audible sound (i.e. "driving" the sound). It is usually associated with first-party Japanese Mega Drive games (where it was most predominantly used) - analogous to Sega of America's use of the GEMS driver, and began appearing in games from the late 1980s until the aforementioned consoles bowed out of the market.

By sharing drivers between games, developers could create tools to quickly produce audio, and it allows for music and sound effects to be more easily ported between games.

Variants

Mega Drive and 32X

Mega Drive (and by extension, 32X) developers had a choice of which processor to run SMPS on; the 16-bit 68000, or the 8-bit Z80. The driver variants are known as SMPS 68000 and SMPS Z80 respectively.

Some developers, such as Treasure, chose to modify the driver, effectively making their own variants. Individual games such as Ristar also have their own modified drivers.

Source code

The source code to both SMPS-68000 and SMPS-Z80 was found and released by Hidden Palace in 2020[1]. The versions of the two drivers appear to be SMPS-68000 Type 1B and SMPS-Z80 Type 2 DAC.

Download.svg Download SMPS-68000 source code
File: SMPS-68000_source_code.zip (231 kB) (info)
Download.svg Download SMPS-Z80 source code
File: SMPS-Z80_source_code.zip (258 kB) (info)

Games which use SMPS 68000

Mega Drive
32X

Games which use SMPS Z80

Mega Drive
32X

Mega-CD

SMPS-PCM is variant of SMPS-68000 designed to work on the Mega-CD's second 68000 processor, giving it access to the system's RF5C164 PCM chip.

Master System and Game Gear

SMPS drivers designed to work on the Z80 processors of the Master System and Game Gear were also produced. These tap into the two consoles' SN76489 chip.

Pico

SMPS-Pico is a variant of SMPS-68000 that targets the Sega Pico. It plays audio using the SN76489 and the Pico-specific UPD7759 chip.

The source code to this particular SMPS variant was released on AssemblerGames some time around 2016.

Download.svg Download Sega Pico Dev Tools
File: SEGA_Pico_dev_tools.zip (625 kB) (info)

Naming

The 'true' name of SMPS has been a subject of debate. Analysis of the source code reveals various possible names:

Name Usage
Sound Appears frequently in documentation (m5_edit.jxw, ver11.doc, etc.). In the source code, this is the name of the label that marks the driver's entry point (m5cnt13.src, mdcnt11.asm).
Sound-Sorce Appears in the header at the top of SMPS-Z80's source code files. Included with the source code is a sed script that replaces the instances of this name with a parameter that is labelled 'game name'. This script was seemingly used on a handful of files, replacing 'Sound-Sorce' with 'MODEM_BOOT_ROM' and 'DICK_TRACY'.
Sound-Source Appears in the header at the top of SMPS-68000's and SMPS-Pico's source code files. It is also the name used by some developers who had used SMPS back in the 90s[2][3][4]. Included with the source code is a sed script that replaces the instances of this name with a parameter that is labelled 'game name'.
Sound-Sample Written on the SMPS-68000 and SMPS-Z80 source code's floppy disks. The SMPS-68000 source code has a Batch script (fmk.bat) that uses the aforementioned sed script to replace 'Sound-Source' with 'Sound-Sample'.
EASYSND The name of the zip file that holds another zip file which contains the SMPS-Pico source code.
PICOSND The name of the zip file which contains the SMPS-Pico source code. Also appears in various filenames and build scripts.
The PICO sound driver Used by SMPS-Pico's GENERIC.MAK and PICOSND.MAK files.

Developers

The names of several developers appear in SMPS' source code:

Name Role Source
Tokuhiko Uwabo Maintainer of SMPS-Z80. The header of each source code file. Also mentioned by his Japanese name in the 'm5_bord.jxw' document.
Hiroshi Kubota Maintainer of SMPS-68000. The header of each source code file. Also mentioned by his Japanese name in the 'readme.txt' document.
"M.Nagao" (presumably Masayuki Nagao) Maintainer of SMPS-Pico. The header of each source code file.
Ken Chao 'Cleaned-up' the SMPS-Pico source code for use by U.S. and European developers. The 'README.1ST' document.

Technical details

Tools

External links

References

  1. ↑ https://hiddenpalace.org/News/Sega_of_Japan_Sound_Documents_and_Source_Code
  2. ↑ https://web.archive.org/web/20191006015702/https://twitter.com/Hikoshi_H/status/1180661206253596672
  3. ↑ https://web.archive.org/web/20190920174036/https://twitter.com/Hikoshi_H/status/1169707879164608513
  4. ↑ https://web.archive.org/web/20200719143541/https://twitter.com/Mazin__/status/105869176442331136
Retrieved from "https://segaretro.org/index.php?title=SMPS&oldid=970720"