Skip to main content

FrameExtractor

Struct FrameExtractor 

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

Extracts one frame per time interval from a video file.

§Examples

use ff_decode::FrameExtractor;
use std::time::Duration;

let frames = FrameExtractor::new("video.mp4")
    .interval(Duration::from_secs(5))
    .run()?;
println!("extracted {} frames", frames.len());

Implementations§

Source§

impl FrameExtractor

Source

pub fn new(input: impl AsRef<Path>) -> Self

Creates a new FrameExtractor for the given input file.

The default extraction interval is 1 second.

Source

pub fn interval(self, d: Duration) -> Self

Sets the time interval between extracted frames.

Passing Duration::ZERO causes run to return DecodeError::AnalysisFailed.

Source

pub fn run(self) -> Result<Vec<VideoFrame>, DecodeError>

Runs the extraction and returns one frame per interval.

Timestamps 0, interval, 2×interval, … up to (but not including) the video duration are sampled. DecodeError::NoFrameAtTimestamp for a given timestamp is silently skipped with a warn! log; all other errors are propagated immediately.

§Errors

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