Expand description
AVIF container parser (ISOBMFF/MIAF demuxer).
Extracts AV1 payloads, alpha channels, grid tiles, animation frames, and container metadata from AVIF files. Written in safe Rust with fallible allocations throughout.
The primary API is AvifParser, which performs zero-copy parsing by
recording byte offsets and resolving data on demand.
A legacy eager API (read_avif) is available behind the eager feature flag.
Modules§
- c_api
- This crate can be used from C.
Structs§
- AV1Config
- AV1 codec configuration from the
av1Cproperty box. - AV1Layered
Image Indexing - AV1 layered image indexing from the
a1lxproperty box. - AV1Metadata
- AV1 sequence header metadata parsed from an OBU bitstream.
- Ambient
Viewing Environment - Ambient viewing environment from the
amveproperty box. - Animation
Config Deprecated - Animation configuration for animated AVIF (avis brand)
- Animation
Frame Deprecated - Frame information for animated AVIF
- Animation
Info - Animation metadata from
AvifParser - Avif
Data Deprecated - Avif
Parser - Zero-copy AVIF parser backed by a borrowed or owned byte buffer.
- Clean
Aperture - Clean aperture from the
clapproperty box. - Content
Colour Volume - Content colour volume from the
cclvproperty box. - Content
Light Level - Content light level info from the
clliproperty box. - Decode
Config - Configuration for parsing AVIF files with resource limits and validation options
- Frame
Iterator - Iterator over animation frames.
- Frame
Ref - A single frame from an animated AVIF, with zero-copy when possible.
- Grid
Config - Grid configuration for tiled/grid-based AVIF images Grid image configuration
- Image
Mirror - Image mirror from the
imirproperty box. - Image
Rotation - Image rotation from the
irotproperty box. - Layer
Selector - Layer selector from the
lselproperty box. - Mastering
Display Colour Volume - Mastering display colour volume from the
mdcvproperty box. - Operating
Point Selector - Operating point selector from the
a1opproperty box. - Parse
Options - Options for parsing AVIF files
- Pixel
Aspect Ratio - Pixel aspect ratio from the
paspproperty box. - Unstoppable
- A
Stopimplementation that never stops (no cooperative cancellation).
Enums§
- Color
Information - Colour information from the
colrproperty box. - Error
- Describes parser failures.
- Stop
Reason - Why an operation was stopped.
Traits§
- Stop
- Cooperative cancellation check.
Functions§
- read_
avif Deprecated - Read the contents of an AVIF file
- read_
avif_ with_ config Deprecated - Read the contents of an AVIF file with resource limits and cancellation support
- read_
avif_ with_ options Deprecated - Read the contents of an AVIF file with custom parsing options
Type Aliases§
- Result
- Result shorthand using our Error enum.