Struct AvifParser 

pub struct AvifParser<'data> { /* private fields */ }

Zero-copy AVIF parser backed by a borrowed or owned byte buffer.

AvifParser records byte offsets during parsing but does not copy mdat payload data. Data access methods return Cow<[u8]> — borrowed when the item is a single contiguous extent, owned when extents must be concatenated.

Constructors

Method	Lifetime	Zero-copy?
from_bytes	'data	Yes — borrows the slice
from_owned	'static	Within the owned buffer
from_reader	'static	Reads all, then owned

Example

use zenavif_parse::AvifParser;

let bytes = std::fs::read("image.avif")?;
let parser = AvifParser::from_bytes(&bytes)?;
let primary = parser.primary_data()?; // Cow::Borrowed for single-extent

Implementations

impl<'data> AvifParser<'data>

pub fn from_bytes(data: &'data [u8]) -> Result<Self>

Parse AVIF from a borrowed byte slice (true zero-copy).

The returned parser borrows data — single-extent items will be returned as Cow::Borrowed slices into this buffer.

pub fn from_bytes_with_config( data: &'data [u8], config: &DecodeConfig, stop: &dyn Stop, ) -> Result<Self>

Parse AVIF from a borrowed byte slice with resource limits.

pub fn from_owned(data: Vec<u8>) -> Result<AvifParser<'static>>

Parse AVIF from an owned buffer.

The returned parser owns the data — single-extent items will still be returned as Cow::Borrowed slices (borrowing from the internal buffer).

pub fn from_owned_with_config( data: Vec<u8>, config: &DecodeConfig, stop: &dyn Stop, ) -> Result<AvifParser<'static>>

Parse AVIF from an owned buffer with resource limits.

pub fn from_reader<R: Read>(reader: &mut R) -> Result<AvifParser<'static>>

Parse AVIF from a reader (reads all bytes, then parses).

pub fn from_reader_with_config<R: Read>( reader: &mut R, config: &DecodeConfig, stop: &dyn Stop, ) -> Result<AvifParser<'static>>

Parse AVIF from a reader with resource limits.

If config.peak_memory_limit is set, reading is capped at that many bytes to prevent unbounded allocation from an untrusted reader.

pub fn primary_data(&self) -> Result<Cow<'_, [u8]>>

Get primary item data.

Returns Cow::Borrowed for single-extent items, Cow::Owned for multi-extent.

pub fn alpha_data(&self) -> Option<Result<Cow<'_, [u8]>>>

Get alpha item data, if present.

pub fn tile_data(&self, index: usize) -> Result<Cow<'_, [u8]>>

Get grid tile data by index.

pub fn frame(&self, index: usize) -> Result<FrameRef<'_>>

Get a single animation frame by index.

pub fn frames(&self) -> FrameIterator<'_>

Iterate over all animation frames.

pub fn animation_info(&self) -> Option<AnimationInfo>

Get animation metadata (if animated).

pub fn grid_config(&self) -> Option<&GridConfig>

Get grid configuration (if grid image).

pub fn grid_tile_count(&self) -> usize

Get number of grid tiles.

pub fn premultiplied_alpha(&self) -> bool

Check if alpha channel uses premultiplied alpha.

pub fn av1_config(&self) -> Option<&AV1Config>

Get the AV1 codec configuration for the primary item, if present.

This is parsed from the av1C property box in the container.

pub fn color_info(&self) -> Option<&ColorInformation>

Get colour information for the primary item, if present.

This is parsed from the colr property box in the container. For CICP/nclx values, this is the authoritative source and may differ from values in the AV1 bitstream sequence header.

pub fn rotation(&self) -> Option<&ImageRotation>

Get rotation for the primary item, if present.

pub fn mirror(&self) -> Option<&ImageMirror>

Get mirror for the primary item, if present.

pub fn clean_aperture(&self) -> Option<&CleanAperture>

Get clean aperture (crop) for the primary item, if present.

pub fn pixel_aspect_ratio(&self) -> Option<&PixelAspectRatio>

Get pixel aspect ratio for the primary item, if present.

pub fn content_light_level(&self) -> Option<&ContentLightLevel>

Get content light level info for the primary item, if present.

pub fn mastering_display(&self) -> Option<&MasteringDisplayColourVolume>

Get mastering display colour volume for the primary item, if present.

pub fn content_colour_volume(&self) -> Option<&ContentColourVolume>

Get content colour volume for the primary item, if present.

pub fn ambient_viewing(&self) -> Option<&AmbientViewingEnvironment>

Get ambient viewing environment for the primary item, if present.

pub fn operating_point(&self) -> Option<&OperatingPointSelector>

Get operating point selector for the primary item, if present.

pub fn layer_selector(&self) -> Option<&LayerSelector>

Get layer selector for the primary item, if present.

pub fn layered_image_indexing(&self) -> Option<&AV1LayeredImageIndexing>

Get AV1 layered image indexing for the primary item, if present.

pub fn exif(&self) -> Option<Result<Cow<'_, [u8]>>>

Get EXIF metadata for the primary item, if present.

Returns raw EXIF data (TIFF header onwards), with the 4-byte AVIF offset prefix stripped.

pub fn xmp(&self) -> Option<Result<Cow<'_, [u8]>>>

Get XMP metadata for the primary item, if present.

Returns raw XMP/XML data.

pub fn gain_map_metadata(&self) -> Option<&GainMapMetadata>

Gain map metadata, if a tmap derived image item is present.

Describes how to apply a gain map to reconstruct an HDR rendition from the SDR base image. See ISO 21496-1.

pub fn gain_map_data(&self) -> Option<Result<Cow<'_, [u8]>>>

Gain map image data (AV1-encoded), if present.

pub fn gain_map_color_info(&self) -> Option<&ColorInformation>

Color information for the alternate (typically HDR) rendition.

This comes from the tmap item’s colr property and describes the colour space of the tone-mapped output.

pub fn gain_map(&self) -> Option<Result<AvifGainMap>>

Get the full gain map bundle, if a tmap derived image item is present.

Returns AvifGainMap containing metadata, raw AV1 gain map data, and alternate rendition color info. Returns None if no gain map is present, or Some(Err(..)) if the gain map data cannot be resolved.

pub fn has_depth_map(&self) -> bool

Check if a depth auxiliary image is present.

Returns true if the AVIF container has an auxl-linked item with a depth auxiliary type URN.

pub fn depth_map_data(&self) -> Option<Result<Cow<'_, [u8]>>>

Get the raw AV1 bitstream of the depth auxiliary image, if present.

pub fn depth_map(&self) -> Option<Result<AvifDepthMap>>

Get the full depth map bundle, if a depth auxiliary image is present.

Returns AvifDepthMap containing the raw AV1 depth image data, dimensions, codec config, and color info. Returns None if no depth auxiliary is present, or Some(Err(..)) if the data cannot be resolved.

Example

let bytes = std::fs::read("portrait.avif").unwrap();
let parser = zenavif_parse::AvifParser::from_bytes(&bytes).unwrap();
if let Some(Ok(dm)) = parser.depth_map() {
    println!("Depth: {}x{}, {} bytes", dm.width, dm.height, dm.data.len());
}

pub fn major_brand(&self) -> &[u8; 4]

Get the major brand from the ftyp box (e.g., *b"avif" or *b"avis").

pub fn compatible_brands(&self) -> &[[u8; 4]]

Get the compatible brands from the ftyp box.

pub fn primary_metadata(&self) -> Result<AV1Metadata>

Parse AV1 metadata from the primary item.

pub fn alpha_metadata(&self) -> Option<Result<AV1Metadata>>

Parse AV1 metadata from the alpha item, if present.

pub fn to_avif_data(&self) -> Result<AvifData>

👎Deprecated since 1.5.0:

Use AvifParser methods directly instead of converting to AvifData

Convert to AvifData (eagerly loads all frames and tiles).

Provided for migration from the eager API. Prefer using AvifParser methods directly.