Struct FFMpeg 

pub struct FFMpeg { /* private fields */ }

Main interface into FFMPEG

This struct holds a child ffmpeg process that you can send frames into. Remember to call FFMpeg::finalize when you’re done. Dropping this struct basically calls finalize anyway but it ignores errors, so it’s better to call finalize explicitly

Implementations

impl FFMpeg

pub fn start( out_file: impl AsRef<OsStr>, width: usize, height: usize, fps: u32, ) -> Result<FFMpeg>

Start the FFMPEG rendering

Starts the FFMPEG rendering.

pub fn width(&self) -> usize

Get the render width

pub fn height(&self) -> usize

Get the render height

pub fn fps(&self) -> u32

Get the render FPS

pub fn resolution(&self) -> (usize, usize)

Get the render resolution

pub fn send_frame(&mut self, pixels: &[Color]) -> Result<()>

Send a frame to the FFMPEG process

Send a frame to the FFMPEG process. pixels.len() must be equal to ffmpeg.width() * ffmpeg.height()

Examples found in repository

examples/bouncing-square.rs (line 37)

fn main() -> ffmpeg::Result<()> {
    let mut pixels: [Color; PIXEL_COUNT] = [0; PIXEL_COUNT];

    let mut ffmpeg = ffmpeg::start("out.mp4", WIDTH, HEIGHT, FPS)?;

    let mut x = 0;
    let mut y = 0;
    let mut dx = 1;
    let mut dy = 1;
    let w = 50;
    let h = 50;
    for _ in 0..(60 * FPS) {
        pixels.fill(0);
        draw_rect(&mut pixels, WIDTH, x, y, w, h, 0xFF00FF00);
        ffmpeg.send_frame(&pixels)?;

        let new_x = x + dx;
        if (0..WIDTH as i32 - w).contains(&new_x) {
            x = new_x;
        } else {
            dx *= -1;
        }

        let new_y = y + dy;
        if (0..HEIGHT as i32 - h).contains(&new_y) {
            y = new_y;
        } else {
            dy *= -1;
        }
    }

    ffmpeg.finalize()?;

    Ok(())
}

pub fn finalize(self) -> Result<()>

Finalize the FFMPEG rendering

If this method isn’t called directly or indirectly (such as if std::mem::forget is called on FFMpeg), the final video may not be complete

Examples found in repository

examples/bouncing-square.rs (line 54)

fn main() -> ffmpeg::Result<()> {
    let mut pixels: [Color; PIXEL_COUNT] = [0; PIXEL_COUNT];

    let mut ffmpeg = ffmpeg::start("out.mp4", WIDTH, HEIGHT, FPS)?;

    let mut x = 0;
    let mut y = 0;
    let mut dx = 1;
    let mut dy = 1;
    let w = 50;
    let h = 50;
    for _ in 0..(60 * FPS) {
        pixels.fill(0);
        draw_rect(&mut pixels, WIDTH, x, y, w, h, 0xFF00FF00);
        ffmpeg.send_frame(&pixels)?;

        let new_x = x + dx;
        if (0..WIDTH as i32 - w).contains(&new_x) {
            x = new_x;
        } else {
            dx *= -1;
        }

        let new_y = y + dy;
        if (0..HEIGHT as i32 - h).contains(&new_y) {
            y = new_y;
        } else {
            dy *= -1;
        }
    }

    ffmpeg.finalize()?;

    Ok(())
}

Trait Implementations

impl Drop for FFMpeg

fn drop(&mut self)

Executes the destructor for this type.