Difference between revisions of "CMDL (Tropical Freeze)"

From Retro Modding Wiki
Jump to: navigation, search
m
(→‎Format)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
The '''CMDL, SMDL, and WMDL''' format are Tropical Freeze's three model formats; CMDL is a generic model format, SMDL is for skinned models, and WMDL is for world (terrain) models. All three are the same basic format, with SMDL and WMDL each containing an extra data section at the start of the file. With the Wii U's graphics system being updated from GX to GX2, the Retro model format has been dramatically overhauled, bearing little to no resemblance to the previous CMDL format found in DKCR and the Prime series.
+
''See [[CMDL (File Format)]] for the other revisions of this format.''
  
−
{{researchmoderate|There's still a lot of unknown data. The entire optional section at the end of HEAD is completely unknown to me and there's lots of scattered unknown values.}}
+
Tropical Freeze features a new model format (necessitated by the hardware jump from Wii to Wii U) that bears little-to-no resemblance to the CMDL format of past games. There are three extensions used for models:
−
{{todo|Material structure is known, just need to document it. These should probably stay on this page for now.}}
+
 
 +
* '''CMDL''': Generic models
 +
* '''SMDL''': Skinned models (ie. animated characters)
 +
* '''WMDL''': World models (ie. level geometry)
 +
 
 +
All three share the same basic format, with SMDL and WMDL each containing an extra data chunk at the start of the file.
 +
 
 +
{{research|2|There's a lot of unknown data.}}
  
 
__TOC__
 
__TOC__
Line 8: Line 15:
 
== Format ==
 
== Format ==
  
−
After the [[RFRM Header]], the first section of the file is SKHD in SMDL, and WDHD in WMDL. Following those extra sections, all three formats start with a header.
+
File layout:
  
−
=== HEAD ===
+
{| class="wikitable"
 +
! Type/Name
 +
! Notes
 +
|-
 +
| [[Form Descriptor (Tropical Freeze)|Form Descriptor]]
 +
| Form ID is <code>CMDL</code>, <code>SMDL</code>, or <code>WMDL</code>.
 +
|-
 +
| [[#Skinned Model Header|Skinned Model Header]]
 +
| '''Only present in SMDL files'''
 +
|-
 +
| [[#World Model Header|World Model Header]]
 +
| '''Only present in WMDL files'''
 +
|-
 +
| [[#Model Header|Model Header]]
 +
|
 +
|-
 +
| [[#Material Data|Material Data]]
 +
|
 +
|-
 +
| [[#Render Meshes|Render Meshes]]
 +
|
 +
|-
 +
| [[#Vertex Buffers|Vertex Buffers]]
 +
|
 +
|-
 +
| [[#Index Buffers|Index Buffers]]
 +
|
 +
|-
 +
| [[#GPU Data|GPU Data]]
 +
|
 +
|}
 +
 
 +
=== Skinned Model Header ===
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 24
+
| [[Chunk Descriptor (Tropical Freeze)|Chunk Descriptor]]
−
| '''"HEAD" [[Section Header (Tropical Freeze)|section header]]
+
| 1
 +
| '''SKHD Chunk Descriptor'''
 +
| Data type is <code>SKHD</code>
 
|-
 
|-
 
| 0x18
 
| 0x18
−
| 4
+
| u32
−
| {{unknown|'''Unknown'''}}
+
| 1
 +
| {{unknown|Unknown}}
 +
|
 
|-
 
|-
 
| 0x1C
 
| 0x1C
−
| 4
+
| colspan=5 {{unknown|End of Skinned Model Header}}
−
| {{unknown|'''Unknown'''}}
+
|}
 +
 
 +
=== World Model Header ===
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| [[Chunk Descriptor (Tropical Freeze)|Chunk Descriptor]]
 +
| 1
 +
| '''WDHD Chunk Descriptor'''
 +
| Chunk ID is <code>WDHD</code>
 +
|-
 +
| u8
 +
| 1
 +
| {{unknown|Unknown}}
 +
|
 +
|-
 +
| [[#Render Octree|Render Octree]]
 +
| 1
 +
| '''Render Octree'''
 +
|
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown AABox Count}}
 +
|
 +
|-
 +
| {{AABox}}
 +
| ''Unknown AABox Count''
 +
| {{unknown|Unknown AABox Array}}
 +
|
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Float Count}}
 +
|
 +
|-
 +
| float
 +
| ''Unknown Float Count''
 +
| {{unknown|Unknown Float Array}}
 +
|
 +
|}
 +
 
 +
==== Render Octree ====
 +
 
 +
This seems to be an updated version of the [[AROT (MREA Section)|AROT]] format seen in previous Retro games.
 +
 
 +
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| 0x0
 +
| {{FourCC}}
 +
| 1
 +
| '''Magic'''
 +
| Always <code>AROT</code> (Area Octree)
 +
|-
 +
| 0x4
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
| Always 1. Version number?
 +
|-
 +
| 0x8
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
|
 +
|-
 +
| 0xC
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
|
 +
|-
 +
| 0x10
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
|
 +
|-
 +
| 0x14
 +
| {{AABox}}
 +
| 1
 +
| '''Octree Bounding Box'''
 +
| Bounds of the entire octree; matches the bounding box from the main model header.
 +
|-
 +
| 0x2C
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count A}}
 +
|
 +
|-
 +
| 0x30
 +
| u32
 +
| ''Unknown Count A''
 +
| {{unknown|Unknown Array A}}
 +
|
 +
|-
 +
| {{none}}
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count B}}
 +
|
 +
|-
 +
| {{none}}
 +
| u8
 +
| ''Unknown Count B''
 +
| {{unknown|Unknown Array B}}
 +
|
 +
|-
 +
| {{none}}
 +
| u32
 +
| 1
 +
| {{unknown|Unknown AABox Count}}
 +
|
 +
|-
 +
| {{none}}
 +
| {{AABox}}
 +
| ''Unknown AABox Count''
 +
| {{unknown|Unknown AABox Array}}
 +
|
 +
|}
 +
 
 +
=== Model Header ===
 +
 
 +
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| 0x0
 +
| [[Chunk Descriptor (Tropical Freeze)|Chunk Descriptor]]
 +
| 1
 +
| '''HEAD Chunk Descriptor'''
 +
| Chunk ID is <code>HEAD</code>
 +
|-
 +
| 0x18
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
|
 +
|-
 +
| 0x1C
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
|
 
|-
 
|-
 
| 0x20
 
| 0x20
−
| 4
+
| u32
−
| {{unknown|'''Unknown'''}}
+
| 1
 +
| {{unknown}}
 +
|
 
|-
 
|-
 
| 0x24
 
| 0x24
−
| 4
+
| u32
−
| {{unknown|'''Unknown'''}}
+
| 1
 +
| {{unknown}}
 +
|
 
|-
 
|-
 
| 0x28
 
| 0x28
−
| 4
+
| u32
−
| {{unknown|'''Unknown'''}}
+
| 1
 +
| {{unknown}}
 +
|
 
|-
 
|-
 
| 0x2C
 
| 0x2C
−
| 24
+
| {{AABox}}
−
| '''Axis-aligned bounding box'''
+
| 1
 +
| '''Model Bounding Box'''
 +
|
 
|-
 
|-
−
| 0x30
+
| 0x44
−
| 4
+
| u32
−
| '''Extra data flag'''
+
| 1
 +
| '''Model Data Source Count'''
 +
|
 +
|-
 +
| 0x48
 +
| [[#Model Data Source|Model Data Source]]
 +
| ''Model Data Source Count''
 +
| '''Model Data Source Array'''
 +
|
 
|}
 
|}
  
−
If the ending flag is 1, then a large chunk of extra data follows before the next section begins; otherwise, the HEAD section ends.
+
==== Model Data Source ====
  
−
=== MTRL ===
+
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Name
 +
! Notes
 +
|-
 +
| 0x0
 +
| u32
 +
| '''Model Data Source Type'''
 +
| Controls the type of data present in this data source. Valid values are 0, 1, 2, or 3.
 +
|-
 +
| 0x4
 +
| {{none}}
 +
| '''Model Data Source Data'''
 +
| Structure and size varies depending on ''Model Data Source Type''. See below.
 +
|}
  
−
Materials. To do.
+
===== Type 0: UV Animation =====
  
−
=== MESH ===
+
{{todo|Needs research. The loader function doesn't reveal much because the game just loads all the data into a couple big buffers.}}
  
−
The MESH section does what the name suggests: it defines submeshes. The MESH section header is as follows:
+
===== Type 1: Wind =====
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| u32
 +
| 1
 +
| '''Wind Set Count'''
 +
| Count of Wind Set elements in the next array.
 +
|-
 +
| [[#Wind Set|Wind Set]]
 +
| ''Wind Set Count''
 +
| '''Wind Set Array'''
 +
|
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count}}
 +
|
 +
|-
 +
| u8
 +
| ''Unknown Count''
 +
| {{unknown|Unknown Data}}
 +
|
 +
|}
 +
 
 +
====== Wind Set ======
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 24
+
| {{Vector3f}}
−
| '''"HEAD" [[Section Header (Tropical Freeze)|section header]]
+
| {{unknown}}
 +
|
 +
|-
 +
| 0xC
 +
| {{Vector3f}}
 +
| {{unknown}}
 +
|  
 
|-
 
|-
 
| 0x18
 
| 0x18
−
| 4
+
| float
−
| Submesh count
+
| {{unknown}}
 +
|  
 
|-
 
|-
 
| 0x1C
 
| 0x1C
−
| colspan=2 {{unknown|End of MESH header}}
+
| colspan=3 {{unknown|End of Wind Set}}
 
|}
 
|}
  
−
Each submesh definition is structured as follows:
+
===== Type 2: Caustic =====
  
−
{|class="wikitable"
+
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count}}
 +
|
 +
|-
 +
| u32
 +
| ''Unknown Count''
 +
| {{unknown|Unknown Array}}
 +
|
 +
|}
 +
 
 +
===== Type 3: Fur =====
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count A}}
 +
|
 +
|-
 +
| float
 +
| ''Unknown Count A''
 +
| {{unknown|Unknown Array A}}
 +
|
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count B}}
 +
|
 +
|-
 +
| float
 +
| ''Unknown Count B''
 +
| {{unknown|Unknown Array B}}
 +
|
 +
|-
 +
| u32
 +
| 1
 +
| {{unknown|Unknown Count C}}
 +
|
 +
|-
 +
| float
 +
| ''Unknown Count C''
 +
| {{unknown|Unknown Array C}}
 +
|
 +
|}
 +
 
 +
=== Material Data ===
 +
 
 +
The MTRL section has a 32-bit material count, then lays out its materials one after the other. Materials are composed of basically a [[MTRL (File Format)|MTRL asset ID]] which contains the shader the material is rendered with, then per-instance material parameters (textures, scalar/color parameters, etc).
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| string
 +
| 1
 +
| '''Material Name'''
 +
| Zero-terminated string
 +
|-
 +
| Asset ID ([[MTRL (File Format)|MTRL]])
 +
| 1
 +
| '''Material Shader Asset ID'''
 +
| Points to the MTRL file containing the shader for this material.
 +
|-
 +
| {{FourCC}}
 +
| 1
 +
| '''Material Type'''
 +
| Can be <code>PHNG</code> (Phong), <code>LAMB</code> (Lambert), <code>SURF</code> (Surface), <code>FURM</code> (Fur), or <code>REFL</code> (Reflect). <code>REFL</code> may be unused.
 +
|-
 +
| u32
 +
| 1
 +
| '''Material Flags'''
 +
| Bitfield used to toggle various settings on the material. None of the flags are known.
 +
|-
 +
| u32
 +
| 1
 +
| '''Parameter Count'''
 +
| Count of parameters in this material definition.
 +
|-
 +
| [[#Material Parameter|Material Parameter]]
 +
| ''Parameter Count''
 +
| '''Parameter Array'''
 +
|
 +
|}
 +
 
 +
==== Material Parameter ====
 +
 
 +
Each parameter has a fourCC parameter ID as well as a parameter type enum. There are five possible parameter types that each have a different layout in the file.
 +
 
 +
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 4
+
| {{FourCC}}
−
| {{unknown|'''Unknown'''; always 3?}}
+
| 1
 +
| '''Parameter ID'''
 +
|
 
|-
 
|-
 
| 0x4
 
| 0x4
−
| 2
+
| u32
−
| '''Material ID'''
+
| 1
 +
| '''Parameter Type'''
 +
| Determines what type of data this parameter contains. Can be either 0, 1, 2, 4, or 5. (Note: 3 is an invalid value, not an unused type.)
 
|-
 
|-
−
| 0x6
+
| 0x8
 +
| {{none}}
 +
| {{none}}
 +
| '''Parameter Data'''
 +
| Structure and size varies depending on ''Parameter Type''. See below.
 +
|}
 +
 
 +
==== Type 0: Texture Token Data ====
 +
 
 +
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| 0x0
 +
| Asset ID ([[TXTR (Tropical Freeze)|TXTR]])
 
| 1
 
| 1
−
| '''Vertex buffer ID'''
+
| '''Texture ID'''
 +
| Texture asset ID.
 
|-
 
|-
−
| 0x7
+
| 0x10
 +
| [[#Texture Usage Info|Texture Usage Info]]
 
| 1
 
| 1
−
| '''Index buffer ID'''
+
| '''Texture Usage Info'''
 +
| '''Note:''' Not present if the TXTR asset ID is invalid.
 
|-
 
|-
−
| 0x8
+
| colspan=5 {{unknown|End of Texture Token Data}}
−
| 4
+
|}
−
| '''Start index'''
+
 
 +
==== Type 1: Color Data ====
 +
 
 +
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
−
| 0xC
+
| 0x0
−
| 4
+
| {{Color4f}}
−
| '''Index count'''
+
| 1
 +
| '''Color Value'''
 +
|
 
|-
 
|-
 
| 0x10
 
| 0x10
−
| 4
+
| colspan=4 {{unknown|End of Color Data}}
−
| {{unknown|'''Unknown'''}}
+
|}
 +
 
 +
==== Type 2: Scalar Data ====
 +
 
 +
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
−
| 0x14
+
| 0x0
 +
| float
 
| 1
 
| 1
−
| {{unknown|'''Unknown'''; usually seems to be either 0 or 1, possibly a bool value}}
+
| '''Scalar Value'''
 +
|
 
|-
 
|-
−
| 0x15
+
| 0x4
−
| colspan=2 {{unknown|End of submesh definition}}
+
| colspan=4 {{unknown|End of Scalar Data}}
 
|}
 
|}
  
−
=== VBUF ===
+
==== Type 4: Layered Texture Data ====
  
−
The VBUF section defines vertex buffers; each buffer can have different vertex types, with different strides and attributes.
+
{| class="wikitable"
 +
! Offset
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| 0x0
 +
| u32
 +
| 1
 +
| {{unknown|Unknown}}
 +
|
 +
|-
 +
| 0x4
 +
| {{Color4f}}
 +
| 1
 +
| {{unknown|Unknown Color}}
 +
|
 +
|-
 +
| 0x14
 +
| {{Color4f}}
 +
| 1
 +
| {{unknown|Unknown Color}}
 +
|
 +
|-
 +
| 0x24
 +
| {{Color4f}}
 +
| 1
 +
| {{unknown|Unknown Color}}
 +
|
 +
|-
 +
| 0x34
 +
| u8
 +
| 1
 +
| {{unknown|Unknown}}
 +
|
 +
|-
 +
| 0x35
 +
| [[#Type 0: Texture Token Data|Texture Token Data]]
 +
| 1
 +
| {{unknown|Unknown Texture Token Data}}
 +
|
 +
|-
 +
| {{none}}
 +
| [[#Type 0: Texture Token Data|Texture Token Data]]
 +
| 1
 +
| {{unknown|Unknown Texture Token Data}}
 +
|
 +
|-
 +
| {{none}}
 +
| [[#Type 0: Texture Token Data|Texture Token Data]]
 +
| 1
 +
| {{unknown|Unknown Texture Token Data}}
 +
|
 +
|-
 +
| colspan=5 {{unknown|End of Layered Texture Data}}
 +
|}
  
−
==== Header ====
+
==== Type 5: Int4 Data ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 24
+
| u32
−
| '''"VBUF" [[Section Header (Tropical Freeze)|section header]]
+
−
|-
+
−
| 0x18
+
 
| 4
 
| 4
−
| Vertex buffer count
+
| '''Int4 Value'''
 +
|
 
|-
 
|-
−
| 0x1C
+
| 0x10
−
| colspan=2 {{unknown|End of VBUF header}}
+
| colspan=4 {{unknown|End of Int4 Data}}
 
|}
 
|}
  
−
==== Vertex Buffer ====
+
==== Texture Usage Info ====
  
−
{|class="wikitable"
+
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 4
+
| u32
−
| '''Vertex count'''
+
| 1
 +
| {{unknown|Unknown}}
 +
|  
 
|-
 
|-
 
| 0x4
 
| 0x4
−
| 4
+
| u32
−
| '''Attrib count''' (AC)
+
| 1
 +
| {{unknown|Unknown}}
 +
|  
 
|-
 
|-
 
| 0x8
 
| 0x8
−
| 0x14 &times; AC
+
| u32
−
| '''Vertex attributes'''
+
| 1
 +
| {{unknown|Unknown}}
 +
|  
 
|-
 
|-
−
| colspan=3 {{unknown|End of vertex buffer}}
+
| 0xC
 +
| u32
 +
| 1
 +
| {{unknown|Unknown}}
 +
|
 +
|-
 +
| 0x10
 +
| u32
 +
| 1
 +
| {{unknown|Unknown}}
 +
|
 +
|-
 +
| 0x14
 +
| colspan=4 {{unknown|End of Texture Usage Info}}
 
|}
 
|}
  
−
==== Vertex Attribute ====
+
=== Render Meshes ===
  
−
{|class="wikitable"
+
The MESH section defines render meshes.
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| [[Chunk Descriptor (Tropical Freeze)|Chunk Descriptor]]
 +
| 1
 +
| '''MESH Chunk Descriptor'''
 +
| Chunk ID is <code>MESH</code>
 +
|-
 +
| u32
 +
| 1
 +
| '''Render Mesh Count'''
 +
|
 +
|-
 +
| [[#Render Mesh|Render Mesh]]
 +
| ''Render Mesh Count''
 +
| '''Render Mesh Array'''
 +
|
 +
|}
 +
 
 +
==== Render Mesh ====
 +
 
 +
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 4
+
| u32
−
| {{unknown|'''Unknown'''}}
+
| 1
 +
| {{unknown}}
 +
| Always 3?
 
|-
 
|-
 
| 0x4
 
| 0x4
−
| 4
+
| u16
−
| '''Offset'''
+
| 1
 +
| '''Material Index'''
 +
|
 +
|-
 +
| 0x6
 +
| u8
 +
| 1
 +
| '''Vertex Buffer Index'''
 +
|
 +
|-
 +
| 0x7
 +
| u8
 +
| 1
 +
| '''Index Buffer Index'''
 +
|
 
|-
 
|-
 
| 0x8
 
| 0x8
−
| 4
+
| u32
−
| '''Stride'''
+
| 1
 +
| '''Start Index'''
 +
| This is basically an offset into the selected index buffer.
 
|-
 
|-
 
| 0xC
 
| 0xC
−
| 4
+
| u32
−
| {{unknown|'''Unknown'''}}
+
| 1
 +
| '''Index Count'''
 +
| Number of indices for this mesh in the index buffer.
 
|-
 
|-
 
| 0x10
 
| 0x10
−
| 4
+
| u32
−
|{{unknown|'''Unknown''' (likely attrib type/format)}}
+
| 1
 +
| {{unknown}}
 +
|
 
|-
 
|-
 
| 0x14
 
| 0x14
−
| colspan=2 {{unknown|End of attribute}}
+
| bool
 +
| 1
 +
| {{unknown}}
 +
|
 +
|-
 +
| 0x15
 +
| colspan=4 {{unknown|End of Render Mesh}}
 
|}
 
|}
  
−
=== IBUF ===
+
=== Vertex Buffers ===
  
−
Just like how the VBUF section defines vertex buffers, the IBUF section defines index buffers. Each index buffer only has one value associated with it, so it's fairly simple, and you generally will only see one or two index buffers per file.
+
The VBUF section defines vertex buffers; each buffer can have different vertex types, with different strides and attributes.
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| [[Chunk Descriptor (Tropical Freeze)|Chunk Descriptor]]
 +
| 1
 +
| '''VBUF Chunk Descriptor'''
 +
| Chunk ID is <code>VBUF</code>
 +
|-
 +
| u32
 +
| 1
 +
| '''Vertex Buffer Count'''
 +
|
 +
|-
 +
| [[#Vertex Buffer|Vertex Buffer]]
 +
| ''Vertex Buffer Count''
 +
| '''Vertex Buffer Array'''
 +
| The model will contain a separate vertex buffer for every unique vertex configuration needed.
 +
|}
 +
 
 +
==== Vertex Buffer ====
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| u32
 +
| 1
 +
| '''Vertex Count'''
 +
| Number of vertices in the buffer.
 +
|-
 +
| u32
 +
| 1
 +
| '''Vertex Component Count'''
 +
| Number of components in each vertex.
 +
|-
 +
| [[#Vertex Component|Vertex Component]]
 +
| ''Vertex Component Count''
 +
| '''Vertex Component Array'''
 +
| Definitions for each component in the vertex.
 +
|}
  
−
==== Header ====
+
==== Vertex Component ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Count
 +
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 24
+
| u32
−
| '''"IBUF" [[Section Header (Tropical Freeze)|section header]]
+
| 1
 +
| {{unknown}}
 +
|  
 
|-
 
|-
−
| 0x18
+
| 0x4
−
| 4
+
| u32
−
| Index buffer count
+
| 1
 +
| '''Offset'''
 +
| Offset of this component within the vertex.
 
|-
 
|-
−
| 0x1C
+
| 0x8
−
| colspan=2 {{unknown|End of IBUF header}}
+
| u32
 +
| 1
 +
| '''Stride'''
 +
| Distance in bytes between elements of this component within the vertex buffer. (This is equivalent to the full size of a single vertex.)
 +
|-
 +
| 0xC
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
|
 +
|-
 +
| 0x10
 +
| u32
 +
| 1
 +
| {{unknown}}
 +
| Likely component type/format
 +
|-
 +
| 0x14
 +
| colspan=4 {{unknown|End of Vertex Component}}
 +
|}
 +
 
 +
=== Index Buffers ===
 +
 
 +
Just like how the VBUF section defines vertex buffers, the IBUF section defines index buffers. Each index buffer only has one value associated with it, so it's fairly simple, and you generally will only see one or two index buffers per file (as there's only two possible index buffer configurations).
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Count
 +
! Name
 +
! Notes
 +
|-
 +
| [[Chunk Descriptor (Tropical Freeze)|Chunk Descriptor]]
 +
| 1
 +
| '''IBUF Chunk Descriptor'''
 +
| Chunk Descriptor is <code>IBUF</code>
 +
|-
 +
| u32
 +
| 1
 +
| '''Index Buffer Count'''
 +
|
 +
|-
 +
| [[#Index Buffer|Index Buffer]]
 +
| ''Index Buffer Count''
 +
| '''Index Buffer Array'''
 +
|
 
|}
 
|}
  
Line 223: Line 868:
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 4
+
| u32
−
| '''Format''' (1 means unsigned short; 2 means unsigned long)
+
| '''Format'''
 +
| 1 means unsigned short; 2 means unsigned long.
 
|-
 
|-
 
| 0x4
 
| 0x4
−
| colspan=2 {{unknown|End of index buffer}}
+
| colspan=3 {{unknown|End of Index Buffer}}
 
|}
 
|}
  
−
=== GPU ===
+
=== GPU Data ===
  
 
The GPU section contains raw buffer data that's fed to the GPU. It's essentially just a giant blob with all the vertex and index buffers laid out next to each other. The tricky part is, all the buffer data is [[LZSS Compression|LZSS-compressed]], and the metadata needed to decompress it is stored in the pak rather than in the files themselves; not only that, but that metadata is also the only way to distinguish the different buffers from each other.
 
The GPU section contains raw buffer data that's fed to the GPU. It's essentially just a giant blob with all the vertex and index buffers laid out next to each other. The tricky part is, all the buffer data is [[LZSS Compression|LZSS-compressed]], and the metadata needed to decompress it is stored in the pak rather than in the files themselves; not only that, but that metadata is also the only way to distinguish the different buffers from each other.
Line 242: Line 889:
 
== PAK Metadata ==
 
== PAK Metadata ==
  
−
The pak metadata for the model formats contains mainly information related to the size and layout of the GPU section, and the metadata required to locate and decompress specific buffers within it.
+
The PAK metadata for the model formats contains mainly information related to the size and layout of the GPU section, and the metadata required to locate and decompress specific buffers within it.
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! Offset
+
! Type
−
! Size
+
! Count
−
! Description
+
! Name
 +
! Notes
 
|-
 
|-
−
| 0x0
+
| u32
−
| 4
+
| 1
−
| Unknown; always 4?
+
| {{unknown}}
 +
| Always 4?
 
|-
 
|-
−
| 0x4
+
| u32
−
| 4
+
| 1
−
| '''GPU section offset'''
+
| '''GPU Section Offset'''
 
|-
 
|-
−
| 0x8
+
| u32
−
| 4
+
| 1
−
| '''GPU chunk count''' (CC)
+
| '''Read Buffer Count'''
 +
| Number of read buffers making up the GPU section.
 
|-
 
|-
−
| 0xC
+
| [[#Read Buffer Info|Read Buffer Info]]
−
| 8 &times; CC
+
| ''Read Buffer Count''
−
| '''GPU chunk definitions'''
+
| '''Read Buffer Array'''
 +
| Definitions for each read buffer.
 
|-
 
|-
−
| -
+
| u32
−
| 4
+
| 1
−
| '''Compressed vertex buffer count''' (VC)
+
| '''Vertex Buffer Count'''
 +
| Number of vertex buffers in the model.
 
|-
 
|-
−
| -
+
| [[#Buffer Info|Buffer Info]]
−
| 0x10 &times; VC
+
| ''Vertex Buffer Count''
−
| '''Vertex buffer definitions'''
+
| '''Vertex Buffer Info Array'''
 +
| Array containing all data needed to decompress each vertex buffer.
 
|-
 
|-
−
| -
+
| u32
−
| 4
+
| 1
−
| '''Compressed index buffer count''' (IC)
+
| '''Index Buffer Count'''
−
|-
+
| Number of index buffers in the model.
−
| -
+
−
| 0x10 &times; IC
+
−
| '''Index buffer definitions'''
+
 
|-
 
|-
−
| colspan = 3 | End of pak metadata
+
| [[#Buffer Info|Buffer Info]]
 +
| ''Index Buffer Count''
 +
| '''Index Buffer Info Array'''
 +
| Array containing all data needed to decompress each index buffer.
 
|}
 
|}
  
−
=== GPU Chunk ===
+
=== Read Buffer Info ===
  
−
For large models, the GPU section might be split up into multiple chunks, rather than read as one data buffer; all offsets into the GPU section will be relative to the start of the chosen chunk.
+
For large models, the GPU section may be split into multiple read buffers. All offsets into the GPU section will be relative to the beginning of the chosen buffer.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 4
+
| u32
 
| '''Size'''
 
| '''Size'''
 +
| Size of the buffer.
 
|-
 
|-
 
| 0x4
 
| 0x4
−
| 4
+
| u32
 
| '''Offset'''
 
| '''Offset'''
 +
| Offset of the buffer within the GPU section.
 
|-
 
|-
 
| 0x8
 
| 0x8
−
| colspan=2 | End of GPU chunk definition
+
| colspan=3 {{unknown|End of Read Buffer Info}}
 
|}
 
|}
  
−
=== Compressed Buffer ===
+
=== Buffer Info ===
  
−
The format for compressed buffer definitions is the same regardless of buffer type (vertex/index).
+
This structure is used for both vertex and index buffers.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset
 
! Offset
−
! Size
+
! Type
−
! Description
+
! Name
 +
! Notes
 
|-
 
|-
 
| 0x0
 
| 0x0
−
| 4
+
| u32
−
| '''GPU chunk index'''
+
| '''Read Buffer Index'''
 +
| The read buffer that this buffer is inside of.
 
|-
 
|-
 
| 0x4
 
| 0x4
−
| 4
+
| u32
−
| '''Start offset''' (relative to the start of the chosen GPU chunk)
+
| '''Start Offset'''
 +
| Starting offset of this buffer, relative to the start of the chosen read buffer.
 
|-
 
|-
 
| 0x8
 
| 0x8
−
| 4
+
| u32
−
| '''Compressed size'''
+
| '''Compressed Size'''
 +
| Size of the compressed data.
 
|-
 
|-
 
| 0xC
 
| 0xC
−
| 4
+
| u32
−
| '''Decompressed size'''
+
| '''Decompressed Size'''
 +
| Size of the data after being decompressed.
 
|-
 
|-
 
| 0x10
 
| 0x10
−
| colspan=2 | End of compressed buffer definition
+
| colspan=3 {{unknown|End of Buffer Info}}
 
|}
 
|}
  
 
[[Category:File Formats]]
 
[[Category:File Formats]]
 
[[Category:Donkey Kong Country: Tropical Freeze]]
 
[[Category:Donkey Kong Country: Tropical Freeze]]

Latest revision as of 13:40, 14 November 2016

See CMDL (File Format) for the other revisions of this format.

Tropical Freeze features a new model format (necessitated by the hardware jump from Wii to Wii U) that bears little-to-no resemblance to the CMDL format of past games. There are three extensions used for models:

  • CMDL: Generic models
  • SMDL: Skinned models (ie. animated characters)
  • WMDL: World models (ie. level geometry)

All three share the same basic format, with SMDL and WMDL each containing an extra data chunk at the start of the file.


Morphball wirerender.png This file format needs more research
There's a lot of unknown data.


Format

File layout:

Type/Name Notes
Form Descriptor Form ID is CMDL, SMDL, or WMDL.
Skinned Model Header Only present in SMDL files
World Model Header Only present in WMDL files
Model Header
Material Data
Render Meshes
Vertex Buffers
Index Buffers
GPU Data

Skinned Model Header

Offset Type Count Name Notes
0x0 Chunk Descriptor 1 SKHD Chunk Descriptor Data type is SKHD
0x18 u32 1 Unknown
0x1C End of Skinned Model Header

World Model Header

Type Count Name Notes
Chunk Descriptor 1 WDHD Chunk Descriptor Chunk ID is WDHD
u8 1 Unknown
Render Octree 1 Render Octree
u32 1 Unknown AABox Count
AABox Unknown AABox Count Unknown AABox Array
u32 1 Unknown Float Count
float Unknown Float Count Unknown Float Array

Render Octree

This seems to be an updated version of the AROT format seen in previous Retro games.

Offset Type Count Name Notes
0x0 FourCC 1 Magic Always AROT (Area Octree)
0x4 u32 1 Unknown Always 1. Version number?
0x8 u32 1 Unknown
0xC u32 1 Unknown
0x10 u32 1 Unknown
0x14 AABox 1 Octree Bounding Box Bounds of the entire octree; matches the bounding box from the main model header.
0x2C u32 1 Unknown Count A
0x30 u32 Unknown Count A Unknown Array A
u32 1 Unknown Count B
u8 Unknown Count B Unknown Array B
u32 1 Unknown AABox Count
AABox Unknown AABox Count Unknown AABox Array

Model Header

Offset Type Count Name Notes
0x0 Chunk Descriptor 1 HEAD Chunk Descriptor Chunk ID is HEAD
0x18 u32 1 Unknown
0x1C u32 1 Unknown
0x20 u32 1 Unknown
0x24 u32 1 Unknown
0x28 u32 1 Unknown
0x2C AABox 1 Model Bounding Box
0x44 u32 1 Model Data Source Count
0x48 Model Data Source Model Data Source Count Model Data Source Array

Model Data Source

Offset Type Name Notes
0x0 u32 Model Data Source Type Controls the type of data present in this data source. Valid values are 0, 1, 2, or 3.
0x4 Model Data Source Data Structure and size varies depending on Model Data Source Type. See below.
Type 0: UV Animation
GravitySuitIcon.png To do:
Needs research. The loader function doesn't reveal much because the game just loads all the data into a couple big buffers.
Type 1: Wind
Type Count Name Notes
u32 1 Wind Set Count Count of Wind Set elements in the next array.
Wind Set Wind Set Count Wind Set Array
u32 1 Unknown Count
u8 Unknown Count Unknown Data
Wind Set
Offset Type Name Notes
0x0 Vector3f Unknown
0xC Vector3f Unknown
0x18 float Unknown
0x1C End of Wind Set
Type 2: Caustic
Type Count Name Notes
u32 1 Unknown Count
u32 Unknown Count Unknown Array
Type 3: Fur
Type Count Name Notes
u32 1 Unknown Count A
float Unknown Count A Unknown Array A
u32 1 Unknown Count B
float Unknown Count B Unknown Array B
u32 1 Unknown Count C
float Unknown Count C Unknown Array C

Material Data

The MTRL section has a 32-bit material count, then lays out its materials one after the other. Materials are composed of basically a MTRL asset ID which contains the shader the material is rendered with, then per-instance material parameters (textures, scalar/color parameters, etc).

Type Count Name Notes
string 1 Material Name Zero-terminated string
Asset ID (MTRL) 1 Material Shader Asset ID Points to the MTRL file containing the shader for this material.
FourCC 1 Material Type Can be PHNG (Phong), LAMB (Lambert), SURF (Surface), FURM (Fur), or REFL (Reflect). REFL may be unused.
u32 1 Material Flags Bitfield used to toggle various settings on the material. None of the flags are known.
u32 1 Parameter Count Count of parameters in this material definition.
Material Parameter Parameter Count Parameter Array

Material Parameter

Each parameter has a fourCC parameter ID as well as a parameter type enum. There are five possible parameter types that each have a different layout in the file.

Offset Type Count Name Notes
0x0 FourCC 1 Parameter ID
0x4 u32 1 Parameter Type Determines what type of data this parameter contains. Can be either 0, 1, 2, 4, or 5. (Note: 3 is an invalid value, not an unused type.)
0x8 Parameter Data Structure and size varies depending on Parameter Type. See below.

Type 0: Texture Token Data

Offset Type Count Name Notes
0x0 Asset ID (TXTR) 1 Texture ID Texture asset ID.
0x10 Texture Usage Info 1 Texture Usage Info Note: Not present if the TXTR asset ID is invalid.
End of Texture Token Data

Type 1: Color Data

Offset Type Count Name Notes
0x0 Color4f 1 Color Value
0x10 End of Color Data

Type 2: Scalar Data

Offset Type Count Name Notes
0x0 float 1 Scalar Value
0x4 End of Scalar Data

Type 4: Layered Texture Data

Offset Type Count Name Notes
0x0 u32 1 Unknown
0x4 Color4f 1 Unknown Color
0x14 Color4f 1 Unknown Color
0x24 Color4f 1 Unknown Color
0x34 u8 1 Unknown
0x35 Texture Token Data 1 Unknown Texture Token Data
Texture Token Data 1 Unknown Texture Token Data
Texture Token Data 1 Unknown Texture Token Data
End of Layered Texture Data

Type 5: Int4 Data

Offset Type Count Name Notes
0x0 u32 4 Int4 Value
0x10 End of Int4 Data

Texture Usage Info

Offset Type Count Name Notes
0x0 u32 1 Unknown
0x4 u32 1 Unknown
0x8 u32 1 Unknown
0xC u32 1 Unknown
0x10 u32 1 Unknown
0x14 End of Texture Usage Info

Render Meshes

The MESH section defines render meshes.

Type Count Name Notes
Chunk Descriptor 1 MESH Chunk Descriptor Chunk ID is MESH
u32 1 Render Mesh Count
Render Mesh Render Mesh Count Render Mesh Array

Render Mesh

Offset Type Count Name Notes
0x0 u32 1 Unknown Always 3?
0x4 u16 1 Material Index
0x6 u8 1 Vertex Buffer Index
0x7 u8 1 Index Buffer Index
0x8 u32 1 Start Index This is basically an offset into the selected index buffer.
0xC u32 1 Index Count Number of indices for this mesh in the index buffer.
0x10 u32 1 Unknown
0x14 bool 1 Unknown
0x15 End of Render Mesh

Vertex Buffers

The VBUF section defines vertex buffers; each buffer can have different vertex types, with different strides and attributes.

Type Count Name Notes
Chunk Descriptor 1 VBUF Chunk Descriptor Chunk ID is VBUF
u32 1 Vertex Buffer Count
Vertex Buffer Vertex Buffer Count Vertex Buffer Array The model will contain a separate vertex buffer for every unique vertex configuration needed.

Vertex Buffer

Type Count Name Notes
u32 1 Vertex Count Number of vertices in the buffer.
u32 1 Vertex Component Count Number of components in each vertex.
Vertex Component Vertex Component Count Vertex Component Array Definitions for each component in the vertex.

Vertex Component

Offset Type Count Name Notes
0x0 u32 1 Unknown
0x4 u32 1 Offset Offset of this component within the vertex.
0x8 u32 1 Stride Distance in bytes between elements of this component within the vertex buffer. (This is equivalent to the full size of a single vertex.)
0xC u32 1 Unknown
0x10 u32 1 Unknown Likely component type/format
0x14 End of Vertex Component

Index Buffers

Just like how the VBUF section defines vertex buffers, the IBUF section defines index buffers. Each index buffer only has one value associated with it, so it's fairly simple, and you generally will only see one or two index buffers per file (as there's only two possible index buffer configurations).

Type Count Name Notes
Chunk Descriptor 1 IBUF Chunk Descriptor Chunk Descriptor is IBUF
u32 1 Index Buffer Count
Index Buffer Index Buffer Count Index Buffer Array

Index Buffer

Offset Type Name Notes
0x0 u32 Format 1 means unsigned short; 2 means unsigned long.
0x4 End of Index Buffer

GPU Data

The GPU section contains raw buffer data that's fed to the GPU. It's essentially just a giant blob with all the vertex and index buffers laid out next to each other. The tricky part is, all the buffer data is LZSS-compressed, and the metadata needed to decompress it is stored in the pak rather than in the files themselves; not only that, but that metadata is also the only way to distinguish the different buffers from each other.

As such, this section can't be read correctly if the model file is unpacked and completely left as-is; it needs to be either read directly from the pak, or the metadata needs to be added to the file in some way. A good unpacker should append the metadata to the end of the file; a pre-decompressed file needs the buffer sizes or offsets inserted into the file data somewhere.

PAK Metadata

The PAK metadata for the model formats contains mainly information related to the size and layout of the GPU section, and the metadata required to locate and decompress specific buffers within it.

Type Count Name Notes
u32 1 Unknown Always 4?
u32 1 GPU Section Offset
u32 1 Read Buffer Count Number of read buffers making up the GPU section.
Read Buffer Info Read Buffer Count Read Buffer Array Definitions for each read buffer.
u32 1 Vertex Buffer Count Number of vertex buffers in the model.
Buffer Info Vertex Buffer Count Vertex Buffer Info Array Array containing all data needed to decompress each vertex buffer.
u32 1 Index Buffer Count Number of index buffers in the model.
Buffer Info Index Buffer Count Index Buffer Info Array Array containing all data needed to decompress each index buffer.

Read Buffer Info

For large models, the GPU section may be split into multiple read buffers. All offsets into the GPU section will be relative to the beginning of the chosen buffer.

Offset Type Name Notes
0x0 u32 Size Size of the buffer.
0x4 u32 Offset Offset of the buffer within the GPU section.
0x8 End of Read Buffer Info

Buffer Info

This structure is used for both vertex and index buffers.

Offset Type Name Notes
0x0 u32 Read Buffer Index The read buffer that this buffer is inside of.
0x4 u32 Start Offset Starting offset of this buffer, relative to the start of the chosen read buffer.
0x8 u32 Compressed Size Size of the compressed data.
0xC u32 Decompressed Size Size of the data after being decompressed.
0x10 End of Buffer Info
Retrieved from "http://www.metroid2002.com/retromodding/index.php?title=CMDL_(Tropical_Freeze)&oldid=1738"