image-blp 1.2.0

Library to encode/decode Blizzard BLP texture format
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use super::super::*;
use crate::encode::encode_blp0;
use crate::path::make_mipmap_path;
use test_log::test;

fn test_blp0(
    name: &str,
    blp_bytes: &[u8],
    blp_mipmaps: &[Vec<u8>],
    expected_header: &BlpHeader,
    expected_images: usize,
) {
    let (_, parsed) = parse_blp_with_externals(blp_bytes, |i| preloaded_mipmaps(blp_mipmaps, i))
        .expect("successfull parsing");
    assert_eq!(&parsed.header, expected_header);
    assert_eq!(parsed.image_count(), expected_images);
    let encoded = encode_blp0(&parsed).expect("encoded blp");
    // There are zeros in the original file at the end
    let blp_bytes_n: Vec<u8> = blp_bytes
        .iter()
        .take(encoded.blp_bytes.len())
        .copied()
        .collect();
    assert_eq!(encoded.blp_bytes, blp_bytes_n);
    assert_eq!(encoded.blp_mipmaps, blp_mipmaps);

    // Test File API
    {
        let dir = tempfile::tempdir().expect("temporary directory");
        let blp_name = format!("{}.blp", name);
        let blp_path = dir.path().join(Path::new(&blp_name));
        std::fs::write(&blp_path, blp_bytes).expect("write");
        for (i, mipmap) in blp_mipmaps.iter().enumerate() {
            let mipmap_name = make_mipmap_path(&blp_path, i).expect("mipmap name");
            std::fs::write(mipmap_name, mipmap).expect("write");
        }

        let loaded = load_blp(&blp_path).expect("loaded");
        assert_eq!(loaded, parsed);
    }
}

#[test]
fn test_wyvern_rider() {
    let blp_bytes = include_bytes!("../../../../assets/blp0/WyvernRider.blp");
    let blp_mipmaps = vec![
        include_bytes!("../../../../assets/blp0/WyvernRider.b00").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b01").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b02").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b03").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b04").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b05").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b06").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b07").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b08").to_vec(),
        include_bytes!("../../../../assets/blp0/WyvernRider.b09").to_vec(),
    ];
    let header = BlpHeader {
        version: BlpVersion::Blp0,
        content: BlpContentTag::Jpeg,
        flags: BlpFlags::Old {
            alpha_bits: 8,
            extra: 4,
            has_mipmaps: 1,
        },
        width: 512,
        height: 256,
        mipmap_locator: MipmapLocator::External,
    };
    test_blp0(
        "WyvernRider",
        blp_bytes,
        &blp_mipmaps,
        &header,
        blp_mipmaps.len(),
    );
}

#[test]
fn test_hero_level_border() {
    let blp_bytes = include_bytes!("../../../../assets/blp0/HeroLevel-Border.blp");
    let blp_mipmaps = vec![
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b00").to_vec(),
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b01").to_vec(),
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b02").to_vec(),
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b03").to_vec(),
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b04").to_vec(),
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b05").to_vec(),
        include_bytes!("../../../../assets/blp0/HeroLevel-Border.b06").to_vec(),
    ];
    let header = BlpHeader {
        version: BlpVersion::Blp0,
        content: BlpContentTag::Direct,
        flags: BlpFlags::Old {
            alpha_bits: 0,
            extra: 5,
            has_mipmaps: 1,
        },
        width: 64,
        height: 64,
        mipmap_locator: MipmapLocator::External,
    };
    test_blp0(
        "HeroLevel-Border",
        blp_bytes,
        &blp_mipmaps,
        &header,
        blp_mipmaps.len(),
    );
}

#[test]
fn test_acid_splash1() {
    let blp_bytes = include_bytes!("../../../../assets/blp0/AcidSplash1.blp");
    let blp_mipmaps = vec![
        include_bytes!("../../../../assets/blp0/AcidSplash1.b00").to_vec(),
        include_bytes!("../../../../assets/blp0/AcidSplash1.b01").to_vec(),
        include_bytes!("../../../../assets/blp0/AcidSplash1.b02").to_vec(),
        include_bytes!("../../../../assets/blp0/AcidSplash1.b03").to_vec(),
        include_bytes!("../../../../assets/blp0/AcidSplash1.b04").to_vec(),
        include_bytes!("../../../../assets/blp0/AcidSplash1.b05").to_vec(),
        include_bytes!("../../../../assets/blp0/AcidSplash1.b06").to_vec(),
    ];
    let header = BlpHeader {
        version: BlpVersion::Blp0,
        content: BlpContentTag::Jpeg,
        flags: BlpFlags::Old {
            alpha_bits: 8,
            extra: 4,
            has_mipmaps: 1,
        },
        width: 64,
        height: 64,
        mipmap_locator: MipmapLocator::External,
    };
    test_blp0(
        "AcidSplash1",
        blp_bytes,
        &blp_mipmaps,
        &header,
        blp_mipmaps.len(),
    );
}