Struct VideoFrame 

pub struct VideoFrame<P, E, D> { /* private fields */ }

A decoded video frame.

Generic parameters:

• P — pixel-format identifier (e.g. mediadecode_ffmpeg::PixelFormat).
• E — backend-specific frame extras (HDR mastering display, RAW sensor metadata, picture type, …).
• D — plane data buffer type. Each populated Plane<D> carries one plane’s bytes; D: AsRef<[u8]> at the use site (e.g. Bytes, &'a [u8], refcounted FFmpeg buffer).

width / height are the coded dimensions; visible_rect (when present) is the displayable subregion (FFmpeg crop / WebCodecs visibleRect / ProRes RAW CleanAperture).

plane_count is the number of populated entries in planes. Four slots cover every realistic format: NV12 = 2, YUV420P = 3, YUVA / packed-with-alpha = 4, packed RGB / Bayer CFA = 1.

Implementations

impl<P, E, D> VideoFrame<P, E, D>

pub const fn new( dimensions: Dimensions, pixel_format: P, planes: [Plane<D>; 4], plane_count: u8, extra: E, ) -> Self

Constructs a VideoFrame. Timestamps default to None, visible_rect to None, color to ColorInfo::UNSPECIFIED.

dimensions is the coded width/height pair (see Dimensions and Self::dimensions for the visible-vs- coded distinction).

Panics

Panics if plane_count > 4. The fixed-size planes array has four slots; passing a larger plane_count would later trip the slice indexing inside Self::planes far from the construction site. Asserting here fails fast with a clear message instead. Prefer Self::try_new when plane_count can’t be statically proven <= 4.

pub fn try_new( dimensions: Dimensions, pixel_format: P, planes: [Plane<D>; 4], plane_count: u8, extra: E, ) -> Result<Self, FrameError>

Fallible counterpart to Self::new. Returns FrameError::TooManyVideoPlanes when plane_count > 4 (the fixed plane array’s capacity) rather than panicking.

Not const fn — returning Result<Self, _> would require dropping the moved generic-typed planes / pixel_format / extra on the error branch, which the const evaluator can’t prove safe for arbitrary P / E / D.

pub const fn pts(&self) -> Option<Timestamp>

Returns the presentation timestamp.

pub const fn duration(&self) -> Option<Timestamp>

Returns the duration.

pub const fn dimensions(&self) -> Dimensions

Returns the coded dimensions.

pub const fn width(&self) -> u32

Returns the coded width.

pub const fn height(&self) -> u32

Returns the coded height.

pub const fn visible_rect(&self) -> Option<Rect>

Returns the visible / clean-aperture rectangle, if any.

pub const fn pixel_format(&self) -> &P

Returns a reference to the pixel format identifier.

pub const fn plane_count(&self) -> u8

Returns the populated plane count.

pub fn planes(&self) -> &[Plane<D>]

Returns the populated planes as a slice.

pub fn plane(&self, i: usize) -> Option<&Plane<D>>

Returns one plane by index, or None if out of range.

pub const fn color(&self) -> ColorInfo

Returns the color metadata.

pub const fn extra(&self) -> &E

Returns the backend extras.

pub const fn extra_mut(&mut self) -> &mut E

Returns a mutable reference to the backend extras.

pub const fn with_pts(self, v: Option<Timestamp>) -> Self

Sets the PTS (consuming builder).

pub const fn with_duration(self, v: Option<Timestamp>) -> Self

Sets the duration (consuming builder).

pub const fn with_visible_rect(self, v: Option<Rect>) -> Self

Sets the visible rect (consuming builder).

pub const fn with_color(self, v: ColorInfo) -> Self

Sets the color metadata (consuming builder).

pub const fn set_pts(&mut self, v: Option<Timestamp>) -> &mut Self

Sets the PTS in place.

pub const fn set_duration(&mut self, v: Option<Timestamp>) -> &mut Self

Sets the duration in place.

pub const fn set_visible_rect(&mut self, v: Option<Rect>) -> &mut Self

Sets the visible rect in place.

pub const fn set_color(&mut self, v: ColorInfo) -> &mut Self

Sets the color metadata in place.