Struct Frame 

pub struct Frame { /* private fields */ }

A decoded picture.

The data is behind an Arc so a frame can be handed to a renderer, an encoder, and a callback at once without copying — none of them mutate it.

Implementations

impl Frame

pub fn packed( width: u32, height: u32, format: PixelFormat, color: ColorSpace, pts: Duration, data: Vec<u8>, ) -> Result<Self>

A frame over data, with the planes laid out end to end and no padding.

Errors

Error::BadFrame if data is not the size that layout implies, or either dimension is zero.

pub fn with_planes( width: u32, height: u32, format: PixelFormat, color: ColorSpace, pts: Duration, planes: Vec<Plane>, data: Vec<u8>, ) -> Result<Self>

A frame whose planes are where the decoder put them.

Errors

Error::BadFrame if the plane count is wrong for the format, or any plane’s last row runs past the end of data.

pub fn width(&self) -> u32

Width in pixels.

pub fn height(&self) -> u32

Height in pixels.

pub fn format(&self) -> PixelFormat

The sample layout.

pub fn color(&self) -> ColorSpace

What the samples mean.

pub fn pts(&self) -> Duration

When this picture is due, from the start of the stream.

pub fn with_pts(&self, pts: Duration) -> Self

Retimes the frame, for a player that offsets a stream against a master clock. Cheap: the data is shared, not copied.

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

Where each plane is.

pub fn plane_data(&self, plane: usize) -> Option<&[u8]>

One plane’s bytes, from its offset to the end of its last row.

pub fn row(&self, plane: usize, row: u32) -> Option<&[u8]>

One row of one plane, without the padding a stride may add.

pub fn data(&self) -> &[u8]

The whole buffer, planes and padding alike.

pub fn byte_len(&self) -> usize

How many bytes this frame holds, for accounting against a memory ceiling.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Frame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.