Luma's Workshop - User contributions [en]

BMS (File Format)

2026-07-06T00:33:21Z

RavuAlHemio: /* Data */ parseNoteOn: Midi Gate voices are those where the bottom 3 bits are 0

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (bottom three bits of Voice are all 0). If the bottom three bits of Voice are 0, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| JASSeqParser::parseRegCommand
| ''possibly unused in SMG'' {OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]} Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups. Taking the lowest 3 bits of OpCode and adding 1 defines how many parameters TargetOpCode has (90 = 1 parameter, 91 = 2 parameters, ..., 97 = 8 parameters, 98 = 1 parameter, 99 = 2 parameters, ..., 9F = 8 parameters). For each parameter, if the corresponding bit in RegBits (MSB first) is set, the parameter type is changed to a register read. (For example, if RegBits = 160 = 0b10100000, the first and the third parameter are changed to register reads.) Finally, TargetOpCode is performed with TargetParams. TargetOpCode must be at least A0.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]} Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are: - 0: do nothing - 1: Read(Register) + Value - 2: Read(Register) - Value - 3: Read(Register) - Value, but store result into register 3 instead of Register - 4: Read(Register) × Value, but store result into register 33 instead of Register - 5: Read(Register) AND Value (bitwise) - 6: Read(Register) OR Value (bitwise) - 7: Read(Register) XOR Value (bitwise) - 8: a random number 0 &leq; n < Value - 9: Read(Register) SHL Value (bitshift left) - 10: Read(Register) SHR Value (bitshift right)
|
|
|-
| DA
| JASSeqParser::cmdReg
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]} Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T21:24:37Z

RavuAlHemio: /* Data */ parseRegCommand: RegBits is encoded MSB first

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| JASSeqParser::parseRegCommand
| ''possibly unused in SMG'' {OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]} Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups. Taking the lowest 3 bits of OpCode and adding 1 defines how many parameters TargetOpCode has (90 = 1 parameter, 91 = 2 parameters, ..., 97 = 8 parameters, 98 = 1 parameter, 99 = 2 parameters, ..., 9F = 8 parameters). For each parameter, if the corresponding bit in RegBits (MSB first) is set, the parameter type is changed to a register read. (For example, if RegBits = 160 = 0b10100000, the first and the third parameter are changed to register reads.) Finally, TargetOpCode is performed with TargetParams. TargetOpCode must be at least A0.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]} Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are: - 0: do nothing - 1: Read(Register) + Value - 2: Read(Register) - Value - 3: Read(Register) - Value, but store result into register 3 instead of Register - 4: Read(Register) × Value, but store result into register 33 instead of Register - 5: Read(Register) AND Value (bitwise) - 6: Read(Register) OR Value (bitwise) - 7: Read(Register) XOR Value (bitwise) - 8: a random number 0 &leq; n < Value - 9: Read(Register) SHL Value (bitshift left) - 10: Read(Register) SHR Value (bitshift right)
|
|
|-
| DA
| JASSeqParser::cmdReg
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]} Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T21:20:38Z

RavuAlHemio: /* Data */ parseRegCommand: only bottom 3 bits from OpCode are relevant

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| JASSeqParser::parseRegCommand
| ''possibly unused in SMG'' {OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]} Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups. Taking the lowest 3 bits of OpCode and adding 1 defines how many parameters TargetOpCode has (90 = 1 parameter, 91 = 2 parameters, ..., 97 = 8 parameters, 98 = 1 parameter, 99 = 2 parameters, ..., 9F = 8 parameters). For each parameter, if the corresponding bit in RegBits is set, the parameter type is changed to a register read. (For example, if RegBits = 5 = 0b00000101, the first and the third parameter are changed to register reads.) Finally, TargetOpCode is performed with TargetParams. TargetOpCode must be at least A0.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]} Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are: - 0: do nothing - 1: Read(Register) + Value - 2: Read(Register) - Value - 3: Read(Register) - Value, but store result into register 3 instead of Register - 4: Read(Register) × Value, but store result into register 33 instead of Register - 5: Read(Register) AND Value (bitwise) - 6: Read(Register) OR Value (bitwise) - 7: Read(Register) XOR Value (bitwise) - 8: a random number 0 &leq; n < Value - 9: Read(Register) SHL Value (bitshift left) - 10: Read(Register) SHR Value (bitshift right)
|
|
|-
| DA
| JASSeqParser::cmdReg
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]} Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T14:52:43Z

RavuAlHemio:

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| JASSeqParser::parseRegCommand
| ''possibly unused in SMG'' {OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]} Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups. OpCode selects how many parameters TargetOpCode has (90 = 1 parameter, 91 = 2 parameters, ..., 9F = 16 parameters). For each parameter, if the corresponding bit in RegBits is set, the parameter type is changed to a register read. (For example, if RegBits = 5 = 0b00000101, the first and the third parameter are changed to register reads.) Finally, TargetOpCode is performed with TargetParams. TargetOpCode must be at least A0.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]} Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are: - 0: do nothing - 1: Read(Register) + Value - 2: Read(Register) - Value - 3: Read(Register) - Value, but store result into register 3 instead of Register - 4: Read(Register) × Value, but store result into register 33 instead of Register - 5: Read(Register) AND Value (bitwise) - 6: Read(Register) OR Value (bitwise) - 7: Read(Register) XOR Value (bitwise) - 8: a random number 0 &leq; n < Value - 9: Read(Register) SHL Value (bitshift left) - 10: Read(Register) SHR Value (bitshift right)
|
|
|-
| DA
| JASSeqParser::cmdReg
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]} Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T14:45:39Z

RavuAlHemio: document parseRegCommand

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| JASSeqParser::parseRegCommand
| ''possibly unused in SMG'' {OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]} Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups. OpCode selects how many parameters TargetOpCode has (90 = 1 parameter, 91 = 2 parameters, ..., 9F = 16 parameters). For each parameter, if the corresponding bit in RegBits is set, the parameter type is changed to a register read. (For example, if RegBits = 5 = 0b00000101, the first and the third parameter are changed to register reads.) Finally, TargetOpCode is performed with TargetParams.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]} Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are: - 0: do nothing - 1: Read(Register) + Value - 2: Read(Register) - Value - 3: Read(Register) - Value, but store result into register 3 instead of Register - 4: Read(Register) × Value, but store result into register 33 instead of Register - 5: Read(Register) AND Value (bitwise) - 6: Read(Register) OR Value (bitwise) - 7: Read(Register) XOR Value (bitwise) - 8: a random number 0 &leq; n < Value - 9: Read(Register) SHL Value (bitshift left) - 10: Read(Register) SHR Value (bitshift right)
|
|
|-
| DA
| JASSeqParser::cmdReg
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]} Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T09:26:23Z

RavuAlHemio: document cmdReg

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]} Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are: - 0: do nothing - 1: Read(Register) + Value - 2: Read(Register) - Value - 3: Read(Register) - Value, but store result into register 3 instead of Register - 4: Read(Register) × Value, but store result into register 33 instead of Register - 5: Read(Register) AND Value (bitwise) - 6: Read(Register) OR Value (bitwise) - 7: Read(Register) XOR Value (bitwise) - 8: a random number 0 &leq; n < Value - 9: Read(Register) SHL Value (bitshift left) - 10: Read(Register) SHR Value (bitshift right)
|
|
|-
| DA
| JASSeqParser::cmdReg
| ''possibly unused in SMG'' {OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]} Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T09:13:30Z

RavuAlHemio: /* Data */ clarify Port range in cmdParentWritePort

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T09:12:43Z

RavuAlHemio: document cmd(Parent|Child)(Read|Write)Port

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the parent track's Port.
|
|
|-
| D5
| JASSeqParser::cmdChildWritePort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from this track's Register (0-32) and writes it to the child track's port given by ChildAndPort. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| D6
| JASSeqParser::cmdParentReadPort
| ''possibly unused in SMG'' {OpCode[1]} {Port[1]} {Register[1]} Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
|
|-
| D7
| JASSeqParser::cmdChildReadPort
| ''possibly unused in SMG'' {OpCode[1]} {ChildAndPort[1]} {Register[1]} Reads the value from the child track's port given by ChildAndPort and writes it to this track's Register. The top 4 bits of ChildAndPort (0-15) represent the number of the child track, the bottom 4 bits (0-15) the port.
|
|
|-
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T08:45:21Z

RavuAlHemio: document IIR and FIR commands

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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
| ''possibly unused in SMG'' {OpCode[1]} {Cutoff[1]} Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table. Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
|
|
|-
| EC
| JASSeqParser::cmdIIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]} Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
|
|
|-
| ED
| JASSeqParser::cmdFIRSet
| ''possibly unused in SMG'' {OpCode[1]} {Pointer[3]} Reads a FIR parameter table (8 two-byte signed integer values = 16 bytes) at the given Pointer and sets the track's FIR filter parameters to these values.
|
|
|-
| 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)

BMS (File Format)

2026-07-05T08:23:27Z

RavuAlHemio: /* Data */ parseNoteOn: describe additional Midi Gate value

[[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]} {Wait[n]} 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. Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7). If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect that the Wait value is present. The Wait value is one or more bytes with range 0x00 through 0xFF; each time the byte is 0x80 or greater (i.e. bit 7 = 1), another following byte will be taken into account. If the Wait value is 0x00, the game waits until the note has finished; otherwise, it waits the number of ticks specified in the Wait value.
| 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)

SMR.szs

2026-07-03T10:11:42Z

RavuAlHemio: /* BSC offset table */ link to page on BMS data format

[[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
| Bitfield (0x4)
| Allows for asynchronous AW file pre-loading upon game boot. 0xFFFFFFFF makes all AW files of the WSYS get loaded.
|-
| 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)
| JaiChord file check. 0x0000 if no, 0x0001 if yes.
| 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 (File Format)|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")
|}

WSYS

2026-07-03T10:05:53Z

RavuAlHemio: document WBCT as link between WSYS and SCNE

'''WSYS''' Wave System

Internally, Wave System.

This section contains all of the information required for decoding the [[AW_(File_Format)|AW file]] as well as other information for melodic tuning, root key, and other various parts of JAudio.

WSYS format is consistent between engine versions, however some games do not make use of the waveCount bytes. If the wavecount int32 is missing in anything newer than twilight princess, the WSYS will not function correctly.

__TOC__

<h1>WSYS Structure</h1>

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x57535953 'WSYS' || Magic
|-
| <center>0x04</center> || int32 || size || WSYS Size
|-
| <center>0x08</center> || int32 || wsysID || WSYS ID (This is how insts select the wsys)
|-
| <center>0x0C</center> || int32 || waveCount || WSYS Wave Count
|-
| <center>0x10</center> || int32 || [[WSYS#WINF | WINF Pointer]] || WBINF
|-
| <center>0x14</center> || int32 || [[WSYS#WBCT | WBCT Pointer]] || WBCT
|-
|}
==WINF==
WINF is a pointer container. They point to the [[WSYS#WaveGroup|Wave Groups]].

The ID's for every wave group are controlled by the [[WSYS#SCNE|SCNE]] object. They line up, WaveGroup[1] uses WaveScenes[1]

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x57494E46 'WINF' || Magic
|-
| <center>0x04</center> || int32 || waveGroupCount || Count of wavegroups
|-
| <center>0x08</center> || [[WSYS#WaveGroup|WaveGroup]]*[] (int32) || waveGroupPointers || Pointers to the individual wavegroups.
|-
|}
==WBCT==
WBCT is a container for pointers that point to [[WSYS#SCNE|SCNE]] objects.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x57424354 'WBCT' || Magic
|-
| <center>0x04</center> || int32 || -1 || unknown
|-
| <center>0x08</center> || int32 || sceneCount || Count of scenes
|-
| <center>0x0C</center> || [[WSYS#SCNE|SCNE]]*[] (int32) || scenePointers || Pointers to the individual scenes.
|-
|}

==SCNE==
SCNE is a pointer container as well. They point to the [[WSYS#C-DF|C-DF]] objects.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x53434E45 'SCNE' || Magic
|-
| <center>0x04</center> || int64 || padding || padding
|-
| <center>0x0C</center> || int32 || [[WSYS#C-DF|C-DF]]* || Pointer to C-DF
|-
| <center>0x10</center> || int32 || [[WSYS#C-DF|C-DF]]* || Pointer to C-EX
|-
| <center>0x14</center> || int32 || [[WSYS#C-DF|C-DF]]* || Pointer to C-ST
|-
|}

==Scene Waves==

Note: The other sections C-ST, and C-EX point to to this category as well. They remain empty. Code for parsing them isn't even in the executables.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x432D4446 ('C-DF') || Magic
|-
| <center>0x04</center> || int32 || wavesCount || Wave Count
|-
| <center>0x08</center> || int32 || [[WSYS#WAVEID|WAVEID]]*[] || Pointer array waveID's
|-
|}

==WAVEID==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int16 || waveGroupID || Wave Group ID (Current WSYS)
|-
| <center>0x02</center> || int16 || waveID || The ID assigned from this wave
|-
|}

==WaveGroup==
SCNE is a pointer container as well. They point to the [[WSYS#C-DF|C-DF]] objects.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[0x70] || archiveName || File Path for .AW
|-
| <center>0x70</center> || int32|| wavesCount || Wave Count
|-
| <center>0x74</center> || int32 || [[WSYS#WAVE|WAVE]]*[] || Pointer array of Waves
|-
|}

==WAVE==

Container format for Wave Information. This tells you where the ADPCM / PCM / whatever data starts inside of the .AW file for the current group and for what wave.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || byte || 0x00 || unknown
|-
| <center>0x01</center> || byte || format || WaveFormat
|-
| <center>0x02</center> || byte || baseKey || Base Key
|-
| <center>0x03</center> || byte || 0x00 || unknown
|-
| <center>0x04</center> || float || sampleRate || Sample Rate
|-
| <center>0x08</center> || int32 || awOfsStart || AW Offset Start
|-
| <center>0x0C</center> || int32 || awOfsEnd || AW Length
|-
| <center>0x10</center> || int32(bool) || loop || Loop flags?
|-
| <center>0x14</center> || int32 || loopStartSample || Loop Start Sample
|-
| <center>0x18</center> || int32 || loopEndSample || Loop End Sample
|-
| <center>0x20</center> || int32 || sampleCount || Samples Count
|-
| <center>0x24</center> || short || pLast || ADPCM Loop Last Sample
|-
| <center>0x26</center> || short || pPenult || ADPCM Loop Penult Sample
|-
|}