Skip to main content

Encoder

Struct Encoder 

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

Encodes frames into a video stream.

§Example

let encoder = Encoder::new(
    Path::new("video_in.mp4"),
    Settings::for_h264_yuv420p(800, 600, 30.0)
)
.unwrap();

let decoder = Decoder::new(Path::new("video_out.mkv")).unwrap();
decoder
    .decode_iter()
    .take_while(Result::is_ok)
    .map(|frame| encoder
        .encode(frame.unwrap())
        .expect("Failed to encode frame."),
    );

Implementations§

Source§

impl Encoder

Source

pub fn new( destination: impl Into<Location>, settings: Settings, ) -> Result<Self, Error>

Create an encoder with the specified destination and settings.

  • destination - Where to encode to.
  • settings - Encoding settings.
Source

pub fn encode( &mut self, frame: &Frame, source_timestamp: Time, ) -> Result<(), Error>

Encode a single ndarray frame.

§Arguments
  • frame - Frame to encode in HWC format and standard layout.
  • source_timestamp - Frame timestamp of original source. This is necessary to make sure the output will be timed correctly.
Source

pub fn encode_raw(&mut self, frame: RawFrame) -> Result<(), Error>

Encode a single raw frame.

§Arguments
  • frame - Frame to encode.
Source

pub fn finish(&mut self) -> Result<(), Error>

Signal to the encoder that writing has finished. This will cause any packets in the encoder to be flushed and a trailer to be written if the container format has one.

Note: If you don’t call this function before dropping the encoder, it will be called automatically. This will block the caller thread. Any errors cannot be propagated in this case.

Source

pub fn time_base(&self) -> AvRational

Get encoder time base.

Trait Implementations§

Source§

impl Drop for Encoder

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Encoder

Source§

impl Sync for Encoder

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> 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, 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