Struct AvifData 

pub struct AvifData {
    pub primary_item: TryVec<u8>,
    pub alpha_item: Option<TryVec<u8>>,
    pub premultiplied_alpha: bool,
    pub grid_config: Option<GridConfig>,
    pub grid_tiles: TryVec<TryVec<u8>>,
    pub animation: Option<AnimationConfig>,
}

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

Fields

primary_item: TryVec<u8>

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

AV1 data for the color channels.

The collected data indicated by the pitm box, See ISO 14496-12:2015 § 8.11.4

alpha_item: Option<TryVec<u8>>

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

AV1 data for alpha channel.

Associated alpha channel for the primary item, if any

premultiplied_alpha: bool

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

If true, divide RGB values by the alpha value.

See prem in MIAF § 7.3.5.2

grid_config: Option<GridConfig>

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

Grid configuration for tiled images.

If present, the image is a grid and grid_tiles contains the tile data. Grid layout is determined either from an explicit ImageGrid property box or calculated from ispe (Image Spatial Extents) properties.

Example

#[allow(deprecated)]
use std::fs::File;
#[allow(deprecated)]
let data = zenavif_parse::read_avif(&mut File::open("image.avif")?)?;

if let Some(grid) = data.grid_config {
    println!("Grid: {}×{} tiles", grid.rows, grid.columns);
    println!("Output: {}×{}", grid.output_width, grid.output_height);
    println!("Tile count: {}", data.grid_tiles.len());
}

grid_tiles: TryVec<TryVec<u8>>

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

AV1 payloads for grid image tiles.

Empty for non-grid images. For grid images, contains one entry per tile.

Tile ordering: Tiles are guaranteed to be in the correct order for grid assembly, sorted by their dimgIdx (reference index). This is row-major order: tiles in the first row from left to right, then the second row, etc.

animation: Option<AnimationConfig>

👎Deprecated since 1.5.0: Use AvifParser for zero-copy parsing instead

Animation configuration (for animated AVIF with avis brand)

When present, primary_item contains the first frame

Implementations

impl AvifData

pub fn from_reader<R: Read>(reader: &mut R) -> Result<Self>

👎Deprecated since 1.5.0: Use AvifParser::from_reader() instead

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

Parses AV1 data to get basic properties of the opaque channel

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

Parses AV1 data to get basic properties about the alpha channel, if any

Trait Implementations

impl Debug for AvifData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AvifData

fn default() -> AvifData

Returns the “default value” for a type.