#include "Globals.h" #include #include #include #include #include "WarningHandler.h" // Linker Hacks Begin #include "ZAnimation.h" ZNormalAnimation nAnim(nullptr); ZCurveAnimation cAnim(nullptr); ZLinkAnimation lAnim(nullptr); ZLegacyAnimation lAnim2(nullptr); #include "ZArray.h" ZArray arr(nullptr); #include "ZAudio.h" ZAudio audio(nullptr); #include "ZBackground.h" ZBackground back(nullptr); #include "ZBlob.h" ZBlob blob(nullptr); #include "ZCollision.h" ZCollisionHeader colHeader(nullptr); #include "ZCutscene.h" ZCutscene cs(nullptr); #include "ZLimb.h" ZLimb limb(nullptr); #include "ZMtx.h" ZMtx mtx(nullptr); #include "ZPath.h" ZPath path(nullptr); #include "ZPlayerAnimationData.h" ZPlayerAnimationData pAnimData(nullptr); #include "ZScalar.h" ZScalar scalar(nullptr); #include "ZSkeleton.h" ZLimbTable limbTbl(nullptr); ZSkeleton skel(nullptr); #include "ZString.h" ZString str(nullptr); #include "ZSymbol.h" ZSymbol sym(nullptr); #include "ZText.h" ZText txt(nullptr); #include "ZTextMM.h" ZTextMM txtMM(nullptr); #include "ZTexture.h" ZTexture tex(nullptr); #include "ZVector.h" ZVector vec(nullptr); #include "ZVtx.h" ZVtx vtx(nullptr); #include "ZRoom/ZRoom.h" ZRoom room(nullptr); #include "ZPointer.h" ZPointer pointer(nullptr); #include "ZCKeyFrame.h" ZKeyFrameSkel kfSKel(nullptr); #include "ZCkeyFrameAnim.h" ZKeyFrameAnim kfAnim(nullptr); // Linker Hacks End #include "ZFile.h" #include "ZTexture.h" #include #include "CrashHandler.h" #include #include #include "tinyxml2.h" #include const char gBuildHash[] = ""; using ArgFunc = void (*)(int&, char**); void Arg_SetOutputPath(int& i, char* argv[]); void Arg_SetInputPath(int& i, char* argv[]); void Arg_SetBaseromPath(int& i, char* argv[]); void Arg_SetSourceOutputPath(int& i, char* argv[]); void Arg_GenerateSourceFile(int& i, char* argv[]); void Arg_TestMode(int& i, char* argv[]); void Arg_LegacyDList(int& i, char* argv[]); void Arg_EnableProfiling(int& i, char* argv[]); void Arg_UseExternalResources(int& i, char* argv[]); void Arg_SetTextureType(int& i, char* argv[]); void Arg_ReadConfigFile(int& i, char* argv[]); void Arg_EnableErrorHandler(int& i, char* argv[]); void Arg_SetVerbosity(int& i, char* argv[]); void Arg_VerboseUnaccounted(int& i, char* argv[]); void Arg_SetExporter(int& i, char* argv[]); void Arg_EnableGCCCompat(int& i, char* argv[]); void Arg_ForceStatic(int& i, char* argv[]); void Arg_ForceUnaccountedStatic(int& i, char* argv[]); void Arg_SetFileListPath(int& i, char* argv[]); void Arg_SetBuildRawTexture(int& i, char* argv[]); void Arg_SetNoRomMode(int& i, char* argv[]); void Arg_SetXMLMode(int& i, char* argv[]); int main(int argc, char* argv[]); bool Parse(const fs::path& xmlFilePath, const fs::path& basePath, const fs::path& outPath, ZFileMode fileMode, int workerID); void ParseArgs(int& argc, char* argv[]); void BuildAssetTexture(const fs::path& pngFilePath, TextureType texType, const fs::path& outPath); void BuildAssetBackground(const fs::path& imageFilePath, const fs::path& outPath); void BuildAssetBlob(const fs::path& blobFilePath, const fs::path& outPath); ZFileMode ParseFileMode(const std::string& buildMode, ExporterSet* exporterSet); int HandleExtract(ZFileMode fileMode, ExporterSet* exporterSet, std::atomic* extractCount = nullptr, std::atomic* totalExtract = nullptr); int ExtractFunc(int workerID, int fileListSize, std::string fileListItem, ZFileMode fileMode); std::atomic numWorkersLeft = 0; extern const char gBuildHash[]; extern void ImportExporters(); extern "C" int zapd_report(int argc, char* argv[], std::atomic* extractCount, std::atomic* totalExtract) { int returnCode = 0; if (argc < 2) { printf("ZAPD.out (%s) [mode (btex/bovl/bsf/bblb/bmdlintr/bamnintr/e)] ...\n", gBuildHash); return 1; } Globals* g = new Globals(); WarningHandler::Init(argc, argv); for (int i = 1; i < argc; i++) { if (!strcmp(argv[i], "--version")) { printf("ZAPD.out %s\n", gBuildHash); return 0; } else if (!strcmp(argv[i], "--help") || !strcmp(argv[i], "-h")) { printf("Congratulations!\n"); printf("You just found the (unimplemented and undocumented) ZAPD's help message.\n"); printf("Feel free to implement it if you want :D\n"); WarningHandler::PrintHelp(); return 0; } } ParseArgs(argc, argv); // Parse File Mode ExporterSet* exporterSet = Globals::Instance->GetExporterSet(); // We've parsed through our commands once. If an exporter exists, it's been set by now. // Now we'll parse through them again but pass them on to our exporter if one is available. if (exporterSet != nullptr && exporterSet->parseArgsFunc != nullptr) { for (int32_t i = 2; i < argc; i++) { exporterSet->parseArgsFunc(argc, argv, i); } } if (Globals::Instance->onlyGenCustomOtr) { if (exporterSet != nullptr) { exporterSet->endProgramFunc(); } else { printf("Error: No exporter set, unable to make custom otr.\n"); } delete g; return 0; } std::string buildMode = argv[1]; ZFileMode fileMode = ParseFileMode(buildMode, exporterSet); if (fileMode == ZFileMode::Invalid) { printf("Error: Invalid file mode '%s'\n", buildMode.c_str()); return 1; } Globals::Instance->fileMode = fileMode; if (fileMode == ZFileMode::ExtractDirectory) Globals::Instance->rom = new ZRom(Globals::Instance->baseRomPath.string()); if (Globals::Instance->verbosity >= VerbosityLevel::VERBOSITY_INFO) printf("ZAPD: Zelda Asset Processor For Decomp: %s\n", gBuildHash); if (Globals::Instance->verbosity >= VerbosityLevel::VERBOSITY_DEBUG) WarningHandler::PrintWarningsDebugInfo(); if (fileMode == ZFileMode::Extract || fileMode == ZFileMode::BuildSourceFile || fileMode == ZFileMode::ExtractDirectory) returnCode = HandleExtract(fileMode, exporterSet, extractCount, totalExtract); else if (fileMode == ZFileMode::BuildTexture) BuildAssetTexture(Globals::Instance->inputPath, Globals::Instance->texType, Globals::Instance->outputPath); else if (fileMode == ZFileMode::BuildBackground) BuildAssetBackground(Globals::Instance->inputPath, Globals::Instance->outputPath); else if (fileMode == ZFileMode::BuildBlob) BuildAssetBlob(Globals::Instance->inputPath, Globals::Instance->outputPath); if (exporterSet != nullptr && exporterSet->endProgramFunc != nullptr) exporterSet->endProgramFunc(); delete g; return returnCode; } extern "C" int zapd_main(int argc, char* argv[]) { return zapd_report(argc, argv, nullptr, nullptr); } int ExtractFunc(int workerID, int fileListSize, std::string fileListItem, ZFileMode fileMode) { bool parseSuccessful; printf("(%i / %i): %s\n", (workerID + 1), fileListSize, fileListItem.c_str()); for (auto& extFile : Globals::Instance->cfg.externalFiles) { fs::path externalXmlFilePath = Globals::Instance->cfg.externalXmlFolder / extFile.xmlPath; if (Globals::Instance->verbosity >= VerbosityLevel::VERBOSITY_INFO) { printf("Parsing external file from config: '%s'\n", externalXmlFilePath.c_str()); } parseSuccessful = Parse(externalXmlFilePath, Globals::Instance->baseRomPath, extFile.outPath, ZFileMode::ExternalFile, workerID); if (!parseSuccessful) return 1; } parseSuccessful = Parse(fileListItem, Globals::Instance->baseRomPath, Globals::Instance->outputPath, fileMode, workerID); if (!parseSuccessful) return 1; if (Globals::Instance->singleThreaded) { for (int i = 0; i < Globals::Instance->files.size(); i++) { delete Globals::Instance->files[i]; Globals::Instance->files.erase(Globals::Instance->files.begin() + i); i--; } Globals::Instance->externalFiles.clear(); Globals::Instance->segments.clear(); Globals::Instance->segmentFiles.clear(); Globals::Instance->cfg.segmentRefFiles.clear(); } else { for (int i = 0; i < Globals::Instance->workerData[workerID]->files.size(); i++) { delete Globals::Instance->workerData[workerID]->files[i]; Globals::Instance->workerData[workerID]->files.erase( Globals::Instance->workerData[workerID]->files.begin() + i); i--; } Globals::Instance->workerData[workerID]->externalFiles.clear(); Globals::Instance->workerData[workerID]->segments.clear(); Globals::Instance->workerData[workerID]->segmentFiles.clear(); Globals::Instance->workerData[workerID]->segmentRefFiles.clear(); numWorkersLeft--; } return 0; } bool Parse(const fs::path& xmlFilePath, const fs::path& basePath, const fs::path& outPath, ZFileMode fileMode, int workerID) { tinyxml2::XMLDocument doc; tinyxml2::XMLError eResult = doc.LoadFile(xmlFilePath.string().c_str()); if (eResult != tinyxml2::XML_SUCCESS) { // TODO: use XMLDocument::ErrorIDToName to get more specific error messages here HANDLE_ERROR(WarningType::InvalidXML, StringHelper::Sprintf("invalid XML file: '%s'", xmlFilePath.c_str()), ""); return false; } tinyxml2::XMLNode* root = doc.FirstChild(); if (root == nullptr) { HANDLE_WARNING( WarningType::InvalidXML, StringHelper::Sprintf("missing Root tag in xml file: '%s'", xmlFilePath.c_str()), ""); return false; } for (tinyxml2::XMLElement* child = root->FirstChildElement(); child != NULL; child = child->NextSiblingElement()) { if (std::string_view(child->Name()) == "File") { ZFile* file = new ZFile(fileMode, child, basePath, outPath, "", xmlFilePath, workerID); Globals::Instance->AddFile(file, workerID); if (fileMode == ZFileMode::ExternalFile) { Globals::Instance->AddExternalFile(file, workerID); file->isExternalFile = true; } } else if (std::string(child->Name()) == "ExternalFile") { const char* xmlPathValue = child->Attribute("XmlPath"); if (xmlPathValue == nullptr) { throw std::runtime_error(StringHelper::Sprintf( "Parse: Fatal error in '%s'.\n" "\t Missing 'XmlPath' attribute in `ExternalFile` element.\n", xmlFilePath.c_str())); } const char* outPathValue = child->Attribute("OutPath"); if (outPathValue == nullptr) { throw std::runtime_error(StringHelper::Sprintf( "Parse: Fatal error in '%s'.\n" "\t Missing 'OutPath' attribute in `ExternalFile` element.\n", xmlFilePath.c_str())); } fs::path externalXmlFilePath = Globals::Instance->cfg.externalXmlFolder / fs::path(xmlPathValue); fs::path externalOutFilePath = fs::path(outPathValue); if (Globals::Instance->verbosity >= VerbosityLevel::VERBOSITY_INFO) { printf("Parsing external file: '%s'\n", externalXmlFilePath.c_str()); } // Recursion. What can go wrong? Parse(externalXmlFilePath, basePath, externalOutFilePath, ZFileMode::ExternalFile, workerID); } else { std::string errorHeader = StringHelper::Sprintf("when parsing file '%s'", xmlFilePath.c_str()); std::string errorBody = StringHelper::Sprintf( "Found a resource outside a File element: '%s'", child->Name()); HANDLE_ERROR(WarningType::InvalidXML, errorHeader, errorBody); } } if (fileMode != ZFileMode::ExternalFile) { ExporterSet* exporterSet = Globals::Instance->GetExporterSet(); if (exporterSet != nullptr && exporterSet->beginXMLFunc != nullptr) exporterSet->beginXMLFunc(); std::vector files; if (Globals::Instance->singleThreaded) files = Globals::Instance->files; else files = Globals::Instance->workerData[workerID]->files; for (ZFile* file : files) { if (fileMode == ZFileMode::BuildSourceFile) file->BuildSourceFile(); else file->ExtractResources(); } if (exporterSet != nullptr && exporterSet->endXMLFunc != nullptr) exporterSet->endXMLFunc(); } return true; } void ParseArgs(int& argc, char* argv[]) { static const std::unordered_map ArgFuncDictionary = { {"-o", &Arg_SetOutputPath}, {"--outputpath", &Arg_SetOutputPath}, {"-i", &Arg_SetInputPath}, {"--inputpath", &Arg_SetInputPath}, {"-b", &Arg_SetBaseromPath}, {"--baserompath", &Arg_SetBaseromPath}, {"-osf", &Arg_SetSourceOutputPath}, {"-gsf", &Arg_GenerateSourceFile}, {"-tm", &Arg_TestMode}, {"-ulzdl", &Arg_LegacyDList}, {"-profile", &Arg_EnableProfiling}, {"-uer", &Arg_UseExternalResources}, {"-tt", &Arg_SetTextureType}, {"-rconf", &Arg_ReadConfigFile}, {"-eh", &Arg_EnableErrorHandler}, {"-v", &Arg_SetVerbosity}, {"-vu", &Arg_VerboseUnaccounted}, {"--verbose-unaccounted", &Arg_VerboseUnaccounted}, {"-se", &Arg_SetExporter}, {"--set-exporter", &Arg_SetExporter}, {"--gcc-compat", &Arg_EnableGCCCompat}, {"-s", &Arg_ForceStatic}, {"--static", &Arg_ForceStatic}, {"-us", &Arg_ForceUnaccountedStatic}, {"--unaccounted-static", &Arg_ForceUnaccountedStatic}, {"-fl", &Arg_SetFileListPath}, {"-brt", &Arg_SetBuildRawTexture}, {"--norom", &Arg_SetNoRomMode}, {"-oxml", &Arg_SetXMLMode}, }; for (int32_t i = 2; i < argc; i++) { std::string arg = argv[i]; // Ignore warning args as they have already been parsed if (arg.length() > 2 && arg[0] == '-' && arg[1] == 'W' && arg[2] != '\0') { continue; } auto it = ArgFuncDictionary.find(arg); if (it == ArgFuncDictionary.end()) { fprintf(stderr, "Unsupported argument: %s\n", arg.c_str()); ExporterSet* exporterSet = Globals::Instance->GetExporterSet(); if (exporterSet != nullptr) exporterSet->parseArgsFunc(argc, argv, i); continue; } std::invoke(it->second, i, argv); } } ZFileMode ParseFileMode(const std::string& buildMode, ExporterSet* exporterSet) { ZFileMode fileMode = ZFileMode::Invalid; if (buildMode == "btex") fileMode = ZFileMode::BuildTexture; else if (buildMode == "bren") fileMode = ZFileMode::BuildBackground; else if (buildMode == "bsf") fileMode = ZFileMode::BuildSourceFile; else if (buildMode == "bblb") fileMode = ZFileMode::BuildBlob; else if (buildMode == "e") fileMode = ZFileMode::Extract; else if (buildMode == "ed") fileMode = ZFileMode::ExtractDirectory; else if (exporterSet != nullptr && exporterSet->parseFileModeFunc != nullptr) exporterSet->parseFileModeFunc(buildMode, fileMode); return fileMode; } void Arg_SetOutputPath(int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->outputPath = argv[++i]; if (Globals::Instance->sourceOutputPath == "") Globals::Instance->sourceOutputPath = Globals::Instance->outputPath; } void Arg_SetInputPath(int& i, char* argv[]) { Globals::Instance->inputPath = argv[++i]; } void Arg_SetBaseromPath(int& i, char* argv[]) { Globals::Instance->baseRomPath = argv[++i]; } void Arg_SetSourceOutputPath(int& i, char* argv[]) { Globals::Instance->sourceOutputPath = argv[++i]; } void Arg_GenerateSourceFile(int& i, char* argv[]) { // Generate source file during extraction Globals::Instance->genSourceFile = std::string_view(argv[++i]) == "1"; } void Arg_TestMode(int& i, char* argv[]) { // Test Mode (enables certain experimental features) Globals::Instance->testMode = std::string_view(argv[++i]) == "1"; } void Arg_LegacyDList(int& i, char* argv[]) { Globals::Instance->useLegacyZDList = std::string_view(argv[++i]) == "1"; } void Arg_EnableProfiling(int& i, char* argv[]) { Globals::Instance->profile = std::string_view(argv[++i]) == "1"; } void Arg_UseExternalResources(int& i, char* argv[]) { // Split resources into their individual components(enabled by default) // TODO: We may wish to make this a part of the config file... Globals::Instance->useExternalResources = std::string_view(argv[++i]) == "1"; } void Arg_SetTextureType(int& i, char* argv[]) { Globals::Instance->texType = ZTexture::GetTextureTypeFromString(argv[++i]); } void Arg_ReadConfigFile(int& i, char* argv[]) { Globals::Instance->cfg.ReadConfigFile(argv[++i]); } void Arg_EnableErrorHandler([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { CrashHandler_Init(); } void Arg_SetVerbosity(int& i, char* argv[]) { Globals::Instance->verbosity = static_cast(strtol(argv[++i], NULL, 16)); } void Arg_VerboseUnaccounted([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->verboseUnaccounted = true; } void Arg_SetExporter(int& i, char* argv[]) { ImportExporters(); Globals::Instance->currentExporter = argv[++i]; } void Arg_EnableGCCCompat([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->gccCompat = true; } void Arg_ForceStatic([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->forceStatic = true; } void Arg_ForceUnaccountedStatic([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->forceUnaccountedStatic = true; } void Arg_SetFileListPath(int& i, char* argv[]) { Globals::Instance->fileListPath = argv[++i]; } void Arg_SetBuildRawTexture([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->buildRawTexture = true; } void Arg_SetNoRomMode([[maybe_unused]] int& i, [[maybe_unused]] char* argv[]) { Globals::Instance->onlyGenCustomOtr = true; } void Arg_SetXMLMode(int& i, char* argv[]) { char* xmlList = argv[++i]; size_t xmlListPos = 0; size_t xmlListLen = strlen(xmlList); while (xmlListPos < xmlListLen) { char* nextDelimiterPtr = strchr(&xmlList[xmlListPos], ','); if (nextDelimiterPtr == nullptr) nextDelimiterPtr = strchr(&xmlList[xmlListPos], 0); if (nextDelimiterPtr == nullptr) return; size_t curModeLen = nextDelimiterPtr - &xmlList[xmlListPos]; // Audio Sound Font (asf) if (strncmp(&xmlList[xmlListPos], "asf", curModeLen) == 0) Globals::Instance->xmlExtractModes |= 1 << (int)XMLModeShift::SoundFont; // Audio Sample (asp) else if (strncmp(&xmlList[xmlListPos], "asp", curModeLen) == 0) Globals::Instance->xmlExtractModes |= 1 << (int)XMLModeShift::Sample; // Audio Sequence (asq) else if (strncmp(&xmlList[xmlListPos], "asq", curModeLen) == 0) Globals::Instance->xmlExtractModes |= 1 << (int)XMLModeShift::Sequence; // We read the 3 chars for the type xmlListPos += curModeLen; if (xmlList[xmlListPos] != ',' && xmlList[xmlListPos] != 0) HANDLE_WARNING( WarningType::Always, "Invalid Argument", "XML Extract mode not separated by ','. This may have unintended side effects."); xmlListPos++; } } int HandleExtract(ZFileMode fileMode, ExporterSet* exporterSet, std::atomic* extractCount, std::atomic* totalExtract) { bool procFileModeSuccess = false; if (exporterSet != nullptr && exporterSet->processFileModeFunc != nullptr) procFileModeSuccess = exporterSet->processFileModeFunc(fileMode); if (!procFileModeSuccess) { bool parseSuccessful; for (auto& extFile : Globals::Instance->cfg.externalFiles) { if (fileMode == ZFileMode::ExtractDirectory) { std::vector fileList = Directory::ListFiles(Globals::Instance->inputPath.string()); const int num_threads = std::thread::hardware_concurrency(); ctpl::thread_pool pool(num_threads > 1 ? num_threads / 2 : 1); bool parseSuccessful; auto start = std::chrono::steady_clock::now(); size_t fileListSize = fileList.size(); Globals::Instance->singleThreaded = true; for (size_t i = 0; i < fileListSize; i++) Globals::Instance->workerData[i] = new FileWorker(); numWorkersLeft = fileListSize; if (totalExtract != nullptr) { *totalExtract = fileListSize; } for (size_t i = 0; i < fileListSize; i++) { if (Globals::Instance->singleThreaded) { ExtractFunc(i, fileList.size(), fileList[i], fileMode); if (extractCount != nullptr) { *extractCount = i; } } else { std::string fileListItem = fileList[i]; pool.push([i, fileListSize, fileListItem, fileMode](int) { ExtractFunc(i, fileListSize, fileListItem, fileMode); }); } } if (!Globals::Instance->singleThreaded) { while (true) { if (numWorkersLeft <= 0) break; std::this_thread::sleep_for(std::chrono::milliseconds(250)); } } auto end = std::chrono::steady_clock::now(); auto diff = std::chrono::duration_cast(end - start).count(); printf("Generated OTR File Data in %i seconds\n", diff); } else { fs::path externalXmlFilePath = Globals::Instance->cfg.externalXmlFolder / extFile.xmlPath; if (Globals::Instance->verbosity >= VerbosityLevel::VERBOSITY_INFO) printf("Parsing external file from config: '%s'\n", externalXmlFilePath.c_str()); parseSuccessful = Parse(externalXmlFilePath, Globals::Instance->baseRomPath, extFile.outPath, ZFileMode::ExternalFile, 0); if (!parseSuccessful) return 1; } } } return 0; } void BuildAssetTexture(const fs::path& pngFilePath, TextureType texType, const fs::path& outPath) { return Globals::Instance->BuildAssetTexture(pngFilePath, texType, outPath); } void BuildAssetBackground(const fs::path& imageFilePath, const fs::path& outPath) { ZBackground background(nullptr); background.ParseBinaryFile(imageFilePath.string(), false); DiskFile::WriteAllText(outPath.string(), background.GetBodySourceCode()); } void BuildAssetBlob(const fs::path& blobFilePath, const fs::path& outPath) { ZBlob* blob = ZBlob::FromFile(blobFilePath.string()); std::string name = outPath.stem().string(); // filename without extension std::string src = blob->GetBodySourceCode(); DiskFile::WriteAllText(outPath.string(), src); delete blob; }