codec-eval 0.3.1

Image codec comparison and evaluation library
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

//! # codec-eval
//!
//! Image codec comparison and evaluation library.
//!
//! This library provides an **API-first design** where external crates provide
//! encode/decode callbacks, and this library handles quality metrics, viewing
//! conditions, and report generation.
//!
//! ## Quick Start
//!
//! ```rust,ignore
//! use codec_eval::{EvalSession, EvalConfig, ViewingCondition, ImageData};
//!
//! let config = EvalConfig::builder()
//!     .report_dir("./reports")
//!     .viewing(ViewingCondition::desktop())
//!     .build();
//!
//! let mut session = EvalSession::new(config);
//!
//! session.add_codec("my-codec", "1.0.0", Box::new(|image, request| {
//!     // Your encoding logic here
//!     Ok(encoded_bytes)
//! }));
//!
//! let report = session.evaluate_image("test.png", image_data)?;
//! ```
//!
//! ## Modules
//!
//! - [`error`]: Error types for the library
//! - [`viewing`]: Viewing condition modeling for perceptual metrics
//! - [`metrics`]: Quality metrics (DSSIM, SSIMULACRA2, Butteraugli, PSNR)
//! - [`eval`]: Evaluation session and report generation
//! - [`corpus`]: Test corpus management
//! - [`import`]: CSV import for third-party results
//! - [`stats`]: Statistical analysis and Pareto front
//! - [`interpolation`]: Quality interpolation and polynomial fitting

pub mod corpus;
#[cfg(feature = "jpeg-decode")]
pub mod decode;
pub mod error;
pub mod eval;
pub mod import;
#[cfg(feature = "interpolation")]
pub mod interpolation;
pub mod metrics;
pub mod stats;
pub mod viewing;

// Re-export commonly used types for codec evaluation
pub use corpus::{Corpus, CorpusImage, ImageCategory};
pub use error::{Error, Result};
pub use eval::{
    // Session-based evaluation (full API)
    CodecResult,
    CorpusReport,
    EvalConfig,
    EvalSession,
    ImageData,
    ImageReport,
    // Evaluation helpers (lightweight API for zen* projects)
    assert_perception_level,
    assert_quality,
    evaluate_single,
};
pub use import::{CsvImporter, ExternalResult};
pub use metrics::{MetricConfig, MetricResult, PerceptionLevel};
pub use stats::{ParetoFront, RDPoint, Summary};
pub use viewing::{REFERENCE_PPD, ViewingCondition};

// Advanced/specialized re-exports (less commonly used)

/// Sparse corpus checkout types (for large test corpora).
#[cfg(feature = "default")]
pub use corpus::{SparseCheckout, SparseFilter, SparseStatus};

/// CSV schema for importing external results.
#[cfg(feature = "default")]
pub use import::CsvSchema;

/// ICC color profile support (requires `icc` feature).
#[cfg(feature = "icc")]
pub use metrics::ColorProfile;

/// XYB color space roundtrip (for testing XYB-based codecs).
pub use metrics::xyb_roundtrip;

/// Statistical functions (mean, median, percentile, etc.).
pub use stats::{iqr, mean, median, percentile, percentile_u32, std_dev, trimmed_mean};

/// Viewing condition simulation parameters.
pub use viewing::{SimulationMode, SimulationParams};

// Feature-gated re-exports

/// Chart generation types (requires `chart` feature).
#[cfg(feature = "chart")]
pub use stats::{ChartConfig, ChartPoint, ChartSeries, generate_svg};

/// Polynomial interpolation for quality curves (requires `interpolation` feature).
#[cfg(feature = "interpolation")]
pub use interpolation::{
    GapPolynomial, InterpolationConfig, InterpolationTable, compute_gap_polynomials,
    fit_gap_polynomial, fit_power_law, linear_interpolate,
};