whiteoutlib 0.1.5

Read and write Blizzard game assets from Rust: models (MDX, M2, M3), textures (BLP, DDS, PNG, JPEG, BMP, TGA, TIFF, GIF) and archives (CASC, MPQ).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow

#include "../crypto.h"
#include "block_table.h"

#include <cstring>

namespace whiteout::storages::mpq {

// ============================================================================
// Parsing
// ============================================================================

bool BlockTable::parse(std::span<const u8> data, u32 count) {
    const size_t expectedSize = static_cast<size_t>(count) * sizeof(BlockEntry);
    if (data.size() < expectedSize)
        return false;

    // Copy and decrypt in place.
    std::vector<u32> raw(count * 4);
    std::memcpy(raw.data(), data.data(), expectedSize);
    decryptBlock(raw.data(), raw.size(), hashString("(block table)", HashType::FileKey));

    m_entries.resize(count);
    for (u32 i = 0; i < count; ++i) {
        const u32* src = raw.data() + i * 4;
        m_entries[i].fileOffset = src[0];
        m_entries[i].compressedSize = src[1];
        m_entries[i].uncompressedSize = src[2];
        m_entries[i].flags = static_cast<FileFlag>(src[3]);
    }

    m_hiBlockOffsets.clear();
    return true;
}

bool BlockTable::parseHiBlockTable(std::span<const u8> data, u32 count) {
    const size_t expectedSize = static_cast<size_t>(count) * sizeof(u16);
    if (data.size() < expectedSize)
        return false;

    m_hiBlockOffsets.resize(count);
    std::memcpy(m_hiBlockOffsets.data(), data.data(), expectedSize);
    return true;
}

// ============================================================================
// Creation
// ============================================================================

void BlockTable::createEmpty() {
    m_entries.clear();
    m_hiBlockOffsets.clear();
}

// ============================================================================
// Append
// ============================================================================

u32 BlockTable::append(const BlockEntry& entry) {
    u32 const index = static_cast<u32>(m_entries.size());
    m_entries.push_back(entry);
    return index;
}

// ============================================================================
// 48-bit offset
// ============================================================================

u64 BlockTable::fileOffset48(u32 index) const {
    u64 const lo = m_entries[index].fileOffset;
    if (index < m_hiBlockOffsets.size()) {
        u64 const hi = m_hiBlockOffsets[index];
        return lo | (hi << 32);
    }
    return lo;
}

// ============================================================================
// Serialize
// ============================================================================

std::vector<u8> BlockTable::serialize() const {
    const size_t byteSize = m_entries.size() * sizeof(BlockEntry);
    std::vector<u32> raw(m_entries.size() * 4);

    for (size_t i = 0; i < m_entries.size(); ++i) {
        const auto& e = m_entries[i];
        raw[i * 4 + 0] = e.fileOffset;
        raw[i * 4 + 1] = e.compressedSize;
        raw[i * 4 + 2] = e.uncompressedSize;
        raw[i * 4 + 3] = static_cast<u32>(e.flags);
    }

    encryptBlock(raw.data(), raw.size(), hashString("(block table)", HashType::FileKey));

    std::vector<u8> result(byteSize);
    std::memcpy(result.data(), raw.data(), byteSize);
    return result;
}

std::vector<u8> BlockTable::serializeHiBlockTable() const {
    std::vector<u8> result(m_entries.size() * sizeof(u16));
    for (size_t i = 0; i < m_entries.size(); ++i) {
        u16 hi = 0;
        if (i < m_hiBlockOffsets.size()) {
            hi = m_hiBlockOffsets[i];
        }
        std::memcpy(result.data() + i * sizeof(u16), &hi, sizeof(u16));
    }
    return result;
}

bool BlockTable::needsHiBlockTable() const {
    for (const auto& hi : m_hiBlockOffsets) {
        if (hi != 0)
            return true;
    }
    return false;
}

} // namespace whiteout::storages::mpq