Struct FilterGraphBuilder 

pub struct FilterGraphBuilder { /* private fields */ }

Builder for constructing a FilterGraph.

Create one with FilterGraph::builder(), chain the desired filter methods, then call build to obtain the graph.

Examples

use ff_filter::{FilterGraph, ToneMap};

let graph = FilterGraph::builder()
    .scale(1280, 720)
    .tone_map(ToneMap::Hable)
    .build()?;

Implementations

impl FilterGraphBuilder

pub fn new() -> Self

Creates an empty builder.

pub fn trim(self, start: f64, end: f64) -> Self

Trim the stream to the half-open interval [start, end) in seconds.

pub fn scale(self, width: u32, height: u32) -> Self

Scale the video to width × height pixels.

pub fn crop(self, x: u32, y: u32, width: u32, height: u32) -> Self

Crop a rectangle starting at (x, y) with the given dimensions.

pub fn overlay(self, x: i32, y: i32) -> Self

Overlay a second input stream at position (x, y).

pub fn fade_in(self, duration: Duration) -> Self

Fade in from black over the given duration.

pub fn fade_out(self, duration: Duration) -> Self

Fade out to black over the given duration.

pub fn rotate(self, degrees: f64) -> Self

Rotate the video clockwise by degrees.

pub fn tone_map(self, algorithm: ToneMap) -> Self

Apply HDR-to-SDR tone mapping using the given algorithm.

pub fn volume(self, gain_db: f64) -> Self

Adjust audio volume by gain_db decibels (negative = quieter).

pub fn amix(self, inputs: usize) -> Self

Mix inputs audio streams together.

pub fn equalizer(self, band_hz: f64, gain_db: f64) -> Self

Apply a parametric equalizer band at band_hz Hz with gain_db dB.

pub fn hardware(self, hw: HwAccel) -> Self

Enable hardware-accelerated filtering.

When set, hwupload and hwdownload filters are inserted around the filter chain automatically.

pub fn build(self) -> Result<FilterGraph, FilterError>

Build the FilterGraph.

Errors

Returns FilterError::BuildFailed if steps is empty (there is nothing to filter). The actual FFmpeg graph is constructed lazily on the first push_video or push_audio call.

Trait Implementations

impl Debug for FilterGraphBuilder

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

Formats the value using the given formatter.

impl Default for FilterGraphBuilder

fn default() -> FilterGraphBuilder

Returns the “default value” for a type.