zenavif 0.1.6

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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
use image::GenericImageView;
use std::collections::BTreeMap;
use std::fs;
use std::io::Write;
use std::panic::{self, AssertUnwindSafe};
use std::path::{Path, PathBuf};
use std::time::Instant;

fn avif_corpus_dir() -> String {
    std::env::var("AVIF_CORPUS_DIR").unwrap_or_else(|_| "/mnt/v/datasets/scraping/avif".into())
}

fn zenavif_output_dir() -> String {
    std::env::var("ZENAVIF_OUTPUT_DIR").unwrap_or_else(|_| "/mnt/v/output/zenavif".into())
}

fn find_avif_files(dir: &Path) -> Vec<PathBuf> {
    let mut files = Vec::new();
    if let Ok(entries) = fs::read_dir(dir) {
        for entry in entries.flatten() {
            let path = entry.path();
            if path.is_dir() {
                files.extend(find_avif_files(&path));
            } else if path
                .extension()
                .is_some_and(|e| e.eq_ignore_ascii_case("avif"))
            {
                files.push(path);
            }
        }
    }
    files
}

#[derive(Default)]
struct Stats {
    total: u32,
    exact_match: u32,
    close_match: u32,
    minor_mismatch: u32,
    major_mismatch: u32,
    dimension_mismatch: u32,
    zenavif_fail: u32,
    libavif_missing: u32,
    sum_max_err: u64,
    sum_avg_err: f64,
    compared: u32,
}

fn compare_pixels(
    zenavif_rgb: &[u8],
    ref_rgb: &[u8],
    width: u32,
    height: u32,
) -> (f64, u8, f64, u64) {
    // Returns (psnr, max_error, avg_error, wrong_pixels)
    let total_pixels = (width as u64) * (height as u64);
    let total_samples = total_pixels * 3;
    let mut sum_sq_err: f64 = 0.0;
    let mut sum_abs_err: f64 = 0.0;
    let mut max_err: u8 = 0;
    let mut wrong_pixels: u64 = 0;

    let len = zenavif_rgb.len().min(ref_rgb.len());
    for i in (0..len).step_by(3) {
        if i + 2 >= len {
            break;
        }
        let mut pixel_wrong = false;
        for c in 0..3 {
            let a = zenavif_rgb[i + c] as i16;
            let b = ref_rgb[i + c] as i16;
            let diff = (a - b).unsigned_abs() as u8;
            if diff > 0 {
                pixel_wrong = true;
                sum_sq_err += (diff as f64) * (diff as f64);
                sum_abs_err += diff as f64;
                if diff > max_err {
                    max_err = diff;
                }
            }
        }
        if pixel_wrong {
            wrong_pixels += 1;
        }
    }

    let mse = sum_sq_err / total_samples as f64;
    let psnr = if mse == 0.0 {
        f64::INFINITY
    } else {
        10.0 * (255.0_f64 * 255.0 / mse).log10()
    };
    let avg_err = sum_abs_err / total_samples as f64;

    (psnr, max_err, avg_err, wrong_pixels)
}

/// CPU feature level names and their corresponding flag masks (x86_64)
fn cpu_levels() -> Vec<(&'static str, u32)> {
    vec![
        // v3 = AVX2 + FMA + BMI etc (bits 0-3 set)
        ("v3-avx2", u32::MAX),
        // v2 = SSE4.2 (bits 0-2 set, AVX2 masked out)
        ("v2-sse4", 0b0111),
        // scalar = no SIMD
        ("scalar", 0),
    ]
}

fn run_comparison(
    files: &[PathBuf],
    input_dir: &Path,
    ref_dir: &Path,
    cpu_mask: u32,
    level_name: &str,
) -> (Stats, Vec<String>) {
    let config = zenavif::DecoderConfig::new()
        .threads(1)
        .cpu_flags_mask(cpu_mask);

    let mut stats = Stats::default();
    let mut mismatches: Vec<String> = Vec::new();
    let total = files.len();

    for (i, path) in files.iter().enumerate() {
        stats.total += 1;

        if (i + 1) % 100 == 0 || i + 1 == total {
            eprint!(
                "\r  [{level_name}] [{}/{}] exact={} close={} minor={} major={} fail={}  ",
                i + 1,
                total,
                stats.exact_match,
                stats.close_match,
                stats.minor_mismatch,
                stats.major_mismatch,
                stats.zenavif_fail,
            );
            std::io::stderr().flush().ok();
        }

        let stem = path.file_stem().unwrap_or_default();
        let ref_png = ref_dir.join(stem).with_extension("png");

        if !ref_png.exists() {
            stats.libavif_missing += 1;
            continue;
        }

        let data = match fs::read(path) {
            Ok(d) => d,
            Err(_) => {
                stats.zenavif_fail += 1;
                continue;
            }
        };

        let result = panic::catch_unwind(AssertUnwindSafe(|| {
            zenavif::decode_with(&data, &config, &zenavif::Unstoppable)
        }));

        let img = match result {
            Ok(Ok(img)) => img,
            _ => {
                stats.zenavif_fail += 1;
                continue;
            }
        };

        let desc = img.descriptor();
        let (z_width, z_height, z_rgb) = if desc.layout_compatible(zenpixels::PixelDescriptor::RGB8)
        {
            let buf = img.try_as_imgref::<rgb::Rgb<u8>>().unwrap();
            let w = buf.width() as u32;
            let h = buf.height() as u32;
            let mut rgb = Vec::with_capacity((w * h * 3) as usize);
            for row in buf.rows() {
                for px in row {
                    rgb.push(px.r);
                    rgb.push(px.g);
                    rgb.push(px.b);
                }
            }
            (w, h, rgb)
        } else if desc.layout_compatible(zenpixels::PixelDescriptor::RGBA8) {
            let buf = img.try_as_imgref::<rgb::Rgba<u8>>().unwrap();
            let w = buf.width() as u32;
            let h = buf.height() as u32;
            let mut rgb = Vec::with_capacity((w * h * 3) as usize);
            for row in buf.rows() {
                for px in row {
                    rgb.push(px.r);
                    rgb.push(px.g);
                    rgb.push(px.b);
                }
            }
            (w, h, rgb)
        } else {
            stats.libavif_missing += 1;
            continue;
        };

        let ref_img = match image::open(&ref_png) {
            Ok(img) => img,
            Err(_) => {
                stats.libavif_missing += 1;
                continue;
            }
        };
        let (r_width, r_height) = ref_img.dimensions();

        if z_width != r_width || z_height != r_height {
            stats.dimension_mismatch += 1;
            let rel = path.strip_prefix(input_dir).unwrap_or(path);
            mismatches.push(format!(
                "DIM\t{}\tzenavif={}x{}\tlibavif={}x{}",
                rel.display(),
                z_width,
                z_height,
                r_width,
                r_height
            ));
            continue;
        }

        let ref_rgb: Vec<u8> = ref_img.to_rgb8().into_raw();
        let (psnr, max_err, avg_err, wrong_pixels) =
            compare_pixels(&z_rgb, &ref_rgb, z_width, z_height);

        stats.compared += 1;
        stats.sum_max_err += max_err as u64;
        stats.sum_avg_err += avg_err;

        let rel = path.strip_prefix(input_dir).unwrap_or(path);
        if max_err == 0 {
            stats.exact_match += 1;
        } else if max_err <= 2 {
            stats.close_match += 1;
            mismatches.push(format!(
                "CLOSE\t{}\tmax_err={}\tavg_err={:.4}\twrong={}/{}\tpsnr={:.1}",
                rel.display(),
                max_err,
                avg_err,
                wrong_pixels,
                (z_width as u64) * (z_height as u64),
                psnr
            ));
        } else if max_err <= 10 {
            stats.minor_mismatch += 1;
            mismatches.push(format!(
                "MINOR\t{}\tmax_err={}\tavg_err={:.4}\twrong={}/{}\tpsnr={:.1}",
                rel.display(),
                max_err,
                avg_err,
                wrong_pixels,
                (z_width as u64) * (z_height as u64),
                psnr
            ));
        } else {
            stats.major_mismatch += 1;
            mismatches.push(format!(
                "MAJOR\t{}\tmax_err={}\tavg_err={:.4}\twrong={}/{}\tpsnr={:.1}",
                rel.display(),
                max_err,
                avg_err,
                wrong_pixels,
                (z_width as u64) * (z_height as u64),
                psnr
            ));
        }
    }
    eprintln!();

    (stats, mismatches)
}

fn main() {
    let args: Vec<String> = std::env::args().collect();

    // Parse --level arg first (so it doesn't get consumed as positional)
    let level_filter = args
        .iter()
        .position(|a| a == "--level")
        .and_then(|i| args.get(i + 1))
        .map(|s| s.as_str());

    // Collect positional args (skip program name and --level/value pairs)
    let positional: Vec<&str> = args
        .iter()
        .skip(1)
        .filter(|a| *a != "--level")
        .filter(|a| level_filter != Some(a.as_str()))
        .map(|s| s.as_str())
        .collect();

    let default_input = avif_corpus_dir();
    let default_ref = format!("{}/libavif-refs", zenavif_output_dir());
    let default_report = zenavif_output_dir();
    let input_dir = positional
        .first()
        .map(|s| Path::new(*s))
        .unwrap_or(Path::new(&default_input));
    let ref_dir = positional
        .get(1)
        .map(|s| Path::new(*s))
        .unwrap_or(Path::new(&default_ref));
    let report_dir = Path::new(&default_report);

    let all_levels = cpu_levels();
    let levels: Vec<_> = match level_filter {
        Some("all") | None => all_levels,
        Some(name) => all_levels
            .into_iter()
            .filter(|(n, _)| n.starts_with(name))
            .collect(),
    };

    if levels.is_empty() {
        eprintln!("Unknown level. Available: v3, v2, scalar, all");
        std::process::exit(1);
    }

    let mut files = find_avif_files(input_dir);
    files.sort();
    println!(
        "Found {} AVIF files in {}",
        files.len(),
        input_dir.display()
    );
    println!("Reference dir: {}", ref_dir.display());
    println!(
        "Testing {} CPU level(s): {}",
        levels.len(),
        levels
            .iter()
            .map(|(n, _)| *n)
            .collect::<Vec<_>>()
            .join(", ")
    );
    println!();

    let start = Instant::now();

    for (level_name, cpu_mask) in &levels {
        println!("=== Testing: {} (mask=0x{:x}) ===", level_name, cpu_mask);
        let level_start = Instant::now();

        let (stats, mismatches) = run_comparison(&files, input_dir, ref_dir, *cpu_mask, level_name);

        let elapsed = level_start.elapsed();
        println!("  Results ({:.1}s):", elapsed.as_secs_f64());
        println!("    Total:              {}", stats.total);
        println!("    Compared:           {}", stats.compared);
        println!(
            "    Exact match:        {} ({:.1}%)",
            stats.exact_match,
            if stats.compared > 0 {
                stats.exact_match as f64 / stats.compared as f64 * 100.0
            } else {
                0.0
            }
        );
        println!(
            "    Close (err<=2):     {} ({:.1}%)",
            stats.close_match,
            if stats.compared > 0 {
                stats.close_match as f64 / stats.compared as f64 * 100.0
            } else {
                0.0
            }
        );
        println!(
            "    Minor (err<=10):    {} ({:.1}%)",
            stats.minor_mismatch,
            if stats.compared > 0 {
                stats.minor_mismatch as f64 / stats.compared as f64 * 100.0
            } else {
                0.0
            }
        );
        println!(
            "    Major (err>10):     {} ({:.1}%)",
            stats.major_mismatch,
            if stats.compared > 0 {
                stats.major_mismatch as f64 / stats.compared as f64 * 100.0
            } else {
                0.0
            }
        );
        println!("    Dim mismatch:       {}", stats.dimension_mismatch);
        println!("    Decode fail:        {}", stats.zenavif_fail);
        println!("    No reference:       {}", stats.libavif_missing);
        if stats.compared > 0 {
            println!(
                "    Avg max error:      {:.3}",
                stats.sum_max_err as f64 / stats.compared as f64
            );
            println!(
                "    Avg pixel error:    {:.6}",
                stats.sum_avg_err / stats.compared as f64
            );
        }

        if !mismatches.is_empty() {
            let mut by_cat: BTreeMap<String, Vec<String>> = BTreeMap::new();
            for m in &mismatches {
                let cat = m.split('\t').next().unwrap_or("?").to_string();
                by_cat.entry(cat).or_default().push(m.clone());
            }

            for (cat, items) in &by_cat {
                println!("    --- {cat} ({} files) ---", items.len());
                for item in items.iter().take(5) {
                    println!("      {item}");
                }
                if items.len() > 5 {
                    println!("      ... and {} more", items.len() - 5);
                }
            }

            // Write per-level report
            let report_path = report_dir.join(format!("comparison-{}.txt", level_name));
            if let Ok(mut report) = fs::File::create(&report_path) {
                for m in &mismatches {
                    writeln!(report, "{m}").ok();
                }
                println!("    Full report: {}", report_path.display());
            }
        }
        println!();
    }

    println!("Total time: {:.1}s", start.elapsed().as_secs_f64());
}