Luma's Workshop - User contributions [en]

IBNK

2025-07-01T12:19:18Z

Louis Miles: /* Tools */

IBNK page. Feel free to overwrite with accurate information

== IBNK Header ==
{| class="wikitable"
! Offset !! Type !! Description !! Notes
|-
| 0x00 || String[4] || IBNK (0x49424E4B) || |
|-
| 0x04 || UInt32 || File size minus 0x08 || |
|-
| 0x08 || Int32 || Bank ID || |
|-
| 0x0C || Int32 || Bank Version || 0x00000000 = Bank Version 0 0x00000001 = Bank Version 1 Both are supported in ''Super Mario Galaxy'' & ''Super Mario Galaxy 2''
|-
| 0x10 || Byte[16] || Padding? || All Zeros |
|}

== INST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| INST (0x494E5354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Inst sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Inst Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Inst (0x496E7374)
|
|-
| 0x04
| UInt32
| ?
|
|-
| 0x08
| UInt32
| ?
|
|-
| 0x0C
| UInt32
| ?
|
|-
| 0x10
| UInt32
| Amount '''N''' of Keyboard sections
|
|-
| 0x14
|
| Start of first Keyboard section
|
|-
| 0x14+N*0x18
| Float
| Keyboard global volume
|
|-
| 0x14+N*0x18+0x04
| Float
| Keyboard global pitch
|
|}

=== Keyboard section (size 0x18) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt8
| Highest key of current keyboard
| Cannot be higher than 7F. Lowest key of next keyboard (if exists) is this value + 0x01.
|-
| 0x01
| Byte[6]
| ?
|
|-
| 0x07
| Byte[1]
| ?
|
|-
| 0x08
| UInt8
| Velocity
|
|-
| 0x09
| Byte[3]
| ?
|
|-
| 0x0C
| UInt16
| '''Bank ID'''
|
|-
| 0x0E
| UInt16
| '''Wave ID'''
|
|-
| 0x10
| Float
| Volume
|
|-
| 0x14
| Float
| Pitch
|
|}

== PMAP Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PMAP (0x504D4150)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Pmap sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

=== Pmap Section (Size 0x28) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Pmap (0x506D6170)
|
|-
| 0x04
| Float
| ?
|
|-
| 0x08
| Float
| ?
|
|-
| 0x0C
| Float
| ?
|
|-
| 0x10
| Byte[7]
| ?
|
|-
| 0x17
| Byte[1]
| ?
|
|-
| 0x18
| UInt8
| Velocity
|
|-
| 0x19
| Byte[3]
| ?
|
|-
| 0x1C
| UInt16
| '''Bank ID'''
|
|-
| 0x1E
| UInt16
| '''Wave ID'''
|
|-
| 0x20
| Float
| ?
|
|-
| 0x24
| Float
| ?
|
|}

== PERC Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PERC (0x50455243)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Perc sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Perc Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Perc (0x50657263)
|
|-
| 0x04
| UInt32
| Amount '''N''' of entries
|
|-
| 0x08
|
| Start of entries
|
|}

=== Perc entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Pmap section relative to file beginning.
| Many entries can be found holding no offset (0x00000000).
|}

== LIST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| LIST (0x4C495354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of entries
|
|-
| 0x0C
|
| Start of entries
|
|}

=== List entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Inst or Perc section relative to file beginning.
| Many entries can be found holding no offset (0x00000000). The position of an entry in this list defines the '''Program ID'''. It starts counting at 0.
|}

==Tools==
[https://github.com/XAYRGA/ibnktool ibnktool ] (edits IBNK) 
[https://github.com/magcius/vgmtrans VGMTrans Fork] (analyses and converts IBNK to SF2 (unfinished). Drag and drop BAA onto the window.)*

''*''SF2 only supports linear envelopes, so the export may be inaccurate.

IBNK

2025-07-01T12:18:00Z

Louis Miles: /* Tools */

IBNK page. Feel free to overwrite with accurate information

== IBNK Header ==
{| class="wikitable"
! Offset !! Type !! Description !! Notes
|-
| 0x00 || String[4] || IBNK (0x49424E4B) || |
|-
| 0x04 || UInt32 || File size minus 0x08 || |
|-
| 0x08 || Int32 || Bank ID || |
|-
| 0x0C || Int32 || Bank Version || 0x00000000 = Bank Version 0 0x00000001 = Bank Version 1 Both are supported in ''Super Mario Galaxy'' & ''Super Mario Galaxy 2''
|-
| 0x10 || Byte[16] || Padding? || All Zeros |
|}

== INST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| INST (0x494E5354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Inst sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Inst Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Inst (0x496E7374)
|
|-
| 0x04
| UInt32
| ?
|
|-
| 0x08
| UInt32
| ?
|
|-
| 0x0C
| UInt32
| ?
|
|-
| 0x10
| UInt32
| Amount '''N''' of Keyboard sections
|
|-
| 0x14
|
| Start of first Keyboard section
|
|-
| 0x14+N*0x18
| Float
| Keyboard global volume
|
|-
| 0x14+N*0x18+0x04
| Float
| Keyboard global pitch
|
|}

=== Keyboard section (size 0x18) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt8
| Highest key of current keyboard
| Cannot be higher than 7F. Lowest key of next keyboard (if exists) is this value + 0x01.
|-
| 0x01
| Byte[6]
| ?
|
|-
| 0x07
| Byte[1]
| ?
|
|-
| 0x08
| UInt8
| Velocity
|
|-
| 0x09
| Byte[3]
| ?
|
|-
| 0x0C
| UInt16
| '''Bank ID'''
|
|-
| 0x0E
| UInt16
| '''Wave ID'''
|
|-
| 0x10
| Float
| Volume
|
|-
| 0x14
| Float
| Pitch
|
|}

== PMAP Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PMAP (0x504D4150)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Pmap sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

=== Pmap Section (Size 0x28) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Pmap (0x506D6170)
|
|-
| 0x04
| Float
| ?
|
|-
| 0x08
| Float
| ?
|
|-
| 0x0C
| Float
| ?
|
|-
| 0x10
| Byte[7]
| ?
|
|-
| 0x17
| Byte[1]
| ?
|
|-
| 0x18
| UInt8
| Velocity
|
|-
| 0x19
| Byte[3]
| ?
|
|-
| 0x1C
| UInt16
| '''Bank ID'''
|
|-
| 0x1E
| UInt16
| '''Wave ID'''
|
|-
| 0x20
| Float
| ?
|
|-
| 0x24
| Float
| ?
|
|}

== PERC Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PERC (0x50455243)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Perc sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Perc Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Perc (0x50657263)
|
|-
| 0x04
| UInt32
| Amount '''N''' of entries
|
|-
| 0x08
|
| Start of entries
|
|}

=== Perc entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Pmap section relative to file beginning.
| Many entries can be found holding no offset (0x00000000).
|}

== LIST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| LIST (0x4C495354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of entries
|
|-
| 0x0C
|
| Start of entries
|
|}

=== List entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Inst or Perc section relative to file beginning.
| Many entries can be found holding no offset (0x00000000). The position of an entry in this list defines the '''Program ID'''. It starts counting at 0.
|}

==Tools==
[https://github.com/XAYRGA/ibnktool ibnktool ] (edits IBNK) 
[https://github.com/magcius/vgmtrans VGMTrans Fork] (analyses and converts IBNK to SF2. Drag and drop BAA onto the window.)*

''*''SF2 only supports linear envelopes, so the export may be inaccurate.

BMS (File Format)

2025-07-01T12:12:35Z

Louis Miles: /* Tools */

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS consists of pure assembly code, where each track containing events such as notes, patch changes, etc. is an independent executor thread with opcodes to execute.
In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

The game's audio engine can only play up to 16 tracks at a time - very similar to MIDI with its 16 channels.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Global Track / Tempo Track''' BMS always starts (very similary to Midi's "Tempo Track" or "Conductor Track") directly with track containing Meta-Events, which only contains global control data, typically:
**Pulses per Quarter Note (PPQN) set
**Tempo (BPM)
**Looping commands (to keep BPM changes synchronized during the song if necessary)
**OpenTrack command that starts playing the following track

*'''Channel Specific Track''' a kind of management track for channel/Main Track definitions
**Usally contains '''C1''' OpenTrack events for each executor track (channel). For some unknown reason, the exact same looping and duration events from the global track need to be repeated here, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Starts playing a certain track on a certain channel. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#BGM_parameters|If enabled in the BGM parameter table in SMR.szs]], channel 0 can be used for timing and chords usage that do not play any instruments from the sound bank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines/changes patch and bank to be played on the target channel. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines/changes the WSYS/IBNK (bank) whose sounds are to be used in a channel.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT (File Format)|CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the [[IBNK]] belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an [[IBNK]] (bank). If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT (File Format)|CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/magcius/vgmtrans VGMTrans Fork] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

Cutscenes

2025-06-19T12:33:51Z

Louis Miles: /* Action */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' defined in [[ProductMapObjDataTable]].
|-
| CastID
| style="font-size:12px;" | LONG
| Optional Cast ID of the target object. -1 = Deactivated. 
To target a specific object among identical objects that are part of the cutscene.
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from MarioAnim.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focused to. (Primarily uses ObjNameTable names)
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (".canm" extension optional) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
| The part frame to begin the camera on. -1 will have the camera interpolate to the start of the CANM
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Music|Name of the music]] to play.
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Sounds_(SMG2)|Name of the soundeffect]] to play.
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
| Duration in frames for fading out the music. -1 = No fade-out
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

Cutscenes

2025-06-19T12:28:40Z

Louis Miles: /* Action */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' name defined in [[ProductMapObjDataTable]].
|-
| CastID
| style="font-size:12px;" | LONG
| Optional Cast ID of the target object. -1 = Deactivated. 
To target a specific object among identical objects that are part of the cutscene.
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from MarioAnim.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focused to. (Primarily uses ObjNameTable names)
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (".canm" extension optional) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
| The part frame to begin the camera on. -1 will have the camera interpolate to the start of the CANM
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Music|Name of the music]] to play.
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Sounds_(SMG2)|Name of the soundeffect]] to play.
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
| Duration in frames for fading out the music. -1 = No fade-out
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

BMS (File Format)

2025-06-10T12:23:53Z

Louis Miles: /* Structure */

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS consists of pure assembly code, where each track containing events such as notes, patch changes, etc. is an independent executor thread with opcodes to execute.
In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

The game's audio engine can only play up to 16 tracks at a time - very similar to MIDI with its 16 channels.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Global Track / Tempo Track''' BMS always starts (very similary to Midi's "Tempo Track" or "Conductor Track") directly with track containing Meta-Events, which only contains global control data, typically:
**Pulses per Quarter Note (PPQN) set
**Tempo (BPM)
**Looping commands (to keep BPM changes synchronized during the song if necessary)
**OpenTrack command that starts playing the following track

*'''Channel Specific Track''' a kind of management track for channel/Main Track definitions
**Usally contains '''C1''' OpenTrack events for each executor track (channel). For some unknown reason, the exact same looping and duration events from the global track need to be repeated here, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Starts playing a certain track on a certain channel. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#BGM_parameters|If enabled in the BGM parameter table in SMR.szs]], channel 0 can be used for timing and chords usage that do not play any instruments from the sound bank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines/changes patch and bank to be played on the target channel. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines/changes the WSYS/IBNK (bank) whose sounds are to be used in a channel.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT (File Format)|CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the [[IBNK]] belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an [[IBNK]] (bank). If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT (File Format)|CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-10T12:21:30Z

Louis Miles: Better explanation

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS consists of pure assembly code, where each track containing events such as notes, patch changes, etc. is an independent executor thread with opcodes to execute.
In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

The game's audio engine can only play up to 16 tracks at a time - very similar to MIDI with its 16 channels.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Global Track / Tempo Track''' BMS always starts (very similary to Midi's "Tempo Track" or "Conductor Track") directly with track containing Meta-Events, which only contains global control data, typically:
**Pulses per Quarter Note (PPQN) set
**Tempo (BPM)
**Looping commands (to keep BPM changes synchronized during the song if necessary)
**OpenTrack command that starts playing the following track

*'''Channel Specific Track''' a kind of management track for channel definitions
**Usally contains '''C1''' OpenTrack events for each channel. For some unknown reason, the exact same looping and duration events from the global track need to be repeated here, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Starts playing a certain track on a certain channel. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#BGM_parameters|If enabled in the BGM parameter table in SMR.szs]], channel 0 can be used for timing and chords usage that do not play any instruments from the sound bank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines/changes patch and bank to be played on the target channel. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines/changes the WSYS/IBNK (bank) whose sounds are to be used in a channel.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT (File Format)|CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the [[IBNK]] belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an [[IBNK]] (bank). If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT (File Format)|CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-08T13:26:37Z

Louis Miles:

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS works very similar to Midi Format 2, with 16 channels (0-15), as well as a variety of possible independent tracks containing events such as notes, patch changes, etc.

In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Global Track / Tempo Track''' BMS always starts (very similary to Midi's "Tempo Track" or "Conductor Track") directly with track containing Meta-Events, which only contains global control data, typically:
**Pulses per Quarter Note (PPQN) set
**Tempo (BPM)
**Looping commands (to keep BPM changes synchronized during the song if necessary)
**OpenTrack command that starts playing the following track

*'''Channel Specific Track''' a kind of management track for channel definitions
**Usally contains '''C1''' OpenTrack events for each channel. For some unknown reason, the exact same looping and duration events from the global track need to be repeated here, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Starts playing a certain track on a certain channel. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#BGM_parameters|If enabled in the BGM parameter table in SMR.szs]], channel 0 can be used for timing and chords usage that do not play any instruments from the sound bank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines/changes patch and bank to be played on the target channel. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines/changes the WSYS/IBNK (bank) whose sounds are to be used in a channel.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT (File Format)|CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the [[IBNK]] belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an [[IBNK]] (bank). If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT (File Format)|CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-08T13:18:14Z

Louis Miles: /* Filestructure */

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS works very similar to Midi Format 2, with 16 channels (0-15), as well as a variety of possible independent tracks containing events such as notes, patch changes, etc.

In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Global Track / Tempo Track''' BMS always starts (very similary to Midi's "Tempo Track" or "Conductor Track") directly with track containing Meta-Events, which only contains global control data, typically:
**Pulses per Quarter Note (PPQN) set
**Tempo (BPM)
**Looping commands (to keep BPM changes synchronized during the song if necessary)
**OpenTrack command that starts playing the following track

*'''Channel Specific Track''' a kind of management track for channel definitions
**Usally contains '''C1''' OpenTrack events for each channel. For some unknown reason, the exact same looping and duration events from the global track need to be repeated here, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Starts playing a certain track on a certain channel. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#BGM_parameters|If enabled in the BGM parameter table in SMR.szs]], channel 0 can be used for timing and chords usage that do not play any instruments from the sound bank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines/changes patch and bank to be played on the target channel. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines/changes the WSYS/IBNK (bank) whose sounds are to be used in a channel.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT (File Format)|CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the [[IBNK]] belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an [[IBNK]] bank. If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT (File Format)|CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-08T13:14:46Z

Louis Miles: Improved explanations

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS works very similar to Midi Format 2, with 16 channels (0-15), as well as a variety of possible independent tracks containing events such as notes, patch changes, etc.

In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Global Track / Tempo Track''' BMS always starts (very similary to Midi's "Tempo Track" or "Conductor Track") directly with track containing Meta-Events, which only contains global control data, typically:
**Pulses per Quarter Note (PPQN) set
**Tempo (BPM)
**Looping commands (to keep BPM changes synchronized during the song if necessary)
**OpenTrack command that starts playing the following track

*'''Channel Specific Track''' a kind of management track for channel definitions
**Usally contains '''C1''' OpenTrack events for each channel. For some unknown reason, the exact same setting that follows the PPQN setting on the tempo track must be repeated here after the C1 events, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Starts playing a certain track on a certain channel. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#BGM_parameters|If enabled in the BGM parameter table in SMR.szs]], channel 0 can be used for timing and chords usage that do not play any instruments from the sound bank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines/changes patch and bank to be played on the target channel. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines/changes the WSYS/IBNK (bank) whose sounds are to be used in a channel.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT (File Format)|CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the [[IBNK]] belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an [[IBNK]] bank. If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT (File Format)|CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-06T17:31:12Z

Louis Miles:

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS works very similar to Midi Format 2, with 16 channels (0-15), as well as a variety of possible independent tracks containing events such as notes, patch changes, etc..

In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Pointer to Channel Creator Events''' BMS always starts directly with a '''C1''' channel creator event with channel 0 containing pointer to the actual channel creator section.
*'''Tempo Track''' This usually starts with a PPQN set, and then with a track with BPM changes and loop events.
*'''Channel Creator Section''' This contains '''C1''' channel creator events for each channel. For some unknown reason, the exact same setting that follows the PPQN setting on the tempo track must be repeated here after the C1 events, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine without any headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Creates a channel with a start pointer to a track with notes to be played. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#MAIN_BGM|When enabled in the SMR.szs]], channel 0 can be used for timing and chord usage and will not play any instruments from the soundbank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines Instrument and Soundbank to be used in a Track. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK bank whose sounds are to be used in a Track.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an IBNK bank. If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

IBNK

2025-06-06T17:30:28Z

Louis Miles: /* Tools */

IBNK page. Feel free to overwrite with accurate information

== IBNK Header ==
{| class="wikitable"
! Offset !! Type !! Description !! Notes
|-
| 0x00 || String[4] || IBNK (0x49424E4B) || |
|-
| 0x04 || UInt32 || File size minus 0x08 || |
|-
| 0x08 || Int32 || Bank ID || |
|-
| 0x0C || Int32 || Bank Version || 0x00000000 = Bank Version 0 0x00000001 = Bank Version 1 Both are supported in ''Super Mario Galaxy'' & ''Super Mario Galaxy 2''
|-
| 0x10 || Byte[16] || Padding? || All Zeros |
|}

== INST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| INST (0x494E5354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Inst sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Inst Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Inst (0x496E7374)
|
|-
| 0x04
| UInt32
| ?
|
|-
| 0x08
| UInt32
| ?
|
|-
| 0x0C
| UInt32
| ?
|
|-
| 0x10
| UInt32
| Amount '''N''' of Keyboard sections
|
|-
| 0x14
|
| Start of first Keyboard section
|
|-
| 0x14+N*0x18
| Float
| Keyboard global volume
|
|-
| 0x14+N*0x18+0x04
| Float
| Keyboard global pitch
|
|}

=== Keyboard section (size 0x18) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt8
| Highest key of current keyboard
| Cannot be higher than 7F. Lowest key of next keyboard (if exists) is this value + 0x01.
|-
| 0x01
| Byte[6]
| ?
|
|-
| 0x07
| Byte[1]
| ?
|
|-
| 0x08
| UInt8
| Velocity
|
|-
| 0x09
| Byte[3]
| ?
|
|-
| 0x0C
| UInt16
| '''Bank ID'''
|
|-
| 0x0E
| UInt16
| '''Wave ID'''
|
|-
| 0x10
| Float
| Volume
|
|-
| 0x14
| Float
| Pitch
|
|}

== PMAP Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PMAP (0x504D4150)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Pmap sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

=== Pmap Section (Size 0x28) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Pmap (0x506D6170)
|
|-
| 0x04
| Float
| ?
|
|-
| 0x08
| Float
| ?
|
|-
| 0x0C
| Float
| ?
|
|-
| 0x10
| Byte[7]
| ?
|
|-
| 0x17
| Byte[1]
| ?
|
|-
| 0x18
| UInt8
| Velocity
|
|-
| 0x19
| Byte[3]
| ?
|
|-
| 0x1C
| UInt16
| '''Bank ID'''
|
|-
| 0x1E
| UInt16
| '''Wave ID'''
|
|-
| 0x20
| Float
| ?
|
|-
| 0x24
| Float
| ?
|
|}

== PERC Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PERC (0x50455243)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Perc sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Perc Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Perc (0x50657263)
|
|-
| 0x04
| UInt32
| Amount '''N''' of entries
|
|-
| 0x08
|
| Start of entries
|
|}

=== Perc entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Pmap section relative to file beginning.
| Many entries can be found holding no offset (0x00000000).
|}

== LIST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| LIST (0x4C495354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of entries
|
|-
| 0x0C
|
| Start of entries
|
|}

=== List entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Inst or Perc section relative to file beginning.
| Many entries can be found holding no offset (0x00000000). The position of an entry in this list defines the '''Program ID'''. It starts counting at 0.
|}

==Tools==
[https://github.com/XAYRGA/ibnktool ibnktool ] (edits IBNK) 
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts IBNK to SF2. Drag and drop BAA onto the window.)

IBNK

2025-06-06T17:23:00Z

Louis Miles: Tools

IBNK page. Feel free to overwrite with accurate information

== IBNK Header ==
{| class="wikitable"
! Offset !! Type !! Description !! Notes
|-
| 0x00 || String[4] || IBNK (0x49424E4B) || |
|-
| 0x04 || UInt32 || File size minus 0x08 || |
|-
| 0x08 || Int32 || Bank ID || |
|-
| 0x0C || Int32 || Bank Version || 0x00000000 = Bank Version 0 0x00000001 = Bank Version 1 Both are supported in ''Super Mario Galaxy'' & ''Super Mario Galaxy 2''
|-
| 0x10 || Byte[16] || Padding? || All Zeros |
|}

== INST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| INST (0x494E5354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Inst sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Inst Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Inst (0x496E7374)
|
|-
| 0x04
| UInt32
| ?
|
|-
| 0x08
| UInt32
| ?
|
|-
| 0x0C
| UInt32
| ?
|
|-
| 0x10
| UInt32
| Amount '''N''' of Keyboard sections
|
|-
| 0x14
|
| Start of first Keyboard section
|
|-
| 0x14+N*0x18
| Float
| Keyboard global volume
|
|-
| 0x14+N*0x18+0x04
| Float
| Keyboard global pitch
|
|}

=== Keyboard section (size 0x18) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt8
| Highest key of current keyboard
| Cannot be higher than 7F. Lowest key of next keyboard (if exists) is this value + 0x01.
|-
| 0x01
| Byte[6]
| ?
|
|-
| 0x07
| Byte[1]
| ?
|
|-
| 0x08
| UInt8
| Velocity
|
|-
| 0x09
| Byte[3]
| ?
|
|-
| 0x0C
| UInt16
| '''Bank ID'''
|
|-
| 0x0E
| UInt16
| '''Wave ID'''
|
|-
| 0x10
| Float
| Volume
|
|-
| 0x14
| Float
| Pitch
|
|}

== PMAP Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PMAP (0x504D4150)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Pmap sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

=== Pmap Section (Size 0x28) ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Pmap (0x506D6170)
|
|-
| 0x04
| Float
| ?
|
|-
| 0x08
| Float
| ?
|
|-
| 0x0C
| Float
| ?
|
|-
| 0x10
| Byte[7]
| ?
|
|-
| 0x17
| Byte[1]
| ?
|
|-
| 0x18
| UInt8
| Velocity
|
|-
| 0x19
| Byte[3]
| ?
|
|-
| 0x1C
| UInt16
| '''Bank ID'''
|
|-
| 0x1E
| UInt16
| '''Wave ID'''
|
|-
| 0x20
| Float
| ?
|
|-
| 0x24
| Float
| ?
|
|}

== PERC Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| PERC (0x50455243)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of Perc sections
|
|-
| 0x0C
|
| Start of first Inst section
|
|}

== Perc Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| Perc (0x50657263)
|
|-
| 0x04
| UInt32
| Amount '''N''' of entries
|
|-
| 0x08
|
| Start of entries
|
|}

=== Perc entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Pmap section relative to file beginning.
| Many entries can be found holding no offset (0x00000000).
|}

== LIST Section ==
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| String[4]
| LIST (0x4C495354)
|
|-
| 0x04
| UInt32
| Section size minus 0x08
|
|-
| 0x08
| UInt32
| Amount '''N''' of entries
|
|-
| 0x0C
|
| Start of entries
|
|}

=== List entry ===
{| class="wikitable"
|-
! Offset
! Type
! Description
! Notes
|-
| 0x00
| UInt32
| Offset to Inst or Perc section relative to file beginning.
| Many entries can be found holding no offset (0x00000000). The position of an entry in this list defines the '''Program ID'''. It starts counting at 0.
|}

==Tools==
[https://github.com/XAYRGA/ibnktool ibnktool ] (edits IBNK) 
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts IBNK to SF2)

BMS (File Format)

2025-06-06T17:07:25Z

Louis Miles: Filestructure and more info

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Structure ==
BMS works very similar to Midi Format 2, with 16 channels (0-15), as well as a variety of possible independent tracks containing events such as notes, patch changes, etc..

In contrast to Midi, events are read linearly per channel in a data stream and interpreted byte by byte. This means that multiple tracks within the same channel cannot be played back synchronously and would therefore have to be baked onto one track. However, BMS tracks can jump or call to different places in the file, e.g. to loop the song or to ensure a very high storage efficiency.

BMS also includes extended MIDI operations, such as more powerful versions of controllers, with fade-in capability, and higher resolution control values. However, no song in either Galaxy game makes use of this.

=== Filestructure ===
There are no headers or filesize checks. The file usually starts with the following:
*'''Pointer to Channel Creator Events''' BMS always starts directly with a '''C1''' channel creator event with channel 0 containing pointer to the actual channel creator section.
*'''Tempo Track''' This usually starts with a PPQN set, and then with a track with BPM changes and loop events.
*'''Channel Creator Section''' This contains '''C1''' channel creator events for each channel. For some unknown reason, the exact same setting that follows the PPQN setting on the tempo track must be repeated here after the C1 events, otherwise some events such as pitchwheel will not work in the song.

== Data ==
BMS files contain raw instructions for the audio engine. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Creates a channel with a start pointer to a track with notes to be played. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#MAIN_BGM|When enabled in the SMR.szs]], channel 0 can be used for timing and chord usage and will not play any instruments from the soundbank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines Instrument and Soundbank to be used in a Track. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK bank whose sounds are to be used in a Track.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an IBNK bank. If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Trivia ==
* Many BMS filenames contain the suffix ''midi_cnv''. This could indicate that Midis were first converted to a (perhaps text-based) CNV file, which was then converted to the BMS format. A similar situation applies to Nintendo's SDK tool for converting the Nintendo DS's SSEQ sequence format, which first converts Midis to a text-based SMFT format, which is then converted to the final SSEQ format.

== Tools ==
[https://github.com/vgmtrans/vgmtrans VGMTrans] (analyses and converts BMS to MIDI) 
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-03T14:22:22Z

Louis Miles:

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Data ==
BMS files contain raw instructions for the audio engine. There are no headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines a start offset in the file to play.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Creates a channel with a start pointer to a track with notes to be played. Channel 15 is usually reserved for Yoshi Drums. [[SMR.szs#MAIN_BGM|When enabled in the SMR.szs]], channel 0 can be used for timing and chord usage and will not play any instruments from the soundbank.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines Instrument and Soundbank to be used in a Track. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK bank whose sounds are to be used in a Track.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an IBNK bank. If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Tools ==
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-06-03T14:18:45Z

Louis Miles: CIT info and more.

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Data ==
BMS files contain raw instructions for the audio engine. There are no headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
| JASSeqParser::parseNoteOn
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| JASSeqParser::cmdWaitByte
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
| JASSeqParser::parseNoteOff
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
| 81: Stop voice ID 1
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
| {OpCode[1]} {Target[1]} {Parameter[1]} OpCode: one byte, B8. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
| B8 00 64 B8: OpCode 00: Target (Volume) 64: ~78% volume
| Allows different operations onto the music track
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Target[1]} {Parameter[2]} OpCode: one byte, B9. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
| B9 01 04 00 B9: OpCode 01: Target (Pitch) 04 00: Pitch of 4 keys
| Allows different operations with higher precision onto the music track
|-
| BA
| JASSeqParser::cmdParamEI
| {OpCode[1]} {Target[1]} {Parameter[1]} {Fade time[2]} OpCode: one byte, BA. Target: one byte with range 0x00 through 0x03. Parameter: one byte with range 0x00 through 0xFF (Int8), whichs purpose depends on the target:
* Target 0: Volume. 0x7F = Full volume (100%), 0x00 = Silent (0%). 0x80 through 0xFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x01) or subtracting one (0xFF) increases/decreases pitch by one key, like from D#4 to E4.
* Target 2: Reverb. 0x7F = Strong reverb, 0x00 = no reverb. 0x80 through 0xFF are treated the same as no reverb.
* Target 3: Panning. 0x7F = right channel, 0x00 = center, 0x80 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 02 22 01 68 BA: OpCode 02: Target (Reverb) 22: Reverb of strength 34 01 68: 360 Ticks
| Allows different operations with fade time onto the music track
|-
| BB
| JASSeqParser::cmdParamII
| {OpCode[1]} {Target[1]} {Parameter[2]} {Fade time[2]} OpCode: one byte, BB. Target: one byte with range 0x00 through 0x03. Parameter: two bytes with range 0x0000 through 0xFFFF (Int16), whichs purpose depends on the target:
* Target 0: Volume. 0x7FFF = Full volume (100%), 0x0000 = Silent (0%). 0x8000 through 0xFFFF are treated the same as silence (0%).
* Target 1: Pitch. Adding one (0x0100) or subtracting one (0xFF00) increases/decreases pitch by one key, like from D#4 to E4. Values inbetween can be used for fine-tuning.
* Target 2: Reverb. 0x7FFF = Strong reverb, 0x0000 = no reverb. 0x8000 through 0xFFFF are treated the same as no reverb.
* Target 3: Panning. 0x7FFF = right channel, 0x0000 = center, 0x8000 = left channel.
Fade time: two bytes with range 0x0000 through 0xFFFF. The amount of time in ticks until the Parameter value is met.
| BA 03 7F FF 02 00 BB: OpCode 03: Target (Panning) 7F FF: Panned to right channel 02 00: 512 Ticks
| Allows different operations with higher precision and fade time onto the music track
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {ChannelNumber[1]} {TrackPointer[3]} OpCode: one byte, C1. ChannelNumber: one byte with range 0x00 through 0x0F. 0x00 = Channel 0, 0x0F = Channel 15. TrackPointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C1 04 05 B4 73 C1: OpCode 04: Channel 4 05 B4 73: Offset to track
| Creates a channel with a start pointer to a track with notes to be played. Channel 15 is usually reserved for Yoshi Drums.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D0
Source: One byte, 0-15 , source port
Destination: One byte, 0-32, destination register
|
| Imports the value from sequence port Source and writes it to destination register 'Destination', the value is also written to register 3
|-
| D1
| JASSeqParser::cmdWritePort
| {OpCode[1]} {Source[1]} {Destination[1]}
Opcode: One byte, D1
Source: One byte, source register, 0-32
Destination: One Byte, destination port, 0-15
|
| Writes the value in register 'Source' and saves it to register 3, as well as port 'Destination'
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
| {OpCode[1]} {AccessMode[1]} {Destination[1]} {Offset[3]} {Index[1]}
OpCode: One Byte, 0xDC
AccessMode: Determines how the sequence accesses the table.
Destination: 24-bit offset of table
Index: Register target index into table
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines Instrument and Soundbank to be used in a Track. A combination of E2 and E3.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK bank whose sounds are to be used in a Track.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the note scale to be used from the [[CIT]].
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Instrument Patch / Keyboard of an IBNK bank. If no E2 Bank Select Command was used before, it will default to Bank 0.
Timing Channel: If the track is on a channel for timing and chord usage, this command instead defines the ID of the chord to be used from the [[CIT]].
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
| {OpCode[1]} {Attack[2]} {Sustain[2]} {Decay[2]} {Amplitude[2]} {Release[2]} OpCode: one byte, E9. Attack: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-in in ticks. Sustain: two bytes with range 0x0000 through 0x7FFF. Define the duration for how long the wave is kept at maximum amplitude in ticks. Decay: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade between maximum and controlled amplitude in ticks. Amplitude: two bytes with range 0x0000 through 0x7FFF. Define the volume of the wave for the 2nd sustain duration. Release: two bytes with range 0x0000 through 0x7FFF. Define the duration of fade-out in ticks. If Amplitude is set to 0x7FFF, Sustain and Decay won't have an audible effect to the wave. The Attack, Decay and Release operations affect the volume of the wave linearly.
| E9 00 80 01 00 00 80 5F FF 00 3C E9: OpCode 00 80: Attack (fade-in) for 128 ticks 01 00: Sustain for 256 ticks 00 80: Decay for 128 ticks 5F FF: Amplitude of 75% compared to maximum 00 3C: Release (fade-out) for 60 ticks
| Perform ADSR operations on a key. Must be placed before the actual key presses. [https://cdn.discordapp.com/attachments/1361554635369873490/1376201837237239899/image.png?ex=68347756&is=683325d6&hm=10661c473bb1ecb6187a17baafbc22c7d8af0a59cb0ceb87d7c85f42a8fee54c See this image for a visual representation of the ADSR operations].
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
| {OpCode[1]} {WaitTime[1]}
Waits for WaitTime ticks
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length, ending with <code>\n</code>. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 5C 6E 00 FD: OpCode 48 65 6C 6C 6F 5C 6E: "Hello\n" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Tools ==
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

SMR.szs

2025-06-03T14:00:49Z

Louis Miles: /* MAIN_BGM */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

'''SMR.szs''' is a compressed '''BAA''' file ('''B'''inary '''A'''udio '''A'''rchive) which defines the game's sound system. It contains references to [[AST (File Format)|streamed]] and [[BMS (File Format)|sequenced]] music files as well as data for sound effects and instruments. It can be found in various JAudio games, however the specifications below mainly apply to ''Super Mario Galaxy'' and ''Super Mario Galaxy 2''. 
 
The following files are directly linked to SMR.szs:
* [[BgmParam|AudioRes/Info/BgmParam.arc]] (SMG2 only, overrides the BGM and STM volume parameter)
* [[CIT (File Format)|AudioRes/Info/JaiChord.arc]] (SMR.szs links BGM labels to CIT file IDs within this archive)
* [[BMS (File Format)|AudioRes/Seqs/JaiSeq.arc]] (SMR.szs links BGM labels to BMS file IDs within this archive)
* [[AST (File Format)|AudioRes/Stream/*.ast]] (SMR.szs links STM labels to AST files)
* [[AW (File Format)|AudioRes/Waves/*.aw]] (SMR.szs defines the contents of AW files)

The following files are indirectly linked to SMR.szs:
* [[ActionSound|AudioRes/Info/ActionSound.arc]] (SMG2 only, links hardcoded triggers for all objects to sound effects in SMR.szs)
* AudioRes/Info/JaiMe.arc (References instruments from SMR.szs)
* [[BRS (File Format)|AudioRes/Info/JaiRemixSeq.arc]] (References instruments from SMR.szs)
* [[MultiBgmInfo|AudioRes/Info/MultiBgmInfo.arc]] (SMG2 only, connects MBGM labels to STM and BGM labels, allowing streamed and sequenced audio to play simultaneously)
* [[SoundIdToInstList|AudioRes/Info/SoundIdToInstList]] (SMG2 only, references Sound IDs and instruments from SMR.szs and allows loading AW files)
* AudioRes/Info/StageBgmInfo.arc (SMG2 only, controls the [[ScenarioBgmInfo|main music]] and [[StageBgmInfo|music changes]] for all stages) 

==Header==
The header contains offsets to all files included in SMR.szs:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>AA_<</code> (0x41415F3C)
|-
| 0x04
| Magic (0x4)
| <code>bst </code> (0x62737420)
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BST|BST]] section start
|-
| 0x0C
| UInt32 (0x4)
| Offset to BST section end
|-
| 0x10
| Magic (0x4)
| <code>bstn</code> (0x6273746E)
|-
| 0x14
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN|BSTN]] section start
|-
| 0x18
| UInt32 (0x4)
| Offset to BSTN section end
|-
| 0x1C
| Magic (0x4)
| <code>bsc </code> (0x62736320)
|-
| 0x20
| UInt32 (0x4)
| Offset to [[SMR.szs#BSC|BSC]] section start
|-
| 0x24
| UInt32 (0x4)
| Offset to BSC section end
|-
| 0x28 + N * 0x10
| Magic (0x4)
| <code>ws </code> (0x77732020)
|-
| 0x28 + N * 0x10 + 0x4
| UInt32 (0x4)
| WSYS file ID (N)
|-
| 0x28 + N * 0x10 + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#WSYS|WSYS]] file
|-
| 0x28 + N * 0x10 + 0xC
| UInt32 (0x4)
| Unknown (mostly 0x00000000, once seen as 0xFFFFFFFF)
|-
| 0x38 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>bnk </code> (0x626E6B20)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x4
| UInt32 (0x4)
| IBNK file ID (M)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#IBNK|IBNK]] file
|-
| 0x44 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>>_AA</code> (0x3E5F4141)
|}

==BST==
The '''B'''inary '''S'''ound '''T'''able contains parameters for all music and sound effects
===BST Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BST </code> (0x42535420)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BST main table|BST main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BST main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE table|SE table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM table|BGM table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM table|STREAM table]]
|}

===SE table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to SYSTEM table
|-
| 0x08
| UInt32 (0x4)
| Offset to PLAYER_VOICE table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_MOTION table
|-
| 0x10
| UInt32 (0x4)
| Offset to BOSS_VOICE table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_MOTION table
|-
| 0x18
| UInt32 (0x4)
| Offset to OBJECT table
|-
| 0x1C
| UInt32 (0x4)
| Offset to ATMOSPHERE table
|-
| 0x20
| UInt32 (0x4)
| Offset to DEMO table
|-
| 0x24
| UInt32 (0x4)
| Offset to ENEMY_VOICE table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_MOTION table
|-
| 0x2C
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION table
|-
| 0x34
| UInt32 (0x4)
| Offset to REMIX_SEQ table
|-
| 0x38
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE parameter table|SE parameter table]].

===BGM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to MAIN_BGM table
|-
| 0x08
| UInt32 (0x4)
| Offset to MULTI_BGM table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM parameter table|BGM parameter table]].

===STREAM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM parameter table|STREAM parameter table]]
|}

===SE parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x50
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#SE parameters|SE parameters]]
|}

====SE parameters====
size: 0x6 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown
|-
| 0x1
| UInt8 (0x1)
| Volume. Can be overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt8 (0x1)
| Unknown
|-
| 0x3
| UInt8 (0x1)
| Unknown
|-
| 0x4
| UInt8 (0x1)
| Unknown
|-
| 0x5
| UInt8 (0x1)
| Unknown
|}

===BGM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x60
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#BGM parameters|BGM parameters]]
|}

====BGM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description for MAIN_BGM
! Description for MULTI_BGM
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x70
| Unknown. Always 0x70
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
| Unknown. Always 0x78
|-
| 0x2
| UInt16 (0x2)
| JaiSeq.arc file ID. Must always be valid.
| Unknown. Always 0x0000
|-
| 0x4
| UInt16 (0x2)
| JaiChord.arc file ID. 0xFFFF if no JaiChord file is set.
| Unknown. Always 0xFFFF
|-
| 0x6
| UInt16 (0x2)
| Unknown. Seen as 0x0000 and 0x0001.
| Unknown. Always 0x0000
|}

===STREAM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x70
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#STREAM parameters|STREAM parameters]]
|}

====STREAM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x80
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt16 (0x2)
| Channel count. 0x000E for 2 channels, 0x00EE for 4 channels
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated AST filename, relative to the root of the ISO. Example: <code>/AudioRes/Stream/smg2_ev_starchance_strm.ast</code>
|}

The rest of the BST section is padded to the nearest 0x20.

==BSTN==
The '''B'''inary '''S'''ound '''T'''able '''N'''ames section contains labels for all music and sound effects
===BSTN Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BSTN</code> (0x4253544E)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN main table|BSTN main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BSTN main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE names table|SE names table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM names table|BGM names table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM names table|STREAM names table]]
|}

===SE names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Sound Effect name. Points to <code>SE</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE names table
|-
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION names table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE names table
|-
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION names table
|-
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT names table
|-
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE names table
|-
| 0x24
| UInt32 (0x4)
| Offset to DEMO names table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE names table
|-
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION names table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE names table
|-
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION names table
|-
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ names table
|-
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE name offset table|SE name offset table]].

===BGM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Background Music name. Points to <code>BGM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to MAIN_BGM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to MULTI_BGM names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM name offset table|BGM name offset table]].

===STREAM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Stream Music name. Points to <code>STREAM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM name offset table|STREAM name offset table]]
|}

===SE name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect category name. Examples: <code>SYSTEM</code>, <code>PLAYER_VOICE</code> etc.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect name. Examples: <code>SE_SY_COIN</code>, <code>SE_PV_JUMP_S</code> etc.
|}

===BGM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music category name, like <code>MAIN_BGM</code> or <code>MULTI_BGM</code>.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music name. Examples: <code>BGM_MISS</code>, <code>MBGM_STAR_CHANCE</code> etc.
|}

===STREAM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music category name. Simply <code>0</code> in SMG and SMG2
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music name. Examples: <code>STM_STAR_CHANCE</code>, <code>STM_SMG_GALAXY_01</code> etc.
|}

The rest of the BSTN section is padded to the nearest 0x20.

==BSC==
The '''B'''inary '''S'''equence '''C'''ollection section (often referred to as '''SC section''') defines the playback of all sound effects via [[BMS (File Format)|BMS]] data.

===BSC Header===
size: N * 0x4 + 0x8
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x2)
| <code>SC</code> (0x5343)
|-
| 0x02
| UInt16 (0x2)
| Amount N of sound categories (0x0E in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| BSC section size
|- style="vertical-align:bottom;"
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM offset table
|- style="vertical-align:bottom;"
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE offset table
|- style="vertical-align:bottom;"
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION offset table
|- style="vertical-align:bottom;"
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT offset table
|- style="vertical-align:bottom;"
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE offset table
|- style="vertical-align:bottom;"
| 0x24
| UInt32 (0x4)
| Offset to DEMO offset table
|- style="vertical-align:bottom;"
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE offset table
|- style="vertical-align:bottom;"
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION offset table
|- style="vertical-align:bottom;"
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ offset table
|- style="vertical-align:bottom;"
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU offset table
|}

Each of the referenced tables are defined identically, see [[SMR.szs#BSC offset table|BSC offset table]].

===BSC offset table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4 + N * 0x4
| UInt32 (0x4)
| Offset to BMS data
|}

Inbetween tables is the BMS data that makes up all of the sound effects. The BSC section is basically structured like this:
{| class="wikitable"
|-
! BSC
! Contents
|-
| BSC Header
| Offsets to [CATEGORY] offset tables
|-
| Main BMS controller
| BMS data thats mandatory for all sound effects. Its stored once at the beginning of the file to reduce filesize
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the first sound category (SYSTEM)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the second sound category (PLAYER_VOICE)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| ...
| ...
|}

===BSC optimizations===
Despite using the same data that BMS files use, the BSC section optimizes a lot of them. Here are some notable ones:
{| class="wikitable"
|-
! BMS files
! BSC section
|-
| Use E2 + E3 to define an instrument. Takes 0x4 bytes in total
| Use E1 to define an instrument. Takes 0x3 bytes in total
|-
| Close all tracks with FF, even tracks that end with a C7 loop
| Omit use of FF when the last operation in a track is C7
|-
| Define playback speed with D8 and E0 for each BMS file individually
| Define playback speed with EA and D8 once. Every sound effect references this with a C3 jump, reducing the filesize by a lot as opposed to defining the playback speed individually for each sound effect
|-
| no equivalent
| All dummy sounds point to offset 0x6B, which holds FF instead of defining FF for all dummies individually
|-
| OpenTrack with voices 1-7, wait with F0 and shut voices with the 8X operator. Takes up 0x6 bytes minimum
| OpenTrack with voice 0, which enables a Midi gate. This only needs 0x4 bytes to define a sound/key and how long its supposed to last
|}

==WSYS==
'''W'''ave '''Sys'''tem. See [[WSYS]]

==IBNK==
'''I'''nstrument '''B'''a'''nk'''. See [[IBNK]]

==Editing SMR.szs==
'''The following section contains instructions for editing SMR.szs with the SoundModdingToolkit. They do not contain specifications for the file itself.'''

The tool [https://xayr.gay/tools/SoundModdingToolkit/ SoundModdingToolkit] can convert this file into a clear and readable file structure, so the structure of the file is shown on this page using the tool's converted structure.

'''Please note that only version 4.1.0 can edit the lists without any problems. Later versions can lead to problems such as muted songs.'''

===BGM===
====MAIN_BGM====
Found in ''SoundTable/BGM/libraries/MAIN_BGM.json'' 
Defines the sequenced music. The music sequence files can be found in bms format in ''AudioRes/Seqs/JaiSeq.arc''.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
|
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| unk3
| File ID of the bms file in JaiSeq.arc to use (the filename is ignored)
|-
| unk4
| File ID of the cit file in JaiChord.arc to use (the filename is ignored)-1 = No CIT/chord
|-
| unk5
| Whether BMS channel 0 should be used for timing and chord usage for [[CIT (File Format)|chords]] or not..0 = False, 1 = True
|-
| type
|
|-
| mOffset
|
|-
| NameOffset
|
|-
| name
| Internal mapping name for this sequence (e.g. "BGM_MISS"). This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

====MULTI_BGM====
Found in ''SoundTable/BGM/libraries/MULTI_BGM.json'' 
Defines settings about Multi BGM such as its name. Multi BGM combines Stream (STM) and sequential Music (BGM). Which Music is set for each Multi BGM is defined in [[MultiBgmInfo]].

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 112
|-
| unk2
| ? always 120
|-
| unk3
| ? always 0
|-
| unk4
| ? always -1
|-
| unk5
| ? always 0
|-
| type
| ? always 96
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this entry (e.g. "MBGM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===STREAM===
Found in ''SoundTable/STREAM/0.json''
Defines the streamed ast audio files including its internal STM name as well as its filepath.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| streamType
| Stream Type 14: Standard Stream (2 Channels) 238: Multi Stream (4 Channels)
|-
| streamPath
| Filepath of the AST file to use (e.g. "/AudioRes/Stream/smg2_ev_starchance_strm.ast")
|-
| type
| ? always 112
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this song (e.g. "STM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===SE===
====AW====
Each aw. file is converted by the tool into a folder that has the ID of the aw file in its name, and besides the sound files converted in wav format, contains the following settings for each sound:
*'''manifest.json''' Contains the ID and name of the aw file
*'''wavetable.json''' Contains settings for each sound of the aw. file

=====wavetable=====
Each entry starts with the name of the Wav file (e.g. "31") followed by its settings:
{| class="wikitable"
|-
! Name
! Description
|-
| format
| ? always 0
|-
| key
|
|-
| sampleRate
| The sample rate at which the sound should be played. (e.g. "22050.0") 
|-
| sampleCount
| Length of the sound in samples
|-
| loop
| Whether it should be looped or not '''true:''' loop '''false:''' do not loop
|-
| loop_start
| Loop Start position in samples.
|-
| loop_end
| Loop End position in samples.
|-
| last
|
|-
| penult
|
|}

====Libraries====
In ''SoundTable\SE\libraries\'' there are several libraries which contain settings for sounds with their internal assigned names.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
|
|-
| unk3
|
|-
| unk4
|
|-
| unk5
|
|-
| unk6
|
|-
| type
| Always 80
|-
| mOffset
|
|-
| NameOffset
| ? Always 0
|-
| name
| Internal Name of the soundeffect (e.g. "SE_SV_LV_YOSHI_FLUTTER")
|}

SMR.szs

2025-06-03T14:00:08Z

Louis Miles: /* MAIN_BGM */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

'''SMR.szs''' is a compressed '''BAA''' file ('''B'''inary '''A'''udio '''A'''rchive) which defines the game's sound system. It contains references to [[AST (File Format)|streamed]] and [[BMS (File Format)|sequenced]] music files as well as data for sound effects and instruments. It can be found in various JAudio games, however the specifications below mainly apply to ''Super Mario Galaxy'' and ''Super Mario Galaxy 2''. 
 
The following files are directly linked to SMR.szs:
* [[BgmParam|AudioRes/Info/BgmParam.arc]] (SMG2 only, overrides the BGM and STM volume parameter)
* [[CIT (File Format)|AudioRes/Info/JaiChord.arc]] (SMR.szs links BGM labels to CIT file IDs within this archive)
* [[BMS (File Format)|AudioRes/Seqs/JaiSeq.arc]] (SMR.szs links BGM labels to BMS file IDs within this archive)
* [[AST (File Format)|AudioRes/Stream/*.ast]] (SMR.szs links STM labels to AST files)
* [[AW (File Format)|AudioRes/Waves/*.aw]] (SMR.szs defines the contents of AW files)

The following files are indirectly linked to SMR.szs:
* [[ActionSound|AudioRes/Info/ActionSound.arc]] (SMG2 only, links hardcoded triggers for all objects to sound effects in SMR.szs)
* AudioRes/Info/JaiMe.arc (References instruments from SMR.szs)
* [[BRS (File Format)|AudioRes/Info/JaiRemixSeq.arc]] (References instruments from SMR.szs)
* [[MultiBgmInfo|AudioRes/Info/MultiBgmInfo.arc]] (SMG2 only, connects MBGM labels to STM and BGM labels, allowing streamed and sequenced audio to play simultaneously)
* [[SoundIdToInstList|AudioRes/Info/SoundIdToInstList]] (SMG2 only, references Sound IDs and instruments from SMR.szs and allows loading AW files)
* AudioRes/Info/StageBgmInfo.arc (SMG2 only, controls the [[ScenarioBgmInfo|main music]] and [[StageBgmInfo|music changes]] for all stages) 

==Header==
The header contains offsets to all files included in SMR.szs:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>AA_<</code> (0x41415F3C)
|-
| 0x04
| Magic (0x4)
| <code>bst </code> (0x62737420)
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BST|BST]] section start
|-
| 0x0C
| UInt32 (0x4)
| Offset to BST section end
|-
| 0x10
| Magic (0x4)
| <code>bstn</code> (0x6273746E)
|-
| 0x14
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN|BSTN]] section start
|-
| 0x18
| UInt32 (0x4)
| Offset to BSTN section end
|-
| 0x1C
| Magic (0x4)
| <code>bsc </code> (0x62736320)
|-
| 0x20
| UInt32 (0x4)
| Offset to [[SMR.szs#BSC|BSC]] section start
|-
| 0x24
| UInt32 (0x4)
| Offset to BSC section end
|-
| 0x28 + N * 0x10
| Magic (0x4)
| <code>ws </code> (0x77732020)
|-
| 0x28 + N * 0x10 + 0x4
| UInt32 (0x4)
| WSYS file ID (N)
|-
| 0x28 + N * 0x10 + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#WSYS|WSYS]] file
|-
| 0x28 + N * 0x10 + 0xC
| UInt32 (0x4)
| Unknown (mostly 0x00000000, once seen as 0xFFFFFFFF)
|-
| 0x38 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>bnk </code> (0x626E6B20)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x4
| UInt32 (0x4)
| IBNK file ID (M)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#IBNK|IBNK]] file
|-
| 0x44 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>>_AA</code> (0x3E5F4141)
|}

==BST==
The '''B'''inary '''S'''ound '''T'''able contains parameters for all music and sound effects
===BST Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BST </code> (0x42535420)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BST main table|BST main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BST main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE table|SE table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM table|BGM table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM table|STREAM table]]
|}

===SE table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to SYSTEM table
|-
| 0x08
| UInt32 (0x4)
| Offset to PLAYER_VOICE table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_MOTION table
|-
| 0x10
| UInt32 (0x4)
| Offset to BOSS_VOICE table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_MOTION table
|-
| 0x18
| UInt32 (0x4)
| Offset to OBJECT table
|-
| 0x1C
| UInt32 (0x4)
| Offset to ATMOSPHERE table
|-
| 0x20
| UInt32 (0x4)
| Offset to DEMO table
|-
| 0x24
| UInt32 (0x4)
| Offset to ENEMY_VOICE table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_MOTION table
|-
| 0x2C
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION table
|-
| 0x34
| UInt32 (0x4)
| Offset to REMIX_SEQ table
|-
| 0x38
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE parameter table|SE parameter table]].

===BGM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to MAIN_BGM table
|-
| 0x08
| UInt32 (0x4)
| Offset to MULTI_BGM table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM parameter table|BGM parameter table]].

===STREAM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM parameter table|STREAM parameter table]]
|}

===SE parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x50
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#SE parameters|SE parameters]]
|}

====SE parameters====
size: 0x6 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown
|-
| 0x1
| UInt8 (0x1)
| Volume. Can be overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt8 (0x1)
| Unknown
|-
| 0x3
| UInt8 (0x1)
| Unknown
|-
| 0x4
| UInt8 (0x1)
| Unknown
|-
| 0x5
| UInt8 (0x1)
| Unknown
|}

===BGM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x60
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#BGM parameters|BGM parameters]]
|}

====BGM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description for MAIN_BGM
! Description for MULTI_BGM
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x70
| Unknown. Always 0x70
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
| Unknown. Always 0x78
|-
| 0x2
| UInt16 (0x2)
| JaiSeq.arc file ID. Must always be valid.
| Unknown. Always 0x0000
|-
| 0x4
| UInt16 (0x2)
| JaiChord.arc file ID. 0xFFFF if no JaiChord file is set.
| Unknown. Always 0xFFFF
|-
| 0x6
| UInt16 (0x2)
| Unknown. Seen as 0x0000 and 0x0001.
| Unknown. Always 0x0000
|}

===STREAM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x70
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#STREAM parameters|STREAM parameters]]
|}

====STREAM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x80
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt16 (0x2)
| Channel count. 0x000E for 2 channels, 0x00EE for 4 channels
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated AST filename, relative to the root of the ISO. Example: <code>/AudioRes/Stream/smg2_ev_starchance_strm.ast</code>
|}

The rest of the BST section is padded to the nearest 0x20.

==BSTN==
The '''B'''inary '''S'''ound '''T'''able '''N'''ames section contains labels for all music and sound effects
===BSTN Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BSTN</code> (0x4253544E)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN main table|BSTN main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BSTN main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE names table|SE names table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM names table|BGM names table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM names table|STREAM names table]]
|}

===SE names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Sound Effect name. Points to <code>SE</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE names table
|-
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION names table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE names table
|-
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION names table
|-
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT names table
|-
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE names table
|-
| 0x24
| UInt32 (0x4)
| Offset to DEMO names table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE names table
|-
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION names table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE names table
|-
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION names table
|-
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ names table
|-
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE name offset table|SE name offset table]].

===BGM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Background Music name. Points to <code>BGM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to MAIN_BGM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to MULTI_BGM names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM name offset table|BGM name offset table]].

===STREAM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Stream Music name. Points to <code>STREAM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM name offset table|STREAM name offset table]]
|}

===SE name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect category name. Examples: <code>SYSTEM</code>, <code>PLAYER_VOICE</code> etc.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect name. Examples: <code>SE_SY_COIN</code>, <code>SE_PV_JUMP_S</code> etc.
|}

===BGM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music category name, like <code>MAIN_BGM</code> or <code>MULTI_BGM</code>.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music name. Examples: <code>BGM_MISS</code>, <code>MBGM_STAR_CHANCE</code> etc.
|}

===STREAM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music category name. Simply <code>0</code> in SMG and SMG2
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music name. Examples: <code>STM_STAR_CHANCE</code>, <code>STM_SMG_GALAXY_01</code> etc.
|}

The rest of the BSTN section is padded to the nearest 0x20.

==BSC==
The '''B'''inary '''S'''equence '''C'''ollection section (often referred to as '''SC section''') defines the playback of all sound effects via [[BMS (File Format)|BMS]] data.

===BSC Header===
size: N * 0x4 + 0x8
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x2)
| <code>SC</code> (0x5343)
|-
| 0x02
| UInt16 (0x2)
| Amount N of sound categories (0x0E in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| BSC section size
|- style="vertical-align:bottom;"
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM offset table
|- style="vertical-align:bottom;"
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE offset table
|- style="vertical-align:bottom;"
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION offset table
|- style="vertical-align:bottom;"
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT offset table
|- style="vertical-align:bottom;"
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE offset table
|- style="vertical-align:bottom;"
| 0x24
| UInt32 (0x4)
| Offset to DEMO offset table
|- style="vertical-align:bottom;"
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE offset table
|- style="vertical-align:bottom;"
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION offset table
|- style="vertical-align:bottom;"
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ offset table
|- style="vertical-align:bottom;"
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU offset table
|}

Each of the referenced tables are defined identically, see [[SMR.szs#BSC offset table|BSC offset table]].

===BSC offset table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4 + N * 0x4
| UInt32 (0x4)
| Offset to BMS data
|}

Inbetween tables is the BMS data that makes up all of the sound effects. The BSC section is basically structured like this:
{| class="wikitable"
|-
! BSC
! Contents
|-
| BSC Header
| Offsets to [CATEGORY] offset tables
|-
| Main BMS controller
| BMS data thats mandatory for all sound effects. Its stored once at the beginning of the file to reduce filesize
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the first sound category (SYSTEM)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the second sound category (PLAYER_VOICE)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| ...
| ...
|}

===BSC optimizations===
Despite using the same data that BMS files use, the BSC section optimizes a lot of them. Here are some notable ones:
{| class="wikitable"
|-
! BMS files
! BSC section
|-
| Use E2 + E3 to define an instrument. Takes 0x4 bytes in total
| Use E1 to define an instrument. Takes 0x3 bytes in total
|-
| Close all tracks with FF, even tracks that end with a C7 loop
| Omit use of FF when the last operation in a track is C7
|-
| Define playback speed with D8 and E0 for each BMS file individually
| Define playback speed with EA and D8 once. Every sound effect references this with a C3 jump, reducing the filesize by a lot as opposed to defining the playback speed individually for each sound effect
|-
| no equivalent
| All dummy sounds point to offset 0x6B, which holds FF instead of defining FF for all dummies individually
|-
| OpenTrack with voices 1-7, wait with F0 and shut voices with the 8X operator. Takes up 0x6 bytes minimum
| OpenTrack with voice 0, which enables a Midi gate. This only needs 0x4 bytes to define a sound/key and how long its supposed to last
|}

==WSYS==
'''W'''ave '''Sys'''tem. See [[WSYS]]

==IBNK==
'''I'''nstrument '''B'''a'''nk'''. See [[IBNK]]

==Editing SMR.szs==
'''The following section contains instructions for editing SMR.szs with the SoundModdingToolkit. They do not contain specifications for the file itself.'''

The tool [https://xayr.gay/tools/SoundModdingToolkit/ SoundModdingToolkit] can convert this file into a clear and readable file structure, so the structure of the file is shown on this page using the tool's converted structure.

'''Please note that only version 4.1.0 can edit the lists without any problems. Later versions can lead to problems such as muted songs.'''

===BGM===
====MAIN_BGM====
Found in ''SoundTable/BGM/libraries/MAIN_BGM.json'' 
Defines the sequenced music. The music sequence files can be found in bms format in ''AudioRes/Seqs/JaiSeq.arc''.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
|
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| unk3
| File ID of the bms file in JaiSeq.arc to use (the filename is ignored)
|-
| unk4
| File ID of the cit file in JaiChord.arc to use (the filename is ignored)-1 = No CIT/chord
|-
| unk5
| Whether BMS channel 0 should be used as a timing channel for [[CIT (File Format)|chords]] or not..0 = False, 1 = True
|-
| type
|
|-
| mOffset
|
|-
| NameOffset
|
|-
| name
| Internal mapping name for this sequence (e.g. "BGM_MISS"). This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

====MULTI_BGM====
Found in ''SoundTable/BGM/libraries/MULTI_BGM.json'' 
Defines settings about Multi BGM such as its name. Multi BGM combines Stream (STM) and sequential Music (BGM). Which Music is set for each Multi BGM is defined in [[MultiBgmInfo]].

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 112
|-
| unk2
| ? always 120
|-
| unk3
| ? always 0
|-
| unk4
| ? always -1
|-
| unk5
| ? always 0
|-
| type
| ? always 96
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this entry (e.g. "MBGM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===STREAM===
Found in ''SoundTable/STREAM/0.json''
Defines the streamed ast audio files including its internal STM name as well as its filepath.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| streamType
| Stream Type 14: Standard Stream (2 Channels) 238: Multi Stream (4 Channels)
|-
| streamPath
| Filepath of the AST file to use (e.g. "/AudioRes/Stream/smg2_ev_starchance_strm.ast")
|-
| type
| ? always 112
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this song (e.g. "STM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===SE===
====AW====
Each aw. file is converted by the tool into a folder that has the ID of the aw file in its name, and besides the sound files converted in wav format, contains the following settings for each sound:
*'''manifest.json''' Contains the ID and name of the aw file
*'''wavetable.json''' Contains settings for each sound of the aw. file

=====wavetable=====
Each entry starts with the name of the Wav file (e.g. "31") followed by its settings:
{| class="wikitable"
|-
! Name
! Description
|-
| format
| ? always 0
|-
| key
|
|-
| sampleRate
| The sample rate at which the sound should be played. (e.g. "22050.0") 
|-
| sampleCount
| Length of the sound in samples
|-
| loop
| Whether it should be looped or not '''true:''' loop '''false:''' do not loop
|-
| loop_start
| Loop Start position in samples.
|-
| loop_end
| Loop End position in samples.
|-
| last
|
|-
| penult
|
|}

====Libraries====
In ''SoundTable\SE\libraries\'' there are several libraries which contain settings for sounds with their internal assigned names.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
|
|-
| unk3
|
|-
| unk4
|
|-
| unk5
|
|-
| unk6
|
|-
| type
| Always 80
|-
| mOffset
|
|-
| NameOffset
| ? Always 0
|-
| name
| Internal Name of the soundeffect (e.g. "SE_SV_LV_YOSHI_FLUTTER")
|}

SMR.szs

2025-06-03T13:58:34Z

Louis Miles: /* MAIN_BGM */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

'''SMR.szs''' is a compressed '''BAA''' file ('''B'''inary '''A'''udio '''A'''rchive) which defines the game's sound system. It contains references to [[AST (File Format)|streamed]] and [[BMS (File Format)|sequenced]] music files as well as data for sound effects and instruments. It can be found in various JAudio games, however the specifications below mainly apply to ''Super Mario Galaxy'' and ''Super Mario Galaxy 2''. 
 
The following files are directly linked to SMR.szs:
* [[BgmParam|AudioRes/Info/BgmParam.arc]] (SMG2 only, overrides the BGM and STM volume parameter)
* [[CIT (File Format)|AudioRes/Info/JaiChord.arc]] (SMR.szs links BGM labels to CIT file IDs within this archive)
* [[BMS (File Format)|AudioRes/Seqs/JaiSeq.arc]] (SMR.szs links BGM labels to BMS file IDs within this archive)
* [[AST (File Format)|AudioRes/Stream/*.ast]] (SMR.szs links STM labels to AST files)
* [[AW (File Format)|AudioRes/Waves/*.aw]] (SMR.szs defines the contents of AW files)

The following files are indirectly linked to SMR.szs:
* [[ActionSound|AudioRes/Info/ActionSound.arc]] (SMG2 only, links hardcoded triggers for all objects to sound effects in SMR.szs)
* AudioRes/Info/JaiMe.arc (References instruments from SMR.szs)
* [[BRS (File Format)|AudioRes/Info/JaiRemixSeq.arc]] (References instruments from SMR.szs)
* [[MultiBgmInfo|AudioRes/Info/MultiBgmInfo.arc]] (SMG2 only, connects MBGM labels to STM and BGM labels, allowing streamed and sequenced audio to play simultaneously)
* [[SoundIdToInstList|AudioRes/Info/SoundIdToInstList]] (SMG2 only, references Sound IDs and instruments from SMR.szs and allows loading AW files)
* AudioRes/Info/StageBgmInfo.arc (SMG2 only, controls the [[ScenarioBgmInfo|main music]] and [[StageBgmInfo|music changes]] for all stages) 

==Header==
The header contains offsets to all files included in SMR.szs:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>AA_<</code> (0x41415F3C)
|-
| 0x04
| Magic (0x4)
| <code>bst </code> (0x62737420)
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BST|BST]] section start
|-
| 0x0C
| UInt32 (0x4)
| Offset to BST section end
|-
| 0x10
| Magic (0x4)
| <code>bstn</code> (0x6273746E)
|-
| 0x14
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN|BSTN]] section start
|-
| 0x18
| UInt32 (0x4)
| Offset to BSTN section end
|-
| 0x1C
| Magic (0x4)
| <code>bsc </code> (0x62736320)
|-
| 0x20
| UInt32 (0x4)
| Offset to [[SMR.szs#BSC|BSC]] section start
|-
| 0x24
| UInt32 (0x4)
| Offset to BSC section end
|-
| 0x28 + N * 0x10
| Magic (0x4)
| <code>ws </code> (0x77732020)
|-
| 0x28 + N * 0x10 + 0x4
| UInt32 (0x4)
| WSYS file ID (N)
|-
| 0x28 + N * 0x10 + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#WSYS|WSYS]] file
|-
| 0x28 + N * 0x10 + 0xC
| UInt32 (0x4)
| Unknown (mostly 0x00000000, once seen as 0xFFFFFFFF)
|-
| 0x38 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>bnk </code> (0x626E6B20)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x4
| UInt32 (0x4)
| IBNK file ID (M)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#IBNK|IBNK]] file
|-
| 0x44 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>>_AA</code> (0x3E5F4141)
|}

==BST==
The '''B'''inary '''S'''ound '''T'''able contains parameters for all music and sound effects
===BST Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BST </code> (0x42535420)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BST main table|BST main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BST main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE table|SE table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM table|BGM table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM table|STREAM table]]
|}

===SE table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to SYSTEM table
|-
| 0x08
| UInt32 (0x4)
| Offset to PLAYER_VOICE table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_MOTION table
|-
| 0x10
| UInt32 (0x4)
| Offset to BOSS_VOICE table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_MOTION table
|-
| 0x18
| UInt32 (0x4)
| Offset to OBJECT table
|-
| 0x1C
| UInt32 (0x4)
| Offset to ATMOSPHERE table
|-
| 0x20
| UInt32 (0x4)
| Offset to DEMO table
|-
| 0x24
| UInt32 (0x4)
| Offset to ENEMY_VOICE table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_MOTION table
|-
| 0x2C
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION table
|-
| 0x34
| UInt32 (0x4)
| Offset to REMIX_SEQ table
|-
| 0x38
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE parameter table|SE parameter table]].

===BGM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to MAIN_BGM table
|-
| 0x08
| UInt32 (0x4)
| Offset to MULTI_BGM table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM parameter table|BGM parameter table]].

===STREAM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM parameter table|STREAM parameter table]]
|}

===SE parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x50
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#SE parameters|SE parameters]]
|}

====SE parameters====
size: 0x6 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown
|-
| 0x1
| UInt8 (0x1)
| Volume. Can be overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt8 (0x1)
| Unknown
|-
| 0x3
| UInt8 (0x1)
| Unknown
|-
| 0x4
| UInt8 (0x1)
| Unknown
|-
| 0x5
| UInt8 (0x1)
| Unknown
|}

===BGM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x60
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#BGM parameters|BGM parameters]]
|}

====BGM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description for MAIN_BGM
! Description for MULTI_BGM
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x70
| Unknown. Always 0x70
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
| Unknown. Always 0x78
|-
| 0x2
| UInt16 (0x2)
| JaiSeq.arc file ID. Must always be valid.
| Unknown. Always 0x0000
|-
| 0x4
| UInt16 (0x2)
| JaiChord.arc file ID. 0xFFFF if no JaiChord file is set.
| Unknown. Always 0xFFFF
|-
| 0x6
| UInt16 (0x2)
| Unknown. Seen as 0x0000 and 0x0001.
| Unknown. Always 0x0000
|}

===STREAM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x70
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#STREAM parameters|STREAM parameters]]
|}

====STREAM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x80
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt16 (0x2)
| Channel count. 0x000E for 2 channels, 0x00EE for 4 channels
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated AST filename, relative to the root of the ISO. Example: <code>/AudioRes/Stream/smg2_ev_starchance_strm.ast</code>
|}

The rest of the BST section is padded to the nearest 0x20.

==BSTN==
The '''B'''inary '''S'''ound '''T'''able '''N'''ames section contains labels for all music and sound effects
===BSTN Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BSTN</code> (0x4253544E)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN main table|BSTN main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BSTN main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE names table|SE names table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM names table|BGM names table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM names table|STREAM names table]]
|}

===SE names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Sound Effect name. Points to <code>SE</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE names table
|-
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION names table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE names table
|-
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION names table
|-
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT names table
|-
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE names table
|-
| 0x24
| UInt32 (0x4)
| Offset to DEMO names table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE names table
|-
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION names table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE names table
|-
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION names table
|-
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ names table
|-
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE name offset table|SE name offset table]].

===BGM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Background Music name. Points to <code>BGM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to MAIN_BGM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to MULTI_BGM names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM name offset table|BGM name offset table]].

===STREAM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Stream Music name. Points to <code>STREAM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM name offset table|STREAM name offset table]]
|}

===SE name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect category name. Examples: <code>SYSTEM</code>, <code>PLAYER_VOICE</code> etc.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect name. Examples: <code>SE_SY_COIN</code>, <code>SE_PV_JUMP_S</code> etc.
|}

===BGM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music category name, like <code>MAIN_BGM</code> or <code>MULTI_BGM</code>.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music name. Examples: <code>BGM_MISS</code>, <code>MBGM_STAR_CHANCE</code> etc.
|}

===STREAM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music category name. Simply <code>0</code> in SMG and SMG2
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music name. Examples: <code>STM_STAR_CHANCE</code>, <code>STM_SMG_GALAXY_01</code> etc.
|}

The rest of the BSTN section is padded to the nearest 0x20.

==BSC==
The '''B'''inary '''S'''equence '''C'''ollection section (often referred to as '''SC section''') defines the playback of all sound effects via [[BMS (File Format)|BMS]] data.

===BSC Header===
size: N * 0x4 + 0x8
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x2)
| <code>SC</code> (0x5343)
|-
| 0x02
| UInt16 (0x2)
| Amount N of sound categories (0x0E in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| BSC section size
|- style="vertical-align:bottom;"
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM offset table
|- style="vertical-align:bottom;"
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE offset table
|- style="vertical-align:bottom;"
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION offset table
|- style="vertical-align:bottom;"
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT offset table
|- style="vertical-align:bottom;"
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE offset table
|- style="vertical-align:bottom;"
| 0x24
| UInt32 (0x4)
| Offset to DEMO offset table
|- style="vertical-align:bottom;"
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE offset table
|- style="vertical-align:bottom;"
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION offset table
|- style="vertical-align:bottom;"
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ offset table
|- style="vertical-align:bottom;"
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU offset table
|}

Each of the referenced tables are defined identically, see [[SMR.szs#BSC offset table|BSC offset table]].

===BSC offset table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4 + N * 0x4
| UInt32 (0x4)
| Offset to BMS data
|}

Inbetween tables is the BMS data that makes up all of the sound effects. The BSC section is basically structured like this:
{| class="wikitable"
|-
! BSC
! Contents
|-
| BSC Header
| Offsets to [CATEGORY] offset tables
|-
| Main BMS controller
| BMS data thats mandatory for all sound effects. Its stored once at the beginning of the file to reduce filesize
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the first sound category (SYSTEM)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the second sound category (PLAYER_VOICE)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| ...
| ...
|}

===BSC optimizations===
Despite using the same data that BMS files use, the BSC section optimizes a lot of them. Here are some notable ones:
{| class="wikitable"
|-
! BMS files
! BSC section
|-
| Use E2 + E3 to define an instrument. Takes 0x4 bytes in total
| Use E1 to define an instrument. Takes 0x3 bytes in total
|-
| Close all tracks with FF, even tracks that end with a C7 loop
| Omit use of FF when the last operation in a track is C7
|-
| Define playback speed with D8 and E0 for each BMS file individually
| Define playback speed with EA and D8 once. Every sound effect references this with a C3 jump, reducing the filesize by a lot as opposed to defining the playback speed individually for each sound effect
|-
| no equivalent
| All dummy sounds point to offset 0x6B, which holds FF instead of defining FF for all dummies individually
|-
| OpenTrack with voices 1-7, wait with F0 and shut voices with the 8X operator. Takes up 0x6 bytes minimum
| OpenTrack with voice 0, which enables a Midi gate. This only needs 0x4 bytes to define a sound/key and how long its supposed to last
|}

==WSYS==
'''W'''ave '''Sys'''tem. See [[WSYS]]

==IBNK==
'''I'''nstrument '''B'''a'''nk'''. See [[IBNK]]

==Editing SMR.szs==
'''The following section contains instructions for editing SMR.szs with the SoundModdingToolkit. They do not contain specifications for the file itself.'''

The tool [https://xayr.gay/tools/SoundModdingToolkit/ SoundModdingToolkit] can convert this file into a clear and readable file structure, so the structure of the file is shown on this page using the tool's converted structure.

'''Please note that only version 4.1.0 can edit the lists without any problems. Later versions can lead to problems such as muted songs.'''

===BGM===
====MAIN_BGM====
Found in ''SoundTable/BGM/libraries/MAIN_BGM.json'' 
Defines the sequenced music. The music sequence files can be found in bms format in ''AudioRes/Seqs/JaiSeq.arc''.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
|
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| unk3
| File ID of the bms file in JaiSeq.arc to use (the filename is ignored)
|-
| unk4
| File ID of the cit file in JaiChord.arc to use (the filename is ignored)
|-
| unk5
| Whether BMS channel 0 should be used as a timing channel for [[CIT (File Format)|chords]] or not..0 = False, 1 = True
|-
| type
|
|-
| mOffset
|
|-
| NameOffset
|
|-
| name
| Internal mapping name for this sequence (e.g. "BGM_MISS"). This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

====MULTI_BGM====
Found in ''SoundTable/BGM/libraries/MULTI_BGM.json'' 
Defines settings about Multi BGM such as its name. Multi BGM combines Stream (STM) and sequential Music (BGM). Which Music is set for each Multi BGM is defined in [[MultiBgmInfo]].

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 112
|-
| unk2
| ? always 120
|-
| unk3
| ? always 0
|-
| unk4
| ? always -1
|-
| unk5
| ? always 0
|-
| type
| ? always 96
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this entry (e.g. "MBGM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===STREAM===
Found in ''SoundTable/STREAM/0.json''
Defines the streamed ast audio files including its internal STM name as well as its filepath.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| streamType
| Stream Type 14: Standard Stream (2 Channels) 238: Multi Stream (4 Channels)
|-
| streamPath
| Filepath of the AST file to use (e.g. "/AudioRes/Stream/smg2_ev_starchance_strm.ast")
|-
| type
| ? always 112
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this song (e.g. "STM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===SE===
====AW====
Each aw. file is converted by the tool into a folder that has the ID of the aw file in its name, and besides the sound files converted in wav format, contains the following settings for each sound:
*'''manifest.json''' Contains the ID and name of the aw file
*'''wavetable.json''' Contains settings for each sound of the aw. file

=====wavetable=====
Each entry starts with the name of the Wav file (e.g. "31") followed by its settings:
{| class="wikitable"
|-
! Name
! Description
|-
| format
| ? always 0
|-
| key
|
|-
| sampleRate
| The sample rate at which the sound should be played. (e.g. "22050.0") 
|-
| sampleCount
| Length of the sound in samples
|-
| loop
| Whether it should be looped or not '''true:''' loop '''false:''' do not loop
|-
| loop_start
| Loop Start position in samples.
|-
| loop_end
| Loop End position in samples.
|-
| last
|
|-
| penult
|
|}

====Libraries====
In ''SoundTable\SE\libraries\'' there are several libraries which contain settings for sounds with their internal assigned names.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
|
|-
| unk3
|
|-
| unk4
|
|-
| unk5
|
|-
| unk6
|
|-
| type
| Always 80
|-
| mOffset
|
|-
| NameOffset
| ? Always 0
|-
| name
| Internal Name of the soundeffect (e.g. "SE_SV_LV_YOSHI_FLUTTER")
|}

SMR.szs

2025-06-03T13:56:37Z

Louis Miles: /* Editing SMR.szs */

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

'''SMR.szs''' is a compressed '''BAA''' file ('''B'''inary '''A'''udio '''A'''rchive) which defines the game's sound system. It contains references to [[AST (File Format)|streamed]] and [[BMS (File Format)|sequenced]] music files as well as data for sound effects and instruments. It can be found in various JAudio games, however the specifications below mainly apply to ''Super Mario Galaxy'' and ''Super Mario Galaxy 2''. 
 
The following files are directly linked to SMR.szs:
* [[BgmParam|AudioRes/Info/BgmParam.arc]] (SMG2 only, overrides the BGM and STM volume parameter)
* [[CIT (File Format)|AudioRes/Info/JaiChord.arc]] (SMR.szs links BGM labels to CIT file IDs within this archive)
* [[BMS (File Format)|AudioRes/Seqs/JaiSeq.arc]] (SMR.szs links BGM labels to BMS file IDs within this archive)
* [[AST (File Format)|AudioRes/Stream/*.ast]] (SMR.szs links STM labels to AST files)
* [[AW (File Format)|AudioRes/Waves/*.aw]] (SMR.szs defines the contents of AW files)

The following files are indirectly linked to SMR.szs:
* [[ActionSound|AudioRes/Info/ActionSound.arc]] (SMG2 only, links hardcoded triggers for all objects to sound effects in SMR.szs)
* AudioRes/Info/JaiMe.arc (References instruments from SMR.szs)
* [[BRS (File Format)|AudioRes/Info/JaiRemixSeq.arc]] (References instruments from SMR.szs)
* [[MultiBgmInfo|AudioRes/Info/MultiBgmInfo.arc]] (SMG2 only, connects MBGM labels to STM and BGM labels, allowing streamed and sequenced audio to play simultaneously)
* [[SoundIdToInstList|AudioRes/Info/SoundIdToInstList]] (SMG2 only, references Sound IDs and instruments from SMR.szs and allows loading AW files)
* AudioRes/Info/StageBgmInfo.arc (SMG2 only, controls the [[ScenarioBgmInfo|main music]] and [[StageBgmInfo|music changes]] for all stages) 

==Header==
The header contains offsets to all files included in SMR.szs:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>AA_<</code> (0x41415F3C)
|-
| 0x04
| Magic (0x4)
| <code>bst </code> (0x62737420)
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BST|BST]] section start
|-
| 0x0C
| UInt32 (0x4)
| Offset to BST section end
|-
| 0x10
| Magic (0x4)
| <code>bstn</code> (0x6273746E)
|-
| 0x14
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN|BSTN]] section start
|-
| 0x18
| UInt32 (0x4)
| Offset to BSTN section end
|-
| 0x1C
| Magic (0x4)
| <code>bsc </code> (0x62736320)
|-
| 0x20
| UInt32 (0x4)
| Offset to [[SMR.szs#BSC|BSC]] section start
|-
| 0x24
| UInt32 (0x4)
| Offset to BSC section end
|-
| 0x28 + N * 0x10
| Magic (0x4)
| <code>ws </code> (0x77732020)
|-
| 0x28 + N * 0x10 + 0x4
| UInt32 (0x4)
| WSYS file ID (N)
|-
| 0x28 + N * 0x10 + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#WSYS|WSYS]] file
|-
| 0x28 + N * 0x10 + 0xC
| UInt32 (0x4)
| Unknown (mostly 0x00000000, once seen as 0xFFFFFFFF)
|-
| 0x38 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>bnk </code> (0x626E6B20)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x4
| UInt32 (0x4)
| IBNK file ID (M)
|-
| 0x38 + N * 0x10 + M * 0xC + 0x8
| UInt32 (0x4)
| Offset to [[SMR.szs#IBNK|IBNK]] file
|-
| 0x44 + N * 0x10 + M * 0xC
| Magic (0x4)
| <code>>_AA</code> (0x3E5F4141)
|}

==BST==
The '''B'''inary '''S'''ound '''T'''able contains parameters for all music and sound effects
===BST Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BST </code> (0x42535420)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BST main table|BST main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BST main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE table|SE table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM table|BGM table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM table|STREAM table]]
|}

===SE table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to SYSTEM table
|-
| 0x08
| UInt32 (0x4)
| Offset to PLAYER_VOICE table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_MOTION table
|-
| 0x10
| UInt32 (0x4)
| Offset to BOSS_VOICE table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_MOTION table
|-
| 0x18
| UInt32 (0x4)
| Offset to OBJECT table
|-
| 0x1C
| UInt32 (0x4)
| Offset to ATMOSPHERE table
|-
| 0x20
| UInt32 (0x4)
| Offset to DEMO table
|-
| 0x24
| UInt32 (0x4)
| Offset to ENEMY_VOICE table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_MOTION table
|-
| 0x2C
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION table
|-
| 0x34
| UInt32 (0x4)
| Offset to REMIX_SEQ table
|-
| 0x38
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE parameter table|SE parameter table]].

===BGM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to MAIN_BGM table
|-
| 0x08
| UInt32 (0x4)
| Offset to MULTI_BGM table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM parameter table|BGM parameter table]].

===STREAM table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM parameter table|STREAM parameter table]]
|}

===SE parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x50
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#SE parameters|SE parameters]]
|}

====SE parameters====
size: 0x6 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown
|-
| 0x1
| UInt8 (0x1)
| Volume. Can be overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt8 (0x1)
| Unknown
|-
| 0x3
| UInt8 (0x1)
| Unknown
|-
| 0x4
| UInt8 (0x1)
| Unknown
|-
| 0x5
| UInt8 (0x1)
| Unknown
|}

===BGM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x60
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#BGM parameters|BGM parameters]]
|}

====BGM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description for MAIN_BGM
! Description for MULTI_BGM
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x70
| Unknown. Always 0x70
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
| Unknown. Always 0x78
|-
| 0x2
| UInt16 (0x2)
| JaiSeq.arc file ID. Must always be valid.
| Unknown. Always 0x0000
|-
| 0x4
| UInt16 (0x2)
| JaiChord.arc file ID. 0xFFFF if no JaiChord file is set.
| Unknown. Always 0xFFFF
|-
| 0x6
| UInt16 (0x2)
| Unknown. Seen as 0x0000 and 0x0001.
| Unknown. Always 0x0000
|}

===STREAM parameter table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Padding?
|-
| 0x8 + N * 0x4
| UInt8 (0x1)
| Unknown. Always 0x70
|-
| 0x9 + N * 0x4
| UInt24 (0x3)
| Offset to [[SMR.szs#STREAM parameters|STREAM parameters]]
|}

====STREAM parameters====
size: 0x8 for each entry
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt8 (0x1)
| Unknown. Always 0x80
|-
| 0x1
| UInt8 (0x1)
| Volume. Overridden by [[BgmParam]] in SMG2.
|-
| 0x2
| UInt16 (0x2)
| Channel count. 0x000E for 2 channels, 0x00EE for 4 channels
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated AST filename, relative to the root of the ISO. Example: <code>/AudioRes/Stream/smg2_ev_starchance_strm.ast</code>
|}

The rest of the BST section is padded to the nearest 0x20.

==BSTN==
The '''B'''inary '''S'''ound '''T'''able '''N'''ames section contains labels for all music and sound effects
===BSTN Header===
size: 0x20
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x4)
| <code>BSTN</code> (0x4253544E)
|-
| ?
| ?
|
|-
| 0x08
| UInt8 (0x1) ?
| Unknown. 0x01 in SMG and SMG2
|-
| ?
| ?
|
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#BSTN main table|BSTN main table]]
|-
| 0x10
| Padding (0x10)
|
|}

===BSTN main table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (3 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to [[SMR.szs#SE names table|SE names table]]
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#BGM names table|BGM names table]]
|-
| 0x0C
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM names table|STREAM names table]]
|}

===SE names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (0xE in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Sound Effect name. Points to <code>SE</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE names table
|-
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION names table
|-
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE names table
|-
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION names table
|-
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT names table
|-
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE names table
|-
| 0x24
| UInt32 (0x4)
| Offset to DEMO names table
|-
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE names table
|-
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION names table
|-
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE names table
|-
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION names table
|-
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ names table
|-
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#SE name offset table|SE name offset table]].

===BGM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (2 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Background Music name. Points to <code>BGM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to MAIN_BGM names table
|-
| 0x0C
| UInt32 (0x4)
| Offset to MULTI_BGM names table
|}
Each of the referenced tables are defined identically, see [[SMR.szs#BGM name offset table|BGM name offset table]].

===STREAM names table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Amount N of entries (1 in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| Offset to null-terminated global Stream Music name. Points to <code>STREAM</code> in SMG and SMG2
|-
| 0x08
| UInt32 (0x4)
| Offset to [[SMR.szs#STREAM name offset table|STREAM name offset table]]
|}

===SE name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect category name. Examples: <code>SYSTEM</code>, <code>PLAYER_VOICE</code> etc.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Sound Effect name. Examples: <code>SE_SY_COIN</code>, <code>SE_PV_JUMP_S</code> etc.
|}

===BGM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music category name, like <code>MAIN_BGM</code> or <code>MULTI_BGM</code>.
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Background Music name. Examples: <code>BGM_MISS</code>, <code>MBGM_STAR_CHANCE</code> etc.
|}

===STREAM name offset table===
size: (N + 2) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music category name. Simply <code>0</code> in SMG and SMG2
|-
| 0x8 + N * 0x4
| UInt32 (0x4)
| Offset to null-terminated Stream Music name. Examples: <code>STM_STAR_CHANCE</code>, <code>STM_SMG_GALAXY_01</code> etc.
|}

The rest of the BSTN section is padded to the nearest 0x20.

==BSC==
The '''B'''inary '''S'''equence '''C'''ollection section (often referred to as '''SC section''') defines the playback of all sound effects via [[BMS (File Format)|BMS]] data.

===BSC Header===
size: N * 0x4 + 0x8
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| Magic (0x2)
| <code>SC</code> (0x5343)
|-
| 0x02
| UInt16 (0x2)
| Amount N of sound categories (0x0E in SMG and SMG2)
|-
| 0x04
| UInt32 (0x4)
| BSC section size
|- style="vertical-align:bottom;"
| 0x08
| UInt32 (0x4)
| Offset to SYSTEM offset table
|- style="vertical-align:bottom;"
| 0x0C
| UInt32 (0x4)
| Offset to PLAYER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x10
| UInt32 (0x4)
| Offset to PLAYER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x14
| UInt32 (0x4)
| Offset to BOSS_VOICE offset table
|- style="vertical-align:bottom;"
| 0x18
| UInt32 (0x4)
| Offset to BOSS_MOTION offset table
|- style="vertical-align:bottom;"
| 0x1C
| UInt32 (0x4)
| Offset to OBJECT offset table
|- style="vertical-align:bottom;"
| 0x20
| UInt32 (0x4)
| Offset to ATMOSPHERE offset table
|- style="vertical-align:bottom;"
| 0x24
| UInt32 (0x4)
| Offset to DEMO offset table
|- style="vertical-align:bottom;"
| 0x28
| UInt32 (0x4)
| Offset to ENEMY_VOICE offset table
|- style="vertical-align:bottom;"
| 0x2C
| UInt32 (0x4)
| Offset to ENEMY_MOTION offset table
|- style="vertical-align:bottom;"
| 0x30
| UInt32 (0x4)
| Offset to SUPPORTER_VOICE offset table
|- style="vertical-align:bottom;"
| 0x34
| UInt32 (0x4)
| Offset to SUPPORTER_MOTION offset table
|- style="vertical-align:bottom;"
| 0x38
| UInt32 (0x4)
| Offset to REMIX_SEQ offset table
|- style="vertical-align:bottom;"
| 0x3C
| UInt32 (0x4)
| Offset to HOME_BUTTON_MENU offset table
|}

Each of the referenced tables are defined identically, see [[SMR.szs#BSC offset table|BSC offset table]].

===BSC offset table===
size: (N + 1) * 0x4
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x0
| UInt32 (0x4)
| Amount N of entries
|-
| 0x4 + N * 0x4
| UInt32 (0x4)
| Offset to BMS data
|}

Inbetween tables is the BMS data that makes up all of the sound effects. The BSC section is basically structured like this:
{| class="wikitable"
|-
! BSC
! Contents
|-
| BSC Header
| Offsets to [CATEGORY] offset tables
|-
| Main BMS controller
| BMS data thats mandatory for all sound effects. Its stored once at the beginning of the file to reduce filesize
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the first sound category (SYSTEM)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| [CATEGORY] offset table
| A table with offsets to BMS data for the second sound category (PLAYER_VOICE)
|-
| [CATEGORY] BMS data
| Raw BMS data defining the playback of each sound effect
|-
| ...
| ...
|}

===BSC optimizations===
Despite using the same data that BMS files use, the BSC section optimizes a lot of them. Here are some notable ones:
{| class="wikitable"
|-
! BMS files
! BSC section
|-
| Use E2 + E3 to define an instrument. Takes 0x4 bytes in total
| Use E1 to define an instrument. Takes 0x3 bytes in total
|-
| Close all tracks with FF, even tracks that end with a C7 loop
| Omit use of FF when the last operation in a track is C7
|-
| Define playback speed with D8 and E0 for each BMS file individually
| Define playback speed with EA and D8 once. Every sound effect references this with a C3 jump, reducing the filesize by a lot as opposed to defining the playback speed individually for each sound effect
|-
| no equivalent
| All dummy sounds point to offset 0x6B, which holds FF instead of defining FF for all dummies individually
|-
| OpenTrack with voices 1-7, wait with F0 and shut voices with the 8X operator. Takes up 0x6 bytes minimum
| OpenTrack with voice 0, which enables a Midi gate. This only needs 0x4 bytes to define a sound/key and how long its supposed to last
|}

==WSYS==
'''W'''ave '''Sys'''tem. See [[WSYS]]

==IBNK==
'''I'''nstrument '''B'''a'''nk'''. See [[IBNK]]

==Editing SMR.szs==
'''The following section contains instructions for editing SMR.szs with the SoundModdingToolkit. They do not contain specifications for the file itself.'''

The tool [https://xayr.gay/tools/SoundModdingToolkit/ SoundModdingToolkit] can convert this file into a clear and readable file structure, so the structure of the file is shown on this page using the tool's converted structure.

'''Please note that only version 4.1.0 can edit the lists without any problems. Later versions can lead to problems such as muted songs.'''

===BGM===
====MAIN_BGM====
Found in ''SoundTable/BGM/libraries/MAIN_BGM.json'' 
Defines the sequenced music. The music sequence files can be found in bms format in ''AudioRes/Seqs/JaiSeq.arc''.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
|
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| unk3
| File ID of the bms file in JaiSeq.arc to use (the filename is ignored)
|-
| unk4
| File ID of the cit file in JaiChord.arc to use (the filename is ignored)
|-
| unk5
| Whether BMS channel 0 should be used as a timing channel for [[CIT (File Format)|chords]] or not..-1 = False, 1 = True
|-
| type
|
|-
| mOffset
|
|-
| NameOffset
|
|-
| name
| Internal mapping name for this sequence (e.g. "BGM_MISS"). This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

====MULTI_BGM====
Found in ''SoundTable/BGM/libraries/MULTI_BGM.json'' 
Defines settings about Multi BGM such as its name. Multi BGM combines Stream (STM) and sequential Music (BGM). Which Music is set for each Multi BGM is defined in [[MultiBgmInfo]].

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 112
|-
| unk2
| ? always 120
|-
| unk3
| ? always 0
|-
| unk4
| ? always -1
|-
| unk5
| ? always 0
|-
| type
| ? always 96
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this entry (e.g. "MBGM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===STREAM===
Found in ''SoundTable/STREAM/0.json''
Defines the streamed ast audio files including its internal STM name as well as its filepath.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
| Volume (overridden by [[BgmParam]] in SMG2)
|-
| streamType
| Stream Type 14: Standard Stream (2 Channels) 238: Multi Stream (4 Channels)
|-
| streamPath
| Filepath of the AST file to use (e.g. "/AudioRes/Stream/smg2_ev_starchance_strm.ast")
|-
| type
| ? always 112
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this song (e.g. "STM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===SE===
====AW====
Each aw. file is converted by the tool into a folder that has the ID of the aw file in its name, and besides the sound files converted in wav format, contains the following settings for each sound:
*'''manifest.json''' Contains the ID and name of the aw file
*'''wavetable.json''' Contains settings for each sound of the aw. file

=====wavetable=====
Each entry starts with the name of the Wav file (e.g. "31") followed by its settings:
{| class="wikitable"
|-
! Name
! Description
|-
| format
| ? always 0
|-
| key
|
|-
| sampleRate
| The sample rate at which the sound should be played. (e.g. "22050.0") 
|-
| sampleCount
| Length of the sound in samples
|-
| loop
| Whether it should be looped or not '''true:''' loop '''false:''' do not loop
|-
| loop_start
| Loop Start position in samples.
|-
| loop_end
| Loop End position in samples.
|-
| last
|
|-
| penult
|
|}

====Libraries====
In ''SoundTable\SE\libraries\'' there are several libraries which contain settings for sounds with their internal assigned names.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
|
|-
| unk3
|
|-
| unk4
|
|-
| unk5
|
|-
| unk6
|
|-
| type
| Always 80
|-
| mOffset
|
|-
| NameOffset
| ? Always 0
|-
| name
| Internal Name of the soundeffect (e.g. "SE_SV_LV_YOSHI_FLUTTER")
|}

BMS (File Format)

2025-05-17T12:41:44Z

Louis Miles:

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Data ==
BMS files contain raw instructions for the audio engine. There are no headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
|
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| Unknown.
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
|
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
|
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
|
|
|
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Unknown[1]} {Pitch Wheel Value[2]} OpCode: one byte, B9. Unknown: always 01, other values do nothing or glitching sounds. Pitch Wheel Value: Value seeminlgy equals the midi pitch value divided by 8. Minus values start at FFFF and then decreases. Can also have higher/lower values than regular Midi Pitch Wheel, which has a maximum of +8191 (03FF) and minimum of -8192 (FC00).
| B9 01 02 4B B9: OpCode 01: Unknown 02 4B: Pitch Wheel of 4701
| Sets the Pitch Wheel
|-
| BA
| JASSeqParser::cmdParamEI
|
|
|
|-
| BB
| JASSeqParser::cmdParamII
|
|
|
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {TrackNumber[1]} {Pointer[3]} OpCode: one byte, C1. TrackNumber: one byte with range 0x00 through 0x0F. 0x00 = Track 0, 0x0F = Track 15. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C1 04 05 B4 73 C1: OpCode 04: Track 4 05 B4 73: Offset
| Creates a Track which can play Notes. Track 15 is usually reserved for Yoshi Drums.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
|
|
|
|-
| D1
| JASSeqParser::cmdWritePort
|
|
|
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
|
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines the Instrument to be used in a Track.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK whose sounds are to be used in a Track.
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Keyboard which holds more specific sounds to an IBNK.
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
|
|
|
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
|
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 00 FD: OpCode 48 65 6C 6C 6F: "Hello" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Tools ==
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-05-17T12:31:23Z

Louis Miles:

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Data ==
BMS files contain raw instructions for the audio engine. There are no headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
|
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| Unknown.
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
|
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
|
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
|
|
|
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Unknown[1]} {Pitch Wheel Value[2]} OpCode: one byte, B9. Unknown: always 01, other values do nothing or glitching sounds. Pitch Wheel Value: Value seeminlgy equals the midi pitch value divided by 4. Minus values start at FFFF and then decreases. Can also have higher/lower values than regular Midi Pitch Wheel, which has a maximum of +8191 (1FFF) and minimum of -8192 (F800).
| B9 01 02 4B B9: OpCode 01: Unknown 02 4B: Pitch Wheel of 4701
| Sets the Pitch Wheel
|-
| BA
| JASSeqParser::cmdParamEI
|
|
|
|-
| BB
| JASSeqParser::cmdParamII
|
|
|
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {TrackNumber[1]} {Pointer[3]} OpCode: one byte, C1. TrackNumber: one byte with range 0x00 through 0x0F. 0x00 = Track 0, 0x0F = Track 15. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C1 04 05 B4 73 C1: OpCode 04: Track 4 05 B4 73: Offset
| Creates a Track which can play Notes. Track 15 is usually reserved for Yoshi Drums.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
|
|
|
|-
| D1
| JASSeqParser::cmdWritePort
|
|
|
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
|
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines the Instrument to be used in a Track.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK whose sounds are to be used in a Track.
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Keyboard which holds more specific sounds to an IBNK.
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
|
|
|
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
|
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 00 FD: OpCode 48 65 6C 6C 6F: "Hello" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Tools ==
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

BMS (File Format)

2025-05-16T22:18:24Z

Louis Miles:

[[Category:File formats]]
== File Format ==
BMS files are '''B'''inary '''M'''usic '''S'''equences that store commands for the audio engine to play notes, similar to the MIDI file format.

== Data ==
BMS files contain raw instructions for the audio engine. There are no headers or filesize checks. Each instruction (OpCode) stands for its own function in the engine. The following table lists all JAudio2 OpCodes that have functions in SMG2:

{| class="wikitable"
|-
! OpCode
! Function (SMG/SMG2)
! Usage
! Example
! Description
|-
| 00 01 02 ... 7D 7E 7F
|
| {OpCode[1]} {Voice[1]} {Velocity[1]} OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9. Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note. Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127. If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect a 4th value that is one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. It is unknown what effects this has on the output.
| 64 02 68 64: Key E4 02: Voice 2 68: Velocity 104
| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).
|-
| 80
| Unknown.
|
|
| Seems to do nothing based on the code.
|-
| 81 ... 87
|
| {OpCode[1]} OpCode: one byte with range 0x81 through 0x87. 0x81 = Close Voice 1, 0x87 = Close Voice 7.
|
| Stops playing a Note.
|-
| 88 ... 8F
| Unknown
|
|
|
|-
| 90 ... 9F
| Unknown
|
|
|
|-
| A0
| NULL
|
|
|
|-
| A1
| NULL
|
|
|
|-
| A2
| NULL
|
|
|
|-
| A3
| NULL
|
|
|
|-
| A4
| NULL
|
|
|
|-
| A5
| NULL
|
|
|
|-
| A6
| NULL
|
|
|
|-
| A7
| NULL
|
|
|
|-
| A8
| NULL
|
|
|
|-
| A9
| NULL
|
|
|
|-
| AA
| NULL
|
|
|
|-
| AB
| NULL
|
|
|
|-
| AC
| NULL
|
|
|
|-
| AD
| NULL
|
|
|
|-
| AE
| NULL
|
|
|
|-
| AF
| NULL
|
|
|
|-
| B0
| Extended Opcode Indicator
| See B000 or B001.
|
|
|-
| B1
| JASSeqParser::cmdNoteOn
|
|
|
|-
| B2
| JASSeqParser::cmdNoteOff
|
|
|
|-
| B3
| JASSeqParser::cmdNote
|
|
|
|-
| B4
| JASSeqParser::cmdSetLastNote
|
|
|
|-
| B5
| NULL
|
|
|
|-
| B6
| NULL
|
|
|
|-
| B7
| NULL
|
|
|
|-
| B8
| JASSeqParser::cmdParamE
|
|
|
|-
| B9
| JASSeqParser::cmdParamI
| {OpCode[1]} {Unknown[1]} {Pitch Wheel Value[2]} OpCode: one byte, B9. Unknown: always 01, other values do nothing or glitching sounds. Pitch Wheel Value: Only high pitching possible (needs investigation, possibly the unknown value allows low pitching). Value equals the midi pitch value divided by 4. Can also have higher values than regular Midi Pitch Wheel, which has a maximum of +8191.
| B9 01 02 4B B9: OpCode 01: Unknown 02 4B: Pitch Wheel of 4701
| Sets the Pitch Wheel (high)
|-
| BA
| JASSeqParser::cmdParamEI
|
|
|
|-
| BB
| JASSeqParser::cmdParamII
|
|
|
|-
| BC
| NULL
|
|
|
|-
| BD
| NULL
|
|
|
|-
| BE
| NULL
|
|
|
|-
| BF
| NULL
|
|
|
|-
| C0
| NULL
|
|
|
|-
| C1
| JASSeqParser::cmdOpenTrack
| {OpCode[1]} {TrackNumber[1]} {Pointer[3]} OpCode: one byte, C1. TrackNumber: one byte with range 0x00 through 0x0F. 0x00 = Track 0, 0x0F = Track 15. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C1 04 05 B4 73 C1: OpCode 04: Track 4 05 B4 73: Offset
| Creates a Track which can play Notes. Track 15 is usually reserved for Yoshi Drums.
|-
| C2
| JASSeqParser::cmdCloseTrack
|
|
|
|-
| C3
| JASSeqParser::cmdCall
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C3. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C3 00 00 40 C3: OpCode 00 00 40: Offset
| Redirects execution to the defined offset. Execution can return with C5.
|-
| C4
| JASSeqParser::cmdCallF
|
|
|
|-
| C5
| JASSeqParser::cmdRet
| {OpCode[1]} OpCode: one byte, C5.
|
| Returns redirected execution (like from C3) to the initial call.
|-
| C6
| JASSeqParser::cmdRetF
|
|
|
|-
| C7
| JASSeqParser::cmdJmp
| {OpCode[1]} {Pointer[3]} OpCode: one byte, C7. Pointer: three bytes with range 0x000000 through 0xFFFFFF. Defines an offset in the file.
| C7 08 02 34 C7: OpCode 08 02 34: Offset
| Redirects execution to the defined offset, used for Loops.
|-
| C8
| JASSeqParser::cmdJmpF
|
|
|
|-
| C9
| JASSeqParser::cmdJmpTable
|
|
|
|-
| CA
| JASSeqParser::cmdCallTable
|
|
|
|-
| CB
| JASSeqParser::cmdLoopS
|
|
|
|-
| CC
| JASSeqParser::cmdLoopE
|
|
|
|-
| CD
| NULL
|
|
|
|-
| CE
| NULL
|
|
|
|-
| CF
| NULL
|
|
|
|-
| D0
| JASSeqParser::cmdReadPort
|
|
|
|-
| D1
| JASSeqParser::cmdWritePort
|
|
|
|-
| D2
| JASSeqParser::cmdCheckPortImport
|
|
|
|-
| D3
| JASSeqParser::cmdCheckPortExport
|
|
|
|-
| D4
| JASSeqParser::cmdParentWritePort
|
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
|
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
|
|
|
|-
| D7
| JASSeqParser::cmdChildReadPort
|
|
|
|-
| D8
| JASSeqParser::cmdRegLoad
| {OpCode[1]} {Setting[1]} {Unknown[1]} {Variable[1]} OpCode: one byte, D8. Setting: one byte with unknown range. Different bytes will trigger different effects: - 0x62: set PPQN (seen in BMS) - 0x6B: set PPQN (seen in SC) Unknown: one byte with unknown range and purpose. Variable: one byte with different range and purpose depending on the Setting byte.
| D8 62 00 78 D8: OpCode 62: set PPQN 00: Unknown 78: PPQN 120
| Different purposes.
|-
| D9
| JASSeqParser::cmdReg
|
|
|
|-
| DA
| JASSeqParser::cmdReg
|
|
|
|-
| DB
| JASSeqParser::cmdRegUni
|
|
|
|-
| DC
| JASSeqParser::cmdRegTblLoad
|
|
|
|-
| DD
| NULL
|
|
|
|-
| DE
| NULL
|
|
|
|-
| DF
| NULL
|
|
|
|-
| E0
| JASSeqParser::cmdTempo
| {OpCode[1]} {Unknown[1]} {BPM[1]} OpCode: one byte, E0. Unknown: one byte with unknown range and purpose. BPM: one byte with range 0x00 through 0xFF. 0x78 = 120, F0 = 240.
| E0 00 90 E0: OpCode 00: Unknown 90: BPM 144
| Defines the tempo (playback speed) of the BMS file.
|-
| E1
| JASSeqParser::cmdBankPrg
| {OpCode[1]} {Bank[1]} {Program[1]} OpCode: one byte, E1. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID. Program: one byte ranging from 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E1 01 0F E1: OpCode 01: WSYS ID 1 0F: IBNK LIST entry 15 (01 0F is the percussion set for Yoshi Drums)
| Defines the Instrument to be used in a Track.
|-
| E2
| JASSeqParser::cmdBank
| {OpCode[1]} {Bank[1]} OpCode: one byte, E2. Bank: one byte with range 0x00 through 0xFF. This byte represents a WSYS ID.
| E2 53 E2: OpCode 53: WSYS ID 83 (This bank holds sounds for Megahammer)
| Defines the WSYS/IBNK whose sounds are to be used in a Track.
|-
| E3
| JASSeqParser::cmdPrg
| {OpCode[1]} {Program[1]} OpCode: one byte, E3. Program: one byte with range 0x00 through 0xFF. This byte represents a LIST entry in the IBNK belonging to the defined WSYS ID.
| E3 0B E3: OpCode 0B: IBNK LIST entry 11 (In relation to Megahammer, this Program holds movement related sounds)
| Defines the Keyboard which holds more specific sounds to an IBNK.
|-
| E4
| NULL
|
|
|
|-
| E5
| NULL
|
|
|
|-
| E6
| NULL
|
|
|
|-
| E7
| JASSeqParser::cmdEnvScaleSet
|
|
|
|-
| E8
| JASSeqParser::cmdEnvSet
|
|
|
|-
| E9
| JASSeqParser::cmdSimpleADSR
|
|
|
|-
| EA
| JASSeqParser::cmdBusConnect
| {OpCode[1]} {Unknown[1]} {Unknown[1]} {Unknown[1]} OpCode: one byte, EA. Unknown: one byte with unknown range and purpose.
| EA 00 FF FF EA: OpCode 00: Unknown FF: Unknown FF: Unknown
| Unknown purpose, only seen in SC.
|-
| EB
| JASSeqParser::cmdIIRCutOff
|
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
|
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
|
|
|
|-
| EE
| NULL
|
|
|
|-
| EF
| NULL
|
|
|
|-
| F0
| JASSeqParser::cmdWait
| {OpCode[1]} {WaitTime[n]} OpCode: one byte, 0xF0. WaitTime: one or more bytes with range 0x00 through 0xFF. If the leading byte is 0x80 (bit 7 = 1) or greater, another following byte will be taken into account. Time is measured in ticks here.
| F0 60 (96 Ticks) F0 81 56 (214 Ticks) F0 83 81 30 (49328 Ticks)
| Creates a delay, used to define the length of a Note or gap between Notes.
|-
| F1
| JASSeqParser::cmdWaitByte
|
|
|
|-
| F2
| NULL
|
|
|
|-
| F3
| JASSeqParser::cmdSetIntTable
|
|
|
|-
| F4
| JASSeqParser::cmdSetInterrupt
|
|
|
|-
| F5
| JASSeqParser::cmdDisInterrupt
|
|
|
|-
| F6
| JASSeqParser::cmdRetI
|
|
|
|-
| F7
| JASSeqParser::cmdClrI
|
|
|
|-
| F8
| JASSeqParser::cmdIntTimer
|
|
|
|-
| F9
| JASSeqParser::cmdSyncCPU
|
|
|
|-
| FA
| NULL
|
|
|
|-
| FB
| NULL
|
|
|
|-
| FC
| NULL
|
|
|
|-
| FD
| JASSeqParser::cmdPrintf
| {OpCode[1]} {Message[n]} {NullTerminator[1]} OpCode: one byte, FD. Message: ASCII string of undefined length. NullTerminator: one byte, 00.
| FD 48 65 6C 6C 6F 00 FD: OpCode 48 65 6C 6C 6F: "Hello" 00: Null-terminator
| Prints a specified message to OSReport.
|-
| FE
| JASSeqParser::cmdNop
|
|
|
|-
| FF
| JASSeqParser::cmdFinish
| {OpCode[1]} OpCode: one byte, 0xFF.
|
| Stops execution of a Track.
|-
| B000
| NULL
|
|
|
|-
| B001
| JASSeqParser::cmdDump
|
|
|
|}

== Tools ==
[https://cdn.discordapp.com/attachments/421356154795458570/1291660143758413824/BMS_DEC.zip?ex=6719f440&is=6718a2c0&hm=f44c5197a070f30a00283858942f9e4ae5066034862eba006f8abe87a228a6aa& BMS_DEC] (converts BMS to MIDI) 
[https://github.com/XAYRGA/JaiSeqX JaiSeqX] (playback for JAudio1 and JAudio2 BMS files)

ProductMapObjDataTable

2025-02-19T13:53:43Z

Louis Miles: /* Classes */

[[Category:Files]]
'''ProductMapObjDataTable''' is a [[BCSV (File format)|BCSV]] table that defines map objects and assigns them a class. The file can be found in ''SMG2'' in ''ObjectData/ProductMapObjDataTable.arc/root/ProductMapObjDataTable.bcsv''. It contains the following fields:
{| class="wikitable"
! Field !! Type !! Description
|-
| ModelName || string || The object name and model file in [[File system#ObjectData|ObjectData]].
|-
| ClassName || string || The name of the class that this object uses. A list of propery classes can be found below.
|}

=== Classes ===
{| class="wikitable"
! Class !! Function
|-
| AutoMakeMapObj || Alias for SimpleMapObj.
|-
| SimpleMapObj || A basic object that can be used in any level. Supports [[BCK]], [[BTK]], [[BTP]], [[BVA]], and [[BRK]]. [[BPK]] is not supported. Animations must take on the same name as the model in order to be played, and they start playing once the object loads. '''obj_arg0''' allows for this model to change colours based on a file inside the archive called "ColorChange.brk". The value put into '''obj_arg0''' corresponds to the frame to use. '''obj_arg1''' allows for this model to change textures based on a file inside the archive called "TexChange.btp" ("TexChange.btk" is also supported. Both btk and btp may exist at the same time, both will be used). The value put into '''obj_arg1''' corresponds to the frame to use. '''obj_arg2''' dictates how far the shadow of the object drops (Calculated with in-game units). Shadows can be used if you setup a Shadow.bcsv inside the object's [[ActorInfo]].
|-
| SimpleMapObjFarMax || Basic object with a far viewing range
|-
| SimpleMapObjWithEffect || Basic object with particle effects
|-
| SimpleClipPartsObj || Basic object that can be clipped
|-
| SimpleSeesawObj || Basic seesaw MapParts object '''MoveConditionType''': Rotate back to initially rotation when jumped off? 1 = Yes, 0 = No '''RotateSpeed''': Rotation Speed; How fast the Seesaw rotates when jumped on '''RotateAngle''': Degree of rotation; How far the Seesaw can rotate on one side '''RotateAxis''': On which axis the object rotates; 0 = Z-Axis, 1 = ? (Doesn't rotate), 2 = Z- and X-Axis '''RotateAccelType''': ? '''RotateStopTime''': Back Swinging Speed; How fast it swings back when jumped off
|-
| SimpleFloaterObj || Basic floater MapParts object '''MoveConditionType''': Depth; How far it sinks (a negative value to make the object rising up will glitch, turning the object over instead will work) '''RotateSpeed''': Sinking Speed; How fast it sinks '''RotateAngle''': Pop-Up Speed; How fast it comes back to it's initially height
|-
| LavaFloater || Lava floating platform that requires effects
|-
| SimpleBreakableObj || Object that can be destroyed with a SW_B switch. Can spawn items when destroyed via '''obj_arg3''': '''-1:''' Coin '''0:''' Nothing '''1:''' 1-Up mushroom '''2:''' Power Star '''3:''' Starbits The Power Star requires a properly set up AppearPowerStarObj parameter.
|-
| SimpleBreakableCollisionObj ||
|-
| SimpleBreakableDeleteShadowObj ||
|-
| SimpleBreakableStrongLightObj ||
|-
| AnmModelSwitchMove || Object for which animations with the name ''Move'' are played as soon as its SW_A switch is activated. Supports any animation type except [[BPK]].
[[BVA]] requires an associated [[BCK]] animation, otherwise the game will crash for unknown reasons.
|-
| AnmModelSwitchMoveEndKill || Special object for [[cutscenes]] with action type 4.
Plays animations with the name ''Move'' when activated and then disappears.
|-
| AnmModelSwitchMoveEndKillAnyAnim || Same as AnmModelSwitchMoveEndKill but supports any animation type? More investigation needed.
Used by YoshiEggCapsuleCage.
|-
| AnmModelSwitchMoveValidateCollision ||
|-
| AnmModelSwitchMoveInvalidateCollision ||
|-
| AnmModelSwitchSyncBrk || An object for which the following animation names are played:
'''Move''' When its SW_A switch is activated
'''Reverse''' When its SW_A switch is deactivated
|-
| RailMoveObj || Path-moving MapParts platform. Can play animations with the name ''Move'' when moving.
|-
| RailMoveWithReverseAnimObj ||
|-
| RailMoveWithIndirectModelObj ||
|-
| RailMoveShadowDropYObj || Path-moving MapParts platform that drops a shadow
|-
| RailMoveObjClipParts || Path-moving platform that can be clipped
|-
| RailMoveDemoActionObj ||
|-
| RailMoveLavaProjmapObj ||
|-
| RailRotateMoveObj || A MapParts platform that can move and rotate along a path. '''point_arg0''': Move speed/time (see point arg 7) '''point_arg1''': Acceleration speed/time (see point arg 7) '''point_arg2''': Rotate Speed/time (see point arg 7) '''point_arg3''': Rotation Angle. Relative (180 on two path points will rotate 360) '''point_arg4''': Rotation Axis. (0 = X, 1 = Y, 2 = Z) '''point_arg5''': Wait time. Stops movement at this path point for the provided time (in frames). '''point_arg6''': Rotation Type (-1 = Rotate at point, 1 = Rotate between this path point and next path point) '''point_arg7''': Calculation Type (-1 = Speed, 1 = Time. Time will define a fixed amount of time, while speed will set a value without care for how far away the next point is.) 
A collision model is required, otherwise the rotation will be ignored.
|-
| RailAndRotateMoveObj ||
|-
| RotateMoveObj || Rotating MapParts platform '''MoveConditionType''': 0 = Always moving, 1 = Wait for player to step on it. '''RotateSpeed''': Rotation Speed. How fast the object rotates. Negative numbers are allowed, and will rotate the object in the opposite direction. '''RotateAngle''': How much to rotate. For always spinning objects that just do 360, set this to 0. '''RotateAxis''': On which axis the object rotates. 0 = X, 1 = Y, 2 = Z. '''RotateAccelType''': ? '''RotateStopTime''': If applicable, how long to stop rotating for. In frames.
|-
| RotateMoveObjClipParts || Rotating MapParts platform that can be clipped.
|-
| EffectObjR500F50 || An effect object which can span with a radius of 500 and a Far Clip distance of 50.
|-
| EffectObjR1000F50 || An effect object which can span with a radius of 1000 and a Far Clip distance of 50.
|-
| EffectObjR1500F400 || An effect object which can span with a radius of 1500 and a Far Clip distance of 400.
|-
| EffectObj20x20x10SyncClipping ||
|-
| EffectObj50x50x10SyncClipping ||
|-
| EffectObj10x10x10SyncClipping ||
|-
| Sky || A basic Sky that simply moves with the camera. Supports most animation formats with the same name as the model.
|-
| ProjectionMapSky || Also a Sky model, but the difference is unknown
|-
| SoundSyncSky || Sky model that plays a BRK animation to the beat
|-
| Air || Basic atmosphere object
|-
| ProjectionMapAir ||
|-
| PriorDrawAir ||
|-
| AfterMapObjDrawAir ||
|-
| CloudStep || Cloud platform that can move on paths as well
|-
| CloudSea || Unknown; used by the bowl swamp planet in Cloudy Court Galaxy
|-
| HipDropMoveBlock || Moves when groundpounded on its Y-Axis; used by the blocks in Puzzle Plank Galaxy 
*'''Obj_arg0''': Units, how far the object may be pushed at most in one direction; a positive number lets you move the object from the bottom up, while a negative number lets you move it from the top down. 
*'''Obj_arg1''': How many times you have to stomp on it until it reaches the end point set above 
*'''Obj_arg2''': Rising Speed 
*'''Obj_arg3''': Can be stomped only in one direction? -1 = No, 0 = Yes; allows stomping only in the direction set in arg_0
|-
| GorogoroCylinderRock || Rolling cylinder rocks that move on a path and respawn; see Clockwork Ruins Galaxy
|-
| SwitchingMoveBlock || Moves when a switch is activated. Used by the red and blue platforms in Flip-Out Galaxy '''obj_arg0''': How many units this object moves on its X Axis '''obj_arg1''': How many units this object moves on its Y Axis '''obj_arg2''': How many units this object moves on its Z Axis '''obj_arg3''': How many units this object rotates on its X Axis '''obj_arg4''': How many units this object rotates on its Y Axis '''obj_arg5''': How many units this object rotates on its Z Axis
|}

ProductMapObjDataTable

2025-02-15T12:34:05Z

Louis Miles: /* Classes */

[[Category:Files]]
'''ProductMapObjDataTable''' is a [[BCSV (File format)|BCSV]] table that defines map objects and assigns them a class. The file can be found in ''SMG2'' in ''ObjectData/ProductMapObjDataTable.arc/root/ProductMapObjDataTable.bcsv''. It contains the following fields:
{| class="wikitable"
! Field !! Type !! Description
|-
| ModelName || string || The object name and model file in [[File system#ObjectData|ObjectData]].
|-
| ClassName || string || The name of the class that this object uses. A list of propery classes can be found below.
|}

=== Classes ===
{| class="wikitable"
! Class !! Function
|-
| AutoMakeMapObj || Alias for SimpleMapObj.
|-
| SimpleMapObj || A basic object that can be used in any level. Supports [[BCK]], [[BTK]], [[BTP]], [[BVA]], and [[BRK]]. [[BPK]] is not supported. Animations must take on the same name as the model in order to be played, and they start playing once the object loads. '''obj_arg0''' allows for this model to change colours based on a file inside the archive called "ColorChange.brk". The value put into '''obj_arg0''' corresponds to the frame to use. '''obj_arg1''' allows for this model to change textures based on a file inside the archive called "TexChange.btp" ("TexChange.btk" is also supported. Both btk and btp may exist at the same time, both will be used). The value put into '''obj_arg1''' corresponds to the frame to use. '''obj_arg2''' dictates how far the shadow of the object drops (Calculated with in-game units). Shadows can be used if you setup a Shadow.bcsv inside the object's [[ActorInfo]].
|-
| SimpleMapObjFarMax || Basic object with a far viewing range
|-
| SimpleMapObjWithEffect || Basic object with particle effects
|-
| SimpleClipPartsObj || Basic object that can be clipped
|-
| SimpleSeesawObj || Basic seesaw MapParts object '''MoveConditionType''': Rotate back to initially rotation when jumped off? 1 = Yes, 0 = No '''RotateSpeed''': Rotation Speed; How fast the Seesaw rotates when jumped on '''RotateAngle''': Degree of rotation; How far the Seesaw can rotate on one side '''RotateAxis''': On which axis the object rotates; 0 = Z-Axis, 1 = ? (Doesn't rotate), 2 = Z- and X-Axis '''RotateAccelType''': ? '''RotateStopTime''': Back Swinging Speed; How fast it swings back when jumped off
|-
| SimpleFloaterObj || Basic floater MapParts object '''MoveConditionType''': Depth; How far it sinks (a negative value to make the object rising up will glitch, turning the object over instead will work) '''RotateSpeed''': Sinking Speed; How fast it sinks '''RotateAngle''': Pop-Up Speed; How fast it comes back to it's initially height
|-
| LavaFloater || Lava floating platform that requires effects
|-
| SimpleBreakableObj || Object that can be destroyed with a SW_B switch. Can spawn items when destroyed via '''obj_arg3''': '''-1:''' Coin '''0:''' Nothing '''1:''' 1-Up mushroom '''2:''' Power Star '''3:''' Starbits The Power Star requires a properly set up AppearPowerStarObj parameter.
|-
| SimpleBreakableCollisionObj ||
|-
| SimpleBreakableDeleteShadowObj ||
|-
| SimpleBreakableStrongLightObj ||
|-
| AnmModelSwitchMove || Object for which animations with the name ''Move'' are played as soon as its SW_A switch is activated. Supports any animation type except [[BPK]].
[[BVA]] requires an associated [[BCK]] animation, otherwise the game will crash for unknown reasons.
|-
| AnmModelSwitchMoveEndKill || Special object for [[cutscenes]] with action type 4.
Plays animations with the name ''Move'' when activated and then disappears.
|-
| AnmModelSwitchMoveEndKillAnyAnim || Same as AnmModelSwitchMoveEndKill but supports any animation type? More investigation needed.
Used by YoshiEggCapsuleCage.
|-
| AnmModelSwitchMoveValidateCollision ||
|-
| AnmModelSwitchMoveInvalidateCollision ||
|-
| AnmModelSwitchSyncBrk || An object for which the following animation names are played:
'''Move''' When its SW_A switch is activated
'''Reverse''' When its SW_A switch is deactivated
|-
| RailMoveObj || Path-moving MapParts platform. Can play animations with the name ''Move'' when moving.
|-
| RailMoveWithReverseAnimObj ||
|-
| RailMoveWithIndirectModelObj ||
|-
| RailMoveShadowDropYObj || Path-moving MapParts platform that drops a shadow
|-
| RailMoveObjClipParts || Path-moving platform that can be clipped
|-
| RailMoveDemoActionObj ||
|-
| RailMoveLavaProjmapObj ||
|-
| RailRotateMoveObj || A MapParts platform that can move and rotate along a path. '''point_arg0''': Move speed/time (see point arg 7) '''point_arg1''': Acceleration speed/time (see point arg 7) '''point_arg2''': Rotate Speed/time (see point arg 7) '''point_arg3''': Rotation Angle. Relative (180 on two path points will rotate 360) '''point_arg4''': Rotation Axis. (0 = X, 1 = Y, 2 = Z) '''point_arg5''': Wait time. Stops movement at this path point for the provided time (in frames). '''point_arg6''': Rotation Type (-1 = Rotate at point, 1 = Rotate between this path point and next path point) '''point_arg7''': Calculation Type (-1 = Speed, 1 = Time. Time will define a fixed amount of time, while speed will set a value without care for how far away the next point is.)
|-
| RailAndRotateMoveObj ||
|-
| RotateMoveObj || Rotating MapParts platform '''MoveConditionType''': 0 = Always moving, 1 = Wait for player to step on it. '''RotateSpeed''': Rotation Speed. How fast the object rotates. Negative numbers are allowed, and will rotate the object in the opposite direction. '''RotateAngle''': How much to rotate. For always spinning objects that just do 360, set this to 0. '''RotateAxis''': On which axis the object rotates. 0 = X, 1 = Y, 2 = Z. '''RotateAccelType''': ? '''RotateStopTime''': If applicable, how long to stop rotating for. In frames.
|-
| RotateMoveObjClipParts || Rotating MapParts platform that can be clipped.
|-
| EffectObjR500F50 || An effect object which can span with a radius of 500 and a Far Clip distance of 50.
|-
| EffectObjR1000F50 || An effect object which can span with a radius of 1000 and a Far Clip distance of 50.
|-
| EffectObjR1500F400 || An effect object which can span with a radius of 1500 and a Far Clip distance of 400.
|-
| EffectObj20x20x10SyncClipping ||
|-
| EffectObj50x50x10SyncClipping ||
|-
| EffectObj10x10x10SyncClipping ||
|-
| Sky || A basic Sky that simply moves with the camera. Supports most animation formats with the same name as the model.
|-
| ProjectionMapSky || Also a Sky model, but the difference is unknown
|-
| SoundSyncSky || Sky model that plays a BRK animation to the beat
|-
| Air || Basic atmosphere object
|-
| ProjectionMapAir ||
|-
| PriorDrawAir ||
|-
| AfterMapObjDrawAir ||
|-
| CloudStep || Cloud platform that can move on paths as well
|-
| CloudSea || Unknown; used by the bowl swamp planet in Cloudy Court Galaxy
|-
| HipDropMoveBlock || Moves when groundpounded on its Y-Axis; used by the blocks in Puzzle Plank Galaxy 
*'''Obj_arg0''': Units, how far the object may be pushed at most in one direction; a positive number lets you move the object from the bottom up, while a negative number lets you move it from the top down. 
*'''Obj_arg1''': How many times you have to stomp on it until it reaches the end point set above 
*'''Obj_arg2''': Rising Speed 
*'''Obj_arg3''': Can be stomped only in one direction? -1 = No, 0 = Yes; allows stomping only in the direction set in arg_0
|-
| GorogoroCylinderRock || Rolling cylinder rocks that move on a path and respawn; see Clockwork Ruins Galaxy
|-
| SwitchingMoveBlock || Moves when a switch is activated. Used by the red and blue platforms in Flip-Out Galaxy '''obj_arg0''': How many units this object moves on its X Axis '''obj_arg1''': How many units this object moves on its Y Axis '''obj_arg2''': How many units this object moves on its Z Axis '''obj_arg3''': How many units this object rotates on its X Axis '''obj_arg4''': How many units this object rotates on its Y Axis '''obj_arg5''': How many units this object rotates on its Z Axis
|}

Worldmap

2024-08-16T12:50:53Z

Louis Miles:

[[Category:Lists]]
{{WIP}}
Todo:
*What is the difference between the stage types HideGalaxy and MiniGalaxy?

All information of the world map like paths, points, galaxies and more are stored in the ''WorldMap0X.arc'' file in the ''ObjectData'' folder, with X being the world number. WorldMap08.arc is the Grand Galaxy Map.

Each world map is loaded inside a galaxy stage, which in the original game mainly contains the background. The stage files can be found in ''StageData/WorldMap0XGalaxy/''.

==General Notes==
*Paths from point with ID 0 are automatically unlocked when entering the world for the first time.
*Lubba's talking sequence when first entering the first world, has a hardcoded behavior to show an arrow over the galaxy ''YosshiHomeGalaxy''. If the Galaxy icon with this name does not exist, the game crashes (the galaxy itself does not have to exist).
*A point with a pipe attached to two paths can confuse the game if you try to pass the pipe by clicking with the pointer on a point; Starship Mario will then erroneously go out and in the pipe several times.
*Gourmet Lumas cannot eat star pieces if the required number of star pieces is less than 100; the star pieces then simply fly through him.
*The game remembers various unlock and interaction properties of PointParts objects. If you change and swap them, it can happen that with the old save file the objects are not interactable (e.g. star clusters can no longer be touched).
*The game crashes on the world map if the scenario file for ''HomeCenterGalaxy'' doesn't exist.

==Structure==
The WorldMap0X.arc files contain several [[BCSV (File format)|BCSV]] tables, which can be found in the original game either in the root or in a folder called ActorInfo, it doesn't matter if they are in the root or in this folder. The game reads the files either way.

*'''PointPos:''' Positions and properties of the points
*'''PointLink:''' Paths/connections of the points
*'''Galaxy:''' Galaxies and their properties
*'''PointParts:''' Various objects like star clusters, pipes and world gates
*'''SpaceParts:''' Unknown/Unused. Seems to be a different kind of PointParts.
*'''PointStream:''' Unknown/Unused

===PointPos===
{| class="wikitable"
|-
! Field Name
! style="font-size:100%;" | Type
! Description
|-
| Index
| style="font-size:12px;" | LONG
| Point ID
|-
| Valid
| style="font-size:12px;" | STRING_OFFSET
| Should always be set to valid. Invalid makes the point invisible but still accessible through a path, however, the game crashes when you point to it with the pointer. x = invalid o = valid
|-
| SubPoint
| style="font-size:12px;" | STRING_OFFSET
| Always false (x). Marks the point as a subpoint (blue and only accessible after unlocking the path). However, this is useless and unused, because the SubPaths already sets the points as subpoints. (More about this below at PointLink) x = false o = true
|-
| ColorChange
| style="font-size:12px;" | STRING_OFFSET
| Color of the point. Pink is usually used for Gourmet Luma paths. x = yellow o = pink
|-
| LayerNo
| style="font-size:12px;" | LONG
| Unknown; Unused
|-
| PointPosX
| style="font-size:12px;" | FLOAT
| X Position
|-
| PointPosY
| style="font-size:12px;" | FLOAT
| Y Position
|-
| PointPoxZ
| style="font-size:12px;" | FLOAT
| Z Position
|}

====Notes====
*The Grand Galaxy Map does not feature the ColorChange field.
*World Map 1, 2 and 6 contain unused, unlinked points which are set as invalid. This suggests that this field may have been used by the developers to temporarily disable points for possible reuse at a later time.

===PointLink===
{| class="wikitable"
|-
! Field Name
! style="font-size:100%;" | Type
! Description
|-
| PointIndexA
| style="font-size:12px;" | LONG
| Point ID of the first point to link
|-
| PointIndexB
| style="font-size:12px;" | LONG
| Point ID of the second point to link
|-
| CloseStageName
| style="font-size:12px;" | STRING_OFFSET
| Internal name of the galaxy to be completed to unlock this path. This is used for paths that are only unlocked from certain galaxy paths that should not be reached from the other side. (e.g. FlowerHighlandGalaxy's path).
|-
| CloseStageScenarioNo
| style="font-size:12px;" | LONG
| The scenario number to be completed in the galaxy specified in the previous field to unlock this path. 0 = Any scenario -1 = Default for normal paths
|-
| CloseGameFlag
| style="font-size:12px;" | STRING_OFFSET
| Required [[Game Flags|Game Flag]] to unlock this Path. This field makes the path invisible and inaccessible until the entered game flag is fulfilled. However, this does not unlock the path, it just makes it visible and may need to be unlocked by a galaxy in front of it first.
|-
| IsSubRoute
| style="font-size:12px;" | STRING_OFFSET
| Whether the path is displayed as either blue dotted or completely invisible if it has not yet been unlocked. Invisible is often used for Gourmet Luma paths as well as some stargate paths. x = normal/dotted o = invisible
|-
| IsColorChange
| style="font-size:12px;" | STRING_OFFSET
| Color of the path. Pink is usually used for Gourmet Luma paths. x = yellow o = pink
|}

===Galaxy===
{| class="wikitable"
|-
! Field Name
! style="font-size:100%;" | Type
! Description
|-
| StageName
| style="font-size:12px;" | STRING_OFFSET
| Internal name of the galaxy (ex. RedBlueExGalaxy)
|-
| MiniatureName
| style="font-size:12px;" | STRING_OFFSET
| Model name of the mini model to display (ex. MiniRedBlueExGalaxy)
|-
| PointPosIndex
| style="font-size:12px;" | LONG
| ID of the point on which the Galaxy is located 
|-
| StageType
| style="font-size:12px;" | STRING_OFFSET
| Sets various visibility settings depending on the type: '''Galaxy:''' Normal Galaxy; always visible '''MiniGalaxy:''' Hungry Luma Galaxy; always invisible until the way to it is unlocked '''HideGalaxy:''' Hidden Galaxy; always invisible until the way to it is unlocked '''BossGalaxyLv1:''' Bowser Jr. Galaxy; Adds a Bowser Jr. flag to a specific part of the mini-model. '''BossGalaxyLv2:''' Bowser Galaxy; Adds a Bowser flag to a specific part of the mini model. '''BossGalaxyLv3:''' Final Bowser Galaxy; Mini model does not rotate. This does not specify what kind of galaxy it is.
|-
| ScaleMin
| style="font-size:12px;" | FLOAT
| Normal scale of the mini model 
|-
| ScaleMax
| style="font-size:12px;" | FLOAT
| Scale of the mini model when pointed to with pointer 
|-
| PosOffsetX
| style="font-size:12px;" | FLOAT
| X-offset position of the mini-model from the point.
|-
| PosOffsetY
| style="font-size:12px;" | FLOAT
| Y-offset position of the mini-model from the point.
|-
| PosOffsetZ
| style="font-size:12px;" | FLOAT
| Z-offset position of the mini-model from the point.
|-
| NamePlatePosY
| style="font-size:12px;" | FLOAT
| X-offset position of the name plate from mini model.
|-
| NamePlatePosZ
| style="font-size:12px;" | FLOAT
| Z-offset position of the name plate from mini model.
|-
| IconOffsetX
| style="font-size:12px;" | FLOAT
| Icon X position in the world selection screen (Grand Galaxy Map)
|-
| IconOffsetY
| style="font-size:12px;" | FLOAT
| Icon Y position in the world selection screen (Grand Galaxy Map)
|}

===PointParts===
{| class="wikitable"
|-
! Field Name
! style="font-size:100%;" | Type
! Description
|-
| PartsTypeName
| style="font-size:12px;" | STRING_OFFSET
| Name of the object: '''StarPieceMine:''' Starbit Cluster '''StarCheckPoint:''' Star Gate '''TicoRouteCreator:''' Hungry Luma '''EarthenPipe:''' Warp Pipe '''WorldWarpPoint:''' World Portal '''StarRoadWarpPoint:''' Grand World Portal
|-
| PointIndex
| style="font-size:12px;" | LONG
| ID of the point on which the object is located 
|-
| PartsIndex
| style="font-size:12px;" | LONG
| Index for Stargates. Each stargate within a world map requires a unique index. 
|-
| Param00
| style="font-size:12px;" | LONG
| Parameter 1. Different usage for each object type.
|-
| Param01
| style="font-size:12px;" | LONG
| Parameter 2. Different usage for each object type.
|-
| Param02
| style="font-size:12px;" | LONG
| Parameter 3. Unused.
|}

====Parameters====
{| class="wikitable"
|-
! PartsTypeName
! Param00
! Param01
|-
| StarCheckPoint
| Required stars
|
|-
| TicoRouteCreator
| Required starbits
| Point ID destination
|-
| EarthenPipe
| Point ID destination
|
|-
| WorldWarpPoint
| World ID destination
| Point ID destination
|-
| StarRoadWarpPoint
| World ID destination
| Point ID destination
|}

===SpaceParts===
{| class="wikitable"
|-
! Field Name
! style="font-size:12px;" | Type
! Description
|-
| PartsTypeName
| style="font-size:12px;" | STRING_OFFSET
|
|-
| [4D6DBDAE]
| style="font-size:12px;" | LONG
|
|-
| [433A5DB7]
| style="font-size:12px;" | LONG
|
|-
| Param00
| style="font-size:12px;" | LONG
|
|-
| Param01
| style="font-size:12px;" | LONG
|
|-
| [912C1F84]
| style="font-size:12px;" | STRING_OFFSET
|
|-
| LayerNo
| style="font-size:12px;" | LONG
|
|-
| TransX
| style="font-size:12px;" | FLOAT
|
|-
| TransY
| style="font-size:12px;" | FLOAT
|
|-
| TransZ
| style="font-size:12px;" | FLOAT
|
|-
| RotateX
| style="font-size:12px;" | FLOAT
|
|-
| RotateY
| style="font-size:12px;" | FLOAT
|
|-
| RotateZ
| style="font-size:12px;" | FLOAT
|
|-
| ScaleX
| style="font-size:12px;" | FLOAT
|
|-
| ScaleY
| style="font-size:12px;" | FLOAT
|
|-
| ScaleZ
| style="font-size:12px;" | FLOAT
|
|}

===PointStream===
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| StreamName
| style="font-size:12px;" | STRING_OFFSET
|
|-
| StreamIndex
| style="font-size:12px;" | LONG
|
|-
| PointNum
| style="font-size:12px;" | LONG
|
|}

==Cameras==
All cameras for the different views are in ''ObjectData/WorldMapCamera.arc/ActorInfo/CameraParam.bcam''. A few tracking shots for specific sequences, such as when Mario travels to a galaxy, are controlled by the [[CAMN]] camera key animation files and can be found in ''ObjectData/MarioAnim.arc''.

There are more specific cameras, which are partly used to link different camera-usages with the cameras from WorldMapCamera.arc and can be found in the map archives of the individual WorldMap0XGalaxy stages in BCAM format, although some camera codes appear to be completely unused.

==Tools==
There are two programs for editing world maps.

===[https://github.com/RealTheSunCat/Whitehole/releases/tag/v1.7fix Whitehole]===
Version 1.5.1 and higher include a powerful world editor that displays the world map within the 3D view. However, the world map cannot be edited by clicking on the objects, but only by using the bar on the left side. In addition, various parameters such as mini-model positions, name plates and by marking the destination points of certain objects such as pipes can be edited very easily and quickly through the 3D display.

This editor also features the very useful '''QuickActions''' tab, which displays time-saving options depending on what type of object is currently selected:
*'''Add Connected Point''' Adds a new point to a selected point, complete with connected link.
*'''Insert Point''' Halves a selected link and inserts a new point in the center
*'''Add conntected pipe''' Adds a connected pipe to a selected pipe
*'''Add conntected SecretGalaxy''' Adds a preset secret galaxy to a selected Hungry Luma
*'''Load Default Template''' Loads a template for creating a new world

''Note: If you experience any bugs in later versions, use the one from v.1.5.1. This one is known to have none of the glitches. You may only need to click on Help -> Controls to fix a bug that prevents you from selecting the various settings and values.''

===[https://kuribo64.net/get.php?id=CcQpzf8GviY8rv9m World Map Editor]===
An old tool, which like Whitehole only has a bar for editing, but has little functionality for editing. For example, links and points must be added individually. Some text information are also partially wrong. 
It has no 3D view, but a 2D view of the points and paths as well as the kind of paths.

This tool can be useful for quick edits like exchanging galaxynames, since it only needs the WorldMap0X.arc file to edit.

Tools and Resources

2024-08-02T11:25:05Z

Louis Miles: /* Small Patches */

[[Category:Tools]]
{{WIP}}

==Tools==
Below are a lot of useful tools to deal with files and structures found in the ''Galaxy'' games. There are many more tools that may aid in modding the games, but these were excluded due to being too outdated or obsolete.

{| class="wikitable"
! Name !! Authors !! Language !! Platforms !! Description !! Preview
|-
! colspan="7" | General
|-
| [https://github.com/SunakazeKun/Whitehole-Despaghettification Whitehole Despaghettification] || Arisotura, Aurum, jupahe64, TheSunCat, etc. || Java || Windows, Linux, Mac || A major rewrite of the old 3D level editor for both ''Galaxy'' games. This is essential for most projects. There are also more features, such as the BCSV editor. || [[File:Whitehole_RedBlueExGalaxy.png|250px]]
|-
| [https://github.com/SuperHackio/Scenaristar Scenaristar] || Super Hackio || C# || Windows || A standalone scenario editor for ''Super Mario Galaxy 2'' featuring a clean and easy-to-use UI. Can be used to add, remove and edit scenario entries. || [[File:Scenaristar_RedBlueExGalaxy.png|250px]]
|-
| [https://github.com/SuperHackio/LaunchCamPlus Launch Cam Plus] || Super Hackio || C# || Windows || A standalone camera editor for both ''Galaxy'' games. It requires some learning, however, as there is no visual feedback. It consists of several useful functions such as preset options, copypaste and optional experimental "unique editors" for different types. || [[File:LaunchCamPlus_RedBlueExGalaxy.png|250px]]
|-
| [https://cdn.discordapp.com/attachments/421356181844393984/977759404684365875/CANM_editor.zip CANM editor] || Phantomwings(?) || C# || Windows || A low-level editor for key-framed camera animations, such as the ones used for Galaxy intros. There is no visual feedback, meaning that it is somewhat difficult to use. ||
|-
| [https://github.com/SuperHackio/WiiExplorer WiiExplorer] || Super Hackio || C# || Windows || An all-purpose archiving tool that supports RARC and U8 archives. Can be used to create and extract archives and edit, replace, rename, extract and organize the contents of these archive files. Supports all sorts of other games as well. || [[File:WiiExplorer_RedBlueExGalaxy.png|250px]]
|-
| [https://kuribo64.net/get.php?id=5c98RKoV3uJdGBin RARC Tools] || thakis || C || Windows || General Drag and Drop tools for archive manipulation. Consists of programs to deal with SZS compression (''yaz0dec'' & ''yaz0enc'') and RARC archives (''rarcdump'' & ''rarcpack''). Simply drag and drop the source file onto the respective programs and the work will be done for you. Also useful for batch script usage.||
|-
| [https://github.com/SunakazeKun/pyjmap pyjmap] || Aurum || Python || Windows, Linux, Mac || A high-level implementation of Nintendo's homemade BCSV/JMap data format. This includes methods to construct, analyze, manipulate, deserialize and serialize proper JMap data. Conversion between CSV and BCSV files is also supported. ||
|-
| [https://github.com/SunakazeKun/pygapa pygapa] || Aurum || Python || Windows, Linux, Mac || An editor for particles and effect data in both ''Galaxy'' games. It features a GUI editor to open, edit and save ''Effect.arc'' files. Additionally, it contains a bunch of functions to extract, dump, import and pack particle data. Command-line operations (Batch mode) are supported as well. || [[File:Screenshot_Res_pygapa.png|250px]]
|-
| [https://szs.wiimm.de/ wszst] || Wiimm || C || Windows, Linux, Mac || Wiimms SZS Tools is a set of command line tools to extract, modify and create different files of game Mario Kart Wii and of other Nintendo games. Source code is available on [https://github.com/Wiimm/wiimms-szs-tools GitHub]. ||

|-
! colspan="7" | Sounds & Music
|-
| [https://github.com/gheskett/Nintendo-AST-Creator ASTCreate] || gheskett || C++ || Windows || Command-line tool to convert between WAV and [[AST]] files that features looping options. ||
|-
| [http://www.xayr.ga/tools/SoundModdingToolkit/ SoundModdingToolkit] || XAYRGA || n/a || Windows || Low-level toolkit to edit sounds in both ''Galaxy'' games (and many other Nintendo titles). ||

|-
! colspan="7" | Modelling
|-
| [https://github.com/RenolY2/j3dview j3dview] || blank, RenolY2 || Python || Windows, Linux, Mac || A BMD/BDL rendering program. Can render most models with 90% accuracy, and can play BCK, BTK, BRK, BTP, BVA, and BPK animations. You can also replace the model's textures. ||
|-
| [https://github.com/RenolY2/SuperBMD SuperBMD] || Sage of Mirrors, RenolY2 || C# || Windows || A BMD/BDL model converter. Can convert BMD/BDL to .dae and .dae/.fbx to BMD/BDL. Allows the use of Material.json files to edit materials. ||
|-
| [https://github.com/tarsa129/j3d-animation-editor j3d-animation-editor] || tarsa129, epichickensoup || Python || Windows, Linux, Mac || An editor and converter for most J3D animation formats. Includes an FBX/BVH/anim to BCK converter. Can also convert animations to Maya anim format. ||
|-
| [https://github.com/RenolY2/btk-conv btk-conv] ||RenolY2 || Python || Windows, Linux, Mac || A BTK <-> JSON converter. Converts a BTK to a JSON, and vise versa. Drag and Drop usage. ||
|-
| [https://github.com/RenolY2/bark-conv bark-conv] || RenolY2 || Python || Windows, Linux, Mac || A BRK <-> JSON converter. Converts a BRK to a JSON, and vise versa. Drag and Drop usage. ||
|-
| [https://github.com/SuperHackio/NeoKclCreate NeoKclCreate] || Super Hackio || C# || Windows || A KCL and PA Collision Import/Export tool. Converts an OBJ and MTL into a KCL and PA (your collision files). Includes proper names for each collision code, presets for common collision uses, and allows the dumping of KCL models to obj files. ||
|-
| [https://github.com/gayfrogog/pyKCLCreate#pykclcreate pyKCLCreate] || blank, Froggo || Python || Windows, Linux, Mac || A KCL and PA Collision Creator. Converts an OBJ with it's packaged MTL into a KCL and PA (your collision files). Requires PyQt5 to work. ||
|-
| [https://github.com/Gabbo089/SlideCalculator Slide Calculator] || Gabbo || Python || Windows, Linux, Mac || Blender Add-on. Can calculate the coordinates of the control points and handles of a Bezier curve and convert them into Whitehole coordinates. It allows the creation of custom slide levels. ||

|-
! colspan="7" | Layout
|-
| [https://github.com/KillzXGaming/Switch-Toolbox/tags Switch Toolbox] || KillzXGaming || C# || Windows || Contains a layout editor that can edit all properties of [[BRLYT]] layout files and an animation previewer. It can start the layout editor directly by opening the ARC file.Be sure to turn off ARC Compression, because it does not work properly. Brlan animation editing is also broken. ||
|-
| [https://wiki.tockdom.com/wiki/Wii_Layout_Editor Wii Layout Editor] || Gericom || C# || Windows || Older layout editor. Can display layouts and animations based on exported ARC folder structure (anim, timg and blyt folders) and only move and edit objects to a limited extent. ||
|-
| [https://wiibrew.org/wiki/Benzin Benzin] || SquidMan, comex, megazig, Yossi and CheatFreak47 || ? || Windows || Command line tools for BRLYT/BRLAN <-> XML conversion usage.||
|-
| [https://drive.google.com/file/d/1Pf5ZIBGe0UHrZdSXj1W3_gML1VkMhvAM/view Wexos Toolbox] || Wexos || C# || Windows || Tool for editing Wii-specific formats such as BTI. The only tool that includes an editor for BRLAN animation files. ||

|-
! colspan="7" | Texts
|-
| [https://kuribo64.net/get.php?id=vsMm2Z3lxngxEX5W msbconv] || blank(?) || Python 2 || Windows, Linux, Mac || Outdated MSBT to XML Converter and vise versa. Drag and Drop or command line/batch script usage. Supports all characters including japanese font. For use with ''Super Mario Galaxy 2''. ||
|-
| [https://github.com/penguin117117/MSBT_Editor MSBT_Editor] || ぺんぐいん (penguin117117) || C# || Windows || MSBT and MSBF editor - supports Japanese exclusive text features. For use with ''Super Mario Galaxy 2''. ||
|-
| [https://github.com/ZyphronG/Tomato Tomato] || Zyphron G. || C++ || Windows, Linux, Mac || BMG and TBL converter to XML and vise versa, causes will be less common. For use with ''Super Mario Galaxy 1''. ||

|-
! colspan="7" | Assorted
|-
| [https://github.com/SunakazeKun/Syati Syati] || shibbo, Aurum || C++ || Windows || A coding toolkit for Super Mario Galaxy 2 which provides headers, sample code, symbols and the actual loader. It is also able to patch a DOL file to incorporate the loader. ||
|-
| [https://github.com/SuperHackio/SMG2MarioConstEditor SMG2MarioConstEditor] || Super Hackio || C# || Windows || A tool that allows you to edit parameters for playable characters in Super Mario Galaxy 2. These parameters affect jump height, running speed, Power-Ups timers and much more. ||
|-
| [https://github.com/Lord-Giganticus/THP-Conveter THP-Converter] || Lord-Giganticus || C#, Python || Windows || A tool to convert between MP4 and THP videos. This also features a command-line functionality. ||
|-
| [https://github.com/RoadrunnerWMC/BRFNTify-Next BRFNTify Next] || Tempus, RoadrunnerWMC || Python || Windows, Linux, Mac || NW4R font editor that can edit, expand and replace existing fonts. ||
|-
| [https://wit.wiimm.de/ wit] || Wiimm || C, Assembly || Windows, Linux, Mac || Wiimms ISO Tools is a set of command line tools to extract, modify and create Wii and GameCube ISO images and WBFS containers. The source code can be found on [https://github.com/Wiimm/wiimms-iso-tools GitHub]. ||
|-
|}

==Extensions==
{| class="wikitable"
! Name !! Authors !! Language !! Games !! Description !! Preview
|-
|style="width: 200px"| [https://github.com/SunakazeKun/SMG2-Project-Template Project Template] ||style="width: 120px"| Aurum || C++ || SMG2 || A package consisting of useful files, patches and data to expand ''Super Mario Galaxy 2''. This includes many new coded objects, such as Cataquacks, Montys, Jump Guarder, the Ice Flower & Flying Star power-ups, Pull Star Chips, custom Power Star colors, and a lot more. || [[File:Screenshot_Res_ProjectTemplate.png|250px]]
|-
| [https://github.com/SuperHackio/GalaxyLevelEngine Galaxy Level Engine] || Super Hackio || PowerPC || SMG2 || A new Level Engine for ''Super Mario Galaxy 2'', featuring a new hubworld system instead of the World Maps, 8 yellow stars, and more! Supports the major regions of the game (NTSC-U, PAL, and NTSC-J) || https://www.youtube.com/watch?v=wyFxaiIbbZE
|-
| [https://github.com/SuperHackio/SMG2-FPSCounterLayout SMG2 Frames per Second Counter Layout] || Super Hackio || C++ || SMG2 || A new layout intended for mod creators to reduce the amount of lag in their levels. Supports all Wii regions. ||
|-
| SMG1 Crash Debugger Patch || n/a || PowerPC || SMG1 || A Riivolution patch that enables the Crash Debugger in ''Super Mario Galaxy 1''. This supports all known Wii releases of the game:
<pre>

<memory offset="0x8039AA2C" value="60000000" original="98040068"/>
<memory offset="0x8039AAF0" value="60000000" original="4082FFB8"/>
<memory offset="0x804A432C" value="60000000" original="48000160"/>


<memory offset="0x8039AA48" value="60000000" original="98040068"/>
<memory offset="0x8039AB0C" value="60000000" original="4082FFB8"/>
<memory offset="0x804A432C" value="60000000" original="48000160"/>


<memory offset="0x8039AA2C" value="60000000" original="98040068"/>
<memory offset="0x8039AAF0" value="60000000" original="4082FFB8"/>
<memory offset="0x804A430C" value="60000000" original="48000160"/>


<memory offset="0x8039BF80" value="60000000" original="98040068"/>
<memory offset="0x8039C044" value="60000000" original="4082FFB8"/>
<memory offset="0x804A656C" value="60000000" original="48000160"/>
</pre>
||
|}

==Small Patches==
Below are a some small patches you can copy+paste into your hack's Riivolution XML
{| class="wikitable"
! Name !! Authors !! Games !! Code !! Description
|-
| Don't lose coins upon death. || SuperHackio || SMG2 || <pre>

<memory offset="0x804C92AC" value="60000000" />
</pre> || Causes the game to keep your coin count when you die in a level.
|-
| Lose Starbits upon death. || SuperHackio || SMG2 || <pre>

<memory offset="0x804C92D0" value="90A3004C4E800020" />
</pre> || Causes the game to remove all your starbits upon death in a level.
|-
| Collect Comet Medals Permanently || SuperHackio || SMG2 || <pre>

<memory offset="0x80322FE0" value="4BD33571481AFB0D" />
</pre> || This makes every comet medal permanently collectable.Example: If you enter a stage, get the comet medal, then pause and quit the level, you'll keep the comet medal.
|-
| Remove all original galaxies || Louis Miles || SMG2 || {{#spoiler: <pre> <folder disc="/LevelData" external="StageData" create="true" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80663131" /> 
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806643e1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806716e1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80671711" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80671755" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8069d5f1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806f68b5" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80701a75" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80701be1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065DA31" /> 
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065ECE1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066BFE1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066C011" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066C055" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80697EF1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806F11B5" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FC375" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FC4E1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065D211" /> 
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065E4C1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066B7C1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066B7F1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066B835" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806976D1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806F0995" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FBB55" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FBCC1" /></pre> }} || Removes all original galaxies, making it easy to add new galaxy slots. Works with US, EU and JP versions.

The following stages are necessary for the game to work:
*FileSelect
*PeachCastleGalaxy
*MarioFaceShipGalaxy
*HomeCenterGalaxy
*WorldMap0XGalaxy stages with GrandGalaxyMapZone

The [[GalaxyDataTable]] also requires 6 galaxy slots with a set Grand Star from 1 - 6.
|}

==Miscellaneous==
Various other resources and websites are listed here for the purpose of documentation.

* [https://web.archive.org/web/20181217155847/http://lumasworkshop.bplaced.net/index.php ''Luma's Workshop'' Web Archive]: The original forums from 2018, preserved by Web Archive. If you feel like browsing through a small bit of history, here you go. Several old documentations can be accessed through this.
* [https://kuribo64.net/board/?board=archive ''Kuribo64'' forums]: Originally, Kuribo64 was the place for ''Galaxy'' modding. If you are in for another time travel, consider looking through the posts. Keep in mind that the information you are going to find over there is very outdated and not accurate anymore.
* [https://github.com/shibbo/Petari Petari]: A work-in-progress decompilation of ''Super Mario Galaxy 1'' that also serves as a documentation of the actual game.
* [https://github.com/shibbo/Takochu Takochu]: An abandoned level editor originally slated to release in 2022. Due to some tensions, this project has been cancelled and therefore archived, waiting for people to pick it up and finish it.
* [https://noclip.website noclip.website]: A virtual "museum" which features various selected levels and locations from video games. This also features very accurate rendering for both ''Galaxy'' games.

Tools and Resources

2024-08-01T12:51:24Z

Louis Miles: /* Small Patches */ Added remove original galaxy slots patch

[[Category:Tools]]
{{WIP}}

==Tools==
Below are a lot of useful tools to deal with files and structures found in the ''Galaxy'' games. There are many more tools that may aid in modding the games, but these were excluded due to being too outdated or obsolete.

{| class="wikitable"
! Name !! Authors !! Language !! Platforms !! Description !! Preview
|-
! colspan="7" | General
|-
| [https://github.com/SunakazeKun/Whitehole-Despaghettification Whitehole Despaghettification] || Arisotura, Aurum, jupahe64, TheSunCat, etc. || Java || Windows, Linux, Mac || A major rewrite of the old 3D level editor for both ''Galaxy'' games. This is essential for most projects. There are also more features, such as the BCSV editor. || [[File:Whitehole_RedBlueExGalaxy.png|250px]]
|-
| [https://github.com/SuperHackio/Scenaristar Scenaristar] || Super Hackio || C# || Windows || A standalone scenario editor for ''Super Mario Galaxy 2'' featuring a clean and easy-to-use UI. Can be used to add, remove and edit scenario entries. || [[File:Scenaristar_RedBlueExGalaxy.png|250px]]
|-
| [https://github.com/SuperHackio/LaunchCamPlus Launch Cam Plus] || Super Hackio || C# || Windows || A standalone camera editor for both ''Galaxy'' games. It requires some learning, however, as there is no visual feedback. It consists of several useful functions such as preset options, copypaste and optional experimental "unique editors" for different types. || [[File:LaunchCamPlus_RedBlueExGalaxy.png|250px]]
|-
| [https://cdn.discordapp.com/attachments/421356181844393984/977759404684365875/CANM_editor.zip CANM editor] || Phantomwings(?) || C# || Windows || A low-level editor for key-framed camera animations, such as the ones used for Galaxy intros. There is no visual feedback, meaning that it is somewhat difficult to use. ||
|-
| [https://github.com/SuperHackio/WiiExplorer WiiExplorer] || Super Hackio || C# || Windows || An all-purpose archiving tool that supports RARC and U8 archives. Can be used to create and extract archives and edit, replace, rename, extract and organize the contents of these archive files. Supports all sorts of other games as well. || [[File:WiiExplorer_RedBlueExGalaxy.png|250px]]
|-
| [https://kuribo64.net/get.php?id=5c98RKoV3uJdGBin RARC Tools] || thakis || C || Windows || General Drag and Drop tools for archive manipulation. Consists of programs to deal with SZS compression (''yaz0dec'' & ''yaz0enc'') and RARC archives (''rarcdump'' & ''rarcpack''). Simply drag and drop the source file onto the respective programs and the work will be done for you. Also useful for batch script usage.||
|-
| [https://github.com/SunakazeKun/pyjmap pyjmap] || Aurum || Python || Windows, Linux, Mac || A high-level implementation of Nintendo's homemade BCSV/JMap data format. This includes methods to construct, analyze, manipulate, deserialize and serialize proper JMap data. Conversion between CSV and BCSV files is also supported. ||
|-
| [https://github.com/SunakazeKun/pygapa pygapa] || Aurum || Python || Windows, Linux, Mac || An editor for particles and effect data in both ''Galaxy'' games. It features a GUI editor to open, edit and save ''Effect.arc'' files. Additionally, it contains a bunch of functions to extract, dump, import and pack particle data. Command-line operations (Batch mode) are supported as well. || [[File:Screenshot_Res_pygapa.png|250px]]
|-
| [https://szs.wiimm.de/ wszst] || Wiimm || C || Windows, Linux, Mac || Wiimms SZS Tools is a set of command line tools to extract, modify and create different files of game Mario Kart Wii and of other Nintendo games. Source code is available on [https://github.com/Wiimm/wiimms-szs-tools GitHub]. ||

|-
! colspan="7" | Sounds & Music
|-
| [https://github.com/gheskett/Nintendo-AST-Creator ASTCreate] || gheskett || C++ || Windows || Command-line tool to convert between WAV and [[AST]] files that features looping options. ||
|-
| [http://www.xayr.ga/tools/SoundModdingToolkit/ SoundModdingToolkit] || XAYRGA || n/a || Windows || Low-level toolkit to edit sounds in both ''Galaxy'' games (and many other Nintendo titles). ||

|-
! colspan="7" | Modelling
|-
| [https://github.com/RenolY2/j3dview j3dview] || blank, RenolY2 || Python || Windows, Linux, Mac || A BMD/BDL rendering program. Can render most models with 90% accuracy, and can play BCK, BTK, BRK, BTP, BVA, and BPK animations. You can also replace the model's textures. ||
|-
| [https://github.com/RenolY2/SuperBMD SuperBMD] || Sage of Mirrors, RenolY2 || C# || Windows || A BMD/BDL model converter. Can convert BMD/BDL to .dae and .dae/.fbx to BMD/BDL. Allows the use of Material.json files to edit materials. ||
|-
| [https://github.com/tarsa129/j3d-animation-editor j3d-animation-editor] || tarsa129, epichickensoup || Python || Windows, Linux, Mac || An editor and converter for most J3D animation formats. Includes an FBX/BVH/anim to BCK converter. Can also convert animations to Maya anim format. ||
|-
| [https://github.com/RenolY2/btk-conv btk-conv] ||RenolY2 || Python || Windows, Linux, Mac || A BTK <-> JSON converter. Converts a BTK to a JSON, and vise versa. Drag and Drop usage. ||
|-
| [https://github.com/RenolY2/bark-conv bark-conv] || RenolY2 || Python || Windows, Linux, Mac || A BRK <-> JSON converter. Converts a BRK to a JSON, and vise versa. Drag and Drop usage. ||
|-
| [https://github.com/SuperHackio/NeoKclCreate NeoKclCreate] || Super Hackio || C# || Windows || A KCL and PA Collision Import/Export tool. Converts an OBJ and MTL into a KCL and PA (your collision files). Includes proper names for each collision code, presets for common collision uses, and allows the dumping of KCL models to obj files. ||
|-
| [https://github.com/gayfrogog/pyKCLCreate#pykclcreate pyKCLCreate] || blank, Froggo || Python || Windows, Linux, Mac || A KCL and PA Collision Creator. Converts an OBJ with it's packaged MTL into a KCL and PA (your collision files). Requires PyQt5 to work. ||
|-
| [https://github.com/Gabbo089/SlideCalculator Slide Calculator] || Gabbo || Python || Windows, Linux, Mac || Blender Add-on. Can calculate the coordinates of the control points and handles of a Bezier curve and convert them into Whitehole coordinates. It allows the creation of custom slide levels. ||

|-
! colspan="7" | Layout
|-
| [https://github.com/KillzXGaming/Switch-Toolbox/tags Switch Toolbox] || KillzXGaming || C# || Windows || Contains a layout editor that can edit all properties of [[BRLYT]] layout files and an animation previewer. It can start the layout editor directly by opening the ARC file.Be sure to turn off ARC Compression, because it does not work properly. Brlan animation editing is also broken. ||
|-
| [https://wiki.tockdom.com/wiki/Wii_Layout_Editor Wii Layout Editor] || Gericom || C# || Windows || Older layout editor. Can display layouts and animations based on exported ARC folder structure (anim, timg and blyt folders) and only move and edit objects to a limited extent. ||
|-
| [https://wiibrew.org/wiki/Benzin Benzin] || SquidMan, comex, megazig, Yossi and CheatFreak47 || ? || Windows || Command line tools for BRLYT/BRLAN <-> XML conversion usage.||
|-
| [https://drive.google.com/file/d/1Pf5ZIBGe0UHrZdSXj1W3_gML1VkMhvAM/view Wexos Toolbox] || Wexos || C# || Windows || Tool for editing Wii-specific formats such as BTI. The only tool that includes an editor for BRLAN animation files. ||

|-
! colspan="7" | Texts
|-
| [https://kuribo64.net/get.php?id=vsMm2Z3lxngxEX5W msbconv] || blank(?) || Python 2 || Windows, Linux, Mac || Outdated MSBT to XML Converter and vise versa. Drag and Drop or command line/batch script usage. Supports all characters including japanese font. For use with ''Super Mario Galaxy 2''. ||
|-
| [https://github.com/penguin117117/MSBT_Editor MSBT_Editor] || ぺんぐいん (penguin117117) || C# || Windows || MSBT and MSBF editor - supports Japanese exclusive text features. For use with ''Super Mario Galaxy 2''. ||
|-
| [https://github.com/ZyphronG/Tomato Tomato] || Zyphron G. || C++ || Windows, Linux, Mac || BMG and TBL converter to XML and vise versa, causes will be less common. For use with ''Super Mario Galaxy 1''. ||

|-
! colspan="7" | Assorted
|-
| [https://github.com/SunakazeKun/Syati Syati] || shibbo, Aurum || C++ || Windows || A coding toolkit for Super Mario Galaxy 2 which provides headers, sample code, symbols and the actual loader. It is also able to patch a DOL file to incorporate the loader. ||
|-
| [https://github.com/SuperHackio/SMG2MarioConstEditor SMG2MarioConstEditor] || Super Hackio || C# || Windows || A tool that allows you to edit parameters for playable characters in Super Mario Galaxy 2. These parameters affect jump height, running speed, Power-Ups timers and much more. ||
|-
| [https://github.com/Lord-Giganticus/THP-Conveter THP-Converter] || Lord-Giganticus || C#, Python || Windows || A tool to convert between MP4 and THP videos. This also features a command-line functionality. ||
|-
| [https://github.com/RoadrunnerWMC/BRFNTify-Next BRFNTify Next] || Tempus, RoadrunnerWMC || Python || Windows, Linux, Mac || NW4R font editor that can edit, expand and replace existing fonts. ||
|-
| [https://wit.wiimm.de/ wit] || Wiimm || C, Assembly || Windows, Linux, Mac || Wiimms ISO Tools is a set of command line tools to extract, modify and create Wii and GameCube ISO images and WBFS containers. The source code can be found on [https://github.com/Wiimm/wiimms-iso-tools GitHub]. ||
|-
|}

==Extensions==
{| class="wikitable"
! Name !! Authors !! Language !! Games !! Description !! Preview
|-
|style="width: 200px"| [https://github.com/SunakazeKun/SMG2-Project-Template Project Template] ||style="width: 120px"| Aurum || C++ || SMG2 || A package consisting of useful files, patches and data to expand ''Super Mario Galaxy 2''. This includes many new coded objects, such as Cataquacks, Montys, Jump Guarder, the Ice Flower & Flying Star power-ups, Pull Star Chips, custom Power Star colors, and a lot more. || [[File:Screenshot_Res_ProjectTemplate.png|250px]]
|-
| [https://github.com/SuperHackio/GalaxyLevelEngine Galaxy Level Engine] || Super Hackio || PowerPC || SMG2 || A new Level Engine for ''Super Mario Galaxy 2'', featuring a new hubworld system instead of the World Maps, 8 yellow stars, and more! Supports the major regions of the game (NTSC-U, PAL, and NTSC-J) || https://www.youtube.com/watch?v=wyFxaiIbbZE
|-
| [https://github.com/SuperHackio/SMG2-FPSCounterLayout SMG2 Frames per Second Counter Layout] || Super Hackio || C++ || SMG2 || A new layout intended for mod creators to reduce the amount of lag in their levels. Supports all Wii regions. ||
|-
| SMG1 Crash Debugger Patch || n/a || PowerPC || SMG1 || A Riivolution patch that enables the Crash Debugger in ''Super Mario Galaxy 1''. This supports all known Wii releases of the game:
<pre>

<memory offset="0x8039AA2C" value="60000000" original="98040068"/>
<memory offset="0x8039AAF0" value="60000000" original="4082FFB8"/>
<memory offset="0x804A432C" value="60000000" original="48000160"/>


<memory offset="0x8039AA48" value="60000000" original="98040068"/>
<memory offset="0x8039AB0C" value="60000000" original="4082FFB8"/>
<memory offset="0x804A432C" value="60000000" original="48000160"/>


<memory offset="0x8039AA2C" value="60000000" original="98040068"/>
<memory offset="0x8039AAF0" value="60000000" original="4082FFB8"/>
<memory offset="0x804A430C" value="60000000" original="48000160"/>


<memory offset="0x8039BF80" value="60000000" original="98040068"/>
<memory offset="0x8039C044" value="60000000" original="4082FFB8"/>
<memory offset="0x804A656C" value="60000000" original="48000160"/>
</pre>
||
|}

==Small Patches==
Below are a some small patches you can copy+paste into your hack's Riivolution XML
{| class="wikitable"
! Name !! Authors !! Games !! Code !! Description
|-
| Don't lose coins upon death. || SuperHackio || SMG2 || <pre>

<memory offset="0x804C92AC" value="60000000" />
</pre> || Causes the game to keep your coin count when you die in a level.
|-
| Lose Starbits upon death. || SuperHackio || SMG2 || <pre>

<memory offset="0x804C92D0" value="90A3004C4E800020" />
</pre> || Causes the game to remove all your starbits upon death in a level.
|-
| Collect Comet Medals Permanently || SuperHackio || SMG2 || <pre>

<memory offset="0x80322FE0" value="4BD33571481AFB0D" />
</pre> || This makes every comet medal permanently collectable.Example: If you enter a stage, get the comet medal, then pause and quit the level, you'll keep the comet medal.
|-
| Remove all original galaxies || Louis Miles || SMG2 || {{#spoiler: <pre> <folder disc="/LevelData" external="StageData" create="true" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80663131" /> 
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806643e1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806716e1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80671711" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80671755" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8069d5f1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806f68b5" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80701a75" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80701be1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065DA31" /> 
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065ECE1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066BFE1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066C011" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066C055" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x80697EF1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806F11B5" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FC375" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FC4E1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065D211" /> 
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8065E4C1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066B7C1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066B7F1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x8066B835" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806976D1" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806F0995" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FBB55" />
<memory value="4C6576656C44617461" original="537461676544617461" offset="0x806FBCC1" /></pre> }} || Removes all original galaxies, making it easy to add new galaxy slots. Works with US, EU and JP versions.

The following stages are necessary for the game to work:
*FileSelect
*PeachCastleGalaxy
*MarioFaceShipGalaxy
*HomeCenterGalaxy
|}

==Miscellaneous==
Various other resources and websites are listed here for the purpose of documentation.

* [https://web.archive.org/web/20181217155847/http://lumasworkshop.bplaced.net/index.php ''Luma's Workshop'' Web Archive]: The original forums from 2018, preserved by Web Archive. If you feel like browsing through a small bit of history, here you go. Several old documentations can be accessed through this.
* [https://kuribo64.net/board/?board=archive ''Kuribo64'' forums]: Originally, Kuribo64 was the place for ''Galaxy'' modding. If you are in for another time travel, consider looking through the posts. Keep in mind that the information you are going to find over there is very outdated and not accurate anymore.
* [https://github.com/shibbo/Petari Petari]: A work-in-progress decompilation of ''Super Mario Galaxy 1'' that also serves as a documentation of the actual game.
* [https://github.com/shibbo/Takochu Takochu]: An abandoned level editor originally slated to release in 2022. Due to some tensions, this project has been cancelled and therefore archived, waiting for people to pick it up and finish it.
* [https://noclip.website noclip.website]: A virtual "museum" which features various selected levels and locations from video games. This also features very accurate rendering for both ''Galaxy'' games.

File:Cutscene Visual-Representation.png

2024-04-27T19:31:16Z

Louis Miles: Reupload

== Summary ==
Reupload

SMR.szs

2024-04-27T19:25:39Z

Louis Miles:

[[Category:Files]]
[[Category:Lists]]
{{WIP}}

SMR.szs is a compressed BAA-file which defines the game's sound system. It contains strings relating to music, as well as information about various sequenced music and sound effects. Among other things, the file paths of [[AST]] stream files and the names of BGM, MBGM and STM tracks are specified within this file.

The tool [https://xayr.gay/tools/SoundModdingToolkit/ SoundModdingToolkit] can convert this file into a clear and readable file structure, so the structure of the file is shown on this page using the tool's converted structure.

'''Please note that only version 4.1.0 can edit the lists without any problems. Later versions can lead to problems such as muted songs.'''

==BGM==
===MAIN_BGM===
Found in ''SoundTable/BGM/libraries/MAIN_BGM.json'' 
Defines the sequenced music. The music sequence files can be found in bms format in ''AudioRes/Seqs/JaiSeq.arc''.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
|
|-
| unk2
|
|-
| unk3
| File ID of the bms file in JaiSeq.arc to use (the filename is ignored)
|-
| unk4
|
|-
| unk5
|
|-
| type
|
|-
| mOffset
|
|-
| NameOffset
|
|-
| name
| Internal mapping name for this sequence (e.g. "BGM_MISS"). This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

===MULTI_BGM===
Found in ''SoundTable/BGM/libraries/MULTI_BGM.json'' 
Defines settings about Multi BGM such as its name. Multi BGM combines Stream (STM) and sequential Music (BGM). Which Music is set for each Multi BGM is defined in [[MultiBgmInfo]].

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 112
|-
| unk2
| ? always 120
|-
| unk3
| ? always 0
|-
| unk4
| ? always -1
|-
| unk5
| ? always 0
|-
| type
| ? always 96
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this entry (e.g. "MBGM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

==STREAM==
Found in ''SoundTable/STREAM/0.json''
Defines the streamed ast audio files including its internal STM name as well as its filepath.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
| ? always 80
|-
| streamType
| Stream Type 14: Standard Stream (2 Channels) 238: Multi Stream (4 Channels)
|-
| streamPath
| Filepath of the AST file to use (e.g. "/AudioRes/Stream/smg2_ev_starchance_strm.ast")
|-
| type
| ? always 112
|-
| mOffset
|
|-
| NameOffset
| ? always 0
|-
| name
| Internal mapping name for this song (e.g. "STM_STAR_CHANCE") This name can then be used in musiclists like [[ScenarioBgmInfo]].
|}

==SE==
===AW===
Each aw. file is converted by the tool into a folder that has the ID of the aw file in its name, and besides the sound files converted in wav format, contains the following settings for each sound:
*'''manifest.json''' Contains the ID and name of the aw file
*'''wavetable.json''' Contains settings for each sound of the aw. file

====wavetable====
Each entry starts with the name of the Wav file (e.g. "31") followed by its settings:
{| class="wikitable"
|-
! Name
! Description
|-
| format
| ? always 0
|-
| key
|
|-
| sampleRate
| The sample rate at which the sound should be played. (e.g. "22050.0") 
|-
| sampleCount
| Length of the sound in samples
|-
| loop
| Whether it should be looped or not '''true:''' loop '''false:''' do not loop
|-
| loop_start
| Loop Start position in samples.
|-
| loop_end
| Loop End position in samples.
|-
| last
|
|-
| penult
|
|}

===Libraries===
In ''SoundTable\SE\libraries\'' there are several libraries which contain settings for sounds with their internal assigned names.

{| class="wikitable"
|-
! Name
! Description
|-
| unk1
| ? always 128
|-
| unk2
|
|-
| unk3
|
|-
| unk4
|
|-
| unk5
|
|-
| unk6
|
|-
| type
| Always 80
|-
| mOffset
|
|-
| NameOffset
| ? Always 0
|-
| name
| Internal Name of the soundeffect (e.g. "SE_SV_LV_YOSHI_FLUTTER")
|}

List of Music

2024-04-27T19:19:08Z

Louis Miles:

[[Category:Lists]]
{{WIP}}

This page lists all music that can be found in both ''Galaxy'' games along with their respective BGM, STM, MBGM and stream file names:
* '''BGM Name''': The name of the sequenced track.
* '''Stream Name''': The name of the streamed track.
* '''Combined Name''': The Multi BGM name that combines the sequenced and streamed tracks.
* '''Stream File''': The stream's file name in ''AudioRes/Streams''.

These entries can be found and edited in [[SMR.szs]] as well as in [[File_system#Audio_&_Video|various lists]] that vary per game.

==Super Mario Galaxy==
{| class="wikitable"
! Description !! BGM Name !! Stream Name !! Combined Name !! Stream File
|-
| No music || BGM_CLEAR || || ||
|-
! colspan="5" | General Galaxy Music
|-
| Gateway Galaxy || BGM_GALAXY_24 || STM_GALAXY_24 || MBGM_GALAXY_24 || SMG_galaxy24_multi
|-
| Gateway Galaxy 2 || BGM_GALAXY_25 || STM_GALAXY_25 || MBGM_GALAXY_25 || SMG_galaxy25_strm
|-
| Gateway Galaxy 3 || BGM_GALAXY_26 || STM_GALAXY_26 || MBGM_GALAXY_26 || SMG_galaxy26_strm
|-
| Good Egg Galaxy || BGM_GALAXY_01 || STM_GALAXY_01 || MBGM_GALAXY_01 || SMG_galaxy01_strm
|-
| Honeyhive Galaxy || BGM_GALAXY_10 || STM_GALAXY_10 || MBGM_GALAXY_10 || SMG_galaxy10_strm
|-
| Big Bad Bugaboom || BGM_GALAXY_10_HURRY || STM_GALAXY_10_HURRY || MBGM_GALAXY_10_HURRY || SMG_galaxy10_hurry_strm
|-
| Space Junk Galaxy || BGM_GALAXY_08 || STM_GALAXY_08 || MBGM_GALAXY_08 || SMG_galaxy08_strm
|-
| Battlerock Galaxy || BGM_GALAXY_11 || STM_GALAXY_11 || MBGM_GALAXY_11 || SMG_galaxy11_multi
|-
| Bowser's Star Reactor || BGM_GALAXY_15 || STM_GALAXY_15 || MBGM_GALAXY_15 || SMG_galaxy15_strm
|-
| Bowser's Big Staircase || BGM_GALAXY_15_HURRY || STM_GALAXY_15_HURRY || MBGM_GALAXY_15_HURRY || SMG_galaxy15_hurry_strm
|-
| Beach Bowl Galaxy || BGM_GALAXY_03 || STM_GALAXY_03 || MBGM_GALAXY_03 || SMG_galaxy03_multi
|-
| Ghostly Galaxy || BGM_GALAXY_06 || STM_GALAXY_06 || MBGM_GALAXY_06 || SMG_galaxy06_strm
|-
| Buoy Base Galaxy || BGM_GALAXY_04 || STM_GALAXY_04 || MBGM_GALAXY_04 || SMG_galaxy04_multi
|-
| Bowser Jr.'s Airship Armada || BGM_GALAXY_09 || STM_GALAXY_09 || MBGM_GALAXY_09 || SMG_galaxy09_strm
|-
| Drip Drop Galaxy || BGM_GALAXY_23 || STM_GALAXY_23 || MBGM_GALAXY_23 || SMG_galaxy23_strm
|-
| Gusty Garden Galaxy || BGM_GALAXY_14 || STM_GALAXY_14 || MBGM_GALAXY_14 || SMG_galaxy14_strm
|-
| Freezeflame Galaxy || BGM_GALAXY_16 || STM_GALAXY_16 || MBGM_GALAXY_16 || SMG_galaxy16_multi
|-
| Dusty Dune Galaxy || BGM_GALAXY_19 || STM_GALAXY_19 || MBGM_GALAXY_19 || SMG_galaxy19_strm
|-
| Toy Time Galaxy || BGM_GALAXY_22 || STM_GALAXY_22 || MBGM_GALAXY_22 || SMG_galaxy22_strm
|-
| Deep Dark Galaxy || BGM_GALAXY_05 || STM_GALAXY_05 || MBGM_GALAXY_05 || SMG_galaxy05_strm
|-
| Melty Molten Galaxy || BGM_GALAXY_02 || STM_GALAXY_02 || MBGM_GALAXY_02 || SMG_galaxy02_strm
|-
| Snow Cap Galaxy || BGM_GALAXY_27 || STM_GALAXY_27 || MBGM_GALAXY_27 || SMG_galaxy27_strm
|-
| Bowser's Galaxy Reactor || BGM_GALAXY_28 || STM_GALAXY_28 || MBGM_GALAXY_28 || SMG_galaxy28_strm
|-
! colspan="5" | Miscellaneous Stage Music
|-
| Interlude || BGM_GALAXY_INTER || STM_GALAXY_INTER || MBGM_GALAXY_INTER || SMG_galaxy_inter_strm
|-
| A Tense Moment || BGM_GALAXY_01_TOMB || STM_GALAXY_01_TOMB || MBGM_GALAXY_01_TOMB || SMG_galaxy01_tomb_strm
|-
| Space Fantasy || BGM_GALAXY_12 || STM_GALAXY_12 || MBGM_GALAXY_12 || SMG_galaxy12_strm
|-
| Space Athletic || BGM_GALAXY_13 || STM_GALAXY_13 || MBGM_GALAXY_13 || SMG_galaxy13_strm
|-
| Blue Sky Athletic || BGM_GALAXY_17 || STM_GALAXY_17 || MBGM_GALAXY_17 || SMG_galaxy17_strm
|-
| Speedy Comet || BGM_GALAXY_02_HURRY || STM_GALAXY_02_HURRY || MBGM_GALAXY_02_HURRY || SMG_galaxy02_hurry_strm
|-
| Cosmic Comet || BGM_GALAXY_20 || STM_GALAXY_20 || MBGM_GALAXY_20 || SMG_galaxy20_strm
|-
| Purple Comet || BGM_GALAXY_21 || STM_GALAXY_21 || MBGM_GALAXY_21 || SMG_galaxy21_strm
|-
| Pipe Interior || BGM_GALAXY_18 || STM_GALAXY_18 || MBGM_GALAXY_18 || SMG_galaxy18_strm
|-
| Captain Toad's Theme || BGM_KINOPIO_TANKEN || STM_KINOPIO_TANKEN || MBGM_KINOPIO_TANKEN || SMG_ev_kinotan_strm
|-
| Captain Toad's Theme (Duplicate) || BGM_KINOPIO_TANKEN_B || STM_KINOPIO_TANKEN_B || MBGM_KINOPIO_TANKEN_B || SMG_ev_kinotan_strm
|-
| Surfing Race || BGM_RACE_01 || STM_RACE_01 || MBGM_RACE_01 || SMG_ev_race_strm
|-
| Spooky Race || BGM_RACE_02 || STM_RACE_02 || MBGM_RACE_02 || SMG_ev_race02_multi
|-
| Star Ball (Rolling Greens) || BGM_TAMAKORO || || ||
|-
| Star Ball (Melty Molten) || BGM_TAMAKORO_2 || || ||
|-
| Star Bunny Theme || BGM_GALAXY_02_CHASE || STM_GALAXY_02_CHASE || MBGM_GALAXY_02_CHASE || SMG_ev_rabbit_strm
|-
| Bowser Appears || || STM_MEET_KOOPA || || SMG_ev_kuppabt01_strm
|-
| A Chance to Grab a Star! 1 || BGM_STAR_EXIST || STM_STAR_EXIST || MBGM_STAR_EXIST || SMG_ev_starchance_strm
|-
| A Chance to Grab a Star! 2 || BGM_STAR_EXIST_2 || STM_STAR_EXIST_2 || MBGM_STAR_EXIST_2 || SMG_ev_starchance02_strm
|-
! colspan="5" | Boss Music
|-
| Dino Piranha || BGM_BOSS_03_A || STM_BOSS_03_A || MBGM_BOSS_03_A || SMG_boss03a_strm
|-
| Dino Piranha (Fast) || BGM_BOSS_03_B || STM_BOSS_03_B || MBGM_BOSS_03_B || SMG_boss03b_strm
|-
| King Kaliente || BGM_BOSS_01_A || STM_BOSS_01_A || MBGM_BOSS_01_A || SMG_boss01a_strm
|-
| King Kaliente (Fast) || BGM_BOSS_01_B || STM_BOSS_01_B || MBGM_BOSS_01_B || SMG_boss01b_strm
|-
| Megaleg || BGM_BOSS_02_A || STM_BOSS_02_A || MBGM_BOSS_02_A || SMG_boss02a_strm
|-
| Megaleg (Fast) || BGM_BOSS_02_B || STM_BOSS_02_B || MBGM_BOSS_02_B || SMG_boss02b_strm
|-
| Kamella || BGM_BOSS_04 || STM_BOSS_04 || MBGM_BOSS_04 || SMG_boss04_strm
|-
| Bowser || BGM_BOSS_KOOPA || STM_BOSS_KOOPA || MBGM_BOSS_KOOPA || SMG_boss07_multi
|-
| Bouldergeist || BGM_BOSS_09_A || STM_BOSS_09_A || MBGM_BOSS_09_A || SMG_boss09a_multi
|-
| Bouldergeist (Fast) || BGM_BOSS_09_B || STM_BOSS_09_B || MBGM_BOSS_09_B || SMG_boss09b_multi
|-
| Bowser Jr. || BGM_BOSS_06_A || STM_BOSS_06_A || MBGM_BOSS_06_A || SMG_boss06a_strm
|-
| Bowser Jr. (Fast) || BGM_BOSS_06_B || STM_BOSS_06_B || MBGM_BOSS_06_B || SMG_boss06b_strm
|-
| Major Burrows Chases Star Bunny || BGM_PINCH_3 || || ||
|-
| Major Burrows || BGM_BOSS_05_A || STM_BOSS_05_A || MBGM_BOSS_05_A || SMG_boss05a_strm
|-
| Major Burrows (Fast) || BGM_BOSS_05_B || STM_BOSS_05_B || MBGM_BOSS_05_B || SMG_boss05b_strm
|-
| Mecha-Bowser || BGM_BOSS_MECHA_KOOPA || STM_BOSS_MECHA_KOOPA || MBGM_BOSS_MECHA_KOOPA || SMG_boss08_strm
|-
| Final Bowser || BGM_BOSS_KOOPA_FINAL || STM_BOSS_KOOPA_FINAL || MBGM_BOSS_KOOPA_FINAL || SMG_boss10_strm
|-
! colspan="5" | Comet Observatory
|-
| Comet Observatory 1 || || STM_ASTRO_OUT || || SMG_astroout01_strm
|-
| Comet Observatory 2 || || STM_ASTRO_OUT_2 || || SMG_astroout02_strm
|-
| Comet Observatory 3 || || STM_ASTRO_OUT_3 || || SMG_astroout03_strm
|-
| Dome || BGM_ASTRO_DOME || STM_ASTRO_DOME || MBGM_ASTRO_DOME || SMG_astrodome_multi
|-
| Dome (Bowser) || BGM_ASTRO_DOME_2 || STM_ASTRO_DOME_2 || MBGM_ASTRO_DOME_2 || SMG_astrodome02_strm
|-
| Dome (Garden) || BGM_ASTRO_DOME_LOFT || STM_ASTRO_DOME_LOFT || MBGM_ASTRO_DOME_LOFT || SMG_astrodome03_strm
|-
| Library || BGM_LIBRARY || STM_LIBRARY || MBGM_LIBRARY || SMG_astrodome04_strm
|-
! colspan="5" | Power-Up Music
|-
| Rainbow Power-Up || BGM_MUTEKI_A || || ||
|-
| Rainbow Power-Up (first time) || BGM_MUTEKI_B || || ||
|-
| Fire Power-Up || BGM_FIRE_A || || ||
|-
| Fire Power-Up (first time) || BGM_FIRE_B || || ||
|-
| Ice Power-Up || BGM_ICE_A || || ||
|-
| Ice Power-Up (first time) || BGM_ICE_B || || ||
|-
| Flying Power-Up || BGM_FLYING_A || || ||
|-
| Flying Power-Up (first time) || BGM_FLYING_B || || ||
|-
| || BGM_FIRST_MORPH_A || || ||
|-
| || BGM_FIRST_MORPH_B || || ||
|-
! colspan="5" | Other Music
|-
| Title Music || || STM_TITLE || || SMG_title_strm
|-
| File Select || BGM_FILE_SELECT || STM_FILE_SELECT || MBGM_FILE_SELECT || SMG_fileselect_strm
|-
| Credits || || STM_STAFF_ROLL || || SMG_staffroll_strm
|-
| Picture Book || || STM_PROLOGUE_01 || || SMG_ev_prolo01_strm
|-
| Picture Book (Sad) || || STM_PROLOGUE_01_B || || SMG_ev_prolo01_b_strm
|-
| Mushroom Kingdom || BGM_PROLOGUE_02 || STM_PROLOGUE_02 || MBGM_PROLOGUE_02 || SMG_ev_prolo02_strm
|-
| Attack of the Airships (unused) || BGM_PROLOGUE_03 || STM_PROLOGUE_03 || MBGM_PROLOGUE_03 || SMG_ev_prolo03_strm
|-
| Catastrophe (unused) || || STM_PROLOGUE_04 || || SMG_ev_prolo04_strm
|-
| Mushroom Kingdom (After Attack) || || STM_PROLOGUE_05 || || SMG_ev_prolo05_strm
|-
| Star Child || || STM_EPILOGUE_B || || SMG_ev_epilogue_b_strm
|-
| Star Select Screen (When entering from a Dome) || BGM_SENARIO_SEL || || ||
|-
| Star Select Screen (When not entering from a Dome) || BGM_SENARIO_SEL_2 || || ||
|-
| Preparing to go to the Center of the Universe || BGM_SENARIO_SEL_3 || || ||
|-
| Galaxy Intro || BGM_START_DEMO || || ||
|-
| Gateway Intro || BGM_MEET_TICO_ZOOM_OUT || || ||
|-
| Bowser Jr. Intro || BGM_KOOPA_JR_APPEAR || || ||
|-
| Final Bowser Intro || BGM_KOOPA_VS3_SUN || || ||
|-
| First Grand Star Collected || || STM_FIRST_ASTRO || || SMG_first_astro_strm
|-
| Another Grand Star Collected || || STM_SECOND_ASTRO || || SMG_second_astro_strm
|-
| E3 2006 Bubble || BGM_IN_BUBBLE || || ||
|-
! colspan="5" | Jingles
|-
| Death || BGM_MISS || || ||
|-
| Game Over || BGM_GAMEOVER || || ||
|-
| Got Power Star || BGM_STAR_POW_GET || || ||
|-
| Got Grand Star || BGM_GRAND_STAR_GET || || ||
|-
| Got Final Grand Star || BGM_GRAND_STAR_GET_2 || || ||
|-
| Countdown || BGM_MINIGAME_START || || ||
|-
| Won Race || BGM_RACE_WIN || || ||
|-
| Lost Race || BGM_RACE_LOSE || || ||
|-
| New Galaxy || BGM_NEW_GALAXY || || ||
|-
| Planet Appeared || BGM_APPEAR_PLANET || || ||
|-
| Pedestal Appeared in Gateway || BGM_APPEAR_HD_TOWER || || ||
|-
| New High Score || BGM_HIGH_SCORE || || ||
|-
| Galaxy Completed || BGM_GALAXY_COMPLETE || || ||
|-
! colspan="5" | Uncategorized
|-
| || BGM_ASTRO_RETURN || || ||
|-
| || BGM_JINGLE_LIGHT_1 || || ||
|-
| || BGM_KOOPA_APPEAR || || ||
|-
| || BGM_KOOPA_GRAND_STAR_1 || || ||
|-
| || BGM_KOOPA_GRAND_STAR_3 || || ||
|-
| || BGM_PINCH_1 || || ||
|-
| || BGM_PINCH_2 || || ||
|-
| || BGM_RED_COMET_APPEAR || || ||
|}

==Super Mario Galaxy 2==
{| class="wikitable"
! Description !! BGM Name !! Stream Name !! Combined Name !! Stream File
|-
| No music || BGM_CLEAR || || ||
|-
! colspan="5" | General Galaxy Music
|-
| Sky Station Galaxy || BGM_SMG2_GALAXY_06 || STM_SMG2_GALAXY_06 || MBGM_SMG2_GALAXY_06 || SMG2_galaxy06_strm
|-
| Sky Station Galaxy 2 || BGM_SMG2_GALAXY_05 || STM_SMG2_GALAXY_05 || MBGM_SMG2_GALAXY_05 || SMG2_galaxy05_strm
|-
| Yoshi Star Galaxy || BGM_SMG2_GALAXY_32 || STM_SMG2_GALAXY_32 || MBGM_SMG2_GALAXY_32 || SMG2_galaxy32_strm
|-
| Spin-Dig Galaxy || BGM_SMG2_GALAXY_09 || STM_SMG2_GALAXY_09 || MBGM_SMG2_GALAXY_09 || SMG2_galaxy09_strm
|-
| Fluffy Bluff Galaxy || BGM_SMG2_GALAXY_07 || STM_SMG2_GALAXY_07 || MBGM_SMG2_GALAXY_07 || SMG2_galaxy07_strm
|-
| Rightside Down Galaxy || BGM_SMG2_GALAXY_03 || STM_SMG2_GALAXY_03 || MBGM_SMG2_GALAXY_03 || SMG2_galaxy03_multi
|-
| Flip-Swap Galaxy || BGM_SMG2_GALAXY_04 || STM_SMG2_GALAXY_04 || MBGM_SMG2_GALAXY_04 || SMG2_galaxy04_strm
|-
| Bowser Jr.'s Fiery Flotilla || BGM_SMG2_GALAXY31 || STM_SMG2_GALAXY31 || MBGM_SMG2_GALAXY31 || SMG2_galaxy31_strm
|-
| Puzzle Plank Galaxy || BGM_SMG2_GALAXY_29 || STM_SMG2_GALAXY_29 || MBGM_SMG2_GALAXY_29 || SMG2_galaxy29_strm
|-
| Hightail Falls Galaxy || BGM_DASH_YOSHI || || ||
|-
| Cosmic Cove Galaxy || BGM_SMG2_GALAXY_02 || STM_SMG2_GALAXY_02 || MBGM_SMG2_GALAXY_02 || SMG2_galaxy02_strm
|-
| Wild Glide Galaxy || BGM_GLIDER || STM_GLIDER || MBGM_GLIDER || SMG2_ev_glider_strm
|-
| Honeybloom Galaxy || BGM_SMG2_GALAXY_13 || STM_SMG2_GALAXY_13 || MBGM_SMG2_GALAXY_13 || SMG2_galaxy13_strm
|-
| Bowser's Lava Lair || BGM_SMG2_GALAXY_15 || STM_SMG2_GALAXY_15 || MBGM_SMG2_GALAXY_15 || SMG2_galaxy15_strm
|-
| Tall Trunk Galaxy Slide || BGM_SLIDER || || ||
|-
| Haunty Halls Galaxy || BGM_SMG2_GALAXY_11 || STM_SMG2_GALAXY_11 || MBGM_SMG2_GALAXY_11 || SMG2_galaxy11_strm
|-
| Freezy Flake Galaxy || BGM_SMG2_GALAXY_19 || STM_SMG2_GALAXY_19 || MBGM_SMG2_GALAXY_19 || SMG2_galaxy19_strm
|-
| Beat Block Galaxy || BGM_REPEAT_TIMER || || ||
|-
| Supermassive Galaxy || BGM_SMG2_GALAXY_23 || STM_SMG2_GALAXY_23 || MBGM_SMG2_GALAXY_23 || SMG2_galaxy23_strm
|-
| Flipsville Galaxy || BGM_SMG2_GALAXY_14 || STM_SMG2_GALAXY_14 || MBGM_SMG2_GALAXY_14 || SMG2_galaxy14_strm
|-
| Starshine Beach Galaxy || BGM_SMG2_GALAXY_27 || STM_SMG2_GALAXY_27 || MBGM_SMG2_GALAXY_27 || SMG2_galaxy27_multi
|-
| Sweet Mystery Galaxy || BGM_SMG2_GALAXY_10 || STM_SMG2_GALAXY_10 || MBGM_SMG2_GALAXY_10 || SMG2_galaxy10_strm
|-
| Space Storm Galaxy || BGM_SMG2_GALAXY_12 || STM_SMG2_GALAXY_12 || MBGM_SMG2_GALAXY_12 || SMG2_galaxy12_strm
|-
| Space Storm Galaxy 2 || BGM_SMG2_GALAXY_17 || STM_SMG2_GALAXY_17 || MBGM_SMG2_GALAXY_17 || SMG_galaxy17_multi
|-
| Slipsand Galaxy || BGM_SMG2_GALAXY_01 || STM_SMG2_GALAXY_01 || MBGM_SMG2_GALAXY_01 || SMG2_galaxy01_multi
|-
| Shiverburn Galaxy || BGM_SMG2_GALAXY_16 || STM_SMG2_GALAXY_16 || MBGM_SMG2_GALAXY_16 || SMG2_galaxy16_multi
|-
| Fleet Glide Galaxy || BGM_SMG2_GALAXY_28 || STM_SMG2_GALAXY_28 || MBGM_SMG2_GALAXY_28 || SMG2_galaxy28_strm
|-
| Melty Monster Galaxy || BGM_SMG2_GALAXY_30 || STM_SMG2_GALAXY_30 || MBGM_SMG2_GALAXY_30 || SMG2_galaxy30_strm
|-
| Throwback Galaxy || BGM_SMG2_GALAXY_21 || STM_SMG2_GALAXY_21 || MBGM_SMG2_GALAXY_21 || SMG2_galaxy21_strm
|-
| Slimy Spring Galaxy || BGM_SMG2_GALAXY_24 || STM_SMG2_GALAXY_24 || MBGM_SMG2_GALAXY_24 || SMG2_galaxy24_strm
|-
| Slimy Spring Galaxy (Ambience) || BGM_SMG2_GALAXY_24B || STM_SMG2_GALAXY_24B || MBGM_SMG2_GALAXY_24B || SMG2_galaxy24b_strm
|-
| Bowser's Galaxy Generator || BGM_SMG2_GALAXY_20 || STM_SMG2_GALAXY_20 || MBGM_SMG2_GALAXY_20 || SMG2_galaxy20_strm
|-
| Stone Cyclone Galaxy || BGM_SMG2_GALAXY_22 || STM_SMG2_GALAXY_22 || MBGM_SMG2_GALAXY_22 || SMG2_galaxy22_multi
|-
| Boss Blitz Galaxy || BGM_EV_BOSSRUSH || || ||
|-
| Boss Blitz Galaxy (with fade-in) || BGM_EV_BOSSRUSH02 || || ||
|-
| Unused Galaxy Theme || BGM_SMG2_GALAXY_08 || STM_SMG2_GALAXY_08 || MBGM_SMG2_GALAXY_08 || SMG2_galaxy08_strm
|-
| Gateway Galaxy || BGM_SMG2_GALAXY_25 || STM_SMG2_GALAXY_25 || MBGM_SMG2_GALAXY_25 || SMG2_galaxy25_strm
|-
| Good Egg Galaxy || BGM_SMG_GALAXY_01 || STM_SMG_GALAXY_01 || MBGM_SMG_GALAXY_01 || SMG_galaxy01_strm
|-
| Gusty Garden Galaxy || BGM_SMG_GALAXY_14 || STM_SMG_GALAXY_14 || MBGM_SMG_GALAXY_14 || SMG_galaxy14_strm
|-
| Bowser's Galaxy Reactor || BGM_SMG_GALAXY_28 || STM_SMG_GALAXY_28 || MBGM_SMG_GALAXY_28 || SMG_galaxy28_strm
|-
! colspan="5" | Miscellaneous Stage Music
|-
| Unknown Star || BGM_SMG2_GALAXY_INTER || STM_SMG2_GALAXY_INTER || MBGM_SMG2_GALAXY_INTER || SMG2_galaxy_inter_strm
|-
| Speedy Comet || BGM_SMG2_GALAXY_HURRY || STM_SMG2_GALAXY_HURRY || MBGM_SMG2_GALAXY_HURRY || SMG2_galaxy_hurry_strm
|-
| Daredevil Comet || BGM_SMG2_GALAXY_DANGER || STM_SMG2_GALAXY_DANGER || MBGM_SMG2_GALAXY_DANGER || SMG2_galaxy_danger_strm
|-
| Purple Comet || BGM_SMG2_GALAXY_26 || STM_SMG2_GALAXY_26 || MBGM_SMG2_GALAXY_26 || SMG2_galaxy26_strm
|-
| Pipe Interior || BGM_SMG2_GALAXY_18 || STM_SMG2_GALAXY_18 || MBGM_SMG2_GALAXY_18 || SMG2_galaxy18_strm
|-
| Bonus Room || BGM_GAMBLE || || ||
|-
| Teleporter || BGM_SMG2_EV_PORTER || || ||
|-
| Minigame || BGM_MINI_GAME || STM_MINI_GAME || MBGM_MINI_GAME || SMG2_ev_minigame_strm
|-
| Star Ball (Rolling Masterpiece) || BGM_TAMAKORO || || ||
|-
| Star Ball (Rolling Coaster) || BGM_TAMAKORO_2 || || ||
|-
| Tip Network || BGM_DREAM01 || || ||
|-
| Captain Toad's Theme || BGM_EV_KINOTAN || STM_EV_KINOTAN || MBGM_EV_KINOTAN || SMG2_ev_kinotan_strm
|-
| Star Bunny Theme || BGM_EV_RABBIT || STM_EV_RABBIT || MBGM_EV_RABBIT || SMG2_ev_rabbit_strm
|-
| Whittle Theme || BGM_SMG2_EV_MOKKU || STM_SMG2_EV_MOKKU || MBGM_SMG2_EV_MOKKU || SMG2_ev_mokku_strm
|-
| Bowser Appears || || STM_SMG2_EV_KUPPABT01 || || SMG2_ev_kuppabt01_strm
|-
| A Chance to Grab a Star! 1 || BGM_STAR_CHANCE || STM_STAR_CHANCE || MBGM_STAR_CHANCE || SMG2_ev_starchance_strm
|-
| A Chance to Grab a Star! 2 || BGM_STAR_CHANCE_2 || STM_STAR_CHANCE_2 || MBGM_STAR_CHANCE_2 || SMG2_ev_starchance02_strm
|-
| A Chance to Grab a Star! 3 || || STM_STAR_CHANCE_3 || || SMG2_ev_starchance03_strm
|-
! colspan="5" | Boss Music
|-
| Peewee Piranha || BGM_SMG2_BOSS_05A || STM_SMG2_BOSS_05A || MBGM_SMG2_BOSS_05A || SMG2_boss05a_strm
|-
| Peewee Piranha (Fast) || || STM_SMG2_BOSS_05B || || SMG2_boss05b_strm
|-
| Giga-Lakitu || BGM_PINCH_01 || || ||
|-
| Digga-Leg || BGM_SMG2_BOSS_08A || STM_SMG2_BOSS_08A || MBGM_SMG2_BOSS_08A || SMG2_boss08a_strm
|-
| Digga-Leg (Fast) || || STM_SMG2_BOSS08B || || SMG2_boss08b_strm
|-
| Gobblegut || BGM_SMG2_BOSS_01A || STM_SMG2_BOSS_01A || MBGM_SMG2_BOSS_01A || SMG2_boss01a_strm
|-
| Gobblegut (Fast) || || STM_SMG2_BOSS_01B || || SMG2_boss01b_strm
|-
| Bowser || BGM_SMG2_BOSS_07 || STM_SMG2_BOSS_07 || MBGM_SMG2_BOSS_07 || SMG2_boss07_multi
|-
| Bowser (Fast) || BGM_SMG2_BOSS_07B || STM_SMG2_BOSS_07B || MBGM_SMG2_BOSS_07B || SMG2_boss07b_multi
|-
| Megahammer || BGM_SMG2_BOSS_03A || STM_SMG2_BOSS_03A || MBGM_SMG2_BOSS_03A || SMG2_boss03a_multi
|-
| Megahammer (Fast) || || STM_SMG2_BOSS_03B || || SMG2_boss03b_strm
|-
| Glamdozer || BGM_SMG2_BOSS_02A || STM_SMG2_BOSS_02A || MBGM_SMG2_BOSS_02A || SMG2_boss02a_strm
|-
| Glamdozer (Fast) || || STM_SMG2_BOSS_02B || || SMG2_boss02b_strm
|-
| Squizzard || BGM_SMG2_BOSS_04A || || ||
|-
| Boomsday Machine || BGM_SMG2_BOSS_06A || STM_SMG2_BOSS_06A || MBGM_SMG2_BOSS_06A || SMG2_boss06a_strm
|-
| Boomsday Machine (Fast) || BGM_SMG2_BOSS_06B || STM_SMG2_BOSS_06B || MBGM_SMG2_BOSS_06B || SMG2_boss06b_strm
|-
| Final Bowser || BGM_SMG2_BOSS_10 || STM_SMG2_BOSS_10 || MBGM_SMG2_BOSS_10 || SMG2_boss10_multi
|-
| Final Bowser (Without Ambience) || || STM_SMG2_BOSS10 || || SMG2_boss10_strm
|-
| Dino Piranha || BGM_SMG_BOSS_03A || STM_SMG_BOSS_03A || MBGM_SMG_BOSS_03A || SMG_boss03a_strm
|-
| Dino Piranha (Fast) || BGM_SMG_BOSS_03B || STM_SMG_BOSS_03B || MBGM_SMG_BOSS_03B || SMG_boss03b_strm
|-
| King Kaliente || BGM_SMG_BOSS_01A || STM_SMG_BOSS_01A || MBGM_SMG_BOSS_01A || SMG_boss01a_strm
|-
| King Kaliente (Fast) || BGM_SMG_BOSS_01B || STM_SMG_BOSS_01B || MBGM_SMG_BOSS_01B || SMG_boss01b_strm
|-
| Major Burrows || BGM_SMG_BOSS_05A || STM_SMG_BOSS_05A || MBGM_SMG_BOSS_05A || SMG_boss05a_strm
|-
| Major Burrows (Fast) || BGM_SMG_BOSS_05B || STM_SMG_BOSS_05B || MBGM_SMG_BOSS_05B || SMG_boss05b_strm
|-
| Bouldergeist || BGM_SMG_BOSS_09A || STM_SMG_BOSS_09A || MBGM_SMG_BOSS_09A || SMG_boss09a_multi
|-
| Bouldergeist (Fast) || BGM_SMG_BOSS_09B || STM_SMG_BOSS_09B || MBGM_SMG_BOSS_09B || SMG_boss09b_multi
|-
! colspan="5" | HUB & World Map Music
|-
| World 1 & 2 || BGM_SMG2_WORLDMAP_06 || STM_SMG2_WORLDMAP_06 || MBGM_SMG2_WORLDMAP_06 || SMG2_worldmap06_multi
|-
| World 3 || BGM_SMG2_WORLDMAP_00 || STM_SMG2_WORLDMAP_00 || MBGM_SMG2_WORLDMAP_00 || SMG2_worldmap00_multi
|-
| World 4 || BGM_SMG2_WORLDMAP_04 || STM_SMG2_WORLDMAP_04 || MBGM_SMG2_WORLDMAP_04 || SMG2_worldmap04_multi
|-
| World 5 || BGM_SMG2_WORLDMAP_08 || STM_SMG2_WORLDMAP_08 || MBGM_SMG2_WORLDMAP_08 || SMG2_worldmap08_multi
|-
| World 6 || BGM_SMG2_WORLDMAP_07 || STM_SMG2_WORLDMAP_07 || MBGM_SMG2_WORLDMAP_07 || SMG2_worldmap07_multi
|-
| World S || BGM_SMG2_WORLDMAP_03 || STM_SMG2_WORLDMAP_03 || MBGM_SMG2_WORLDMAP_03 || SMG2_worldmap03_multi
|-
| Green Star World || BGM_SMG2_WORLDMAP_05 || STM_SMG2_WORLDMAP_05 || MBGM_SMG2_WORLDMAP_05 || SMG2_worldmap05_multi
|-
| Starship Mario 1 || BGM_SMG2_MARIO_SHIP01 || STM_SMG2_MARIO_SHIP01 || MBGM_SMG2_MARIO_SHIP01 || SMG2_mario_ship01_strm
|-
| Starship Mario 2 || BGM_SMG2_MARIO_SHIP02 || STM_SMG2_MARIO_SHIP02 || MBGM_SMG2_MARIO_SHIP02 || SMG2_mario_ship02_strm
|-
| Starship Mario 3 || BGM_SMG2_MARIO_SHIP03 || STM_SMG2_MARIO_SHIP03 || MBGM_SMG2_MARIO_SHIP03 || SMG2_mario_ship03_strm
|-
| Comet Observatory 2 || || STM_SMG_ASTROOUT02 || || SMG_astroout02_strm
|-
| Comet Observatory 3 || || STM_SMG_ASTROOUT03 || || SMG_astroout03_strm
|-
! colspan="5" | Power-Up Music
|-
| Rainbow Power-Up || BGM_MUTEKI_A || || ||
|-
| Rainbow Power-Up (first time) || BGM_MUTEKI_B || || ||
|-
| Fire Power-Up || BGM_FIRE_A || || ||
|-
| Fire Power-Up (first time) || BGM_FIRE_B || || ||
|-
| Ice Power-Up || BGM_ICE_A || || ||
|-
| Ice Power-Up (first time) || BGM_ICE_B || || ||
|-
| Flying Power-Up || BGM_FLYING_A || || ||
|-
| Flying Power-Up (first time) || BGM_FLYING_B || || ||
|-
| || BGM_FIRST_MORPH_A || || ||
|-
| || BGM_FIRST_MORPH_B || || ||
|-
! colspan="5" | Other Music
|-
| Title Music (Duplicate) || BGM_TITLE || STM_TITLE || MBGM_TITLE || SMG2_title_strm
|-
| Credits || BGM_SMG2_STAFFROLL || STM_SMG2_STAFFROLL || MBGM_SMG2_STAFFROLL || SMG2_staffroll_strm
|-
| Mushroom Kingdom || || STM_SMG2_EV_PROLOGUE_02 || || SMG2_ev_prolo02_strm
|-
| Master Luma's Theme || BGM_SMG2_EV_PROLO_03 || || ||
|-
| Bowser Attacks || || STM_SMG2_EV_PROLOGUE_05 || || SMG2_ev_prolo05_strm
|-
| First Grand Star Collected || || STM_SMG2_FIRST_ASTRO || || SMG2_first_astro_strm
|-
| Entering World 1 || || STM_SMG2_FIRST_ASTRO2 || || SMG2_first_astro2_strm
|-
| Another Grand Star Collected || || STM_SMG2_SECOND_ASTRO || || SMG2_second_astro_strm
|-
| First Star Select || BGM_SMG2_EV_DEPART01 || || ||
|-
| Star Select || BGM_SMG2_COURSESELECT02 || || ||
|-
| The Luma and the Hat || || STM_SMG2_EV_ENDING01 || || SMG2_ev_ending01_strm
|-
| Precious One || || STM_SMG2_EV_EPILOGUE_01 || || SMG2_ev_epilogue01_strm
|-
| E3 2006 Bubble || BGM_IN_BUBBLE || || ||
|-
| || BGM_KOOPA_JR_APPEAR || || ||
|-
| || BGM_PINCH_02 || || ||
|-
! colspan="5" | Jingles
|-
| Death || BGM_MISS || || ||
|-
| Game Over || BGM_GAMEOVER || || ||
|-
| Countdown || BGM_MINIGAME_START || || ||
|-
| Won Race || BGM_RACE_WIN || || ||
|-
| Lost Race || BGM_RACE_LOSE || || ||
|-
| New Galaxy || BGM_JG_NEW_GALAXY || || ||
|-
| Planet Appeared || BGM_JG_APPEAR_PLANET || || ||
|-
| Got Grand Star || BGM_JG_GRAND_STAR_GET || || ||
|-
| New High Score || BGM_JG_HIGH_SCORE || || ||
|-
| Galaxy Completed || BGM_JG_GALAXY_COMPLETE || || ||
|-
| || BGM_JG_RETURN_HOME || || ||
|-
| || BGM_JG_START_CAMERA_DEMO || || ||
|-
| || || STM_SMG2_JG_COMETSE || || SMG2_jg_cometse_strm
|-
| || BGM_SMG2_JG_COMET || || ||
|-
| || BGM_SMG2_JG_DECIDE || || ||
|-
| || BGM_SMG2_JG_GREENSTAR1 || || ||
|-
| || BGM_SMG2_JG_GSTAR1 || || ||
|-
| || BGM_SMG2_JG_GSTAR2 || || ||
|-
| || BGM_SMG2_JG_M_PLANET01 || || ||
|-
| || BGM_SMG2_JG_MEETCHIKO || || ||
|-
| || BGM_SMG2_JG_MEETYOSHI || || ||
|-
| || BGM_SMG2_JG_PAMATA || || ||
|-
| || BGM_SMG2_JG_TIME || || ||
|}

Cutscenes

2024-04-27T12:21:23Z

Louis Miles:

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object (defined in [[ObjNameTable]])
|-
| CastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".

===== SMG1 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Apppear || Makes the object Appear.
|-
| 1 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 2 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 3 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || On SW_A || The SW_A of this object will be activated.
|-
| 5 || On SW_B || The SW_B of this object will be activated.
|-
| 6 || Show Model || The model of the object will be unhidden.
|-
| 7 || Hide Model || The model of the object will be hidden.
|-
| 8 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 9 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Duplicate of 9 || Duplicate of 9.
|-
| 11 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|}
===== SMG2 =====
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from MarioAnim.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focussed at.
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (with ".canm" extension) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
|
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Music|Name of the music]] to play.
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
| [[List_of_Sounds_(SMG2)|Name of the soundeffect]] to play.
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
| Duration in frames for fading out the music. -1 = No fade-out
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].