whiteoutlib 0.1.3

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

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

#pragma once

/**
 * @file blp_internal.h
 * @brief Internal constants, packed structs, and helpers shared by parser and writer.
 *
 * This header is NOT part of the public API.
 */

#include <algorithm>
#include <array>
#include <cstdint>
#include <cstring>

#include <whiteout/common_types.h>

#include "../utils/color_convert.h"

namespace whiteout::textures::blp {

using whiteout::textures::swap_red_blue;

// ============================================================================
// Format constants
// ============================================================================

static constexpr u32 BLP0_MAGIC = 0x30504C42u;
static constexpr u32 BLP1_MAGIC = 0x31504C42u;
static constexpr u32 BLP2_MAGIC = 0x32504C42u;

static constexpr u32 MAX_MIP_LEVELS = 16;

static constexpr u32 CONTENT_JPEG = 0;
static constexpr u32 CONTENT_DIRECT = 1;

static constexpr u8 ENCODING_JPEG = 0;
static constexpr u8 ENCODING_PALETTIZED = 1;
static constexpr u8 ENCODING_DXT = 2;
static constexpr u8 ENCODING_BGRA = 3;
static constexpr u8 ENCODING_BGRA_DUP = 4;

// ============================================================================
// Packed on-disk structures
// ============================================================================

#pragma pack(push, 1)

struct BLP1Header {
    u32 magic;
    u32 content;
    u32 alphaBitDepth;
    u32 width;
    u32 height;
    u32 extra;
    u32 hasMipmaps;
};

struct MipmapLocator {
    std::array<u32, 16> mipOffsets;
    std::array<u32, 16> mipSizes;
};

struct BLP2Header {
    u32 magic;
    u32 version;
    u8 colorEncoding;
    u8 alphaBitDepth;
    u8 alphaType;
    u8 hasMipmaps;
    u32 width;
    u32 height;
    std::array<u32, 16> mipOffsets;
    std::array<u32, 16> mipSizes;
    std::array<u32, 256> palette;
};

#pragma pack(pop)

static_assert(sizeof(BLP1Header) == 28, "BLP1Header must be 28 bytes");
static_assert(sizeof(MipmapLocator) == 128, "MipmapLocator must be 128 bytes");
static_assert(sizeof(BLP2Header) == 0x494, "BLP2Header must be 1172 bytes");

// ============================================================================
// Shared inline helpers
// ============================================================================

/// Fill mip offset/size arrays from payload vectors.
inline void fill_mip_table(std::array<u32, 16>& offsets, std::array<u32, 16>& sizes,
                           const std::vector<std::vector<u8>>& payloads, u32 count,
                           u32 base_offset) {
    u32 cursor = base_offset;
    for (u32 mip = 0; mip < count; ++mip) {
        offsets[mip] = cursor;
        sizes[mip] = static_cast<u32>(payloads[mip].size());
        cursor += sizes[mip];
    }
}

/// Copy mip payloads into an output buffer at the recorded offsets.
inline void write_mip_payloads(u8* output, const std::array<u32, 16>& offsets,
                               const std::vector<std::vector<u8>>& payloads, u32 count) {
    for (u32 mip = 0; mip < count; ++mip) {
        std::memcpy(output + offsets[mip], payloads[mip].data(), payloads[mip].size());
    }
}

} // namespace whiteout::textures::blp