BRS (File Format) - Revision history

SY24: Fixed Key

2025-01-11T18:09:44Z

Fixed Key

← Older revision		Revision as of 18:09, 11 January 2025
Line 98:		Line 98:
	\| 0x00		\| 0x00
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| Key (0x00 = C-1, ~~0x60~~ = C4 (middle C), 0x7F = G9, FFFFFFFF = None)		\| Key (0x00 = C-1, 0x3C = C4 (middle C), 0x7F = G9, FFFFFFFF = None)
	\|-		\|-
	\| 0x04		\| 0x04

AwesomeTMC: Add more documentation

2024-12-28T08:11:01Z

Add more documentation

← Older revision		Revision as of 08:11, 28 December 2024
Line 1:		Line 1:
	[[category:File formats]]		[[category:File formats]]
	'''BRS''' ('''B'''inary '''R'''emix '''S'''equence) files contain sequence data for the NoteFairy (Rainbow Notes) object. ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'' each contain only one '''BRS''' file, located in <code>AudioRes/Info/JaiRemixSeq.arc/brs/defaultremixseq.brs</code>.		{{WIP}}'''BRS''' ('''B'''inary '''R'''emix '''S'''equence) files contain sequence data for the NoteFairy (Rainbow Notes) object. ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'' each contain only one '''BRS''' file, located in <code>AudioRes/Info/JaiRemixSeq.arc/brs/defaultremixseq.brs</code>.

	== Header ==		== Header ==
	The '''BRS''' format contains no header magic like most files do. Instead, it consists of a Sequence Count and ~~Pointers~~. The size of the header is <code>0x4 + (Sequence Count x 0x4)</code>:		The '''BRS''' format contains no header magic like most files do. Instead, it consists of a Sequence Count and Offsets. The size of the header is <code>0x4 + (Sequence Count x 0x4)</code>:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 16:		Line 16:

	=== Offsets ===		=== Offsets ===
	Each ~~pointer~~ holds the offset of a Sequence relative to the beginning of the file and is formatted like this:		Each offset holds the offset of a Sequence relative to the beginning of the file and is formatted like this:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 45:		Line 45:
	\|}		\|}

	== ~~Note Duration (?)~~ ==		== Unused/Unknown Section ==
	The header is followed by a section that ~~(presumably) defines the duration of each Note~~. This section's size is <code>Note Count x 0x4</code>.		The header is followed by a section that doesn't seem to do anything. This section's size is <code>Note Count x 0x4</code>.
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 55:		Line 55:
	\| 0x00		\| 0x00
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| ~~Note Duration (?)~~		\| Unused/Unknown
	\|}		\|}

	== Track ==		== Track ==
	Each Track starts by defining its instrument (0x4), followed by the individual Key-presses for a Note (0x10 each). There is no padding between Tracks.		Each Track starts by defining its instrument (0x4), followed by the individual Key-presses for a Note (0x10 each). There is no padding between Tracks.

			Only 16 keys can be played at once.
	=== Instrument ===		=== Instrument ===
	{\| class="wikitable"		{\| class="wikitable"
Line 68:		Line 70:
	\|-		\|-
	\| 0x00		\| 0x00
	\| ~~???~~ (0x2)		\| UInt16 (0x2)
	\| ~~Likely unused~~		\| Not used
	\|-		\|-
	\| 0x02		\| 0x02
	\| UInt8 (0x1)		\| UInt8 (0x1)
	\| ~~Set~~ Bank		\| Bank Number
	\|-		\|-
	\| 0x03		\| 0x03
	\| UInt8 (0x1)		\| UInt8 (0x1)
	\| ~~Set Prog~~		\| Program Number
	\|}		\|}

	=== Key ===		=== Key ===
			Duration's intended range is 0-1440 after being scaled. Any value above 1440 is clamped to 1440. However, due to the first 3 bytes being discarded at one point, a scaled duration above 255 can cause unexpected behavior.

			For instance, if a scaled duration is 0x1234, it is clamped to 0x05A0 (1440) and the 0x05 is discarded later on, making 0xA0 (160) how long it actually plays for.

			The tempo at any given time is calculated using: (player_magnitude * 3600.0) / (note_fairy_path_length / note_count)

			The scaled duration is calculated using: (120.0 * duration / tempo)
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 93:		Line 102:
	\| 0x04		\| 0x04
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| Velocity		\| Velocity. Valid range: 0-127.
	\|-		\|-
	\| 0x08		\| 0x08
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| Duration		\| Duration (in ticks?). Scaled to the tempo the song is being played at.
			Valid range: 0-255 after being scaled.
	\|-		\|-
	\| 0x0C		\| 0x0C
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| Delay		\| Delay (in ticks?)
	\|}		\|}

	== Sequences in SMG & SMG2 ==		== Sequences in SMG & SMG2 ==
	A sequence can be defined in Obj_arg4 for the NoteFairy object. The following sequences are available in both games:		A sequence can be defined in Obj_arg4 for the NoteFairy object. Obj_arg4 directly corresponds to the sequence index in defaultremixseq.brs. The following sequences are available in both games:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-

SY24: Added tag

2024-12-14T14:25:32Z

Added tag

← Older revision		Revision as of 14:25, 14 December 2024
Line 1:		Line 1:
			[[category:File formats]]
	'''BRS''' ('''B'''inary '''R'''emix '''S'''equence) files contain sequence data for the NoteFairy (Rainbow Notes) object. ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'' each contain only one '''BRS''' file, located in <code>AudioRes/Info/JaiRemixSeq.arc/brs/defaultremixseq.brs</code>.		'''BRS''' ('''B'''inary '''R'''emix '''S'''equence) files contain sequence data for the NoteFairy (Rainbow Notes) object. ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'' each contain only one '''BRS''' file, located in <code>AudioRes/Info/JaiRemixSeq.arc/brs/defaultremixseq.brs</code>.

AwesomeTMC at 21:47, 11 December 2024

2024-12-11T21:47:54Z

← Older revision		Revision as of 21:47, 11 December 2024
Line 14:		Line 14:
	\|}		\|}

	=== ~~Pointers~~ ===		=== Offsets ===
	Each pointer holds the offset of a Sequence relative to the beginning of the file and is formatted like this:		Each pointer holds the offset of a Sequence relative to the beginning of the file and is formatted like this:
	{\| class="wikitable"		{\| class="wikitable"
Line 58:		Line 58:

	== Track ==		== Track ==
	Each Track starts by defining an instrument (0x4), followed by the individual Key-presses for a Note (0x10 each). There is no padding between Tracks.		Each Track starts by defining its instrument (0x4), followed by the individual Key-presses for a Note (0x10 each). There is no padding between Tracks.
	=== Instrument ===		=== Instrument ===
	{\| class="wikitable"		{\| class="wikitable"
Line 68:		Line 68:
	\| 0x00		\| 0x00
	\| ??? (0x2)		\| ??? (0x2)
	\| ~~???~~		\| Likely unused
	\|-		\|-
	\| 0x02		\| 0x02
Line 92:		Line 92:
	\| 0x04		\| 0x04
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| Velocity ~~(?)~~		\| Velocity
	\|-		\|-
	\| 0x08		\| 0x08
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| Duration ~~(?)~~		\| Duration
	\|-		\|-
	\| 0x0C		\| 0x0C
	\| UInt32 (0x4)		\| UInt32 (0x4)
	\| ~~???~~		\| Delay
	\|}		\|}

SY24: Created BRS page

2024-12-11T12:23:33Z

Created BRS page

New page

'''BRS''' ('''B'''inary '''R'''emix '''S'''equence) files contain sequence data for the NoteFairy (Rainbow Notes) object. ''Super Mario Galaxy'' and ''Super Mario Galaxy 2'' each contain only one '''BRS''' file, located in <code>AudioRes/Info/JaiRemixSeq.arc/brs/defaultremixseq.brs</code>.

== Header ==
The '''BRS''' format contains no header magic like most files do. Instead, it consists of a Sequence Count and Pointers. The size of the header is <code>0x4 + (Sequence Count x 0x4)</code>:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Sequence Count
|}

=== Pointers ===
Each pointer holds the offset of a Sequence relative to the beginning of the file and is formatted like this:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Offset
|}

== Sequence Header ==
Each sequence's header consists of a Track and Note Count:
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Track Count
|-
| 0x04
| UInt32 (0x4)
| Note Count
|}

== Note Duration (?) ==
The header is followed by a section that (presumably) defines the duration of each Note. This section's size is <code>Note Count x 0x4</code>.
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Note Duration (?)
|}

== Track ==
Each Track starts by defining an instrument (0x4), followed by the individual Key-presses for a Note (0x10 each). There is no padding between Tracks.
=== Instrument ===
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| ??? (0x2)
| ???
|-
| 0x02
| UInt8 (0x1)
| Set Bank
|-
| 0x03
| UInt8 (0x1)
| Set Prog
|}

=== Key ===
{| class="wikitable"
|-
! Offset
! Type
! Description
|-
| 0x00
| UInt32 (0x4)
| Key (0x00 = C-1, 0x60 = C4 (middle C), 0x7F = G9, FFFFFFFF = None)
|-
| 0x04
| UInt32 (0x4)
| Velocity (?)
|-
| 0x08
| UInt32 (0x4)
| Duration (?)
|-
| 0x0C
| UInt32 (0x4)
| ???
|}

== Sequences in SMG & SMG2 ==
A sequence can be defined in Obj_arg4 for the NoteFairy object. The following sequences are available in both games:
{| class="wikitable"
|-
! Obj_arg4
! Name
! Note Count
! Notes
|-
| 0
| Super Mario Bros. main theme (long)
| 13
| Unused
|-
| 1
| Super Mario Bros. main theme (short)
| 7
| Unused
|-
| 2
| Super Mario Bros. underground theme
| 43
|
|-
| 3
| Super Mario Bros. main theme (short)
| 7
| Unused
|-
| 4
| Super Mario Bros. underwater theme
| 46
|
|-
| 5
| Super Mario World bonus room theme
| 64
|
|}