zenavif 0.1.2

Pure Rust AVIF image codec powered by rav1d and zenravif
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

//! Roundtrip encode/decode tests for the encode feature

#![cfg(feature = "encode")]

use almost_enough::{StopToken, Unstoppable};
use imgref::Img;
use rgb::{Rgb, Rgba};
use zenavif::{
    EncodeBitDepth, EncodeColorModel, EncoderConfig, PixelBuffer, encode, encode_rgb8,
    encode_rgb16, encode_rgba8, encode_rgba16, encode_with,
};

fn stop() -> StopToken {
    StopToken::new(Unstoppable)
}

/// Create a simple 16x16 RGB8 test image with a gradient
fn make_rgb8_image() -> Img<Vec<Rgb<u8>>> {
    let mut pixels = Vec::with_capacity(16 * 16);
    for y in 0..16u8 {
        for x in 0..16u8 {
            pixels.push(Rgb {
                r: x * 16,
                g: y * 16,
                b: 128,
            });
        }
    }
    Img::new(pixels, 16, 16)
}

/// Create a simple 16x16 RGBA8 test image with a gradient and alpha
fn make_rgba8_image() -> Img<Vec<Rgba<u8>>> {
    let mut pixels = Vec::with_capacity(16 * 16);
    for y in 0..16u8 {
        for x in 0..16u8 {
            pixels.push(Rgba {
                r: x * 16,
                g: y * 16,
                b: 128,
                a: 200,
            });
        }
    }
    Img::new(pixels, 16, 16)
}

#[test]
fn roundtrip_rgb8() {
    let img = make_rgb8_image();
    let config = EncoderConfig::new().quality(80.0).speed(10);
    let encoded = encode_rgb8(img.as_ref(), &config, stop()).expect("encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    assert!(encoded.color_byte_size > 0);
    assert_eq!(encoded.alpha_byte_size, 0);

    // Decode it back
    let decoded = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(decoded.width(), 16);
    assert_eq!(decoded.height(), 16);
    assert!(!decoded.has_alpha());
}

#[test]
fn roundtrip_rgba8() {
    let img = make_rgba8_image();
    let config = EncoderConfig::new().quality(80.0).speed(10);
    let encoded = encode_rgba8(img.as_ref(), &config, stop()).expect("encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    assert!(encoded.color_byte_size > 0);
    assert!(encoded.alpha_byte_size > 0);

    // Decode it back
    let decoded = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(decoded.width(), 16);
    assert_eq!(decoded.height(), 16);
    assert!(decoded.has_alpha());
}

#[test]
fn convenience_encode_rgb8() {
    let img = make_rgb8_image();
    let pb: PixelBuffer = zenpixels::PixelBuffer::from_imgvec(img).into();
    let encoded = encode(&pb).expect("convenience encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    let roundtrip = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(roundtrip.width(), 16);
    assert_eq!(roundtrip.height(), 16);
}

#[test]
fn convenience_encode_rgba8() {
    let img = make_rgba8_image();
    let pb: PixelBuffer = zenpixels::PixelBuffer::from_imgvec(img).into();
    let encoded = encode(&pb).expect("convenience encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    let roundtrip = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(roundtrip.width(), 16);
    assert_eq!(roundtrip.height(), 16);
    assert!(roundtrip.has_alpha());
}

#[test]
fn encoder_config_builder_chains() {
    let config = EncoderConfig::new()
        .quality(90.0)
        .speed(3)
        .alpha_quality(85.0)
        .bit_depth(EncodeBitDepth::Eight)
        .color_model(EncodeColorModel::YCbCr)
        .threads(Some(1))
        .exif(vec![0xFF, 0xD8]);

    let img = make_rgb8_image();
    let encoded = encode_rgb8(img.as_ref(), &config, stop()).expect("encode should succeed");
    assert!(!encoded.avif_file.is_empty());
}

/// Create a simple 16x16 RGB16 test image with full u16 range values
fn make_rgb16_image() -> Img<Vec<Rgb<u16>>> {
    let mut pixels = Vec::with_capacity(16 * 16);
    for y in 0..16u16 {
        for x in 0..16u16 {
            pixels.push(Rgb {
                r: x * 4096, // 0–61440, full u16 range
                g: y * 4096,
                b: 32768,
            });
        }
    }
    Img::new(pixels, 16, 16)
}

/// Create a simple 16x16 RGBA16 test image with full u16 range values
fn make_rgba16_image() -> Img<Vec<Rgba<u16>>> {
    let mut pixels = Vec::with_capacity(16 * 16);
    for y in 0..16u16 {
        for x in 0..16u16 {
            pixels.push(Rgba {
                r: x * 4096,
                g: y * 4096,
                b: 32768,
                a: 51200,
            });
        }
    }
    Img::new(pixels, 16, 16)
}

#[test]
fn roundtrip_rgb16() {
    let img = make_rgb16_image();
    let config = EncoderConfig::new().quality(80.0).speed(10);
    let encoded = encode_rgb16(img.as_ref(), &config, stop()).expect("encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    assert!(encoded.color_byte_size > 0);
    assert_eq!(encoded.alpha_byte_size, 0);

    // Decode it back
    let decoded = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(decoded.width(), 16);
    assert_eq!(decoded.height(), 16);
    assert!(!decoded.has_alpha());
}

#[test]
fn roundtrip_rgba16() {
    let img = make_rgba16_image();
    let config = EncoderConfig::new().quality(80.0).speed(10);
    let encoded = encode_rgba16(img.as_ref(), &config, stop()).expect("encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    assert!(encoded.color_byte_size > 0);
    assert!(encoded.alpha_byte_size > 0);

    // Decode it back
    let decoded = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(decoded.width(), 16);
    assert_eq!(decoded.height(), 16);
    assert!(decoded.has_alpha());
}

#[test]
fn convenience_encode_rgb16() {
    let img = make_rgb16_image();
    let pb: PixelBuffer = zenpixels::PixelBuffer::from_imgvec(img).into();
    let encoded = encode(&pb).expect("convenience encode should succeed");

    assert!(!encoded.avif_file.is_empty());
    let roundtrip = zenavif::decode(&encoded.avif_file).expect("decode should succeed");
    assert_eq!(roundtrip.width(), 16);
    assert_eq!(roundtrip.height(), 16);
}

#[test]
fn unsupported_grayscale_input() {
    let pixels: Vec<rgb::Gray<u8>> = vec![rgb::Gray::new(128); 4];
    let img = Img::new(pixels, 2, 2);
    let pb: PixelBuffer = zenpixels::PixelBuffer::from_imgvec(img).into();

    let result = encode(&pb);
    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(
        err.to_string().contains("encoding is supported"),
        "error should mention grayscale: {err}"
    );
}

#[test]
fn encode_with_custom_config() {
    let img = make_rgb8_image();
    let pb: PixelBuffer = zenpixels::PixelBuffer::from_imgvec(img).into();
    let config = EncoderConfig::new().quality(50.0).speed(10);

    let encoded = encode_with(&pb, &config, stop()).expect("encode_with should succeed");
    assert!(!encoded.avif_file.is_empty());
}