whiteoutlib 0.1.4

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

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

#include <whiteout/textures/bmp/parser.h>

#include "bmp_internal.h"

#include <cstring>
#include <memory>
#include <stdexcept>
#include "../io_helpers.h"
#include "../issue_sink.h"
#include "../utils/color_convert.h"

namespace whiteout::textures::bmp {

class Parser::Impl : public IssueSink {
public:
    std::optional<Texture> parse(std::span<const u8> buffer);
};

std::optional<Texture> Parser::Impl::parse(std::span<const u8> buffer) {
    issues.clear();

    const size_t min_size = sizeof(BmpFileHeader) + sizeof(BmpInfoHeader);
    if (buffer.size() < min_size) {
        fail("Buffer too small for a BMP file");
        return std::nullopt;
    }

    BmpFileHeader file_header{};
    std::memcpy(&file_header, buffer.data(), sizeof(BmpFileHeader));
    if (file_header.signature != BMP_SIGNATURE) {
        fail("Invalid BMP signature");
        return std::nullopt;
    }

    BmpInfoHeader info_header{};
    std::memcpy(&info_header, buffer.data() + sizeof(BmpFileHeader), sizeof(BmpInfoHeader));
    if (info_header.headerSize < 40) {
        fail("Unsupported BMP header size: " + std::to_string(info_header.headerSize));
        return std::nullopt;
    }

    if (info_header.planes != 1) {
        fail("Invalid BMP planes value: " + std::to_string(info_header.planes));
        return std::nullopt;
    }

    if (info_header.compression != BI_RGB && info_header.compression != BI_BITFIELDS) {
        fail("Unsupported BMP compression: " + std::to_string(info_header.compression));
        return std::nullopt;
    }

    if (info_header.bitsPerPixel != 24 && info_header.bitsPerPixel != 32) {
        fail("Unsupported BMP bit depth: " + std::to_string(info_header.bitsPerPixel) +
             " (only 24 and 32 supported)");
        return std::nullopt;
    }

    const bool top_down = info_header.height < 0;
    const u32 width = static_cast<u32>(info_header.width);
    const u32 height = static_cast<u32>(top_down ? -info_header.height : info_header.height);

    if (width == 0 || height == 0) {
        fail("BMP has zero dimensions");
        return std::nullopt;
    }

    const u32 row_stride = bmp_row_stride(width, info_header.bitsPerPixel);
    const u64 required_pixel_data = static_cast<u64>(row_stride) * height;

    if (file_header.dataOffset + required_pixel_data > buffer.size()) {
        fail("BMP file truncated");
        return std::nullopt;
    }

    Texture texture = Texture::create2D(PixelFormat::RGBA8, width, height, 1);
    u8* dest_data = texture.dataPtr();
    const u8* pixel_data = buffer.data() + file_header.dataOffset;

    const u32 source_bytes_per_pixel = info_header.bitsPerPixel / 8;

    for (u32 y = 0; y < height; ++y) {
        // BMP default is bottom-up; top-down when height is negative.
        const u32 source_row = top_down ? y : (height - 1 - y);
        const u8* source_line = pixel_data + static_cast<u64>(source_row) * row_stride;
        u8* dest_line = dest_data + static_cast<u64>(y) * width * 4;

        // BMP stores BGR(A); convert to RGBA.
        convert_bgr_to_rgba(source_line, dest_line, width, source_bytes_per_pixel);
    }

    return texture;
}

Parser::Parser() : pImpl(std::make_unique<Impl>()) {}

Parser::~Parser() = default;

std::optional<Texture> Parser::parse(const std::string& filePath) {
    pImpl->issues.clear();
    auto buf = read_file_bytes(filePath, *pImpl);
    if (!buf) {
        return std::nullopt;
    }
    return pImpl->parse(std::span<const u8>{*buf});
}

std::optional<Texture> Parser::parse(std::span<const u8> buffer) {
    return pImpl->parse(buffer);
}

bool Parser::hasIssues() const {
    return !pImpl->issues.empty();
}

const std::vector<std::string>& Parser::getIssues() const {
    return pImpl->issues;
}

} // namespace whiteout::textures::bmp