Filtergraph description
***********************

A filtergraph is a directed graph of connected filters. It can contain cycles, and there can be multiple links between a pair of filters. Each link has one input pad on one side connecting it to one filter from which it takes its input, and one output pad on the other side connecting it to the one filter accepting its output.

Each filter in a filtergraph is an instance of a filter class registered in the application, which defines the features and the number of input and output pads of the filter.

A filter with no input pads is called a "source", a filter with no output pads is called a "sink".

Filtergraph syntax
==================

A filtergraph can be represented using a textual representation, which is recognized by the -vf option of the ff* tools, and by the avfilter_graph_parse() function defined in libavfilter/avfiltergraph.h.

A filterchain consists of a sequence of connected filters, each one connected to the previous one in the sequence. A filterchain is represented by a list of ","-separated filter descriptions.

A filtergraph consists of a sequence of filterchains. A sequence of filterchains is represented by a list of ";"-separated filterchain descriptions.

A filter is represented by a string of the form: [IN_LINK_1]...[IN_LINK_N]FILTER_NAME=ARGUMENTS[OUT_LINK_1]...[OUT_LINK_M]

FILTER_NAME is the name of the filter class of which the described filter is an instance of, and has to be the name of one of the filter classes registered in the program. The name of the filter class is optionally followed by a string "=ARGUMENTS".

ARGUMENTS is a string which contains the parameters used to initialize the filter instance, and are described in the filter descriptions below.

The list of arguments can be quoted using the character "'" as initial and ending mark, and the character '\' for escaping the characters within the quoted text; otherwise the argument string is considered terminated when the next special character (belonging to the set "[]=;,") is encountered.

The name and arguments of the filter are optionally preceded and followed by a list of link labels. A link label allows to name a link and associate it to a filter output or input pad. The preceding labels IN_LINK_1 ... IN_LINK_N, are associated to the filter input pads, the following labels OUT_LINK_1 ... OUT_LINK_M, are associated to the output pads.

When two link labels with the same name are found in the filtergraph, a link between the corresponding input and output pad is created.

If an output pad is not labelled, it is linked by default to the first unlabelled input pad of the next filter in the filterchain. For example in the filterchain:

     nullsrc, split[L1], [L2]overlay, nullsink

the split filter instance has two output pads, and the overlay filter instance two input pads. The first output pad of split is labelled "L1", the first input pad of overlay is labelled "L2", and the second output pad of split is linked to the second input pad of overlay, which are both unlabelled.

In a complete filterchain all the unlabelled filter input and output pads must be connected. A filtergraph is considered valid if all the filter input and output pads of all the filterchains are connected.

Follows a BNF description for the filtergraph syntax:

     NAME             ::= sequence of alphanumeric characters and '_'
     LINKLABEL        ::= "[" NAME "]"
     LINKLABELS       ::= LINKLABEL [LINKLABELS]
     FILTER_ARGUMENTS ::= sequence of chars (eventually quoted)
     FILTER           ::= [LINKNAMES] NAME ["=" ARGUMENTS] [LINKNAMES]
     FILTERCHAIN      ::= FILTER [,FILTERCHAIN]
     FILTERGRAPH      ::= FILTERCHAIN [;FILTERGRAPH]

Audio Filters
*************

When you configure your FFmpeg build, you can disable any of the existing filters using --disable-filters. The configure output will show the audio filters included in your build.

Below is a description of the currently available audio filters.

aconvert
========

Convert the input audio format to the specified formats.

The filter accepts a string of the form: "SAMPLE_FORMAT:CHANNEL_LAYOUT:PACKING_FORMAT".

SAMPLE_FORMAT specifies the sample format, and can be a string or the corresponding numeric value defined in libavutil/samplefmt.h.

CHANNEL_LAYOUT specifies the channel layout, and can be a string or the corresponding number value defined in libavutil/audioconvert.h.

PACKING_FORMAT specifies the type of packing in output, can be one of "planar" or "packed", or the corresponding numeric values "0" or "1".

The special parameter "auto", signifies that the filter will automatically select the output format depending on the output filter.

Some examples follow.

  * Convert input to unsigned 8-bit, stereo, packed:

          aconvert=u8:stereo:packed

  * Convert input to unsigned 8-bit, automatically select out channel layout and packing format:

          aconvert=u8:auto:auto

aformat
=======

Convert the input audio to one of the specified formats. The framework will negotiate the most appropriate format to minimize conversions.

The filter accepts three lists of formats, separated by ":", in the form: "SAMPLE_FORMATS:CHANNEL_LAYOUTS:PACKING_FORMATS".

Elements in each list are separated by "," which has to be escaped in the filtergraph specification.

The special parameter "all", in place of a list of elements, signifies all supported formats.

Some examples follow:

     aformat=u8\\,s16:mono:packed

     aformat=s16:mono\\,stereo:all

anull
=====

Pass the audio source unchanged to the output.

aresample
=========

Resample the input audio to the specified sample rate.

The filter accepts exactly one parameter, the output sample rate. If not specified then the filter will automatically convert between its input and output sample rates.

For example, to resample the input audio to 44100Hz:

     aresample=44100

ashowinfo
=========

Show a line containing various information for each input audio frame. The input audio is not modified.

The shown line contains a sequence of key/value pairs of the form KEY:VALUE.

A description of each shown parameter follows:

n
     sequential number of the input frame, starting from 0

pts
     presentation TimeStamp of the input frame, expressed as a number of time base units. The time base unit depends on the filter input pad, and is usually 1/SAMPLE_RATE.

pts_time
     presentation TimeStamp of the input frame, expressed as a number of seconds

pos
     position of the frame in the input stream, -1 if this information in unavailable and/or meaningless (for example in case of synthetic audio)

fmt
     sample format name

chlayout
     channel layout description

nb_samples
     number of samples (per each channel) contained in the filtered frame

rate
     sample rate for the audio frame

planar
     if the packing format is planar, 0 if packed

checksum
     Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame

plane_checksum
     Adler-32 checksum (printed in hexadecimal) for each input frame plane, expressed in the form "[C0 C1 C2 C3 C4 C5 C6 C7]"

earwax
======

Make audio easier to listen to on headphones.

This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio so that when listened to on headphones the stereo image is moved from inside your head (standard for headphones) to outside and in front of the listener (standard for speakers).

Ported from SoX.

pan
===

Mix channels with specific gain levels. The filter accepts the output channel layout followed by a set of channels definitions.

The filter accepts parameters of the form: "L:OUTDEF:OUTDEF:..."

l
     output channel layout or number of channels

outdef
     output channel specification, of the form: "OUT_NAME=[GAIN*]IN_NAME[+[GAIN*]IN_NAME...]"

out_name
     output channel to define, either a channel name (FL, FR, etc.) or a channel number (c0, c1, etc.)

gain
     multiplicative coefficient for the channel, 1 leaving the volume unchanged

in_name
     input channel to use, see out_name for details; it is not possible to mix named and numbered input channels

If the `=' in a channel specification is replaced by `<', then the gains for that specification will be renormalized so that the total is 1, thus avoiding clipping noise.

For example, if you want to down-mix from stereo to mono, but with a bigger factor for the left channel:

     pan=1:c0=0.9*c0+0.1*c1

A customized down-mix to stereo that works automatically for 3-, 4-, 5- and 7-channels surround:

     pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR

Note that ffmpeg integrates a default down-mix (and up-mix) system that should be preferred (see "-ac" option) unless you have very specific needs.

volume
======

Adjust the input audio volume.

The filter accepts exactly one parameter VOL, which expresses how the audio volume will be increased or decreased.

Output values are clipped to the maximum value.

If VOL is expressed as a decimal number, and the output audio volume is given by the relation:

     OUTPUT_VOLUME = VOL * INPUT_VOLUME

If VOL is expressed as a decimal number followed by the string "dB", the value represents the requested change in decibels of the input audio power, and the output audio volume is given by the relation:

     OUTPUT_VOLUME = 10^(VOL/20) * INPUT_VOLUME

Otherwise VOL is considered an expression and its evaluated value is used for computing the output audio volume according to the first relation.

Default value for VOL is 1.0.

Examples
--------

  * Half the input audio volume:

          volume=0.5

     The above example is equivalent to:

          volume=1/2

  * Decrease input audio power by 12 decibels:

          volume=-12dB

Audio Sources
*************

Below is a description of the currently available audio sources.

abuffer
=======

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/asrc_abuffer.h.

It accepts the following mandatory parameters: SAMPLE_RATE:SAMPLE_FMT:CHANNEL_LAYOUT:PACKING

sample_rate
     The sample rate of the incoming audio buffers.

sample_fmt
     The sample format of the incoming audio buffers. Either a sample format name or its corresponging integer representation from the enum AVSampleFormat in libavutil/samplefmt.h

channel_layout
     The channel layout of the incoming audio buffers. Either a channel layout name from channel_layout_map in libavutil/audioconvert.c or its corresponding integer representation from the AV_CH_LAYOUT_* macros in libavutil/audioconvert.h

packing
     Either "packed" or "planar", or their integer representation: 0 or 1 respectively.

For example:

     abuffer=44100:s16:stereo:planar

will instruct the source to accept planar 16bit signed stereo at 44100Hz. Since the sample format with name "s16" corresponds to the number 1 and the "stereo" channel layout corresponds to the value 3, this is equivalent to:

     abuffer=44100:1:3:1

aevalsrc
========

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.

It accepts the syntax: EXPRS[::OPTIONS]. EXPRS is a list of expressions separated by ":", one for each separate channel. The output channel layout depends on the number of provided expressions, up to 8 channels are supported.

OPTIONS is an optional sequence of KEY=VALUE pairs, separated by ":".

The description of the accepted options follows.

duration, d
     Set the minimum duration of the sourced audio. See the function av_parse_time() for the accepted format. 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.

nb_samples, n
     Set the number of samples per channel per each output frame, default to 1024.

sample_rate, s
     Specify the sample rate, default to 44100.

Each expression in EXPRS can contain the following constants:

n
     number of the evaluated sample, starting from 0

t
     time of the evaluated sample expressed in seconds, starting from 0

s
     sample rate

Examples
--------

  * Generate silence:

          aevalsrc=0

  * Generate a sin signal with frequency of 440 Hz, set sample rate to 8000 Hz:

          aevalsrc="sin(440*2*PI*t)::s=8000"

  * Generate white noise:

          aevalsrc="-2+random(0)"

  * Generate an amplitude modulated signal:

          aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"

  * Generate 2.5 Hz binaural beats on a 360 Hz carrier:

          aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"

amovie
======

Read an audio stream from a movie container.

It accepts the syntax: MOVIE_NAME[:OPTIONS] where MOVIE_NAME is the name of the resource to read (not necessarily a file but also a device or a stream accessed through some protocol), and OPTIONS is an optional sequence of KEY=VALUE pairs, separated by ":".

The description of the accepted options follows.

format_name, f
     Specify the format assumed for the movie to read, and can be either the name of a container or an input device. If not specified the format is guessed from MOVIE_NAME or by probing.

seek_point, sp
     Specify the seek point in seconds, the frames will be output starting from this seek point, the parameter is evaluated with av_strtod so the numerical value may be suffixed by an IS postfix. Default value is "0".

stream_index, si
     Specify the index of the audio stream to read. If the value is -1, the best suited audio stream will be automatically selected. Default value is "-1".

anullsrc
========

Null audio source, return unprocessed audio frames. It is mainly useful as a template and to be employed in analysis / debugging tools, or as the source for filters which ignore the input data (for example the sox synth filter).

It accepts an optional sequence of KEY=VALUE pairs, separated by ":".

The description of the accepted options follows.

sample_rate, s
     Specify the sample rate, and defaults to 44100.

channel_layout, cl

     Specify the channel layout, and can be either an integer or a string representing a channel layout. The default value of CHANNEL_LAYOUT is "stereo".

     Check the channel_layout_map definition in libavcodec/audioconvert.c for the mapping between strings and channel layout values.

nb_samples, n
     Set the number of samples per requested frames.

Follow some examples:

     #  set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
     anullsrc=r=48000:cl=4

     # same as
     anullsrc=r=48000:cl=mono

Audio Sinks
***********

Below is a description of the currently available audio sinks.

abuffersink
===========

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

This sink is mainly intended for programmatic use, in particular through the interface defined in libavfilter/buffersink.h.

It requires a pointer to an AVABufferSinkContext structure, which defines the incoming buffers' formats, to be passed as the opaque parameter to avfilter_init_filter for initialization.

anullsink
=========

Null audio sink, do absolutely nothing with the input audio. It is mainly useful as a template and to be employed in analysis / debugging tools.

Video Filters
*************

When you configure your FFmpeg build, you can disable any of the existing filters using --disable-filters. The configure output will show the video filters included in your build.

Below is a description of the currently available video filters.

ass
===

Draw ASS (Advanced Substation Alpha) subtitles on top of input video using the libass library.

To enable compilation of this filter you need to configure FFmpeg with --enable-libass.

This filter accepts in input the name of the ass file to render.

For example, to render the file sub.ass on top of the input video, use the command:

     ass=sub.ass

blackframe
==========

Detect frames that are (almost) completely black. Can be useful to detect chapter transitions or commercials. Output lines consist of the frame number of the detected frame, the percentage of blackness, the position in the file if known or -1 and the timestamp in seconds.

In order to display the output lines, you need to set the loglevel at least to the AV_LOG_INFO value.

The filter accepts the syntax:

     blackframe[=AMOUNT:[THRESHOLD]]

AMOUNT is the percentage of the pixels that have to be below the threshold, and defaults to 98.

THRESHOLD is the threshold below which a pixel value is considered black, and defaults to 32.

boxblur
=======

Apply boxblur algorithm to the input video.

This filter accepts the parameters: LUMA_RADIUS:LUMA_POWER:CHROMA_RADIUS:CHROMA_POWER:ALPHA_RADIUS:ALPHA_POWER

Chroma and alpha parameters are optional, if not specified they default to the corresponding values set for LUMA_RADIUS and LUMA_POWER.

LUMA_RADIUS, CHROMA_RADIUS, and ALPHA_RADIUS represent the radius in pixels of the box used for blurring the corresponding input plane. They are expressions, and can contain the following constants:

w, h
     the input width and height in pixels

cw, ch
     the input chroma image width and height in pixels

hsub, vsub
     horizontal and vertical chroma subsample values. For example for the pixel format "yuv422p" HSUB is 2 and VSUB is 1.

The radius must be a non-negative number, and must not be greater than the value of the expression min(w,h)/2 for the luma and alpha planes, and of min(cw,ch)/2 for the chroma planes.

LUMA_POWER, CHROMA_POWER, and ALPHA_POWER represent how many times the boxblur filter is applied to the corresponding plane.

Some examples follow:

  * Apply a boxblur filter with luma, chroma, and alpha radius set to 2:

          boxblur=2:1

  * Set luma radius to 2, alpha and chroma radius to 0

          boxblur=2:1:0:0:0:0

  * Set luma and chroma radius to a fraction of the video dimension

          boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1

copy
====

Copy the input source unchanged to the output. Mainly useful for testing purposes.

crop
====

Crop the input video to OUT_W:OUT_H:X:Y.

The parameters are expressions containing the following constants:

x, y
     the computed values for X and Y. They are evaluated for each new frame.

in_w, in_h
     the input width and height

iw, ih
     same as IN_W and IN_H

out_w, out_h
     the output (cropped) width and height

ow, oh
     same as OUT_W and OUT_H

a
     same as IW / IH

sar
     input sample aspect ratio

dar
     input display aspect ratio, it is the same as (IW / IH) * SAR

hsub, vsub
     horizontal and vertical chroma subsample values. For example for the pixel format "yuv422p" HSUB is 2 and VSUB is 1.

n
     the number of input frame, starting from 0

pos
     the position in the file of the input frame, NAN if unknown

t
     timestamp expressed in seconds, NAN if the input timestamp is unknown

The OUT_W and OUT_H parameters specify the expressions for the width and height of the output (cropped) video. They are evaluated just at the configuration of the filter.

The default value of OUT_W is "in_w", and the default value of OUT_H is "in_h".

The expression for OUT_W may depend on the value of OUT_H, and the expression for OUT_H may depend on OUT_W, but they cannot depend on X and Y, as X and Y are evaluated after OUT_W and OUT_H.

The X and Y parameters specify the expressions for the position of the top-left corner of the output (non-cropped) area. They are evaluated for each frame. If the evaluated value is not valid, it is approximated to the nearest valid value.

The default value of X is "(in_w-out_w)/2", and the default value for Y is "(in_h-out_h)/2", which set the cropped area at the center of the input image.

The expression for X may depend on Y, and the expression for Y may depend on X.

Follow some examples:

     # crop the central input area with size 100x100
     crop=100:100

     # crop the central input area with size 2/3 of the input video
     "crop=2/3*in_w:2/3*in_h"

     # crop the input video central square
     crop=in_h

     # delimit the rectangle with the top-left corner placed at position
     # 100:100 and the right-bottom corner corresponding to the right-bottom
     # corner of the input image.
     crop=in_w-100:in_h-100:100:100

     # crop 10 pixels from the left and right borders, and 20 pixels from
     # the top and bottom borders
     "crop=in_w-2*10:in_h-2*20"

     # keep only the bottom right quarter of the input image
     "crop=in_w/2:in_h/2:in_w/2:in_h/2"

     # crop height for getting Greek harmony
     "crop=in_w:1/PHI*in_w"

     # trembling effect
     "crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)"

     # erratic camera effect depending on timestamp
     "crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"

     # set x depending on the value of y
     "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"

cropdetect
==========

Auto-detect crop size.

Calculate necessary cropping parameters and prints the recommended parameters through the logging system. The detected dimensions correspond to the non-black area of the input video.

It accepts the syntax:

     cropdetect[=LIMIT[:ROUND[:RESET]]]

limit
     Threshold, which can be optionally specified from nothing (0) to everything (255), defaults to 24.

round
     Value which the width/height should be divisible by, defaults to 16. The offset is automatically adjusted to center the video. Use 2 to get only even dimensions (needed for 4:2:2 video). 16 is best when encoding to most video codecs.

reset
     Counter that determines after how many frames cropdetect will reset the previously detected largest video area and start over to detect the current optimal crop area. Defaults to 0.

     This can be useful when channel logos distort the video area. 0 indicates never reset and return the largest area encountered during playback.

delogo
======

Suppress a TV station logo by a simple interpolation of the surrounding pixels. Just set a rectangle covering the logo and watch it disappear (and sometimes something even uglier appear - your mileage may vary).

The filter accepts parameters as a string of the form "X:Y:W:H:BAND", or as a list of KEY=VALUE pairs, separated by ":".

The description of the accepted parameters follows.

x, y
     Specify the top left corner coordinates of the logo. They must be specified.

w, h
     Specify the width and height of the logo to clear. They must be specified.

band, t
     Specify the thickness of the fuzzy edge of the rectangle (added to W and H). The default value is 4.

show
     When set to 1, a green rectangle is drawn on the screen to simplify finding the right X, Y, W, H parameters, and BAND is set to 4. The default value is 0.

Some examples follow.

  * Set a rectangle covering the area with top left corner coordinates 0,0 and size 100x77, setting a band of size 10:

          delogo=0:0:100:77:10

  * As the previous example, but use named options:

          delogo=x=0:y=0:w=100:h=77:band=10

deshake
=======

Attempt to fix small changes in horizontal and/or vertical shift. This filter helps remove camera shake from hand-holding a camera, bumping a tripod, moving on a vehicle, etc.

The filter accepts parameters as a string of the form "X:Y:W:H:RX:RY:EDGE:BLOCKSIZE:CONTRAST:SEARCH:FILENAME"

A description of the accepted parameters follows.

x, y, w, h
     Specify a rectangular area where to limit the search for motion vectors. If desired the search for motion vectors can be limited to a rectangular area of the frame defined by its top left corner, width and height. These parameters have the same meaning as the drawbox filter which can be used to visualise the position of the bounding box.

     This is useful when simultaneous movement of subjects within the frame might be confused for camera motion by the motion vector search.

     If any or all of X, Y, W and H are set to -1 then the full frame is used. This allows later options to be set without specifying the bounding box for the motion vector search.

     Default - search the whole frame.

rx, ry
     Specify the maximum extent of movement in x and y directions in the range 0-64 pixels. Default 16.

edge
     Specify how to generate pixels to fill blanks at the edge of the frame. An integer from 0 to 3 as follows:

     0
          Fill zeroes at blank locations

     1
          Original image at blank locations

     2
          Extruded edge value at blank locations

     3
          Mirrored edge at blank locations

     The default setting is mirror edge at blank locations.

blocksize
     Specify the blocksize to use for motion search. Range 4-128 pixels, default 8.

contrast
     Specify the contrast threshold for blocks. Only blocks with more than the specified contrast (difference between darkest and lightest pixels) will be considered. Range 1-255, default 125.

search
     Specify the search strategy 0 = exhaustive search, 1 = less exhaustive search. Default - exhaustive search.

filename
     If set then a detailed log of the motion search is written to the specified file.

drawbox
=======

Draw a colored box on the input image.

It accepts the syntax:

     drawbox=X:Y:WIDTH:HEIGHT:COLOR

x, y
     Specify the top left corner coordinates of the box. Default to 0.

width, height
     Specify the width and height of the box, if 0 they are interpreted as the input width and height. Default to 0.

color
     Specify the color of the box to write, it can be the name of a color (case insensitive match) or a 0xRRGGBB[AA] sequence.

Follow some examples:

     # draw a black box around the edge of the input image
     drawbox

     # draw a box with color red and an opacity of 50%
     drawbox=10:20:200:60:red@0.5"

drawtext
========

Draw text string or text from specified file on top of video using the libfreetype library.

To enable compilation of this filter you need to configure FFmpeg with --enable-libfreetype.

The filter also recognizes strftime() sequences in the provided text and expands them accordingly. Check the documentation of strftime().

The filter accepts parameters as a list of KEY=VALUE pairs, separated by ":".

The description of the accepted parameters follows.

fontfile
     The font file to be used for drawing text. Path must be included. This parameter is mandatory.

text
     The text string to be drawn. The text must be a sequence of UTF-8 encoded characters. This parameter is mandatory if no file is specified with the parameter TEXTFILE.

textfile
     A text file containing text to be drawn. The text must be a sequence of UTF-8 encoded characters.

     This parameter is mandatory if no text string is specified with the parameter TEXT.

     If both text and textfile are specified, an error is thrown.

x, y
     The expressions which specify the offsets where text will be drawn within the video frame. They are relative to the top/left border of the output image.

     The default value of X and Y is "0".

     See below for the list of accepted constants.

fontsize
     The font size to be used for drawing text. The default value of FONTSIZE is 16.

fontcolor
     The color to be used for drawing fonts. Either a string (e.g. "red") or in 0xRRGGBB[AA] format (e.g. "0xff000033"), possibly followed by an alpha specifier. The default value of FONTCOLOR is "black".

boxcolor
     The color to be used for drawing box around text. Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format (e.g. "0xff00ff"), possibly followed by an alpha specifier. The default value of BOXCOLOR is "white".

box
     Used to draw a box around text using background color. Value should be either 1 (enable) or 0 (disable). The default value of BOX is 0.

shadowx, shadowy
     The x and y offsets for the text shadow position with respect to the position of the text. They can be either positive or negative values. Default value for both is "0".

shadowcolor
     The color to be used for drawing a shadow behind the drawn text.  It can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA] form (e.g. "0xff00ff"), possibly followed by an alpha specifier. The default value of SHADOWCOLOR is "black".

ft_load_flags
     Flags to be used for loading the fonts.

     The flags map the corresponding flags supported by libfreetype, and are a combination of the following values:

     default

     no_scale

     no_hinting

     render

     no_bitmap

     vertical_layout

     force_autohint

     crop_bitmap

     pedantic

     ignore_global_advance_width

     no_recurse

     ignore_transform

     monochrome

     linear_design

     no_autohint

     end table

     Default value is "render".

     For more information consult the documentation for the FT_LOAD_* libfreetype flags.

tabsize
     The size in number of spaces to use for rendering the tab. Default value is 4.

The parameters for X and Y are expressions containing the following constants:

W, H
     the input width and height

tw, text_w
     the width of the rendered text

th, text_h
     the height of the rendered text

lh, line_h
     the height of each text line

sar
     input sample aspect ratio

dar
     input display aspect ratio, it is the same as (W / H) * SAR

hsub, vsub
     horizontal and vertical chroma subsample values. For example for the pixel format "yuv422p" HSUB is 2 and VSUB is 1.

max_glyph_w
     maximum glyph width, that is the maximum width for all the glyphs contained in the rendered text

max_glyph_h
     maximum glyph height, that is the maximum height for all the glyphs contained in the rendered text, it is equivalent to ASCENT - DESCENT.

max_glyph_a, ascent

     the maximum distance from the baseline to the highest/upper grid coordinate used to place a glyph outline point, for all the rendered glyphs. It is a positive value, due to the grid's orientation with the Y axis upwards.

max_glyph_d, descent
     the maximum distance from the baseline to the lowest grid coordinate used to place a glyph outline point, for all the rendered glyphs. This is a negative value, due to the grid's orientation, with the Y axis upwards.

n
     the number of input frame, starting from 0

t
     timestamp expressed in seconds, NAN if the input timestamp is unknown

Some examples follow.

  * Draw "Test Text" with font FreeSerif, using the default values for the optional parameters.

          drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"

  * Draw 'Test Text' with font FreeSerif of size 24 at position x=100 and y=50 (counting from the top-left corner of the screen), text is yellow with a red box around it. Both the text and the box have an opacity of 20%.

          drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
                    x=100: y=50: fontsize=24: fontcolor=yellow@0.2: box=1: boxcolor=red@0.2"

     Note that the double quotes are not necessary if spaces are not used within the parameter list.

  * Show the text at the center of the video frame:

          drawtext=fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"

  * Show a text line sliding from right to left in the last row of the video frame. The file LONG_LINE is assumed to contain a single line with no newlines.

          drawtext=fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t

  * Show the content of file CREDITS off the bottom of the frame and scroll up.

          drawtext=fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"

  * Draw a single green letter "g", at the center of the input video. The glyph baseline is placed at half screen height.

          drawtext=fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent

For more information about libfreetype, check: http://www.freetype.org/.

fade
====

Apply fade-in/out effect to input video.

It accepts the parameters: TYPE:START_FRAME:NB_FRAMES[:OPTIONS]

TYPE specifies if the effect type, can be either "in" for fade-in, or "out" for a fade-out effect.

START_FRAME specifies the number of the start frame for starting to apply the fade effect.

NB_FRAMES specifies the number of frames for which the fade effect has to last. At the end of the fade-in effect the output video will have the same intensity as the input video, at the end of the fade-out transition the output video will be completely black.

OPTIONS is an optional sequence of KEY=VALUE pairs, separated by ":". The description of the accepted options follows.

type, t
     See TYPE.

start_frame, s
     See START_FRAME.

nb_frames, n
     See NB_FRAMES.

alpha
     If set to 1, fade only alpha channel, if one exists on the input. Default value is 0.

A few usage examples follow, usable too as test scenarios.

     # fade in first 30 frames of video
     fade=in:0:30

     # fade out last 45 frames of a 200-frame video
     fade=out:155:45

     # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
     fade=in:0:25, fade=out:975:25

     # make first 5 frames black, then fade in from frame 5-24
     fade=in:5:20

     # fade in alpha over first 25 frames of video
     fade=in:0:25:alpha=1

fieldorder
==========

Transform the field order of the input video.

It accepts one parameter which specifies the required field order that the input interlaced video will be transformed to. The parameter can assume one of the following values:

0 or bff
     output bottom field first

1 or tff
     output top field first

Default value is "tff".

Transformation is achieved by shifting the picture content up or down by one line, and filling the remaining line with appropriate picture content. This method is consistent with most broadcast field order converters.

If the input video is not flagged as being interlaced, or it is already flagged as being of the required output field order then this filter does not alter the incoming video.

This filter is very useful when converting to or from PAL DV material, which is bottom field first.

For example:

     ffmpeg -i in.vob -vf "fieldorder=bff" out.dv

fifo
====

Buffer input images and send them when they are requested.

This filter is mainly useful when auto-inserted by the libavfilter framework.

The filter does not take parameters.

format
======

Convert the input video to one of the specified pixel formats. Libavfilter will try to pick one that is supported for the input to the next filter.

The filter accepts a list of pixel format names, separated by ":", for example "yuv420p:monow:rgb24".

Some examples follow:

     # convert the input video to the format "yuv420p"
     format=yuv420p

     # convert the input video to any of the formats in the list
     format=yuv420p:yuv444p:yuv410p

frei0r
======

Apply a frei0r effect to the input video.

To enable compilation of this filter you need to install the frei0r header and configure FFmpeg with --enable-frei0r.

The filter supports the syntax:

     FILTER_NAME[{:|=}PARAM1:PARAM2:...:PARAMN]

FILTER_NAME is the name to the frei0r effect to load. If the environment variable FREI0R_PATH is defined, the frei0r effect is searched in each one of the directories specified by the colon separated list in FREIOR_PATH, otherwise in the standard frei0r paths, which are in this order: HOME/.frei0r-1/lib/, /usr/local/lib/frei0r-1/, /usr/lib/frei0r-1/.

PARAM1, PARAM2, ... , PARAMN specify the parameters for the frei0r effect.

A frei0r effect parameter can be a boolean (whose values are specified with "y" and "n"), a double, a color (specified by the syntax R/G/B, R, G, and B being float numbers from 0.0 to 1.0) or by an av_parse_color() color description), a position (specified by the syntax X/Y, X and Y being float numbers) and a string.

The number and kind of parameters depend on the loaded effect. If an effect parameter is not specified the default value is set.

Some examples follow:

     # apply the distort0r effect, set the first two double parameters
     frei0r=distort0r:0.5:0.01

     # apply the colordistance effect, takes a color as first parameter
     frei0r=colordistance:0.2/0.3/0.4
     frei0r=colordistance:violet
     frei0r=colordistance:0x112233

     # apply the perspective effect, specify the top left and top right
     # image positions
     frei0r=perspective:0.2/0.2:0.8/0.2

For more information see: http://piksel.org/frei0r

gradfun
=======

Fix the banding artifacts that are sometimes introduced into nearly flat regions by truncation to 8bit color depth. Interpolate the gradients that should go where the bands are, and dither them.

This filter is designed for playback only.  Do not use it prior to lossy compression, because compression tends to lose the dither and bring back the bands.

The filter takes two optional parameters, separated by ':': STRENGTH:RADIUS

STRENGTH is the maximum amount by which the filter will change any one pixel. Also the threshold for detecting nearly flat regions. Acceptable values range from .51 to 255, default value is 1.2, out-of-range values will be clipped to the valid range.

RADIUS is the neighborhood to fit the gradient to. A larger radius makes for smoother gradients, but also prevents the filter from modifying the pixels near detailed regions. Acceptable values are 8-32, default value is 16, out-of-range values will be clipped to the valid range.

     # default parameters
     gradfun=1.2:16

     # omitting radius
     gradfun=1.2

hflip
=====

Flip the input video horizontally.

For example to horizontally flip the input video with ffmpeg:

     ffmpeg -i in.avi -vf "hflip" out.avi

hqdn3d
======

High precision/quality 3d denoise filter. This filter aims to reduce image noise producing smooth images and making still images really still. It should enhance compressibility.

It accepts the following optional parameters: LUMA_SPATIAL:CHROMA_SPATIAL:LUMA_TMP:CHROMA_TMP

luma_spatial
     a non-negative float number which specifies spatial luma strength, defaults to 4.0

chroma_spatial
     a non-negative float number which specifies spatial chroma strength, defaults to 3.0*LUMA_SPATIAL/4.0

luma_tmp
     a float number which specifies luma temporal strength, defaults to 6.0*LUMA_SPATIAL/4.0

chroma_tmp
     a float number which specifies chroma temporal strength, defaults to LUMA_TMP*CHROMA_SPATIAL/LUMA_SPATIAL

lut, lutrgb, lutyuv
===================

Compute a look-up table for binding each pixel component input value to an output value, and apply it to input video.

LUTYUV applies a lookup table to a YUV input video, LUTRGB to an RGB input video.

These filters accept in input a ":"-separated list of options, which specify the expressions used for computing the lookup table for the corresponding pixel component values.

The LUT filter requires either YUV or RGB pixel formats in input, and accepts the options:

c0
     first  pixel component

c1
     second pixel component

c2
     third  pixel component

c3
     fourth pixel component, corresponds to the alpha component

The exact component associated to each option depends on the format in input.

The LUTRGB filter requires RGB pixel formats in input, and accepts the options:

r
     red component

g
     green component

b
     blue component

a
     alpha component

The LUTYUV filter requires YUV pixel formats in input, and accepts the options:

y
     Y/luminance component

u
     U/Cb component

v
     V/Cr component

a
     alpha component

The expressions can contain the following constants and functions:

w, h
     the input width and height

val
     input value for the pixel component

clipval
     the input value clipped in the MINVAL-MAXVAL range

maxval
     maximum value for the pixel component

minval
     minimum value for the pixel component

negval
     the negated value for the pixel component value clipped in the MINVAL-MAXVAL range , it corresponds to the expression "maxval-clipval+minval"

clip(val)
     the computed value in VAL clipped in the MINVAL-MAXVAL range

gammaval(gamma)
     the computed gamma correction value of the pixel component value clipped in the MINVAL-MAXVAL range, corresponds to the expression "pow((clipval-minval)/(maxval-minval)\,GAMMA)*(maxval-minval)+minval"

All expressions default to "val".

Some examples follow:

     # negate input video
     lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
     lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"

     # the above is the same as
     lutrgb="r=negval:g=negval:b=negval"
     lutyuv="y=negval:u=negval:v=negval"

     # negate luminance
     lutyuv=y=negval

     # remove chroma components, turns the video into a graytone image
     lutyuv="u=128:v=128"

     # apply a luma burning effect
     lutyuv="y=2*val"

     # remove green and blue components
     lutrgb="g=0:b=0"

     # set a constant alpha channel value on input
     format=rgba,lutrgb=a="maxval-minval/2"

     # correct luminance gamma by a 0.5 factor
     lutyuv=y=gammaval(0.5)

mp
==

Apply an MPlayer filter to the input video.

This filter provides a wrapper around most of the filters of MPlayer/MEncoder.

This wrapper is considered experimental. Some of the wrapped filters may not work properly and we may drop support for them, as they will be implemented natively into FFmpeg. Thus you should avoid depending on them when writing portable scripts.

The filters accepts the parameters: FILTER_NAME[:=]FILTER_PARAMS

FILTER_NAME is the name of a supported MPlayer filter, FILTER_PARAMS is a string containing the parameters accepted by the named filter.

The list of the currently supported filters follows:

2xsai

decimate

denoise3d

detc

dint

divtc

down3dright

dsize

eq2

eq

field

fil

fixpts

framestep

fspp

geq

harddup

hqdn3d

hue

il

ilpack

ivtc

kerndeint

mcdeint

mirror

noise

ow

palette

perspective

phase

pp7

pullup

qp

rectangle

remove-logo

rotate

sab

screenshot

smartblur

softpulldown

softskip

spp

swapuv

telecine

tile

tinterlace

unsharp

uspp

yuvcsp

yvu9

The parameter syntax and behavior for the listed filters are the same of the corresponding MPlayer filters. For detailed instructions check the "VIDEO FILTERS" section in the MPlayer manual.

Some examples follow:

     # remove a logo by interpolating the surrounding pixels
     mp=delogo=200:200:80:20:1

     # adjust gamma, brightness, contrast
     mp=eq2=1.0:2:0.5

     # tweak hue and saturation
     mp=hue=100:-10

See also mplayer(1), http://www.mplayerhq.hu/.

negate
======

Negate input video.

This filter accepts an integer in input, if non-zero it negates the alpha component (if available). The default value in input is 0.

noformat
========

Force libavfilter not to use any of the specified pixel formats for the input to the next filter.

The filter accepts a list of pixel format names, separated by ":", for example "yuv420p:monow:rgb24".

Some examples follow:

     # force libavfilter to use a format different from "yuv420p" for the
     # input to the vflip filter
     noformat=yuv420p,vflip

     # convert the input video to any of the formats not contained in the list
     noformat=yuv420p:yuv444p:yuv410p

null
====

Pass the video source unchanged to the output.

ocv
===

Apply video transform using libopencv.

To enable this filter install libopencv library and headers and configure FFmpeg with --enable-libopencv.

The filter takes the parameters: FILTER_NAME{:=}FILTER_PARAMS.

FILTER_NAME is the name of the libopencv filter to apply.

FILTER_PARAMS specifies the parameters to pass to the libopencv filter. If not specified the default values are assumed.

Refer to the official libopencv documentation for more precise information: http://opencv.willowgarage.com/documentation/c/image_filtering.html

Follows the list of supported libopencv filters.

dilate
------

Dilate an image by using a specific structuring element. This filter corresponds to the libopencv function cvDilate.

It accepts the parameters: STRUCT_EL:NB_ITERATIONS.

STRUCT_EL represents a structuring element, and has the syntax: COLSxROWS+ANCHOR_XxANCHOR_Y/SHAPE

COLS and ROWS represent the number of columns and rows of the structuring element, ANCHOR_X and ANCHOR_Y the anchor point, and SHAPE the shape for the structuring element, and can be one of the values "rect", "cross", "ellipse", "custom".

If the value for SHAPE is "custom", it must be followed by a string of the form "=FILENAME". The file with name FILENAME is assumed to represent a binary image, with each printable character corresponding to a bright pixel. When a custom SHAPE is used, COLS and ROWS are ignored, the number or columns and rows of the read file are assumed instead.

The default value for STRUCT_EL is "3x3+0x0/rect".

NB_ITERATIONS specifies the number of times the transform is applied to the image, and defaults to 1.

Follow some example:

     # use the default values
     ocv=dilate

     # dilate using a structuring element with a 5x5 cross, iterate two times
     ocv=dilate=5x5+2x2/cross:2

     # read the shape from the file diamond.shape, iterate two times
     # the file diamond.shape may contain a pattern of characters like this:
     #   *
     #  ***
     # *****
     #  ***
     #   *
     # the specified cols and rows are ignored (but not the anchor point coordinates)
     ocv=0x0+2x2/custom=diamond.shape:2

erode
-----

Erode an image by using a specific structuring element. This filter corresponds to the libopencv function cvErode.

The filter accepts the parameters: STRUCT_EL:NB_ITERATIONS, with the same syntax and semantics as the dilate filter.

smooth
------

Smooth the input video.

The filter takes the following parameters: TYPE:PARAM1:PARAM2:PARAM3:PARAM4.

TYPE is the type of smooth filter to apply, and can be one of the following values: "blur", "blur_no_scale", "median", "gaussian", "bilateral". The default value is "gaussian".

PARAM1, PARAM2, PARAM3, and PARAM4 are parameters whose meanings depend on smooth type. PARAM1 and PARAM2 accept integer positive values or 0, PARAM3 and PARAM4 accept float values.

The default value for PARAM1 is 3, the default value for the other parameters is 0.

These parameters correspond to the parameters assigned to the libopencv function cvSmooth.

overlay
=======

Overlay one video on top of another.

It takes two inputs and one output, the first input is the "main" video on which the second input is overlayed.

It accepts the parameters: X:Y[:OPTIONS].

X is the x coordinate of the overlayed video on the main video, Y is the y coordinate. X and Y are expressions containing the following parameters:

main_w, main_h
     main input width and height

W, H
     same as MAIN_W and MAIN_H

overlay_w, overlay_h
     overlay input width and height

w, h
     same as OVERLAY_W and OVERLAY_H

OPTIONS is an optional list of KEY=VALUE pairs, separated by ":".

The description of the accepted options follows.

rgb
     If set to 1, force the filter to accept inputs in the RGB color space. Default value is 0.

Be aware that frames are taken from each input video in timestamp order, hence, if their initial timestamps differ, it is a a good idea to pass the two inputs through a SETPTS=PTS-STARTPTS filter to have them begin in the same zero timestamp, as it does the example for the MOVIE filter.

Follow some examples:

     # draw the overlay at 10 pixels from the bottom right
     # corner of the main video.
     overlay=main_w-overlay_w-10:main_h-overlay_h-10

     # insert a transparent PNG logo in the bottom left corner of the input
     movie=logo.png [logo];
     [in][logo] overlay=10:main_h-overlay_h-10 [out]

     # insert 2 different transparent PNG logos (second logo on bottom
     # right corner):
     movie=logo1.png [logo1];
     movie=logo2.png [logo2];
     [in][logo1]       overlay=10:H-h-10 [in+logo1];
     [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]

     # add a transparent color layer on top of the main video,
     # WxH specifies the size of the main input to the overlay filter
     color=red.3:WxH [over]; [in][over] overlay [out]

You can chain together more overlays but the efficiency of such approach is yet to be tested.

pad
===

Add paddings to the input image, and places the original input at the given coordinates X, Y.

It accepts the following parameters: WIDTH:HEIGHT:X:Y:COLOR.

The parameters WIDTH, HEIGHT, X, and Y are expressions containing the following constants:

in_w, in_h
     the input video width and height

iw, ih
     same as IN_W and IN_H

out_w, out_h
     the output width and height, that is the size of the padded area as specified by the WIDTH and HEIGHT expressions

ow, oh
     same as OUT_W and OUT_H

x, y
     x and y offsets as specified by the X and Y expressions, or NAN if not yet specified

a
     same as IW / IH

sar
     input sample aspect ratio

dar
     input display aspect ratio, it is the same as (IW / IH) * SAR

hsub, vsub
     horizontal and vertical chroma subsample values. For example for the pixel format "yuv422p" HSUB is 2 and VSUB is 1.

Follows the description of the accepted parameters.

width, height

     Specify the size of the output image with the paddings added. If the value for WIDTH or HEIGHT is 0, the corresponding input size is used for the output.

     The WIDTH expression can reference the value set by the HEIGHT expression, and vice versa.

     The default value of WIDTH and HEIGHT is 0.

x, y

     Specify the offsets where to place the input image in the padded area with respect to the top/left border of the output image.

     The X expression can reference the value set by the Y expression, and vice versa.

     The default value of X and Y is 0.

color

     Specify the color of the padded area, it can be the name of a color (case insensitive match) or a 0xRRGGBB[AA] sequence.

     The default value of COLOR is "black".

Some examples follow:

     # Add paddings with color "violet" to the input video. Output video
     # size is 640x480, the top-left corner of the input video is placed at
     # column 0, row 40.
     pad=640:480:0:40:violet

     # pad the input to get an output with dimensions increased bt 3/2,
     # and put the input video at the center of the padded area
     pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"

     # pad the input to get a squared output with size equal to the maximum
     # value between the input width and height, and put the input video at
     # the center of the padded area
     pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"

     # pad the input to get a final w/h ratio of 16:9
     pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"

     # for anamorphic video, in order to set the output display aspect ratio,
     # it is necessary to use sar in the expression, according to the relation:
     # (ih * X / ih) * sar = output_dar
     # X = output_dar / sar
     pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"

     # double output size and put the input video in the bottom-right
     # corner of the output padded area
     pad="2*iw:2*ih:ow-iw:oh-ih"

pixdesctest
===========

Pixel format descriptor test filter, mainly useful for internal testing. The output video should be equal to the input video.

For example:

     format=monow, pixdesctest

can be used to test the monowhite pixel format descriptor definition.

scale
=====

Scale the input video to WIDTH:HEIGHT[:INTERL={1|-1}] and/or convert the image format.

The parameters WIDTH and HEIGHT are expressions containing the following constants:

in_w, in_h
     the input width and height

iw, ih
     same as IN_W and IN_H

out_w, out_h
     the output (cropped) width and height

ow, oh
     same as OUT_W and OUT_H

a
     same as IW / IH

sar
     input sample aspect ratio

dar
     input display aspect ratio, it is the same as (IW / IH) * SAR

sar
     input sample aspect ratio

hsub, vsub
     horizontal and vertical chroma subsample values. For example for the pixel format "yuv422p" HSUB is 2 and VSUB is 1.

If the input image format is different from the format requested by the next filter, the scale filter will convert the input to the requested format.

If the value for WIDTH or HEIGHT is 0, the respective input size is used for the output.

If the value for WIDTH or HEIGHT is -1, the scale filter will use, for the respective output size, a value that maintains the aspect ratio of the input image.

The default value of WIDTH and HEIGHT is 0.

Valid values for the optional parameter INTERL are:

1
     force interlaced aware scaling

-1
     select interlaced aware scaling depending on whether the source frames are flagged as interlaced or not

Some examples follow:

     # scale the input video to a size of 200x100.
     scale=200:100

     # scale the input to 2x
     scale=2*iw:2*ih
     # the above is the same as
     scale=2*in_w:2*in_h

     # scale the input to half size
     scale=iw/2:ih/2

     # increase the width, and set the height to the same size
     scale=3/2*iw:ow

     # seek for Greek harmony
     scale=iw:1/PHI*iw
     scale=ih*PHI:ih

     # increase the height, and set the width to 3/2 of the height
     scale=3/2*oh:3/5*ih

     # increase the size, but make the size a multiple of the chroma
     scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"

     # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
     scale='min(500\, iw*3/2):-1'

select
======

Select frames to pass in output.

It accepts in input an expression, which is evaluated for each input frame. If the expression is evaluated to a non-zero value, the frame is selected and passed to the output, otherwise it is discarded.

The expression can contain the following constants:

n
     the sequential number of the filtered frame, starting from 0

selected_n
     the sequential number of the selected frame, starting from 0

prev_selected_n
     the sequential number of the last selected frame, NAN if undefined

TB
     timebase of the input timestamps

pts
     the PTS (Presentation TimeStamp) of the filtered video frame, expressed in TB units, NAN if undefined

t
     the PTS (Presentation TimeStamp) of the filtered video frame, expressed in seconds, NAN if undefined

prev_pts
     the PTS of the previously filtered video frame, NAN if undefined

prev_selected_pts
     the PTS of the last previously filtered video frame, NAN if undefined

prev_selected_t
     the PTS of the last previously selected video frame, NAN if undefined

start_pts
     the PTS of the first video frame in the video, NAN if undefined

start_t
     the time of the first video frame in the video, NAN if undefined

pict_type
     the type of the filtered frame, can assume one of the following values:

     I

     P

     B

     S

     SI

     SP

     BI

interlace_type
     the frame interlace type, can assume one of the following values:

     PROGRESSIVE
          the frame is progressive (not interlaced)

     TOPFIRST
          the frame is top-field-first

     BOTTOMFIRST
          the frame is bottom-field-first

key
     1 if the filtered frame is a key-frame, 0 otherwise

pos
     the position in the file of the filtered frame, -1 if the information is not available (e.g. for synthetic video)

The default value of the select expression is "1".

Some examples follow:

     # select all frames in input
     select

     # the above is the same as:
     select=1

     # skip all frames:
     select=0

     # select only I-frames
     select='eq(pict_type\,I)'

     # select one frame every 100
     select='not(mod(n\,100))'

     # select only frames contained in the 10-20 time interval
     select='gte(t\,10)*lte(t\,20)'

     # select only I frames contained in the 10-20 time interval
     select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'

     # select frames with a minimum distance of 10 seconds
     select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'

setdar
======

Set the Display Aspect Ratio for the filter output video.

This is done by changing the specified Sample (aka Pixel) Aspect Ratio, according to the following equation: DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR

Keep in mind that this filter does not modify the pixel dimensions of the video frame. Also the display aspect ratio set by this filter may be changed by later filters in the filterchain, e.g. in case of scaling or if another "setdar" or a "setsar" filter is applied.

The filter accepts a parameter string which represents the wanted display aspect ratio. The parameter can be a floating point number string, or an expression of the form NUM:DEN, where NUM and DEN are the numerator and denominator of the aspect ratio. If the parameter is not specified, it is assumed the value "0:1".

For example to change the display aspect ratio to 16:9, specify:

     setdar=16:9
     # the above is equivalent to
     setdar=1.77777

See also the setsar filter documentation.

setpts
======

Change the PTS (presentation timestamp) of the input video frames.

Accept in input an expression evaluated through the eval API, which can contain the following constants:

PTS
     the presentation timestamp in input

N
     the count of the input frame, starting from 0.

STARTPTS
     the PTS of the first video frame

INTERLACED
     tell if the current frame is interlaced

POS
     original position in the file of the frame, or undefined if undefined for the current frame

PREV_INPTS
     previous input PTS

PREV_OUTPTS
     previous output PTS

Some examples follow:

     # start counting PTS from zero
     setpts=PTS-STARTPTS

     # fast motion
     setpts=0.5*PTS

     # slow motion
     setpts=2.0*PTS

     # fixed rate 25 fps
     setpts=N/(25*TB)

     # fixed rate 25 fps with some jitter
     setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'

setsar
======

Set the Sample (aka Pixel) Aspect Ratio for the filter output video.

Note that as a consequence of the application of this filter, the output display aspect ratio will change according to the following equation: DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR

Keep in mind that the sample aspect ratio set by this filter may be changed by later filters in the filterchain, e.g. if another "setsar" or a "setdar" filter is applied.

The filter accepts a parameter string which represents the wanted sample aspect ratio. The parameter can be a floating point number string, or an expression of the form NUM:DEN, where NUM and DEN are the numerator and denominator of the aspect ratio. If the parameter is not specified, it is assumed the value "0:1".

For example to change the sample aspect ratio to 10:11, specify:

     setsar=10:11

settb
=====

Set the timebase to use for the output frames timestamps. It is mainly useful for testing timebase configuration.

It accepts in input an arithmetic expression representing a rational. The expression can contain the constants "AVTB" (the default timebase), and "intb" (the input timebase).

The default value for the input is "intb".

Follow some examples.

     # set the timebase to 1/25
     settb=1/25

     # set the timebase to 1/10
     settb=0.1

     #set the timebase to 1001/1000
     settb=1+0.001

     #set the timebase to 2*intb
     settb=2*intb

     #set the default timebase value
     settb=AVTB

showinfo
========

Show a line containing various information for each input video frame. The input video is not modified.

The shown line contains a sequence of key/value pairs of the form KEY:VALUE.

A description of each shown parameter follows:

n
     sequential number of the input frame, starting from 0

pts
     Presentation TimeStamp of the input frame, expressed as a number of time base units. The time base unit depends on the filter input pad.

pts_time
     Presentation TimeStamp of the input frame, expressed as a number of seconds

pos
     position of the frame in the input stream, -1 if this information in unavailable and/or meaningless (for example in case of synthetic video)

fmt
     pixel format name

sar
     sample aspect ratio of the input frame, expressed in the form NUM/DEN

s
     size of the input frame, expressed in the form WIDTHxHEIGHT

i
     interlaced mode ("P" for "progressive", "T" for top field first, "B" for bottom field first)

iskey
     1 if the frame is a key frame, 0 otherwise

type
     picture type of the input frame ("I" for an I-frame, "P" for a P-frame, "B" for a B-frame, "?" for unknown type). Check also the documentation of the AVPictureType enum and of the av_get_picture_type_char function defined in libavutil/avutil.h.

checksum
     Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame

plane_checksum
     Adler-32 checksum (printed in hexadecimal) of each plane of the input frame, expressed in the form "[C0 C1 C2 C3]"

slicify
=======

Pass the images of input video on to next video filter as multiple slices.

     ffmpeg -i in.avi -vf "slicify=32" out.avi

The filter accepts the slice height as parameter. If the parameter is not specified it will use the default value of 16.

Adding this in the beginning of filter chains should make filtering faster due to better use of the memory cache.

split
=====

Pass on the input video to two outputs. Both outputs are identical to the input video.

For example:

     [in] split [splitout1][splitout2];
     [splitout1] crop=100:100:0:0    [cropout];
     [splitout2] pad=200:200:100:100 [padout];

will create two separate outputs from the same input, one cropped and one padded.

transpose
=========

Transpose rows with columns in the input video and optionally flip it.

It accepts a parameter representing an integer, which can assume the values:

0
     Rotate by 90 degrees counterclockwise and vertically flip (default), that is:

          L.R     L.l
          . . ->  . .
          l.r     R.r

1
     Rotate by 90 degrees clockwise, that is:

          L.R     l.L
          . . ->  . .
          l.r     r.R

2
     Rotate by 90 degrees counterclockwise, that is:

          L.R     R.r
          . . ->  . .
          l.r     L.l

3
     Rotate by 90 degrees clockwise and vertically flip, that is:

          L.R     r.R
          . . ->  . .
          l.r     l.L

unsharp
=======

Sharpen or blur the input video.

It accepts the following parameters: LUMA_MSIZE_X:LUMA_MSIZE_Y:LUMA_AMOUNT:CHROMA_MSIZE_X:CHROMA_MSIZE_Y:CHROMA_AMOUNT

Negative values for the amount will blur the input video, while positive values will sharpen. All parameters are optional and default to the equivalent of the string '5:5:1.0:5:5:0.0'.

luma_msize_x
     Set the luma matrix horizontal size. It can be an integer between 3 and 13, default value is 5.

luma_msize_y
     Set the luma matrix vertical size. It can be an integer between 3 and 13, default value is 5.

luma_amount
     Set the luma effect strength. It can be a float number between -2.0 and 5.0, default value is 1.0.

chroma_msize_x
     Set the chroma matrix horizontal size. It can be an integer between 3 and 13, default value is 5.

chroma_msize_y
     Set the chroma matrix vertical size. It can be an integer between 3 and 13, default value is 5.

chroma_amount
     Set the chroma effect strength. It can be a float number between -2.0 and 5.0, default value is 0.0.

     # Strong luma sharpen effect parameters
     unsharp=7:7:2.5

     # Strong blur of both luma and chroma parameters
     unsharp=7:7:-2:7:7:-2

     # Use the default values with ffmpeg
     ffmpeg -i in.avi -vf "unsharp" out.mp4

vflip
=====

Flip the input video vertically.

     ffmpeg -i in.avi -vf "vflip" out.avi

yadif
=====

Deinterlace the input video ("yadif" means "yet another deinterlacing filter").

It accepts the optional parameters: MODE:PARITY:AUTO.

MODE specifies the interlacing mode to adopt, accepts one of the following values:

0
     output 1 frame for each frame

1
     output 1 frame for each field

2
     like 0 but skips spatial interlacing check

3
     like 1 but skips spatial interlacing check

Default value is 0.

PARITY specifies the picture field parity assumed for the input interlaced video, accepts one of the following values:

0
     assume top field first

1
     assume bottom field first

-1
     enable automatic detection

Default value is -1. If interlacing is unknown or decoder does not export this information, top field first will be assumed.

AUTO specifies if deinterlacer should trust the interlaced flag and only deinterlace frames marked as interlaced

0
     deinterlace all frames

1
     only deinterlace frames marked as interlaced

Default value is 0.

Video Sources
*************

Below is a description of the currently available video sources.

buffer
======

Buffer video 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/vsrc_buffer.h.

It accepts the following parameters: WIDTH:HEIGHT:PIX_FMT_STRING:TIMEBASE_NUM:TIMEBASE_DEN:SAMPLE_ASPECT_RATIO_NUM:SAMPLE_ASPECT_RATIO.DEN:SCALE_PARAMS

All the parameters but SCALE_PARAMS need to be explicitly defined.

Follows the list of the accepted parameters.

width, height
     Specify the width and height of the buffered video frames.

pix_fmt_string
     A string representing the pixel format of the buffered video frames. It may be a number corresponding to a pixel format, or a pixel format name.

timebase_num, timebase_den
     Specify numerator and denomitor of the timebase assumed by the timestamps of the buffered frames.

sample_aspect_ratio.num, sample_aspect_ratio.den
     Specify numerator and denominator of the sample aspect ratio assumed by the video frames.

scale_params
     Specify the optional parameters to be used for the scale filter which is automatically inserted when an input change is detected in the input size or format.

For example:

     buffer=320:240:yuv410p:1:24:1:1

will instruct the source to accept video frames with size 320x240 and with format "yuv410p", assuming 1/24 as the timestamps timebase and square pixels (1:1 sample aspect ratio). Since the pixel format with name "yuv410p" corresponds to the number 6 (check the enum PixelFormat definition in libavutil/pixfmt.h), this example corresponds to:

     buffer=320:240:6:1:24:1:1

color
=====

Provide an uniformly colored input.

It accepts the following parameters: COLOR:FRAME_SIZE:FRAME_RATE

Follows the description of the accepted parameters.

color
     Specify the color of the source. It can be the name of a color (case insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an alpha specifier. The default value is "black".

frame_size
     Specify the size of the sourced video, it may be a string of the form WIDTHxHEIGHT, or the name of a size abbreviation. The default value is "320x240".

frame_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 float number or a valid video frame rate abbreviation. The default value is "25".

For example the following graph description will generate a red source with an opacity of 0.2, with size "qcif" and a frame rate of 10 frames per second, which will be overlayed over the source connected to the pad with identifier "in".

     "color=red@0.2:qcif:10 [color]; [in][color] overlay [out]"

movie
=====

Read a video stream from a movie container.

It accepts the syntax: MOVIE_NAME[:OPTIONS] where MOVIE_NAME is the name of the resource to read (not necessarily a file but also a device or a stream accessed through some protocol), and OPTIONS is an optional sequence of KEY=VALUE pairs, separated by ":".

The description of the accepted options follows.

format_name, f
     Specifies the format assumed for the movie to read, and can be either the name of a container or an input device. If not specified the format is guessed from MOVIE_NAME or by probing.

seek_point, sp
     Specifies the seek point in seconds, the frames will be output starting from this seek point, the parameter is evaluated with av_strtod so the numerical value may be suffixed by an IS postfix. Default value is "0".

stream_index, si
     Specifies the index of the video stream to read. If the value is -1, the best suited video stream will be automatically selected. Default value is "-1".

This filter allows to overlay a second video on top of main input of a filtergraph as shown in this graph:

     input -----------> deltapts0 --> overlay --> output
                                         ^
                                         |
     movie --> scale--> deltapts1 -------+

Some examples follow:

     # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
     # on top of the input labelled as "in".
     movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
     [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]

     # read from a video4linux2 device, and overlay it on top of the input
     # labelled as "in"
     movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
     [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]

mptestsrc
=========

Generate various test patterns, as generated by the MPlayer test filter.

The size of the generated video is fixed, and is 256x256. This source is useful in particular for testing encoding features.

This source accepts an optional sequence of KEY=VALUE pairs, separated by ":". The description of the accepted options follows.

rate, r
     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 float number or a valid video frame rate abbreviation. The default value is "25".

duration, d
     Set the video duration of the sourced video. The accepted syntax is:

          [-]HH[:MM[:SS[.m...]]]
          [-]S+[.m...]

     See also the function av_parse_time().

     If not specified, or the expressed duration is negative, the video is supposed to be generated forever.

test, t

     Set the number or the name of the test to perform. Supported tests are:

     dc_luma

     dc_chroma

     freq_luma

     freq_chroma

     amp_luma

     amp_chroma

     cbp

     mv

     ring1

     ring2

     all

     Default value is "all", which will cycle through the list of all tests.

For example the following:

     testsrc=t=dc_luma

will generate a "dc_luma" test pattern.

frei0r_src
==========

Provide a frei0r source.

To enable compilation of this filter you need to install the frei0r header and configure FFmpeg with --enable-frei0r.

The source supports the syntax:

     SIZE:RATE:SRC_NAME[{=|:}PARAM1:PARAM2:...:PARAMN]

SIZE is the size of the video to generate, may be a string of the form WIDTHxHEIGHT or a frame size abbreviation. RATE is the rate of the video to generate, may be a string of the form NUM/DEN or a frame rate abbreviation. SRC_NAME is the name to the frei0r source to load. For more information regarding frei0r and how to set the parameters read the section frei0r in the description of the video filters.

Some examples follow:

     # generate a frei0r partik0l source with size 200x200 and frame rate 10
     # which is overlayed on the overlay filter main input
     frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay

life
====

Generate a life pattern.

This source is based on a generalization of John Conway's life game.

The sourced input represents a life grid, each pixel represents a cell which can be in one of two possible states, alive or dead. Every cell interacts with its eight neighbours, which are the cells that are horizontally, vertically, or diagonally adjacent.

At each interaction the grid evolves according to the adopted rule, which specifies the number of neighbor alive cells which will make a cell stay alive or born. The rule option allows to specify the rule to adopt.

This source accepts a list of options in the form of KEY=VALUE pairs separated by ":". A description of the accepted options follows.

filename, f
     Set the file from which to read the initial grid state. In the file, each non-whitespace character is considered an alive cell, and newline is used to delimit the end of each row.

     If this option is not specified, the initial grid is generated randomly.

rate, r
     Set the video rate, that is the number of frames generated per second. Default is 25.

random_fill_ratio, ratio
     Set the random fill ratio for the initial random grid. It is a floating point number value ranging from 0 to 1, defaults to 1/PHI. It is ignored when a file is specified.

random_seed, seed
     Set the seed for filling the initial random grid, must be an integer included between 0 and UINT32_MAX. If not specified, or if explicitly set to -1, the filter will try to use a good random seed on a best effort basis.

rule
     Set the life rule.

     A rule can be specified with a code of the kind "SNS/BNB", where NS and NB are sequences of numbers in the range 0-8, NS specifies the number of alive neighbor cells which make a live cell stay alive, and NB the number of alive neighbor cells which make a dead cell to become alive (i.e. to "born"). "s" and "b" can be used in place of "S" and "B", respectively.

     Alternatively a rule can be specified by an 18-bits integer. The 9 high order bits are used to encode the next cell state if it is alive for each number of neighbor alive cells, the low order bits specify the rule for "borning" new cells. Higher order bits encode for an higher number of neighbor cells. For example the number 6153 = (12<<9)+9 specifies a stay alive rule of 12 and a born rule of 9, which corresponds to "S23/B03".

     Default value is "S23/B3", which is the original Conway's game of life rule, and will keep a cell alive if it has 2 or 3 neighbor alive cells, and will born a new cell if there are three alive cells around a dead cell.

size, s
     Set the size of the output video.

     If filename is specified, the size is set by default to the same size of the input file. If size is set, it must contain the size specified in the input file, and the initial grid defined in that file is centered in the larger resulting area.

     If a filename is not specified, the size value defaults to "320x240" (used for a randomly generated initial grid).

stitch
     If set to 1, stitch the left and right grid edges together, and the top and bottom edges also. Defaults to 1.

Examples
--------

  * Read a grid from pattern, and center it on a grid of size 300x300 pixels:

          life=f=pattern:s=300x300

  * Generate a random grid of size 200x200, with a fill ratio of 2/3:

          life=ratio=2/3:s=200x200

  * Specify a custom rule for evolving a randomly generated grid:

          life=rule=S14/B34

nullsrc, rgbtestsrc, testsrc
============================

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 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 testsrc source generates a test video pattern, showing a color pattern, a scrolling gradient and a timestamp. This is mainly intended for testing purposes.

These sources accept an optional sequence of KEY=VALUE pairs, separated by ":". The description of the accepted options follows.

size, s
     Specify the size of the sourced video, it may be a string of the form WIDTHxHEIGHT, or the name of a size abbreviation. The default value is "320x240".

rate, r
     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 float number or a valid video frame rate abbreviation. The default value is "25".

sar
     Set the sample aspect ratio of the sourced video.

duration
     Set the video duration of the sourced video. The accepted syntax is:

          [-]HH[:MM[:SS[.m...]]]
          [-]S+[.m...]

     See also the function av_parse_time().

     If not specified, or the expressed duration is negative, the video is supposed to be generated forever.

For example the following:

     testsrc=duration=5.3:size=qcif:rate=10

will generate a video with a duration of 5.3 seconds, with size 176x144 and a frame rate of 10 frames per second.

If the input content is to be ignored, nullsrc can be used. The following command generates noise in the luminance plane by employing the mp=geq filter:

     nullsrc=s=256x256, mp=geq=random(1)*255:128:128

Video Sinks
***********

Below is a description of the currently available video sinks.

buffersink
==========

Buffer video frames, and make them available to the end of the filter graph.

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

It does not require a string parameter in input, but you need to specify a pointer to a list of supported pixel formats terminated by -1 in the opaque parameter provided to avfilter_init_filter when initializing this sink.

nullsink
========

Null video sink, do absolutely nothing with the input video. It is mainly useful as a template and to be employed in analysis / debugging tools.