zenwebp 0.4.2

High-performance WebP encoding and decoding in pure Rust
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

//! Standalone metadata convenience functions for WebP data.
//!
//! These functions operate on already-encoded WebP bytes, extracting or
//! embedding ICC, EXIF, and XMP metadata without decoding pixels.
//!
//! For embedding metadata during encoding, use
//! [`EncodeRequest::with_metadata`](crate::EncodeRequest::with_metadata) instead.
//!
//! # Example
//!
//! ```rust,no_run
//! use zenwebp::{metadata, ImageMetadata};
//!
//! # let webp_data: &[u8] = &[];
//! // Extract
//! let icc = metadata::icc_profile(webp_data)?;
//!
//! // Embed multiple in one pass
//! let icc_bytes = vec![0u8; 10];
//! let meta = ImageMetadata::new().with_icc_profile(&icc_bytes);
//! let with_meta = metadata::embed(webp_data, &meta)?;
//!
//! // Remove
//! let stripped = metadata::remove_icc(webp_data)?;
//! # Ok::<(), whereat::At<zenwebp::mux::MuxError>>(())
//! ```

use alloc::vec::Vec;

use crate::encoder::ImageMetadata;
use crate::mux::{MuxResult, WebPDemuxer, WebPMux};

/// Extract the ICC color profile from WebP data, if present.
#[track_caller]
pub fn icc_profile(data: &[u8]) -> MuxResult<Option<Vec<u8>>> {
    let demuxer = WebPDemuxer::new(data)?;
    Ok(demuxer.icc_profile().map(|s| s.to_vec()))
}

/// Extract EXIF metadata from WebP data, if present.
#[track_caller]
pub fn exif(data: &[u8]) -> MuxResult<Option<Vec<u8>>> {
    let demuxer = WebPDemuxer::new(data)?;
    Ok(demuxer.exif().map(|s| s.to_vec()))
}

/// Extract XMP metadata from WebP data, if present.
#[track_caller]
pub fn xmp(data: &[u8]) -> MuxResult<Option<Vec<u8>>> {
    let demuxer = WebPDemuxer::new(data)?;
    Ok(demuxer.xmp().map(|s| s.to_vec()))
}

/// Embed metadata (ICC, EXIF, XMP) into WebP data in a single pass.
///
/// More efficient than calling [`embed_icc`], [`embed_exif`], and [`embed_xmp`]
/// separately, since it only parses and reassembles the RIFF container once.
#[track_caller]
pub fn embed(data: &[u8], metadata: &ImageMetadata<'_>) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    if let Some(icc) = metadata.icc_profile {
        mux.set_icc_profile(icc.to_vec());
    }
    if let Some(exif) = metadata.exif {
        mux.set_exif(exif.to_vec());
    }
    if let Some(xmp) = metadata.xmp {
        mux.set_xmp(xmp.to_vec());
    }
    mux.assemble()
}

/// Embed an ICC color profile into WebP data.
///
/// For embedding multiple metadata types at once, use [`embed`] instead.
#[track_caller]
pub fn embed_icc(data: &[u8], icc_profile: &[u8]) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    mux.set_icc_profile(icc_profile.to_vec());
    mux.assemble()
}

/// Embed EXIF metadata into WebP data.
#[track_caller]
pub fn embed_exif(data: &[u8], exif: &[u8]) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    mux.set_exif(exif.to_vec());
    mux.assemble()
}

/// Embed XMP metadata into WebP data.
#[track_caller]
pub fn embed_xmp(data: &[u8], xmp: &[u8]) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    mux.set_xmp(xmp.to_vec());
    mux.assemble()
}

/// Remove ICC color profile from WebP data.
#[track_caller]
pub fn remove_icc(data: &[u8]) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    mux.clear_icc_profile();
    mux.assemble()
}

/// Remove EXIF metadata from WebP data.
#[track_caller]
pub fn remove_exif(data: &[u8]) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    mux.clear_exif();
    mux.assemble()
}

/// Remove XMP metadata from WebP data.
#[track_caller]
pub fn remove_xmp(data: &[u8]) -> MuxResult<Vec<u8>> {
    let mut mux = WebPMux::from_data(data)?;
    mux.clear_xmp();
    mux.assemble()
}