Crate hpvcd 

Structs

Cicp

CICP encoding used for both HEIF colr (nclx) boxes and HEVC VUI.

CleanAperture

Clean aperture (spatial crop) from the ISOBMFF clap property (ISO 14496-12 §12.1.4.2).

ColorMetadata

Combined color metadata from a HEIF item.

ContentLightLevel

HDR content light level (CTA-861.3 / ISOBMFF clli): the maximum content light level (MaxCLL) and maximum frame-average light level (MaxFALL), both in cd/m² (nits). Written as the ContentLightLevelBox.

DecodedImage

A fully decoded HEIF/HEIC image.

DecodedYuv

Zero-copy-or-minimal-copy raw YCbCr result. Single-item HEIC images retain their decoder allocation and expose the visible crop through plane offsets and strides. Grid images are naturally tightly packed.

Decoder

A configured, reusable HEIF/HEIC decoder.

FrameYuv

Visible YCbCr planes (already cropped to the display window).

GainMap

Decoded HDR gain map carried as a HEIF auxiliary image.

GainMapFrame

Strided, typed gain-map planes returned by Decoder::decode_yuv.

HeicSettings

Configuration shared by all HEIF/HEIC decode entry points.

ImageInfo

Lightweight, decode-free description of a HEIF/HEIC image.

Metadata

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

ParseLimits

Limits enforced while parsing the HEIF container.

PixelAspectRatio

Pixel aspect ratio from the ISOBMFF pasp property (ISO 14496-12 §12.1.4.4).

PlanarImage

Three planar components with a single sample type. Chroma planes are absent for monochrome images.

PlaneBuffer

An owning, typed, strided image plane.

PlaneLayout

Visible layout of one owned image plane. stride and offset are measured in samples, not bytes. The backing allocation may include coded padding before, after, or between visible rows.

Rgb8Image

Packed display-ready 8-bit RGB output.

VideoDecoder

Stateful HEVC video decoder.

VideoFrame

One decoded, displayable video frame.

Enums

BitDepth

ChromaFormat

Chroma subsampling mode.

DecodeError

DecodeThreads

Worker-thread policy used by HeicSettings.

ImageBuffer

Pixel buffer returned by crate::decode_heic.

MatrixCoefficients

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

Orientation

Primaries

SampleBuf

A typed single-plane sample buffer — u8 for 8-bit, u16 for 10/12-bit.

SamplePlane

One typed plane, used for auxiliary alpha images.

TransferFunction

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

YuvBuffer

Typed planar YCbCr storage. Callers match once for the complete image rather than independently matching Y, Cb, and Cr buffers.

Functions

decode_heic

Decode a HEIF/HEIC file to display-ready pixels using a default Decoder.

decode_heic_rgb8

Decode to display-ready packed 8-bit RGB using a default Decoder. Monochrome images are expanded to gray RGB. The returned buffer always has exactly three bytes per pixel.

decode_heic_rgb8_with_settings

Decode packed RGB8 with one explicit settings value. This output cannot expose auxiliary planes, so alpha and gain-map payloads are never decoded.

decode_heic_with_settings

Decode a display-ready image with one explicit settings value. This creates a decoder and worker pool for the call; reuse Decoder::from_settings for a sequence of images.

decode_heic_yuv

Decode a HEIF/HEIC file and return typed, owning, strided raw YCbCr planes using a default Decoder. Eight-bit items use u8; 10/12-bit items use u16. Single-item images retain coded stride and padding.

decode_heic_yuv_with_settings

Decode typed, strided raw YCbCr planes with one explicit settings value.

decode_hevc

Decode a complete HEVC/H.265 elementary stream into displayable frames.

decode_hevc_frame_at

Decode just the frame shown at seconds, seeking from the nearest preceding random-access point. Convenience wrapper over VideoDecoder::decode_frame_at for one-shot use. The frame rate comes from the stream’s VUI timing; pass an explicit rate with VideoDecoder::decode_frame_at_fps if the stream has none.

read_heic_info

Read image metadata from a HEIF/HEIC file without decoding pixels, using default crate::ParseLimits.

read_heic_info_with_limits

Read image metadata under caller-supplied parse limits.