mirror of
https://github.com/Mauler125/r5sdk.git
synced 2025-02-09 19:15:03 +01:00
0ab31606eb
The CPackedStore class now heavily relies on the engine's FileSystem and KeyValues API. Since its part of the engine, it would make more sense to utilize the engine's features instead. It also allows for easier modifications. * The logic behind the build process hasn't changed.
165 lines
7.6 KiB
C++
165 lines
7.6 KiB
C++
#ifndef PACKEDSTORE_H
|
|
#define PACKEDSTORE_H
|
|
/*******************************************************************
|
|
* ██████╗ ██╗ ██╗ ██╗██████╗ ██╗ ██╗ ██╗ ██╗██████╗ *
|
|
* ██╔══██╗███║ ██║ ██║██╔══██╗██║ ██╔╝ ██║ ██║██╔══██╗ *
|
|
* ██████╔╝╚██║ ██║ ██║██████╔╝█████╔╝ ██║ ██║██████╔╝ *
|
|
* ██╔══██╗ ██║ ╚██╗ ██╔╝██╔═══╝ ██╔═██╗ ██║ ██║██╔══██╗ *
|
|
* ██║ ██║ ██║ ╚████╔╝ ██║ ██║ ██╗ ███████╗██║██████╔╝ *
|
|
* ╚═╝ ╚═╝ ╚═╝ ╚═══╝ ╚═╝ ╚═╝ ╚═╝ ╚══════╝╚═╝╚═════╝ *
|
|
*******************************************************************/
|
|
#include "public/ifilesystem.h"
|
|
#include "thirdparty/lzham/include/lzham.h"
|
|
|
|
constexpr unsigned int VPK_HEADER_MARKER = 0x55AA1234;
|
|
constexpr unsigned int VPK_MAJOR_VERSION = 2;
|
|
constexpr unsigned int VPK_MINOR_VERSION = 3;
|
|
constexpr unsigned int VPK_DICT_SIZE = 20;
|
|
constexpr int ENTRY_MAX_LEN = 1024 * 1024;
|
|
constexpr int PACKFILEPATCH_MAX = 512;
|
|
constexpr int PACKFILEINDEX_SEP = 0x0;
|
|
constexpr int PACKFILEINDEX_END = 0xffff;
|
|
|
|
static const std::regex BLOCK_REGEX{ R"(pak000_([0-9]{3}))" };
|
|
static const std::regex DIR_REGEX{ R"((?:.*\/)?([^_]*_)(.*)(.bsp.pak000_dir).*)" };
|
|
|
|
static const vector<string> DIR_TARGET =
|
|
{
|
|
"server",
|
|
"client"
|
|
};
|
|
static const vector<string> DIR_LOCALE =
|
|
{
|
|
"english",
|
|
"french",
|
|
"german",
|
|
"italian",
|
|
"japanese",
|
|
"korean",
|
|
"polish",
|
|
"portuguese",
|
|
"russian",
|
|
"spanish",
|
|
"tchinese"
|
|
};
|
|
|
|
struct VPKKeyValues_t
|
|
{
|
|
static constexpr uint16_t TEXTURE_FLAGS_DEFAULT = static_cast<uint16_t>(EPackedTextureFlags::TEXTURE_DEFAULT);
|
|
static constexpr uint32_t LOAD_FLAGS_DEFAULT = static_cast<uint32_t>(EPackedLoadFlags::LOAD_VISIBLE) | static_cast<uint32_t>(EPackedLoadFlags::LOAD_CACHE);
|
|
|
|
string m_svEntryPath;
|
|
uint16_t m_iPreloadSize;
|
|
uint32_t m_nLoadFlags;
|
|
uint16_t m_nTextureFlags;
|
|
bool m_bUseCompression;
|
|
bool m_bUseDataSharing;
|
|
|
|
VPKKeyValues_t(const string& svEntryPath = "", uint16_t iPreloadSize = NULL, uint32_t nLoadFlags = LOAD_FLAGS_DEFAULT,
|
|
uint16_t nTextureFlags = TEXTURE_FLAGS_DEFAULT, bool bUseCompression = true, bool bUseDataSharing = true);
|
|
};
|
|
|
|
struct VPKChunkDescriptor_t
|
|
{
|
|
uint32_t m_nLoadFlags; // Load flags.
|
|
uint16_t m_nTextureFlags; // Texture flags (only used if the entry is a vtf).
|
|
uint64_t m_nPackFileOffset; // Offset in pack file.
|
|
uint64_t m_nCompressedSize; // Compressed size of chunk.
|
|
uint64_t m_nUncompressedSize; // Uncompressed size of chunk.
|
|
bool m_bIsCompressed = false;
|
|
|
|
VPKChunkDescriptor_t(){};
|
|
VPKChunkDescriptor_t(FileHandle_t pFile);
|
|
VPKChunkDescriptor_t(uint32_t nEntryFlags, uint16_t nTextureFlags, uint64_t nPackFileOffset, uint64_t nCompressedSize, uint64_t nUncompressedSize);
|
|
};
|
|
|
|
struct VPKEntryBlock_t
|
|
{
|
|
uint32_t m_nFileCRC; // Crc32 for the uncompressed entry.
|
|
uint16_t m_iPreloadSize; // Preload bytes.
|
|
uint16_t m_iPackFileIndex; // Index of the pack file that contains this entry.
|
|
vector<VPKChunkDescriptor_t> m_vFragments; // Vector of all the chunks of a given entry (chunks have a size limit of 1 MiB, anything over this limit is fragmented into smaller chunks).
|
|
string m_svEntryPath; // Path to entry within vpk.
|
|
|
|
VPKEntryBlock_t(FileHandle_t pFile, string svEntryPath);
|
|
VPKEntryBlock_t(const uint8_t* pData, size_t nLen, int64_t nOffset, uint16_t iPreloadSize,
|
|
uint16_t iPackFileIndex, uint32_t nEntryFlags, uint16_t nTextureFlags, const string& svEntryPath);
|
|
};
|
|
|
|
struct VPKDirHeader_t
|
|
{
|
|
uint32_t m_nHeaderMarker; // File magic.
|
|
uint16_t m_nMajorVersion; // Vpk major version.
|
|
uint16_t m_nMinorVersion; // Vpk minor version.
|
|
uint32_t m_nDirectorySize; // Directory tree size.
|
|
uint32_t m_nSignatureSize; // Directory signature.
|
|
};
|
|
|
|
struct VPKDir_t
|
|
{
|
|
VPKDirHeader_t m_vHeader; // Dir header.
|
|
vector<VPKEntryBlock_t> m_vEntryBlocks; // Vector of entry blocks.
|
|
uint16_t m_nPackFileCount; // Number of pack patches (pack file count-1).
|
|
vector<string> m_vPackFile; // Vector of pack file names.
|
|
string m_svDirPath; // Path to vpk_dir file.
|
|
|
|
VPKDir_t(const string& svPath);
|
|
VPKDir_t() { m_vHeader.m_nHeaderMarker = VPK_HEADER_MARKER; m_vHeader.m_nMajorVersion = VPK_MAJOR_VERSION; m_vHeader.m_nMinorVersion = VPK_MINOR_VERSION; };
|
|
|
|
void Build(const string& svDirectoryFile, const vector<VPKEntryBlock_t>& vEntryBlocks);
|
|
};
|
|
|
|
struct VPKPair_t
|
|
{
|
|
string m_svBlockName;
|
|
string m_svDirectoryName;
|
|
};
|
|
|
|
class CPackedStore
|
|
{
|
|
public:
|
|
void InitLzCompParams(void);
|
|
void InitLzDecompParams(void);
|
|
|
|
VPKDir_t GetDirectoryFile(const string& svDirectoryFile, bool bSanitizeName) const;
|
|
string GetPackFile(const string& svPackDirFile, uint16_t iPackFileIndex) const;
|
|
lzham_compress_level GetCompressionLevel(void) const;
|
|
|
|
vector<VPKEntryBlock_t> GetEntryBlocks(FileHandle_t pDirectory) const;
|
|
vector<VPKKeyValues_t> GetEntryPaths(const string& svPathIn) const;
|
|
vector<VPKKeyValues_t> GetEntryPaths(const string& svPathIn, KeyValues* pManifestKeyValues) const;
|
|
|
|
string GetNameParts(const string& svDirectoryName, int nCaptureGroup) const;
|
|
string GetLevelName(const string& svDirectoryName) const;
|
|
|
|
KeyValues* GetManifest(const string& svWorkspace, const string& svManifestName) const;
|
|
vector<string> GetIgnoreList(const string& svWorkspace) const;
|
|
|
|
string FormatEntryPath(const string& svName, const string& svPath, const string& svExtension) const;
|
|
string StripLocalePrefix(const string& svDirectoryFile) const;
|
|
|
|
VPKPair_t BuildFileName(string svLanguage, string svTarget, const string& svLevel, int nPatch) const;
|
|
void BuildManifest(const vector<VPKEntryBlock_t>& vBlock, const string& svWorkSpace, const string& svManifestName) const;
|
|
|
|
void PackWorkspace(const VPKPair_t& vPair, const string& svWorkspace, const string& svBuildPath, bool bManifestOnly);
|
|
void UnpackWorkspace(const VPKDir_t& vDir, const string& svPathOut = "");
|
|
|
|
void ValidateAdler32PostDecomp(const string& svAssetPath);
|
|
void ValidateCRC32PostDecomp(const string& svAssetPath);
|
|
|
|
private:
|
|
size_t m_nChunkCount; // The number of fragments for this asset.
|
|
lzham_uint32 m_nAdler32_Internal; // Internal operation Adler32 file checksum.
|
|
lzham_uint32 m_nAdler32; // Pre/post operation Adler32 file checksum.
|
|
lzham_uint32 m_nCrc32_Internal; // Internal operation Crc32 file checksum.
|
|
lzham_uint32 m_nCrc32; // Pre/post operation Crc32 file checksum.
|
|
lzham_compress_params m_lzCompParams; // LZham decompression parameters.
|
|
lzham_compress_status_t m_lzCompStatus; // LZham compression status.
|
|
lzham_decompress_params m_lzDecompParams; // LZham decompression parameters.
|
|
lzham_decompress_status_t m_lzDecompStatus; // LZham decompression status.
|
|
std::unordered_map<string, VPKChunkDescriptor_t&> m_mChunkHashMap;
|
|
};
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
extern CPackedStore* g_pPackedStore;
|
|
|
|
#endif // PACKEDSTORE_H
|