FSHA (File Format)
The FSHA (caFe SHape Animation) subfile stores shape animations. It appears as a subfile of a BFRES file in the 9th index group. Unless otherwise noted, all offsets in the file are relative to themselves.
An FSHA file begins with an FSHA header. This is then followed by a number of sections pointed to by the header, many of which can occur multiple times. The purpose of these sections is described in the table below.
FSHA shares many similarities with the FSKA, FSHU, FTXP, FVIS and FSCN subfiles, which mostly only differ in the structure describing what is changed by animations over time, but reusing the same animation curve and key structures, and even headers being very similar to one another.
Every FSHA begins with an 0x30 byte FSHA header.
|0x00||4||Char||"FSHA" file identifier, ASCII string.|
|0x04||4||Int32||File name offset (without file extension).|
|0x08||4||Int32||File path offset, the path of the file this data was originally created from. Stripped in Mario Kart 8 files, always pointing to an empty string at the end of the BFRES string table.|
|0x0C||2||UInt16||Flags. Set of bits packed as xxxxxxxx xxxxxLxB, controlling how to play the animation and what data is stored. The following flags are possible:
|0x0E||2||UInt16||User Data entry count.|
|0x14||2||UInt16||Vertex Shape Animation count, the number of elements in the Vertex Shape Animation array.|
|0x16||2||UInt16||Shape Animation Key count, the total number of Shape Animation Keys in all Vertex Shape Animations.|
|0x18||2||UInt16||Curve count, the total number of Curve structures in all Vertex Shape Animations.|
|0x20||4||Int32||Model offset. Points to the affected FMDL model.|
|0x24||4||Int32||Bind index array offset.|
|0x28||4||Int32||Vertex Shape Animation array offset.|
|0x2C||4||Int32||User Data index group offset.|
|0x30||End of FSHA header|
The header points to an array of UInt16 elements with as many elements as specified in Vertex Shape Animation count. It holds indices to shapes, but an index can be 0xFFFF to reference no shape. The exact purpose of this array is unknown. The end of the array is aligned to 4 bytes.
Vertex Shape Animation
The header points to an array of Vertex Shape Animation structures with as many elements as specified in Vertex Shape Animation count, each of 0x20 bytes size.
|0x02||2||UInt16||Shape Animation Key count.|
|0x04||4||Int32||Start Curve index, relative to the whole FSHA subfile (an array where all Vertex Shape Animation Curves would be stored together, in the order of which they appear in the subfile).|
|0x08||4||Int32||Start Shape Animation Key index, relative to the whole FSHA subfile (an array where all Shape Animation Keys would be stored together, in the order of which they appear in the subfile).|
|0x14||4||Int32||Shape Animation Key array offset.|
|0x18||4||Int32||Curve array offset.|
|0x1C||4||Int32||Base Transformation Data offset.|
|0x20||End of Vertex Shape Animation|
Shape Animation Key
The Vertex Shape Animation header points to an array of Shape Animation Key structures, as many as given in the Shape Animation Key count field. Each structure is of 0x08 bytes size.
|0x00||1||SByte||Curve index, index of the curve relative to the whole FSHA subfile.|
|0x01||1||SByte||Sub bind index, the index of the key shape in the FSHP.|
|0x08||End of Shape Animation Key|
Base Transformation Data
The Vertex Shape Animation header points to an array of float values. It has as many elements as given in the Shape Animation Key count field minus 1, as the base shape data is not stored.
Curves store how animations are performed over time and store the required keys and values for this. They appear in multiple animation subfiles, and their header is of 0x24 bytes size (for BFRES versions earlier than 184.108.40.206, they are of 0x20 bytes size).
|0x00||2||UInt16||Flags. Sets of bits packed as xxxxxxxx xCCCKKFF.
|0x04||4||UInt32||Target Offset, an offset in bytes into the corresponding Animation Data structure to animate the field at that relative address.|
|0x08||4||Single||Start frame, the first frame at which a key is placed.|
|0x0C||4||Single||End frame, the last frame at which a key is placed.|
|0x10||4||Int32 / Single||Data scale, multiplier to the raw key values to get the final result. Together with Data offset, it is chosen carefully to consider an optimal granularity between the stored values.|
|0x14||4||Single||Data offset, added to the raw values (after multiplying them with Data scale) to get the final key value.|
|if BFRES version >= 220.127.116.11|
|0x18||4||Single||Data delta, stores the difference between the first and last key value.|
|0x1C||4||Int32||Frame array offset.|
|0x20||4||Int32||Key array offset.|
|0x24||End of Curve|
|0x18||4||Int32||Frame array offset.|
|0x1C||4||Int32||Key array offset.|
|0x20||End of Curve|
The Curve header points to a Frame array which stores values controlling at which frame a Key from the Key array is placed. Thus, the array has as many elements as specified in Key count. The data type of the frames is given in the Curve's Flags.
The end of the array is aligned to 4 bytes.
The Curve header points to a Key array which stores the key values and additional values to interpolate the curve from one point to the next. Thus, the array has as many elements as specified in Key count, multiplied by the number of elements stored per key (depending upon the CCC Curve Type bits in the Curve Flags as described above). The data type of each element is given by the KK Key Type bits in the Curve Flags.
The end of the array is aligned to 4 bytes.
The elements apparently represent the key values directly.
For linearly interpolated curves, 2 elements are stored per key:
- Value at which the key is set. To get the final value, scale and then offset it.
- Delta to value at next frame to which the curve linearly runs. To get the final value, scale it. If there is no next frame, this is always 0.
A key can be discarded by the next key if that one is stored at the same frame. In that case, only the value of the next key is stored, and the delta of the previous key is adjusted to run to the value of the now discarded key.
This example curve's keys are stored as SByte elements. The curve scale was computed as 2, the offset as 200 and the curve delta (if available in the BFRES version) as 300. Due to the lower key in frame 20 being discarded in favor of the higher key, only 3 keys are stored in 6 elements as follows.
|Point||Array Index||Raw Value||*2 (Scale)||+200 (Offset)||Notes|
|0,0||0||-100||-200||0||Initial key with value 0.|
|(20,254)||1||127||254||-||Delta to end value of initial key at next frame.|
|20,254||-||-||-||-||This key is discarded in favor of the next.|
|20,400||2||100||200||400||Overrides previous key.|
|(30,300)||3||-50||-100||-||End value of overriding key at next frame.|
|30,300||4||50||100||300||Value of fourth (but third stored) key.|
|(end)||5||0||0||-||Since no frame follows, always 0.|
For hermite curves, 4 elements are stored for each key. It is unclear how to exactly interprete them to form the curve out of it.
The Curve targets which control what exactly is animated over time are not yet known.