feat: IW3 xanim dumping/loading in CoD4 Mod Tools raw binary format (#768)

* feat: IW3 dump xanim to cod4 mod tools compatible binary

* chore: add XAnimPartType enum to game headers

* chore: use XAnimPartType in XAnimDumperIW3

* chore: extract xanim filename into XAnimCommon

* chore: prefer emplace_back over push_back

* chore: small code style improvements

* chore: use proper unsigned types for XAnimParts structs

* chore: use better understandable calculations for bitfields

* chore: use game names for parts

* chore: rename method to WriteNoteTracks

* chore: adds comments and improve clearity of what the game does

* chore: extract stream writing methods into StreamUtils

* chore: use vec3 for XAnimPartTransFrames mins and size

* chore: properly differ between XQuat and XQuat2 structs

* chore: use constants for xanim flags

* chore: use optional for delta track quats and trans

* chore: split delta track writing methods into quat and trans

* chore: add assertion for bDelta

* chore: simplify quat frame encoding indexing

* chore: simplify float to int bit casting

* chore: do not throw exception on failing to reconstruct bone tracks

* feat: add xanim loader for iw3

* fix: make sure to sort quats and trans like the game

* chore: prevent empty dumped files on bad xanim data

* chore: ensure no exception on zero frames in xanim notifies

* test: add system test for iw3 xanims

---------

Co-authored-by: Jan Laupetin <[email protected]>
This commit is contained in:
mo
2026-06-01 22:52:49 +02:00
committed by GitHub
co-authored by Jan Laupetin
parent f7be1ac9c1
commit 0c22dddd0e
19 changed files with 2044 additions and 55 deletions
+2 -1
View File
@@ -12,13 +12,14 @@
#include "Sound/LoadedSoundDumperIW3.h"
#include "Sound/SndCurveDumperIW3.h"
#include "StringTable/StringTableDumperIW3.h"
#include "XAnim/XAnimDumperIW3.h"
using namespace IW3;
void ObjWriter::RegisterAssetDumpers(AssetDumpingContext& context)
{
RegisterAssetDumper(std::make_unique<phys_preset::InfoStringDumperIW3>());
// REGISTER_DUMPER(AssetDumperXAnimParts)
RegisterAssetDumper(std::make_unique<xanim::DumperIW3>());
RegisterAssetDumper(std::make_unique<xmodel::DumperIW3>());
RegisterAssetDumper(std::make_unique<material::JsonDumperIW3>());
RegisterAssetDumper(std::make_unique<techset::DumperIW3>(
@@ -0,0 +1,937 @@
#include "XAnimDumperIW3.h"
#include "Utils/Alignment.h"
#include "Utils/StreamUtils.h"
#include "XAnim/XAnimCommon.h"
#include <array>
#include <cassert>
#include <cmath>
#include <cstdint>
#include <cstring>
#include <expected>
#include <format>
#include <limits>
#include <optional>
#include <ostream>
#include <stdexcept>
#include <string>
#include <vector>
using namespace IW3;
namespace
{
constexpr uint16_t RAW_VERSION = 17;
constexpr uint8_t FLAG_LOOPED = 1u;
constexpr uint8_t FLAG_DELTA = 2u;
// The linker decodes raw trans size[] with these exact float literals.
// They correspond to 1.0f / 255.0f and 1.0f / 65535.0f, but we keep the
// decompiled values to preserve binary-stable round trips.
constexpr auto HALF_TRANS_SIZE_SCALE = 0.003921568859368563f;
constexpr auto FULL_TRANS_SIZE_SCALE = 0.00001525902189314365f;
enum class QuatType : uint8_t
{
NO_QUAT = 0,
HALF_QUAT = 1,
FULL_QUAT = 2,
HALF_QUAT_NO_SIZE = 3,
FULL_QUAT_NO_SIZE = 4,
};
enum class TransType : uint8_t
{
SMALL_TRANS = 5,
FULL_TRANS = 6,
TRANS_NO_SIZE = 7,
NO_TRANS = 8,
};
struct QuatTrack
{
QuatType type = QuatType::NO_QUAT;
std::vector<uint16_t> indices;
std::vector<int16_t> values;
};
struct TransTrack
{
TransType type = TransType::NO_TRANS;
std::vector<uint16_t> indices;
std::array<float, 3> mins{};
std::array<float, 3> size{};
std::vector<uint8_t> byteFrames;
std::vector<uint16_t> shortFrames;
std::array<float, 3> constant{};
};
struct BoneTrack
{
std::string name;
QuatTrack quat;
TransTrack trans;
};
struct FlatDataCursor
{
const uint8_t* dataByte;
const int16_t* dataShort;
const int* dataInt;
const uint8_t* randomDataByte;
const int16_t* randomDataShort;
const uint16_t* indices;
};
struct DeltaQuatTrack
{
bool keyframed = false;
std::vector<uint16_t> indices;
std::vector<int16_t> values;
};
struct DeltaTransTrack
{
bool keyframed = false;
bool smallTrans = false;
std::vector<uint16_t> indices;
std::array<float, 3> mins{};
std::array<float, 3> size{};
std::vector<uint8_t> byteFrames;
std::vector<uint16_t> shortFrames;
std::array<float, 3> constant{};
};
struct DeltaTrack
{
std::optional<DeltaQuatTrack> quat;
std::optional<DeltaTransTrack> trans;
};
struct EncodedQuatTrack
{
bool flipQuat = false;
std::vector<int16_t> storedValues;
};
[[nodiscard]] const std::string& ResolveScriptString(const XAssetInfo<XAnimParts>& asset, const ScriptString value)
{
assert(asset.m_zone != nullptr && value < asset.m_zone->m_script_strings.Count());
return asset.m_zone->m_script_strings[value];
}
[[nodiscard]] uint16_t GetNumLoopFrames(const XAnimParts& parts)
{
assert(parts.numframes < std::numeric_limits<uint16_t>::max());
// Raw non-looped xanims store numframes + 1 in keyed track counts/header fields.
return static_cast<uint16_t>(parts.numframes + 1u);
}
[[nodiscard]] bool UseByteIndices(const XAnimParts& parts)
{
return parts.numframes < 256;
}
[[nodiscard]] float IntBitsToFloat(const int value)
{
union
{
int i;
float f;
};
i = value;
return f;
}
[[nodiscard]] std::array<float, 3> ReadFloat3(const int*& dataInt)
{
std::array<float, 3> result{};
for (float& i : result)
i = IntBitsToFloat(*dataInt++);
return result;
}
template<typename T> [[nodiscard]] const T* AdvancePtr(const T* ptr, const size_t count)
{
if (count == 0uz)
return ptr;
assert(ptr != nullptr);
return ptr + count;
}
[[nodiscard]] std::vector<uint16_t> ReadPackedIndices(FlatDataCursor& cursor, const uint16_t storedSize, const bool useByteIndices)
{
const auto count = static_cast<size_t>(storedSize) + 1uz;
std::vector<uint16_t> result(count);
if (useByteIndices)
{
for (auto i = 0uz; i < count; i++)
result[i] = cursor.dataByte[i];
cursor.dataByte += count;
return result;
}
// The linker moves 16-bit frame indices into the top-level indices pool only when
// the in-memory stored size is at least 64, i.e. frameCount >= 65.
if (storedSize >= 64u)
{
for (auto i = 0uz; i < count; i++)
result[i] = cursor.indices[i];
cursor.indices += count;
// The game inserts checkpoint values in dataShort
// Those checkpoint values are copied from positions in the full index list: the first entry, then every 256th entry, and always the final entry.
// The final entry is included even when it does not land exactly on a 256-entry boundary.
cursor.dataShort += ((count - 2uz) / 256u) + 2uz;
return result;
}
for (auto i = 0uz; i < count; i++)
result[i] = static_cast<uint16_t>(cursor.dataShort[i]);
cursor.dataShort += count;
return result;
}
[[nodiscard]] bool IsSequentialCoverage(const std::vector<uint16_t>& indices, const uint16_t numLoopFrames)
{
if (indices.size() != numLoopFrames)
return false;
for (auto i = 0uz; i < indices.size(); i++)
{
if (indices[i] != i)
return false;
}
return true;
}
[[nodiscard]] bool QuatTypeUsesHalf(const QuatType type)
{
return type == QuatType::NO_QUAT || type == QuatType::HALF_QUAT || type == QuatType::HALF_QUAT_NO_SIZE;
}
[[nodiscard]] float EncodeRawTransSize(const float value, const bool smallTrans)
{
const auto scale = smallTrans ? HALF_TRANS_SIZE_SCALE : FULL_TRANS_SIZE_SCALE;
return value / scale;
}
[[nodiscard]] int64_t ComputeQuatDot(const int16_t* lhs, const int16_t* rhs, const size_t componentCount)
{
int64_t result = 0;
for (auto i = 0uz; i < componentCount; i++)
result += static_cast<int64_t>(lhs[i]) * static_cast<int64_t>(rhs[i]);
return result;
}
[[nodiscard]] EncodedQuatTrack EncodeQuatFrames(const int16_t* values, const size_t frameCount, const size_t componentCount, const bool allowFlipQuat)
{
assert(componentCount == 2uz || componentCount == 4uz);
EncodedQuatTrack result;
if (frameCount == 0uz)
return result;
const auto storedComponentCount = componentCount - 1uz;
result.storedValues.reserve(frameCount * storedComponentCount);
// Raw IW3 xanims store only N-1 quat components. The loader reconstructs the
// final component with a positive sqrt, applies the per-bone flip bit, and then
// continuity-corrects subsequent frames by optionally negating whole quats.
result.flipQuat = allowFlipQuat && values[storedComponentCount] < 0;
const auto targetNegativeOmitted = result.flipQuat;
for (auto frameIndex = 0uz; frameIndex < frameCount; frameIndex++)
{
const auto* frame = &values[frameIndex * componentCount];
const auto omittedNegative = frame[storedComponentCount] < 0;
auto continuityNegated = false;
if (frameIndex > 0uz && omittedNegative != targetNegativeOmitted)
{
const auto* prevFrame = &values[(frameIndex - 1uz) * componentCount];
continuityNegated = ComputeQuatDot(prevFrame, frame, componentCount) > 0;
}
const auto rawNegated = result.flipQuat != continuityNegated;
const auto sign = rawNegated ? -1 : 1;
for (auto componentIndex = 0uz; componentIndex < storedComponentCount; componentIndex++)
{
const auto value = static_cast<int>(frame[componentIndex]) * sign;
assert(value >= std::numeric_limits<int16_t>::min() && value <= std::numeric_limits<int16_t>::max());
result.storedValues.emplace_back(static_cast<int16_t>(value));
}
}
return result;
}
[[nodiscard]] EncodedQuatTrack EncodeQuatTrack(const QuatTrack& quat)
{
switch (quat.type)
{
case QuatType::NO_QUAT:
return {};
case QuatType::HALF_QUAT_NO_SIZE:
assert(quat.values.size() == 2uz);
return EncodeQuatFrames(quat.values.data(), 1uz, 2uz, true);
case QuatType::FULL_QUAT_NO_SIZE:
assert(quat.values.size() == 4uz);
return EncodeQuatFrames(quat.values.data(), 1uz, 4uz, true);
case QuatType::HALF_QUAT:
{
const auto frameCount = quat.indices.size();
assert(quat.values.size() == frameCount * 2uz);
return EncodeQuatFrames(quat.values.data(), frameCount, 2uz, true);
}
case QuatType::FULL_QUAT:
{
const auto frameCount = quat.indices.size();
assert(quat.values.size() == frameCount * 4uz);
return EncodeQuatFrames(quat.values.data(), frameCount, 4uz, true);
}
}
assert(false);
return {};
}
[[nodiscard]] EncodedQuatTrack EncodeDeltaQuatTrack(const DeltaTrack& delta)
{
if (!delta.quat)
return {};
// Delta quats are serialized without the per-bone flipQuat mask used by normal bone quats.
if (!delta.quat->keyframed)
{
assert(delta.quat->values.size() == 2uz);
return EncodeQuatFrames(delta.quat->values.data(), 1uz, 2uz, false);
}
const auto frameCount = delta.quat->indices.size();
assert(delta.quat->values.size() == frameCount * 2uz);
return EncodeQuatFrames(delta.quat->values.data(), frameCount, 2uz, false);
}
std::string CreateReconstructionError(const XAssetInfo<XAnimParts>& asset, const char* field)
{
return std::format("IW3 xanim raw reconstruction cursor mismatch for asset \"{}\" in {}", asset.m_name, field);
}
[[nodiscard]] std::expected<std::vector<BoneTrack>, std::string> ReconstructBoneTracks(const XAssetInfo<XAnimParts>& asset)
{
const auto& parts = *asset.Asset();
const auto nameCount = static_cast<size_t>(parts.boneCount[PART_TYPE_ALL]);
const auto useByteIndices = UseByteIndices(parts);
std::vector<BoneTrack> bones(nameCount);
for (auto i = 0uz; i < nameCount; i++)
bones[i].name = ResolveScriptString(asset, parts.names[i]);
// Root indices should only ever be used when it is !useByteIndices, therefore we should be safe to always use the short version
assert(!useByteIndices || parts.indices._1 == nullptr);
auto cursor = FlatDataCursor{
.dataByte = parts.dataByte,
.dataShort = parts.dataShort,
.dataInt = parts.dataInt,
.randomDataByte = parts.randomDataByte,
.randomDataShort = parts.randomDataShort,
.indices = parts.indices._2,
};
size_t boneIndex = 0;
for (auto i = 0u; i < parts.boneCount[PART_TYPE_NO_QUAT]; i++, boneIndex++)
bones[boneIndex].quat.type = QuatType::NO_QUAT;
for (auto i = 0u; i < parts.boneCount[PART_TYPE_HALF_QUAT]; i++, boneIndex++)
{
auto& quat = bones[boneIndex].quat;
quat.type = QuatType::HALF_QUAT;
const auto storedSize = static_cast<uint16_t>(*cursor.dataShort++);
const auto frameCount = static_cast<size_t>(storedSize) + 1uz;
quat.indices = ReadPackedIndices(cursor, storedSize, useByteIndices);
quat.values.assign(cursor.randomDataShort, cursor.randomDataShort + frameCount * 2uz);
cursor.randomDataShort += frameCount * 2uz;
}
for (auto i = 0u; i < parts.boneCount[PART_TYPE_FULL_QUAT]; i++, boneIndex++)
{
auto& quat = bones[boneIndex].quat;
quat.type = QuatType::FULL_QUAT;
const auto storedSize = static_cast<uint16_t>(*cursor.dataShort++);
const auto frameCount = static_cast<size_t>(storedSize) + 1uz;
quat.indices = ReadPackedIndices(cursor, storedSize, useByteIndices);
quat.values.assign(cursor.randomDataShort, cursor.randomDataShort + frameCount * 4uz);
cursor.randomDataShort += frameCount * 4uz;
}
for (auto i = 0u; i < parts.boneCount[PART_TYPE_HALF_QUAT_NO_SIZE]; i++, boneIndex++)
{
auto& quat = bones[boneIndex].quat;
quat.type = QuatType::HALF_QUAT_NO_SIZE;
quat.values.assign(cursor.dataShort, cursor.dataShort + 2);
cursor.dataShort += 2;
}
for (auto i = 0u; i < parts.boneCount[PART_TYPE_FULL_QUAT_NO_SIZE]; i++, boneIndex++)
{
auto& quat = bones[boneIndex].quat;
quat.type = QuatType::FULL_QUAT_NO_SIZE;
quat.values.assign(cursor.dataShort, cursor.dataShort + 4);
cursor.dataShort += 4;
}
std::vector<bool> transAssigned(nameCount, false);
for (auto i = 0u; i < parts.boneCount[PART_TYPE_SMALL_TRANS]; i++)
{
const auto bone = static_cast<size_t>(*cursor.dataByte++);
assert(bone < nameCount && !transAssigned[bone]);
auto& trans = bones[bone].trans;
transAssigned[bone] = true;
trans.type = TransType::SMALL_TRANS;
const auto storedSize = static_cast<uint16_t>(*cursor.dataShort++);
const auto frameCount = static_cast<size_t>(storedSize) + 1uz;
trans.mins = ReadFloat3(cursor.dataInt);
trans.size = ReadFloat3(cursor.dataInt);
trans.indices = ReadPackedIndices(cursor, storedSize, useByteIndices);
trans.byteFrames.assign(cursor.randomDataByte, cursor.randomDataByte + frameCount * 3uz);
cursor.randomDataByte += frameCount * 3uz;
}
for (auto i = 0u; i < parts.boneCount[PART_TYPE_TRANS]; i++)
{
const auto bone = static_cast<size_t>(*cursor.dataByte++);
assert(bone < nameCount && !transAssigned[bone]);
auto& trans = bones[bone].trans;
transAssigned[bone] = true;
trans.type = TransType::FULL_TRANS;
const auto storedSize = static_cast<uint16_t>(*cursor.dataShort++);
const auto frameCount = static_cast<size_t>(storedSize) + 1uz;
trans.mins = ReadFloat3(cursor.dataInt);
trans.size = ReadFloat3(cursor.dataInt);
trans.indices = ReadPackedIndices(cursor, storedSize, useByteIndices);
trans.shortFrames.reserve(frameCount * 3uz);
for (auto frame = 0uz; frame < frameCount * 3uz; frame++)
trans.shortFrames.emplace_back(static_cast<uint16_t>(*cursor.randomDataShort++));
}
for (auto i = 0u; i < parts.boneCount[PART_TYPE_TRANS_NO_SIZE]; i++)
{
const auto bone = static_cast<size_t>(*cursor.dataByte++);
assert(bone < nameCount && !transAssigned[bone]);
auto& trans = bones[bone].trans;
transAssigned[bone] = true;
trans.type = TransType::TRANS_NO_SIZE;
trans.constant = ReadFloat3(cursor.dataInt);
}
for (auto i = 0u; i < parts.boneCount[PART_TYPE_NO_TRANS]; i++)
{
const auto bone = static_cast<size_t>(*cursor.dataByte++);
assert(bone < nameCount && !transAssigned[bone]);
bones[bone].trans.type = TransType::NO_TRANS;
transAssigned[bone] = true;
}
for (auto i = 0uz; i < nameCount; i++)
assert(transAssigned[i]);
const auto dataByteEnd = AdvancePtr(parts.dataByte, parts.dataByteCount);
const auto dataShortEnd = AdvancePtr(parts.dataShort, parts.dataShortCount);
const auto dataIntEnd = AdvancePtr(parts.dataInt, parts.dataIntCount);
const auto randomDataByteEnd = AdvancePtr(parts.randomDataByte, parts.randomDataByteCount);
const auto randomDataShortEnd = AdvancePtr(parts.randomDataShort, parts.randomDataShortCount);
if (cursor.dataByte != dataByteEnd)
return std::unexpected(CreateReconstructionError(asset, "dataByte"));
if (cursor.dataShort != dataShortEnd)
return std::unexpected(CreateReconstructionError(asset, "dataShort"));
if (cursor.dataInt != dataIntEnd)
return std::unexpected(CreateReconstructionError(asset, "dataInt"));
if (cursor.randomDataByte != randomDataByteEnd)
return std::unexpected(CreateReconstructionError(asset, "randomDataByte"));
if (cursor.randomDataShort != randomDataShortEnd)
return std::unexpected(CreateReconstructionError(asset, "randomDataShort"));
if (!useByteIndices)
{
const auto indicesEnd = AdvancePtr(parts.indices._2, parts.indexCount);
if (cursor.indices != indicesEnd)
return std::unexpected(CreateReconstructionError(asset, "indices"));
}
else
{
assert(parts.indexCount == 0);
}
return bones;
}
[[nodiscard]] DeltaTrack ReconstructDeltaTrack(const XAnimParts& parts)
{
DeltaTrack result;
assert(static_cast<bool>(parts.deltaPart) == static_cast<bool>(parts.bDelta));
if (!parts.deltaPart)
return result;
const auto numLoopFrames = GetNumLoopFrames(parts);
const auto useByteIndices = UseByteIndices(parts);
if (const auto* quat = parts.deltaPart->quat; quat)
{
result.quat.emplace();
if (quat->size > 0)
{
result.quat->keyframed = true;
const auto frameCount = static_cast<size_t>(quat->size) + 1uz;
result.quat->values.reserve(frameCount * 2uz);
result.quat->indices.reserve(frameCount);
for (auto i = 0uz; i < frameCount; i++)
{
result.quat->values.emplace_back(quat->u.frames.frames[i].value[0]);
result.quat->values.emplace_back(quat->u.frames.frames[i].value[1]);
}
if (useByteIndices)
{
for (auto i = 0uz; i < frameCount; i++)
result.quat->indices.emplace_back(static_cast<uint8_t>(quat->u.frames.indices._1[i]));
}
else
{
for (auto i = 0uz; i < frameCount; i++)
result.quat->indices.emplace_back(quat->u.frames.indices._2[i]);
}
assert(result.quat->indices.size() <= numLoopFrames);
}
else
{
result.quat->values.emplace_back(quat->u.frame0.value[0]);
result.quat->values.emplace_back(quat->u.frame0.value[1]);
}
}
if (const auto* trans = parts.deltaPart->trans; trans)
{
result.trans.emplace();
if (trans->size > 0)
{
result.trans->keyframed = true;
result.trans->smallTrans = trans->smallTrans;
result.trans->mins = {trans->u.frames.mins.x, trans->u.frames.mins.y, trans->u.frames.mins.z};
result.trans->size = {trans->u.frames.size.x, trans->u.frames.size.y, trans->u.frames.size.z};
const auto frameCount = static_cast<size_t>(trans->size) + 1uz;
result.trans->indices.reserve(frameCount);
if (useByteIndices)
{
for (auto i = 0uz; i < frameCount; i++)
result.trans->indices.emplace_back(static_cast<uint8_t>(trans->u.frames.indices._1[i]));
}
else
{
for (auto i = 0uz; i < frameCount; i++)
result.trans->indices.emplace_back(trans->u.frames.indices._2[i]);
}
if (trans->smallTrans)
{
result.trans->byteFrames.reserve(frameCount * 3uz);
for (auto i = 0uz; i < frameCount; i++)
{
result.trans->byteFrames.emplace_back(trans->u.frames.frames._1[i][0]);
result.trans->byteFrames.emplace_back(trans->u.frames.frames._1[i][1]);
result.trans->byteFrames.emplace_back(trans->u.frames.frames._1[i][2]);
}
}
else
{
result.trans->shortFrames.reserve(frameCount * 3uz);
for (auto i = 0uz; i < frameCount; i++)
{
result.trans->shortFrames.emplace_back(trans->u.frames.frames._2[i][0]);
result.trans->shortFrames.emplace_back(trans->u.frames.frames._2[i][1]);
result.trans->shortFrames.emplace_back(trans->u.frames.frames._2[i][2]);
}
}
}
else
{
result.trans->constant = {trans->u.frame0.v[0], trans->u.frame0.v[1], trans->u.frame0.v[2]};
}
}
return result;
}
void WriteIndicesIfNeeded(std::ostream& stream, const std::vector<uint16_t>& indices, const uint16_t numLoopFrames, const bool useByteIndices)
{
if (indices.empty())
return;
// The raw format omits indices when a track covers every loop frame in order.
if (indices.size() >= numLoopFrames)
{
assert(IsSequentialCoverage(indices, numLoopFrames));
return;
}
if (useByteIndices)
{
for (const auto index : indices)
{
assert(index <= std::numeric_limits<uint8_t>::max());
const auto asByte = static_cast<uint8_t>(index);
stream::WriteValue(stream, asByte);
}
}
else
{
for (const auto index : indices)
stream::WriteValue(stream, index);
}
}
void WriteQuatTrack(
std::ostream& stream, const QuatTrack& quat, const EncodedQuatTrack& encodedQuat, const uint16_t numLoopFrames, const bool useByteIndices)
{
switch (quat.type)
{
case QuatType::NO_QUAT:
{
stream::WriteValue(stream, static_cast<uint16_t>(0));
break;
}
case QuatType::HALF_QUAT_NO_SIZE:
{
assert(encodedQuat.storedValues.size() == 1uz);
stream::WriteValue(stream, static_cast<uint16_t>(1));
stream::WriteValue(stream, encodedQuat.storedValues[0]);
break;
}
case QuatType::FULL_QUAT_NO_SIZE:
{
assert(encodedQuat.storedValues.size() == 3uz);
stream::WriteValue(stream, static_cast<uint16_t>(1));
for (const auto value : encodedQuat.storedValues)
stream::WriteValue(stream, value);
break;
}
case QuatType::HALF_QUAT:
{
const auto frameCount = quat.indices.size();
assert(frameCount > 0uz);
assert(quat.values.size() == frameCount * 2uz);
assert(encodedQuat.storedValues.size() == frameCount);
stream::WriteValue(stream, static_cast<uint16_t>(frameCount));
WriteIndicesIfNeeded(stream, quat.indices, numLoopFrames, useByteIndices);
for (const auto value : encodedQuat.storedValues)
stream::WriteValue(stream, value);
break;
}
case QuatType::FULL_QUAT:
{
const auto frameCount = quat.indices.size();
assert(frameCount > 0uz);
assert(quat.values.size() == frameCount * 4uz);
assert(encodedQuat.storedValues.size() == frameCount * 3uz);
stream::WriteValue(stream, static_cast<uint16_t>(frameCount));
WriteIndicesIfNeeded(stream, quat.indices, numLoopFrames, useByteIndices);
for (const auto value : encodedQuat.storedValues)
stream::WriteValue(stream, value);
break;
}
}
}
void WriteTransTrack(std::ostream& stream, const TransTrack& trans, const uint16_t numLoopFrames, const bool useByteIndices)
{
switch (trans.type)
{
case TransType::NO_TRANS:
{
stream::WriteValue(stream, static_cast<uint16_t>(0));
break;
}
case TransType::TRANS_NO_SIZE:
{
stream::WriteValue(stream, static_cast<uint16_t>(1));
for (const auto value : trans.constant)
stream::WriteValue(stream, value);
break;
}
case TransType::SMALL_TRANS:
{
const auto frameCount = trans.indices.size();
assert(frameCount > 0uz);
assert(trans.byteFrames.size() == frameCount * 3uz);
stream::WriteValue(stream, static_cast<uint16_t>(frameCount));
WriteIndicesIfNeeded(stream, trans.indices, numLoopFrames, useByteIndices);
constexpr auto smallTrans = static_cast<uint8_t>(1);
stream::WriteValue(stream, smallTrans);
for (const auto value : trans.mins)
stream::WriteValue(stream, value);
for (const auto value : trans.size)
stream::WriteValue(stream, EncodeRawTransSize(value, true));
stream::Write(stream, trans.byteFrames.data(), trans.byteFrames.size());
break;
}
case TransType::FULL_TRANS:
{
const auto frameCount = trans.indices.size();
assert(frameCount > 0uz);
assert(trans.shortFrames.size() == frameCount * 3uz);
stream::WriteValue(stream, static_cast<uint16_t>(frameCount));
WriteIndicesIfNeeded(stream, trans.indices, numLoopFrames, useByteIndices);
constexpr auto smallTrans = static_cast<uint8_t>(0);
stream::WriteValue(stream, smallTrans);
for (const auto value : trans.mins)
stream::WriteValue(stream, value);
for (const auto value : trans.size)
stream::WriteValue(stream, EncodeRawTransSize(value, false));
for (const auto value : trans.shortFrames)
stream::WriteValue(stream, value);
break;
}
}
}
void WriteDeltaQuatTrack(std::ostream& stream, const DeltaTrack& delta, const uint16_t numLoopFrames, const bool useByteIndices)
{
const auto encodedDeltaQuat = EncodeDeltaQuatTrack(delta);
if (!delta.quat)
{
stream::WriteValue(stream, static_cast<uint16_t>(0));
}
else if (!delta.quat->keyframed)
{
assert(encodedDeltaQuat.storedValues.size() == 1uz);
stream::WriteValue(stream, static_cast<uint16_t>(1));
stream::WriteValue(stream, encodedDeltaQuat.storedValues[0]);
}
else
{
const auto frameCount = delta.quat->indices.size();
assert(frameCount > 0uz);
assert(delta.quat->values.size() == frameCount * 2uz);
assert(encodedDeltaQuat.storedValues.size() == frameCount);
stream::WriteValue(stream, static_cast<uint16_t>(frameCount));
WriteIndicesIfNeeded(stream, delta.quat->indices, numLoopFrames, useByteIndices);
for (const auto value : encodedDeltaQuat.storedValues)
stream::WriteValue(stream, value);
}
}
void WriteDeltaTransTrack(std::ostream& stream, const DeltaTrack& delta, const uint16_t numLoopFrames, const bool useByteIndices)
{
if (!delta.trans)
{
stream::WriteValue(stream, static_cast<uint16_t>(0));
return;
}
if (!delta.trans->keyframed)
{
stream::WriteValue(stream, static_cast<uint16_t>(1));
for (const auto value : delta.trans->constant)
stream::WriteValue(stream, value);
return;
}
const auto frameCount = delta.trans->indices.size();
assert(frameCount > 0uz);
stream::WriteValue(stream, static_cast<uint16_t>(frameCount));
WriteIndicesIfNeeded(stream, delta.trans->indices, numLoopFrames, useByteIndices);
const auto smallTrans = static_cast<uint8_t>(delta.trans->smallTrans ? 1 : 0);
stream::WriteValue(stream, smallTrans);
for (const auto value : delta.trans->mins)
stream::WriteValue(stream, value);
if (delta.trans->smallTrans)
{
assert(delta.trans->byteFrames.size() == frameCount * 3uz);
for (const auto value : delta.trans->size)
stream::WriteValue(stream, EncodeRawTransSize(value, true));
stream::Write(stream, delta.trans->byteFrames.data(), delta.trans->byteFrames.size());
}
else
{
assert(delta.trans->shortFrames.size() == frameCount * 3uz);
for (const auto value : delta.trans->size)
stream::WriteValue(stream, EncodeRawTransSize(value, false));
for (const auto value : delta.trans->shortFrames)
stream::WriteValue(stream, value);
}
}
void WriteDeltaTrack(std::ostream& stream, const DeltaTrack& delta, const uint16_t numLoopFrames, const bool useByteIndices)
{
WriteDeltaQuatTrack(stream, delta, numLoopFrames, useByteIndices);
WriteDeltaTransTrack(stream, delta, numLoopFrames, useByteIndices);
}
void WriteNoteTracks(std::ostream& stream, const XAssetInfo<XAnimParts>& asset)
{
const auto& parts = *asset.Asset();
const auto notifyCount = static_cast<size_t>(parts.notifyCount);
size_t rawNotifyCount = notifyCount;
if (notifyCount > 0uz)
{
const auto& lastName = ResolveScriptString(asset, parts.notify[notifyCount - 1].name);
const auto lastTime = parts.notify[notifyCount - 1].time;
// The linker appends a synthetic "end" notify at 1.0f to the loaded asset state.
if (lastName == "end" && std::abs(lastTime - 1.0f) < 0.0001f)
rawNotifyCount--;
}
assert(rawNotifyCount < 255uz);
const auto rawNotifyCountByte = static_cast<uint8_t>(rawNotifyCount);
stream::WriteValue(stream, rawNotifyCountByte);
for (auto i = 0uz; i < rawNotifyCount; i++)
{
stream::WriteCString(stream, ResolveScriptString(asset, parts.notify[i].name));
uint16_t frame = 0;
if (parts.numframes > 0)
{
const auto scaled = static_cast<long>(std::lround(parts.notify[i].time * static_cast<float>(parts.numframes)));
assert(scaled >= 0 && scaled <= std::numeric_limits<uint16_t>::max());
frame = static_cast<uint16_t>(scaled);
}
stream::WriteValue(stream, frame);
}
}
} // namespace
namespace xanim
{
void DumperIW3::DumpAsset(AssetDumpingContext& context, const XAssetInfo<AssetXAnim::Type>& asset)
{
const auto* parts = asset.Asset();
auto maybeBoneTracks = ReconstructBoneTracks(asset);
if (!maybeBoneTracks.has_value())
{
con::error(maybeBoneTracks.error());
return;
}
const auto boneTracks = std::move(maybeBoneTracks).value();
const auto assetFile = context.OpenAssetFile(GetCompiledFileNameForAssetName(asset.m_name));
if (!assetFile)
return;
const auto numLoopFrames = GetNumLoopFrames(*parts);
const auto useByteIndices = UseByteIndices(*parts);
const auto deltaTrack = ReconstructDeltaTrack(*parts);
std::vector<EncodedQuatTrack> encodedBoneQuats;
encodedBoneQuats.reserve(boneTracks.size());
for (const auto& bone : boneTracks)
encodedBoneQuats.emplace_back(EncodeQuatTrack(bone.quat));
auto& stream = *assetFile;
const auto flags = static_cast<uint8_t>((parts->bLoop ? FLAG_LOOPED : 0u) | (parts->bDelta ? FLAG_DELTA : 0u));
const auto boneCount = static_cast<uint16_t>(parts->boneCount[PART_TYPE_ALL]);
const auto assetType = static_cast<uint8_t>(parts->assetType);
const auto framerate = static_cast<uint16_t>(std::lround(parts->framerate));
stream::WriteValue(stream, RAW_VERSION);
// Looped raws store numframes directly; non-looped raws store numframes + 1.
stream::WriteValue(stream, static_cast<uint16_t>(parts->bLoop ? parts->numframes : numLoopFrames));
stream::WriteValue(stream, boneCount);
stream::WriteValue(stream, flags);
stream::WriteValue(stream, assetType);
stream::WriteValue(stream, framerate);
if (parts->bDelta)
WriteDeltaTrack(stream, deltaTrack, numLoopFrames, useByteIndices);
if (!boneTracks.empty())
{
const auto bitmaskSize = utils::Align<size_t>(boneTracks.size(), 8u) / 8u;
std::vector<uint8_t> flipQuat(bitmaskSize, 0);
std::vector<uint8_t> halfQuat(bitmaskSize, 0);
for (size_t i = 0u; i < boneTracks.size(); i++)
{
if (encodedBoneQuats[i].flipQuat)
flipQuat[i / 8u] |= static_cast<uint8_t>(1u << (i % 8u));
if (QuatTypeUsesHalf(boneTracks[i].quat.type))
halfQuat[i / 8u] |= static_cast<uint8_t>(1u << (i % 8u));
}
stream::Write(stream, flipQuat.data(), flipQuat.size());
stream::Write(stream, halfQuat.data(), halfQuat.size());
for (const auto& bone : boneTracks)
stream::WriteCString(stream, bone.name);
for (auto i = 0uz; i < boneTracks.size(); i++)
{
WriteQuatTrack(stream, boneTracks[i].quat, encodedBoneQuats[i], numLoopFrames, useByteIndices);
WriteTransTrack(stream, boneTracks[i].trans, numLoopFrames, useByteIndices);
}
}
WriteNoteTracks(stream, asset);
}
} // namespace xanim
@@ -0,0 +1,13 @@
#pragma once
#include "Dumping/AbstractAssetDumper.h"
#include "Game/IW3/IW3.h"
namespace xanim
{
class DumperIW3 final : public AbstractAssetDumper<IW3::AssetXAnim>
{
protected:
void DumpAsset(AssetDumpingContext& context, const XAssetInfo<IW3::AssetXAnim::Type>& asset) override;
};
} // namespace xanim