whiteoutlib 0.1.1

Read and write Blizzard game assets: models (MDX, M2, M3), textures (BLP, DDS, PNG, ...) 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

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow
/// @file ow_root.h
/// @brief Overwatch (Tank) root manifest parser.
///
/// Overwatch uses a text-based root file listing manifest entries (CMF, APM,
/// TRG).  Each CMF (Content Manifest File) maps 64-bit GUIDs to content keys.
/// This parser reads the text root, resolves CMF files via a CKey callback,
/// and builds a flat GUID → CKey index for file access.
///
/// Internal header — not part of the public include path.
#pragma once

#include "common/entry_index.h"
#include "root.h"

#include <span>
#include <vector>

namespace whiteout::interfaces {
class WorkerPool;
}

namespace whiteout::storages::casc {

/// A single entry from the Overwatch text root manifest.
struct OwRootFileEntry {
    std::string fileId;
    std::array<u8, 16> md5{};
    u8 chunkId = 0;
    u8 priority = 0;
    u8 mPriority = 0;
    std::string fileName;
    std::string installPath;
};

/// CMF header (version 26+, Overwatch 1.48+).
struct CmfHeader {
    u32 buildVersion = 0;
    i32 dataCount = 0;
    i32 entryCount = 0;
    u32 magic = 0;
    u8 version = 0;
    bool encrypted = false;
};

/// CMF hash data entry (version 25+).
struct CmfHashData {
    u64 guid = 0;
    u32 size = 0;
    u8 unknown = 0;
    std::array<u8, 16> contentKey{};
};

class OwRoot final : public RootManifest {
public:
    /// Parse an Overwatch text root file.
    /// @param data     Raw (BLTE-decoded) root file bytes (text format).
    /// @param resolver Callback that resolves CKey → file data (for CMF files).
    ///                 May be nullptr for root-only parsing (no CMF resolution).
    /// @param pool     Optional worker pool for parallel CMF parsing.
    /// @return Parsed root, or nullptr on failure.
    static std::unique_ptr<OwRoot> parse(std::span<const u8> data, CKeyResolver resolver = nullptr,
                                         interfaces::WorkerPool* pool = nullptr);

    /// Parse an Overwatch text root file from the manifest entries directly.
    /// Useful for testing without raw byte parsing.
    static std::unique_ptr<OwRoot> fromManifestEntries(std::vector<OwRootFileEntry> manifestEntries,
                                                       CKeyResolver resolver = nullptr,
                                                       interfaces::WorkerPool* pool = nullptr);

    // --- RootManifest interface ---
    std::vector<const RootEntry*> findByPath(const std::string& path) const override;
    std::vector<const RootEntry*> findByFileDataId(
        u32 fileDataId, FileIdHint hint = FileIdHint::None) const override;
    bool hasFileDataId(u32, FileIdHint = FileIdHint::None) const override {
        return false;
    }

    /// Find entries by 64-bit Overwatch GUID.
    std::vector<const RootEntry*> findByGuid(u64 guid) const;

    RootFormat format() const override {
        return RootFormat::Overwatch;
    }

    /// Access the parsed manifest entries (CMF/APM/TRG listing).
    const std::vector<OwRootFileEntry>& manifestEntries() const {
        return m_manifestEntries;
    }

protected:
    const std::vector<RootEntry>& entries() const override {
        return m_entries;
    }
    std::vector<RootEntry>& mutableEntries() override {
        return m_entries;
    }

private:
    /// All entries from parsed CMF files.
    std::vector<RootEntry> m_entries;

    /// Text root manifest entries.
    std::vector<OwRootFileEntry> m_manifestEntries;

    /// GUID-based lookup (GUID stored in fileNameHash field).
    EntryIndex<u64> m_byGuid;

    /// Path-based lookup (for manifest file entries).
    EntryIndex<std::string> m_byPath;

    void buildIndices();
};

} // namespace whiteout::storages::casc