zenpng 0.1.0

PNG encoding and decoding with zencodec trait integration
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

//! PNG encoding and decoding with zencodec trait integration.
//!
//! Uses `zenflate` for both compression and decompression, typed pixel buffers
//! (`imgref` + `rgb`), metadata roundtrip (ICC/EXIF/XMP), and optional palette
//! quantization via `zenquant`.
//!
//! # Quick start
//!
//! ```no_run
//! use zenpng::{decode, probe, encode_rgb8, EncodeConfig, PngDecodeConfig};
//! use enough::Unstoppable;
//! use imgref::ImgVec;
//! use rgb::Rgb;
//!
//! // Decode
//! let data: &[u8] = &[]; // your PNG bytes
//! let output = decode(data, &PngDecodeConfig::default(), &Unstoppable)?;
//! println!("{}x{}", output.info.width, output.info.height);
//!
//! // Encode
//! let pixels = ImgVec::new(vec![Rgb { r: 0u8, g: 0, b: 0 }; 64], 8, 8);
//! let encoded = encode_rgb8(pixels.as_ref(), None, &EncodeConfig::default(), &Unstoppable, &Unstoppable)?;
//! # Ok::<(), whereat::At<zenpng::PngError>>(())
//! ```
//!
//! # zencodec traits
//!
//! [`PngEncoderConfig`] implements [`zencodec::EncoderConfig`] and [`PngDecoderConfig`]
//! implements [`zencodec::DecoderConfig`] for use with multi-codec dispatchers.
//! Note: [`PngDecodeConfig`] (used in the quick start) is the lower-level decode config;
//! [`PngDecoderConfig`] wraps it for the zencodec trait interface.

#![forbid(unsafe_code)]

extern crate alloc;
extern crate std;

whereat::define_at_crate_info!();

mod chunk;
mod codec;
mod decode;
mod decoder;
/// PNG source analysis, compression assessment, and re-encoding recommendations.
pub mod detect;
mod encode;
mod encoder;
mod error;
#[cfg(any(feature = "quantize", feature = "imagequant", feature = "quantette"))]
mod indexed;
mod optimize;
mod quantize;
mod simd;
mod types;
// #[cfg(feature = "zennode")]
// pub mod zennode_defs;

pub use codec::{
    PngAnimationFrameDecoder, PngAnimationFrameEncoder, PngDecodeJob, PngDecoder, PngDecoderConfig,
    PngEncodeJob, PngEncoder, PngEncoderConfig,
};
#[allow(deprecated)]
pub use decode::PngLimits;
pub use decode::{
    ApngDecodeOutput, ApngFrame, ApngFrameInfo, PhysUnit, PngBackground, PngChromaticities,
    PngDecodeConfig, PngDecodeOutput, PngInfo, PngTime, PngWarning, SignificantBits, TextChunk,
    decode, decode_apng, probe,
};
pub use encode::{
    ApngEncodeConfig, ApngFrameInput, EncodeConfig, encode_apng, encode_gray8, encode_gray16,
    encode_rgb8, encode_rgb16, encode_rgba8, encode_rgba16,
};
pub use error::PngError;
#[cfg(any(feature = "quantize", feature = "imagequant", feature = "quantette"))]
pub use indexed::{
    ApngEncodeParams, AutoEncodeResult, QualityGate, encode_apng_auto, encode_apng_indexed,
    encode_auto, encode_indexed,
};
#[cfg(feature = "imagequant")]
pub use quantize::ImagequantQuantizer;
#[cfg(feature = "quantette")]
pub use quantize::QuantetteQuantizer;
#[cfg(feature = "quantize")]
pub use quantize::ZenquantQuantizer;
#[cfg(any(feature = "quantize", feature = "imagequant", feature = "quantette"))]
pub use quantize::default_quantizer;
pub use quantize::{
    MultiFrameOutput, QuantizeOutput, Quantizer, available_backends, quantizer_by_name,
};

pub use types::{Compression, Filter};

#[cfg(feature = "_dev")]
#[doc(hidden)]
pub use crate::encode::{encode_rgb8_with_stats, encode_rgba8_with_stats};
#[cfg(feature = "_dev")]
#[doc(hidden)]
pub use crate::encoder::{PhaseStat, PhaseStats};
#[cfg(feature = "_dev")]
#[doc(hidden)]
pub fn __bench_unfilter_row(filter_type: u8, row: &mut [u8], prev: &[u8], bpp: usize) {
    simd::bench_unfilter_row(filter_type, row, prev, bpp);
}