Struct AvifParser

Source

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

Expand description

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§

Source §

impl<'data> AvifParser<'data>

Source

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.

Source

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.

Source

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).

Source

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.

Source

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

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

Source

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.

Source

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

Get primary item data.

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

Source

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

Get alpha item data, if present.

Source

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

Get grid tile data by index.

Source

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

Get a single animation frame by index.

Source

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

Iterate over all animation frames.

Source

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

Get animation metadata (if animated).

Source

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

Get grid configuration (if grid image).

Source

pub fn grid_tile_count(&self) -> usize

Get number of grid tiles.

Source

pub fn premultiplied_alpha(&self) -> bool

Check if alpha channel uses premultiplied alpha.

Source

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.

Source

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.

Source