#include "TechsetDumperIW4.h" #include "Dumping/AbstractTextDumper.h" #include "Game/IW4/Techset/TechsetConstantsIW4.h" #include "Pool/GlobalAssetPool.h" #include "Shader/D3D9ShaderAnalyser.h" #include "Techset/CommonTechset.h" #include "Techset/CommonTechsetDumper.h" #include "Techset/TechniqueDumpingZoneState.h" #include "Techset/TechsetCommon.h" #include "Utils/Logging/Log.h" #include #include #include #include #include #include using namespace IW4; namespace { class TechniqueFileWriter : public AbstractTextDumper { void DumpStateMap() const { Indent(); // TODO: Actual statemap: Maybe find all materials using this techset and try to make out rules for the flags based on the statebitstable m_stream << "stateMap \"passthrough\"; // TODO\n"; } static bool FindCodeConstantSourceAccessor(const MaterialConstantSource sourceIndexToFind, const CodeConstantSource* codeConstantTable, std::string& codeSourceAccessor) { const auto* currentCodeConst = codeConstantTable; while (currentCodeConst->name != nullptr) { if (currentCodeConst->subtable != nullptr) { std::string accessorInSubTable; if (FindCodeConstantSourceAccessor(sourceIndexToFind, currentCodeConst->subtable, accessorInSubTable)) { std::ostringstream ss; ss << currentCodeConst->name << '.' << accessorInSubTable; codeSourceAccessor = ss.str(); return true; } } else if (currentCodeConst->arrayCount > 0) { if (currentCodeConst->source <= sourceIndexToFind && static_cast(currentCodeConst->source) + currentCodeConst->arrayCount > static_cast(sourceIndexToFind)) { std::ostringstream ss; ss << currentCodeConst->name << '[' << (static_cast(sourceIndexToFind) - static_cast(currentCodeConst->source)) << ']'; codeSourceAccessor = ss.str(); return true; } } else if (currentCodeConst->source == sourceIndexToFind) { codeSourceAccessor = currentCodeConst->name; return true; } currentCodeConst++; } return false; } static bool FindCodeSamplerSourceAccessor(const MaterialTextureSource sourceIndexToFind, const CodeSamplerSource* codeSamplerTable, std::string& codeSourceAccessor) { const auto* currentCodeConst = codeSamplerTable; while (currentCodeConst->name != nullptr) { if (currentCodeConst->subtable != nullptr) { std::string accessorInSubTable; if (FindCodeSamplerSourceAccessor(sourceIndexToFind, currentCodeConst->subtable, accessorInSubTable)) { std::ostringstream ss; ss << currentCodeConst->name << '.' << accessorInSubTable; codeSourceAccessor = ss.str(); return true; } } else if (currentCodeConst->arrayCount > 0) { if (currentCodeConst->source <= sourceIndexToFind && static_cast(currentCodeConst->source) + currentCodeConst->arrayCount > static_cast(sourceIndexToFind)) { std::ostringstream ss; ss << currentCodeConst->name << '[' << (static_cast(sourceIndexToFind) - static_cast(currentCodeConst->source)) << ']'; codeSourceAccessor = ss.str(); return true; } } else if (currentCodeConst->source == sourceIndexToFind) { codeSourceAccessor = currentCodeConst->name; return true; } currentCodeConst++; } return false; } void DumpShaderArg(const MaterialShaderArgument& arg, const d3d9::ShaderInfo& shaderInfo) const { const auto expectedRegisterSet = arg.type == MTL_ARG_CODE_PIXEL_SAMPLER || arg.type == MTL_ARG_MATERIAL_PIXEL_SAMPLER ? d3d9::RegisterSet::SAMPLER : d3d9::RegisterSet::FLOAT_4; const auto targetShaderArg = std::ranges::find_if(shaderInfo.m_constants, [arg, expectedRegisterSet](const d3d9::ShaderConstant& constant) { return constant.m_register_set == expectedRegisterSet && constant.m_register_index <= arg.dest && constant.m_register_index + constant.m_register_count > arg.dest; }); assert(targetShaderArg != shaderInfo.m_constants.end()); if (targetShaderArg == shaderInfo.m_constants.end()) { m_stream << "// Unrecognized arg dest:" << arg.dest << " type: " << arg.type << "\n"; return; } std::string codeDestAccessor; if (targetShaderArg->m_type_elements > 1) { std::ostringstream ss; ss << targetShaderArg->m_name << '[' << (arg.dest - targetShaderArg->m_register_index) << ']'; codeDestAccessor = ss.str(); } else codeDestAccessor = targetShaderArg->m_name; if (arg.type == MTL_ARG_CODE_VERTEX_CONST || arg.type == MTL_ARG_CODE_PIXEL_CONST) { const auto sourceIndex = static_cast(arg.u.codeConst.index); std::string codeSourceAccessor; if (FindCodeConstantSourceAccessor(sourceIndex, s_codeConsts, codeSourceAccessor) || FindCodeConstantSourceAccessor(sourceIndex, s_defaultCodeConsts, codeSourceAccessor)) { if (codeDestAccessor != codeSourceAccessor) { Indent(); m_stream << codeDestAccessor << " = constant." << codeSourceAccessor << ";\n"; } else { #ifdef TECHSET_DEBUG Indent(); m_stream << "// Omitted due to matching accessors: " << codeDestAccessor << " = constant." << codeSourceAccessor << ";\n"; #endif } } else { assert(false); Indent(); m_stream << codeDestAccessor << " = UNKNOWN;\n"; } } else if (arg.type == MTL_ARG_CODE_PIXEL_SAMPLER) { const auto sourceIndex = static_cast(arg.u.codeSampler); std::string codeSourceAccessor; if (FindCodeSamplerSourceAccessor(sourceIndex, s_codeSamplers, codeSourceAccessor) || FindCodeSamplerSourceAccessor(sourceIndex, s_defaultCodeSamplers, codeSourceAccessor)) { if (codeDestAccessor != codeSourceAccessor) { Indent(); m_stream << codeDestAccessor << " = sampler." << codeSourceAccessor << ";\n"; } else { #ifdef TECHSET_DEBUG Indent(); m_stream << "// Omitted due to matching accessors: " << codeDestAccessor << " = sampler." << codeSourceAccessor << ";\n"; #endif } } else { assert(false); Indent(); m_stream << codeDestAccessor << " = UNKNOWN;\n"; } } else if (arg.type == MTL_ARG_LITERAL_VERTEX_CONST || arg.type == MTL_ARG_LITERAL_PIXEL_CONST) { if (arg.u.literalConst) { Indent(); m_stream << codeDestAccessor << " = float4( " << (*arg.u.literalConst)[0] << ", " << (*arg.u.literalConst)[1] << ", " << (*arg.u.literalConst)[2] << ", " << (*arg.u.literalConst)[3] << " );\n"; } } else if (arg.type == MTL_ARG_MATERIAL_PIXEL_CONST || arg.type == MTL_ARG_MATERIAL_VERTEX_CONST || arg.type == MTL_ARG_MATERIAL_PIXEL_SAMPLER) { Indent(); m_stream << codeDestAccessor << " = material."; const auto knownConstantName = knownConstantNames.find(arg.u.nameHash); if (knownConstantName != knownConstantNames.end()) { m_stream << knownConstantName->second; } else { const auto knownMaterialTextureName = knownTextureMaps.find(arg.u.nameHash); if (knownMaterialTextureName != knownTextureMaps.end()) { m_stream << knownMaterialTextureName->second.m_name; } else { const auto shaderArgNameHash = Common::R_HashString(targetShaderArg->m_name.c_str(), 0u); if (shaderArgNameHash == arg.u.nameHash) m_stream << targetShaderArg->m_name; else m_stream << "#0x" << std::hex << arg.u.nameHash; } } m_stream << ";\n"; } else { assert(false); } } void DumpVertexShader(const MaterialPass& pass) { auto vertexShader = pass.vertexShader; if (vertexShader == nullptr || vertexShader->name == nullptr) return; if (vertexShader->name[0] == ',') { const auto loadedVertexShaderFromOtherZone = GameGlobalAssetPools::GetGlobalPoolsForGame(GameId::IW4)->GetAsset(&vertexShader->name[1]); if (loadedVertexShaderFromOtherZone == nullptr) { // Cannot dump when shader is referenced due to unknown constant names and unknown version Indent(); con::error("Cannot dump vertex shader {} due to being a referenced asset", &vertexShader->name[1]); m_stream << std::format("// Cannot dump vertex shader {} due to being a referenced asset\n", &vertexShader->name[1]); return; } vertexShader = loadedVertexShaderFromOtherZone->Asset(); } const auto vertexShaderInfo = d3d9::ShaderAnalyser::GetShaderInfo(vertexShader->prog.loadDef.program, vertexShader->prog.loadDef.programSize * sizeof(uint32_t)); assert(vertexShaderInfo); if (!vertexShaderInfo) return; m_stream << "\n"; Indent(); m_stream << "vertexShader " << vertexShaderInfo->m_version_major << "." << vertexShaderInfo->m_version_minor << " \"" << vertexShader->name << "\"\n"; Indent(); m_stream << "{\n"; IncIndent(); if (pass.args) { const auto totalArgCount = static_cast(pass.perPrimArgCount) + static_cast(pass.perObjArgCount) + static_cast(pass.stableArgCount); for (auto i = 0u; i < totalArgCount; i++) { const auto& arg = pass.args[i]; if (arg.type == MTL_ARG_MATERIAL_VERTEX_CONST || arg.type == MTL_ARG_LITERAL_VERTEX_CONST || arg.type == MTL_ARG_CODE_VERTEX_CONST) { DumpShaderArg(arg, *vertexShaderInfo); } } } DecIndent(); Indent(); m_stream << "}\n"; } void DumpPixelShader(const MaterialPass& pass) { auto pixelShader = pass.pixelShader; if (pixelShader == nullptr || pixelShader->name == nullptr) return; if (pixelShader->name[0] == ',') { const auto loadedPixelShaderFromOtherZone = GameGlobalAssetPools::GetGlobalPoolsForGame(GameId::IW4)->GetAsset(&pixelShader->name[1]); if (loadedPixelShaderFromOtherZone == nullptr) { // Cannot dump when shader is referenced due to unknown constant names and unknown version Indent(); con::error("Cannot dump pixel shader {} due to being a referenced asset", &pixelShader->name[1]); m_stream << std::format("// Cannot dump pixel shader {} due to being a referenced asset\n", &pixelShader->name[1]); return; } pixelShader = loadedPixelShaderFromOtherZone->Asset(); } const auto pixelShaderInfo = d3d9::ShaderAnalyser::GetShaderInfo(pixelShader->prog.loadDef.program, pixelShader->prog.loadDef.programSize * sizeof(uint32_t)); assert(pixelShaderInfo); if (!pixelShaderInfo) return; m_stream << "\n"; Indent(); m_stream << "pixelShader " << pixelShaderInfo->m_version_major << "." << pixelShaderInfo->m_version_minor << " \"" << pixelShader->name << "\"\n"; Indent(); m_stream << "{\n"; IncIndent(); if (pass.args) { const auto totalArgCount = static_cast(pass.perPrimArgCount) + static_cast(pass.perObjArgCount) + static_cast(pass.stableArgCount); for (auto i = 0u; i < totalArgCount; i++) { const auto& arg = pass.args[i]; if (arg.type == MTL_ARG_MATERIAL_PIXEL_SAMPLER || arg.type == MTL_ARG_CODE_PIXEL_SAMPLER || arg.type == MTL_ARG_CODE_PIXEL_CONST || arg.type == MTL_ARG_MATERIAL_PIXEL_CONST || arg.type == MTL_ARG_LITERAL_PIXEL_CONST) { DumpShaderArg(arg, *pixelShaderInfo); } } } DecIndent(); Indent(); m_stream << "}\n"; } static const char* GetStreamDestinationString(const MaterialStreamDestination_e dst) { const auto dstIndex = static_cast(dst); assert(dstIndex < std::extent_v); if (dstIndex < std::extent_v) return materialStreamDestinationNames[dstIndex]; return ""; } static const char* GetStreamSourceString(const MaterialStreamStreamSource_e src) { const auto srcIndex = static_cast(src); assert(srcIndex < std::extent_v); if (srcIndex < std::extent_v) return materialStreamSourceNames[srcIndex]; return ""; } void DumpVertexDecl(const MaterialPass& pass) { const auto* vertexDecl = pass.vertexDecl; if (vertexDecl == nullptr) return; if (vertexDecl->name && vertexDecl->name[0] == ',') { const auto loadedVertexDeclFromOtherZone = GameGlobalAssetPools::GetGlobalPoolsForGame(GameId::IW4)->GetAsset(&vertexDecl->name[1]); if (loadedVertexDeclFromOtherZone == nullptr) { // Cannot dump when shader is referenced due to unknown constant names and unknown version Indent(); con::error("Cannot dump vertex decl {} due to being a referenced asset", &vertexDecl->name[1]); m_stream << std::format("// Cannot dump vertex decl {} due to being a referenced asset\n", &vertexDecl->name[1]); return; } vertexDecl = loadedVertexDeclFromOtherZone->Asset(); } m_stream << "\n"; #ifdef TECHSET_DEBUG Indent(); m_stream << "// Decl: " << vertexDecl->name << "\n"; #endif const auto streamCount = std::min(static_cast(vertexDecl->streamCount), std::extent_v); for (auto streamIndex = 0u; streamIndex < streamCount; streamIndex++) { const auto& stream = vertexDecl->routing.data[streamIndex]; Indent(); m_stream << "vertex." << GetStreamDestinationString(static_cast(stream.dest)) << " = code." << GetStreamSourceString(static_cast(stream.source)) << ";\n"; } } void DumpPass(const MaterialPass& pass) { m_stream << "{\n"; IncIndent(); #ifdef TECHSET_DEBUG for (auto i = 0u; i < 8; i++) { const auto mask = 1u << i; if (pass.customSamplerFlags & mask) { Indent(); m_stream << "// CUSTOM SAMPLER FLAGS: 0x" << std::hex << mask << "\n"; } } #endif DumpStateMap(); DumpVertexShader(pass); DumpPixelShader(pass); DumpVertexDecl(pass); DecIndent(); m_stream << "}\n"; } public: explicit TechniqueFileWriter(std::ostream& stream) : AbstractTextDumper(stream) { } void DumpTechnique(const MaterialTechnique* technique) { #ifdef TECHSET_DEBUG if (technique->flags) { for (auto i = 0u; i < 16; i++) { const auto mask = 1u << i; if (technique->flags & mask) { Indent(); m_stream << "// TECHNIQUE FLAGS: 0x" << std::hex << mask << "\n"; } } } #endif for (auto i = 0u; i < technique->passCount; i++) DumpPass(technique->passArray[i]); } }; techset::CommonTechset ConvertToCommonTechset(const MaterialTechniqueSet& techset) { std::vector techniqueNames(std::extent_v); for (auto techniqueIndex = 0u; techniqueIndex < std::extent_v; techniqueIndex++) { const auto* technique = techset.techniques[techniqueIndex]; if (technique && technique->name) techniqueNames[techniqueIndex] = technique->name; } return techset::CommonTechset{ .m_name = techset.name, .m_technique_names = std::move(techniqueNames), }; } void DumpTechset(const AssetDumpingContext& context, const MaterialTechniqueSet& techset) { static techset::CommonTechniqueTypeNames commonNames(techniqueTypeNames, std::extent_v); const auto commonTechset = ConvertToCommonTechset(techset); techset::DumpCommonTechset(commonNames, context, commonTechset); } } // namespace namespace techset { void DumperIW4::DumpAsset(AssetDumpingContext& context, const XAssetInfo& asset) { const auto* techniqueSet = asset.Asset(); DumpTechset(context, *techniqueSet); auto* techniqueState = context.GetZoneAssetDumperState(); for (const auto* technique : techniqueSet->techniques) { if (technique && techniqueState->ShouldDumpTechnique(technique)) { const auto techniqueFile = context.OpenAssetFile(GetFileNameForTechniqueName(technique->name)); if (techniqueFile) { TechniqueFileWriter writer(*techniqueFile); writer.DumpTechnique(technique); } } } } } // namespace techset