mirror of https://github.com/OpenMW/openmw.git
Handle GNRL case of ba2 format
Cédric Mocquillon
2 years ago
parent
a0cddfda2b
commit
c1fbe90953
@ -0,0 +1,270 @@
|
|||||||
|
#include "ba2gnrlfile.hpp"
|
||||||
|
|
||||||
|
#include <cassert>
|
||||||
|
#include <filesystem>
|
||||||
|
#include <fstream>
|
||||||
|
|
||||||
|
#include <lz4frame.h>
|
||||||
|
|
||||||
|
#include <boost/iostreams/copy.hpp>
|
||||||
|
#include <boost/iostreams/filtering_streambuf.hpp>
|
||||||
|
|
||||||
|
#if defined(_MSC_VER)
|
||||||
|
#pragma warning(push)
|
||||||
|
#pragma warning(disable : 4706)
|
||||||
|
#include <boost/iostreams/filter/zlib.hpp>
|
||||||
|
#pragma warning(pop)
|
||||||
|
#else
|
||||||
|
#include <boost/iostreams/filter/zlib.hpp>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <boost/iostreams/device/array.hpp>
|
||||||
|
#include <components/bsa/memorystream.hpp>
|
||||||
|
#include <components/esm/fourcc.hpp>
|
||||||
|
#include <components/files/constrainedfilestream.hpp>
|
||||||
|
#include <components/files/conversion.hpp>
|
||||||
|
#include <components/misc/strings/lower.hpp>
|
||||||
|
|
||||||
|
namespace Bsa
|
||||||
|
{
|
||||||
|
// special marker for invalid records,
|
||||||
|
// equal to max uint32_t value
|
||||||
|
const uint32_t sInvalidOffset = std::numeric_limits<uint32_t>::max();
|
||||||
|
|
||||||
|
BA2GNRLFile::FileRecord::FileRecord()
|
||||||
|
: size(0)
|
||||||
|
, offset(sInvalidOffset)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
bool BA2GNRLFile::FileRecord::isValid() const
|
||||||
|
{
|
||||||
|
return offset != sInvalidOffset;
|
||||||
|
}
|
||||||
|
|
||||||
|
BA2GNRLFile::BA2GNRLFile() {}
|
||||||
|
|
||||||
|
BA2GNRLFile::~BA2GNRLFile() = default;
|
||||||
|
|
||||||
|
void BA2GNRLFile::loadFiles(uint32_t fileCount, std::istream& in)
|
||||||
|
{
|
||||||
|
mFiles.clear();
|
||||||
|
mFiles.reserve(fileCount);
|
||||||
|
for (uint32_t i = 0; i < fileCount; ++i)
|
||||||
|
{
|
||||||
|
uint32_t nameHash, extHash, dirHash;
|
||||||
|
in.read(reinterpret_cast<char*>(&nameHash), sizeof(uint32_t));
|
||||||
|
in.read(reinterpret_cast<char*>(&extHash), sizeof(uint32_t));
|
||||||
|
in.read(reinterpret_cast<char*>(&dirHash), sizeof(uint32_t));
|
||||||
|
|
||||||
|
FileRecord file;
|
||||||
|
uint32_t unknown;
|
||||||
|
in.read(reinterpret_cast<char*>(&unknown), sizeof(uint32_t));
|
||||||
|
in.read(reinterpret_cast<char*>(&file.offset), sizeof(int64_t));
|
||||||
|
in.read(reinterpret_cast<char*>(&file.packedSize), sizeof(uint32_t));
|
||||||
|
in.read(reinterpret_cast<char*>(&file.size), sizeof(uint32_t));
|
||||||
|
|
||||||
|
uint32_t baadfood;
|
||||||
|
in.read(reinterpret_cast<char*>(&baadfood), sizeof(uint32_t));
|
||||||
|
if (baadfood != 0xBAADF00D)
|
||||||
|
fail("Corrupted BSA");
|
||||||
|
|
||||||
|
mFolders[dirHash][{ nameHash, extHash }] = file;
|
||||||
|
|
||||||
|
FileStruct fileStruct{};
|
||||||
|
fileStruct.fileSize = file.size;
|
||||||
|
fileStruct.offset = file.offset;
|
||||||
|
mFiles.push_back(fileStruct);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read header information from the input source
|
||||||
|
void BA2GNRLFile::readHeader()
|
||||||
|
{
|
||||||
|
assert(!mIsLoaded);
|
||||||
|
|
||||||
|
std::ifstream input(mFilepath, std::ios_base::binary);
|
||||||
|
|
||||||
|
// Total archive size
|
||||||
|
std::streamoff fsize = 0;
|
||||||
|
if (input.seekg(0, std::ios_base::end))
|
||||||
|
{
|
||||||
|
fsize = input.tellg();
|
||||||
|
input.seekg(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (fsize < 24) // header is 24 bytes
|
||||||
|
fail("File too small to be a valid BSA archive");
|
||||||
|
|
||||||
|
// Get essential header numbers
|
||||||
|
uint32_t type, fileCount;
|
||||||
|
uint64_t fileTableOffset;
|
||||||
|
{
|
||||||
|
uint32_t header[4];
|
||||||
|
input.read(reinterpret_cast<char*>(header), 16);
|
||||||
|
input.read(reinterpret_cast<char*>(&fileTableOffset), 8);
|
||||||
|
|
||||||
|
if (header[0] == 0x00415342) /*"BSA\x00"*/
|
||||||
|
fail("Unrecognized compressed BSA format");
|
||||||
|
mVersion = header[1];
|
||||||
|
if (mVersion != 0x01 /*F04*/)
|
||||||
|
fail("Unrecognized compressed BSA version");
|
||||||
|
|
||||||
|
type = header[2];
|
||||||
|
fileCount = header[3];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (type == ESM::fourCC("GNRL"))
|
||||||
|
loadFiles(fileCount, input);
|
||||||
|
else
|
||||||
|
fail("Unrecognized ba2 version type");
|
||||||
|
|
||||||
|
// Read the string table
|
||||||
|
input.seekg(fileTableOffset);
|
||||||
|
for (uint32_t i = 0; i < fileCount; ++i)
|
||||||
|
{
|
||||||
|
std::vector<char> fileName;
|
||||||
|
uint16_t fileNameSize;
|
||||||
|
input.read(reinterpret_cast<char*>(&fileNameSize), sizeof(uint16_t));
|
||||||
|
fileName.resize(fileNameSize);
|
||||||
|
input.read(fileName.data(), fileName.size());
|
||||||
|
fileName.push_back('\0');
|
||||||
|
mFileNames.push_back(fileName);
|
||||||
|
mFiles[i].setNameInfos(0, &mFileNames.back());
|
||||||
|
}
|
||||||
|
|
||||||
|
mIsLoaded = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
BA2GNRLFile::FileRecord BA2GNRLFile::getFileRecord(const std::string& str) const
|
||||||
|
{
|
||||||
|
for (const auto c : str)
|
||||||
|
{
|
||||||
|
if (((static_cast<unsigned>(c) >> 7U) & 1U) != 0U)
|
||||||
|
{
|
||||||
|
fail("File record " + str + " contains unicode characters, refusing to load.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
const auto& path = str;
|
||||||
|
#else
|
||||||
|
// Force-convert the path into something UNIX can handle first
|
||||||
|
// to make sure std::filesystem::path doesn't think the entire path is the filename on Linux
|
||||||
|
// and subsequently purge it to determine the file folder.
|
||||||
|
std::string path = str;
|
||||||
|
std::replace(path.begin(), path.end(), '\\', '/');
|
||||||
|
#endif
|
||||||
|
|
||||||
|
const auto p = std::filesystem::path{ path }; // Purposefully damage Unicode strings.
|
||||||
|
const auto fileName = Misc::StringUtils::lowerCase(p.stem().string());
|
||||||
|
const auto ext = Misc::StringUtils::lowerCase(p.extension().string()); // Purposefully damage Unicode strings.
|
||||||
|
const auto folder = Misc::StringUtils::lowerCase(p.parent_path().string());
|
||||||
|
|
||||||
|
uint32_t folderHash = generateHash(folder);
|
||||||
|
auto it = mFolders.find(folderHash);
|
||||||
|
if (it == mFolders.end())
|
||||||
|
return FileRecord(); // folder not found, return default which has offset of sInvalidOffset
|
||||||
|
|
||||||
|
uint32_t fileHash = generateHash(fileName);
|
||||||
|
uint32_t extHash = *reinterpret_cast<const uint32_t*>(ext.data() + 1);
|
||||||
|
auto iter = it->second.find({ fileHash, extHash });
|
||||||
|
if (iter == it->second.end())
|
||||||
|
return FileRecord(); // file not found, return default which has offset of sInvalidOffset
|
||||||
|
return iter->second;
|
||||||
|
}
|
||||||
|
|
||||||
|
Files::IStreamPtr BA2GNRLFile::getFile(const FileStruct* file)
|
||||||
|
{
|
||||||
|
FileRecord fileRec = getFileRecord(file->name());
|
||||||
|
if (!fileRec.isValid())
|
||||||
|
{
|
||||||
|
fail("File not found: " + std::string(file->name()));
|
||||||
|
}
|
||||||
|
return getFile(fileRec);
|
||||||
|
}
|
||||||
|
|
||||||
|
void BA2GNRLFile::addFile(const std::string& filename, std::istream& file)
|
||||||
|
{
|
||||||
|
assert(false); // not implemented yet
|
||||||
|
fail("Add file is not implemented for compressed BSA: " + filename);
|
||||||
|
}
|
||||||
|
|
||||||
|
Files::IStreamPtr BA2GNRLFile::getFile(const char* file)
|
||||||
|
{
|
||||||
|
FileRecord fileRec = getFileRecord(file);
|
||||||
|
if (!fileRec.isValid())
|
||||||
|
{
|
||||||
|
fail("File not found: " + std::string(file));
|
||||||
|
}
|
||||||
|
return getFile(fileRec);
|
||||||
|
}
|
||||||
|
|
||||||
|
Files::IStreamPtr BA2GNRLFile::getFile(const FileRecord& fileRecord)
|
||||||
|
{
|
||||||
|
Files::IStreamPtr streamPtr
|
||||||
|
= Files::openConstrainedFileStream(mFilepath, fileRecord.offset, fileRecord.packedSize);
|
||||||
|
std::istream* fileStream = streamPtr.get();
|
||||||
|
uint32_t uncompressedSize = fileRecord.size;
|
||||||
|
auto memoryStreamPtr = std::make_unique<MemoryInputStream>(uncompressedSize);
|
||||||
|
if (fileRecord.packedSize != 0)
|
||||||
|
{
|
||||||
|
boost::iostreams::filtering_streambuf<boost::iostreams::input> inputStreamBuf;
|
||||||
|
inputStreamBuf.push(boost::iostreams::zlib_decompressor());
|
||||||
|
inputStreamBuf.push(*fileStream);
|
||||||
|
|
||||||
|
boost::iostreams::basic_array_sink<char> sr(memoryStreamPtr->getRawData(), uncompressedSize);
|
||||||
|
boost::iostreams::copy(inputStreamBuf, sr);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
fileStream->read(memoryStreamPtr->getRawData(), fileRecord.size);
|
||||||
|
}
|
||||||
|
return std::make_unique<Files::StreamWithBuffer<MemoryInputStream>>(std::move(memoryStreamPtr));
|
||||||
|
}
|
||||||
|
|
||||||
|
constexpr const uint32_t crc32table[256] = { 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
|
||||||
|
0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
|
||||||
|
0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
|
||||||
|
0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8,
|
||||||
|
0x4c69105e, 0xd56041e4, 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
|
||||||
|
0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, 0xc8d75180,
|
||||||
|
0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
|
||||||
|
0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589,
|
||||||
|
0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
|
||||||
|
0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, 0x1b01a57b, 0x8208f4c1,
|
||||||
|
0xf50fc457, 0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
|
||||||
|
0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
|
||||||
|
0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
|
||||||
|
0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, 0x5edef90e, 0x29d9c998, 0xb0d09822,
|
||||||
|
0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
|
||||||
|
0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b,
|
||||||
|
0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
|
||||||
|
0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43,
|
||||||
|
0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
|
||||||
|
0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79, 0xcb61b38c,
|
||||||
|
0xbc66831a, 0x256fd2a0, 0x5268e236, 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
|
||||||
|
0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
|
||||||
|
0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
|
||||||
|
0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 0x81be16cd,
|
||||||
|
0xf6b9265b, 0x6fb077e1, 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
|
||||||
|
0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, 0x4969474d,
|
||||||
|
0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
|
||||||
|
0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e,
|
||||||
|
0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d };
|
||||||
|
|
||||||
|
uint32_t BA2GNRLFile::generateHash(const std::string& name)
|
||||||
|
{
|
||||||
|
uint32_t result = 0;
|
||||||
|
for (auto c : name)
|
||||||
|
{
|
||||||
|
if (uint8_t(c) > 127)
|
||||||
|
continue;
|
||||||
|
if (c == '/')
|
||||||
|
c = '\\';
|
||||||
|
result = (result >> 8) ^ crc32table[(result ^ (unsigned)(c)) & 0xFF];
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace Bsa
|
||||||
@ -0,0 +1,55 @@
|
|||||||
|
#ifndef BSA_BA2_GNRL_FILE_H
|
||||||
|
#define BSA_BA2_GNRL_FILE_H
|
||||||
|
|
||||||
|
#include <list>
|
||||||
|
#include <map>
|
||||||
|
|
||||||
|
#include <components/bsa/bsa_file.hpp>
|
||||||
|
#include <filesystem>
|
||||||
|
|
||||||
|
namespace Bsa
|
||||||
|
{
|
||||||
|
class BA2GNRLFile : private BSAFile
|
||||||
|
{
|
||||||
|
private:
|
||||||
|
struct FileRecord
|
||||||
|
{
|
||||||
|
FileRecord();
|
||||||
|
uint32_t size;
|
||||||
|
uint32_t offset;
|
||||||
|
uint32_t packedSize = 0;
|
||||||
|
bool isValid() const;
|
||||||
|
};
|
||||||
|
|
||||||
|
uint32_t mVersion{ 0u };
|
||||||
|
|
||||||
|
using FolderRecord = std::map<std::pair<uint32_t, uint32_t>, FileRecord>;
|
||||||
|
std::map<uint32_t, FolderRecord> mFolders;
|
||||||
|
|
||||||
|
std::list<std::vector<char>> mFileNames;
|
||||||
|
|
||||||
|
FileRecord getFileRecord(const std::string& str) const;
|
||||||
|
|
||||||
|
static uint32_t generateHash(const std::string& name);
|
||||||
|
Files::IStreamPtr getFile(const FileRecord& fileRecord);
|
||||||
|
|
||||||
|
void loadFiles(uint32_t fileCount, std::istream& in);
|
||||||
|
|
||||||
|
public:
|
||||||
|
using BSAFile::getFilename;
|
||||||
|
using BSAFile::getList;
|
||||||
|
using BSAFile::open;
|
||||||
|
|
||||||
|
BA2GNRLFile();
|
||||||
|
virtual ~BA2GNRLFile();
|
||||||
|
|
||||||
|
/// Read header information from the input source
|
||||||
|
void readHeader() override;
|
||||||
|
|
||||||
|
Files::IStreamPtr getFile(const char* filePath);
|
||||||
|
Files::IStreamPtr getFile(const FileStruct* fileStruct);
|
||||||
|
void addFile(const std::string& filename, std::istream& file);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif
|
||||||
Loading…
Reference in New Issue