BMS (File Format) - Revision history

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

2026-07-06T00:33:21Z

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

← Older revision		Revision as of 00:33, 6 July 2026
Line 35:		Line 35:
	\| 00<br />01<br />02<br />...<br />7D<br />7E<br />7F		\| 00<br />01<br />02<br />...<br />7D<br />7E<br />7F
	\| JASSeqParser::parseNoteOn		\| JASSeqParser::parseNoteOn
	\| {OpCode[1]} {Voice[1]} {Velocity[1]} {Wait[n]}<br />OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9.<br />Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note.<br />Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127.<br />Wait: variable length, only present for Midi Gate notes (Voice ~~is not 1 - 7~~).<br/><br/>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.		\| {OpCode[1]} {Voice[1]} {Velocity[1]} {Wait[n]}<br />OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9.<br />Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note.<br />Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127.<br />Wait: variable length, only present for Midi Gate notes (bottom three bits of Voice are all 0).<br/><br/>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<br /><br />64: Key E4<br />02: Voice 2<br />68: Velocity 104		\| 64 02 68<br /><br />64: Key E4<br />02: Voice 2<br />68: Velocity 104
	\| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).		\| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).

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

2026-07-05T21:24:37Z

Data: parseRegCommand: RegBits is encoded MSB first

← Older revision		Revision as of 21:24, 5 July 2026
Line 59:		Line 59:
	\| 90<br />...<br />9F		\| 90<br />...<br />9F
	\| JASSeqParser::parseRegCommand		\| JASSeqParser::parseRegCommand
	\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.<br/>TargetOpCode must be at least A0.		\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.<br/>TargetOpCode must be at least A0.
	\|		\|
	\|		\|

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

2026-07-05T21:20:38Z

Data: parseRegCommand: only bottom 3 bits from OpCode are relevant

← Older revision		Revision as of 21:20, 5 July 2026
Line 59:		Line 59:
	\| 90<br />...<br />9F		\| 90<br />...<br />9F
	\| JASSeqParser::parseRegCommand		\| JASSeqParser::parseRegCommand
	\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.<br/>TargetOpCode must be at least A0.		\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.<br/>TargetOpCode must be at least A0.
	\|		\|
	\|		\|

RavuAlHemio at 14:52, 5 July 2026

2026-07-05T14:52:43Z

← Older revision		Revision as of 14:52, 5 July 2026
Line 59:		Line 59:
	\| 90<br />...<br />9F		\| 90<br />...<br />9F
	\| JASSeqParser::parseRegCommand		\| JASSeqParser::parseRegCommand
	\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.		\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.<br/>TargetOpCode must be at least A0.
	\|		\|
	\|		\|

RavuAlHemio: document parseRegCommand

2026-07-05T14:45:39Z

document parseRegCommand

← Older revision		Revision as of 14:45, 5 July 2026
Line 58:		Line 58:
	\|-		\|-
	\| 90<br />...<br />9F		\| 90<br />...<br />9F
	\| ~~Unknown~~		\| JASSeqParser::parseRegCommand
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegBits[1]} {TargetOpCode[1]} {TargetParams[n]}<br/>Triggers TargetOpCode while replacing some of its fixed parameters with register value lookups.<br/>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.
	\|		\|
	\|		\|

RavuAlHemio: document cmdReg

2026-07-05T09:26:23Z

document cmdReg

← Older revision		Revision as of 09:26, 5 July 2026
Line 430:		Line 430:
	\| D9		\| D9
	\| JASSeqParser::cmdReg		\| JASSeqParser::cmdReg
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegOp[1]} {Register[1]} {Value[2]}<br/>Reads a value from Register (0-32), performs RegOp with Value on it, then stores the result into Register. Values for RegOp are:<br/>- 0: do nothing<br/>- 1: Read(Register) + Value<br/>- 2: Read(Register) - Value<br/>- 3: Read(Register) - Value, but store result into register 3 instead of Register<br/>- 4: Read(Register) × Value, but store result into register 33 instead of Register<br/>- 5: Read(Register) AND Value (bitwise)<br/>- 6: Read(Register) OR Value (bitwise)<br/>- 7: Read(Register) XOR Value (bitwise)<br/>- 8: a random number 0 &leq; n < Value<br/>- 9: Read(Register) SHL Value (bitshift left)<br/>- 10: Read(Register) SHR Value (bitshift right)
	\|		\|
	\|		\|
Line 436:		Line 436:
	\| DA		\| DA
	\| JASSeqParser::cmdReg		\| JASSeqParser::cmdReg
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {RegOp[1]} {Register[1]} {OtherRegister[1]}<br/>Performs the same operation as D9, except the value to the operation is not specified directly, but read from OtherRegister (0-32).
	\|		\|
	\|		\|

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

2026-07-05T09:13:30Z

Data: clarify Port range in cmdParentWritePort

← Older revision		Revision as of 09:13, 5 July 2026
Line 401:		Line 401:
	\| D4		\| D4
	\| JASSeqParser::cmdParentWritePort		\| JASSeqParser::cmdParentWritePort
	\| ''possibly unused in SMG''<br/>{OpCode[1]} {Port[1]} {Register[1]}<br/>Reads the value from this track's Register (0-32) and writes it to the parent track's Port.		\| ''possibly unused in SMG''<br/>{OpCode[1]} {Port[1]} {Register[1]}<br/>Reads the value from this track's Register (0-32) and writes it to the parent track's Port (0-15).
	\|		\|
	\|		\|

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

2026-07-05T09:12:43Z

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

← Older revision		Revision as of 09:12, 5 July 2026
Line 401:		Line 401:
	\| D4		\| D4
	\| JASSeqParser::cmdParentWritePort		\| JASSeqParser::cmdParentWritePort
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {Port[1]} {Register[1]}<br/>Reads the value from this track's Register (0-32) and writes it to the parent track's Port.
	\|		\|
	\|		\|
Line 407:		Line 407:
	\| D5		\| D5
	\| JASSeqParser::cmdChildWritePort		\| JASSeqParser::cmdChildWritePort
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {ChildAndPort[1]} {Register[1]}<br/>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.
	\|		\|
	\|		\|
Line 413:		Line 413:
	\| D6		\| D6
	\| JASSeqParser::cmdParentReadPort		\| JASSeqParser::cmdParentReadPort
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {Port[1]} {Register[1]}<br/>Reads the value from the parent track's Port (0-15) and writes it to this track's Register (0-32).
	\|
	\|		\|
	\|-		\|-
	\| D7		\| D7
	\| JASSeqParser::cmdChildReadPort		\| JASSeqParser::cmdChildReadPort
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {ChildAndPort[1]} {Register[1]}<br/>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.
	\|		\|
	\|		\|

RavuAlHemio: document IIR and FIR commands

2026-07-05T08:45:21Z

document IIR and FIR commands

← Older revision		Revision as of 08:45, 5 July 2026
Line 545:		Line 545:
	\| EB		\| EB
	\| JASSeqParser::cmdIIRCutOff		\| JASSeqParser::cmdIIRCutOff
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {Cutoff[1]}<br/>Sets the track's IIR filter parameters to values derived from the Cutoff value via a lookup table.<br/><br/>Cutoff: one byte in the range 0-127. The IIR filter parameters are derived from this value.
	\|		\|
	\|		\|
Line 551:		Line 551:
	\| EC		\| EC
	\| JASSeqParser::cmdIIRSet		\| JASSeqParser::cmdIIRSet
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {Param1[2]} {Param2[2]} {Param3[2]} {Param4[2]}<br/>Sets the track's IIR filter parameters to the four parameter values, which are interpreted as signed 16-bit integers.
	\|		\|
	\|		\|
Line 557:		Line 557:
	\| ED		\| ED
	\| JASSeqParser::cmdFIRSet		\| JASSeqParser::cmdFIRSet
	\|		\| ''possibly unused in SMG''<br/>{OpCode[1]} {Pointer[3]}<br/>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.
	\|		\|
	\|		\|

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

2026-07-05T08:23:27Z

Data: parseNoteOn: describe additional Midi Gate value

← Older revision		Revision as of 08:23, 5 July 2026
Line 35:		Line 35:
	\| 00<br />01<br />02<br />...<br />7D<br />7E<br />7F		\| 00<br />01<br />02<br />...<br />7D<br />7E<br />7F
	\| JASSeqParser::parseNoteOn		\| JASSeqParser::parseNoteOn
	\| {OpCode[1]} {Voice[1]} {Velocity[1]}<br />OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9.<br />Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note.<br />Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127.<br/><br/>If the Voice is not 1 - 7, the game will treat this note as a Midi Gate note, and will expect ~~a 4th~~ value ~~that~~ is one or more bytes with range 0x00 through 0xFF~~. If~~ the ~~leading~~ byte is 0x80 (bit 7 = 1) ~~or greater~~, another following byte will be taken into account. It is ~~unknown what effects this~~ has on the ~~output~~.		\| {OpCode[1]} {Voice[1]} {Velocity[1]} {Wait[n]}<br />OpCode: one byte with range 0x00 through 0x7F. 0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9.<br />Voice: one byte with range 0x01 through 0x07 (needs testing/verification). Each Voice can only hold one Note.<br />Velocity: one byte with range 0x00 through 0x7F. 0x00 = 0, 0x7F = 127.<br />Wait: variable length, only present for Midi Gate notes (Voice is not 1 - 7).<br/><br/>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<br /><br />64: Key E4<br />02: Voice 2<br />68: Velocity 104		\| 64 02 68<br /><br />64: Key E4<br />02: Voice 2<br />68: Velocity 104
	\| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).		\| Starts playing a Note with the previously defined Instrument (see E1, E2 and E3).