1 @chapter Filtergraph description
2 @c man begin FILTERGRAPH DESCRIPTION
4 A filtergraph is a directed graph of connected filters. It can contain
5 cycles, and there can be multiple links between a pair of
6 filters. Each link has one input pad on one side connecting it to one
7 filter from which it takes its input, and one output pad on the other
8 side connecting it to the one filter accepting its output.
10 Each filter in a filtergraph is an instance of a filter class
11 registered in the application, which defines the features and the
12 number of input and output pads of the filter.
14 A filter with no input pads is called a "source", a filter with no
15 output pads is called a "sink".
17 @section Filtergraph syntax
19 A filtergraph can be represented using a textual representation, which
20 is recognized by the @code{-vf} and @code{-af} options of the ff*
21 tools, and by the @code{avfilter_graph_parse()} function defined in
22 @file{libavfilter/avfiltergraph.h}.
24 A filterchain consists of a sequence of connected filters, each one
25 connected to the previous one in the sequence. A filterchain is
26 represented by a list of ","-separated filter descriptions.
28 A filtergraph consists of a sequence of filterchains. A sequence of
29 filterchains is represented by a list of ";"-separated filterchain
32 A filter is represented by a string of the form:
33 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
35 @var{filter_name} is the name of the filter class of which the
36 described filter is an instance of, and has to be the name of one of
37 the filter classes registered in the program.
38 The name of the filter class is optionally followed by a string
41 @var{arguments} is a string which contains the parameters used to
42 initialize the filter instance, and are described in the filter
45 The list of arguments can be quoted using the character "'" as initial
46 and ending mark, and the character '\' for escaping the characters
47 within the quoted text; otherwise the argument string is considered
48 terminated when the next special character (belonging to the set
49 "[]=;,") is encountered.
51 The name and arguments of the filter are optionally preceded and
52 followed by a list of link labels.
53 A link label allows to name a link and associate it to a filter output
54 or input pad. The preceding labels @var{in_link_1}
55 ... @var{in_link_N}, are associated to the filter input pads,
56 the following labels @var{out_link_1} ... @var{out_link_M}, are
57 associated to the output pads.
59 When two link labels with the same name are found in the
60 filtergraph, a link between the corresponding input and output pad is
63 If an output pad is not labelled, it is linked by default to the first
64 unlabelled input pad of the next filter in the filterchain.
65 For example in the filterchain:
67 nullsrc, split[L1], [L2]overlay, nullsink
69 the split filter instance has two output pads, and the overlay filter
70 instance two input pads. The first output pad of split is labelled
71 "L1", the first input pad of overlay is labelled "L2", and the second
72 output pad of split is linked to the second input pad of overlay,
73 which are both unlabelled.
75 In a complete filterchain all the unlabelled filter input and output
76 pads must be connected. A filtergraph is considered valid if all the
77 filter input and output pads of all the filterchains are connected.
79 Follows a BNF description for the filtergraph syntax:
81 @var{NAME} ::= sequence of alphanumeric characters and '_'
82 @var{LINKLABEL} ::= "[" @var{NAME} "]"
83 @var{LINKLABELS} ::= @var{LINKLABEL} [@var{LINKLABELS}]
84 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
85 @var{FILTER} ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
86 @var{FILTERCHAIN} ::= @var{FILTER} [,@var{FILTERCHAIN}]
87 @var{FILTERGRAPH} ::= @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
90 @c man end FILTERGRAPH DESCRIPTION
92 @chapter Audio Filters
93 @c man begin AUDIO FILTERS
95 When you configure your FFmpeg build, you can disable any of the
96 existing filters using --disable-filters.
97 The configure output will show the audio filters included in your
100 Below is a description of the currently available audio filters.
104 Convert the input audio format to the specified formats.
106 The filter accepts a string of the form:
107 "@var{sample_format}:@var{channel_layout}:@var{packing_format}".
109 @var{sample_format} specifies the sample format, and can be a string or
110 the corresponding numeric value defined in @file{libavutil/samplefmt.h}.
112 @var{channel_layout} specifies the channel layout, and can be a string
113 or the corresponding number value defined in @file{libavutil/audioconvert.h}.
115 @var{packing_format} specifies the type of packing in output, can be one
116 of "planar" or "packed", or the corresponding numeric values "0" or "1".
118 The special parameter "auto", signifies that the filter will
119 automatically select the output format depending on the output filter.
121 Some examples follow.
125 Convert input to unsigned 8-bit, stereo, packed:
127 aconvert=u8:stereo:packed
131 Convert input to unsigned 8-bit, automatically select out channel layout
134 aconvert=u8:auto:auto
140 Convert the input audio to one of the specified formats. The framework will
141 negotiate the most appropriate format to minimize conversions.
143 The filter accepts three lists of formats, separated by ":", in the form:
144 "@var{sample_formats}:@var{channel_layouts}:@var{packing_formats}".
146 Elements in each list are separated by "," which has to be escaped in the
147 filtergraph specification.
149 The special parameter "all", in place of a list of elements, signifies all
152 Some examples follow:
154 aformat=u8\\,s16:mono:packed
156 aformat=s16:mono\\,stereo:all
161 Pass the audio source unchanged to the output.
165 Resample the input audio to the specified sample rate.
167 The filter accepts exactly one parameter, the output sample rate. If not
168 specified then the filter will automatically convert between its input
169 and output sample rates.
171 For example, to resample the input audio to 44100Hz:
178 Show a line containing various information for each input audio frame.
179 The input audio is not modified.
181 The shown line contains a sequence of key/value pairs of the form
182 @var{key}:@var{value}.
184 A description of each shown parameter follows:
188 sequential number of the input frame, starting from 0
191 presentation TimeStamp of the input frame, expressed as a number of
192 time base units. The time base unit depends on the filter input pad, and
193 is usually 1/@var{sample_rate}.
196 presentation TimeStamp of the input frame, expressed as a number of
200 position of the frame in the input stream, -1 if this information in
201 unavailable and/or meaningless (for example in case of synthetic audio)
207 channel layout description
210 number of samples (per each channel) contained in the filtered frame
213 sample rate for the audio frame
216 if the packing format is planar, 0 if packed
219 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
222 Adler-32 checksum (printed in hexadecimal) for each input frame plane,
223 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3} @var{c4} @var{c5}
229 Make audio easier to listen to on headphones.
231 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
232 so that when listened to on headphones the stereo image is moved from
233 inside your head (standard for headphones) to outside and in front of
234 the listener (standard for speakers).
240 Adjust the input audio volume.
242 The filter accepts exactly one parameter @var{vol}, which expresses
243 how the audio volume will be increased or decreased.
245 Output values are clipped to the maximum value.
247 If @var{vol} is expressed as a decimal number, and the output audio
248 volume is given by the relation:
250 @var{output_volume} = @var{vol} * @var{input_volume}
253 If @var{vol} is expressed as a decimal number followed by the string
254 "dB", the value represents the requested change in decibels of the
255 input audio power, and the output audio volume is given by the
258 @var{output_volume} = 10^(@var{vol}/20) * @var{input_volume}
261 Otherwise @var{vol} is considered an expression and its evaluated
262 value is used for computing the output audio volume according to the
265 Default value for @var{vol} is 1.0.
271 Half the input audio volume:
276 The above example is equivalent to:
282 Decrease input audio power by 12 decibels:
288 @c man end AUDIO FILTERS
290 @chapter Audio Sources
291 @c man begin AUDIO SOURCES
293 Below is a description of the currently available audio sources.
297 Buffer audio frames, and make them available to the filter chain.
299 This source is mainly intended for a programmatic use, in particular
300 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
302 It accepts the following mandatory parameters:
303 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}:@var{packing}
308 The sample rate of the incoming audio buffers.
311 The sample format of the incoming audio buffers.
312 Either a sample format name or its corresponging integer representation from
313 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
316 The channel layout of the incoming audio buffers.
317 Either a channel layout name from channel_layout_map in
318 @file{libavutil/audioconvert.c} or its corresponding integer representation
319 from the AV_CH_LAYOUT_* macros in @file{libavutil/audioconvert.h}
322 Either "packed" or "planar", or their integer representation: 0 or 1
329 abuffer=44100:s16:stereo:planar
332 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
333 Since the sample format with name "s16" corresponds to the number
334 1 and the "stereo" channel layout corresponds to the value 3, this is
342 Generate an audio signal specified by an expression.
344 This source accepts in input one or more expressions (one for each
345 channel), which are evaluated and used to generate a corresponding
348 It accepts the syntax: @var{exprs}[::@var{options}].
349 @var{exprs} is a list of expressions separated by ":", one for each
350 separate channel. The output channel layout depends on the number of
351 provided expressions, up to 8 channels are supported.
353 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
356 The description of the accepted options follows.
361 Set the number of samples per channel per each output frame,
365 Specify the sample rate, default to 44100.
368 Each expression in @var{exprs} can contain the following constants:
372 number of the evaluated sample, starting from 0
375 time of the evaluated sample expressed in seconds, starting from 0
394 Generate a sin signal with frequence of 440 Hz, set sample rate to
397 aevalsrc="sin(440*2*PI*t)::s=8000"
401 Generate white noise:
403 aevalsrc="-2+random(0)"
407 Generate an amplitude modulated signal:
409 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
413 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
415 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"
422 Read an audio stream from a movie container.
424 It accepts the syntax: @var{movie_name}[:@var{options}] where
425 @var{movie_name} is the name of the resource to read (not necessarily
426 a file but also a device or a stream accessed through some protocol),
427 and @var{options} is an optional sequence of @var{key}=@var{value}
428 pairs, separated by ":".
430 The description of the accepted options follows.
435 Specify the format assumed for the movie to read, and can be either
436 the name of a container or an input device. If not specified the
437 format is guessed from @var{movie_name} or by probing.
440 Specify the seek point in seconds, the frames will be output
441 starting from this seek point, the parameter is evaluated with
442 @code{av_strtod} so the numerical value may be suffixed by an IS
443 postfix. Default value is "0".
445 @item stream_index, si
446 Specify the index of the audio stream to read. If the value is -1,
447 the best suited audio stream will be automatically selected. Default
454 Null audio source, return unprocessed audio frames. It is mainly useful
455 as a template and to be employed in analysis / debugging tools, or as
456 the source for filters which ignore the input data (for example the sox
459 It accepts an optional sequence of @var{key}=@var{value} pairs,
462 The description of the accepted options follows.
467 Specify the sample rate, and defaults to 44100.
469 @item channel_layout, cl
471 Specify the channel layout, and can be either an integer or a string
472 representing a channel layout. The default value of @var{channel_layout}
475 Check the channel_layout_map definition in
476 @file{libavcodec/audioconvert.c} for the mapping between strings and
477 channel layout values.
480 Set the number of samples per requested frames.
484 Follow some examples:
486 # set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
487 anullsrc=r=48000:cl=4
490 anullsrc=r=48000:cl=mono
493 @c man end AUDIO SOURCES
496 @c man begin AUDIO SINKS
498 Below is a description of the currently available audio sinks.
502 Buffer audio frames, and make them available to the end of filter chain.
504 This sink is mainly intended for programmatic use, in particular
505 through the interface defined in @file{libavfilter/buffersink.h}.
507 It requires a pointer to an AVABufferSinkContext structure, which
508 defines the incoming buffers' formats, to be passed as the opaque
509 parameter to @code{avfilter_init_filter} for initialization.
513 Null audio sink, do absolutely nothing with the input audio. It is
514 mainly useful as a template and to be employed in analysis / debugging
517 @c man end AUDIO SINKS
519 @chapter Video Filters
520 @c man begin VIDEO FILTERS
522 When you configure your FFmpeg build, you can disable any of the
523 existing filters using --disable-filters.
524 The configure output will show the video filters included in your
527 Below is a description of the currently available video filters.
531 Detect frames that are (almost) completely black. Can be useful to
532 detect chapter transitions or commercials. Output lines consist of
533 the frame number of the detected frame, the percentage of blackness,
534 the position in the file if known or -1 and the timestamp in seconds.
536 In order to display the output lines, you need to set the loglevel at
537 least to the AV_LOG_INFO value.
539 The filter accepts the syntax:
541 blackframe[=@var{amount}:[@var{threshold}]]
544 @var{amount} is the percentage of the pixels that have to be below the
545 threshold, and defaults to 98.
547 @var{threshold} is the threshold below which a pixel value is
548 considered black, and defaults to 32.
552 Apply boxblur algorithm to the input video.
554 This filter accepts the parameters:
555 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
557 Chroma and alpha parameters are optional, if not specified they default
558 to the corresponding values set for @var{luma_radius} and
561 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
562 the radius in pixels of the box used for blurring the corresponding
563 input plane. They are expressions, and can contain the following
567 the input width and heigth in pixels
570 the input chroma image width and height in pixels
573 horizontal and vertical chroma subsample values. For example for the
574 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
577 The radius must be a non-negative number, and must not be greater than
578 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
579 and of @code{min(cw,ch)/2} for the chroma planes.
581 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
582 how many times the boxblur filter is applied to the corresponding
585 Some examples follow:
590 Apply a boxblur filter with luma, chroma, and alpha radius
597 Set luma radius to 2, alpha and chroma radius to 0
603 Set luma and chroma radius to a fraction of the video dimension
605 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
612 Copy the input source unchanged to the output. Mainly useful for
617 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
619 The parameters are expressions containing the following constants:
623 the computed values for @var{x} and @var{y}. They are evaluated for
627 the input width and height
630 same as @var{in_w} and @var{in_h}
633 the output (cropped) width and height
636 same as @var{out_w} and @var{out_h}
639 same as @var{iw} / @var{ih}
642 input sample aspect ratio
645 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
648 horizontal and vertical chroma subsample values. For example for the
649 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
652 the number of input frame, starting from 0
655 the position in the file of the input frame, NAN if unknown
658 timestamp expressed in seconds, NAN if the input timestamp is unknown
662 The @var{out_w} and @var{out_h} parameters specify the expressions for
663 the width and height of the output (cropped) video. They are
664 evaluated just at the configuration of the filter.
666 The default value of @var{out_w} is "in_w", and the default value of
667 @var{out_h} is "in_h".
669 The expression for @var{out_w} may depend on the value of @var{out_h},
670 and the expression for @var{out_h} may depend on @var{out_w}, but they
671 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
672 evaluated after @var{out_w} and @var{out_h}.
674 The @var{x} and @var{y} parameters specify the expressions for the
675 position of the top-left corner of the output (non-cropped) area. They
676 are evaluated for each frame. If the evaluated value is not valid, it
677 is approximated to the nearest valid value.
679 The default value of @var{x} is "(in_w-out_w)/2", and the default
680 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
681 the center of the input image.
683 The expression for @var{x} may depend on @var{y}, and the expression
684 for @var{y} may depend on @var{x}.
686 Follow some examples:
688 # crop the central input area with size 100x100
691 # crop the central input area with size 2/3 of the input video
692 "crop=2/3*in_w:2/3*in_h"
694 # crop the input video central square
697 # delimit the rectangle with the top-left corner placed at position
698 # 100:100 and the right-bottom corner corresponding to the right-bottom
699 # corner of the input image.
700 crop=in_w-100:in_h-100:100:100
702 # crop 10 pixels from the left and right borders, and 20 pixels from
703 # the top and bottom borders
704 "crop=in_w-2*10:in_h-2*20"
706 # keep only the bottom right quarter of the input image
707 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
709 # crop height for getting Greek harmony
710 "crop=in_w:1/PHI*in_w"
713 "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)"
715 # erratic camera effect depending on timestamp
716 "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)"
718 # set x depending on the value of y
719 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
724 Auto-detect crop size.
726 Calculate necessary cropping parameters and prints the recommended
727 parameters through the logging system. The detected dimensions
728 correspond to the non-black area of the input video.
730 It accepts the syntax:
732 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
738 Threshold, which can be optionally specified from nothing (0) to
739 everything (255), defaults to 24.
742 Value which the width/height should be divisible by, defaults to
743 16. The offset is automatically adjusted to center the video. Use 2 to
744 get only even dimensions (needed for 4:2:2 video). 16 is best when
745 encoding to most video codecs.
748 Counter that determines after how many frames cropdetect will reset
749 the previously detected largest video area and start over to detect
750 the current optimal crop area. Defaults to 0.
752 This can be useful when channel logos distort the video area. 0
753 indicates never reset and return the largest area encountered during
759 Suppress a TV station logo by a simple interpolation of the surrounding
760 pixels. Just set a rectangle covering the logo and watch it disappear
761 (and sometimes something even uglier appear - your mileage may vary).
763 The filter accepts parameters as a string of the form
764 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
765 @var{key}=@var{value} pairs, separated by ":".
767 The description of the accepted parameters follows.
772 Specify the top left corner coordinates of the logo. They must be
776 Specify the width and height of the logo to clear. They must be
780 Specify the thickness of the fuzzy edge of the rectangle (added to
781 @var{w} and @var{h}). The default value is 4.
784 When set to 1, a green rectangle is drawn on the screen to simplify
785 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
786 @var{band} is set to 4. The default value is 0.
790 Some examples follow.
795 Set a rectangle covering the area with top left corner coordinates 0,0
796 and size 100x77, setting a band of size 10:
802 As the previous example, but use named options:
804 delogo=x=0:y=0:w=100:h=77:band=10
811 Attempt to fix small changes in horizontal and/or vertical shift. This
812 filter helps remove camera shake from hand-holding a camera, bumping a
813 tripod, moving on a vehicle, etc.
815 The filter accepts parameters as a string of the form
816 "@var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}"
818 A description of the accepted parameters follows.
823 Specify a rectangular area where to limit the search for motion
825 If desired the search for motion vectors can be limited to a
826 rectangular area of the frame defined by its top left corner, width
827 and height. These parameters have the same meaning as the drawbox
828 filter which can be used to visualise the position of the bounding
831 This is useful when simultaneous movement of subjects within the frame
832 might be confused for camera motion by the motion vector search.
834 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
835 then the full frame is used. This allows later options to be set
836 without specifying the bounding box for the motion vector search.
838 Default - search the whole frame.
841 Specify the maximum extent of movement in x and y directions in the
842 range 0-64 pixels. Default 16.
845 Specify how to generate pixels to fill blanks at the edge of the
846 frame. An integer from 0 to 3 as follows:
849 Fill zeroes at blank locations
851 Original image at blank locations
853 Extruded edge value at blank locations
855 Mirrored edge at blank locations
858 The default setting is mirror edge at blank locations.
861 Specify the blocksize to use for motion search. Range 4-128 pixels,
865 Specify the contrast threshold for blocks. Only blocks with more than
866 the specified contrast (difference between darkest and lightest
867 pixels) will be considered. Range 1-255, default 125.
870 Specify the search strategy 0 = exhaustive search, 1 = less exhaustive
871 search. Default - exhaustive search.
874 If set then a detailed log of the motion search is written to the
881 Draw a colored box on the input image.
883 It accepts the syntax:
885 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
891 Specify the top left corner coordinates of the box. Default to 0.
894 Specify the width and height of the box, if 0 they are interpreted as
895 the input width and height. Default to 0.
898 Specify the color of the box to write, it can be the name of a color
899 (case insensitive match) or a 0xRRGGBB[AA] sequence.
902 Follow some examples:
904 # draw a black box around the edge of the input image
907 # draw a box with color red and an opacity of 50%
908 drawbox=10:20:200:60:red@@0.5"
913 Draw text string or text from specified file on top of video using the
916 To enable compilation of this filter you need to configure FFmpeg with
917 @code{--enable-libfreetype}.
919 The filter also recognizes strftime() sequences in the provided text
920 and expands them accordingly. Check the documentation of strftime().
922 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
925 The description of the accepted parameters follows.
930 The font file to be used for drawing text. Path must be included.
931 This parameter is mandatory.
934 The text string to be drawn. The text must be a sequence of UTF-8
936 This parameter is mandatory if no file is specified with the parameter
940 A text file containing text to be drawn. The text must be a sequence
941 of UTF-8 encoded characters.
943 This parameter is mandatory if no text string is specified with the
944 parameter @var{text}.
946 If both text and textfile are specified, an error is thrown.
949 The expressions which specify the offsets where text will be drawn
950 within the video frame. They are relative to the top/left border of the
953 The default value of @var{x} and @var{y} is "0".
955 See below for the list of accepted constants.
958 The font size to be used for drawing text.
959 The default value of @var{fontsize} is 16.
962 The color to be used for drawing fonts.
963 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
964 (e.g. "0xff000033"), possibly followed by an alpha specifier.
965 The default value of @var{fontcolor} is "black".
968 The color to be used for drawing box around text.
969 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
970 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
971 The default value of @var{boxcolor} is "white".
974 Used to draw a box around text using background color.
975 Value should be either 1 (enable) or 0 (disable).
976 The default value of @var{box} is 0.
978 @item shadowx, shadowy
979 The x and y offsets for the text shadow position with respect to the
980 position of the text. They can be either positive or negative
981 values. Default value for both is "0".
984 The color to be used for drawing a shadow behind the drawn text. It
985 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
986 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
987 The default value of @var{shadowcolor} is "black".
990 Flags to be used for loading the fonts.
992 The flags map the corresponding flags supported by libfreetype, and are
993 a combination of the following values:
1000 @item vertical_layout
1001 @item force_autohint
1004 @item ignore_global_advance_width
1006 @item ignore_transform
1013 Default value is "render".
1015 For more information consult the documentation for the FT_LOAD_*
1019 The size in number of spaces to use for rendering the tab.
1023 The parameters for @var{x} and @var{y} are expressions containing the
1024 following constants:
1028 the input width and heigth
1031 the width of the rendered text
1034 the height of the rendered text
1037 the height of each text line
1040 input sample aspect ratio
1043 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
1046 horizontal and vertical chroma subsample values. For example for the
1047 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1050 maximum glyph width, that is the maximum width for all the glyphs
1051 contained in the rendered text
1054 maximum glyph height, that is the maximum height for all the glyphs
1055 contained in the rendered text, it is equivalent to @var{ascent} -
1058 @item max_glyph_a, ascent
1060 the maximum distance from the baseline to the highest/upper grid
1061 coordinate used to place a glyph outline point, for all the rendered
1063 It is a positive value, due to the grid's orientation with the Y axis
1066 @item max_glyph_d, descent
1067 the maximum distance from the baseline to the lowest grid coordinate
1068 used to place a glyph outline point, for all the rendered glyphs.
1069 This is a negative value, due to the grid's orientation, with the Y axis
1073 the number of input frame, starting from 0
1076 timestamp expressed in seconds, NAN if the input timestamp is unknown
1079 Some examples follow.
1084 Draw "Test Text" with font FreeSerif, using the default values for the
1085 optional parameters.
1088 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1092 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
1093 and y=50 (counting from the top-left corner of the screen), text is
1094 yellow with a red box around it. Both the text and the box have an
1098 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1099 x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
1102 Note that the double quotes are not necessary if spaces are not used
1103 within the parameter list.
1106 Show the text at the center of the video frame:
1108 drawtext=fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
1112 Show a text line sliding from right to left in the last row of the video
1113 frame. The file @file{LONG_LINE} is assumed to contain a single line
1116 drawtext=fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t
1120 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
1122 drawtext=fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
1126 Draw a single green letter "g", at the center of the input video.
1127 The glyph baseline is placed at half screen height.
1129 drawtext=fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent
1134 For more information about libfreetype, check:
1135 @url{http://www.freetype.org/}.
1139 Apply fade-in/out effect to input video.
1141 It accepts the parameters:
1142 @var{type}:@var{start_frame}:@var{nb_frames}
1144 @var{type} specifies if the effect type, can be either "in" for
1145 fade-in, or "out" for a fade-out effect.
1147 @var{start_frame} specifies the number of the start frame for starting
1148 to apply the fade effect.
1150 @var{nb_frames} specifies the number of frames for which the fade
1151 effect has to last. At the end of the fade-in effect the output video
1152 will have the same intensity as the input video, at the end of the
1153 fade-out transition the output video will be completely black.
1155 A few usage examples follow, usable too as test scenarios.
1157 # fade in first 30 frames of video
1160 # fade out last 45 frames of a 200-frame video
1163 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
1164 fade=in:0:25, fade=out:975:25
1166 # make first 5 frames black, then fade in from frame 5-24
1172 Transform the field order of the input video.
1174 It accepts one parameter which specifies the required field order that
1175 the input interlaced video will be transformed to. The parameter can
1176 assume one of the following values:
1180 output bottom field first
1182 output top field first
1185 Default value is "tff".
1187 Transformation is achieved by shifting the picture content up or down
1188 by one line, and filling the remaining line with appropriate picture content.
1189 This method is consistent with most broadcast field order converters.
1191 If the input video is not flagged as being interlaced, or it is already
1192 flagged as being of the required output field order then this filter does
1193 not alter the incoming video.
1195 This filter is very useful when converting to or from PAL DV material,
1196 which is bottom field first.
1200 ./ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
1205 Buffer input images and send them when they are requested.
1207 This filter is mainly useful when auto-inserted by the libavfilter
1210 The filter does not take parameters.
1214 Convert the input video to one of the specified pixel formats.
1215 Libavfilter will try to pick one that is supported for the input to
1218 The filter accepts a list of pixel format names, separated by ":",
1219 for example "yuv420p:monow:rgb24".
1221 Some examples follow:
1223 # convert the input video to the format "yuv420p"
1226 # convert the input video to any of the formats in the list
1227 format=yuv420p:yuv444p:yuv410p
1233 Apply a frei0r effect to the input video.
1235 To enable compilation of this filter you need to install the frei0r
1236 header and configure FFmpeg with --enable-frei0r.
1238 The filter supports the syntax:
1240 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
1243 @var{filter_name} is the name to the frei0r effect to load. If the
1244 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
1245 is searched in each one of the directories specified by the colon
1246 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
1247 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
1248 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
1250 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
1251 for the frei0r effect.
1253 A frei0r effect parameter can be a boolean (whose values are specified
1254 with "y" and "n"), a double, a color (specified by the syntax
1255 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1256 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1257 description), a position (specified by the syntax @var{X}/@var{Y},
1258 @var{X} and @var{Y} being float numbers) and a string.
1260 The number and kind of parameters depend on the loaded effect. If an
1261 effect parameter is not specified the default value is set.
1263 Some examples follow:
1265 # apply the distort0r effect, set the first two double parameters
1266 frei0r=distort0r:0.5:0.01
1268 # apply the colordistance effect, takes a color as first parameter
1269 frei0r=colordistance:0.2/0.3/0.4
1270 frei0r=colordistance:violet
1271 frei0r=colordistance:0x112233
1273 # apply the perspective effect, specify the top left and top right
1275 frei0r=perspective:0.2/0.2:0.8/0.2
1278 For more information see:
1279 @url{http://piksel.org/frei0r}
1283 Fix the banding artifacts that are sometimes introduced into nearly flat
1284 regions by truncation to 8bit colordepth.
1285 Interpolate the gradients that should go where the bands are, and
1288 This filter is designed for playback only. Do not use it prior to
1289 lossy compression, because compression tends to lose the dither and
1290 bring back the bands.
1292 The filter takes two optional parameters, separated by ':':
1293 @var{strength}:@var{radius}
1295 @var{strength} is the maximum amount by which the filter will change
1296 any one pixel. Also the threshold for detecting nearly flat
1297 regions. Acceptable values range from .51 to 255, default value is
1298 1.2, out-of-range values will be clipped to the valid range.
1300 @var{radius} is the neighborhood to fit the gradient to. A larger
1301 radius makes for smoother gradients, but also prevents the filter from
1302 modifying the pixels near detailed regions. Acceptable values are
1303 8-32, default value is 16, out-of-range values will be clipped to the
1307 # default parameters
1316 Flip the input video horizontally.
1318 For example to horizontally flip the video in input with
1321 ffmpeg -i in.avi -vf "hflip" out.avi
1326 High precision/quality 3d denoise filter. This filter aims to reduce
1327 image noise producing smooth images and making still images really
1328 still. It should enhance compressibility.
1330 It accepts the following optional parameters:
1331 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
1335 a non-negative float number which specifies spatial luma strength,
1338 @item chroma_spatial
1339 a non-negative float number which specifies spatial chroma strength,
1340 defaults to 3.0*@var{luma_spatial}/4.0
1343 a float number which specifies luma temporal strength, defaults to
1344 6.0*@var{luma_spatial}/4.0
1347 a float number which specifies chroma temporal strength, defaults to
1348 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1351 @section lut, lutrgb, lutyuv
1353 Compute a look-up table for binding each pixel component input value
1354 to an output value, and apply it to input video.
1356 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1357 to an RGB input video.
1359 These filters accept in input a ":"-separated list of options, which
1360 specify the expressions used for computing the lookup table for the
1361 corresponding pixel component values.
1363 The @var{lut} filter requires either YUV or RGB pixel formats in
1364 input, and accepts the options:
1367 first pixel component
1369 second pixel component
1371 third pixel component
1373 fourth pixel component, corresponds to the alpha component
1376 The exact component associated to each option depends on the format in
1379 The @var{lutrgb} filter requires RGB pixel formats in input, and
1380 accepts the options:
1392 The @var{lutyuv} filter requires YUV pixel formats in input, and
1393 accepts the options:
1396 Y/luminance component
1405 The expressions can contain the following constants and functions:
1409 the input width and heigth
1412 input value for the pixel component
1415 the input value clipped in the @var{minval}-@var{maxval} range
1418 maximum value for the pixel component
1421 minimum value for the pixel component
1424 the negated value for the pixel component value clipped in the
1425 @var{minval}-@var{maxval} range , it corresponds to the expression
1426 "maxval-clipval+minval"
1429 the computed value in @var{val} clipped in the
1430 @var{minval}-@var{maxval} range
1432 @item gammaval(gamma)
1433 the computed gamma correction value of the pixel component value
1434 clipped in the @var{minval}-@var{maxval} range, corresponds to the
1436 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1440 All expressions default to "val".
1442 Some examples follow:
1444 # negate input video
1445 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1446 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1448 # the above is the same as
1449 lutrgb="r=negval:g=negval:b=negval"
1450 lutyuv="y=negval:u=negval:v=negval"
1455 # remove chroma components, turns the video into a graytone image
1456 lutyuv="u=128:v=128"
1458 # apply a luma burning effect
1461 # remove green and blue components
1464 # set a constant alpha channel value on input
1465 format=rgba,lutrgb=a="maxval-minval/2"
1467 # correct luminance gamma by a 0.5 factor
1468 lutyuv=y=gammaval(0.5)
1473 Apply an MPlayer filter to the input video.
1475 This filter provides a wrapper around most of the filters of
1478 This wrapper is considered experimental. Some of the wrapped filters
1479 may not work properly and we may drop support for them, as they will
1480 be implemented natively into FFmpeg. Thus you should avoid
1481 depending on them when writing portable scripts.
1483 The filters accepts the parameters:
1484 @var{filter_name}[:=]@var{filter_params}
1486 @var{filter_name} is the name of a supported MPlayer filter,
1487 @var{filter_params} is a string containing the parameters accepted by
1490 The list of the currently supported filters follows:
1544 The parameter syntax and behavior for the listed filters are the same
1545 of the corresponding MPlayer filters. For detailed instructions check
1546 the "VIDEO FILTERS" section in the MPlayer manual.
1548 Some examples follow:
1550 # remove a logo by interpolating the surrounding pixels
1551 mp=delogo=200:200:80:20:1
1553 # adjust gamma, brightness, contrast
1556 # tweak hue and saturation
1560 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
1566 This filter accepts an integer in input, if non-zero it negates the
1567 alpha component (if available). The default value in input is 0.
1571 Force libavfilter not to use any of the specified pixel formats for the
1572 input to the next filter.
1574 The filter accepts a list of pixel format names, separated by ":",
1575 for example "yuv420p:monow:rgb24".
1577 Some examples follow:
1579 # force libavfilter to use a format different from "yuv420p" for the
1580 # input to the vflip filter
1581 noformat=yuv420p,vflip
1583 # convert the input video to any of the formats not contained in the list
1584 noformat=yuv420p:yuv444p:yuv410p
1589 Pass the video source unchanged to the output.
1593 Apply video transform using libopencv.
1595 To enable this filter install libopencv library and headers and
1596 configure FFmpeg with --enable-libopencv.
1598 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
1600 @var{filter_name} is the name of the libopencv filter to apply.
1602 @var{filter_params} specifies the parameters to pass to the libopencv
1603 filter. If not specified the default values are assumed.
1605 Refer to the official libopencv documentation for more precise
1607 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1609 Follows the list of supported libopencv filters.
1614 Dilate an image by using a specific structuring element.
1615 This filter corresponds to the libopencv function @code{cvDilate}.
1617 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
1619 @var{struct_el} represents a structuring element, and has the syntax:
1620 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1622 @var{cols} and @var{rows} represent the number of colums and rows of
1623 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1624 point, and @var{shape} the shape for the structuring element, and
1625 can be one of the values "rect", "cross", "ellipse", "custom".
1627 If the value for @var{shape} is "custom", it must be followed by a
1628 string of the form "=@var{filename}". The file with name
1629 @var{filename} is assumed to represent a binary image, with each
1630 printable character corresponding to a bright pixel. When a custom
1631 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1632 or columns and rows of the read file are assumed instead.
1634 The default value for @var{struct_el} is "3x3+0x0/rect".
1636 @var{nb_iterations} specifies the number of times the transform is
1637 applied to the image, and defaults to 1.
1639 Follow some example:
1641 # use the default values
1644 # dilate using a structuring element with a 5x5 cross, iterate two times
1645 ocv=dilate=5x5+2x2/cross:2
1647 # read the shape from the file diamond.shape, iterate two times
1648 # the file diamond.shape may contain a pattern of characters like this:
1654 # the specified cols and rows are ignored (but not the anchor point coordinates)
1655 ocv=0x0+2x2/custom=diamond.shape:2
1660 Erode an image by using a specific structuring element.
1661 This filter corresponds to the libopencv function @code{cvErode}.
1663 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1664 with the same syntax and semantics as the @ref{dilate} filter.
1668 Smooth the input video.
1670 The filter takes the following parameters:
1671 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
1673 @var{type} is the type of smooth filter to apply, and can be one of
1674 the following values: "blur", "blur_no_scale", "median", "gaussian",
1675 "bilateral". The default value is "gaussian".
1677 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1678 parameters whose meanings depend on smooth type. @var{param1} and
1679 @var{param2} accept integer positive values or 0, @var{param3} and
1680 @var{param4} accept float values.
1682 The default value for @var{param1} is 3, the default value for the
1683 other parameters is 0.
1685 These parameters correspond to the parameters assigned to the
1686 libopencv function @code{cvSmooth}.
1690 Overlay one video on top of another.
1692 It takes two inputs and one output, the first input is the "main"
1693 video on which the second input is overlayed.
1695 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
1697 @var{x} is the x coordinate of the overlayed video on the main video,
1698 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
1699 the following parameters:
1702 @item main_w, main_h
1703 main input width and height
1706 same as @var{main_w} and @var{main_h}
1708 @item overlay_w, overlay_h
1709 overlay input width and height
1712 same as @var{overlay_w} and @var{overlay_h}
1715 @var{options} is an optional list of @var{key}=@var{value} pairs,
1718 The description of the accepted options follows.
1722 If set to 1, force the filter to accept inputs in the RGB
1723 colorspace. Default value is 0.
1726 Be aware that frames are taken from each input video in timestamp
1727 order, hence, if their initial timestamps differ, it is a a good idea
1728 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1729 have them begin in the same zero timestamp, as it does the example for
1730 the @var{movie} filter.
1732 Follow some examples:
1734 # draw the overlay at 10 pixels from the bottom right
1735 # corner of the main video.
1736 overlay=main_w-overlay_w-10:main_h-overlay_h-10
1738 # insert a transparent PNG logo in the bottom left corner of the input
1739 movie=logo.png [logo];
1740 [in][logo] overlay=10:main_h-overlay_h-10 [out]
1742 # insert 2 different transparent PNG logos (second logo on bottom
1744 movie=logo1.png [logo1];
1745 movie=logo2.png [logo2];
1746 [in][logo1] overlay=10:H-h-10 [in+logo1];
1747 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
1749 # add a transparent color layer on top of the main video,
1750 # WxH specifies the size of the main input to the overlay filter
1751 color=red@.3:WxH [over]; [in][over] overlay [out]
1754 You can chain together more overlays but the efficiency of such
1755 approach is yet to be tested.
1759 Add paddings to the input image, and places the original input at the
1760 given coordinates @var{x}, @var{y}.
1762 It accepts the following parameters:
1763 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
1765 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1766 expressions containing the following constants:
1770 the input video width and height
1773 same as @var{in_w} and @var{in_h}
1776 the output width and height, that is the size of the padded area as
1777 specified by the @var{width} and @var{height} expressions
1780 same as @var{out_w} and @var{out_h}
1783 x and y offsets as specified by the @var{x} and @var{y}
1784 expressions, or NAN if not yet specified
1787 same as @var{iw} / @var{ih}
1790 input sample aspect ratio
1793 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1796 horizontal and vertical chroma subsample values. For example for the
1797 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1800 Follows the description of the accepted parameters.
1805 Specify the size of the output image with the paddings added. If the
1806 value for @var{width} or @var{height} is 0, the corresponding input size
1807 is used for the output.
1809 The @var{width} expression can reference the value set by the
1810 @var{height} expression, and viceversa.
1812 The default value of @var{width} and @var{height} is 0.
1816 Specify the offsets where to place the input image in the padded area
1817 with respect to the top/left border of the output image.
1819 The @var{x} expression can reference the value set by the @var{y}
1820 expression, and viceversa.
1822 The default value of @var{x} and @var{y} is 0.
1826 Specify the color of the padded area, it can be the name of a color
1827 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1829 The default value of @var{color} is "black".
1833 Some examples follow:
1836 # Add paddings with color "violet" to the input video. Output video
1837 # size is 640x480, the top-left corner of the input video is placed at
1839 pad=640:480:0:40:violet
1841 # pad the input to get an output with dimensions increased bt 3/2,
1842 # and put the input video at the center of the padded area
1843 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1845 # pad the input to get a squared output with size equal to the maximum
1846 # value between the input width and height, and put the input video at
1847 # the center of the padded area
1848 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1850 # pad the input to get a final w/h ratio of 16:9
1851 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1853 # for anamorphic video, in order to set the output display aspect ratio,
1854 # it is necessary to use sar in the expression, according to the relation:
1855 # (ih * X / ih) * sar = output_dar
1856 # X = output_dar / sar
1857 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
1859 # double output size and put the input video in the bottom-right
1860 # corner of the output padded area
1861 pad="2*iw:2*ih:ow-iw:oh-ih"
1864 @section pixdesctest
1866 Pixel format descriptor test filter, mainly useful for internal
1867 testing. The output video should be equal to the input video.
1871 format=monow, pixdesctest
1874 can be used to test the monowhite pixel format descriptor definition.
1878 Scale the input video to @var{width}:@var{height}[:@var{interl}=@{1|-1@}] and/or convert the image format.
1880 The parameters @var{width} and @var{height} are expressions containing
1881 the following constants:
1885 the input width and height
1888 same as @var{in_w} and @var{in_h}
1891 the output (cropped) width and height
1894 same as @var{out_w} and @var{out_h}
1897 same as @var{iw} / @var{ih}
1900 input sample aspect ratio
1903 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1906 input sample aspect ratio
1909 horizontal and vertical chroma subsample values. For example for the
1910 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1913 If the input image format is different from the format requested by
1914 the next filter, the scale filter will convert the input to the
1917 If the value for @var{width} or @var{height} is 0, the respective input
1918 size is used for the output.
1920 If the value for @var{width} or @var{height} is -1, the scale filter will
1921 use, for the respective output size, a value that maintains the aspect
1922 ratio of the input image.
1924 The default value of @var{width} and @var{height} is 0.
1926 Valid values for the optional parameter @var{interl} are:
1930 force interlaced aware scaling
1933 select interlaced aware scaling depending on whether the source frames
1934 are flagged as interlaced or not
1937 Some examples follow:
1939 # scale the input video to a size of 200x100.
1942 # scale the input to 2x
1944 # the above is the same as
1947 # scale the input to half size
1950 # increase the width, and set the height to the same size
1953 # seek for Greek harmony
1957 # increase the height, and set the width to 3/2 of the height
1960 # increase the size, but make the size a multiple of the chroma
1961 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1963 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1964 scale='min(500\, iw*3/2):-1'
1968 Select frames to pass in output.
1970 It accepts in input an expression, which is evaluated for each input
1971 frame. If the expression is evaluated to a non-zero value, the frame
1972 is selected and passed to the output, otherwise it is discarded.
1974 The expression can contain the following constants:
1978 the sequential number of the filtered frame, starting from 0
1981 the sequential number of the selected frame, starting from 0
1983 @item prev_selected_n
1984 the sequential number of the last selected frame, NAN if undefined
1987 timebase of the input timestamps
1990 the PTS (Presentation TimeStamp) of the filtered video frame,
1991 expressed in @var{TB} units, NAN if undefined
1994 the PTS (Presentation TimeStamp) of the filtered video frame,
1995 expressed in seconds, NAN if undefined
1998 the PTS of the previously filtered video frame, NAN if undefined
2000 @item prev_selected_pts
2001 the PTS of the last previously filtered video frame, NAN if undefined
2003 @item prev_selected_t
2004 the PTS of the last previously selected video frame, NAN if undefined
2007 the PTS of the first video frame in the video, NAN if undefined
2010 the time of the first video frame in the video, NAN if undefined
2013 the type of the filtered frame, can assume one of the following
2025 @item interlace_type
2026 the frame interlace type, can assume one of the following values:
2029 the frame is progressive (not interlaced)
2031 the frame is top-field-first
2033 the frame is bottom-field-first
2037 1 if the filtered frame is a key-frame, 0 otherwise
2040 the position in the file of the filtered frame, -1 if the information
2041 is not available (e.g. for synthetic video)
2044 The default value of the select expression is "1".
2046 Some examples follow:
2049 # select all frames in input
2052 # the above is the same as:
2058 # select only I-frames
2059 select='eq(pict_type\,I)'
2061 # select one frame every 100
2062 select='not(mod(n\,100))'
2064 # select only frames contained in the 10-20 time interval
2065 select='gte(t\,10)*lte(t\,20)'
2067 # select only I frames contained in the 10-20 time interval
2068 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2070 # select frames with a minimum distance of 10 seconds
2071 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2077 Set the Display Aspect Ratio for the filter output video.
2079 This is done by changing the specified Sample (aka Pixel) Aspect
2080 Ratio, according to the following equation:
2081 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2083 Keep in mind that this filter does not modify the pixel dimensions of
2084 the video frame. Also the display aspect ratio set by this filter may
2085 be changed by later filters in the filterchain, e.g. in case of
2086 scaling or if another "setdar" or a "setsar" filter is applied.
2088 The filter accepts a parameter string which represents the wanted
2089 display aspect ratio.
2090 The parameter can be a floating point number string, or an expression
2091 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
2092 numerator and denominator of the aspect ratio.
2093 If the parameter is not specified, it is assumed the value "0:1".
2095 For example to change the display aspect ratio to 16:9, specify:
2098 # the above is equivalent to
2102 See also the @ref{setsar} filter documentation.
2106 Change the PTS (presentation timestamp) of the input video frames.
2108 Accept in input an expression evaluated through the eval API, which
2109 can contain the following constants:
2113 the presentation timestamp in input
2116 the count of the input frame, starting from 0.
2119 the PTS of the first video frame
2122 tell if the current frame is interlaced
2125 original position in the file of the frame, or undefined if undefined
2126 for the current frame
2136 Some examples follow:
2139 # start counting PTS from zero
2151 # fixed rate 25 fps with some jitter
2152 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2158 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
2160 Note that as a consequence of the application of this filter, the
2161 output display aspect ratio will change according to the following
2163 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2165 Keep in mind that the sample aspect ratio set by this filter may be
2166 changed by later filters in the filterchain, e.g. if another "setsar"
2167 or a "setdar" filter is applied.
2169 The filter accepts a parameter string which represents the wanted
2170 sample aspect ratio.
2171 The parameter can be a floating point number string, or an expression
2172 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
2173 numerator and denominator of the aspect ratio.
2174 If the parameter is not specified, it is assumed the value "0:1".
2176 For example to change the sample aspect ratio to 10:11, specify:
2183 Set the timebase to use for the output frames timestamps.
2184 It is mainly useful for testing timebase configuration.
2186 It accepts in input an arithmetic expression representing a rational.
2187 The expression can contain the constants "AVTB" (the
2188 default timebase), and "intb" (the input timebase).
2190 The default value for the input is "intb".
2192 Follow some examples.
2195 # set the timebase to 1/25
2198 # set the timebase to 1/10
2201 #set the timebase to 1001/1000
2204 #set the timebase to 2*intb
2207 #set the default timebase value
2213 Show a line containing various information for each input video frame.
2214 The input video is not modified.
2216 The shown line contains a sequence of key/value pairs of the form
2217 @var{key}:@var{value}.
2219 A description of each shown parameter follows:
2223 sequential number of the input frame, starting from 0
2226 Presentation TimeStamp of the input frame, expressed as a number of
2227 time base units. The time base unit depends on the filter input pad.
2230 Presentation TimeStamp of the input frame, expressed as a number of
2234 position of the frame in the input stream, -1 if this information in
2235 unavailable and/or meanigless (for example in case of synthetic video)
2241 sample aspect ratio of the input frame, expressed in the form
2245 size of the input frame, expressed in the form
2246 @var{width}x@var{height}
2249 interlaced mode ("P" for "progressive", "T" for top field first, "B"
2250 for bottom field first)
2253 1 if the frame is a key frame, 0 otherwise
2256 picture type of the input frame ("I" for an I-frame, "P" for a
2257 P-frame, "B" for a B-frame, "?" for unknown type).
2258 Check also the documentation of the @code{AVPictureType} enum and of
2259 the @code{av_get_picture_type_char} function defined in
2260 @file{libavutil/avutil.h}.
2263 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
2265 @item plane_checksum
2266 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
2267 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
2272 Pass the images of input video on to next video filter as multiple
2276 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
2279 The filter accepts the slice height as parameter. If the parameter is
2280 not specified it will use the default value of 16.
2282 Adding this in the beginning of filter chains should make filtering
2283 faster due to better use of the memory cache.
2287 Pass on the input video to two outputs. Both outputs are identical to
2292 [in] split [splitout1][splitout2];
2293 [splitout1] crop=100:100:0:0 [cropout];
2294 [splitout2] pad=200:200:100:100 [padout];
2297 will create two separate outputs from the same input, one cropped and
2302 Transpose rows with columns in the input video and optionally flip it.
2304 It accepts a parameter representing an integer, which can assume the
2309 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2317 Rotate by 90 degrees clockwise, that is:
2325 Rotate by 90 degrees counterclockwise, that is:
2333 Rotate by 90 degrees clockwise and vertically flip, that is:
2343 Sharpen or blur the input video.
2345 It accepts the following parameters:
2346 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
2348 Negative values for the amount will blur the input video, while positive
2349 values will sharpen. All parameters are optional and default to the
2350 equivalent of the string '5:5:1.0:5:5:0.0'.
2355 Set the luma matrix horizontal size. It can be an integer between 3
2356 and 13, default value is 5.
2359 Set the luma matrix vertical size. It can be an integer between 3
2360 and 13, default value is 5.
2363 Set the luma effect strength. It can be a float number between -2.0
2364 and 5.0, default value is 1.0.
2366 @item chroma_msize_x
2367 Set the chroma matrix horizontal size. It can be an integer between 3
2368 and 13, default value is 5.
2370 @item chroma_msize_y
2371 Set the chroma matrix vertical size. It can be an integer between 3
2372 and 13, default value is 5.
2375 Set the chroma effect strength. It can be a float number between -2.0
2376 and 5.0, default value is 0.0.
2381 # Strong luma sharpen effect parameters
2384 # Strong blur of both luma and chroma parameters
2385 unsharp=7:7:-2:7:7:-2
2387 # Use the default values with @command{ffmpeg}
2388 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
2393 Flip the input video vertically.
2396 ./ffmpeg -i in.avi -vf "vflip" out.avi
2401 Deinterlace the input video ("yadif" means "yet another deinterlacing
2404 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
2406 @var{mode} specifies the interlacing mode to adopt, accepts one of the
2411 output 1 frame for each frame
2413 output 1 frame for each field
2415 like 0 but skips spatial interlacing check
2417 like 1 but skips spatial interlacing check
2422 @var{parity} specifies the picture field parity assumed for the input
2423 interlaced video, accepts one of the following values:
2427 assume top field first
2429 assume bottom field first
2431 enable automatic detection
2434 Default value is -1.
2435 If interlacing is unknown or decoder does not export this information,
2436 top field first will be assumed.
2438 @var{auto} specifies if deinterlacer should trust the interlaced flag
2439 and only deinterlace frames marked as interlaced
2443 deinterlace all frames
2445 only deinterlace frames marked as interlaced
2450 @c man end VIDEO FILTERS
2452 @chapter Video Sources
2453 @c man begin VIDEO SOURCES
2455 Below is a description of the currently available video sources.
2459 Buffer video frames, and make them available to the filter chain.
2461 This source is mainly intended for a programmatic use, in particular
2462 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2464 It accepts the following parameters:
2465 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den}:@var{scale_params}
2467 All the parameters but @var{scale_params} need to be explicitly
2470 Follows the list of the accepted parameters.
2475 Specify the width and height of the buffered video frames.
2477 @item pix_fmt_string
2478 A string representing the pixel format of the buffered video frames.
2479 It may be a number corresponding to a pixel format, or a pixel format
2482 @item timebase_num, timebase_den
2483 Specify numerator and denomitor of the timebase assumed by the
2484 timestamps of the buffered frames.
2486 @item sample_aspect_ratio.num, sample_aspect_ratio.den
2487 Specify numerator and denominator of the sample aspect ratio assumed
2488 by the video frames.
2491 Specify the optional parameters to be used for the scale filter which
2492 is automatically inserted when an input change is detected in the
2493 input size or format.
2498 buffer=320:240:yuv410p:1:24:1:1
2501 will instruct the source to accept video frames with size 320x240 and
2502 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2503 square pixels (1:1 sample aspect ratio).
2504 Since the pixel format with name "yuv410p" corresponds to the number 6
2505 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
2506 this example corresponds to:
2508 buffer=320:240:6:1:24:1:1
2513 Provide an uniformly colored input.
2515 It accepts the following parameters:
2516 @var{color}:@var{frame_size}:@var{frame_rate}
2518 Follows the description of the accepted parameters.
2523 Specify the color of the source. It can be the name of a color (case
2524 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2525 alpha specifier. The default value is "black".
2528 Specify the size of the sourced video, it may be a string of the form
2529 @var{width}x@var{height}, or the name of a size abbreviation. The
2530 default value is "320x240".
2533 Specify the frame rate of the sourced video, as the number of frames
2534 generated per second. It has to be a string in the format
2535 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2536 number or a valid video frame rate abbreviation. The default value is
2541 For example the following graph description will generate a red source
2542 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2543 frames per second, which will be overlayed over the source connected
2544 to the pad with identifier "in".
2547 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2552 Read a video stream from a movie container.
2554 It accepts the syntax: @var{movie_name}[:@var{options}] where
2555 @var{movie_name} is the name of the resource to read (not necessarily
2556 a file but also a device or a stream accessed through some protocol),
2557 and @var{options} is an optional sequence of @var{key}=@var{value}
2558 pairs, separated by ":".
2560 The description of the accepted options follows.
2564 @item format_name, f
2565 Specifies the format assumed for the movie to read, and can be either
2566 the name of a container or an input device. If not specified the
2567 format is guessed from @var{movie_name} or by probing.
2569 @item seek_point, sp
2570 Specifies the seek point in seconds, the frames will be output
2571 starting from this seek point, the parameter is evaluated with
2572 @code{av_strtod} so the numerical value may be suffixed by an IS
2573 postfix. Default value is "0".
2575 @item stream_index, si
2576 Specifies the index of the video stream to read. If the value is -1,
2577 the best suited video stream will be automatically selected. Default
2582 This filter allows to overlay a second video on top of main input of
2583 a filtergraph as shown in this graph:
2585 input -----------> deltapts0 --> overlay --> output
2588 movie --> scale--> deltapts1 -------+
2591 Some examples follow:
2593 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
2594 # on top of the input labelled as "in".
2595 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2596 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2598 # read from a video4linux2 device, and overlay it on top of the input
2600 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2601 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2607 Generate various test patterns, as generated by the MPlayer test filter.
2609 The size of the generated video is fixed, and is 256x256.
2610 This source is useful in particular for testing encoding features.
2612 This source accepts an optional sequence of @var{key}=@var{value} pairs,
2613 separated by ":". The description of the accepted options follows.
2618 Specify the frame rate of the sourced video, as the number of frames
2619 generated per second. It has to be a string in the format
2620 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2621 number or a valid video frame rate abbreviation. The default value is
2625 Set the video duration of the sourced video. The accepted syntax is:
2627 [-]HH[:MM[:SS[.m...]]]
2630 See also the function @code{av_parse_time()}.
2632 If not specified, or the expressed duration is negative, the video is
2633 supposed to be generated forever.
2637 Set the number or the name of the test to perform. Supported tests are:
2652 Default value is "all", which will cycle through the list of all tests.
2655 For example the following:
2660 will generate a "dc_luma" test pattern.
2664 Provide a frei0r source.
2666 To enable compilation of this filter you need to install the frei0r
2667 header and configure FFmpeg with --enable-frei0r.
2669 The source supports the syntax:
2671 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
2674 @var{size} is the size of the video to generate, may be a string of the
2675 form @var{width}x@var{height} or a frame size abbreviation.
2676 @var{rate} is the rate of the video to generate, may be a string of
2677 the form @var{num}/@var{den} or a frame rate abbreviation.
2678 @var{src_name} is the name to the frei0r source to load. For more
2679 information regarding frei0r and how to set the parameters read the
2680 section @ref{frei0r} in the description of the video filters.
2682 Some examples follow:
2684 # generate a frei0r partik0l source with size 200x200 and framerate 10
2685 # which is overlayed on the overlay filter main input
2686 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
2689 @section nullsrc, rgbtestsrc, testsrc
2691 The @code{nullsrc} source returns unprocessed video frames. It is
2692 mainly useful to be employed in analysis / debugging tools, or as the
2693 source for filters which ignore the input data.
2695 The @code{rgbtestsrc} source generates an RGB test pattern useful for
2696 detecting RGB vs BGR issues. You should see a red, green and blue
2697 stripe from top to bottom.
2699 The @code{testsrc} source generates a test video pattern, showing a
2700 color pattern, a scrolling gradient and a timestamp. This is mainly
2701 intended for testing purposes.
2703 These sources accept an optional sequence of @var{key}=@var{value} pairs,
2704 separated by ":". The description of the accepted options follows.
2709 Specify the size of the sourced video, it may be a string of the form
2710 @var{width}x@var{heigth}, or the name of a size abbreviation. The
2711 default value is "320x240".
2714 Specify the frame rate of the sourced video, as the number of frames
2715 generated per second. It has to be a string in the format
2716 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2717 number or a valid video frame rate abbreviation. The default value is
2721 Set the sample aspect ratio of the sourced video.
2724 Set the video duration of the sourced video. The accepted syntax is:
2726 [-]HH[:MM[:SS[.m...]]]
2729 See also the function @code{av_parse_time()}.
2731 If not specified, or the expressed duration is negative, the video is
2732 supposed to be generated forever.
2735 For example the following:
2737 testsrc=duration=5.3:size=qcif:rate=10
2740 will generate a video with a duration of 5.3 seconds, with size
2741 176x144 and a framerate of 10 frames per second.
2743 If the input content is to be ignored, @code{nullsrc} can be used. The
2744 following command generates noise in the luminance plane by employing
2745 the @code{mp=geq} filter:
2747 nullsrc=s=256x256, mp=geq=random(1)*255:128:128
2750 @c man end VIDEO SOURCES
2752 @chapter Video Sinks
2753 @c man begin VIDEO SINKS
2755 Below is a description of the currently available video sinks.
2759 Buffer video frames, and make them available to the end of the filter
2762 This sink is mainly intended for a programmatic use, in particular
2763 through the interface defined in @file{libavfilter/buffersink.h}.
2765 It does not require a string parameter in input, but you need to
2766 specify a pointer to a list of supported pixel formats terminated by
2767 -1 in the opaque parameter provided to @code{avfilter_init_filter}
2768 when initializing this sink.
2772 Null video sink, do absolutely nothing with the input video. It is
2773 mainly useful as a template and to be employed in analysis / debugging
2776 @c man end VIDEO SINKS