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

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

#include "memory_cache.h"

#include <cstring>

namespace whiteout::storages::casc {

MemoryCache::MemoryCache(size_t maxBytes) : m_maxBytes(maxBytes) {}

std::optional<std::vector<u8>> MemoryCache::get(const std::array<u8, 16>& eKey) const {
    std::lock_guard<std::mutex> const lk(m_mutex);
    auto it = m_map.find(eKey);
    if (it == m_map.end())
        return std::nullopt;

    // Promote to front (MRU).
    m_lru.splice(m_lru.begin(), m_lru, it->second);
    return it->second->data;
}

std::optional<MemoryCache::CacheView> MemoryCache::view(const std::array<u8, 16>& eKey) const {
    std::unique_lock<std::mutex> lk(m_mutex);
    auto it = m_map.find(eKey);
    if (it == m_map.end())
        return std::nullopt;

    // Promote to front (MRU).
    m_lru.splice(m_lru.begin(), m_lru, it->second);

    CacheView cv;
    cv.m_data = std::span<const u8>(it->second->data.data(), it->second->data.size());
    cv.m_lock = std::move(lk);
    return cv;
}

void MemoryCache::put(const std::array<u8, 16>& eKey, const std::vector<u8>& data) {
    std::lock_guard<std::mutex> const lk(m_mutex);

    // If already cached, update and promote.
    auto it = m_map.find(eKey);
    if (it != m_map.end()) {
        m_currentBytes -= it->second->data.size();
        it->second->data = data;
        m_currentBytes += data.size();
        m_lru.splice(m_lru.begin(), m_lru, it->second);
        evict();
        return;
    }

    // Don't cache entries larger than the entire budget.
    if (data.size() > m_maxBytes)
        return;

    // Insert at front.
    m_lru.push_front(CacheEntry{eKey, data});
    m_map[eKey] = m_lru.begin();
    m_currentBytes += data.size();

    evict();
}

void MemoryCache::clear() {
    std::lock_guard<std::mutex> const lk(m_mutex);
    m_lru.clear();
    m_map.clear();
    m_currentBytes = 0;
}

void MemoryCache::evict() {
    // Caller must hold m_mutex.
    while (m_currentBytes > m_maxBytes && !m_lru.empty()) {
        auto& back = m_lru.back();
        m_currentBytes -= back.data.size();
        m_map.erase(back.eKey);
        m_lru.pop_back();
    }
}

} // namespace whiteout::storages::casc