Difference between revisions of "CSNG (File Format)"

From Retro Modding Wiki
Jump to: navigation, search
(→‎Region Info)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
The '''CSNG format''' contains MIDI data. It appears in Metroid Prime 1 and 2.  It is essentially MusyX's SON music format, with a custom header.  
+
The '''CSNG format''' contains MIDI data. It appears in Metroid Prime 1 and 2.  It is essentially MusyX's GameCube SNG music format, with a custom header.  
  
 
__TOC__
 
__TOC__
Line 7: Line 7:
 
All offsets are relative to the start of the main header (after the custom header).  
 
All offsets are relative to the start of the main header (after the custom header).  
  
−
Timings are represented in ''ticks'', like MIDI. Unlike MIDI, the tick-resolution is fixed at 384
+
Overall, SNG functions similar to a Type-1 (multi-track) MIDI file, with (up to) 64 tracks
 +
merging their events into 16 General-MIDI sequencer channels. In addition to the multi-track
 +
structure, SNG supports storing MIDI regions as indexed ''patterns'', so songs with repetitive
 +
refrains can save on memory by referencing patterns more than once.
 +
 
 +
Timings are represented in ''ticks''. Unlike MIDI, the tick-resolution is fixed at 384
 
ticks per beat (e.g. 120 beats-per-minute works out to <code>384 * 120 / 60 = 768</code> ticks-per-second).
 
ticks per beat (e.g. 120 beats-per-minute works out to <code>384 * 120 / 60 = 768</code> ticks-per-second).
  
Line 37: Line 42:
 
| 0x10
 
| 0x10
 
| 4
 
| 4
−
| '''SON File Length'''
+
| '''SNG File Length'''
 
|-
 
|-
 
| 0x14
 
| 0x14
Line 52: Line 57:
 
| 0x0
 
| 0x0
 
| 4
 
| 4
−
| '''Version'''; always 0x18
+
| '''Track Index Offset'''; usually 0x18 for GCN games
 
|-
 
|-
 
| 0x4
 
| 0x4
 
| 4
 
| 4
−
| '''Track Data Offset'''; (absolute SON-offset)
+
| '''Region Data Index Offset'''
 
|-
 
|-
 
| 0x8
 
| 0x8
 
| 4
 
| 4
−
| '''Channel Map Offset'''; (absolute SON-offset)
+
| '''Channel Map Offset'''
 
|-
 
|-
 
| 0xC
 
| 0xC
 
| 4
 
| 4
−
| '''Tempo Table Offset'''; (absolute SON-offset) 0x0 if tempo doesn't change
+
| '''Tempo Table Offset'''; 0x0 if tempo doesn't change
 
|-
 
|-
 
| 0x10
 
| 0x10
Line 75: Line 80:
 
|-
 
|-
 
| 0x18
 
| 0x18
−
| 256
 
−
| '''Track Header Offsets'''; (absolute SON-offsets) 64 elements, 0x0 if track not present
 
−
|-
 
−
| 0x118
 
 
| colspan=2 {{unknown|End of header}}
 
| colspan=2 {{unknown|End of header}}
 
|}
 
|}
  
−
===Track Header===
+
===Region Info===
 +
 
 +
The ''track index'' has offsets relating the first '''region info''' for each track.
  
−
This is a variable-length table of headers for each track
+
There is a sequence of at least 2 region info structures populating each track, last one acting as terminator:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 93: Line 96:
 
| 0x0
 
| 0x0
 
| 4
 
| 4
−
| '''Start Tick'''; time-point to begin executing track data  
+
| '''Start Tick'''; time-point to begin executing region data  
 
|-
 
|-
 
| 0x4
 
| 0x4
Line 101: Line 104:
 
| 0x8
 
| 0x8
 
| 2
 
| 2
−
| '''Track Data Index'''
+
| '''Region Data Index'''; used to select region data when positive; -1 value terminates track; -2 value loops jumps to ''Loop Region Index'' at this region's tick
 
|-
 
|-
 
| 0xA
 
| 0xA
 
| 2
 
| 2
−
| '''Padding'''
+
| '''Loop Region Index'''; index of region to jump to if ''Region Data Index'' set to -2
 
|-
 
|-
 
| 0xC
 
| 0xC
−
| 4
+
| colspan=2 {{unknown|End of region info}}
−
| '''Start Tick'''; copy of start tick
+
−
|-
+
−
| 0x10
+
−
| 4
+
−
| {{unknown|'''Unknown'''}}; commonly 0xffff0000
+
−
|-
+
−
| 0x14
+
−
| 4
+
−
| {{unknown|'''Unknown'''}}; commonly 0xffff0000
+
−
|-
+
−
| 0x18
+
−
| colspan=2 {{unknown|End of header}}
+
 
|}
 
|}
  
−
===Track Data===
+
===Region Data===
  
−
Here begins a free-form blob of indexed track data. It starts with a variable-length  
+
Here begins a free-form blob of indexed region data. It starts with a variable-length  
−
'''u32 array''' of SON offsets for each track, then the track data itself.
+
'''u32 array''' of SNG offsets for each region, then the region data itself.
  
−
====Track Data Header====
+
====Region Data Header====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 137: Line 128:
 
| 0x0
 
| 0x0
 
| 4
 
| 4
−
| '''Track Data Header Size'''; size of the header ''after'' this field (always 0x8)
+
| '''Region Data Header Size'''; size of the header ''after'' this field (always 0x8)
 
|-
 
|-
 
| 0x4
 
| 0x4
 
| 4
 
| 4
−
| '''Pitch Wheel Data Offset'''; (absolute SON-offset) 0x0 if no pitch-wheel messages on track
+
| '''Pitch Wheel Data Offset'''; (absolute SNG-offset) 0x0 if no pitch-wheel messages in region
 
|-
 
|-
 
| 0x8
 
| 0x8
 
| 4
 
| 4
−
| '''Mod Wheel Data Offset'''; (absolute SON-offset) 0x0 if no mod-wheel messages on track
+
| '''Mod Wheel Data Offset'''; (absolute SNG-offset) 0x0 if no mod-wheel messages in region
 
|-
 
|-
 
| 0xC
 
| 0xC
−
| colspan=2 {{unknown|End of header}}
+
| colspan=2 {{unknown|End of region data}}
 
|}
 
|}
  
−
====Track Commands====
+
====Region Commands====
  
−
After the track data header, the actual playback commands begin. There are only 2 types of commands
+
After the region data header, the actual playback commands begin. There are only 3 types of commands
−
in SON: ''note'' and ''control change''.
+
in SNG: ''note'', ''control change'', and ''program change''.
  
−
=====Delta Time RLE=====
+
=====Delta Time Encoding=====
  
 
Just like MIDI, each command starts with a '''delta time''' value telling the sequencer  
 
Just like MIDI, each command starts with a '''delta time''' value telling the sequencer  
−
how many ticks to wait after the previous command. Unlike MIDI, Factor5 uses a custom
+
how many ticks to wait after the previous command. Unlike MIDI, Factor5 uses a fixed 16-bit
−
[[wikipedia:Run-length encoding|RLE scheme]] to adaptively scale the value's precision
+
value to store the delta times. In case of a delta time greater than 65535, no-op commands
−
to reduce the value's size.
+
with a 65535 delta time are inserted into the command stream until the target time is attained.
−
 
+
−
The RLE operates on 16-bit words, with the value 0xffff triggering a continuation,
+
−
then a 'dead' 16-bit word skipped over, then the 0xffff is summed with the following RLE value,
+
−
looping the decode algorithm.
+
  
−
In Python, decoding works like so:
+
In a theoretical Python streaming API, the delta time can be decoded with no-ops automatically consumed like so:
  
 
<syntaxhighlight lang="python" line="1">
 
<syntaxhighlight lang="python" line="1">
−
def DecodeDeltaTimeRLE(streamIn):
+
def DecodeDeltaTime(streamIn):
 
     total = 0
 
     total = 0
 
     while True:
 
     while True:
 
         term = streamIn.ReadU16()
 
         term = streamIn.ReadU16()
−
         if term == 0xffff:
+
        next = streamIn.PeekU16()
 +
         if next == 0:
 +
            # Automatically consume no-op and continue accumulating time value
 
             total += 0xffff
 
             total += 0xffff
−
             dummy = streamIn.ReadU16()
+
             streamIn.seekAhead(2)
 
             continue
 
             continue
 
         total += term
 
         total += term
 
         return total
 
         return total
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
=====No-Op Command=====
 +
 +
When the two bytes following the delta-time are both zero, this is a no-op command.
 +
 +
As mentioned before, no-ops are useful for accumulating delta times greater than 65535.
  
 
=====Note Command=====
 
=====Note Command=====
  
−
When the two bytes following the delta-time != 0xffff, and the high-bit of the first byte is ''unset'',
+
When the two bytes following the delta-time != 0xffff, and the high-bits of both bytes are ''unset'',
 
this is a '''note command'''.  
 
this is a '''note command'''.  
  
−
Unlike MIDI, which has separate commands for note-on/note-off, SON attaches a ''note length'' value
+
Unlike MIDI, which has separate commands for note-on/note-off, SNG attaches a ''note length'' value
 
to a note-on command, which is then able to track its own lifetime.
 
to a note-on command, which is then able to track its own lifetime.
  
Line 213: Line 208:
 
=====Control Change Command=====
 
=====Control Change Command=====
  
−
When the two bytes following the delta-time != 0xffff, and the high-bit of the first byte is ''set'',
+
When the two bytes following the delta-time != 0xffff, and the high-bits of both bytes are ''set'',
 
this is a '''control change command'''.
 
this is a '''control change command'''.
  
Line 235: Line 230:
 
|}
 
|}
  
−
=====End Of Track=====
+
=====Program Change Command=====
  
−
When the two bytes following the delta-time == 0xffff, this track has no more commands.
+
When the two bytes following the delta-time != 0xffff, and the high-bit of the first byte is ''set'',
 +
this is a '''program change command'''.
 +
 
 +
See the [https://www.midi.org/specifications/item/gm-level-1-sound-set standard MIDI program numbers] for details.
 +
 
 +
{| class="wikitable"
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0
 +
| 1
 +
| '''Program'''; AND with 0x7f for the value
 +
|-
 +
| 0x1
 +
| 1
 +
| '''Padding'''; always zero
 +
|-
 +
| 0x2
 +
| colspan=2 {{unknown|End of program change}}
 +
|}
 +
 
 +
=====End Of Region=====
 +
 
 +
When the two bytes following the delta-time == 0xffff, this region has no more commands.
  
 
====Continuous Pitch / Modulation Data====
 
====Continuous Pitch / Modulation Data====
  
−
If the pitch or mod offsets in a track are non-zero, they point to a buffer of RLE-compressed
+
If the pitch or mod offsets in a region are non-zero, they point to a buffer of
−
(delta-tick, delta-value) pairs, decoding to signed 16-bit precision. The decoder must track
+
(delta-tick, delta-value) pairs. The delta times are encoded as unsigned 7/15 bit values
−
the absolute time and value, summing each consecutive update for the current time/values.
+
and the delta values are signed 7/15-bit values. The values are promoted to 15-bit if they
 +
exceed their 7-bit range. In this case, the highest bit is set on the first byte in the pair
 +
(0x80). The decoder must track the absolute time and value, summing each consecutive update
 +
for the current time/values.
  
−
The algorithm for this RLE is different than the delta-time one for commands. It may
+
The byte sequence 0x80 0x00 is a special case that signals the end of the stream.
−
scale down to a single byte if able.
+
 
 +
Similar to the command stream, when the delta time exceeds 15 bit range (>32767), extra pairs
 +
with a zeroed value delta are inserted.
  
 
<syntaxhighlight lang="python" line="1">
 
<syntaxhighlight lang="python" line="1">
−
def DecodeRLE(streamIn):
+
def SignExtend7(value):
−
     # high-bit shift-trigger RLE, limited to 2 bytes
+
     return (value & 0x3f) - (value & 0x40)
−
    term = streamIn.ReadU8()
+
−
    total = term & 0x7f
+
−
    if term & 0x80:
+
−
        total = total * 256 + streamIn.ReadU8()
+
−
    return total
+
  
−
def DecodeContinuousRLE(streamIn, isValue):
+
def SignExtend15(value):
−
     total = 0
+
     return (value & 0x3fff) - (value & 0x4000)
−
    while True:
+
−
        # 1-2 byte RLE accumulated within continuable RLE
+
−
        term = DecodeRLE(streamIn)
+
−
        if term == 0x8000:
+
−
            total += 0xffff
+
−
            dummy = in.ReadU8()
+
−
            continue
+
−
        total += term
+
  
−
        # values are signed deltas;
+
def DecodeSignedValue(streamIn):
−
        # extending into the high-half of 15-bit precision
+
    byte0 = streamIn.ReadU8()
−
        if isValue:
+
    if byte0 & 0x80:
−
            if total >= 0x4000:
+
        byte1 = streamIn.ReadU8()
−
                return total - 0xffff
+
        return SignExtend15(byte1 | ((byte0 & 0x7f) << 8))
−
            else:
+
    else:
−
                return total
+
        return SignExtend7(byte0)
  
−
         # times are always forward-deltas
+
def DecodeUnsignedValue(streamIn):
−
         return total
+
    byte0 = streamIn.ReadU8()
 +
    if byte0 & 0x80:
 +
         byte1 = streamIn.ReadU8()
 +
        return byte1 | ((byte0 & 0x7f) << 8)
 +
    else:
 +
        return byte0
 +
 
 +
def DecodeDeltaPair(streamIn):
 +
    ret = [0,0]
 +
    while ret[1] == 0:
 +
        if streamIn.PeekU16() == 0x8000:
 +
            # The stream has ended
 +
            break
 +
         ret[0] += DecodeUnsignedValue(streamIn)
 +
        ret[1] = DecodeSignedValue(streamIn)
 +
    return ret
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
===Channel Map===
 
===Channel Map===
  
−
This is a simple '''u8 table''' mapping 64 SON tracks to 16 MIDI channels for instrument selection via the [[AGSC (File Format)#MIDI Setup Entry|SongGroup MIDI-Setup]].
+
This is a simple '''u8 table''' mapping 64 SNG tracks to 16 MIDI channels for instrument selection via the [[AGSC (File Format)#MIDI Setup Entry|SongGroup MIDI-Setup]].
  
 
===Tempo Table===
 
===Tempo Table===
  
−
When the SON has a non-zero tempo table offset, this song features tempo changes.  
+
When the SNG has a non-zero tempo table offset, this song features tempo changes.  
 
The change events are simple absolute-tick / BPM pairs.
 
The change events are simple absolute-tick / BPM pairs.
  

Latest revision as of 23:32, 3 September 2018

The CSNG format contains MIDI data. It appears in Metroid Prime 1 and 2. It is essentially MusyX's GameCube SNG music format, with a custom header.

Format

All offsets are relative to the start of the main header (after the custom header).

Overall, SNG functions similar to a Type-1 (multi-track) MIDI file, with (up to) 64 tracks merging their events into 16 General-MIDI sequencer channels. In addition to the multi-track structure, SNG supports storing MIDI regions as indexed patterns, so songs with repetitive refrains can save on memory by referencing patterns more than once.

Timings are represented in ticks. Unlike MIDI, the tick-resolution is fixed at 384 ticks per beat (e.g. 120 beats-per-minute works out to 384 * 120 / 60 = 768 ticks-per-second).

Custom Header

This 0x14-byte header isn't part of the MusyX format; it appears at the start of the file. After parsing this the rest of the file is copied into a buffer and then passed to the MusyX functions.

Offset Size Description
0x0 4 Magic; (always 0x2)
0x4 4 MIDI Setup ID
0x8 4 SongGroup ID
0xC 4 AGSC ID
0x10 4 SNG File Length
0x14 MusyX data starts

Header

Offset Size Description
0x0 4 Track Index Offset; usually 0x18 for GCN games
0x4 4 Region Data Index Offset
0x8 4 Channel Map Offset
0xC 4 Tempo Table Offset; 0x0 if tempo doesn't change
0x10 4 Initial Tempo; (commonly 0x78 or 120 beats per minute)
0x14 4 Unknown
0x18 End of header

Region Info

The track index has offsets relating the first region info for each track.

There is a sequence of at least 2 region info structures populating each track, last one acting as terminator:

Offset Size Description
0x0 4 Start Tick; time-point to begin executing region data
0x4 4 Unknown; commonly 0xffff0000
0x8 2 Region Data Index; used to select region data when positive; -1 value terminates track; -2 value loops jumps to Loop Region Index at this region's tick
0xA 2 Loop Region Index; index of region to jump to if Region Data Index set to -2
0xC End of region info

Region Data

Here begins a free-form blob of indexed region data. It starts with a variable-length u32 array of SNG offsets for each region, then the region data itself.

Region Data Header

Offset Size Description
0x0 4 Region Data Header Size; size of the header after this field (always 0x8)
0x4 4 Pitch Wheel Data Offset; (absolute SNG-offset) 0x0 if no pitch-wheel messages in region
0x8 4 Mod Wheel Data Offset; (absolute SNG-offset) 0x0 if no mod-wheel messages in region
0xC End of region data

Region Commands

After the region data header, the actual playback commands begin. There are only 3 types of commands in SNG: note, control change, and program change.

Delta Time Encoding

Just like MIDI, each command starts with a delta time value telling the sequencer how many ticks to wait after the previous command. Unlike MIDI, Factor5 uses a fixed 16-bit value to store the delta times. In case of a delta time greater than 65535, no-op commands with a 65535 delta time are inserted into the command stream until the target time is attained.

In a theoretical Python streaming API, the delta time can be decoded with no-ops automatically consumed like so: 

  1. def DecodeDeltaTime(streamIn):
  2.     total = 0
  3.     while True:
  4.         term = streamIn.ReadU16()
  5.         next = streamIn.PeekU16()
  6.         if next == 0:
  7.             # Automatically consume no-op and continue accumulating time value
  8.             total += 0xffff
  9.             streamIn.seekAhead(2)
  10.             continue
  11.         total += term
  12.         return total
No-Op Command

When the two bytes following the delta-time are both zero, this is a no-op command.

As mentioned before, no-ops are useful for accumulating delta times greater than 65535.

Note Command

When the two bytes following the delta-time != 0xffff, and the high-bits of both bytes are unset, this is a note command.

Unlike MIDI, which has separate commands for note-on/note-off, SNG attaches a note length value to a note-on command, which is then able to track its own lifetime.

Offset Size Description
0x0 1 Note; AND with 0x7f for the value
0x1 1 Velocity; AND with 0x7f for the value
0x2 2 Note Length; count of ticks before note-off issued by sequencer
0x4 End of note
Control Change Command

When the two bytes following the delta-time != 0xffff, and the high-bits of both bytes are set, this is a control change command.

See the standard MIDI control numbers for details.

Offset Size Description
0x0 1 Value; AND with 0x7f for the value
0x1 1 Control; AND with 0x7f for the value
0x2 End of control change
Program Change Command

When the two bytes following the delta-time != 0xffff, and the high-bit of the first byte is set, this is a program change command.

See the standard MIDI program numbers for details.

Offset Size Description
0x0 1 Program; AND with 0x7f for the value
0x1 1 Padding; always zero
0x2 End of program change
End Of Region

When the two bytes following the delta-time == 0xffff, this region has no more commands.

Continuous Pitch / Modulation Data

If the pitch or mod offsets in a region are non-zero, they point to a buffer of (delta-tick, delta-value) pairs. The delta times are encoded as unsigned 7/15 bit values and the delta values are signed 7/15-bit values. The values are promoted to 15-bit if they exceed their 7-bit range. In this case, the highest bit is set on the first byte in the pair (0x80). The decoder must track the absolute time and value, summing each consecutive update for the current time/values.

The byte sequence 0x80 0x00 is a special case that signals the end of the stream.

Similar to the command stream, when the delta time exceeds 15 bit range (>32767), extra pairs with a zeroed value delta are inserted. 

  1. def SignExtend7(value):
  2.     return (value & 0x3f) - (value & 0x40)
  3.  
  4. def SignExtend15(value):
  5.     return (value & 0x3fff) - (value & 0x4000)
  6.  
  7. def DecodeSignedValue(streamIn):
  8.     byte0 = streamIn.ReadU8()
  9.     if byte0 & 0x80:
  10.         byte1 = streamIn.ReadU8()
  11.         return SignExtend15(byte1 | ((byte0 & 0x7f) << 8))
  12.     else:
  13.         return SignExtend7(byte0)
  14.  
  15. def DecodeUnsignedValue(streamIn):
  16.     byte0 = streamIn.ReadU8()
  17.     if byte0 & 0x80:
  18.         byte1 = streamIn.ReadU8()
  19.         return byte1 | ((byte0 & 0x7f) << 8)
  20.     else:
  21.         return byte0
  22.  
  23. def DecodeDeltaPair(streamIn):
  24.     ret = [0,0]
  25.     while ret[1] == 0:
  26.         if streamIn.PeekU16() == 0x8000:
  27.             # The stream has ended
  28.             break
  29.         ret[0] += DecodeUnsignedValue(streamIn)
  30.         ret[1] = DecodeSignedValue(streamIn)
  31.     return ret

Channel Map

This is a simple u8 table mapping 64 SNG tracks to 16 MIDI channels for instrument selection via the SongGroup MIDI-Setup.

Tempo Table

When the SNG has a non-zero tempo table offset, this song features tempo changes. The change events are simple absolute-tick / BPM pairs.

Offset Size Description
0x0 4 Tick; absolute time-point to perform tempo change
0x4 4 Tempo; new tempo in BPM
0x2 End of tempo change
Retrieved from "http://www.metroid2002.com/retromodding/index.php?title=CSNG_(File_Format)&oldid=1950"