Skip to main content

Module frame

Module frame 

Source
Expand description

Decoded frames and owned software planes.

Shared frame owners and mapping contracts live in zencodec::frame. The existing media import paths name those exact types. Software plane storage stays here because accounted allocations use zencodec-io.

Structs§

ColorClaim
Colour claims with their provenance. The bitstream and the container may disagree; resolved is what the adapter’s format rule chose (AV1 in ISOBMFF: fill and agree rules). Unknown stays unknown.
Crop
A rectangle in coded coordinates.
Frame
One presentation of a decoded picture. Cheap to clone; outlives the decoder; may share its picture with another frame.
FrameGeometry
The shape of a decoded picture.
FrameInterpretation
Everything needed to interpret the samples of one frame. Immutable and shared through Arc: a configuration change makes a new one, and a frame keeps the one it was decoded under.
FrameTiming
Timing of one presentation.
OwnedPlane
One owned plane.
OwnedPlanes
Owned planes in their native words: the Picture of a software decoder.
PlaneView
One plane borrowed from a mapping. The stride is in bytes, as in zenpixels; rows exclude padding. Construction checks the geometry, not the samples.
Presentation
Facts about one presentation.
SampleEncoding
Storage word, significant code bits and their placement within the word.

Enums§

ChromaSiting
Where chroma samples sit relative to luma. An axis of its own: Unknown is kept, never defaulted to Center; a conversion that needs siting refuses Unknown on a subsampled axis or takes it from the caller.
MapError
A picture could not be mapped.
PlaneData
Words of one owned plane.
PlaneError
A plane whose storage does not fit its geometry.
PlaneRole
What a plane holds.
PlaneSamples
Borrowed samples of one plane, in their storage word.
SampleEncodingError
An impossible SampleEncoding.
Subsampling
Chroma subsampling of a planar picture.

Traits§

MappedPlanes
A picture’s planes, mapped. Views borrow the mapping, which borrows the picture, so storage stays put while it is read (rav1d-safe: “a mapped plane owns a borrow guard”).
Picture
Backend-owned pixel storage: rav1d’s refcounted picture, an owned set of planes, a pool slot.