jpegli-rs 0.12.0

Pure Rust JPEG encoder/decoder - port of Google's jpegli with perceptual optimizations
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
//! Unified quality comparison tool for JPEG encoders.
//!
//! Compares encoders across quality levels with multiple metrics.
//! Supports single-image analysis, Pareto curves, and same-size comparisons.
//!
//! Usage:
//!   cargo run --release --example quality_compare -- [OPTIONS] <image.png>
//!
//! Options:
//!   --encoder <name>    Encoder to test. Can specify multiple times. Default: all
//!                       Available: jpegli-rs-ycbcr, jpegli-rs-ycbcr-hybrid, jpegli-rs-xyb,
//!                                  jpegli-rs-ycbcr-444, jpegli-rs-ycbcr-hybrid-444
//!   --quality <n>       Single quality level (0-100). Default: sweep 10-95
//!   --metric <name>     Metric to use (dssim, ssim2, butteraugli, all). Default: all
//!   --output <file>     Output CSV file
//!   --pareto            Generate Pareto curve data
//!   --same-size         Compare at same file size (find matching quality)
//!   --quick             Quick mode: fewer quality levels (10, 30, 50, 70, 90)
//!
//! Examples:
//!   # Quick YCbCr vs hybrid comparison
//!   cargo run --release --example quality_compare --features experimental-hybrid-trellis -- \
//!     --encoder jpegli-rs-ycbcr --encoder hybrid --quick image.png
//!
//!   # Full Pareto curve to CSV
//!   cargo run --release --example quality_compare -- --pareto --output results.csv image.png
//!
//!   # Single quality point
//!   cargo run --release --example quality_compare -- --quality 75 image.png

use jpegli_bench_utils::{
    decode_jpeg_to_rgb, ChromaSubsampling, ColorMode, EncoderConfig, EncoderImpl, ImageData,
    QualityMetrics,
};
use std::env;
use std::fs::File;
use std::io::Write;
use std::path::Path;
use std::time::Instant;

#[derive(Debug, Clone)]
#[allow(dead_code)] // pareto/same_size are parsed but not yet implemented
struct Config {
    encoders: Vec<EncoderConfig>,
    qualities: Vec<u8>,
    metrics: Vec<Metric>,
    output_csv: Option<String>,
    pareto: bool,
    same_size: bool,
    image_path: String,
}

#[derive(Debug, Clone, Copy)]
enum Metric {
    Dssim,
    Ssim2,
    Butteraugli,
}

impl Metric {
    fn name(&self) -> &'static str {
        match self {
            Metric::Dssim => "DSSIM",
            Metric::Ssim2 => "SSIM2",
            Metric::Butteraugli => "Butteraugli",
        }
    }
}

#[derive(Debug)]
struct Result {
    encoder: String,
    quality: u8,
    bytes: usize,
    bpp: f64,
    dssim: Option<f64>,
    ssim2: Option<f64>,
    butteraugli: Option<f64>,
    encode_ms: f64,
}

fn parse_args() -> Config {
    let args: Vec<String> = env::args().collect();

    let mut encoders = Vec::new();
    let mut qualities = Vec::new();
    let mut metrics = Vec::new();
    let mut output_csv = None;
    let mut pareto = false;
    let mut same_size = false;
    let mut quick = false;
    let mut image_path = None;

    let mut i = 1;
    while i < args.len() {
        match args[i].as_str() {
            "--encoder" => {
                i += 1;
                if i < args.len() {
                    encoders.push(parse_encoder(&args[i]));
                }
            }
            "--quality" => {
                i += 1;
                if i < args.len() {
                    qualities.push(args[i].parse().expect("invalid quality"));
                }
            }
            "--metric" => {
                i += 1;
                if i < args.len() {
                    match args[i].as_str() {
                        "dssim" => metrics.push(Metric::Dssim),
                        "ssim2" => metrics.push(Metric::Ssim2),
                        "butteraugli" => metrics.push(Metric::Butteraugli),
                        "all" => {
                            metrics.extend([Metric::Dssim, Metric::Ssim2, Metric::Butteraugli])
                        }
                        _ => eprintln!("Unknown metric: {}", args[i]),
                    }
                }
            }
            "--output" => {
                i += 1;
                if i < args.len() {
                    output_csv = Some(args[i].clone());
                }
            }
            "--pareto" => pareto = true,
            "--same-size" => same_size = true,
            "--quick" => quick = true,
            arg if !arg.starts_with('-') => {
                image_path = Some(arg.to_string());
            }
            _ => eprintln!("Unknown argument: {}", args[i]),
        }
        i += 1;
    }

    // Defaults
    if encoders.is_empty() {
        encoders.push(EncoderConfig::new(EncoderImpl::JpegliRs).color(ColorMode::YCbCr));
        encoders.push(EncoderConfig::new(EncoderImpl::JpegliRs).color(ColorMode::Xyb));
        encoders.push(EncoderConfig::new(EncoderImpl::CJpegli).color(ColorMode::YCbCr));
    }

    if qualities.is_empty() {
        if quick {
            qualities = vec![10, 30, 50, 70, 90];
        } else if pareto {
            qualities = (10..=95).step_by(5).collect();
        } else {
            qualities = vec![75];
        }
    }

    if metrics.is_empty() {
        metrics = vec![Metric::Dssim, Metric::Ssim2, Metric::Butteraugli];
    }

    let image_path = image_path.unwrap_or_else(|| {
        eprintln!("Usage: quality_compare [OPTIONS] <image.png>");
        eprintln!("  --encoder <name>   jpegli-rs-ycbcr, jpegli-rs-xyb, cjpegli");
        eprintln!("  --quality <n>      Quality level 0-100");
        eprintln!("  --metric <name>    dssim, ssim2, butteraugli, all");
        eprintln!("  --output <file>    CSV output file");
        eprintln!("  --pareto           Sweep quality levels for Pareto curve");
        eprintln!("  --quick            Quick mode (5 quality levels)");
        std::process::exit(1);
    });

    Config {
        encoders,
        qualities,
        metrics,
        output_csv,
        pareto,
        same_size,
        image_path,
    }
}

fn parse_encoder(name: &str) -> EncoderConfig {
    match name {
        "jpegli-rs-ycbcr" | "jpegli-ycbcr" | "jpegli" => {
            EncoderConfig::new(EncoderImpl::JpegliRs).color(ColorMode::YCbCr)
        }
        "jpegli-rs-ycbcr-hybrid" | "jpegli-ycbcr-hybrid" | "jpegli-hybrid" | "hybrid" => {
            EncoderConfig::new(EncoderImpl::JpegliRs)
                .color(ColorMode::YCbCr)
                .hybrid(true)
        }
        "jpegli-rs-xyb" | "jpegli-xyb" | "xyb" => {
            EncoderConfig::new(EncoderImpl::JpegliRs).color(ColorMode::Xyb)
        }
        "cjpegli" => EncoderConfig::new(EncoderImpl::CJpegli).color(ColorMode::YCbCr),
        "jpegli-rs-ycbcr-444" => EncoderConfig::new(EncoderImpl::JpegliRs)
            .color(ColorMode::YCbCr)
            .subsampling(ChromaSubsampling::S444),
        "jpegli-rs-ycbcr-hybrid-444" => EncoderConfig::new(EncoderImpl::JpegliRs)
            .color(ColorMode::YCbCr)
            .subsampling(ChromaSubsampling::S444)
            .hybrid(true),
        "jpegli-rs-xyb-444" => EncoderConfig::new(EncoderImpl::JpegliRs)
            .color(ColorMode::Xyb)
            .subsampling(ChromaSubsampling::S444),
        _ => {
            eprintln!("Unknown encoder: {}. Using jpegli-rs-ycbcr", name);
            EncoderConfig::new(EncoderImpl::JpegliRs).color(ColorMode::YCbCr)
        }
    }
}

fn run_comparison(config: &Config) -> Vec<Result> {
    let img = ImageData::from_png(Path::new(&config.image_path)).expect("Failed to load PNG");

    let orig_rgb = img.as_rgb_image();
    let pixels = img.pixel_count();

    println!(
        "Image: {} ({}x{}, {:.2} MP)",
        config.image_path,
        img.width,
        img.height,
        pixels as f64 / 1_000_000.0
    );
    println!();

    // Print header
    print!("{:<25} {:>5} {:>10} {:>8}", "Encoder", "Q", "Size", "BPP");
    for metric in &config.metrics {
        print!(" {:>12}", metric.name());
    }
    println!(" {:>8}", "Time");
    println!("{}", "-".repeat(80));

    let mut results = Vec::new();

    for encoder in &config.encoders {
        for &quality in &config.qualities {
            let mut enc = encoder.clone();
            enc.quality = quality;

            let start = Instant::now();
            let jpeg_data: Vec<u8> = match enc.encode(&img) {
                Ok(data) => data,
                Err(e) => {
                    eprintln!("  {} q{}: {}", enc.short_name(), quality, e);
                    continue;
                }
            };
            let encode_ms = start.elapsed().as_secs_f64() * 1000.0;

            let bpp = jpeg_data.len() as f64 * 8.0 / pixels as f64;

            // Decode and compute metrics
            let decoded = decode_jpeg_to_rgb(&jpeg_data).expect("Failed to decode JPEG");

            let mut dssim = None;
            let mut ssim2 = None;
            let mut butteraugli = None;

            for metric in &config.metrics {
                match metric {
                    Metric::Dssim => {
                        dssim = Some(QualityMetrics::dssim(orig_rgb.as_ref(), decoded.as_ref()));
                    }
                    Metric::Ssim2 => {
                        ssim2 = Some(QualityMetrics::ssimulacra2(
                            orig_rgb.as_ref(),
                            decoded.as_ref(),
                        ));
                    }
                    Metric::Butteraugli => {
                        butteraugli = Some(QualityMetrics::butteraugli(
                            orig_rgb.as_ref(),
                            decoded.as_ref(),
                        ));
                    }
                }
            }

            // Print row
            print!(
                "{:<25} {:>5} {:>10} {:>8.3}",
                enc.short_name(),
                quality,
                format_size(jpeg_data.len()),
                bpp
            );

            for metric in &config.metrics {
                let value = match metric {
                    Metric::Dssim => dssim.map(|v| format!("{:.6}", v)),
                    Metric::Ssim2 => ssim2.map(|v| format!("{:.2}", v)),
                    Metric::Butteraugli => butteraugli.map(|v| format!("{:.4}", v)),
                };
                print!(" {:>12}", value.unwrap_or_default());
            }
            println!(" {:>7.1}ms", encode_ms);

            results.push(Result {
                encoder: enc.short_name(),
                quality,
                bytes: jpeg_data.len(),
                bpp,
                dssim,
                ssim2,
                butteraugli,
                encode_ms,
            });
        }
    }

    results
}

fn write_csv(results: &[Result], path: &str, config: &Config) -> std::io::Result<()> {
    let mut f = File::create(path)?;

    // Header
    write!(f, "encoder,quality,bytes,bpp")?;
    for metric in &config.metrics {
        write!(f, ",{}", metric.name().to_lowercase())?;
    }
    writeln!(f, ",encode_ms")?;

    // Data
    for r in results {
        write!(f, "{},{},{},{:.4}", r.encoder, r.quality, r.bytes, r.bpp)?;
        for metric in &config.metrics {
            let value = match metric {
                Metric::Dssim => r.dssim,
                Metric::Ssim2 => r.ssim2,
                Metric::Butteraugli => r.butteraugli,
            };
            if let Some(v) = value {
                write!(f, ",{:.6}", v)?;
            } else {
                write!(f, ",")?;
            }
        }
        writeln!(f, ",{:.2}", r.encode_ms)?;
    }

    Ok(())
}

fn format_size(bytes: usize) -> String {
    if bytes >= 1_000_000 {
        format!("{:.2} MB", bytes as f64 / 1_000_000.0)
    } else if bytes >= 1_000 {
        format!("{:.1} KB", bytes as f64 / 1_000.0)
    } else {
        format!("{} B", bytes)
    }
}

fn main() {
    let config = parse_args();
    let results = run_comparison(&config);

    if let Some(csv_path) = &config.output_csv {
        if let Err(e) = write_csv(&results, csv_path, &config) {
            eprintln!("Failed to write CSV: {}", e);
        } else {
            println!("\nResults written to {}", csv_path);
        }
    }

    // Summary
    if results.len() > 1 {
        println!("\n--- Summary ---");

        // Group by encoder and find best quality at each size
        let encoders: Vec<String> = config
            .encoders
            .iter()
            .map(|e: &EncoderConfig| e.short_name())
            .collect();

        for encoder in &encoders {
            let encoder_results: Vec<_> =
                results.iter().filter(|r| &r.encoder == encoder).collect();

            if encoder_results.is_empty() {
                continue;
            }

            let avg_bpp: f64 =
                encoder_results.iter().map(|r| r.bpp).sum::<f64>() / encoder_results.len() as f64;

            let avg_ssim2 = if config.metrics.iter().any(|m| matches!(m, Metric::Ssim2)) {
                let sum: f64 = encoder_results.iter().filter_map(|r| r.ssim2).sum();
                let count = encoder_results.iter().filter(|r| r.ssim2.is_some()).count();
                if count > 0 {
                    Some(sum / count as f64)
                } else {
                    None
                }
            } else {
                None
            };

            print!("{}: avg bpp={:.3}", encoder, avg_bpp);
            if let Some(s) = avg_ssim2 {
                print!(", avg SSIM2={:.2}", s);
            }
            println!();
        }
    }
}