ProjectPokemon Wiki - User contributions [en]

Dse smdl

2017-03-04T22:56:35Z

Psy commando: /* Example Event */ Made a typo in the example.. There are 3 parameter bytes, so the note data should be 0xE5. Thanks to Techie for pointing it out! ^^

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:NDS Mystery Dungeon]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
The EoC chunk marks the end of the SMDL file/container.

{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0011 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0xE5
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips the next byte in the track.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 0
| -
| SkipNext2Bytes
| Skip the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|-
| 0xF8
| 0
| -
| SkipNext2Bytes2
| Skips the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]
* The unknown Japanese author of the "smd2mid v0.10" utility floating around the web.

Dse smdl

2017-03-04T22:38:53Z

Psy commando: /* PlayNote(0x0 to 0x7F) */ Fixed massive typo on my end ^^; Octavemod and nb parambytes had their masks inverted! Thanks to Techy for pointing it out!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:NDS Mystery Dungeon]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
The EoC chunk marks the end of the SMDL file/container.

{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0011 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips the next byte in the track.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 0
| -
| SkipNext2Bytes
| Skip the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|-
| 0xF8
| 0
| -
| SkipNext2Bytes2
| Skips the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]
* The unknown Japanese author of the "smd2mid v0.10" utility floating around the web.

Dse smdl

2017-03-04T22:38:25Z

Psy commando: /* PlayNote(0x0 to 0x7F) */ Fixed massive typo on my end ^^; Octavemod and nb parambytes had their masks inverted! Thanks to Techy for pointing it out!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:NDS Mystery Dungeon]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
The EoC chunk marks the end of the SMDL file/container.

{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips the next byte in the track.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 0
| -
| SkipNext2Bytes
| Skip the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|-
| 0xF8
| 0
| -
| SkipNext2Bytes2
| Skips the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]
* The unknown Japanese author of the "smd2mid v0.10" utility floating around the web.

Pmd2 Level System

2017-01-05T22:06:26Z

Psy commando: /* The Level Table */ cleared up something

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Level System in the PMD Explorers Games}}

== Overview ==
This article will try to describe how levels work in the pmd2 games.

== Engine Modes ==
There are essentially 2 modes that the game can run levels as. In-dungeon, referred to as simply "Dungeon", and out-of-dungeon, referred to as "Ground".
Ground mode is the default mode. Dungeon mode is triggered from scripts run by the Ground engine.

* '''Dungeon:''' The dungeon mode is run as soon as a script from the "ground" engine calls the command to run a dungeon. And once a dungeon concludes, execution returns to the line after the command to run the dungeon, and the game falls back into "ground" mode. Scripts aren't executed at all during dungeon mode, since the overlay running scripts is unloaded and replaced with the dungeon engine overlay.

* '''Ground:''' The game runs in this mode as soon as the chunsoft logo pops up on screen. Game scripts are executed only in this mode.

== The Level Table ==
Located in the ARM9 binary. (arm9.bin)
Its a table associating a level ID to level related data. Every "Ground" levels in the game have an entry in this table.

=== Location in the Binaries ===
The table is always inside the arm9 binary, and never in an overlay.

{| class="wikitable"
! Game
! Game Code
! Table Offset
! Nb Entries
|-
| '''North American Explorers of Sky'''
| C2SE
| 0xA5488
| 431
|-
| '''European Explorers of Sky'''
| C2SP
| 0xA5BE0
| 459
|-
| '''Japanese Explorers of Sky'''
| C2SJ
| 0xA689C
| 436
|}

=== Format ===
Each entry is 12 bytes and is laid out this way.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| int16
| mapty
| Type of the map. A value from 0 to 11 defining how a map is loaded and displayed.
|-
| 0x02
| 2
| int16
| unk2
| Unknown value. (0 to 306)
|-
| 0x04
| 2
| int16
| mapid
| ID number of the map. Most likely used in the [[pmd2_bg_list.dat|bg_list.dat]] file to look up the level's resources files.
|-
| 0x06
| 2
| int16
| unk4
| Unknown value. (-1 to 7)
|-
| 0x08
| 4
| uint32
| ptrstring
| Pointer to a null terminated string, containing the internal name of the level. Is used as directory name for the script to run, and for debugging.
|}

== Level Constants and Map Types ==
Depending on the map type, and on the command used to load a level, a different set of constant will be used by the game.

<span style="color: red; text-decoration: bold;">TODO</span>

== Credits ==

Pmd2 eos asm locations

2016-12-17T21:01:04Z

Psy commando: /* ARM9 Bin (0x2000000) */ reordered

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:ASM Locations in the PMD:Explorers of Sky Games}}

== Overview ==
This page contains list of the interesting offsets within the game's binaries.
The offsets are NDS memory relative, because that's more useful that bin files offsets.
Just subtract the binary's load address to get its respective file offset.

== Functions ==
Functions pointers and some documentation on them.

=== ARM9 Bin (0x2000000) ===
{| class="wikitable"
! Name
! Offset NA
! Offset EU
! Offset JP
! Parameters
! Return value
! Description
|-
| '''MemAlloc'''
| 0x2001170
| NA
| NA
|
*r0: alloc size
*r1: unknown
|
*r0: Pointer to allocated buffer
| This function allocates a buffer on the heap of the desired size, and returns a pointer to it. The second parameter's role is unclear.. It might be a flag, since it doesn't seems to change the amount of memory allocated. It can be set to 0.
|-
| '''MemFree'''
| 0x2001188
| NA
| NA
|
*r0: buffer to free
| none
| This function free a buffer that was allocated by MemAlloc.
|-
| '''ZeroFill'''
| 0x2003250
| NA
| NA
|
*r0: Buffer to fill
*r1: Length to fill
| none
| This function fills the given buffer with zeros.
|-
| '''LoadFileFromRom'''
| 0x2008C3C
| NA
| NA
|
*r0: PtrReturnStruct(Struct is 2 32bits integers, first is ptr of file buffer, second is loaded file length)
*r1: PtrStrFilePath (Ptr to path to the file to load)
*r2: Unknown (Set to 0 usually)
| Unknown
| This function will load a file from the rom filesystem into a heap allocated buffer. The function allocates the buffer, and fill it with the file data. The address to the buffer containing the file data and its size in bytes are put one after the other into the 8bytes of memory pointed by r0 when running the function!
|-
| '''DebugPrint'''
| 0x200C240
| NA
| NA
| Unknown
| none
| This function would print to the debug log a printf formated string. But in the retail game it does nothing. Its interesting to note that its still called in the released games and is passed various debug strings and value which can be really useful for research!
|-
| '''HandleSIR0Translation'''
| 0x201F4B4
| NA
| NA
|
*r0: PtrToPtrSIR0BegOfData
*r1: PtrSrcFileBuffer
| none
| This function translates the offsets of a SIR0 file, and change the magic number in the header to SIRO. It places a pointer to the first pointed location in the SIR0 header into the ptr pointed to by r0.
|}

== Static Variables ==
Addresses of static variables and buffers.

== Constants ==
Addresses of static constant values.

=== ARM9 Bin (0x2000000) ===
{| class="wikitable"
! Name
! Offset NA
! Offset EU
! Offset JP
! Length(bytes)
! Type
! Description
|-
| '''PackFilesPathsTable'''
| 0x20AF6A0
| NA
| NA
| 24
| char*[6]
| Contains a list of pointers to path strings to all known pack files. The game uses this table to load its resources when launching dungeon play!
Should contain pointers to the strings:
* "MONSTER/monster.bin"
* "MONSTER/m_attack.bin"
* "MONSTER/m_ground.bin"
* "EFFECT/effect.bin"
* "DUNGEON/dungeon.bin"
* "BALANCE/m_level.bin"
|}

Pmd2 eos asm locations

2016-12-17T21:00:02Z

Psy commando: /* ARM9 Bin (0x2000000) */ added load file function

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:ASM Locations in the PMD:Explorers of Sky Games}}

== Overview ==
This page contains list of the interesting offsets within the game's binaries.
The offsets are NDS memory relative, because that's more useful that bin files offsets.
Just subtract the binary's load address to get its respective file offset.

== Functions ==
Functions pointers and some documentation on them.

=== ARM9 Bin (0x2000000) ===
{| class="wikitable"
! Name
! Offset NA
! Offset EU
! Offset JP
! Parameters
! Return value
! Description
|-
| '''MemAlloc'''
| 0x2001170
| NA
| NA
|
*r0: alloc size
*r1: unknown
|
*r0: Pointer to allocated buffer
| This function allocates a buffer on the heap of the desired size, and returns a pointer to it. The second parameter's role is unclear.. It might be a flag, since it doesn't seems to change the amount of memory allocated. It can be set to 0.
|-
| '''MemFree'''
| 0x2001188
| NA
| NA
|
*r0: buffer to free
| none
| This function free a buffer that was allocated by MemAlloc.
|-
| '''ZeroFill'''
| 0x2003250
| NA
| NA
|
*r0: Buffer to fill
*r1: Length to fill
| none
| This function fills the given buffer with zeros.
|-
| '''DebugPrint'''
| 0x200C240
| NA
| NA
| Unknown
| none
| This function would print to the debug log a printf formated string. But in the retail game it does nothing. Its interesting to note that its still called in the released games and is passed various debug strings and value which can be really useful for research!
|-
| '''LoadFileFromRom'''
| 0x2008C3C
| NA
| NA
|
*r0: PtrReturnStruct(Struct is 2 32bits integers, first is ptr of file buffer, second is loaded file length)
*r1: PtrStrFilePath (Ptr to path to the file to load)
*r2: Unknown (Set to 0 usually)
| Unknown
| This function will load a file from the rom filesystem into a heap allocated buffer. The function allocates the buffer, and fill it with the file data. The address to the buffer containing the file data and its size in bytes are put one after the other into the 8bytes of memory pointed by r0 when running the function!
|-
| '''HandleSIR0Translation'''
| 0x201F4B4
| NA
| NA
|
*r0: PtrToPtrSIR0BegOfData
*r1: PtrSrcFileBuffer
| none
| This function translates the offsets of a SIR0 file, and change the magic number in the header to SIRO. It places a pointer to the first pointed location in the SIR0 header into the ptr pointed to by r0.
|}

== Static Variables ==
Addresses of static variables and buffers.

== Constants ==
Addresses of static constant values.

=== ARM9 Bin (0x2000000) ===
{| class="wikitable"
! Name
! Offset NA
! Offset EU
! Offset JP
! Length(bytes)
! Type
! Description
|-
| '''PackFilesPathsTable'''
| 0x20AF6A0
| NA
| NA
| 24
| char*[6]
| Contains a list of pointers to path strings to all known pack files. The game uses this table to load its resources when launching dungeon play!
Should contain pointers to the strings:
* "MONSTER/monster.bin"
* "MONSTER/m_attack.bin"
* "MONSTER/m_ground.bin"
* "EFFECT/effect.bin"
* "DUNGEON/dungeon.bin"
* "BALANCE/m_level.bin"
|}

Pmd2 eos asm locations

2016-12-17T20:28:47Z

Psy commando: Added more explanations, and locations

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:ASM Locations in the PMD:Explorers of Sky Games}}

== Overview ==
This page contains list of the interesting offsets within the game's binaries.
The offsets are NDS memory relative, because that's more useful that bin files offsets.
Just subtract the binary's load address to get its respective file offset.

== Functions ==
Functions pointers and some documentation on them.

=== ARM9 Bin (0x2000000) ===
{| class="wikitable"
! Name
! Offset NA
! Offset EU
! Offset JP
! Parameters
! Return value
! Description
|-
| '''MemAlloc'''
| 0x2001170
| NA
| NA
|
*r0: alloc size
*r1: unknown
|
*r0: Pointer to allocated buffer
| This function allocates a buffer on the heap of the desired size, and returns a pointer to it. The second parameter's role is unclear.. It might be a flag, since it doesn't seems to change the amount of memory allocated. It can be set to 0.
|-
| '''MemFree'''
| 0x2001188
| NA
| NA
|
*r0: buffer to free
| none
| This function free a buffer that was allocated by MemAlloc.
|-
| '''ZeroFill'''
| 0x2003250
| NA
| NA
|
*r0: Buffer to fill
*r1: Length to fill
| none
| This function fills the given buffer with zeros.
|-
| '''DebugPrint'''
| 0x200C240
| NA
| NA
| Unknown
| none
| This function would print to the debug log a printf formated string. But in the retail game it does nothing. Its interesting to note that its still called in the released games and is passed various debug strings and value which can be really useful for research!
|-
| '''HandleSIR0Translation'''
| 0x201F4B4
| NA
| NA
|
*r0: PtrToPtrSIR0BegOfData
*r1: PtrSrcFileBuffer
| none
| This function translates the offsets of a SIR0 file, and change the magic number in the header to SIRO. It places a pointer to the first pointed location in the SIR0 header into the ptr pointed to by r0.
|}

== Static Variables ==
Addresses of static variables and buffers.

== Constants ==
Addresses of static constant values.

=== ARM9 Bin (0x2000000) ===
{| class="wikitable"
! Name
! Offset NA
! Offset EU
! Offset JP
! Length(bytes)
! Type
! Description
|-
| '''PackFilesPathsTable'''
| 0x20AF6A0
| NA
| NA
| 24
| char*[6]
| Contains a list of pointers to path strings to all known pack files. The game uses this table to load its resources when launching dungeon play!
Should contain pointers to the strings:
* "MONSTER/monster.bin"
* "MONSTER/m_attack.bin"
* "MONSTER/m_ground.bin"
* "EFFECT/effect.bin"
* "DUNGEON/dungeon.bin"
* "BALANCE/m_level.bin"
|}

Pmd2 eos asm locations

2016-12-15T08:33:49Z

Psy commando: Created the base structure of the page and added a few functions to the list for now. More to do!!

Pokémon Mystery Dungeon Explorers

2016-12-15T08:06:51Z

Psy commando: /* Explorers of Sky */ Added a link to the asm location page for PMD2

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness}}

== General Information ==
This page contains data on the Pokémon Mystery Dungeon: Explorers of Sky/Time/Darkness games.

== Explorers of Sky ==
Data Specific to Explorers of Sky

Here's a list of all known functions and data offsets within the game's binaries:
* [[pmd2_eos_asm_locations|Functions and Data Offset]]

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

: '''Overlay #00''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 395,680 bytes
:* Description: Possibly contains data and code related to wifi multiplayer, in addition to the root menu. It mentions several files from the BACK folder that are known backgrounds for the root menu.

: '''Overlay #01''':
:* RAM Load address: 0x02329520
:* Length in RAM: 77,088 bytes
:* Description: Seems related to wifi rescue. It mentions several files from the GROUND and BACK folders:
:** 0x11ab8 : "BACK/expback.bgp"
:** 0x11b00 : "BACK/s07p02a.bgp"
:** 0x11b38 : "BACK/expback.bgp"
:** 0x11b70 : "BACK/expback.bgp"
:** 0x11b84 : "GROUND/s18p01a4.wan"
:** 0x11b98 : "GROUND/s18p01a2.wan"
:** 0x11bac : "GROUND/s18p01a3.wan"
:** 0x11be4 : "GROUND/s18p01a1.wan"
:** 0x11bf8 : "BACK/s18p01a.bgp"

: '''Overlay #02''':
:* RAM Load address: 0x02329520
:* Length in RAM: 176,032 bytes
:* Description: Most likely code for the Nintendo wifi setup.

: '''Overlay #03''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 41,312 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0xA078.

: '''Overlay #04''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,232 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0x2BA4.

: '''Overlay #05''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 12,864 bytes
:* Description: Unknown so far. Contain a single line of dialog formated text "[CS:X][string:0][CR][CLUM_SET:88][rank:0]" at 0x31EC

: '''Overlay #06''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 9,312 bytes
:* Description: Probably linked to WiFi rescue. Found those strings:
:** 0x2354 : "Mysterious WiFi: Illegal Identifier"
:** 0x237C : "Mysterious WiFi: Difference Version"
:** 0x23A4 : "Mysterious WiFi: Difference Language"
:** 0x23CC : "Mysterious WiFi: Difference Check Sum: 0x%08x 0x%08x"
:** 0x2404 : "Mysterious WiFi: Illegal Data"

: '''Overlay #07''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 20,736 bytes
:* Description: Unknown so far.

: '''Overlay #08''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 8,704 bytes
:* Description: Seems related to WiFi communications, from the string search results.

: '''Overlay #09''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,648 bytes
:* Description: Unknown this far. Has a single mention of "BACK/s18p02a.bgp" at 0x2D00

: '''Overlay #10''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 128,928 bytes
:* Description: Unknown this far. Some interesting strings:
:** 0x1F58C : "Lv. %d"
:** 0x1F594 : "[value:0:3]/[value:1:3]"
:** 0x1F5AC : "Lv. %d [CLUM_SET:44][value:0:3]/[value:1:3]"
:** 0x1F5D8 : "%s[CLUM_SET:70]%s"
:** 0x1F5EC : "/DUNGEON/sub2.bgp"
:** 0x1F600 : "/DUNGEON/sub.bgp"
:** 0x1F614 : "MainGame enter dungeon mode %d %d"
:** 0x1F638 : "dungeon fade out mode %d"
:** 0x1F654 : "dungeon getout result %d"
:** 0x1F694 : "rom0:BALANCE/mappa_gs.bin"
:** 0x1F6B0 : "dungeon map index %3d floor %3d -> dg index %3d floor max %3d -> bg index %3d table index %3d"
:** 0x1F710 : "rom0:BALANCE/fixed.bin"

: '''Overlay #11''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 298,048 bytes
:* Description: Most likely the script engine for the game !

: '''Overlay #12''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #13''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,904 bytes
:* Description: Controls the personality test, including the available partners and playable Pokémon. Personality test questions are stored in the MESSAGE folder.

: '''Overlay #14''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 15,072 bytes
:* Description: Probably what runs the gatekeeper mini-game(String search returned mention of footprints).

: '''Overlay #15''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 4,192 bytes
:* Description: Possibly has to do with Duskull's bank. Got this "Menu_Bank_Mode_Cancel" at 0xFB4.

: '''Overlay #16''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,552 bytes
:* Description: Possibly linked to the Chimecho's assembly menu. Got this string "menuMonsterPictureBook_IsBusy busy" at 0x2CC4.

: '''Overlay #17''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 7,392 bytes
:* Description: Unknown this far.

: '''Overlay #18''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 13,568 bytes
:* Description: Unknown this far.

: '''Overlay #19''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 16,960 bytes
:* Description: Possibly linked to Spinda's cafe.

: '''Overlay #20''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 12,288 bytes
:* Description: Unknown this far.

: '''Overlay #21''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,808 bytes
:* Description: Most likely for the swap shop menu.

: '''Overlay #22''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 19,264 bytes
:* Description: Most likely for the Keckleon shop menu.

: '''Overlay #23''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 14,208 bytes
:* Description: Most likely for the Kangashkan storage menu.

: '''Overlay #24''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 9,440 bytes
:* Description: Unknown this far.

: '''Overlay #25''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 5,312 bytes
:* Description: Unknown this far.

: '''Overlay #26''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,648 bytes
:* Description: Unknown this far.

: '''Overlay #27''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,616 bytes
:* Description: Most likely another menu for item handling storage..

: '''Overlay #28''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,168 bytes
:* Description: Unknown this far.

: '''Overlay #29''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 488,992 bytes
:* Description: Possibly having to do with running the in-dungeon game. Spotted strings for the in-dungeon menu.

: '''Overlay #30''':
:* RAM Load address: 0x02382820
:* Length in RAM: 14,496 bytes
:* Description: Unknown this far.

: '''Overlay #31''':
:* RAM Load address: 0x02382820
:* Length in RAM: 31,360 bytes
:* Description: Possibly the tactics menu.

: '''Overlay #32''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #33''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #34''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 3,680 bytes
:* Description: Possibly having to do with launching the game. There are mention in the strings of the ERSB logo and the "n_logo" logo.

: '''Overlay #35''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

== Explorers of Time/Darkness ==
Data Specific to Explorers of Time/Darkness. Those two games have some significant differences with Explorers of Sky in the way data is stored.

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

== File Structure ==
A detailed list of the file structure of the ROM's nitro-fs filesystem. The three games share a pretty similar file structure. The differences between the three file structures will be indicated as such.

*Note: A lot of files in the ROM have an identifier that correspond to which level/event/cutscene/etc, they're used in. Something like: "s17p01" for example.

First/Second level directories:
: '''/BACK/'''
:: Contains large compressed [[pmd2_BGP|BGP]] images. Some of those appear on the main menu, some later during the game.
:: In Explorers of Sky, the backgrounds from Explorers of Time and Darkness are present but unused.
: '''/BALANCE/'''
:: Contain data about entities/Pokemon, moves, items, and dungeons data.
: '''/DUNGEON/'''
:: Contains what seems to be some dungeon tiles.
: '''/DWC/'''
:: Data for the standard NDS Wifi setup screen.
: '''/EFFECT/'''
:: Contains some of the effect sprites.
: '''/FONT/'''
:: Contains fonts, UI element resources, palettes, and the portraits for the talking pokemon during the game.
: '''/GROUND/'''
:: Contains various sprites, map props, cutscene elements, some effects, and more.
: '''/MAP_BG/'''
:: Contains what seems to be map tiles.
: '''/MESSAGE/'''
:: Contains the text strings for most of the game!
: '''/MONSTER/'''
:: Contains the pokemon sprites for battle and the "overworld".
: '''/RESCUE/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly linked to SOS code generation, and the interactive online rescues.
: '''/SCRIPT/'''
:: Contains the scripts for the whole game. Each directories has an identifier related to the context it takes place in.
: '''/SOUND/BGM/'''
:: Contains the main instrument sounds bank, "bgm.swd", and all the music in the game. With each tracks being a pair of a [[dse_smdl|SMD]] and [[dse_swdl|SWD]] file. Those files are used by the game's [[Digital_Sound_Elements|DSE sound driver]].
: '''/SOUND/ME/'''
:: Contains the jingles that plays when obtaining items and etc..
: '''/SOUND/SE/'''
:: Possibly sound effects.
: '''/SOUND/SWD/'''
:: A bunch of sound effects stored as [[dse_swdl|SWD]]s
: '''/SOUND/SYSTEM/'''
:: Possibly menu related sound effects.
: '''/SYNTH/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly data for the swap cauldron.
: '''/SYSTEM/'''
:: Contains the demo roms for DS Download play, along with the icons and other resources related to that.
: '''/TABLEDAT/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly recycle shop data.
: '''/TOP/'''
:: Contains [[pmd2_BGP|BGP]] files for the backgrounds used in Pokémon Mystery Dungeon: Blue Rescue Team.
:: It can be deleted with no immediately apparent side effects, as the backgrounds are unused.

== File/Data Formats ==
A list of all the file/data formats used in the game.

;Graphics Formats:
: [[pmd2_BGP|BGP]]
: [[pmd2_WAN|WAN/WAT]]
: [[pmd2_WBA|WBA]]
: [[pmd2_W16|W16]]
: [[pmd2_WTE_and_WTU|WTE and WTU]]
: [[pmd2_CHR|CHR]]
: [[pmd2_PAL|PAL]]
: [[pmd2_BMA|BMA]]
: [[pmd2_BPC|BPC]]
: [[pmd2_BPL|BPL]]
: [[pmd2_BPA|BPA]]
: [[pmd2_smd_img|SMD(image)]]
: [[pmd2_sma|SMA]]
;Audio Formats (The files the [[Digital_Sound_Elements|DSE sound driver]] uses):
: [[dse_swdl|SWD]]
: [[dse_smdl|SMD(Music Sequence)]]
: [[dse_sedl|SED]]
;Data Formats:
: [[pmd2_BIN|BIN]]
: [[pmd2_DAT|DAT]]
: [[pmd2_monster.md|MD]]
: [[pmd2_tbl_talk.tlk|TLK]]
: [[pmd2_text_strings|STR]]
;Script Engine Formats
: [[pmd2_SSB|SSB]]
: [[pmd2_SSA|SSA]]
: [[pmd2_SSA|SSS]]
: [[pmd2_SSA|SSE]]
: [[pmd2_LSD|LSD]]
;Container Formats:
: [[pmd2_BIN_pack|BIN]](pack files)
: [[pmd2_kaomado.kao|KAO]]
: [[pmd2_SIR0|SIR0]]
;Compressed Container Formats:
: [[pmd2_AT4PX|AT4PX]]
: [[pmd2_AT4PN|AT4PN]]
: [[pmd2_PKDPX|PKDPX]]
;Font Data:
: [[pmd2_fontdata|DAT (from in the /FONT/ directory)]]
: [[pmd2_DIC|DIC]]
;Misc:
: [[pmd2_SRL|SRL]]

Additionally, several files have a file extension that doesn't match their content. For example, "/SYSTEM/hsd_jap.dat" and "/SYSTEM/hsd_eng.dat" are AT4PX files, but their extension is ".dat".

== Files with Unique Formats ==
A list of files that have their own unique format.

* /BALANCE/[[pmd2_monster.md|monster.md]]
* /BALANCE/[[pmd2_monster.mnd|monster.mnd]] <div style="color: blue; display:inline;">''(Explorers of Time/Darkness only)''</div>
* /BALANCE/[[pmd2_item_p.bin|item_p.bin]]
* /BALANCE/[[pmd2_item_s_p.bin|item_s_p.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_m_level.bin|m_level.bin]]
* /BALANCE/[[pmd2_waza_p.bin|waza_p.bin/waza_p2.bin]]
* /BALANCE/[[pmd2_mappa.bin|mappa_s.bin/mappa_t.bin/mappa_y.bin]]
* /BALANCE/[[pmd2_mappa_g.bin|mappa_gs.bin/mappa_gt.bin/mappa_gy.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_gwdparam.bin|gwdparam.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_fixed.bin|fixed.bin]]
* /BALANCE/[[pmd2_st_i2n_j.bin|st_i2n_j.bin]]
* /BALANCE/[[pmd2_st_m2n_j.bin|st_m2n_j.bin]]
* /BALANCE/[[pmd2_st_n2m_j.bin|st_n2m_j.bin]]
* /DUNGEON/[[pmd2_dungeon.bin|dungeon.bin]]
* /FONT/[[pmd2_kaomado.kao|kaomado.kao]]
* /MAP_BG/[[pmd2_bg_list.dat|bg_list.dat]]
* /MESSAGE/[[pmd2_tbl_talk.tlk|tbl_talk.tlk]]
* /MESSAGE/[[pmd2_text_strings|text_*.str]]
* /RESCUE/[[pmd2_rescue.bin|rescue.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /SYNTH/[[pmd2_synth.bin|synth.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /TABLEDAT/[[pmd2_tabledat|item00.dat to item15.dat]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>

== Internal Details ==
Articles on the various inner working of specific aspects of the game.

* [[Digital_Sound_Elements|DSE sound driver]]: Explanation of the sound driver used in all 3 PMD2 games.
* [[pmd2_Level_System|Level System]]: Explanation on how the game picks a level to load and all the various sub-systems involved.

== External Resources ==
* Wonder Mail S Tools, research notes. The "items_p_Sky.xlsx" excel sheet contains a comprehensive list of item names/types, pokemon names/types, moves names, etc, along with their associated index values in-game : [http://apointlessplace.net/wms/]
* Pokemon Explorers of Sky research thread on GameFaqs: [http://www.gamefaqs.com/boards/955859-pokemon-mystery-dungeon-explorers-of-sky/51698562] (lots of great info spread around all those pages)

Pmd2 Level System

2016-12-13T00:40:37Z

Psy commando: initial commit of the page on the level system

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Level System in the PMD Explorers Games}}

== Overview ==
This article will try to describe how levels work in the pmd2 games.

== Engine Modes ==
There are essentially 2 modes that the game can run levels as. In-dungeon, referred to as simply "Dungeon", and out-of-dungeon, referred to as "Ground".
Ground mode is the default mode. Dungeon mode is triggered from scripts run by the Ground engine.

* '''Dungeon:''' The dungeon mode is run as soon as a script from the "ground" engine calls the command to run a dungeon. And once a dungeon concludes, execution returns to the line after the command to run the dungeon, and the game falls back into "ground" mode. Scripts aren't executed at all during dungeon mode, since the overlay running scripts is unloaded and replaced with the dungeon engine overlay.

* '''Ground:''' The game runs in this mode as soon as the chunsoft logo pops up on screen. Game scripts are executed only in this mode.

== The Level Table ==
Table associating a level ID to level related data. Every "Ground" levels in the game have an entry in this table.

=== Location in the Binaries ===
The table is always inside the arm9 binary, and never in an overlay.

{| class="wikitable"
! Game
! Game Code
! Table Offset
! Nb Entries
|-
| '''North American Explorers of Sky'''
| C2SE
| 0xA5488
| 431
|-
| '''European Explorers of Sky'''
| C2SP
| 0xA5BE0
| 459
|-
| '''Japanese Explorers of Sky'''
| C2SJ
| 0xA689C
| 436
|}

=== Format ===
Each entry is 12 bytes and is laid out this way.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| int16
| mapty
| Type of the map. A value from 0 to 11 defining how a map is loaded and displayed.
|-
| 0x02
| 2
| int16
| unk2
| Unknown value. (0 to 306)
|-
| 0x04
| 2
| int16
| mapid
| ID number of the map. Most likely used in the [[pmd2_bg_list.dat|bg_list.dat]] file to look up the level's resources files.
|-
| 0x06
| 2
| int16
| unk4
| Unknown value. (-1 to 7)
|-
| 0x08
| 4
| uint32
| ptrstring
| Pointer to a null terminated string, containing the internal name of the level. Is used as directory name for the script to run, and for debugging.
|}

== Level Constants and Map Types ==
Depending on the map type, and on the command used to load a level, a different set of constant will be used by the game.

<span style="color: red; text-decoration: bold;">TODO</span>

== Credits ==

Pokémon Mystery Dungeon Explorers

2016-12-13T00:18:14Z

Psy commando: /* Files with Unique Formats */ Added bg_list.dat file to the unique file list!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness}}

== General Information ==
This page contains data on the Pokémon Mystery Dungeon: Explorers of Sky/Time/Darkness games.

== Explorers of Sky ==
Data Specific to Explorers of Sky

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

: '''Overlay #00''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 395,680 bytes
:* Description: Possibly contains data and code related to wifi multiplayer, in addition to the root menu. It mentions several files from the BACK folder that are known backgrounds for the root menu.

: '''Overlay #01''':
:* RAM Load address: 0x02329520
:* Length in RAM: 77,088 bytes
:* Description: Seems related to wifi rescue. It mentions several files from the GROUND and BACK folders:
:** 0x11ab8 : "BACK/expback.bgp"
:** 0x11b00 : "BACK/s07p02a.bgp"
:** 0x11b38 : "BACK/expback.bgp"
:** 0x11b70 : "BACK/expback.bgp"
:** 0x11b84 : "GROUND/s18p01a4.wan"
:** 0x11b98 : "GROUND/s18p01a2.wan"
:** 0x11bac : "GROUND/s18p01a3.wan"
:** 0x11be4 : "GROUND/s18p01a1.wan"
:** 0x11bf8 : "BACK/s18p01a.bgp"

: '''Overlay #02''':
:* RAM Load address: 0x02329520
:* Length in RAM: 176,032 bytes
:* Description: Most likely code for the Nintendo wifi setup.

: '''Overlay #03''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 41,312 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0xA078.

: '''Overlay #04''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,232 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0x2BA4.

: '''Overlay #05''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 12,864 bytes
:* Description: Unknown so far. Contain a single line of dialog formated text "[CS:X][string:0][CR][CLUM_SET:88][rank:0]" at 0x31EC

: '''Overlay #06''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 9,312 bytes
:* Description: Probably linked to WiFi rescue. Found those strings:
:** 0x2354 : "Mysterious WiFi: Illegal Identifier"
:** 0x237C : "Mysterious WiFi: Difference Version"
:** 0x23A4 : "Mysterious WiFi: Difference Language"
:** 0x23CC : "Mysterious WiFi: Difference Check Sum: 0x%08x 0x%08x"
:** 0x2404 : "Mysterious WiFi: Illegal Data"

: '''Overlay #07''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 20,736 bytes
:* Description: Unknown so far.

: '''Overlay #08''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 8,704 bytes
:* Description: Seems related to WiFi communications, from the string search results.

: '''Overlay #09''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,648 bytes
:* Description: Unknown this far. Has a single mention of "BACK/s18p02a.bgp" at 0x2D00

: '''Overlay #10''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 128,928 bytes
:* Description: Unknown this far. Some interesting strings:
:** 0x1F58C : "Lv. %d"
:** 0x1F594 : "[value:0:3]/[value:1:3]"
:** 0x1F5AC : "Lv. %d [CLUM_SET:44][value:0:3]/[value:1:3]"
:** 0x1F5D8 : "%s[CLUM_SET:70]%s"
:** 0x1F5EC : "/DUNGEON/sub2.bgp"
:** 0x1F600 : "/DUNGEON/sub.bgp"
:** 0x1F614 : "MainGame enter dungeon mode %d %d"
:** 0x1F638 : "dungeon fade out mode %d"
:** 0x1F654 : "dungeon getout result %d"
:** 0x1F694 : "rom0:BALANCE/mappa_gs.bin"
:** 0x1F6B0 : "dungeon map index %3d floor %3d -> dg index %3d floor max %3d -> bg index %3d table index %3d"
:** 0x1F710 : "rom0:BALANCE/fixed.bin"

: '''Overlay #11''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 298,048 bytes
:* Description: Most likely the script engine for the game !

: '''Overlay #12''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #13''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,904 bytes
:* Description: Controls the personality test, including the available partners and playable Pokémon. Personality test questions are stored in the MESSAGE folder.

: '''Overlay #14''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 15,072 bytes
:* Description: Probably what runs the gatekeeper mini-game(String search returned mention of footprints).

: '''Overlay #15''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 4,192 bytes
:* Description: Possibly has to do with Duskull's bank. Got this "Menu_Bank_Mode_Cancel" at 0xFB4.

: '''Overlay #16''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,552 bytes
:* Description: Possibly linked to the Chimecho's assembly menu. Got this string "menuMonsterPictureBook_IsBusy busy" at 0x2CC4.

: '''Overlay #17''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 7,392 bytes
:* Description: Unknown this far.

: '''Overlay #18''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 13,568 bytes
:* Description: Unknown this far.

: '''Overlay #19''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 16,960 bytes
:* Description: Possibly linked to Spinda's cafe.

: '''Overlay #20''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 12,288 bytes
:* Description: Unknown this far.

: '''Overlay #21''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,808 bytes
:* Description: Most likely for the swap shop menu.

: '''Overlay #22''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 19,264 bytes
:* Description: Most likely for the Keckleon shop menu.

: '''Overlay #23''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 14,208 bytes
:* Description: Most likely for the Kangashkan storage menu.

: '''Overlay #24''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 9,440 bytes
:* Description: Unknown this far.

: '''Overlay #25''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 5,312 bytes
:* Description: Unknown this far.

: '''Overlay #26''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,648 bytes
:* Description: Unknown this far.

: '''Overlay #27''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,616 bytes
:* Description: Most likely another menu for item handling storage..

: '''Overlay #28''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,168 bytes
:* Description: Unknown this far.

: '''Overlay #29''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 488,992 bytes
:* Description: Possibly having to do with running the in-dungeon game. Spotted strings for the in-dungeon menu.

: '''Overlay #30''':
:* RAM Load address: 0x02382820
:* Length in RAM: 14,496 bytes
:* Description: Unknown this far.

: '''Overlay #31''':
:* RAM Load address: 0x02382820
:* Length in RAM: 31,360 bytes
:* Description: Possibly the tactics menu.

: '''Overlay #32''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #33''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #34''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 3,680 bytes
:* Description: Possibly having to do with launching the game. There are mention in the strings of the ERSB logo and the "n_logo" logo.

: '''Overlay #35''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

== Explorers of Time/Darkness ==
Data Specific to Explorers of Time/Darkness. Those two games have some significant differences with Explorers of Sky in the way data is stored.

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

== File Structure ==
A detailed list of the file structure of the ROM's nitro-fs filesystem. The three games share a pretty similar file structure. The differences between the three file structures will be indicated as such.

*Note: A lot of files in the ROM have an identifier that correspond to which level/event/cutscene/etc, they're used in. Something like: "s17p01" for example.

First/Second level directories:
: '''/BACK/'''
:: Contains large compressed [[pmd2_BGP|BGP]] images. Some of those appear on the main menu, some later during the game.
:: In Explorers of Sky, the backgrounds from Explorers of Time and Darkness are present but unused.
: '''/BALANCE/'''
:: Contain data about entities/Pokemon, moves, items, and dungeons data.
: '''/DUNGEON/'''
:: Contains what seems to be some dungeon tiles.
: '''/DWC/'''
:: Data for the standard NDS Wifi setup screen.
: '''/EFFECT/'''
:: Contains some of the effect sprites.
: '''/FONT/'''
:: Contains fonts, UI element resources, palettes, and the portraits for the talking pokemon during the game.
: '''/GROUND/'''
:: Contains various sprites, map props, cutscene elements, some effects, and more.
: '''/MAP_BG/'''
:: Contains what seems to be map tiles.
: '''/MESSAGE/'''
:: Contains the text strings for most of the game!
: '''/MONSTER/'''
:: Contains the pokemon sprites for battle and the "overworld".
: '''/RESCUE/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly linked to SOS code generation, and the interactive online rescues.
: '''/SCRIPT/'''
:: Contains the scripts for the whole game. Each directories has an identifier related to the context it takes place in.
: '''/SOUND/BGM/'''
:: Contains the main instrument sounds bank, "bgm.swd", and all the music in the game. With each tracks being a pair of a [[dse_smdl|SMD]] and [[dse_swdl|SWD]] file. Those files are used by the game's [[Digital_Sound_Elements|DSE sound driver]].
: '''/SOUND/ME/'''
:: Contains the jingles that plays when obtaining items and etc..
: '''/SOUND/SE/'''
:: Possibly sound effects.
: '''/SOUND/SWD/'''
:: A bunch of sound effects stored as [[dse_swdl|SWD]]s
: '''/SOUND/SYSTEM/'''
:: Possibly menu related sound effects.
: '''/SYNTH/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly data for the swap cauldron.
: '''/SYSTEM/'''
:: Contains the demo roms for DS Download play, along with the icons and other resources related to that.
: '''/TABLEDAT/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly recycle shop data.
: '''/TOP/'''
:: Contains [[pmd2_BGP|BGP]] files for the backgrounds used in Pokémon Mystery Dungeon: Blue Rescue Team.
:: It can be deleted with no immediately apparent side effects, as the backgrounds are unused.

== File/Data Formats ==
A list of all the file/data formats used in the game.

;Graphics Formats:
: [[pmd2_BGP|BGP]]
: [[pmd2_WAN|WAN/WAT]]
: [[pmd2_WBA|WBA]]
: [[pmd2_W16|W16]]
: [[pmd2_WTE_and_WTU|WTE and WTU]]
: [[pmd2_CHR|CHR]]
: [[pmd2_PAL|PAL]]
: [[pmd2_BMA|BMA]]
: [[pmd2_BPC|BPC]]
: [[pmd2_BPL|BPL]]
: [[pmd2_BPA|BPA]]
: [[pmd2_smd_img|SMD(image)]]
: [[pmd2_sma|SMA]]
;Audio Formats (The files the [[Digital_Sound_Elements|DSE sound driver]] uses):
: [[dse_swdl|SWD]]
: [[dse_smdl|SMD(Music Sequence)]]
: [[dse_sedl|SED]]
;Data Formats:
: [[pmd2_BIN|BIN]]
: [[pmd2_DAT|DAT]]
: [[pmd2_monster.md|MD]]
: [[pmd2_tbl_talk.tlk|TLK]]
: [[pmd2_text_strings|STR]]
;Script Engine Formats
: [[pmd2_SSB|SSB]]
: [[pmd2_SSA|SSA]]
: [[pmd2_SSA|SSS]]
: [[pmd2_SSA|SSE]]
: [[pmd2_LSD|LSD]]
;Container Formats:
: [[pmd2_BIN_pack|BIN]](pack files)
: [[pmd2_kaomado.kao|KAO]]
: [[pmd2_SIR0|SIR0]]
;Compressed Container Formats:
: [[pmd2_AT4PX|AT4PX]]
: [[pmd2_AT4PN|AT4PN]]
: [[pmd2_PKDPX|PKDPX]]
;Font Data:
: [[pmd2_fontdata|DAT (from in the /FONT/ directory)]]
: [[pmd2_DIC|DIC]]
;Misc:
: [[pmd2_SRL|SRL]]

Additionally, several files have a file extension that doesn't match their content. For example, "/SYSTEM/hsd_jap.dat" and "/SYSTEM/hsd_eng.dat" are AT4PX files, but their extension is ".dat".

== Files with Unique Formats ==
A list of files that have their own unique format.

* /BALANCE/[[pmd2_monster.md|monster.md]]
* /BALANCE/[[pmd2_monster.mnd|monster.mnd]] <div style="color: blue; display:inline;">''(Explorers of Time/Darkness only)''</div>
* /BALANCE/[[pmd2_item_p.bin|item_p.bin]]
* /BALANCE/[[pmd2_item_s_p.bin|item_s_p.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_m_level.bin|m_level.bin]]
* /BALANCE/[[pmd2_waza_p.bin|waza_p.bin/waza_p2.bin]]
* /BALANCE/[[pmd2_mappa.bin|mappa_s.bin/mappa_t.bin/mappa_y.bin]]
* /BALANCE/[[pmd2_mappa_g.bin|mappa_gs.bin/mappa_gt.bin/mappa_gy.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_gwdparam.bin|gwdparam.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_fixed.bin|fixed.bin]]
* /BALANCE/[[pmd2_st_i2n_j.bin|st_i2n_j.bin]]
* /BALANCE/[[pmd2_st_m2n_j.bin|st_m2n_j.bin]]
* /BALANCE/[[pmd2_st_n2m_j.bin|st_n2m_j.bin]]
* /DUNGEON/[[pmd2_dungeon.bin|dungeon.bin]]
* /FONT/[[pmd2_kaomado.kao|kaomado.kao]]
* /MAP_BG/[[pmd2_bg_list.dat|bg_list.dat]]
* /MESSAGE/[[pmd2_tbl_talk.tlk|tbl_talk.tlk]]
* /MESSAGE/[[pmd2_text_strings|text_*.str]]
* /RESCUE/[[pmd2_rescue.bin|rescue.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /SYNTH/[[pmd2_synth.bin|synth.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /TABLEDAT/[[pmd2_tabledat|item00.dat to item15.dat]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>

== Internal Details ==
Articles on the various inner working of specific aspects of the game.

* [[Digital_Sound_Elements|DSE sound driver]]: Explanation of the sound driver used in all 3 PMD2 games.
* [[pmd2_Level_System|Level System]]: Explanation on how the game picks a level to load and all the various sub-systems involved.

== External Resources ==
* Wonder Mail S Tools, research notes. The "items_p_Sky.xlsx" excel sheet contains a comprehensive list of item names/types, pokemon names/types, moves names, etc, along with their associated index values in-game : [http://apointlessplace.net/wms/]
* Pokemon Explorers of Sky research thread on GameFaqs: [http://www.gamefaqs.com/boards/955859-pokemon-mystery-dungeon-explorers-of-sky/51698562] (lots of great info spread around all those pages)

Pokémon Mystery Dungeon Explorers

2016-12-12T23:47:08Z

Psy commando: Added a new section for articles describing specific system/processes/etc in the pmd2 games

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness}}

== General Information ==
This page contains data on the Pokémon Mystery Dungeon: Explorers of Sky/Time/Darkness games.

== Explorers of Sky ==
Data Specific to Explorers of Sky

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

: '''Overlay #00''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 395,680 bytes
:* Description: Possibly contains data and code related to wifi multiplayer, in addition to the root menu. It mentions several files from the BACK folder that are known backgrounds for the root menu.

: '''Overlay #01''':
:* RAM Load address: 0x02329520
:* Length in RAM: 77,088 bytes
:* Description: Seems related to wifi rescue. It mentions several files from the GROUND and BACK folders:
:** 0x11ab8 : "BACK/expback.bgp"
:** 0x11b00 : "BACK/s07p02a.bgp"
:** 0x11b38 : "BACK/expback.bgp"
:** 0x11b70 : "BACK/expback.bgp"
:** 0x11b84 : "GROUND/s18p01a4.wan"
:** 0x11b98 : "GROUND/s18p01a2.wan"
:** 0x11bac : "GROUND/s18p01a3.wan"
:** 0x11be4 : "GROUND/s18p01a1.wan"
:** 0x11bf8 : "BACK/s18p01a.bgp"

: '''Overlay #02''':
:* RAM Load address: 0x02329520
:* Length in RAM: 176,032 bytes
:* Description: Most likely code for the Nintendo wifi setup.

: '''Overlay #03''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 41,312 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0xA078.

: '''Overlay #04''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,232 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0x2BA4.

: '''Overlay #05''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 12,864 bytes
:* Description: Unknown so far. Contain a single line of dialog formated text "[CS:X][string:0][CR][CLUM_SET:88][rank:0]" at 0x31EC

: '''Overlay #06''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 9,312 bytes
:* Description: Probably linked to WiFi rescue. Found those strings:
:** 0x2354 : "Mysterious WiFi: Illegal Identifier"
:** 0x237C : "Mysterious WiFi: Difference Version"
:** 0x23A4 : "Mysterious WiFi: Difference Language"
:** 0x23CC : "Mysterious WiFi: Difference Check Sum: 0x%08x 0x%08x"
:** 0x2404 : "Mysterious WiFi: Illegal Data"

: '''Overlay #07''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 20,736 bytes
:* Description: Unknown so far.

: '''Overlay #08''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 8,704 bytes
:* Description: Seems related to WiFi communications, from the string search results.

: '''Overlay #09''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,648 bytes
:* Description: Unknown this far. Has a single mention of "BACK/s18p02a.bgp" at 0x2D00

: '''Overlay #10''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 128,928 bytes
:* Description: Unknown this far. Some interesting strings:
:** 0x1F58C : "Lv. %d"
:** 0x1F594 : "[value:0:3]/[value:1:3]"
:** 0x1F5AC : "Lv. %d [CLUM_SET:44][value:0:3]/[value:1:3]"
:** 0x1F5D8 : "%s[CLUM_SET:70]%s"
:** 0x1F5EC : "/DUNGEON/sub2.bgp"
:** 0x1F600 : "/DUNGEON/sub.bgp"
:** 0x1F614 : "MainGame enter dungeon mode %d %d"
:** 0x1F638 : "dungeon fade out mode %d"
:** 0x1F654 : "dungeon getout result %d"
:** 0x1F694 : "rom0:BALANCE/mappa_gs.bin"
:** 0x1F6B0 : "dungeon map index %3d floor %3d -> dg index %3d floor max %3d -> bg index %3d table index %3d"
:** 0x1F710 : "rom0:BALANCE/fixed.bin"

: '''Overlay #11''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 298,048 bytes
:* Description: Most likely the script engine for the game !

: '''Overlay #12''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #13''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,904 bytes
:* Description: Controls the personality test, including the available partners and playable Pokémon. Personality test questions are stored in the MESSAGE folder.

: '''Overlay #14''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 15,072 bytes
:* Description: Probably what runs the gatekeeper mini-game(String search returned mention of footprints).

: '''Overlay #15''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 4,192 bytes
:* Description: Possibly has to do with Duskull's bank. Got this "Menu_Bank_Mode_Cancel" at 0xFB4.

: '''Overlay #16''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,552 bytes
:* Description: Possibly linked to the Chimecho's assembly menu. Got this string "menuMonsterPictureBook_IsBusy busy" at 0x2CC4.

: '''Overlay #17''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 7,392 bytes
:* Description: Unknown this far.

: '''Overlay #18''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 13,568 bytes
:* Description: Unknown this far.

: '''Overlay #19''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 16,960 bytes
:* Description: Possibly linked to Spinda's cafe.

: '''Overlay #20''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 12,288 bytes
:* Description: Unknown this far.

: '''Overlay #21''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,808 bytes
:* Description: Most likely for the swap shop menu.

: '''Overlay #22''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 19,264 bytes
:* Description: Most likely for the Keckleon shop menu.

: '''Overlay #23''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 14,208 bytes
:* Description: Most likely for the Kangashkan storage menu.

: '''Overlay #24''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 9,440 bytes
:* Description: Unknown this far.

: '''Overlay #25''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 5,312 bytes
:* Description: Unknown this far.

: '''Overlay #26''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,648 bytes
:* Description: Unknown this far.

: '''Overlay #27''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,616 bytes
:* Description: Most likely another menu for item handling storage..

: '''Overlay #28''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,168 bytes
:* Description: Unknown this far.

: '''Overlay #29''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 488,992 bytes
:* Description: Possibly having to do with running the in-dungeon game. Spotted strings for the in-dungeon menu.

: '''Overlay #30''':
:* RAM Load address: 0x02382820
:* Length in RAM: 14,496 bytes
:* Description: Unknown this far.

: '''Overlay #31''':
:* RAM Load address: 0x02382820
:* Length in RAM: 31,360 bytes
:* Description: Possibly the tactics menu.

: '''Overlay #32''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #33''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #34''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 3,680 bytes
:* Description: Possibly having to do with launching the game. There are mention in the strings of the ERSB logo and the "n_logo" logo.

: '''Overlay #35''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

== Explorers of Time/Darkness ==
Data Specific to Explorers of Time/Darkness. Those two games have some significant differences with Explorers of Sky in the way data is stored.

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

== File Structure ==
A detailed list of the file structure of the ROM's nitro-fs filesystem. The three games share a pretty similar file structure. The differences between the three file structures will be indicated as such.

*Note: A lot of files in the ROM have an identifier that correspond to which level/event/cutscene/etc, they're used in. Something like: "s17p01" for example.

First/Second level directories:
: '''/BACK/'''
:: Contains large compressed [[pmd2_BGP|BGP]] images. Some of those appear on the main menu, some later during the game.
:: In Explorers of Sky, the backgrounds from Explorers of Time and Darkness are present but unused.
: '''/BALANCE/'''
:: Contain data about entities/Pokemon, moves, items, and dungeons data.
: '''/DUNGEON/'''
:: Contains what seems to be some dungeon tiles.
: '''/DWC/'''
:: Data for the standard NDS Wifi setup screen.
: '''/EFFECT/'''
:: Contains some of the effect sprites.
: '''/FONT/'''
:: Contains fonts, UI element resources, palettes, and the portraits for the talking pokemon during the game.
: '''/GROUND/'''
:: Contains various sprites, map props, cutscene elements, some effects, and more.
: '''/MAP_BG/'''
:: Contains what seems to be map tiles.
: '''/MESSAGE/'''
:: Contains the text strings for most of the game!
: '''/MONSTER/'''
:: Contains the pokemon sprites for battle and the "overworld".
: '''/RESCUE/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly linked to SOS code generation, and the interactive online rescues.
: '''/SCRIPT/'''
:: Contains the scripts for the whole game. Each directories has an identifier related to the context it takes place in.
: '''/SOUND/BGM/'''
:: Contains the main instrument sounds bank, "bgm.swd", and all the music in the game. With each tracks being a pair of a [[dse_smdl|SMD]] and [[dse_swdl|SWD]] file. Those files are used by the game's [[Digital_Sound_Elements|DSE sound driver]].
: '''/SOUND/ME/'''
:: Contains the jingles that plays when obtaining items and etc..
: '''/SOUND/SE/'''
:: Possibly sound effects.
: '''/SOUND/SWD/'''
:: A bunch of sound effects stored as [[dse_swdl|SWD]]s
: '''/SOUND/SYSTEM/'''
:: Possibly menu related sound effects.
: '''/SYNTH/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly data for the swap cauldron.
: '''/SYSTEM/'''
:: Contains the demo roms for DS Download play, along with the icons and other resources related to that.
: '''/TABLEDAT/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly recycle shop data.
: '''/TOP/'''
:: Contains [[pmd2_BGP|BGP]] files for the backgrounds used in Pokémon Mystery Dungeon: Blue Rescue Team.
:: It can be deleted with no immediately apparent side effects, as the backgrounds are unused.

== File/Data Formats ==
A list of all the file/data formats used in the game.

;Graphics Formats:
: [[pmd2_BGP|BGP]]
: [[pmd2_WAN|WAN/WAT]]
: [[pmd2_WBA|WBA]]
: [[pmd2_W16|W16]]
: [[pmd2_WTE_and_WTU|WTE and WTU]]
: [[pmd2_CHR|CHR]]
: [[pmd2_PAL|PAL]]
: [[pmd2_BMA|BMA]]
: [[pmd2_BPC|BPC]]
: [[pmd2_BPL|BPL]]
: [[pmd2_BPA|BPA]]
: [[pmd2_smd_img|SMD(image)]]
: [[pmd2_sma|SMA]]
;Audio Formats (The files the [[Digital_Sound_Elements|DSE sound driver]] uses):
: [[dse_swdl|SWD]]
: [[dse_smdl|SMD(Music Sequence)]]
: [[dse_sedl|SED]]
;Data Formats:
: [[pmd2_BIN|BIN]]
: [[pmd2_DAT|DAT]]
: [[pmd2_monster.md|MD]]
: [[pmd2_tbl_talk.tlk|TLK]]
: [[pmd2_text_strings|STR]]
;Script Engine Formats
: [[pmd2_SSB|SSB]]
: [[pmd2_SSA|SSA]]
: [[pmd2_SSA|SSS]]
: [[pmd2_SSA|SSE]]
: [[pmd2_LSD|LSD]]
;Container Formats:
: [[pmd2_BIN_pack|BIN]](pack files)
: [[pmd2_kaomado.kao|KAO]]
: [[pmd2_SIR0|SIR0]]
;Compressed Container Formats:
: [[pmd2_AT4PX|AT4PX]]
: [[pmd2_AT4PN|AT4PN]]
: [[pmd2_PKDPX|PKDPX]]
;Font Data:
: [[pmd2_fontdata|DAT (from in the /FONT/ directory)]]
: [[pmd2_DIC|DIC]]
;Misc:
: [[pmd2_SRL|SRL]]

Additionally, several files have a file extension that doesn't match their content. For example, "/SYSTEM/hsd_jap.dat" and "/SYSTEM/hsd_eng.dat" are AT4PX files, but their extension is ".dat".

== Files with Unique Formats ==
A list of files that have their own unique format.

* /BALANCE/[[pmd2_monster.md|monster.md]]
* /BALANCE/[[pmd2_monster.mnd|monster.mnd]] <div style="color: blue; display:inline;">''(Explorers of Time/Darkness only)''</div>
* /BALANCE/[[pmd2_item_p.bin|item_p.bin]]
* /BALANCE/[[pmd2_item_s_p.bin|item_s_p.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_m_level.bin|m_level.bin]]
* /BALANCE/[[pmd2_waza_p.bin|waza_p.bin/waza_p2.bin]]
* /BALANCE/[[pmd2_mappa.bin|mappa_s.bin/mappa_t.bin/mappa_y.bin]]
* /BALANCE/[[pmd2_mappa_g.bin|mappa_gs.bin/mappa_gt.bin/mappa_gy.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_gwdparam.bin|gwdparam.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_fixed.bin|fixed.bin]]
* /BALANCE/[[pmd2_st_i2n_j.bin|st_i2n_j.bin]]
* /BALANCE/[[pmd2_st_m2n_j.bin|st_m2n_j.bin]]
* /BALANCE/[[pmd2_st_n2m_j.bin|st_n2m_j.bin]]
* /DUNGEON/[[pmd2_dungeon.bin|dungeon.bin]]
* /FONT/[[pmd2_kaomado.kao|kaomado.kao]]
* /MESSAGE/[[pmd2_tbl_talk.tlk|tbl_talk.tlk]]
* /MESSAGE/[[pmd2_text_strings|text_*.str]]
* /RESCUE/[[pmd2_rescue.bin|rescue.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /SYNTH/[[pmd2_synth.bin|synth.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /TABLEDAT/[[pmd2_tabledat|item00.dat to item15.dat]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>

== Internal Details ==
Articles on the various inner working of specific aspects of the game.

* [[Digital_Sound_Elements|DSE sound driver]]: Explanation of the sound driver used in all 3 PMD2 games.
* [[pmd2_Level_System|Level System]]: Explanation on how the game picks a level to load and all the various sub-systems involved.

== External Resources ==
* Wonder Mail S Tools, research notes. The "items_p_Sky.xlsx" excel sheet contains a comprehensive list of item names/types, pokemon names/types, moves names, etc, along with their associated index values in-game : [http://apointlessplace.net/wms/]
* Pokemon Explorers of Sky research thread on GameFaqs: [http://www.gamefaqs.com/boards/955859-pokemon-mystery-dungeon-explorers-of-sky/51698562] (lots of great info spread around all those pages)

Pokémon Mystery Dungeon Explorers

2016-05-18T20:26:45Z

Psy commando: /* File Structure */ fixed some of the links to dse pages

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness}}

== General Information ==
This page contains data on the Pokémon Mystery Dungeon: Explorers of Sky/Time/Darkness games.

== Explorers of Sky ==
Data Specific to Explorers of Sky

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

: '''Overlay #00''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 395,680 bytes
:* Description: Possibly contains data and code related to wifi multiplayer, in addition to the root menu. It mentions several files from the BACK folder that are known backgrounds for the root menu.

: '''Overlay #01''':
:* RAM Load address: 0x02329520
:* Length in RAM: 77,088 bytes
:* Description: Seems related to wifi rescue. It mentions several files from the GROUND and BACK folders:
:** 0x11ab8 : "BACK/expback.bgp"
:** 0x11b00 : "BACK/s07p02a.bgp"
:** 0x11b38 : "BACK/expback.bgp"
:** 0x11b70 : "BACK/expback.bgp"
:** 0x11b84 : "GROUND/s18p01a4.wan"
:** 0x11b98 : "GROUND/s18p01a2.wan"
:** 0x11bac : "GROUND/s18p01a3.wan"
:** 0x11be4 : "GROUND/s18p01a1.wan"
:** 0x11bf8 : "BACK/s18p01a.bgp"

: '''Overlay #02''':
:* RAM Load address: 0x02329520
:* Length in RAM: 176,032 bytes
:* Description: Most likely code for the Nintendo wifi setup.

: '''Overlay #03''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 41,312 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0xA078.

: '''Overlay #04''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,232 bytes
:* Description: Unknown so far. Contains a single mention of "TABLEDAT/item00.dat" at 0x2BA4.

: '''Overlay #05''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 12,864 bytes
:* Description: Unknown so far. Contain a single line of dialog formated text "[CS:X][string:0][CR][CLUM_SET:88][rank:0]" at 0x31EC

: '''Overlay #06''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 9,312 bytes
:* Description: Probably linked to WiFi rescue. Found those strings:
:** 0x2354 : "Mysterious WiFi: Illegal Identifier"
:** 0x237C : "Mysterious WiFi: Difference Version"
:** 0x23A4 : "Mysterious WiFi: Difference Language"
:** 0x23CC : "Mysterious WiFi: Difference Check Sum: 0x%08x 0x%08x"
:** 0x2404 : "Mysterious WiFi: Illegal Data"

: '''Overlay #07''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 20,736 bytes
:* Description: Unknown so far.

: '''Overlay #08''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 8,704 bytes
:* Description: Seems related to WiFi communications, from the string search results.

: '''Overlay #09''':
:* RAM Load address: 0x0233CA80
:* Length in RAM: 11,648 bytes
:* Description: Unknown this far. Has a single mention of "BACK/s18p02a.bgp" at 0x2D00

: '''Overlay #10''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 128,928 bytes
:* Description: Unknown this far. Some interesting strings:
:** 0x1F58C : "Lv. %d"
:** 0x1F594 : "[value:0:3]/[value:1:3]"
:** 0x1F5AC : "Lv. %d [CLUM_SET:44][value:0:3]/[value:1:3]"
:** 0x1F5D8 : "%s[CLUM_SET:70]%s"
:** 0x1F5EC : "/DUNGEON/sub2.bgp"
:** 0x1F600 : "/DUNGEON/sub.bgp"
:** 0x1F614 : "MainGame enter dungeon mode %d %d"
:** 0x1F638 : "dungeon fade out mode %d"
:** 0x1F654 : "dungeon getout result %d"
:** 0x1F694 : "rom0:BALANCE/mappa_gs.bin"
:** 0x1F6B0 : "dungeon map index %3d floor %3d -> dg index %3d floor max %3d -> bg index %3d table index %3d"
:** 0x1F710 : "rom0:BALANCE/fixed.bin"

: '''Overlay #11''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 298,048 bytes
:* Description: Most likely the script engine for the game !

: '''Overlay #12''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #13''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,904 bytes
:* Description: Controls the personality test, including the available partners and playable Pokémon. Personality test questions are stored in the MESSAGE folder.

: '''Overlay #14''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 15,072 bytes
:* Description: Probably what runs the gatekeeper mini-game(String search returned mention of footprints).

: '''Overlay #15''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 4,192 bytes
:* Description: Possibly has to do with Duskull's bank. Got this "Menu_Bank_Mode_Cancel" at 0xFB4.

: '''Overlay #16''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,552 bytes
:* Description: Possibly linked to the Chimecho's assembly menu. Got this string "menuMonsterPictureBook_IsBusy busy" at 0x2CC4.

: '''Overlay #17''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 7,392 bytes
:* Description: Unknown this far.

: '''Overlay #18''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 13,568 bytes
:* Description: Unknown this far.

: '''Overlay #19''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 16,960 bytes
:* Description: Possibly linked to Spinda's cafe.

: '''Overlay #20''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 12,288 bytes
:* Description: Unknown this far.

: '''Overlay #21''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,808 bytes
:* Description: Most likely for the swap shop menu.

: '''Overlay #22''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 19,264 bytes
:* Description: Most likely for the Keckleon shop menu.

: '''Overlay #23''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 14,208 bytes
:* Description: Most likely for the Kangashkan storage menu.

: '''Overlay #24''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 9,440 bytes
:* Description: Unknown this far.

: '''Overlay #25''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 5,312 bytes
:* Description: Unknown this far.

: '''Overlay #26''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,648 bytes
:* Description: Unknown this far.

: '''Overlay #27''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 11,616 bytes
:* Description: Most likely another menu for item handling storage..

: '''Overlay #28''':
:* RAM Load address: 0x0238A140
:* Length in RAM: 3,168 bytes
:* Description: Unknown this far.

: '''Overlay #29''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 488,992 bytes
:* Description: Possibly having to do with running the in-dungeon game. Spotted strings for the in-dungeon menu.

: '''Overlay #30''':
:* RAM Load address: 0x02382820
:* Length in RAM: 14,496 bytes
:* Description: Unknown this far.

: '''Overlay #31''':
:* RAM Load address: 0x02382820
:* Length in RAM: 31,360 bytes
:* Description: Possibly the tactics menu.

: '''Overlay #32''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #33''':
:* RAM Load address: 0x02382820
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

: '''Overlay #34''':
:* RAM Load address: 0x022DC240
:* Length in RAM: 3,680 bytes
:* Description: Possibly having to do with launching the game. There are mention in the strings of the ERSB logo and the "n_logo" logo.

: '''Overlay #35''':
:* RAM Load address: 0x022BCA80
:* Length in RAM: 32 bytes
:* Description: Empty, 32 bytes of zeros.

== Explorers of Time/Darkness ==
Data Specific to Explorers of Time/Darkness. Those two games have some significant differences with Explorers of Sky in the way data is stored.

=== NDS9/ARM9 Overlays: ===
A list of all the overlays, and what they're used for.

== File Structure ==
A detailed list of the file structure of the ROM's nitro-fs filesystem. The three games share a pretty similar file structure. The differences between the three file structures will be indicated as such.

*Note: A lot of files in the ROM have an identifier that correspond to which level/event/cutscene/etc, they're used in. Something like: "s17p01" for example.

First/Second level directories:
: '''/BACK/'''
:: Contains large compressed [[pmd2_BGP|BGP]] images. Some of those appear on the main menu, some later during the game.
:: In Explorers of Sky, the backgrounds from Explorers of Time and Darkness are present but unused.
: '''/BALANCE/'''
:: Contain data about entities/Pokemon, moves, items, and dungeons data.
: '''/DUNGEON/'''
:: Contains what seems to be some dungeon tiles.
: '''/DWC/'''
:: Data for the standard NDS Wifi setup screen.
: '''/EFFECT/'''
:: Contains some of the effect sprites.
: '''/FONT/'''
:: Contains fonts, UI element resources, palettes, and the portraits for the talking pokemon during the game.
: '''/GROUND/'''
:: Contains various sprites, map props, cutscene elements, some effects, and more.
: '''/MAP_BG/'''
:: Contains what seems to be map tiles.
: '''/MESSAGE/'''
:: Contains the text strings for most of the game!
: '''/MONSTER/'''
:: Contains the pokemon sprites for battle and the "overworld".
: '''/RESCUE/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly linked to SOS code generation, and the interactive online rescues.
: '''/SCRIPT/'''
:: Contains the scripts for the whole game. Each directories has an identifier related to the context it takes place in.
: '''/SOUND/BGM/'''
:: Contains the main instrument sounds bank, "bgm.swd", and all the music in the game. With each tracks being a pair of a [[dse_smdl|SMD]] and [[dse_swdl|SWD]] file. Those files are used by the game's [[Digital_Sound_Elements|DSE sound driver]].
: '''/SOUND/ME/'''
:: Contains the jingles that plays when obtaining items and etc..
: '''/SOUND/SE/'''
:: Possibly sound effects.
: '''/SOUND/SWD/'''
:: A bunch of sound effects stored as [[dse_swdl|SWD]]s
: '''/SOUND/SYSTEM/'''
:: Possibly menu related sound effects.
: '''/SYNTH/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly data for the swap cauldron.
: '''/SYSTEM/'''
:: Contains the demo roms for DS Download play, along with the icons and other resources related to that.
: '''/TABLEDAT/''' <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
:: Possibly recycle shop data.
: '''/TOP/'''
:: Contains [[pmd2_BGP|BGP]] files for the backgrounds used in Pokémon Mystery Dungeon: Blue Rescue Team.
:: It can be deleted with no immediately apparent side effects, as the backgrounds are unused.

== File/Data Formats ==
A list of all the file/data formats used in the game.

;Graphics Formats:
: [[pmd2_BGP|BGP]]
: [[pmd2_WAN|WAN/WAT]]
: [[pmd2_WBA|WBA]]
: [[pmd2_W16|W16]]
: [[pmd2_WTE_and_WTU|WTE and WTU]]
: [[pmd2_CHR|CHR]]
: [[pmd2_PAL|PAL]]
: [[pmd2_BMA|BMA]]
: [[pmd2_BPC|BPC]]
: [[pmd2_BPL|BPL]]
: [[pmd2_BPA|BPA]]
: [[pmd2_smd_img|SMD(image)]]
: [[pmd2_sma|SMA]]
;Audio Formats (The files the [[Digital_Sound_Elements|DSE sound driver]] uses):
: [[dse_swdl|SWD]]
: [[dse_smdl|SMD(Music Sequence)]]
: [[dse_sedl|SED]]
;Data Formats:
: [[pmd2_BIN|BIN]]
: [[pmd2_DAT|DAT]]
: [[pmd2_monster.md|MD]]
: [[pmd2_tbl_talk.tlk|TLK]]
: [[pmd2_text_strings|STR]]
;Script Engine Formats
: [[pmd2_SSB|SSB]]
: [[pmd2_SSA|SSA]]
: [[pmd2_SSA|SSS]]
: [[pmd2_SSA|SSE]]
: [[pmd2_LSD|LSD]]
;Container Formats:
: [[pmd2_BIN_pack|BIN]](pack files)
: [[pmd2_kaomado.kao|KAO]]
: [[pmd2_SIR0|SIR0]]
;Compressed Container Formats:
: [[pmd2_AT4PX|AT4PX]]
: [[pmd2_AT4PN|AT4PN]]
: [[pmd2_PKDPX|PKDPX]]
;Font Data:
: [[pmd2_fontdata|DAT (from in the /FONT/ directory)]]
: [[pmd2_DIC|DIC]]
;Misc:
: [[pmd2_SRL|SRL]]

Additionally, several files have a file extension that doesn't match their content. For example, "/SYSTEM/hsd_jap.dat" and "/SYSTEM/hsd_eng.dat" are AT4PX files, but their extension is ".dat".

== Files with Unique Formats ==
A list of files that have their own unique format.

* /BALANCE/[[pmd2_monster.md|monster.md]]
* /BALANCE/[[pmd2_monster.mnd|monster.mnd]] <div style="color: blue; display:inline;">''(Explorers of Time/Darkness only)''</div>
* /BALANCE/[[pmd2_item_p.bin|item_p.bin]]
* /BALANCE/[[pmd2_item_s_p.bin|item_s_p.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_m_level.bin|m_level.bin]]
* /BALANCE/[[pmd2_waza_p.bin|waza_p.bin/waza_p2.bin]]
* /BALANCE/[[pmd2_mappa.bin|mappa_s.bin/mappa_t.bin/mappa_y.bin]]
* /BALANCE/[[pmd2_mappa_g.bin|mappa_gs.bin/mappa_gt.bin/mappa_gy.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_gwdparam.bin|gwdparam.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /BALANCE/[[pmd2_fixed.bin|fixed.bin]]
* /BALANCE/[[pmd2_st_i2n_j.bin|st_i2n_j.bin]]
* /BALANCE/[[pmd2_st_m2n_j.bin|st_m2n_j.bin]]
* /BALANCE/[[pmd2_st_n2m_j.bin|st_n2m_j.bin]]
* /DUNGEON/[[pmd2_dungeon.bin|dungeon.bin]]
* /FONT/[[pmd2_kaomado.kao|kaomado.kao]]
* /MESSAGE/[[pmd2_tbl_talk.tlk|tbl_talk.tlk]]
* /MESSAGE/[[pmd2_text_strings|text_*.str]]
* /RESCUE/[[pmd2_rescue.bin|rescue.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /SYNTH/[[pmd2_synth.bin|synth.bin]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>
* /TABLEDAT/[[pmd2_tabledat|item00.dat to item15.dat]] <div style="color: red; display:inline;">''(Explorers of Sky only)''</div>

== External Resources ==
* Wonder Mail S Tools, research notes. The "items_p_Sky.xlsx" excel sheet contains a comprehensive list of item names/types, pokemon names/types, moves names, etc, along with their associated index values in-game : [http://apointlessplace.net/wms/]
* Pokemon Explorers of Sky research thread on GameFaqs: [http://www.gamefaqs.com/boards/955859-pokemon-mystery-dungeon-explorers-of-sky/51698562] (lots of great info spread around all those pages)

Digital Sound Elements

2016-05-05T04:14:47Z

Psy commando: /* Known Versions */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:Procyon Studios Digital Sound Elements}}

== General Information ==
The ''Digital Sound Elements'' sound driver is an audio engine for games on the Nintendo DS, and Wii. It supports sequenced music and streamed audio.
It was used by several games on the NDS including ''Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness''.

This article will focus mainly on the implementation in PMD2 however.

== Known Versions ==
So far, two versions of the DSE engine have been spotted in NDS games.

{|
!Version Number
!Description
|-
| 0x415
| Most common version. Used in all versions of PMD2.
|-
| 0x402
| Much rarer version. Used only in the game Luminous Arc this far.
|}

Only the format of SWDL containers seems to differs significantly between versions this far.

== Inner Workings ==
The sound driver adds a few layers of extra processing over the data fed to the audio registers of the NDS.

=== Memory Structure ===
The system creates 2 chunks in memory, the "mseq", and "mdev" chunks. They're only labeled as such in a few games using DSE, like PMD2. In other games, like ''Fushigi no Dungeon - Fuurai no Shiren DS 2'' and ''Professor Layton and the Last Specter'', the labels are not there in memory.

The "mseq" chunk contains a set of sequencer wide variables, like counters and such, along with data structs for holding the state of each tracks during playback.

The "mdev" chunk contains a set of channels wide variables, and data structs for every sound channels the driver has. Those structs hold the state for each channels during playback.

Apart from this, the smdl and swdl for a track currently playing are copied once to memory. And then the entries in the swdl for samples, and program splits are copied and any overridable properties samples have are overriden by the program split's shared properties, like volume envelope and etc..(See swdl structure)

=== Code Structure ===
(Offsets are from the North American Explorers of Sky game's disassembled game code, not the ROM !!!)

The channels state are updated at line 0x0207448C. A loop begins further down. And the track
Volume envelopes are updated here: 0x02074E0C

The function that updates the sequencer tracks begins at 0x020713E8. The actual loop begins at 02071648.
The function that parses DSE events begins at 0x02071224.
The table containing the function pointers for all DSE events begins at 0x020B0B90.

== File/Data Formats ==
The system uses the following formats:
* [[dse_swdl|swdl]] : Container for programs/presets data, and optionally sample data, used by the sequencer engine.
* [[dse_smdl|smdl]] : Container for sequenced music.
* [[dse_sedl|sedl]] : Container for sequenced sound effects, and sound presets/programs.
* [[dse_sadl|sadl]] : Container for streamed audio.

== File Layout ==
Game using DSE can store the various container formats in many different ways. Here are some of the known approaches:

* '''PMD2 :''' There is a main sample bank called bgm.swd, which is referred to by the SWDL files accompanying every SMDL music sequences file. Each SWDL contains only program/presets data, and refers to samples from the main bank.

* '''Fushigi no Dungeon - Fuurai no Shiren DS 2 - Sabaku no Majou :''' Here, the SMDL and SWDL are stored in their own separate folder. They're loaded in pair, just like PMD2, but there is no main bank. Instead sample data is stored within every SWDL. Which result in lots of duplicate samples throughout all SWDL.

* '''Zombi Daisuki:''' This game uses SMDL+SWDL pairs as well, without a main bank. But instead of having the SMDL and SWDL for a single music track stored in their own respective file, they're both stored within a [[pmd2_SIR0|SIR0]] container, with the extension ".sd".

* '''Professor Layton and the Last Specter :''' This game works like PMD2, it has a main bank, however, all its SMDL + SWDL pairs are stored within an archive "ll_common.darc". And oddly enough, there are 2 copies of the main bank! One is named "bgm_common.SWD" and is stored outside the "ll_common.darc" archive, while the other is named "BG.SWD" and stored within the archive.

== External Resources ==
* Official Website (in Japanese) [http://www.procyon-studio.co.jp/dse/]

Digital Sound Elements

2016-05-05T04:12:49Z

Psy commando: Added a short section about the various DSE versions.

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:Procyon Studios Digital Sound Elements}}

== General Information ==
The ''Digital Sound Elements'' sound driver is an audio engine for games on the Nintendo DS, and Wii. It supports sequenced music and streamed audio.
It was used by several games on the NDS including ''Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness''.

This article will focus mainly on the implementation in PMD2 however.

== Known Versions ==
So far, two versions of the DSE engine have been spotted in NDS games.

{|
!Version Number
!Description
|-
| 0x415
| 0x402
|-
| Most common version. Used in all versions of PMD2.
| Much rarer version. Used only in the game Luminous Arc this far.
|}

Only the format of SWDL containers seems to differs significantly between versions this far.

== Inner Workings ==
The sound driver adds a few layers of extra processing over the data fed to the audio registers of the NDS.

=== Memory Structure ===
The system creates 2 chunks in memory, the "mseq", and "mdev" chunks. They're only labeled as such in a few games using DSE, like PMD2. In other games, like ''Fushigi no Dungeon - Fuurai no Shiren DS 2'' and ''Professor Layton and the Last Specter'', the labels are not there in memory.

The "mseq" chunk contains a set of sequencer wide variables, like counters and such, along with data structs for holding the state of each tracks during playback.

The "mdev" chunk contains a set of channels wide variables, and data structs for every sound channels the driver has. Those structs hold the state for each channels during playback.

Apart from this, the smdl and swdl for a track currently playing are copied once to memory. And then the entries in the swdl for samples, and program splits are copied and any overridable properties samples have are overriden by the program split's shared properties, like volume envelope and etc..(See swdl structure)

=== Code Structure ===
(Offsets are from the North American Explorers of Sky game's disassembled game code, not the ROM !!!)

The channels state are updated at line 0x0207448C. A loop begins further down. And the track
Volume envelopes are updated here: 0x02074E0C

The function that updates the sequencer tracks begins at 0x020713E8. The actual loop begins at 02071648.
The function that parses DSE events begins at 0x02071224.
The table containing the function pointers for all DSE events begins at 0x020B0B90.

== File/Data Formats ==
The system uses the following formats:
* [[dse_swdl|swdl]] : Container for programs/presets data, and optionally sample data, used by the sequencer engine.
* [[dse_smdl|smdl]] : Container for sequenced music.
* [[dse_sedl|sedl]] : Container for sequenced sound effects, and sound presets/programs.
* [[dse_sadl|sadl]] : Container for streamed audio.

== File Layout ==
Game using DSE can store the various container formats in many different ways. Here are some of the known approaches:

* '''PMD2 :''' There is a main sample bank called bgm.swd, which is referred to by the SWDL files accompanying every SMDL music sequences file. Each SWDL contains only program/presets data, and refers to samples from the main bank.

* '''Fushigi no Dungeon - Fuurai no Shiren DS 2 - Sabaku no Majou :''' Here, the SMDL and SWDL are stored in their own separate folder. They're loaded in pair, just like PMD2, but there is no main bank. Instead sample data is stored within every SWDL. Which result in lots of duplicate samples throughout all SWDL.

* '''Zombi Daisuki:''' This game uses SMDL+SWDL pairs as well, without a main bank. But instead of having the SMDL and SWDL for a single music track stored in their own respective file, they're both stored within a [[pmd2_SIR0|SIR0]] container, with the extension ".sd".

* '''Professor Layton and the Last Specter :''' This game works like PMD2, it has a main bank, however, all its SMDL + SWDL pairs are stored within an archive "ll_common.darc". And oddly enough, there are 2 copies of the main bank! One is named "bgm_common.SWD" and is stored outside the "ll_common.darc" archive, while the other is named "BG.SWD" and stored within the archive.

== External Resources ==
* Official Website (in Japanese) [http://www.procyon-studio.co.jp/dse/]

Dse smdl

2016-04-20T00:37:06Z

Psy commando: /* Others(0x90 to 0xFF) */ fixed the amount of paramters for the byte skipping functions, since those aren't really parameters, they're just ignored bytes

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
The EoC chunk marks the end of the SMDL file/container.

{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips the next byte in the track.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 0
| -
| SkipNext2Bytes
| Skip the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|-
| 0xF8
| 0
| -
| SkipNext2Bytes2
| Skips the next 2 bytes in the track.
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]
* The unknown Japanese author of the "smd2mid v0.10" utility floating around the web.

Dse smdl

2016-04-20T00:30:57Z

Psy commando: Added the missing skip2bytes event to the list!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
The EoC chunk marks the end of the SMDL file/container.

{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|-
| 0xF8
| 0
| -
| SkipNext2Bytes2
| Skips processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]
* The unknown Japanese author of the "smd2mid v0.10" utility floating around the web.

Digital Sound Elements

2016-04-12T19:01:50Z

Psy commando: /* Code Structure */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:Procyon Studios Digital Sound Elements}}

== General Information ==
The ''Digital Sound Elements'' sound driver is an audio engine for games on the Nintendo DS, and Wii. It supports sequenced music and streamed audio.
It was used by several games on the NDS including ''Pokémon Mystery Dungeon : Explorers of Sky/Time/Darkness''.

This article will focus mainly on the implementation in PMD2 however.

== Inner Workings ==
The sound driver adds a few layers of extra processing over the data fed to the audio registers of the NDS.

=== Memory Structure ===
The system creates 2 chunks in memory, the "mseq", and "mdev" chunks. They're only labeled as such in a few games using DSE, like PMD2. In other games, like ''Fushigi no Dungeon - Fuurai no Shiren DS 2'' and ''Professor Layton and the Last Specter'', the labels are not there in memory.

The "mseq" chunk contains a set of sequencer wide variables, like counters and such, along with data structs for holding the state of each tracks during playback.

The "mdev" chunk contains a set of channels wide variables, and data structs for every sound channels the driver has. Those structs hold the state for each channels during playback.

Apart from this, the smdl and swdl for a track currently playing are copied once to memory. And then the entries in the swdl for samples, and program splits are copied and any overridable properties samples have are overriden by the program split's shared properties, like volume envelope and etc..(See swdl structure)

=== Code Structure ===
(Offsets are from the North American Explorers of Sky game's disassembled game code, not the ROM !!!)

The channels state are updated at line 0x0207448C. A loop begins further down. And the track
Volume envelopes are updated here: 0x02074E0C

The function that updates the sequencer tracks begins at 0x020713E8. The actual loop begins at 02071648.
The function that parses DSE events begins at 0x02071224.
The table containing the function pointers for all DSE events begins at 0x020B0B90.

== File/Data Formats ==
The system uses the following formats:
* [[dse_swdl|swdl]] : Container for programs/presets data, and optionally sample data, used by the sequencer engine.
* [[dse_smdl|smdl]] : Container for sequenced music.
* [[dse_sedl|sedl]] : Container for sequenced sound effects, and sound presets/programs.
* [[dse_sadl|sadl]] : Container for streamed audio.

== File Layout ==
Game using DSE can store the various container formats in many different ways. Here are some of the known approaches:

* '''PMD2 :''' There is a main sample bank called bgm.swd, which is referred to by the SWDL files accompanying every SMDL music sequences file. Each SWDL contains only program/presets data, and refers to samples from the main bank.

* '''Fushigi no Dungeon - Fuurai no Shiren DS 2 - Sabaku no Majou :''' Here, the SMDL and SWDL are stored in their own separate folder. They're loaded in pair, just like PMD2, but there is no main bank. Instead sample data is stored within every SWDL. Which result in lots of duplicate samples throughout all SWDL.

* '''Zombi Daisuki:''' This game uses SMDL+SWDL pairs as well, without a main bank. But instead of having the SMDL and SWDL for a single music track stored in their own respective file, they're both stored within a [[pmd2_SIR0|SIR0]] container, with the extension ".sd".

* '''Professor Layton and the Last Specter :''' This game works like PMD2, it has a main bank, however, all its SMDL + SWDL pairs are stored within an archive "ll_common.darc". And oddly enough, there are 2 copies of the main bank! One is named "bgm_common.SWD" and is stored outside the "ll_common.darc" archive, while the other is named "BG.SWD" and stored within the archive.

== External Resources ==
* Official Website (in Japanese) [http://www.procyon-studio.co.jp/dse/]

Dse swdl

2015-12-10T20:34:38Z

Psy commando: /* pcmd Chunk */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lowkey2
| A copy of lowkey, for unknown purpose.
|-
| 0x07
| 1
| int8
| hikey2
| A copy of hikey, for unknown purpose.
|-
| 0x08
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x09
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x0A
| 1
| int8
| lovel2
| A copy of lovel, for unknown purpose. Usually 0x00.
|-
| 0x0B
| 1
| int8
| hivel2
| A copy of hivel, for unknown purpose. Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

==== Example ====
Here's a picture of a single program/preset entry in the prgi chunk:
<br clear=all>
[[File:PMD2DSE annotated prgi chunk entry.png|framed|left|Layout of a DSE program/preset entry]]
<br clear=all>

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Keygroups are used to allow finer control on how the audio engine allocates the limited amount of voices to the presets. They define a per group priority and a range of voice channel available to each, along with the maximum number of simultaneous voice channels each can used.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples.
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====
The durations in the tables are in milliseconds, conveniently!

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-12-10T20:33:35Z

Psy commando: /* Duration Lookup Tables */ Added a mention that the durations in the tables are in milliseconds

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lowkey2
| A copy of lowkey, for unknown purpose.
|-
| 0x07
| 1
| int8
| hikey2
| A copy of hikey, for unknown purpose.
|-
| 0x08
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x09
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x0A
| 1
| int8
| lovel2
| A copy of lovel, for unknown purpose. Usually 0x00.
|-
| 0x0B
| 1
| int8
| hivel2
| A copy of hivel, for unknown purpose. Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

==== Example ====
Here's a picture of a single program/preset entry in the prgi chunk:
<br clear=all>
[[File:PMD2DSE annotated prgi chunk entry.png|framed|left|Layout of a DSE program/preset entry]]
<br clear=all>

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Keygroups are used to allow finer control on how the audio engine allocates the limited amount of voices to the presets. They define a per group priority and a range of voice channel available to each, along with the maximum number of simultaneous voice channels each can used.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====
The durations in the tables are in milliseconds, conveniently!

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Pokemon Super Mystery Dungeon

2015-12-03T20:39:47Z

Psy commando: Initial publish of the PSMD hub page!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:Pokémon Super Mystery Dungeon}}

== General Information ==
This page contains data on the Pokémon Super Mystery Dungeon game.

== File Structure ==

== Script Engine Details ==
The Script engine of PSMD uses compiled lua 5.1 scripts.
* List of all function, objects, and globals : [[psmd_script_globals|Here]]

== File/Data Formats ==
Most files formats are identical to the ones found in [[Pokemon_Mystery_Dungeon_Gates_to_Infinity|Pokémon Mystery Dungeon : Gates to Infinity]]. However, some have been updated, added, or differ slightly.

;Container Format
:[[pmdgti_FARC|BIN(FARC)]]
;Image Data
:[[pmdgti_IMG|IMG]]
;Game Strings
:[[pmdgti_TextDb|BIN(GameStrings)]]
;Script Engine Formats:
:[https://en.wikipedia.org/wiki/Lua_%28programming_language%29 LUA]

== Files with Unique Formats ==

== External Resources ==

Dse swdl

2015-10-22T21:25:02Z

Psy commando: /* SplitEntry */ Fixed a serious mistake I did when transcribing my notes. I labeled the wrong field as being the lowest velocity and highest velocity possible for a given sample.

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lowkey2
| A copy of lowkey, for unknown purpose.
|-
| 0x07
| 1
| int8
| hikey2
| A copy of hikey, for unknown purpose.
|-
| 0x08
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x09
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x0A
| 1
| int8
| lovel2
| A copy of lovel, for unknown purpose. Usually 0x00.
|-
| 0x0B
| 1
| int8
| hivel2
| A copy of hivel, for unknown purpose. Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

==== Example ====
Here's a picture of a single program/preset entry in the prgi chunk:
<br clear=all>
[[File:PMD2DSE annotated prgi chunk entry.png|framed|left|Layout of a DSE program/preset entry]]
<br clear=all>

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Keygroups are used to allow finer control on how the audio engine allocates the limited amount of voices to the presets. They define a per group priority and a range of voice channel available to each, along with the maximum number of simultaneous voice channels each can used.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Pmd2 text strings

2015-10-20T21:11:22Z

Psy commando: /* More Details */ Fixed a brain fart about unicode encoding I had..

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:text_*.str File Format}}

The "text_e.str" file contains a table of pointers to null terminated strings contained further down in the file.
In other languages versions of the game, the letter "e" is changed to indicate the language. For example, "text_j.str" is the name of the file for the Japanese version of the game.

== More Details ==
In addition to the characters from the character sets used, the game sometimes uses [[#Special Characters|unprintable character sequences]] to represent special characters in-game.
The game also uses several [[#Tags|square brackets enclosed tags]] that can trigger a wide range of things, going from replacing the tag with a value or string, adding a pause for input, changing the text formatting, playing a sound/music, etc..

The file also appears to be somehow linked to the "[[Pmd2_tbl_talk.tlk|tbl_talk.tlk]]" file.

==== Notes ====
:* The number of strings varies by game and region. The US version of Explorers of Sky the English file contains 18,452 strings. Each language in the European version contains 18,482. The Japanese version contains 19,010.
:* In Explorers of Time/Darkness the English file contains 13,666 strings.

==== Known Character Encoding ====

{|class="wikitable"
!File
!Encoding
|-
| text_e.str
| 8-bits, [http://en.wikipedia.org/wiki/ISO/IEC_8859-1 ISO 8859-1] aka Windows-28591, or [http://en.wikipedia.org/wiki/Windows-1252 Windows-1252]
|-
| text_j.str
| 8-bits, [http://en.wikipedia.org/wiki/Shift_JIS Shift JIS] or [http://en.wikipedia.org/wiki/Code_page_932 Windows-31J]
|}

* '''Warning:''' There is also a possibility the strings are actually stored as multi-byte [https://en.wikipedia.org/wiki/UTF-8 utf-8] strings! Considering special characters like the music note are made of several characters, and also considering that ASCII characters are interpreted correctly.

== File Structure ==

=== Overview ===
A quick overview of the main parts of the file.
Note that there is no padding between the Pointer Table and the Strings Block!

{| class="wikitable"
! Offset
! Length
! Endianness
! Type
! Name
! Description
|-
| 0x00
| Varies
|
|
| [[#Pointer Table|Pointer Table]]
| A table of pointers to every null-terminate strings in the [[#Strings Block|Strings Block]].
|-
| After Pointer Table
| Varies
|
|
| [[#Strings Block|Strings Block]]
| A block containing null-terminated strings of characters one after the other. The last pointer points to the end of the file, after the last string.
|}

=== Pointer Table ===
A very straightforward list of 4 bytes pointers to every strings in the file. Pointers are all little endian, as usual.
* '''NOTE:''' The last pointer in the table must points to the end of the file, after the last string.

=== Strings Block ===
Again, this is very straightforward. All null-terminated strings are simply stored one after the other. There is no padding at the end of the file.

== Special Characters ==
As mentioned above, the game uses several special sequences of unprintable characters for displaying some in-game characters or pictogram.

Here are some of the known ones:
{| class="wikitable"
! Sequence
! Description
|-
|
|}

== Tags ==
As mentioned above the game uses square brackets enclosed expressions for runtime text replacement, formatting, or triggering various events.

Here are some of the known ones:
{| class="wikitable"
! Expression
! Description
|-
|
|}

Pmd2 text strings

2015-10-20T21:07:29Z

Psy commando: /* Known Character Encoding */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:text_*.str File Format}}

The "text_e.str" file contains a table of pointers to null terminated strings contained further down in the file.
In other languages versions of the game, the letter "e" is changed to indicate the language. For example, "text_j.str" is the name of the file for the Japanese version of the game.

== More Details ==
In addition to the characters from the character sets used, the game sometimes uses [[#Special Characters|unprintable character sequences]] to represent special characters in-game.
The game also uses several [[#Tags|square brackets enclosed tags]] that can trigger a wide range of things, going from replacing the tag with a value or string, adding a pause for input, changing the text formatting, playing a sound/music, etc..

The file also appears to be somehow linked to the "[[Pmd2_tbl_talk.tlk|tbl_talk.tlk]]" file.

==== Notes ====
:* The number of strings varies by game and region. The US version of Explorers of Sky the English file contains 18,452 strings. Each language in the European version contains 18,482. The Japanese version contains 19,010.
:* In Explorers of Time/Darkness the English file contains 13,666 strings.

==== Known Character Encoding ====

{|class="wikitable"
!File
!Encoding
|-
| text_e.str
| 8-bits, [http://en.wikipedia.org/wiki/ISO/IEC_8859-1 ISO 8859-1] aka Windows-28591, or [http://en.wikipedia.org/wiki/Windows-1252 Windows-1252]
|-
| text_j.str
| 8-bits, [http://en.wikipedia.org/wiki/Shift_JIS Shift JIS] or [http://en.wikipedia.org/wiki/Code_page_932 Windows-31J]
|}

* '''Warning:''' There is also a possibility the strings are actually stored as multi-byte utf8/utf16/utf32 strings! Considering special characters like the music note are made of several characters, and also considering that ASCII characters are interpreted correctly.

== File Structure ==

=== Overview ===
A quick overview of the main parts of the file.
Note that there is no padding between the Pointer Table and the Strings Block!

{| class="wikitable"
! Offset
! Length
! Endianness
! Type
! Name
! Description
|-
| 0x00
| Varies
|
|
| [[#Pointer Table|Pointer Table]]
| A table of pointers to every null-terminate strings in the [[#Strings Block|Strings Block]].
|-
| After Pointer Table
| Varies
|
|
| [[#Strings Block|Strings Block]]
| A block containing null-terminated strings of characters one after the other. The last pointer points to the end of the file, after the last string.
|}

=== Pointer Table ===
A very straightforward list of 4 bytes pointers to every strings in the file. Pointers are all little endian, as usual.
* '''NOTE:''' The last pointer in the table must points to the end of the file, after the last string.

=== Strings Block ===
Again, this is very straightforward. All null-terminated strings are simply stored one after the other. There is no padding at the end of the file.

== Special Characters ==
As mentioned above, the game uses several special sequences of unprintable characters for displaying some in-game characters or pictogram.

Here are some of the known ones:
{| class="wikitable"
! Sequence
! Description
|-
|
|}

== Tags ==
As mentioned above the game uses square brackets enclosed expressions for runtime text replacement, formatting, or triggering various events.

Here are some of the known ones:
{| class="wikitable"
! Expression
! Description
|-
|
|}

Pmd2 text strings

2015-10-20T21:07:14Z

Psy commando: /* Known Character Encoding */ Just added a word of caution after realizing something while working on parsing the text.

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
{{DISPLAYTITLE:text_*.str File Format}}

The "text_e.str" file contains a table of pointers to null terminated strings contained further down in the file.
In other languages versions of the game, the letter "e" is changed to indicate the language. For example, "text_j.str" is the name of the file for the Japanese version of the game.

== More Details ==
In addition to the characters from the character sets used, the game sometimes uses [[#Special Characters|unprintable character sequences]] to represent special characters in-game.
The game also uses several [[#Tags|square brackets enclosed tags]] that can trigger a wide range of things, going from replacing the tag with a value or string, adding a pause for input, changing the text formatting, playing a sound/music, etc..

The file also appears to be somehow linked to the "[[Pmd2_tbl_talk.tlk|tbl_talk.tlk]]" file.

==== Notes ====
:* The number of strings varies by game and region. The US version of Explorers of Sky the English file contains 18,452 strings. Each language in the European version contains 18,482. The Japanese version contains 19,010.
:* In Explorers of Time/Darkness the English file contains 13,666 strings.

==== Known Character Encoding ====

{|class="wikitable"
!File
!Encoding
|-
| text_e.str
| 8-bits, [http://en.wikipedia.org/wiki/ISO/IEC_8859-1 ISO 8859-1] aka Windows-28591, or [http://en.wikipedia.org/wiki/Windows-1252 Windows-1252]
|-
| text_j.str
| 8-bits, [http://en.wikipedia.org/wiki/Shift_JIS Shift JIS] or [http://en.wikipedia.org/wiki/Code_page_932 Windows-31J]
|}

* Warning: There is also a possibility the strings are actually stored as multi-byte utf8/utf16/utf32 strings! Considering special characters like the music note are made of several characters, and also considering that ASCII characters are interpreted correctly.

== File Structure ==

=== Overview ===
A quick overview of the main parts of the file.
Note that there is no padding between the Pointer Table and the Strings Block!

{| class="wikitable"
! Offset
! Length
! Endianness
! Type
! Name
! Description
|-
| 0x00
| Varies
|
|
| [[#Pointer Table|Pointer Table]]
| A table of pointers to every null-terminate strings in the [[#Strings Block|Strings Block]].
|-
| After Pointer Table
| Varies
|
|
| [[#Strings Block|Strings Block]]
| A block containing null-terminated strings of characters one after the other. The last pointer points to the end of the file, after the last string.
|}

=== Pointer Table ===
A very straightforward list of 4 bytes pointers to every strings in the file. Pointers are all little endian, as usual.
* '''NOTE:''' The last pointer in the table must points to the end of the file, after the last string.

=== Strings Block ===
Again, this is very straightforward. All null-terminated strings are simply stored one after the other. There is no padding at the end of the file.

== Special Characters ==
As mentioned above, the game uses several special sequences of unprintable characters for displaying some in-game characters or pictogram.

Here are some of the known ones:
{| class="wikitable"
! Sequence
! Description
|-
|
|}

== Tags ==
As mentioned above the game uses square brackets enclosed expressions for runtime text replacement, formatting, or triggering various events.

Here are some of the known ones:
{| class="wikitable"
! Expression
! Description
|-
|
|}

Dse swdl

2015-10-20T20:50:02Z

Psy commando: Fixed the layout breaking because of the image!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

==== Example ====
Here's a picture of a single program/preset entry in the prgi chunk:
<br clear=all>
[[File:PMD2DSE annotated prgi chunk entry.png|framed|left|Layout of a DSE program/preset entry]]
<br clear=all>

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Keygroups are used to allow finer control on how the audio engine allocates the limited amount of voices to the presets. They define a per group priority and a range of voice channel available to each, along with the maximum number of simultaneous voice channels each can used.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-20T20:45:36Z

Psy commando: /* prgi Chunk */ Tried adding a picture taken from an hex editor to better illustrate the format of the chunk!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

==== Example ====
Here's a picture of a single program/preset entry in the prgi chunk:

[[File:PMD2DSE annotated prgi chunk entry.png|framed|left|Layout of a DSE program/preset entry]]

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Keygroups are used to allow finer control on how the audio engine allocates the limited amount of voices to the presets. They define a per group priority and a range of voice channel available to each, along with the maximum number of simultaneous voice channels each can used.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

File:PMD2DSE annotated prgi chunk entry.png

2015-10-20T20:42:49Z

Psy commando: A visual breakdown of a program/preset entry the "prgi" chunk used in PMD2's/DSE's SWDL file format in a hex editor, with annotations and highlighting. Just a bit of a visual aid, as its a bit hard to visualize everything with only the tables.

== Summary ==
A visual breakdown of a program/preset entry the "prgi" chunk used in PMD2's/DSE's SWDL file format in a hex editor, with annotations and highlighting.

Just a bit of a visual aid, as its a bit hard to visualize everything with only the tables.
== Copyright status: ==

== Licensing ==
{{PD-self}}
== Source: ==

Dse swdl

2015-10-18T19:56:02Z

Psy commando: /* kgrp Chunk */ forgot to modify the description!

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Keygroups are used to allow finer control on how the audio engine allocates the limited amount of voices to the presets. They define a per group priority and a range of voice channel available to each, along with the maximum number of simultaneous voice channels each can used.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-16T21:01:30Z

Psy commando: /* Keygroup */ can't decide on how to bring this up..

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Its not known yet how keygroups work, but it appears its a set of properties that can be assigned to splits of every programs that overrides some of those splits' parameters, determine their max polyphony, their volume, their "priority" and a few other things.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, lets say that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-16T21:00:36Z

Psy commando: /* Keygroup */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Its not known yet how keygroups work, but it appears its a set of properties that can be assigned to splits of every programs that overrides some of those splits' parameters, determine their max polyphony, their volume, their "priority" and a few other things.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, consider that a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-16T20:58:21Z

Psy commando: /* SplitEntry */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~10 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Its not known yet how keygroups work, but it appears its a set of properties that can be assigned to splits of every programs that overrides some of those splits' parameters, determine their max polyphony, their volume, their "priority" and a few other things.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, if a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-16T20:55:18Z

Psy commando: /* LFOEntry */ rewording

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO, its frequency, depth, delay, fade-out. And possibly more.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. Most of the time, this value is 1 when the LFO is in use.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Its not known yet how keygroups work, but it appears its a set of properties that can be assigned to splits of every programs that overrides some of those splits' parameters, determine their max polyphony, their volume, their "priority" and a few other things.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, if a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-16T20:49:43Z

Psy commando: /* ProgramInfo */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to the program ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO. The frequency, the depth, the delay, the fade-out. And what might be a resonance parameter(Q) with what might possibly be a low-pass filter.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. (Posibly boolean to confirm its enabled) If is set to 0, the LFO corresponding to the entry is disabled.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Its not known yet how keygroups work, but it appears its a set of properties that can be assigned to splits of every programs that overrides some of those splits' parameters, determine their max polyphony, their volume, their "priority" and a few other things.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, if a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-16T20:39:12Z

Psy commando: Added a lot of missing details and fixed a lot of typos. Added explanation of how the envelopes work,

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SWDL Format}}

== General Information ==
SWDL containers are used to contain sample and programs/presets information for any accompanying [[dse_sedl|SEDL]] or [[dse_smdl|SMDL]] files.

They can be used in a few ways.
* To accompany a SMDL, and contain both the samples it uses and the data for the programs it uses.
* To accompany a SMDL, and contain only the program/preset data while referring to a main sample bank for the samples it uses.
* As a sample bank.

When used in the second manner, it allows the game to only load the samples it actually uses from the main bank, and it keeps redundancy to a minimum. SWDLs also seems to override some of the data they contains. So, if a sample has its rootkey set to 60 in the main bank, and it was set to 80 in another SWDL referring to it, the rootkey actually used after loading that last SWDL would be 80. This works with a lot more parameters however.

== File Structure ==
The file format is based around chunks, a bit like the RIFF file format. There doesn't seem to be a particular order to the chunks other than the header and the eod chunk.

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 80
| [[#SWDL Header|SWDLHeader]]
| The container's header.
|-
| -
| Varies
| [[#wavi Chunk|wavi Chunk]]
| Contains details on all the samples contained, or referred to by the SWDL container.
|-
| -
| Varies
| [[#prgi Chunk|prgi Chunk]]
| The prgi chunk contains the programs/presets used by the SMDL files. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#kgrp Chunk|kgrp Chunk]]
| The kgrp chunk contains information on every keygroups used in the SWDL by the programs/presets. (It may be omitted in SWDL purely for storing sample data.)
|-
| -
| Varies
| [[#pcmd Chunk|pcmd Chunk]]
| The pcmd chunk contains the raw sample data for every samples contained in the file. (It may be omitted if the SWDL refers to a main bank for its sample data.)
|-
| -
| 16
| [[#Eod Chunk|End of Data Chunk]]
| This empty chunk marks the end of the SWDL container.
|}

=== SWDL Header ===
----
{| class="wikitable"
|+ Total length 80 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "swdl" {0x73, 0x77, 0x64, 0x6C}
|-
| 0x04
| 4
| -
| unk18
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk10
| Always 0x00AA AAAA
|-
| 0x34
| 4
| uint32
| unk11
| 4 bytes of zeroes.
|-
| 0x38
| 4
| uint32
| unk12
| 4 bytes of zeroes.
|-
| 0x3C
| 4
| uint32
| unk13
| So far always 0x10
|-
| 0x40
| 4
| uint32
| pcmdlen
| Length of "pcmd" chunk if there is one. If not, is null! If set to 0xAAAA0000 (The 0000 may contains something else), the file refers to samples inside an external "pcmd" chunk, inside another SWDL !
|-
| 0x44
| 4
| uint32
| unk14
| 4 bytes of zeroes.
|-
| 0x46
| 2
| uint16
| nbwavislots
| Numbers of sample pointer slots, empty or not, in the "wavi" chunk's "WavTable".
|-
| 0x48
| 2
| uint16
| nbprgislots
| Numbers of presets pointer slots , empty or not, in the "prgi" chunk's "TablA".
|-
| 0x4A
| 2
| uint16
| unk17
| Unknown
|-
| 0x4C
| 4
| uint32
| wavilen
| Length of "wavi" chunk.
|}

=== wavi Chunk ===
----
The wavi chunk contains information on all the samples. Its what links the prgi chunk to the sample data within the local or external pcmd chunk.
Its made up of two main parts:
* A pointer table, with a slot for every samples used globally.
* A table of sample information.
Each non-null pointers in the first table points to a single sample information entry in the second table. Null pointers indicate unused, or missing samples, depending on the context.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "wavi" {0x77, 0x61, 0x76, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| [[#WavTable|WabTable]]
| Array containing 2 bytes offsets from the beginning offset of WavTable to an entry in the SampleInfoTbl table! It may be null.
|-
| After WavTable
| 0-15
| -
| Padding Bytes
| 0xAA padding bytes to align the next part on 16 bytes.
|-
| After Padding
| varies
| -
| [[#SampleInfoTbl|SampleInfoTbl]]
| This table contains details on each sample entries in the "WavTable".
|}

==== WavTable ====
The table of pointers to the sample info. Each pointers is 16 bits, and may be null. The nb of entries is set in the SWDL header.

==== SampleInfoTbl ====
The table made up of sample info entries. Each entries are 64 bytes, thus no padding is ever needed between entries.

Here's the format of a sample info entry:
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| unk1
| Entry marker? Always 0x01AA.
|-
| 0x02
| 2
| uint16
| ID
| Index number from WavTable. Empty/null entries in WavTable are counted!
|-
| 0x04
| 1
| int8
| ftune
| The pitch fine tuning in cents(?).
|-
| 0x05
| 1
| int8
| ctune
| Coarse tuning, possibly in semitones(?). Default is -7.
|-
| 0x06
| 1
| int8
| rootkey
| The MIDI note associated to the sample. (The note that the instrument sampled is playing) It doesn't seems to have any effect in the game.
|-
| 0x07
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x08
| 1
| int8
| volume
| The volume of the sample. (0-127)
|-
| 0x09
| 1
| int8
| pan
| The pan of the sample. (0-64-127)
|-
| 0x0A
| 1
| uint8
| unk5
| Possibly Keygroup parameter for the sample. Always 0x00.
|-
| 0x0B
| 1
| uint8
| unk58
| Unknown. Always 0x02.
|-
| 0x0C
| 2
| uint16
| unk6
| Always 0x0000.
|-
| 0x0E
| 2
| -
| unk7
| 0xAA padding.
|-
| 0x10
| 2
| uint16
| unk59
| Always 0x1504.
|-
| 0x12
| 2
| uint16
| smplfmt
| Sample format.
* 0x0000 : Possibly 8 bits PCM
* 0x0100 : 16 bits PCM
* 0x0200 : 4 bits ADPCM
* 0x0300 : Possibly PSG ?
|-
| 0x14
| 1
| uint8
| unk9
| Often 0x09
|-
| 0x15
| 1
| uint8
| smplloop
| Flag indicating whether the sample should be looped or not ! (1 = looped, 0 = not looped)
|-
| 0x16
| 2
| uint16
| unk10
| Often 0x0108
|-
| 0x18
| 2
| uint16
| unk11
| Often 0004.
|-
| 0x1A
| 2
| uint16
| unk12
| Often 0x0101.
|-
| 0x1C
| 4
| -
| unk13
| Often 0x0000 0000.
|-
| 0x20
| 4
| uint32
| smplrate
| Sample rate in hertz.
|-
| 0x24
| 4
| uint32
| smplpos
| The offset of the sound sample in the "pcmd" chunk when there is one. Otherwise, possibly offset of the exact sample among all the sample data loaded in memory? (The value usually doesn't match the main bank's)
|-
| 0x28
| 4
| uint32
| loopbeg
| The position in bytes divided by 4, the loop begins at, from smplpos. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length ! (For ADPCM samples, the 4 bytes preamble is counted in the loopbeg!)
|-
| 0x2C
| 4
| uint32
| looplen
| The length of the loop in bytes, divided by 4. ( multiply by 4 to get size in bytes ) Adding loopbeg + looplen gives the sample's length !
|-
| 0x30
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x31
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x32
| 1
| uint8
| unk19
| Unknown. Usually 0x1
|-
| 0x33
| 1
| uint8
| unk20
| Unknown. Usually 0x3
|-
| 0x34
| 2
| uint16
| unk21
| Unknown. Usually 0x03FF ( Little endian -253)
|-
| 0x36
| 2
| uint16
| unk22
| Unknown. Usually 0xFFFF
|-
| 0x38
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x39
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x3A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x3B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x3C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x3D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x3E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x3F
| 1
| int8
| unk57
| Unknown. Usually 0xFF.
|}

=== prgi Chunk ===
----
The prgi chunk contains programs/presets that the SMDL music sequences use as instrument presets in their tracks.
Its made up of :
* A table of pointers to all the programs info entries. Some may be null.
* A table containing program info entries.

The pointer table works in the exact same way as it does in the wavi chunk. 16 bits offsets from the beginning of the table to a program info entry.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "prgi" {0x70, 0x72, 0x67, 0x69}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| (nbprgislots * 2) + padding
| -
| ProgramPtrTbl
| A table of 16 bits pointers to entries in the ProgramInfoTbl. Some may be null. It usually has 128 slots. Like General Midi. If the nb of presets were to change, its possible there would be a need for padding bytes, seeing how the wavi chunk works.
|-
| After ProgramPtrTbl
| Varies
| [[#ProgramInfo|ProgramInfo]][nbprgislots]
| [[#ProgramInfoTbl|ProgramInfoTbl]]
| A table containing information on all the presets available in the current SWDL.
|}

==== ProgramInfoTbl ====
This table contains entries for every single presets available in the SWDL. Each entry is pointed to by a pointer in the ProgramPtrTbl.

It contains ProgramInfo entries:

==== ProgramInfo ====
A ProgramInfo entry is minimum 144 bytes long.
Its made of 3 parts:
* The program info header.
* The LFO table.
* The split table.

The program info header contains details for identifying the preset, and the size of the LFO and split table.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index of the pointer in "TableA" that points to this entry. Also correspond to instrument ID used in the corresponding SMDL file!
|-
| 0x02
| 2
| uint16
| nbsplits
| Nb of samples mapped to this presets, in the split table.
|-
| 0x04
| 1
| int8
| prgvol
| Volume of the entire program.
|-
| 0x05
| 1
| int8
| prgpan
| Pan of the entire program. (0-127, 64 is middle, 127 is full right, 0 is full left )
|-
| 0x06
| 1
| uint8
| unk3
| Most of the time 0x00.
|-
| 0x07
| 1
| uint8
| thatFbyte
| Most of the time 0x0F.
|-
| 0x08
| 2
| uint16
| unk4
| Most of the time is 0x200.
|-
| 0x0A
| 1
| uint8
| unk5
| Most of the time is 0x00.
|-
| 0x0B
| 1
| uint8
| nblfos
| Nb of entries in the LFO Table.
|-
| 0x0C
| 1
| uint8
| PadByte
| Most of the time is 0xAA, or 0x0. The value here is used as the delimiter and padding !
|-
| 0x0D
| 1
| uint8
| unk7
| Most of the time is 0x0.
|-
| 0x0E
| 1
| uint8
| unk8
| Most of the time is 0x0.
|-
| 0x0F
| 1
| uint8
| unk9
| Most of the time is 0x0.
|-
| 0x10
| (nblfos * 16)
| [[#LFOEntry|LFOEntry]][nblfos]
| LFOTbl
| Table that contains details on how to use the 4 LFOs with this preset.
|-
| After LFOTbl
| 16
| -
| Delimiter
| 16 bytes of "PadByte" padding bytes, possibly to delimit the start of the section below. Uses the value of PadByte as padding value!
|-
| After Delimiter
| (nbsplits * 48)
| [[#SplitEntry|SplitEntry]][nbsplits]
| SplitsTbl
| Table of samples splits mapped to this program.
|}

==== LFOEntry ====
These determine how to configure the 4 Low Frquency Oscillators (LFO) linked to this program.
It allows to set the shape of the waveform/the function that generate the value. The output of the LFO. The frequency, the depth, the delay, the fade-out. And what might be a resonance parameter(Q) with what might possibly be a low-pass filter.

Here's the structure of an entry:
{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| unk34
| Unknown, usually 0x00. It does seems to have an effect with a certain combination of other values in the other parameters.
|-
| 0x01
| 1
| uint8
| unk52
| Unknown, usually 0x00. (Posibly boolean to confirm its enabled) If is set to 0, the LFO corresponding to the entry is disabled.
|-
| 0x02
| 1
| uint8
| dest
| The destination of the LFO's output.
* 0x0 : none/disabled
* 0x1 : pitch
* 0x2 : volume
* 0x3 : pan
* 0x4 : lowpass/cutoff filter?
|-
| 0x03
| 1
| uint8
| wshape
| The shape/function of the waveform. (When the LFO is disabled, its always 1)
# Square
# Triangle?
# Sinus?
# ?
# Saw?
# Noise?
# Random
|-
| 0x04
| 2
| uint16
| rate
| Rate at which the LFO "oscillate". May or may not be in Hertz.
|-
| 0x06
| 2?
| uint16?
| unk29
| Changing the value seems to induce feedback or resonance. (Or perhaps its because it ended up corrupting the sound engine state when messing with the parameter?)
|-
| 0x08
| 2
| uint16
| depth
| The depth parameter of the LFO.
|-
| 0x0A
| 2
| uint16
| delay
| Delay in milliseconds before the LFO effect is applied after the sample begins playing.
|-
| 0x0C
| 2
| uint16
| unk32
| Unknown, usually 0x0000. Possibly fade-out in milliseconds.
|-
| 0x0E
| 2
| uint16
| unk33
| Unknown, usually 0x0000. Possibly an extra parameter? Or a cutoff/lowpass filter's frequency cutoff?
|}

==== SplitEntry ====
This represents a sample mapped to the preset. Those are played depending on certain conditions when a playnote event is received by the sequencer for that particular preset/program.
Some samples may be played only for a certain range of keys or velocities for example.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| -
| unk10
| A leading 0.
|-
| 0x01
| 1
| uint8
| id
| The Index of the sample in the SplitsTbl!
|-
| 0x02
| 1
| uint8
| unk11
| Unknown. Is always the same value as offset 0x1A below ! (Possibly "bend range" according to assumptions made from the DSE screenshots)
|-
| 0x03
| 1
| uint8
| unk25
| Unknown. Possibly a boolean.
|-
| 0x04
| 1
| int8
| lowkey
| Usually 0x00. Lowest MIDI Key this sample can play on.
|-
| 0x05
| 1
| int8
| hikey
| Usually 0x7F. Highest MIDI Key this sample can play on.
|-
| 0x06
| 1
| int8
| lovel
| Lowest note velocity the sample is played on.(0 - 127)
|-
| 0x07
| 1
| int8
| hivel
| Highest note velocity the sample is played on.(0 - 127)
|-
| 0x08
| 1
| int8
| unk14
| Usually 0x00.
|-
| 0x09
| 1
| int8
| unk47
| Usually 7F. If smaller than 0x7F the sample won't play...
|-
| 0x0A
| 2
| int16
| unk15
| Usually 0x00.
|-
| 0x0B
| 1
| int8
| unk48
| Usually 0x7F.
|-
| 0x0C
| 4
| -
| unk16
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x10
| 2
| -
| unk17
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| 0x12
| 2
| uint16
| SmplID
| The ID/index of sample in the "wavi" chunk's lookup table.
|-
| 0x14
| 1
| int8
| ftune
| Fine tune. The fine tune in cents.
|-
| 0x15
| 1
| int8
| ctune
| Coarse tuning. Default is -7.
|-
| 0x16
| 1
| int8
| rootkey
| Note at which the sample is sampled at !
|-
| 0x17
| 1
| int8
| ktps
| Key Transpose. Is basically the difference between rootkey and 60.
|-
| 0x18
| 1
| int8
| smplvol
| Volume of the sample.
|-
| 0x19
| 1
| int8
| smplpan
| Pan of the sample.
|-
| 0x1A
| 1
| uint8
| kgrpid
| Keygroup ID of the keygroup this split belongs to!
|-
| 0x1B
| 1
| uint8
| unk22
| Unknown, possibly a flag. Usually 0x02.
|-
| 0x1C
| 2
| uint16
| unk23
| Unknown, usually 0000.
|-
| 0x1E
| 2
| -
| unk24
| Usually the same value as "PadByte", or 0. Possibly padding ?
|-
| colspan="5"| '''Those last 16 bytes are for the volume envelope. They override the sample's original volume envelope!'''
|-
| 0x20
| 1
| uint8
| envon
| If not == 0, the volume envelope is processed. Otherwise its ignored.
|-
| 0x21
| 1
| uint8
| envmult
| If not == 0, is used as multiplier for envelope paramters, and the 16bits lookup table is used for parameter durations. If 0, the 32bits duration lookup table is used instead. This value has no effects on volume parameters, like sustain, and atkvol.
|-
| 0x22
| 1
| uint8
| unk37
| Unknown.
|-
| 0x23
| 1
| uint8
| unk38
| Unknown.
|-
| 0x24
| 2
| uint16
| unk39
| Unknown.
|-
| 0x26
| 2
| uint16
| unk40
| Unknown.
|-
| 0x28
| 1
| int8
| atkvol
| Sample volume envelope Attack Level.(0 to 127) Higher values towards 0x7F means the volume at which the attack phase begins at is louder. Doesn't shorten the attack time.
|-
| 0x29
| 1
| int8
| attack
| Sample volume envelope Attack.(0 to 127) Higher values towards 0x7F means the attack phase takes longer to reach full volume! 126 is ~10 seconds.
|-
| 0x2A
| 1
| int8
| decay
| Sample volume envelope Decay. (0 to 127) The duration the note has to be held until the volume is smoothly decreased to the value of "Sustain Volume". Higher values towards 0x7F means it takes longer before the held note's volume changes to "Sustain Volume".
|-
| 0x2B
| 1
| int8
| sustain
| Sample volume envelope Sustain.(0 to 127) The volume at which the held note will stay at. (Default 0x7F)
|-
| 0x2C
| 1
| int8
| hold
| Sample volume envelope Hold (0 to 127). Higher values towards 0x7F means the note is held at full volume longer after the attack phase. 126 is ~10 seconds. 0x7F, does the same as 0.
|-
| 0x2D
| 1
| int8
| decay2
| Sample volume envelope Decay2 (0 to 127). Higher values towards 0x7F means longer fade-out. 0x7F means never fade-out. (Default 0x7F) At 0x7E, it takes ~8 seconds for the volume to reach 0.
|-
| 0x2E
| 1
| int8
| release
| Sample volume envelope Release parameter(0 to 127). Higher values towards 0x7F means longer release. Negative values mirror positive range. (Default is 0x28(40))
|-
| 0x2F
| 1
| int8
| unk53
| Usually 0xFF.
|}

=== kgrp Chunk ===
----
The kgrp chunk contains a list of all the keygroups in use in this SWDL.
Its not known yet how keygroups work, but it appears its a set of properties that can be assigned to splits of every programs that overrides some of those splits' parameters, determine their max polyphony, their volume, their "priority" and a few other things.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "kgrp" {0x6B, 0x67, 0x72, 0x70}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| [[#Keygroup|Keygroup]][]
| Keygroups
| A table containing all the keygroups used in the SWDL. The first entry is usually the global Keygroup, of which most splits are part of.
|-
| After Keygroups
| 0 or 8
| -
| Padding?
| When there is an odd number of Keygroup entry, it appears there is some garbage(?) inserted here to make the next chunk start on an offset divisible by 16.
|}

==== Keygroup ====
A single entry in the Keygroups table.

This is meant to mitigate issues with the limited polyphony of the NDS.
Basically, this is used to tell what sets of instruments gets to play notes over the others.
(Wikipedia has an excellent article on synthesizer polyphony here: https://en.wikipedia.org/wiki/Polyphony_and_monophony_in_instruments )

* The polyphony parameter allows to set how many simultaneous voices a member of the keygroup may use.
* The vc high and vc low parameters defines the range out of all the available voice channels that members of the group may use.
* The priority parameter is meant to tell which keygroups has priority over using a voice channel.

For example, if a split "splitA" is a member of a priority 1 keygroup, and another split "splitB" of a priority 15 keygroups, and there is no voice channel available to use as they're all being used. SplitB needs to play a note, but splitA is currently playing one. Then SplitA will be cut abruptly, and its voice channel will be reassigned to splitB so it can play its note!

Keygroup 0 is the global keygroup everything uses by default, and its always there.

{| class="wikitable"
|+ Total Length 8 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 2
| uint16
| ID
| Index/ID of the keygroup.
|-
| 0x02
| 1
| uint8
| poly
| Polyphony. AKA max number of simultaneous notes played. 0 to 15. -1 means disabled.
|-
| 0x03
| 1
| uint8
| priority
| Priority over the assignment of a voice channel for the members of this group. A value from 0 to possibly 99. Default is 8. Lower values means lower priority, while higher means higher priority.
|-
| 0x04
| 1
| uint8
| vclow
| Lowest voice channel of the range this group may use. Usually between 0 to 15.
|-
| 0x05
| 1
| uint8
| vchigh
| Highest voice channel this group may use. Usually between 0 to 15.
|-
| 0x06
| 1
| uint8
| unk50
| Unknown.
|-
| 0x07
| 1
| uint8
| unk51
| Unknown.
|}

=== pcmd Chunk ===
----
The pcmd chunk contains the sample data for every samples. Each samples is stored one after the other, regardless of the sample type or sample rate, without headers or delimiters of any sort! Each samples is located by using the sample entries in the wavi chunk.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "pcmd" {0x70, 0x63, 0x6D, 0x64}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field
|-
| 0x10
| Varies
| -
| SampleDataBlob
| Contains the sample data for all the samples used in the SWDL.
|}

The data can be stored in any of the compatible formats:
* The NDS's 4 bits IMA ADPCM encoding (Same as official IMA ADPCM. Even uses the same tables. only the way sample values are clamped when converting back to PCM16 differ a tiny bit, which might not even be noticeable.)
* raw PCM16 samples.
* raw PCM8 samples ?
* Possibly PSG or something else ?

'''Note About ADPCM:'''
* Each ADPCM sample begins with the initial value of the "predictor" on 16 bits. Then the "step index", also on 16 bits. Afterwards, comes the actual sample data.
* The ADPCM preamble is included in the value of the "loopbeg" parameter of the sample!

=== Eod Chunk ===
----
This chunk marks the the end of the SWDL container/file. There is nothing past the chunk header!

{| class="wikitable"
|+ Total Length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| "eod\20" {0x65, 0x6F, 0x64, 0x20}
|-
| 0x04
| 2
| uint16
| unk1
| Always 0.
|-
| 0x06
| 2
| uint16
| unk2
| Always 0x1504.
|-
| 0x08
| 4
| uint32
| chunkbeg
| Seems to always be 0x10, possibly the start of the chunk data.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the chunk data. Begins counting right after this field. Always 0 for eod chunk!
|}

== Volume Envelopes ==
Here is some more information on how volume envelopes are parsed.

In PMD2 Explorers of Sky, the north american version, here are the routines at runtime in memory that handle parsing the envelopes:
* 0x02074E0C : Code that picks an envelope's starting phase.
* 0x02074F54 : Code that handles updating the envelope's state.
* 0x02074D58 : Code handling lerping the volume values for any of the envelope parameters indicating a duration.

The parameters indicating a duration in the envelopes are used as indices in one of 2 lookup tables to get an actual duration.
If the "envmult" parameter of the envelope is not 0, the 16 bits lookup table is used, while if its 0, the 32 bits lookup table is used.

Here's a heavily commented and re-organized assembly snippet to demonstrate how the duration lookup tables are used, and how a single parameter is parsed:

Fun_02074D58( R0(SplitEnvelopeAddress), R1(TargetVolume), R2(EnvelopeParam) )
{
02074D58 E92D4038 push r3-r5,r14
02074D5C E1A05000 mov r5,r0
02074D60 E1A04001 mov r4,r1
02074D64 E352007F cmp r2,7Fh //See if the envelope parameter is == 0x7F
02074D68 1A000004 bne 02074D80
if( EnvelopeParam != 0x7F )
{
02074D80 E5C5401D strb r4,[r5,1Dh] //Put the TargetVolume here
02074D84 E5D53001 ldrb r3,[r5,1h] //Load envmult
02074D88 E3530000 cmp r3,0h
02074D8C 1A000007 bne 02074DB0
if( envmult != 0 )
{
02074DB0 E59F0050 ldr r0,=20B0F50h //16 bits lookup table for durations
02074DB4 E1A01082 mov r1,r2,lsl 1h //R1 = EnvelopeParam << 1 (Basically, multiply by 2 the envelope param, so that we get a byte offset in a 16bits integer array)
02074DB8 E19020B1 ldrh r2,[r0,r1] //Get the duration from the table
02074DBC E59F1040 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074DC0 E3A00FFA mov r0,3E8h
02074DC4 E0020293 mul r2,r3,r2 //We multiply the duration with envmult (the envelope duration multiplier)
02074DC8 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DCC E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DD0 EB006C33 bl 0208FEA4 //(Division signed R0 = R0 / R1)
//Continues to 02074DD4..
}
else
{
02074D90 E59F0068 ldr r0,=20B1050h //32 bits lookup table for durations
02074D94 E59F1068 ldr r1,=22B7330h //That's the static address of DSE driver's memory
02074D98 E7902102 ldr r2,[r0,r2,lsl 2h] //Multiply the EnvelopeParam by 4( EnvelopeParam << 2 ) to get the byte offset in a int32 array
02074D9C E3A00FFA mov r0,3E8h
02074DA0 E0000092 mul r0,r2,r0 //We multiply our duration by 1000
02074DA4 E1D112F8 ldrsh r1,[r1,28h] //This address always contains the value 10000
02074DA8 EB006CC0 bl 020900B0 //(Unsigned division R0 = R0 / R1)
02074DAC EA000008 b 02074DD4
//Continues to 02074DD4..
}
02074DD4 E5850018 str r0,[r5,18h] //Put EnvelopePhaseTimeLeft here
02074DD8 E5951018 ldr r1,[r5,18h] //Read it back into R1
02074DDC E3510000 cmp r1,0h
if( EnvelopePhaseTimeLeft == 0 )
{
02074DE0 03A00000 moveq r0,0h
02074DE4 05850014 streq r0,[r5,14h] //Set VolumeIncrement to 0
02074DE8 08BD8038 popeq r3-r5,r15 //Return
}
02074DEC E5950010 ldr r0,[r5,10h] //Load EnvPhaseCurrentVolume
02074DF0 E0600B84 rsb r0,r0,r4,lsl 17h // (TargetVolume << 0x17) - EnvPhaseCurrentVolume, or (2^23 * TargetVolume) - EnvPhaseCurrentVolume
02074DF4 EB006C2A bl 0208FEA4 //(Division signed R0 = R0 / R1) Divide volume difference between TargetVolume and EnvPhaseCurrentVolume by the EnvelopePhaseTimeLeft
02074DF8 E5850014 str r0,[r5,14h] //Set VolumeIncrement
02074DFC E8BD8038 pop r3-r5,r15
}
else
{
//Envelope param disabled
02074D6C E3A00000 mov r0,0h
02074D70 E5850014 str r0,[r5,14h] //Set the VolumeIncrement to 0
02074D74 E2400106 sub r0,r0,80000001h //This basically puts 0x7FFFFFFF into R0 (Aka the maximum signed, positive value for a signed 16bits integer )
02074D78 E5850018 str r0,[r5,18h] //Put 0x7FFFFFFF as EnvelopePhaseTimeLeft
02074D7C E8BD8038 pop r3-r5,r15
}
}

==== Duration Lookup Tables ====

'''16 bits table located at 0x020B0F50:'''
const int16_t Lookup_Table_20B0F50 [128] =
{
0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
0x0020, 0x0023, 0x0028, 0x002D, 0x0033, 0x0039, 0x0040, 0x0048,
0x0050, 0x0058, 0x0062, 0x006D, 0x0078, 0x0083, 0x0090, 0x009E,
0x00AC, 0x00BC, 0x00CC, 0x00DE, 0x00F0, 0x0104, 0x0119, 0x012F,
0x0147, 0x0160, 0x017A, 0x0196, 0x01B3, 0x01D2, 0x01F2, 0x0214,
0x0238, 0x025E, 0x0285, 0x02AE, 0x02D9, 0x0307, 0x0336, 0x0367,
0x039B, 0x03D1, 0x0406, 0x0442, 0x047E, 0x04C4, 0x0500, 0x0546,
0x058C, 0x0622, 0x0672, 0x06CC, 0x071C, 0x0776, 0x07DA, 0x0834,
0x0898, 0x0906, 0x096A, 0x09D8, 0x0A50, 0x0ABE, 0x0B40, 0x0BB8,
0x0C3A, 0x0CBC, 0x0D48, 0x0DDE, 0x0E6A, 0x0F00, 0x0FA0, 0x1040,
0x10EA, 0x1194, 0x123E, 0x12F2, 0x13B0, 0x146E, 0x1536, 0x15FE,
0x16D0, 0x17A2, 0x187E, 0x195A, 0x1A40, 0x1B30, 0x1C20, 0x1D1A,
0x1E1E, 0x1F22, 0x2030, 0x2148, 0x2260, 0x2382, 0x2710, 0x7FFF
};

'''32 bits table located at 0x20B1050:'''
const int32_t Lookup_Table_20B1050 [128] =
{
0x00000000, 0x00000004, 0x00000007, 0x0000000A,
0x0000000F, 0x00000015, 0x0000001C, 0x00000024,
0x0000002E, 0x0000003A, 0x00000048, 0x00000057,
0x00000068, 0x0000007B, 0x00000091, 0x000000A8,
0x00000185, 0x000001BE, 0x000001FC, 0x0000023F,
0x00000288, 0x000002D6, 0x0000032A, 0x00000385,
0x000003E5, 0x0000044C, 0x000004BA, 0x0000052E,
0x000005A9, 0x0000062C, 0x000006B5, 0x00000746,
0x00000BCF, 0x00000CC0, 0x00000DBD, 0x00000EC6,
0x00000FDC, 0x000010FF, 0x0000122F, 0x0000136C,
0x000014B6, 0x0000160F, 0x00001775, 0x000018EA,
0x00001A6D, 0x00001BFF, 0x00001DA0, 0x00001F51,
0x00002C16, 0x00002E80, 0x00003100, 0x00003395,
0x00003641, 0x00003902, 0x00003BDB, 0x00003ECA,
0x000041D0, 0x000044EE, 0x00004824, 0x00004B73,
0x00004ED9, 0x00005259, 0x000055F2, 0x000059A4,
0x000074CC, 0x000079AB, 0x00007EAC, 0x000083CE,
0x00008911, 0x00008E77, 0x000093FF, 0x000099AA,
0x00009F78, 0x0000A56A, 0x0000AB80, 0x0000B1BB,
0x0000B81A, 0x0000BE9E, 0x0000C547, 0x0000CC17,
0x0000FD42, 0x000105CB, 0x00010E82, 0x00011768,
0x0001207E, 0x000129C4, 0x0001333B, 0x00013CE2,
0x000146BB, 0x000150C5, 0x00015B02, 0x00016572,
0x00017015, 0x00017AEB, 0x000185F5, 0x00019133,
0x0001E16D, 0x0001EF07, 0x0001FCE0, 0x00020AF7,
0x0002194F, 0x000227E6, 0x000236BE, 0x000245D7,
0x00025532, 0x000264CF, 0x000274AE, 0x000284D0,
0x00029536, 0x0002A5E0, 0x0002B6CE, 0x0002C802,
0x000341B0, 0x000355F8, 0x00036A90, 0x00037F79,
0x000394B4, 0x0003AA41, 0x0003C021, 0x0003D654,
0x0003ECDA, 0x000403B5, 0x00041AE5, 0x0004326A,
0x00044A45, 0x00046277, 0x00047B00, 0x7FFFFFFF
};

== Credits ==

Dse swdl

2015-10-15T02:02:11Z

Psy commando: /* Keygroup */

Dse swdl

2015-10-15T01:58:43Z

Psy commando: Added most of the missing info!

Dse swdl

2015-10-15T01:26:30Z

Psy commando: Initial publish of the SWDL page.

Dse smdl

2015-10-14T22:11:07Z

Psy commando: /* Eoc Chunk */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
The EoC chunk marks the end of the SMDL file/container.

{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-10-14T22:09:50Z

Psy commando: /* DSE Events */ reworded a bit the part about the event codes

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with events. Each event starts by a single byte containing a code, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Values from 0x0 to 0x7F are reserved for the PlayNote event.
* Values from 0x80 to 0x8F are reserved for fixed duration pause events.
* Values from 0x90 to 0xFF all have their unique event assigned to them.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-26T23:10:33Z

Psy commando: /* Song Chunk */ fixed ambiguity

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note? Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.) Or possibly just the tick rate..
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-26T23:05:57Z

Psy commando: /* Example */ fixed

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T02:25:46Z

Psy commando:

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (In short, it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes [[#Fixed Duration Pause(0x80 to 0x8F)|fixed duration pauses]])
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T02:21:53Z

Psy commando: /* Fixed Duration Pause(0x80 to 0x8F) */ Added mention of some note durations possibly matching a note's duration as part of a triplet.

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (In short, it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note (Half Note as part of a triplet?)
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note (Quarter Note as part of a triplet?)
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note (8th Note as part of a triplet?)
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note (16th Note as part of a triplet?)
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note (32th Note as part of a triplet?)
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T02:13:38Z

Psy commando: /* Example */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
Here's an example "Events" section (In short, it does not include the preamble and header):
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T02:12:15Z

Psy commando: /* Events */ added a little example

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events themselves are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

===== Example =====
This is a complete event section for example:
E3 73 A4 82 93 E0 1F 98
It ends on an offset divisible by 4, so there is only a single 0x98 event at the end.

Here's what would happen if we'd add an extra events. Lets copy the 0xE3 event and its parameter once:
E3 73 E3 73 A4 82 93 E0 1F 98 98 98
..we needed to add 2 extra 0x98 events to make the track end on an offset divisible by 4!

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T02:01:50Z

Psy commando:

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
----
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
----
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
----
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

:The content begins immediately after the header!

==== Preamble ====
:Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
:All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events are not aligned on 4 bytes.

:{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

=== Eoc Chunk ===
----
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T01:53:43Z

Psy commando: /* File Structure */

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

The content begins immediately after the header!

==== Preamble ====
Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|}

==== Events ====
All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes. Events are not aligned on 4 bytes.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| After Preamble
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

=== Eoc Chunk ===
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T01:48:55Z

Psy commando: Filled up track chunk details

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
The song chunk is made of a single header.

{| class="wikitable"
|+ Song Chunk Header ( Total length 64 bytes )
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
Track chunks contain the events for each individual tracks of the music sequence. They work much like MIDI tracks.

==== Header ====

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Track chunk label "trk\0x20" {0x74,0x72,0x6B,0x20}
|-
| 0x04
| 4
| uint32
| param1
| Unknown. Usually 0x01000000.
|-
| 0x08
| 4
| uint32
| param2
| Unknown. Usually 0x0000FF04.
|-
| 0x0C
| 4
| uint32
| chunklen
| Length of the trk chunk. Starting after this field, to the first 0x98 event encountered in the track. The length is in bytes.
|}

The content begins immediately after the header!

==== Content ====
Each tracks has a short preamble after the header, and before the actual events. That preamble indicates the channel and the track id assigned to the track.

All tracks must have a 0x98 event at their end. And the size of a track is counted up to that event, ignoring the padding bytes.

{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 1
| uint8
| trkid
| The track ID of the track. A number between 0 and 0x11.
|-
| 0x01
| 1
| uint8
| chanid
| The channel ID of the track. A number between 0 and 0x0F?.
|-
| 0x02
| 1
| uint8
| unk1
| Unknown. Often 0.
|-
| 0x03
| 1
| uint8
| unk2
| Unknown. Often 0.
|-
| 0x04
| varies
| -
| events
| Track events begin here.
|-
| After Events
| 0-3
| -
| Padding
| Padding to align the end of the track on 4 bytes. The value is usually the terminating 0x98 byte repeated as needed, up to 3 extra times.
|}

=== Eoc Chunk ===
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]

Dse smdl

2015-09-25T01:24:19Z

Psy commando: Filled Song chunk header

[[Category:Incomplete Articles]]
[[Category:ROM Hacking]]
[[Category:Technical References]]
[[Category:Pokemon Mystery Dungeon Series]]
[[Category:Audio]]
{{DISPLAYTITLE:DSE SMDL Format}}

== General Information ==
The SMDL format is a container for sequenced music. Its very close to the MIDI format, similarly to the [[SSEQ]] format normally used in most NDS games.

== File Structure ==

=== Overview ===
{| class="wikitable"
! Offset
! Length
! Name
! Description
|-
| 0x0
| 64
| [[#SMDL Header|SMDLHeader]]
| The container's header.
|-
| 0x40
| 64
| [[#Song Chunk|Song Chunk]]
| Information on the entire sequence.
|-
| After Song Chunk
| Varies
| [[#Trk Chunk|Trk Chunk]]
| The first Track of the sequence. Its role is to set the tempo.
|-
| colspan="4"|..Additional tracks here..
|-
| After all Track Chunks
| 16
| [[#Eoc Chunk|End of Content Chunk]]
| This empty chunk marks the end of the SMDL container.
|}

=== SMDL Header ===
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| magicn
| The 4 characters "smdl" {0x73,0x6D,0x64,0x6C}
|-
| 0x04
| 4
| -
| unk7
| 4 bytes of zeroes.
|-
| 0x08
| 4
| uint32
| flen
| File length in bytes.
|-
| 0x0C
| 2
| uint16
| version?
| Version number? ( 0x1504 )
|-
| 0x0E
| 1
| uint8
| unk1
| Unknown.
|-
| 0x0F
| 1
| uint8
| unk2
| Unknown.
|-
| 0x10
| 4
| -
| unk3
| 4 bytes of zeroes.
|-
| 0x14
| 4
| -
| unk4
| 4 bytes of zeroes.
|-
| 0x18
| 2
| uint16
| year
| Year the file was last modified.
|-
| 0x1A
| 1
| uint8
| month
| Month the file was last modified.
|-
| 0x1B
| 1
| uint8
| day
| Day the file was last modified.
|-
| 0x1C
| 1
| uint8
| hour
| Hour the file was last modified.
|-
| 0x1D
| 1
| uint8
| minute
| Minute the file was last modified.
|-
| 0x1E
| 1
| uint8
| second
| Second the file was last modified.
|-
| 0x1F
| 1
| uint8
| centisecond?
| Could possibly be the centisecond that the file was last modified.
|-
| 0x20
| 16
| char[16]
| fname
| Filename, ASCII null terminated string. Any extra space after the 0 on the total 16 bytes, is padded with 0xAA.
|-
| 0x30
| 4
| uint32
| unk5
| Unknown, usually 0x1.
|-
| 0x34
| 4
| uint32
| unk6
| Unknown, usually 0x1.
|-
| 0x38
| 4
| uint32
| unk8
| Unknown, usually 0xFFFFFFFF.
|-
| 0x3C
| 4
| uint32
| unk9
| Unknown, usually 0xFFFFFFFF.
|}

=== Song Chunk ===
{| class="wikitable"
|+ Total length 64 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x00
| 4
| char[4]
| label
| Song chunk label "song" {0x73,0x6F,0x6E,0x67}
|-
| 0x04
| 4
| uint32
| unk1
| Unknown. Usually 0x1.
|-
| 0x08
| 4
| uint32
| unk2
| Unknown. Usually 0xFF10.
|-
| 0x0C
| 4
| uint32
| unk3
| Unknown. Usually 0xFFFFFFB0.
|-
| 0x10
| 2
| uint16
| unk4
| Unknown. Usually 0x1.
|-
| 0x12
| 2
| uint16
| tpqn
| Ticks Per Quarter Note. Usually 0x30 or 48 ticks per quarter note. (Works like MIDI clock ticks it seems.)
|-
| 0x14
| 2
| uint16
| unk5
| Unknown. Usually 0xFF01
|-
| 0x16
| 1
| uint8
| nbtrks
| Number of track(trk) chunks
|-
| 0x17
| 1
| uint8
| nbchans
| Number of channels. (Unsure how channels works with DSE)
|-
| 0x18
| 4
| uint32
| unk6
| Unknown. Usually 0x0F000000
|-
| 0x1C
| 4
| uint32
| unk7
| Unknown. Usually 0xFFFFFFFF
|-
| 0x20
| 4
| uint32
| unk8
| Unknown. Usually 0x40000000
|-
| 0x24
| 4
| uint32
| unk9
| Unknown. Usually 0x00404000
|-
| 0x28
| 2
| uint16
| unk10
| Unknown. Usually 0x0200
|-
| 0x2A
| 2
| uint16
| unk11
| Unknown. Usually 0x0800
|-
| 0x2C
| 4
| uint21
| unk12
| Unknown. Usually 0xFFFFFF00
|-
| 0x30
| 16
| -
| unkpad
| Unknown sequence of 16, 0xFF bytes. Possibly padding?
|}

=== Trk Chunk ===
{| class="wikitable"
! Offset
! Length
! Type
! Name
! Description
|-
|}

=== Eoc Chunk ===
{| class="wikitable"
|+ Total length 16 bytes
! Offset
! Length
! Type
! Name
! Description
|-
| 0x0
| 4
| -
| ChunkID
| The chunk ID "eoc\0x20" {0x65, 0x6F, 0x63, 0x20}
|-
| 0x4
| 4
| uint32
| Param1
| Unknown meaning, is often 0x00000001.
|-
| 0x8
| 4
| uint32
| Param2
| Unknown meaning, is often 0x04FF0000.
|-
| 0xC
| 4
| uint32
| Length
| Always 0, for end of content chunks.
|}

== DSE Events ==
Tracks are filled with event codes, which indicates to the sequencer what to do.
* Their value ranges from 0x0 to 0xFF.
* Events from 0x0 to 0x7F are reserved for the PlayNote event.
* Events from 0x80 to 0x8F are reserved for fixed duration pause events.
* Events from 0x90 to 0xFF all have their unique meaning.

=== PlayNote(0x0 to 0x7F) ===
The play note event is special in that its format is particular.
* The event code itself is the velocity(0x0 - 0x7F) of the note to be played.
* The first parameter byte is obligatory, and it contains info on whether we modify the track's current octave, how many extra parameters are there, and what note to play.
* The second parameter is optional, and its length varies depending on the length specified in the obligatory parameter. It contains the duration the key is "held down" before being released.

Here's a breakdown of the NoteData byte:
{| class="wikitable"
! Bits
! Name
! Meaning
|-
| 1100 0000
| OctaveMod
| A value from 0 to 3 from which 2 is subtracted. The result is a signed value that we add to the track's current octave.
|-
| 0011 0000
| NbParamBytes
| A value from 0 to 3 which indicates the amount of extra parameter bytes that should be read.
|-
| 0000 1111
| Note
| The [[#Note List|Note]] that should be played at the track's current octave(after OctaveMod).
|}

==== Note List ====
{|class="wikitable"
! Value
! Note Name
|-
| 0x0
| C
|-
| 0x1
| C#
|-
| 0x2
| D
|-
| 0x3
| D#
|-
| 0x4
| E
|-
| 0x5
| F
|-
| 0x6
| F#
|-
| 0x7
| G
|-
| 0x8
| G#
|-
| 0x9
| A
|-
| 0xA
| A#
|-
| 0xB
| B
|-
| 0xF
| Unknown
|}

==== Example Event ====
{| class="wikitable"
! Velocity
! NoteData
!colspan="3"|(Opt)KeyDownDuration
|-
| 0x7F
| 0x65
| 0x20
| 0x01
| 0x10
|}

This event will play the note F, at the current track octave with no modifications, and hold the note for 0x100120 ticks.

=== Fixed Duration Pause(0x80 to 0x8F) ===
The fixed duration pause is a pause event based on the duration of common musical time intervals. Its event code goes from 0x80-0x8F.

Here's a table of the possible durations:

{|class="wikitable"
! Code
! Musical Time Interval
! Duration in Ticks
|-
| 0x80
| Half Note
| 96
|-
| 0x81
| Dotted Quarter Note
| 72
|-
| 0x82
| 2/3 of a Half Note
| 64
|-
| 0x83
| Quarter Note
| 48
|-
| 0x84
| Dotted 8th Note
| 36
|-
| 0x85
| 2/3 of a Quarter Note
| 32
|-
| 0x86
| 8th Note
| 24
|-
| 0x87
| Dotted 16th Note
| 18
|-
| 0x88
| 2/3 of a 8th Note
| 16
|-
| 0x89
| 16th Note
| 12
|-
| 0x8A
| Dotted 32nd Note
| 9
|-
| 0x8B
| 2/3 of a 16th Note
| 8
|-
| 0x8C
| 32nd Note
| 6
|-
| 0x8D
| Dotted 64th Note
| 4
|-
| 0x8E
| 2/3 of a 32nd Note
| 3
|-
| 0x8F
| 64th Note
| 2
|}

=== Others(0x90 to 0xFF) ===
Here is a list of all known events :

{| class="wikitable"
! Code
! Parameter Length
! Parameters
! Name
! Description
|-
| 0x90
| 0
| -
| RepeatLastPause
| Pause the track processing for the duration of the last pause.(Includes fixed duration pauses)
|-
| 0x91
| 1
| (uint8)Duration
| AddToLastPause
| Pause the track processing for the duration of the last pause + the duration in ticks specified.(Includes fixed duration pauses)
|-
| 0x92
| 1
| (uint8)Duration
| Pause8Bits
| Pause the track processing for the duration in ticks.
|-
| 0x93
| 2
| (uint16)Duration
| Pause16Bits
| Pause the track processing for the duration in ticks.
|-
| 0x94
| 3
| (uint24)Duration
| Pause24Bits
| Pause the track processing for the duration in ticks.
|-
| 0x95
| 1
| (uint8)CheckInterval
| PauseUntilRelease
| Pause the track processing as long as a note is held down. Will wait for at least "CheckInterval" ticks, then checks every "CheckInterval" ticks if all notes have been released on the current track.
|- style="background-color:#D1D1D1;"
| 0x96
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x97
| 0
| -
| INVALID
| Disable current track.
|-
| 0x98
| 0
| -
| EndOfTrack
| Marks the end of the track. Is also used as padding to align the end of the track on 4 bytes.
|-
| 0x99
| 0
| -
| LoopPoint
| Marks the point the track will loop to after the end of track is reached.
|- style="background-color:#D1D1D1;"
| 0x9A
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0x9B
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0x9C
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9D
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0x9E
| 0
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0x9F
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA0
| 1
| (uint8)Octave
| SetTrackOctave
| Sets the current track's octave to the value specified. Valid range is 0 - 9.
|-
| 0xA1
| 1
| (uint8)Octave
| AddToTrackOctave
| Adds the value specified to the current track octave.
|- style="background-color:#D1D1D1;"
| 0xA2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA3
| 0
| -
| INVALID
| Disable current track.
|-
| 0xA4
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute.
|-
| 0xA5
| 1
| (uint8)TempoBPM
| SetTempo
| Sets the track's tempo in beats per minute? (The code is identical to 0xA4)
|- style="background-color:#D1D1D1;"
| 0xA6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xA7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xA8
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xA9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xAA
| 1
| ??
| ??
| ??
|-
| 0xAB
| 0
| -
| SkipNextByte
| Skips processing the next byte.
|-
| 0xAC
| 1
| (uint8)ProgramID
| SetProgram
| Change the track's program(Instrument Preset) to the one specified.
|- style="background-color:#D1D1D1;"
| 0xAD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xAE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xAF
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB0
| 0
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB3
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB4
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB5
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xB6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xB7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xB9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xBB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBC
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xBD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xBE
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xBF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xC0
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC1
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC2
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xC3
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xC4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC8
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xC9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCA
| 0
| -
| INVALID
| Disable current track.
|-
| 0xCB
| 2
| -
| SkipNext2Bytes
| Skip processing the next 2 bytes.
|- style="background-color:#D1D1D1;"
| 0xCC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xCF
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xD0
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD2
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD3
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD4
| 3
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD5
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xD6
| 2
| ??
| ??
| ??
|-
| 0xD7
| 2
| (uint16)Bend
| PitchBend
| Bend the pitch of the note.
|- style="background-color:#DDEDE4;"
| 0xD8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xD9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xDA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDB
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xDD
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xDE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xDF
| 1
| ??
| ??
| ??
|-
| 0xE0
| 1
| (int8)TrackVolume
| SetTrackVolume
| Change the track's volume to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE1
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE2
| 3
| ??
| ??
| ??
|-
| 0xE3
| 1
| (int8)TrackExpression
| SetTrackExpression
| Change the track's expression(secondary volume) to the value specified. (0x0-0x7F)
|- style="background-color:#DDEDE4;"
| 0xE4
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xE5
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xE6
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xE7
| 1
| ??
| ??
| ??
|-
| 0xE8
| 1
| (int8)Pan
| SetTrackPan
| Change the track's pan to the value specified. (0x0-0x7F. 0x40 is middle, 0x0 full left, and 0x7F full right )
|- style="background-color:#DDEDE4;"
| 0xE9
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xEA
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEC
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xED
| 4
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xEE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xEF
| 1
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF0
| 5
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF1
| 4
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF2
| 2
| ??
| ??
| ??
|- style="background-color:#DDEDE4;"
| 0xF3
| 3
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF4
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xF5
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF6
| 1
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF7
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#DDEDE4;"
| 0xF8
| 2
| ??
| ??
| ??
|- style="background-color:#D1D1D1;"
| 0xF9
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFA
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFB
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFC
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFD
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFE
| 0
| -
| INVALID
| Disable current track.
|- style="background-color:#D1D1D1;"
| 0xFF
| 0
| -
| INVALID
| Disable current track.
|}

== Credits ==
* TruePikachu for some of the details on the SMDL format! [http://projectpokemon.org/forums/member.php?51393-TruePikachu]