Crate maroontree 

Modules

av2_image

coeff

Structs

Av2Encoder

A reusable still-image encoder configured for one quality.

Av2Frame

Result of an encode: the AV2 bitstream plus the metadata needed to interpret it.

Av2VideoEncoder

Stateful low-delay AV2 video encoder with a reusable thread budget and DPB.

Cicp

CICP-style color encoding: the primaries + transfer + matrix the image is authored in, plus the sample range. Drives both the HEIF colr (nclx) box and the HEVC VUI signaling.

ContentLightLevel

HDR content light level (CTA-861.3 / ISOBMFF clli)

DarkAq

EncodeConfig

Encoder configuration shared by all entry points.

ItutT35

Raw ITU-T T.35 user metadata — emitted as AV1 ITUT_T35 metadata OBU.

MasteringDisplay

HDR mastering display color volume (SMPTE ST 2086) — emitted as AV1 HDR_MDCV metadata OBU.

Metadata

All optional metadata passed to the encoder, threaded through crate::EncodeConfig.

PlanarImage

Tuning

Encoder tuning knobs. Previously set through AV2_* environment variables; now a plain config value carried by Av2Encoder. Tuning::default reproduces the shipping defaults exactly.

VideoPresetConfig

Declared policy behind a VideoPreset. reference_count reports the active implementation limit, not a future target. Partition fields become execution controls as the corresponding to inter block sto earches land.

Enums

BitDepth

Supported coded bit depths. AV1 profile 0/1 cover 8 and 10; 12 needs profile 2. We model all three; only storage type differs (u8 vs u16).

ChromaFormat

Chroma subsampling format for the AV1 encoder.

ChromaSamplePosition

ColorMetadata

How the output color space is described in the AVIF container.

EncodeError

MatrixCoefficients

CICP matrix coefficients for RGB→YCbCr (ISO/IEC 23091-2 Table 4).

Orientation

Primaries

CICP color primaries (ISO/IEC 23091-2 Table 2).

Speed

Rate-distortion effort for the encoder’s mode search

TransferFunction

CICP transfer characteristics (ISO/IEC 23091-2 Table 3).

TxPart

Luma transform-partition strategy for a 64x64 superblock (replaces the old AV2_TXPART env). ThreeWay RD-chooses among SPLIT/VERT4/HORZ4; Rd2 restricts to {SPLIT,VERT4}; the rest force a single partition (mainly for testing).

VideoPreset

Product-level video speed/quality presets. These are intentionally separate from the still-image Speed tiers so video policy can grow without changing still-image behavior or preset compatibility.

VideoRdoqEffort

VideoThreadingPolicy

VideoTransformSearch

Traits

Pixel

Functions

av2_map_quality

Maps CLI quality 1–100 to AV2 base_q_idx 1–254. quality 100 → q≈3 (near-lossless), quality 60 → q≈100, quality 1 → q=254.

encode_gray8

Encode an 8-bit grayscale image to AVIF using AV1 monochrome coding.

encode_gray10

Encode a 10-bit grayscale image to AVIF.

encode_gray12

Encode a 12-bit grayscale image to AVIF.

encode_gray_alpha8

Encode an 8-bit grayscale image plus a separate 8-bit alpha plane to AVIF.

encode_gray_alpha10

Encode a 10-bit grayscale image plus a separate 10-bit alpha plane to AVIF.

encode_gray_alpha12

Encode a 12-bit grayscale image plus a separate 12-bit alpha plane to AVIF.

encode_ivf

Convenience: encode a whole frame sequence to an in-memory IVF stream.

encode_lossless

Encode a lossless 4:4:4 AVIF still with color signaling.

encode_lossless_gray

Encode a lossless grayscale (monochrome) AVIF still.

encode_lossless_gray_alpha

encode_lossless_gray_obu

encode_lossless_obu

Encode a lossless 4:4:4 still with color signaling.

encode_lossless_with_alpha

Encode a lossless 4:4:4 AVIF still with color signaling.

encode_rgb8

Encode an 8-bit RGB image to AVIF.

encode_rgb10

Encode a 10-bit RGB image to AVIF.

encode_rgb12

Encode a 12-bit RGB image to AVIF.

encode_rgba8

Encode an 8-bit RGBA image to AVIF. The alpha channel is discarded.

encode_rgba8_with_alpha

Encode an 8-bit RGBA image to AVIF with a separate alpha auxiliary image.

encode_rgba10

Encode a 10-bit RGBA image to AVIF. Alpha is discarded.

encode_rgba12

Encode a 12-bit RGBA image to AVIF. Alpha is discarded.

encode_rgba10_with_alpha

Encode a 10-bit RGBA image to AVIF with a separate alpha auxiliary image.

encode_rgba12_with_alpha

Encode a 12-bit RGBA image to AVIF with a separate alpha auxiliary image.

encode_yuv8

Encode a pre-converted 8-bit planar YCbCr image to AVIF.

encode_yuv10

Encode a pre-converted 10-bit planar YCbCr image to AVIF.

encode_yuv12

Encode a pre-converted 12-bit planar YCbCr image to AVIF.

encode_yuva8_with_alpha

Encode pre-converted 8-bit YCbCr + a separate 8-bit alpha plane to AVIF.

encode_yuva10_with_alpha

Encode pre-converted 10-bit YCbCr + a separate 10-bit alpha plane to AVIF.

encode_yuva12_with_alpha

Encode pre-converted 12-bit YCbCr + a separate 12-bit alpha plane to AVIF.