Skip to content

Commit

Permalink
Deduplicate shaderset asset code
Browse files Browse the repository at this point in the history 
Many things are the same between v8 and v11, only separate out the differences.
  • Loading branch information
@Mauler125
Mauler125 committed Dec 9, 2024
1 parent c05a605 commit d88eb91
Showing 1 changed file with 62 additions and 169 deletions.
231 changes: 62 additions & 169 deletions src/assets/shaderset.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,239 +5,132 @@
#include "public/shaderset.h"
#include "public/shader.h"

// Parse numSamplers from pixelShader
// Parse textureInputCount from pixelShader
// Figure out the other count variable before texture input count
// See if any of the other unknown variables are actually required

void Assets::AddShaderSetAsset_v8(CPakFile* const pak, const char* const assetPath, const rapidjson::Value& mapEntry)
template <typename ShaderSetAssetHeader_t>
static void ShaderSet_SetInputSlots(ShaderSetAssetHeader_t* const hdr, PakAsset_t* const shader, const bool isVertexShader, const rapidjson::Value& mapEntry, const int assetVersion)
{
std::vector<PakGuidRefHdr_t> guids{};
uint16_t* inputCount;

CPakDataChunk hdrChunk = pak->CreateDataChunk(sizeof(ShaderSetAssetHeader_v8_t), SF_HEAD, 8);
// note: in v8 shader sets the vertex shader is set in the first slot, whereas
// in v11 the vertex shader is set in the second slot and the first texture
if (assetVersion == 8)
inputCount = isVertexShader ? &hdr->textureInputCounts[0] : &hdr->textureInputCounts[1];
else
inputCount = isVertexShader ? &hdr->textureInputCounts[1] : &hdr->textureInputCounts[0];

const std::string assetPathWithoutExtension = Utils::ChangeExtension(assetPath, "");

CPakDataChunk nameChunk = pak->CreateDataChunk(assetPathWithoutExtension.length() + 1, SF_CPU | SF_DEV, 1);
strcpy_s(nameChunk.Data(), nameChunk.GetSize(), assetPathWithoutExtension.c_str());

ShaderSetAssetHeader_v8_t* const hdr = reinterpret_cast<ShaderSetAssetHeader_v8_t*>(hdrChunk.Data());
uint32_t numShaderTextures;

hdr->name = nameChunk.GetPointer();

pak->AddPointer(hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_v8_t, name)));

// dedup
// === Shader Inputs ===
const PakGuid_t vertexShaderGuid = Pak_ParseGuidRequired(mapEntry, "vertexShader");
const PakGuid_t pixelShaderGuid = Pak_ParseGuidRequired(mapEntry, "pixelShader");
// end dedup

hdr->vertexShader = vertexShaderGuid;
hdr->pixelShader = pixelShaderGuid;

if(hdr->vertexShader != 0)
pak->AddGuidDescriptor(&guids, hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_v8_t, vertexShader)));

if(hdr->pixelShader != 0)
pak->AddGuidDescriptor(&guids, hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_v8_t, pixelShader)));

PakAsset_t* const vertexShader = vertexShaderGuid != 0 ? pak->GetAssetByGuid(vertexShaderGuid, nullptr, true) : nullptr;
PakAsset_t* const pixelShader = pixelShaderGuid != 0 ? pak->GetAssetByGuid(pixelShaderGuid, nullptr, true) : nullptr;
const char* const shaderName = isVertexShader ? "vertex" : "pixel";
const char* const fieldName = isVertexShader ? "$numVertexShaderTextures" : "$numPixelShaderTextures";

if (vertexShader)
if (JSON_GetValue(mapEntry, fieldName, numShaderTextures))
{
const ParsedDXShaderData_t* vtxShaderData = reinterpret_cast<const ParsedDXShaderData_t*>(vertexShader->PublicData());

if (vtxShaderData)
{
hdr->textureInputCounts[0] = vtxShaderData->mtlTexSlotCount;
}
Log("Overriding number of %s shader textures to %u\n", shaderName, numShaderTextures);
*inputCount = static_cast<uint16_t>(numShaderTextures);
}

if (pixelShader)
else if (shader)
{
const ParsedDXShaderData_t* pixelShaderData = reinterpret_cast<const ParsedDXShaderData_t*>(pixelShader->PublicData());
const ParsedDXShaderData_t* const shaderData = reinterpret_cast<const ParsedDXShaderData_t*>(shader->PublicData());

if (pixelShaderData)
{
hdr->textureInputCounts[1] = pixelShaderData->mtlTexSlotCount;
}
// cannot be null at this point
assert(shaderData);
*inputCount = shaderData->mtlTexSlotCount;
}

// dedup
// TEMPORARY VARS

uint32_t numVertexShaderTextures;

if (JSON_GetValue(mapEntry, "$numVertexShaderTextures", numVertexShaderTextures))
else
{
Debug("Overriding field \"$numVertexShaderTextures\" for shader set '%s'.\n", assetPath);
hdr->textureInputCounts[0] = static_cast<uint16_t>(numVertexShaderTextures);
}
else if (!vertexShader && hdr->vertexShader != 0) // warn if there is an asset guid, but it's not present in the current pak
Warning("Creating shader set '%s' without a local vertex shader asset and without a \'$numVertexShaderTextures\' field. Shader set will assume 0 vertex shader textures.\n", assetPath);
const PakGuid_t shaderGuid = isVertexShader ? hdr->vertexShader : hdr->pixelShader;

uint32_t numPixelShaderTextures;

if (JSON_GetValue(mapEntry, "$numPixelShaderTextures", numPixelShaderTextures))
{
Debug("Overriding field \"$numPixelShaderTextures\" for shader set '%s'.\n", assetPathWithoutExtension.c_str());
hdr->textureInputCounts[1] = static_cast<uint16_t>(numPixelShaderTextures);
// todo(amos): this should probably be an error?
if (shaderGuid != 0) // warn if there is an asset guid, but it's not present in the current pak
Warning("Creating shader set without a local %s shader asset and \"%s\" wasn't provided; assuming 0 shader textures.\n", shaderName, fieldName);
}
else if (!pixelShader && hdr->pixelShader != 0) // warn if there is an asset guid, but it's not present in the current pak
Warning("Creating shader set '%s' without a local pixel shader asset and without a \'$numPixelShaderTextures\' field. Shader set will assume 0 pixel shader textures.\n", assetPath);

// end dedup

hdr->numSamplers = static_cast<uint16_t>(JSON_GetNumberOrDefault(mapEntry, "numSamplers", 0u));

// only used for ui/ui_world shadersets in R5
// for now this will have to be manually set if used, because i cannot figure out a way to programmatically
// detect these resources without incorrectly identifying some, and i doubt that's a good thing
hdr->firstResourceBindPoint = static_cast<uint8_t>(JSON_GetNumberOrDefault(mapEntry, "firstResource", 0u));
hdr->numResources = static_cast<uint8_t>(JSON_GetNumberOrDefault(mapEntry, "numResources", 0u));

if (hdr->numResources != 0)
Warning("Shader set '%s' has requested a non-zero number of shader resources. This feature is only intended for use on UI shaders, and may result in unexpected crashes or errors when used with incompatible shader code.\n", assetPath);

const PakGuid_t assetGuid = Pak_GetGuidOverridable(mapEntry, assetPath);

PakAsset_t asset;
asset.InitAsset(
assetPath,
assetGuid,
hdrChunk.GetPointer(), hdrChunk.GetSize(),
PagePtr_t::NullPtr(), UINT64_MAX, UINT64_MAX, AssetType::SHDS);
asset.SetHeaderPointer(hdrChunk.Data());

asset.version = 8;

asset.pageEnd = pak->GetNumPages();

// this doesnt account for external dependencies atm
asset.remainingDependencyCount = static_cast<short>(guids.size() + 1);

asset.AddGuids(&guids);

pak->PushAsset(asset);

printf("\n");
}

void Assets::AddShaderSetAsset_v11(CPakFile* const pak, const char* const assetPath, const rapidjson::Value& mapEntry)
template <typename ShaderSetAssetHeader_t>
void ShaderSet_CreateSet(CPakFile* const pak, const char* const assetPath, const rapidjson::Value& mapEntry, const int assetVersion)
{
std::vector<PakGuidRefHdr_t> guids{};

CPakDataChunk hdrChunk = pak->CreateDataChunk(sizeof(ShaderSetAssetHeader_v11_t), SF_HEAD, 8);
CPakDataChunk hdrChunk = pak->CreateDataChunk(sizeof(ShaderSetAssetHeader_t), SF_HEAD, 8);

const std::string assetPathWithoutExtension = Utils::ChangeExtension(assetPath, "");

CPakDataChunk nameChunk = pak->CreateDataChunk(assetPathWithoutExtension.length() + 1, SF_CPU | SF_DEV, 1);
strcpy_s(nameChunk.Data(), nameChunk.GetSize(), assetPathWithoutExtension.c_str());

ShaderSetAssetHeader_v11_t* const hdr = reinterpret_cast<ShaderSetAssetHeader_v11_t*>(hdrChunk.Data());
ShaderSetAssetHeader_t* const hdr = reinterpret_cast<ShaderSetAssetHeader_t*>(hdrChunk.Data());

hdr->name = nameChunk.GetPointer();

pak->AddPointer(hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_v11_t, name)));
pak->AddPointer(hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_t, name)));

// dedup
// === Shader Inputs ===
const PakGuid_t vertexShaderGuid = Pak_ParseGuidRequired(mapEntry, "vertexShader");
const PakGuid_t pixelShaderGuid = Pak_ParseGuidRequired(mapEntry, "pixelShader");
// end dedup

hdr->vertexShader = vertexShaderGuid;
hdr->pixelShader = pixelShaderGuid;

// todo: can shader refs be null???
if (hdr->vertexShader != 0)
pak->AddGuidDescriptor(&guids, hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_v11_t, vertexShader)));
pak->AddGuidDescriptor(&guids, hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_t, vertexShader)));

if (hdr->pixelShader != 0)
pak->AddGuidDescriptor(&guids, hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_v11_t, pixelShader)));
pak->AddGuidDescriptor(&guids, hdrChunk.GetPointer(offsetof(ShaderSetAssetHeader_t, pixelShader)));

PakAsset_t* const vertexShader = vertexShaderGuid != 0 ? pak->GetAssetByGuid(vertexShaderGuid, nullptr, true) : nullptr;
PakAsset_t* const pixelShader = pixelShaderGuid != 0 ? pak->GetAssetByGuid(pixelShaderGuid, nullptr, true) : nullptr;

if (pixelShader)
{
const ParsedDXShaderData_t* pixelShaderData = reinterpret_cast<const ParsedDXShaderData_t*>(pixelShader->PublicData());

if (pixelShaderData)
{
hdr->textureInputCounts[0] = pixelShaderData->mtlTexSlotCount;
}
}

if (vertexShader)
{
const ParsedDXShaderData_t* vtxShaderData = reinterpret_cast<const ParsedDXShaderData_t*>(vertexShader->PublicData());

if (vtxShaderData)
{
hdr->textureInputCounts[1] = vtxShaderData->mtlTexSlotCount;
}
}

hdr->textureInputCounts[1] += hdr->textureInputCounts[0];

// dedup
// TEMPORARY VARS

uint32_t numVertexShaderTextures;
ShaderSet_SetInputSlots(hdr, vertexShader, true, mapEntry, assetVersion);

if (JSON_GetValue(mapEntry, "$numVertexShaderTextures", numVertexShaderTextures))
{
Debug("Overriding field \"$numVertexShaderTextures\" for shader set '%s'.\n", assetPath);
hdr->textureInputCounts[0] = static_cast<uint16_t>(numVertexShaderTextures);
}
else if (!vertexShader && hdr->vertexShader != 0) // warn if there is an asset guid, but it's not present in the current pak
Warning("Creating shader set '%s' without a local vertex shader asset and without a \'numVertexShaderTextures\' field. Shader set will assume 0 vertex shader textures.\n", assetPath);

uint32_t numPixelShaderTextures;

if (JSON_GetValue(mapEntry, "$numPixelShaderTextures", numPixelShaderTextures))
{
Debug("Overriding field \"$numPixelShaderTextures\" for shader set '%s'.\n", assetPath);
hdr->textureInputCounts[1] = static_cast<uint16_t>(numPixelShaderTextures);
}
else if (!pixelShader && hdr->pixelShader != 0) // warn if there is an asset guid, but it's not present in the current pak
Warning("Creating shader set '%s' without a local pixel shader asset and without a \'numPixelShaderTextures\' field. Shader set will assume 0 pixel shader textures.\n", assetPath);
PakAsset_t* const pixelShader = pixelShaderGuid != 0 ? pak->GetAssetByGuid(pixelShaderGuid, nullptr, true) : nullptr;
ShaderSet_SetInputSlots(hdr, pixelShader, false, mapEntry, assetVersion);

// end dedup
// On v11 shaders, the input count is added on top of the second one.
if (assetVersion == 11)
hdr->textureInputCounts[1] += hdr->textureInputCounts[0];

hdr->numSamplers = static_cast<uint16_t>(JSON_GetNumberOrDefault(mapEntry, "numSamplers", 0u));
hdr->numSamplers = static_cast<uint16_t>(JSON_GetNumberOrDefault(mapEntry, "numSamplers", 0u)); // overridable

// only used for ui/ui_world shadersets in R5
// for now this will have to be manually set if used, because i cannot figure out a way to programmatically
// detect these resources without incorrectly identifying some, and i doubt that's a good thing
hdr->firstResourceBindPoint = static_cast<uint8_t>(JSON_GetNumberOrDefault(mapEntry, "firstResource", 0u));
hdr->numResources = static_cast<uint8_t>(JSON_GetNumberOrDefault(mapEntry, "numResources", 0u));
hdr->firstResourceBindPoint = static_cast<uint8_t>(JSON_GetNumberOrDefault(mapEntry, "firstResource", 0u)); // overridable
hdr->numResources = static_cast<uint8_t>(JSON_GetNumberOrDefault(mapEntry, "numResources", 0u)); // overridable

if (hdr->numResources != 0)
Warning("Shader set '%s' has requested a non-zero number of shader resources. This feature is only intended for use on UI shaders, and may result in unexpected crashes or errors when used with incompatible shader code.\n", assetPath);

const PakGuid_t assetGuid = Pak_GetGuidOverridable(mapEntry, assetPath);

PakAsset_t asset;
asset.InitAsset(
assetPath,
assetGuid,
Pak_GetGuidOverridable(mapEntry, assetPath),
hdrChunk.GetPointer(), hdrChunk.GetSize(),
PagePtr_t::NullPtr(), UINT64_MAX, UINT64_MAX, AssetType::SHDS);
asset.SetHeaderPointer(hdrChunk.Data());

asset.version = 11;

asset.version = assetVersion;
asset.pageEnd = pak->GetNumPages();

// this doesnt account for external dependencies atm
// todo: can shader sets have external dependencies?
asset.remainingDependencyCount = static_cast<short>(guids.size() + 1);

asset.AddGuids(&guids);

pak->PushAsset(asset);

printf("\n");
}
}

// TODO:
// Parse numSamplers from pixelShader
// Parse textureInputCount from pixelShader
// Figure out the other count variable before texture input count
// See if any of the other unknown variables are actually required

void Assets::AddShaderSetAsset_v8(CPakFile* const pak, const char* const assetPath, const rapidjson::Value& mapEntry)
{
ShaderSet_CreateSet<ShaderSetAssetHeader_v8_t>(pak, assetPath, mapEntry, 8);
}

void Assets::AddShaderSetAsset_v11(CPakFile* const pak, const char* const assetPath, const rapidjson::Value& mapEntry)
{
ShaderSet_CreateSet<ShaderSetAssetHeader_v11_t>(pak, assetPath, mapEntry, 11);
}

0 comments on commit d88eb91

Please sign in to comment.