Skip to main content

Frame

Struct Frame 

Source
pub struct Frame {
    pub timestamp: Timestamp,
    pub size: Size,
    pub surface: Surface,
}
Expand description

A decoded raw video frame: CPU I420, or a GPU frame when a hardware decoder produced one (NVDEC on Linux).

A GPU frame stays on the GPU until something needs bytes: feeding it to encode::Encoder::encode keeps it there (the zero-copy transcode path), while Surface::into_i420 downloads it.

Fields§

§timestamp: Timestamp

Presentation timestamp, carried through from the container. It rides out of the decoder with each picture, so a reordered frame (B-frames) keeps its own time rather than the input access unit’s.

§size: Size

The decoded resolution, which is Config::resize when the backend honored it and the stream’s native size otherwise.

§surface: Surface

Where the pixels live. Match on it for a zero-copy path, or call Surface::into_i420 for the universal one.

Implementations§

Source§

impl Frame

Source

pub fn resize(&self, size: Size) -> Result<Frame, Error>

A copy of this frame scaled to size (both dimensions even and non-zero), preserving the timestamp. A CUDA frame scales on the GPU (a box filter, correct at any downscale factor) and stays there, so resize -> encode never touches the CPU. Every other frame scales on the CPU, which for a CVPixelBuffer means a download first. When one output size is enough, prefer decoding straight to it (Config::resize), which is free on decoders with a hardware scaler; this method is for fanning one decoded stream out to several sizes.

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnsafeUnpin for Frame

§

impl UnwindSafe for Frame

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more