sources ¶

FFmpeg sources.

Functions:

Name	Description
`abuffer`	Buffer audio frames, and make them available to the filter chain.
`acrossfade`	Apply cross fade from one input audio stream to another input audio stream.
`aevalsrc`	Generate an audio signal specified by an expression.
`afdelaysrc`	Generate a fractional delay FIR coefficients.
`afireqsrc`	Generate a FIR equalizer coefficients.
`afirsrc`	Generate a FIR coefficients using frequency sampling method.
`ainterleave`	Temporally interleave frames from several inputs.
`allrgb`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`allyuv`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`amerge`	Merge two or more audio streams into a single multi-channel stream.
`amix`	Mixes multiple audio inputs into a single output.
`amovie`	This is the same as movie source, except it selects an audio
`anoisesrc`	Generate a noise audio signal.
`anullsrc`	The null audio source, return unprocessed audio frames. It is mainly useful
`astreamselect`	Select video or audio streams.
`avsynctest`	Generate an Audio/Video Sync Test.
`bm3d`	Denoise frames using Block-Matching 3D algorithm.
`buffer`	Buffer video frames, and make them available to the filter chain.
`cellauto`	Create a pattern generated by an elementary cellular automaton.
`color`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`color_vulkan`	Video source that creates a Vulkan frame of a solid color.
`colorchart`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`colorspectrum`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`concat`	Concatenate audio and video streams, joining them together one after the
`decimate`	Drop duplicated frames at regular intervals.
`fieldmatch`	Field matching filter for inverse telecine. It is meant to reconstruct the
`flite`	Synthesize a voice utterance using the libflite library.
`frei0r_src`	Provide a frei0r source.
`gradients`	Generate several gradients.
`guided`	Apply guided filter for edge-preserving smoothing, dehazing and so on.
`haldclutsrc`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`headphone`	Apply head-related transfer functions (HRTFs) to create virtual
`hilbert`	Generate odd-tap Hilbert transform FIR coefficients.
`hstack`	Stack input videos horizontally.
`hstack_vaapi`	Stack input videos horizontally.
`interleave`	Temporally interleave frames from several inputs.
`join`	Join multiple input streams into one multi-channel stream.
`ladspa`	Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
`life`	Generate a life pattern.
`limitdiff`	Apply limited difference filter using second and optionally third video stream.
`lv2`	Load a LV2 (LADSPA Version 2) plugin.
`mandelbrot`	Generate a Mandelbrot set fractal, and progressively zoom towards the
`mergeplanes`	Merge color channel components from several video streams.
`mix`	Mix several video input streams into one video stream.
`movie`	Read audio and/or video stream(s) from a movie container.
`mptestsrc`	Generate various test patterns, as generated by the MPlayer test filter.
`nullsrc`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`openclsrc`	Generate video using an OpenCL program.
`pal100bars`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`pal75bars`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`perlin`	Generate Perlin noise.
`premultiply`	Apply alpha premultiply effect to input video stream using first plane
`program_opencl`	Filter video using an OpenCL program.
`rgbtestsrc`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`sierpinski`	Generate a Sierpinski carpet/triangle fractal, and randomly pan around.
`signature`	Calculates the MPEG-7 Video Signature. The filter can handle more than one
`sinc`	Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients.
`sine`	Generate an audio signal made of a sine wave with amplitude 1/8.
`smptebars`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`smptehdbars`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`streamselect`	Select video or audio streams.
`testsrc`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`testsrc2`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`unpremultiply`	Apply alpha unpremultiply effect to input video stream using first plane
`vstack`	Stack input videos vertically.
`vstack_vaapi`	Stack input videos vertically.
`xmedian`	Pick median pixels from several input videos.
`xstack`	Stack video inputs into custom layout.
`xstack_vaapi`	Stack video inputs into custom layout.
`yuvtestsrc`	The allrgb source returns frames of size 4096x4096 of all rgb colors.
`zoneplate`	Generate a zoneplate test video pattern.

abuffer ¶

abuffer(
    *,
    time_base: Rational = Default("0/1"),
    sample_rate: Int = Default("0"),
    sample_fmt: Sample_fmt = Default("none"),
    channel_layout: String = Default(None),
    channels: Int = Default("0"),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Buffer audio frames, and make them available to the filter chain.

This source is mainly intended for a programmatic use, in particular through the interface defined in libavfilter/buffersrc.h.

It accepts the following parameters:

Parameters:

Name	Type	Description	Default
`time_base`	`Rational`	The timebase which will be used for timestamps of submitted frames. It must be either a floating-point number or in numerator/denominator form.	`Default('0/1')`
`sample_rate`	`Int`	The sample rate of the incoming audio buffers.	`Default('0')`
`sample_fmt`	`Sample_fmt`	The sample format of the incoming audio buffers. Either a sample format name or its corresponding integer representation from the enum AVSampleFormat in libavutil/samplefmt.h	`Default('none')`
`channel_layout`	`String`	The channel layout of the incoming audio buffers. Either a channel layout name from channel_layout_map in libavutil/channel_layout.c or its corresponding integer representation from the AV_CH_LAYOUT_* macros in libavutil/channel_layout.h	`Default(None)`
`channels`	`Int`	The number of channels of the incoming audio buffers. If both channels and channel_layout are specified, then they must be consistent.	`Default('0')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

acrossfade ¶

acrossfade(
    *streams: VideoStream,
    inputs: Int = Default("2"),
    nb_samples: Int64 = Default("44100"),
    duration: Duration = Default("0"),
    overlap: Boolean = Default("true"),
    curve1: (
        Int
        | Literal[
            "nofade",
            "tri",
            "qsin",
            "esin",
            "hsin",
            "log",
            "ipar",
            "qua",
            "cub",
            "squ",
            "cbr",
            "par",
            "exp",
            "iqsin",
            "ihsin",
            "dese",
            "desi",
            "losi",
            "sinc",
            "isinc",
            "quat",
            "quatr",
            "qsin2",
            "hsin2",
        ]
        | Default
    ) = Default("tri"),
    curve2: (
        Int
        | Literal[
            "nofade",
            "tri",
            "qsin",
            "esin",
            "hsin",
            "log",
            "ipar",
            "qua",
            "cub",
            "squ",
            "cbr",
            "par",
            "exp",
            "iqsin",
            "ihsin",
            "dese",
            "desi",
            "losi",
            "sinc",
            "isinc",
            "quat",
            "quatr",
            "qsin2",
            "hsin2",
        ]
        | Default
    ) = Default("tri"),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Apply cross fade from one input audio stream to another input audio stream. The cross fade is applied for specified duration near the end of first stream.

The filter accepts the following options:

Parameters:

Name	Type	Description	Default
`inputs`	`Int`	Specify the number of inputs to crossfade. When crossfading multiple inputs, each input will be concatenated and crossfaded in sequence, similar to the concat filter. Default is 2.	`Default('2')`
`nb_samples`	`Int64`	Specify the number of samples for which the cross fade effect has to last. At the end of the cross fade effect the first input audio will be completely silent. Default is 44100.	`Default('44100')`
`duration`	`Duration`	Specify the duration of the cross fade effect. See the Time duration section in the ffmpeg-utils(1) manual for the accepted syntax. By default the duration is determined by nb_samples. If set this option is used instead of nb_samples.	`Default('0')`
`overlap`	`Boolean`	Should first stream end overlap with second stream start. Default is enabled.	`Default('true')`
`curve1`	`Int \| Literal['nofade', 'tri', 'qsin', 'esin', 'hsin', 'log', 'ipar', 'qua', 'cub', 'squ', 'cbr', 'par', 'exp', 'iqsin', 'ihsin', 'dese', 'desi', 'losi', 'sinc', 'isinc', 'quat', 'quatr', 'qsin2', 'hsin2'] \| Default`	Set curve for cross fade transition for first stream.	`Default('tri')`
`curve2`	`Int \| Literal['nofade', 'tri', 'qsin', 'esin', 'hsin', 'log', 'ipar', 'qua', 'cub', 'squ', 'cbr', 'par', 'exp', 'iqsin', 'ihsin', 'dese', 'desi', 'losi', 'sinc', 'isinc', 'quat', 'quatr', 'qsin2', 'hsin2'] \| Default`	Set curve for cross fade transition for second stream. For description of available curve types see afade filter description.	`Default('tri')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

aevalsrc ¶

aevalsrc(
    *,
    exprs: String = Default(None),
    nb_samples: Int = Default("1024"),
    sample_rate: String = Default("44100"),
    duration: Duration = Default("-0.000001"),
    channel_layout: String = Default(None),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Generate an audio signal specified by an expression.

This source accepts in input one or more expressions (one for each channel), which are evaluated and used to generate a corresponding audio signal.

This source accepts the following options:

Parameters:

Name	Type	Description	Default
`exprs`	`String`	Set the '\|'-separated expressions list for each separate channel. In case the channel_layout option is not specified, the selected channel layout depends on the number of provided expressions. Otherwise the last specified expression is applied to the remaining output channels.	`Default(None)`
`nb_samples`	`Int`	Set the number of samples per channel per each output frame, default to 1024.	`Default('1024')`
`sample_rate`	`String`	Specify the sample rate, default to 44100.	`Default('44100')`
`duration`	`Duration`	Set the minimum duration of the sourced audio. See the Time duration section in the ffmpeg-utils(1) manual for the accepted syntax. Note that the resulting duration may be greater than the specified duration, as the generated audio is always cut at the end of a complete frame. If not specified, or the expressed duration is negative, the audio is supposed to be generated forever.	`Default('-0.000001')`
`channel_layout`	`String`	Set the channel layout. The number of channels in the specified layout must be equal to the number of specified expressions.	`Default(None)`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

afdelaysrc ¶

afdelaysrc(
    *,
    delay: Double = Default("0"),
    sample_rate: Int = Default("44100"),
    nb_samples: Int = Default("1024"),
    taps: Int = Default("0"),
    channel_layout: String = Default("stereo"),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Generate a fractional delay FIR coefficients.

The resulting stream can be used with afir filter for filtering the audio signal.

The filter accepts the following options:

Parameters:

Name	Type	Description	Default
`delay`	`Double`	Set the fractional delay. Default is 0.	`Default('0')`
`sample_rate`	`Int`	Set the sample rate, default is 44100.	`Default('44100')`
`nb_samples`	`Int`	Set the number of samples per each frame. Default is 1024.	`Default('1024')`
`taps`	`Int`	Set the number of filter coefficients in output audio stream. Default value is 0.	`Default('0')`
`channel_layout`	`String`	Specifies the channel layout, and can be a string representing a channel layout. The default value of channel_layout is "stereo".	`Default('stereo')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

afireqsrc ¶

afireqsrc(
    *,
    preset: (
        Int
        | Literal[
            "custom",
            "flat",
            "acoustic",
            "bass",
            "beats",
            "classic",
            "clear",
            "deep bass",
            "dubstep",
            "electronic",
            "hardstyle",
            "hip-hop",
            "jazz",
            "metal",
            "movie",
            "pop",
            "r&b",
            "rock",
            "vocal booster",
        ]
        | Default
    ) = Default("flat"),
    gains: String = Default(
        "0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"
    ),
    bands: String = Default(
        "25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000"
    ),
    taps: Int = Default("4096"),
    sample_rate: Int = Default("44100"),
    nb_samples: Int = Default("1024"),
    interp: (
        Int | Literal["linear", "cubic"] | Default
    ) = Default("linear"),
    phase: (
        Int | Literal["linear", "min"] | Default
    ) = Default("min"),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Generate a FIR equalizer coefficients.

The resulting stream can be used with afir filter for filtering the audio signal.

The filter accepts the following options:

Parameters:

Name	Type	Description	Default
`preset`	`Int \| Literal['custom', 'flat', 'acoustic', 'bass', 'beats', 'classic', 'clear', 'deep bass', 'dubstep', 'electronic', 'hardstyle', 'hip-hop', 'jazz', 'metal', 'movie', 'pop', 'r&b', 'rock', 'vocal booster'] \| Default`	Set equalizer preset. Default preset is flat. Available presets are: @end table	`Default('flat')`
`gains`	`String`	Set custom gains for each band. Only used if the preset option is set to custom. Gains are separated by white spaces and each gain is set in dBFS. Default is 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.	`Default('0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0')`
`bands`	`String`	Set the custom bands from where custom equalizer gains are set. This must be in strictly increasing order. Only used if the preset option is set to custom. Bands are separated by white spaces and each band represent frequency in Hz. Default is 25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000.	`Default('25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000')`
`taps`	`Int`	Set number of filter coefficients in output audio stream. Default value is 4096.	`Default('4096')`
`sample_rate`	`Int`	Set sample rate of output audio stream, default is 44100.	`Default('44100')`
`nb_samples`	`Int`	Set number of samples per each frame in output audio stream. Default is 1024.	`Default('1024')`
`interp`	`Int \| Literal['linear', 'cubic'] \| Default`	Set interpolation method for FIR equalizer coefficients. Can be linear or cubic.	`Default('linear')`
`phase`	`Int \| Literal['linear', 'min'] \| Default`	Set phase type of FIR filter. Can be linear or min: minimum-phase. Default is minimum-phase filter.	`Default('min')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

afirsrc ¶

afirsrc(
    *,
    taps: Int = Default("1025"),
    frequency: String = Default("0 1"),
    magnitude: String = Default("1 1"),
    phase: String = Default("0 0"),
    sample_rate: Int = Default("44100"),
    nb_samples: Int = Default("1024"),
    win_func: (
        Int
        | Literal[
            "rect",
            "bartlett",
            "hann",
            "hanning",
            "hamming",
            "blackman",
            "welch",
            "flattop",
            "bharris",
            "bnuttall",
            "bhann",
            "sine",
            "nuttall",
            "lanczos",
            "gauss",
            "tukey",
            "dolph",
            "cauchy",
            "parzen",
            "poisson",
            "bohman",
            "kaiser",
        ]
        | Default
    ) = Default("blackman"),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Generate a FIR coefficients using frequency sampling method.

The resulting stream can be used with afir filter for filtering the audio signal.

The filter accepts the following options:

Parameters:

Name	Type	Description	Default
`taps`	`Int`	Set number of filter coefficients in output audio stream. Default value is 1025.	`Default('1025')`
`frequency`	`String`	Set frequency points from where magnitude and phase are set. This must be in non decreasing order, and first element must be 0, while last element must be 1. Elements are separated by white spaces.	`Default('0 1')`
`magnitude`	`String`	Set magnitude value for every frequency point set by frequency. Number of values must be same as number of frequency points. Values are separated by white spaces.	`Default('1 1')`
`phase`	`String`	Set phase value for every frequency point set by frequency. Number of values must be same as number of frequency points. Values are separated by white spaces.	`Default('0 0')`
`sample_rate`	`Int`	Set sample rate, default is 44100.	`Default('44100')`
`nb_samples`	`Int`	Set number of samples per each frame. Default is 1024.	`Default('1024')`
`win_func`	`Int \| Literal['rect', 'bartlett', 'hann', 'hanning', 'hamming', 'blackman', 'welch', 'flattop', 'bharris', 'bnuttall', 'bhann', 'sine', 'nuttall', 'lanczos', 'gauss', 'tukey', 'dolph', 'cauchy', 'parzen', 'poisson', 'bohman', 'kaiser'] \| Default`	Set window function. Default is blackman.	`Default('blackman')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

ainterleave ¶

ainterleave(
    *streams: AudioStream,
    nb_inputs: Int = Auto("len(streams)"),
    duration: (
        Int
        | Literal["longest", "shortest", "first"]
        | Default
    ) = Default("longest"),
    extra_options: dict[str, Any] | None = None
) -> AudioStream

Temporally interleave frames from several inputs.

interleave works with video inputs, ainterleave with audio.

These filters read frames from several inputs and send the oldest queued frame to the output.

Input streams must have well defined, monotonically increasing frame timestamp values.

In order to submit one frame to output, these filters need to enqueue at least one frame for each input, so they cannot work in case one input is not yet terminated and will not receive incoming frames.

For example consider the case when one input is a select filter which always drops input frames. The interleave filter will keep reading from that input, but it will never be able to send new frames to output until the input sends an end-of-stream signal.

Also, depending on inputs synchronization, the filters will drop frames in case one input receives more frames than the other ones, and the queue is already filled.

These filters accept the following options:

Parameters:

Name	Type	Description	Default
`nb_inputs`	`Int`	Set the number of different inputs, it is 2 by default.	`Auto('len(streams)')`
`duration`	`Int \| Literal['longest', 'shortest', 'first'] \| Default`	How to determine the end-of-stream. @end table	`Default('longest')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`AudioStream`	the audio stream

References

FFmpeg Documentation

allrgb ¶

allrgb(
    *,
    rate: Video_rate = Default("25"),
    duration: Duration = Default("-0.000001"),
    sar: Rational = Default("1/1"),
    extra_options: dict[str, Any] | None = None
) -> VideoStream

The allrgb source returns frames of size 4096x4096 of all rgb colors.

The allyuv source returns frames of size 4096x4096 of all yuv colors.

The color source provides an uniformly colored input.

The colorchart source provides a colors checker chart.

The colorspectrum source provides a color spectrum input.

The haldclutsrc source provides an identity Hald CLUT. See also haldclut filter.

The nullsrc source returns unprocessed video frames. It is mainly useful to be employed in analysis / debugging tools, or as the source for filters which ignore the input data.

The pal75bars source generates a color bars pattern, based on EBU PAL recommendations with 75% color levels.

The pal100bars source generates a color bars pattern, based on EBU PAL recommendations with 100% color levels.

The rgbtestsrc source generates an RGB test pattern useful for detecting RGB vs BGR issues. You should see a red, green and blue stripe from top to bottom.

The smptebars source generates a color bars pattern, based on the SMPTE Engineering Guideline EG 1-1990.

The smptehdbars source generates a color bars pattern, based on the SMPTE RP 219-2002.

The testsrc source generates a test video pattern, showing a color pattern, a scrolling gradient and a timestamp. This is mainly intended for testing purposes.

The testsrc2 source is similar to testsrc, but supports more pixel formats instead of just rgb24. This allows using it as an input for other tests without requiring a format conversion.

The yuvtestsrc source generates an YUV test pattern. You should see a y, cb and cr stripe from top to bottom.

The sources accept the following parameters:

Parameters:

Name	Type	Description	Default
`rate`	`Video_rate`	Specify the frame rate of the sourced video, as the number of frames generated per second. It has to be a string in the format frame_rate_num/frame_rate_den, an integer number, a floating point number or a valid video frame rate abbreviation. The default value is "25".	`Default('25')`
`duration`	`Duration`	Set the duration of the sourced video. See the Time duration section in the ffmpeg-utils(1) manual for the accepted syntax. If not specified, or the expressed duration is negative, the video is supposed to be generated forever. Since the frame rate is used as time base, all frames including the last one will have their full duration. If the specified duration is not a multiple of the frame duration, it will be rounded up.	`Default('-0.000001')`
`sar`	`Rational`	Set the sample aspect ratio of the sourced video.	`Default('1/1')`
`extra_options`	`dict[str, Any] \| None`	Extra options for the filter	`None`

Returns:

Name	Type	Description
`default`	`VideoStream`	the video stream

References

FFmpeg Documentation

allyuv ¶

allyuv(
    *,
    rate: Video_rate = Default("25"),
    duration: Duration = Default("-0.000001"),
    sar: Rational = Default("1/1"),
    extra_options: dict[str, Any] | None = None
) -> VideoStream