Skip to main content

DecodedFrame

Struct DecodedFrame 

Source
pub struct DecodedFrame { /* private fields */ }
Expand description

The validated output of a HwStillDecoder: a decoded 4:2:0 (or monochrome-in-4:2:0) picture in one of the four platform surface layouts.

Construct with DecodedFrame::new, which checks the plane count and every plane’s geometry against format/width/height, and the bit_depth against the format’s sample width — an internally inconsistent frame is unrepresentable, so consumers can trust the plane sizes.

Implementations§

Source§

impl DecodedFrame

Source

pub fn new( format: PixelFormat, width: u32, height: u32, bit_depth: u8, range: ColorRange, planes: Vec<Plane>, ) -> Result<Self, HwDecodeError>

Builds a frame from its planes, validating internal consistency.

width/height are the luma dimensions (post conformance-window crop). Chroma planes use ceiling division on the subsampled axes.

§Errors

Returns HwDecodeError::InvalidFrame if either dimension is zero, bit_depth does not fit format (see PixelFormat::supports_bit_depth), the plane count is wrong, a stride is smaller than the row’s used width, or a plane buffer is too short for its rows.

Source

pub fn format(&self) -> PixelFormat

The pixel layout of the planes.

Source

pub fn width(&self) -> u32

The luma width in pixels (post conformance-window crop).

Source

pub fn height(&self) -> u32

The luma height in pixels (post conformance-window crop).

Source

pub fn bit_depth(&self) -> u8

The per-sample bit depth (8 for NV12/I420, 9..=16 for P010/I010).

Source

pub fn range(&self) -> ColorRange

The signal range of the samples (limited/studio vs full swing).

Source

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

The planes, in format order (Y, then CbCr or Cb/Cr).

Trait Implementations§

Source§

impl Clone for DecodedFrame

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DecodedFrame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DecodedFrame

Source§

impl PartialEq for DecodedFrame

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DecodedFrame

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.