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/chlayout.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 meanigless (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 of all the planes of the input frame
222 Adler-32 checksum for each input frame plane, expressed in the form
223 "[@var{c0} @var{c1} @var{c2} @var{c3} @var{c4} @var{c5} @var{c6} @var{c7}]"
226 @c man end AUDIO FILTERS
228 @chapter Audio Sources
229 @c man begin AUDIO SOURCES
231 Below is a description of the currently available audio sources.
235 Buffer audio frames, and make them available to the filter chain.
237 This source is mainly intended for a programmatic use, in particular
238 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
240 It accepts the following mandatory parameters:
241 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}:@var{packing}
246 The sample rate of the incoming audio buffers.
249 The sample format of the incoming audio buffers.
250 Either a sample format name or its corresponging integer representation from
251 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
254 The channel layout of the incoming audio buffers.
255 Either a channel layout name from channel_layout_map in
256 @file{libavutil/audioconvert.c} or its corresponding integer representation
257 from the AV_CH_LAYOUT_* macros in @file{libavutil/audioconvert.h}
260 Either "packed" or "planar", or their integer representation: 0 or 1
267 abuffer=44100:s16:stereo:planar
270 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
271 Since the sample format with name "s16" corresponds to the number
272 1 and the "stereo" channel layout corresponds to the value 3, this is
280 Read an audio stream from a movie container.
282 It accepts the syntax: @var{movie_name}[:@var{options}] where
283 @var{movie_name} is the name of the resource to read (not necessarily
284 a file but also a device or a stream accessed through some protocol),
285 and @var{options} is an optional sequence of @var{key}=@var{value}
286 pairs, separated by ":".
288 The description of the accepted options follows.
293 Specify the format assumed for the movie to read, and can be either
294 the name of a container or an input device. If not specified the
295 format is guessed from @var{movie_name} or by probing.
298 Specify the seek point in seconds, the frames will be output
299 starting from this seek point, the parameter is evaluated with
300 @code{av_strtod} so the numerical value may be suffixed by an IS
301 postfix. Default value is "0".
303 @item stream_index, si
304 Specify the index of the audio stream to read. If the value is -1,
305 the best suited audio stream will be automatically selected. Default
312 Null audio source, return unprocessed audio frames. It is mainly useful
313 as a template and to be employed in analysis / debugging tools, or as
314 the source for filters which ignore the input data (for example the sox
317 It accepts an optional sequence of @var{key}=@var{value} pairs,
320 The description of the accepted options follows.
325 Specify the sample rate, and defaults to 44100.
327 @item channel_layout, cl
329 Specify the channel layout, and can be either an integer or a string
330 representing a channel layout. The default value of @var{channel_layout}
333 Check the channel_layout_map definition in
334 @file{libavcodec/audioconvert.c} for the mapping between strings and
335 channel layout values.
338 Set the number of samples per requested frames.
342 Follow some examples:
344 # set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
345 anullsrc=r=48000:cl=4
348 anullsrc=r=48000:cl=mono
351 @c man end AUDIO SOURCES
354 @c man begin AUDIO SINKS
356 Below is a description of the currently available audio sinks.
360 Buffer audio frames, and make them available to the end of filter chain.
362 This sink is mainly intended for programmatic use, in particular
363 through the interface defined in @file{libavfilter/buffersink.h}.
365 It requires a pointer to an AVABufferSinkContext structure, which
366 defines the incoming buffers' formats, to be passed as the opaque
367 parameter to @code{avfilter_init_filter} for initialization.
371 Null audio sink, do absolutely nothing with the input audio. It is
372 mainly useful as a template and to be employed in analysis / debugging
375 @c man end AUDIO SINKS
377 @chapter Video Filters
378 @c man begin VIDEO FILTERS
380 When you configure your FFmpeg build, you can disable any of the
381 existing filters using --disable-filters.
382 The configure output will show the video filters included in your
385 Below is a description of the currently available video filters.
389 Detect frames that are (almost) completely black. Can be useful to
390 detect chapter transitions or commercials. Output lines consist of
391 the frame number of the detected frame, the percentage of blackness,
392 the position in the file if known or -1 and the timestamp in seconds.
394 In order to display the output lines, you need to set the loglevel at
395 least to the AV_LOG_INFO value.
397 The filter accepts the syntax:
399 blackframe[=@var{amount}:[@var{threshold}]]
402 @var{amount} is the percentage of the pixels that have to be below the
403 threshold, and defaults to 98.
405 @var{threshold} is the threshold below which a pixel value is
406 considered black, and defaults to 32.
410 Apply boxblur algorithm to the input video.
412 This filter accepts the parameters:
413 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
415 Chroma and alpha parameters are optional, if not specified they default
416 to the corresponding values set for @var{luma_radius} and
419 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
420 the radius in pixels of the box used for blurring the corresponding
421 input plane. They are expressions, and can contain the following
425 the input width and heigth in pixels
428 the input chroma image width and height in pixels
431 horizontal and vertical chroma subsample values. For example for the
432 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
435 The radius must be a non-negative number, and must be not greater than
436 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
437 and of @code{min(cw,ch)/2} for the chroma planes.
439 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
440 how many times the boxblur filter is applied to the corresponding
443 Some examples follow:
448 Apply a boxblur filter with luma, chroma, and alpha radius
455 Set luma radius to 2, alpha and chroma radius to 0
461 Set luma and chroma radius to a fraction of the video dimension
463 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
470 Copy the input source unchanged to the output. Mainly useful for
475 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
477 The parameters are expressions containing the following constants:
481 the corresponding mathematical approximated values for e
482 (euler number), pi (greek PI), PHI (golden ratio)
485 the computed values for @var{x} and @var{y}. They are evaluated for
489 the input width and height
492 same as @var{in_w} and @var{in_h}
495 the output (cropped) width and height
498 same as @var{out_w} and @var{out_h}
501 same as @var{iw} / @var{ih}
504 input sample aspect ratio
507 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
510 horizontal and vertical chroma subsample values. For example for the
511 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
514 the number of input frame, starting from 0
517 the position in the file of the input frame, NAN if unknown
520 timestamp expressed in seconds, NAN if the input timestamp is unknown
524 The @var{out_w} and @var{out_h} parameters specify the expressions for
525 the width and height of the output (cropped) video. They are
526 evaluated just at the configuration of the filter.
528 The default value of @var{out_w} is "in_w", and the default value of
529 @var{out_h} is "in_h".
531 The expression for @var{out_w} may depend on the value of @var{out_h},
532 and the expression for @var{out_h} may depend on @var{out_w}, but they
533 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
534 evaluated after @var{out_w} and @var{out_h}.
536 The @var{x} and @var{y} parameters specify the expressions for the
537 position of the top-left corner of the output (non-cropped) area. They
538 are evaluated for each frame. If the evaluated value is not valid, it
539 is approximated to the nearest valid value.
541 The default value of @var{x} is "(in_w-out_w)/2", and the default
542 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
543 the center of the input image.
545 The expression for @var{x} may depend on @var{y}, and the expression
546 for @var{y} may depend on @var{x}.
548 Follow some examples:
550 # crop the central input area with size 100x100
553 # crop the central input area with size 2/3 of the input video
554 "crop=2/3*in_w:2/3*in_h"
556 # crop the input video central square
559 # delimit the rectangle with the top-left corner placed at position
560 # 100:100 and the right-bottom corner corresponding to the right-bottom
561 # corner of the input image.
562 crop=in_w-100:in_h-100:100:100
564 # crop 10 pixels from the left and right borders, and 20 pixels from
565 # the top and bottom borders
566 "crop=in_w-2*10:in_h-2*20"
568 # keep only the bottom right quarter of the input image
569 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
571 # crop height for getting Greek harmony
572 "crop=in_w:1/PHI*in_w"
575 "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)"
577 # erratic camera effect depending on timestamp
578 "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)"
580 # set x depending on the value of y
581 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
586 Auto-detect crop size.
588 Calculate necessary cropping parameters and prints the recommended
589 parameters through the logging system. The detected dimensions
590 correspond to the non-black area of the input video.
592 It accepts the syntax:
594 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
600 Threshold, which can be optionally specified from nothing (0) to
601 everything (255), defaults to 24.
604 Value which the width/height should be divisible by, defaults to
605 16. The offset is automatically adjusted to center the video. Use 2 to
606 get only even dimensions (needed for 4:2:2 video). 16 is best when
607 encoding to most video codecs.
610 Counter that determines after how many frames cropdetect will reset
611 the previously detected largest video area and start over to detect
612 the current optimal crop area. Defaults to 0.
614 This can be useful when channel logos distort the video area. 0
615 indicates never reset and return the largest area encountered during
621 Suppress a TV station logo by a simple interpolation of the surrounding
622 pixels. Just set a rectangle covering the logo and watch it disappear
623 (and sometimes something even uglier appear - your mileage may vary).
625 The filter accepts parameters as a string of the form
626 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
627 @var{key}=@var{value} pairs, separated by ":".
629 The description of the accepted parameters follows.
634 Specify the top left corner coordinates of the logo. They must be
638 Specify the width and height of the logo to clear. They must be
642 Specify the thickness of the fuzzy edge of the rectangle (added to
643 @var{w} and @var{h}). The default value is 4.
646 When set to 1, a green rectangle is drawn on the screen to simplify
647 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
648 @var{band} is set to 4. The default value is 0.
652 Some examples follow.
657 Set a rectangle covering the area with top left corner coordinates 0,0
658 and size 100x77, setting a band of size 10:
664 As the previous example, but use named options:
666 delogo=x=0:y=0:w=100:h=77:band=10
673 Draw a colored box on the input image.
675 It accepts the syntax:
677 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
683 Specify the top left corner coordinates of the box. Default to 0.
686 Specify the width and height of the box, if 0 they are interpreted as
687 the input width and height. Default to 0.
690 Specify the color of the box to write, it can be the name of a color
691 (case insensitive match) or a 0xRRGGBB[AA] sequence.
694 Follow some examples:
696 # draw a black box around the edge of the input image
699 # draw a box with color red and an opacity of 50%
700 drawbox=10:20:200:60:red@@0.5"
705 Draw text string or text from specified file on top of video using the
708 To enable compilation of this filter you need to configure FFmpeg with
709 @code{--enable-libfreetype}.
711 The filter also recognizes strftime() sequences in the provided text
712 and expands them accordingly. Check the documentation of strftime().
714 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
717 The description of the accepted parameters follows.
722 The font file to be used for drawing text. Path must be included.
723 This parameter is mandatory.
726 The text string to be drawn. The text must be a sequence of UTF-8
728 This parameter is mandatory if no file is specified with the parameter
732 A text file containing text to be drawn. The text must be a sequence
733 of UTF-8 encoded characters.
735 This parameter is mandatory if no text string is specified with the
736 parameter @var{text}.
738 If both text and textfile are specified, an error is thrown.
741 The expressions which specify the offsets where text will be drawn
742 within the video frame. They are relative to the top/left border of the
745 The default value of @var{x} and @var{y} is "0".
747 See below for the list of accepted constants.
750 The font size to be used for drawing text.
751 The default value of @var{fontsize} is 16.
754 The color to be used for drawing fonts.
755 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
756 (e.g. "0xff000033"), possibly followed by an alpha specifier.
757 The default value of @var{fontcolor} is "black".
760 The color to be used for drawing box around text.
761 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
762 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
763 The default value of @var{boxcolor} is "white".
766 Used to draw a box around text using background color.
767 Value should be either 1 (enable) or 0 (disable).
768 The default value of @var{box} is 0.
770 @item shadowx, shadowy
771 The x and y offsets for the text shadow position with respect to the
772 position of the text. They can be either positive or negative
773 values. Default value for both is "0".
776 The color to be used for drawing a shadow behind the drawn text. It
777 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
778 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
779 The default value of @var{shadowcolor} is "black".
782 Flags to be used for loading the fonts.
784 The flags map the corresponding flags supported by libfreetype, and are
785 a combination of the following values:
792 @item vertical_layout
796 @item ignore_global_advance_width
798 @item ignore_transform
805 Default value is "render".
807 For more information consult the documentation for the FT_LOAD_*
811 The size in number of spaces to use for rendering the tab.
815 The parameters for @var{x} and @var{y} are expressions containing the
820 the input width and heigth
823 the width of the rendered text
826 the height of the rendered text
829 the height of each text line
832 input sample aspect ratio
835 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
838 horizontal and vertical chroma subsample values. For example for the
839 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
842 maximum glyph width, that is the maximum width for all the glyphs
843 contained in the rendered text
846 maximum glyph height, that is the maximum height for all the glyphs
847 contained in the rendered text, it is equivalent to @var{ascent} -
850 @item max_glyph_a, ascent
852 the maximum distance from the baseline to the highest/upper grid
853 coordinate used to place a glyph outline point, for all the rendered
855 It is a positive value, due to the grid's orientation with the Y axis
858 @item max_glyph_d, descent
859 the maximum distance from the baseline to the lowest grid coordinate
860 used to place a glyph outline point, for all the rendered glyphs.
861 This is a negative value, due to the grid's orientation, with the Y axis
865 the number of input frame, starting from 0
868 timestamp expressed in seconds, NAN if the input timestamp is unknown
871 Some examples follow.
876 Draw "Test Text" with font FreeSerif, using the default values for the
880 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
884 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
885 and y=50 (counting from the top-left corner of the screen), text is
886 yellow with a red box around it. Both the text and the box have an
890 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
891 x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
894 Note that the double quotes are not necessary if spaces are not used
895 within the parameter list.
898 Show the text at the center of the video frame:
900 drawtext=fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
904 Show a text line sliding from right to left in the last row of the video
905 frame. The file @file{LONG_LINE} is assumed to contain a single line
908 drawtext=fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t
912 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
914 drawtext=fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
918 Draw a single green letter "g", at the center of the input video.
919 The glyph baseline is placed at half screen height.
921 drawtext=fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent
926 For more information about libfreetype, check:
927 @url{http://www.freetype.org/}.
931 Apply fade-in/out effect to input video.
933 It accepts the parameters:
934 @var{type}:@var{start_frame}:@var{nb_frames}
936 @var{type} specifies if the effect type, can be either "in" for
937 fade-in, or "out" for a fade-out effect.
939 @var{start_frame} specifies the number of the start frame for starting
940 to apply the fade effect.
942 @var{nb_frames} specifies the number of frames for which the fade
943 effect has to last. At the end of the fade-in effect the output video
944 will have the same intensity as the input video, at the end of the
945 fade-out transition the output video will be completely black.
947 A few usage examples follow, usable too as test scenarios.
949 # fade in first 30 frames of video
952 # fade out last 45 frames of a 200-frame video
955 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
956 fade=in:0:25, fade=out:975:25
958 # make first 5 frames black, then fade in from frame 5-24
964 Transform the field order of the input video.
966 It accepts one parameter which specifies the required field order that
967 the input interlaced video will be transformed to. The parameter can
968 assume one of the following values:
972 output bottom field first
974 output top field first
977 Default value is "tff".
979 Transformation is achieved by shifting the picture content up or down
980 by one line, and filling the remaining line with appropriate picture content.
981 This method is consistent with most broadcast field order converters.
983 If the input video is not flagged as being interlaced, or it is already
984 flagged as being of the required output field order then this filter does
985 not alter the incoming video.
987 This filter is very useful when converting to or from PAL DV material,
988 which is bottom field first.
992 ./ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
997 Buffer input images and send them when they are requested.
999 This filter is mainly useful when auto-inserted by the libavfilter
1002 The filter does not take parameters.
1006 Convert the input video to one of the specified pixel formats.
1007 Libavfilter will try to pick one that is supported for the input to
1010 The filter accepts a list of pixel format names, separated by ":",
1011 for example "yuv420p:monow:rgb24".
1013 Some examples follow:
1015 # convert the input video to the format "yuv420p"
1018 # convert the input video to any of the formats in the list
1019 format=yuv420p:yuv444p:yuv410p
1025 Apply a frei0r effect to the input video.
1027 To enable compilation of this filter you need to install the frei0r
1028 header and configure FFmpeg with --enable-frei0r.
1030 The filter supports the syntax:
1032 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
1035 @var{filter_name} is the name to the frei0r effect to load. If the
1036 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
1037 is searched in each one of the directories specified by the colon
1038 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
1039 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
1040 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
1042 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
1043 for the frei0r effect.
1045 A frei0r effect parameter can be a boolean (whose values are specified
1046 with "y" and "n"), a double, a color (specified by the syntax
1047 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1048 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1049 description), a position (specified by the syntax @var{X}/@var{Y},
1050 @var{X} and @var{Y} being float numbers) and a string.
1052 The number and kind of parameters depend on the loaded effect. If an
1053 effect parameter is not specified the default value is set.
1055 Some examples follow:
1057 # apply the distort0r effect, set the first two double parameters
1058 frei0r=distort0r:0.5:0.01
1060 # apply the colordistance effect, takes a color as first parameter
1061 frei0r=colordistance:0.2/0.3/0.4
1062 frei0r=colordistance:violet
1063 frei0r=colordistance:0x112233
1065 # apply the perspective effect, specify the top left and top right
1067 frei0r=perspective:0.2/0.2:0.8/0.2
1070 For more information see:
1071 @url{http://piksel.org/frei0r}
1075 Fix the banding artifacts that are sometimes introduced into nearly flat
1076 regions by truncation to 8bit colordepth.
1077 Interpolate the gradients that should go where the bands are, and
1080 This filter is designed for playback only. Do not use it prior to
1081 lossy compression, because compression tends to lose the dither and
1082 bring back the bands.
1084 The filter takes two optional parameters, separated by ':':
1085 @var{strength}:@var{radius}
1087 @var{strength} is the maximum amount by which the filter will change
1088 any one pixel. Also the threshold for detecting nearly flat
1089 regions. Acceptable values range from .51 to 255, default value is
1090 1.2, out-of-range values will be clipped to the valid range.
1092 @var{radius} is the neighborhood to fit the gradient to. A larger
1093 radius makes for smoother gradients, but also prevents the filter from
1094 modifying the pixels near detailed regions. Acceptable values are
1095 8-32, default value is 16, out-of-range values will be clipped to the
1099 # default parameters
1108 Flip the input video horizontally.
1110 For example to horizontally flip the video in input with
1113 ffmpeg -i in.avi -vf "hflip" out.avi
1118 High precision/quality 3d denoise filter. This filter aims to reduce
1119 image noise producing smooth images and making still images really
1120 still. It should enhance compressibility.
1122 It accepts the following optional parameters:
1123 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
1127 a non-negative float number which specifies spatial luma strength,
1130 @item chroma_spatial
1131 a non-negative float number which specifies spatial chroma strength,
1132 defaults to 3.0*@var{luma_spatial}/4.0
1135 a float number which specifies luma temporal strength, defaults to
1136 6.0*@var{luma_spatial}/4.0
1139 a float number which specifies chroma temporal strength, defaults to
1140 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1143 @section lut, lutrgb, lutyuv
1145 Compute a look-up table for binding each pixel component input value
1146 to an output value, and apply it to input video.
1148 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1149 to an RGB input video.
1151 These filters accept in input a ":"-separated list of options, which
1152 specify the expressions used for computing the lookup table for the
1153 corresponding pixel component values.
1155 The @var{lut} filter requires either YUV or RGB pixel formats in
1156 input, and accepts the options:
1159 first pixel component
1161 second pixel component
1163 third pixel component
1165 fourth pixel component, corresponds to the alpha component
1168 The exact component associated to each option depends on the format in
1171 The @var{lutrgb} filter requires RGB pixel formats in input, and
1172 accepts the options:
1184 The @var{lutyuv} filter requires YUV pixel formats in input, and
1185 accepts the options:
1188 Y/luminance component
1197 The expressions can contain the following constants and functions:
1201 the input width and heigth
1204 input value for the pixel component
1207 the input value clipped in the @var{minval}-@var{maxval} range
1210 maximum value for the pixel component
1213 minimum value for the pixel component
1216 the negated value for the pixel component value clipped in the
1217 @var{minval}-@var{maxval} range , it corresponds to the expression
1218 "maxval-clipval+minval"
1221 the computed value in @var{val} clipped in the
1222 @var{minval}-@var{maxval} range
1224 @item gammaval(gamma)
1225 the computed gamma correction value of the pixel component value
1226 clipped in the @var{minval}-@var{maxval} range, corresponds to the
1228 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1232 All expressions default to "val".
1234 Some examples follow:
1236 # negate input video
1237 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1238 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1240 # the above is the same as
1241 lutrgb="r=negval:g=negval:b=negval"
1242 lutyuv="y=negval:u=negval:v=negval"
1247 # remove chroma components, turns the video into a graytone image
1248 lutyuv="u=128:v=128"
1250 # apply a luma burning effect
1253 # remove green and blue components
1256 # set a constant alpha channel value on input
1257 format=rgba,lutrgb=a="maxval-minval/2"
1259 # correct luminance gamma by a 0.5 factor
1260 lutyuv=y=gammaval(0.5)
1265 Apply an MPlayer filter to the input video.
1267 This filter provides a wrapper around most of the filters of
1270 This wrapper is considered experimental. Some of the wrapped filters
1271 may not work properly and we may drop support for them, as they will
1272 be implemented natively into FFmpeg. Thus you should avoid
1273 depending on them when writing portable scripts.
1275 The filters accepts the parameters:
1276 @var{filter_name}[:=]@var{filter_params}
1278 @var{filter_name} is the name of a supported MPlayer filter,
1279 @var{filter_params} is a string containing the parameters accepted by
1282 The list of the currently supported filters follows:
1336 The parameter syntax and behavior for the listed filters are the same
1337 of the corresponding MPlayer filters. For detailed instructions check
1338 the "VIDEO FILTERS" section in the MPlayer manual.
1340 Some examples follow:
1342 # remove a logo by interpolating the surrounding pixels
1343 mp=delogo=200:200:80:20:1
1345 # adjust gamma, brightness, contrast
1348 # tweak hue and saturation
1352 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
1358 This filter accepts an integer in input, if non-zero it negates the
1359 alpha component (if available). The default value in input is 0.
1363 Force libavfilter not to use any of the specified pixel formats for the
1364 input to the next filter.
1366 The filter accepts a list of pixel format names, separated by ":",
1367 for example "yuv420p:monow:rgb24".
1369 Some examples follow:
1371 # force libavfilter to use a format different from "yuv420p" for the
1372 # input to the vflip filter
1373 noformat=yuv420p,vflip
1375 # convert the input video to any of the formats not contained in the list
1376 noformat=yuv420p:yuv444p:yuv410p
1381 Pass the video source unchanged to the output.
1385 Apply video transform using libopencv.
1387 To enable this filter install libopencv library and headers and
1388 configure FFmpeg with --enable-libopencv.
1390 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
1392 @var{filter_name} is the name of the libopencv filter to apply.
1394 @var{filter_params} specifies the parameters to pass to the libopencv
1395 filter. If not specified the default values are assumed.
1397 Refer to the official libopencv documentation for more precise
1399 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1401 Follows the list of supported libopencv filters.
1406 Dilate an image by using a specific structuring element.
1407 This filter corresponds to the libopencv function @code{cvDilate}.
1409 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
1411 @var{struct_el} represents a structuring element, and has the syntax:
1412 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1414 @var{cols} and @var{rows} represent the number of colums and rows of
1415 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1416 point, and @var{shape} the shape for the structuring element, and
1417 can be one of the values "rect", "cross", "ellipse", "custom".
1419 If the value for @var{shape} is "custom", it must be followed by a
1420 string of the form "=@var{filename}". The file with name
1421 @var{filename} is assumed to represent a binary image, with each
1422 printable character corresponding to a bright pixel. When a custom
1423 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1424 or columns and rows of the read file are assumed instead.
1426 The default value for @var{struct_el} is "3x3+0x0/rect".
1428 @var{nb_iterations} specifies the number of times the transform is
1429 applied to the image, and defaults to 1.
1431 Follow some example:
1433 # use the default values
1436 # dilate using a structuring element with a 5x5 cross, iterate two times
1437 ocv=dilate=5x5+2x2/cross:2
1439 # read the shape from the file diamond.shape, iterate two times
1440 # the file diamond.shape may contain a pattern of characters like this:
1446 # the specified cols and rows are ignored (but not the anchor point coordinates)
1447 ocv=0x0+2x2/custom=diamond.shape:2
1452 Erode an image by using a specific structuring element.
1453 This filter corresponds to the libopencv function @code{cvErode}.
1455 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1456 with the same syntax and semantics as the @ref{dilate} filter.
1460 Smooth the input video.
1462 The filter takes the following parameters:
1463 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
1465 @var{type} is the type of smooth filter to apply, and can be one of
1466 the following values: "blur", "blur_no_scale", "median", "gaussian",
1467 "bilateral". The default value is "gaussian".
1469 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1470 parameters whose meanings depend on smooth type. @var{param1} and
1471 @var{param2} accept integer positive values or 0, @var{param3} and
1472 @var{param4} accept float values.
1474 The default value for @var{param1} is 3, the default value for the
1475 other parameters is 0.
1477 These parameters correspond to the parameters assigned to the
1478 libopencv function @code{cvSmooth}.
1482 Overlay one video on top of another.
1484 It takes two inputs and one output, the first input is the "main"
1485 video on which the second input is overlayed.
1487 It accepts the parameters: @var{x}:@var{y}.
1489 @var{x} is the x coordinate of the overlayed video on the main video,
1490 @var{y} is the y coordinate. The parameters are expressions containing
1491 the following parameters:
1494 @item main_w, main_h
1495 main input width and height
1498 same as @var{main_w} and @var{main_h}
1500 @item overlay_w, overlay_h
1501 overlay input width and height
1504 same as @var{overlay_w} and @var{overlay_h}
1507 Be aware that frames are taken from each input video in timestamp
1508 order, hence, if their initial timestamps differ, it is a a good idea
1509 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1510 have them begin in the same zero timestamp, as it does the example for
1511 the @var{movie} filter.
1513 Follow some examples:
1515 # draw the overlay at 10 pixels from the bottom right
1516 # corner of the main video.
1517 overlay=main_w-overlay_w-10:main_h-overlay_h-10
1519 # insert a transparent PNG logo in the bottom left corner of the input
1520 movie=logo.png [logo];
1521 [in][logo] overlay=10:main_h-overlay_h-10 [out]
1523 # insert 2 different transparent PNG logos (second logo on bottom
1525 movie=logo1.png [logo1];
1526 movie=logo2.png [logo2];
1527 [in][logo1] overlay=10:H-h-10 [in+logo1];
1528 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
1530 # add a transparent color layer on top of the main video,
1531 # WxH specifies the size of the main input to the overlay filter
1532 color=red@.3:WxH [over]; [in][over] overlay [out]
1535 You can chain togheter more overlays but the efficiency of such
1536 approach is yet to be tested.
1540 Add paddings to the input image, and places the original input at the
1541 given coordinates @var{x}, @var{y}.
1543 It accepts the following parameters:
1544 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
1546 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1547 expressions containing the following constants:
1551 the input video width and height
1554 same as @var{in_w} and @var{in_h}
1557 the output width and height, that is the size of the padded area as
1558 specified by the @var{width} and @var{height} expressions
1561 same as @var{out_w} and @var{out_h}
1564 x and y offsets as specified by the @var{x} and @var{y}
1565 expressions, or NAN if not yet specified
1568 same as @var{iw} / @var{ih}
1571 input sample aspect ratio
1574 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1577 horizontal and vertical chroma subsample values. For example for the
1578 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1581 Follows the description of the accepted parameters.
1586 Specify the size of the output image with the paddings added. If the
1587 value for @var{width} or @var{height} is 0, the corresponding input size
1588 is used for the output.
1590 The @var{width} expression can reference the value set by the
1591 @var{height} expression, and viceversa.
1593 The default value of @var{width} and @var{height} is 0.
1597 Specify the offsets where to place the input image in the padded area
1598 with respect to the top/left border of the output image.
1600 The @var{x} expression can reference the value set by the @var{y}
1601 expression, and viceversa.
1603 The default value of @var{x} and @var{y} is 0.
1607 Specify the color of the padded area, it can be the name of a color
1608 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1610 The default value of @var{color} is "black".
1614 Some examples follow:
1617 # Add paddings with color "violet" to the input video. Output video
1618 # size is 640x480, the top-left corner of the input video is placed at
1620 pad=640:480:0:40:violet
1622 # pad the input to get an output with dimensions increased bt 3/2,
1623 # and put the input video at the center of the padded area
1624 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1626 # pad the input to get a squared output with size equal to the maximum
1627 # value between the input width and height, and put the input video at
1628 # the center of the padded area
1629 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1631 # pad the input to get a final w/h ratio of 16:9
1632 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1634 # for anamorphic video, in order to set the output display aspect ratio,
1635 # it is necessary to use sar in the expression, according to the relation:
1636 # (ih * X / ih) * sar = output_dar
1637 # X = output_dar / sar
1638 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
1640 # double output size and put the input video in the bottom-right
1641 # corner of the output padded area
1642 pad="2*iw:2*ih:ow-iw:oh-ih"
1645 @section pixdesctest
1647 Pixel format descriptor test filter, mainly useful for internal
1648 testing. The output video should be equal to the input video.
1652 format=monow, pixdesctest
1655 can be used to test the monowhite pixel format descriptor definition.
1659 Scale the input video to @var{width}:@var{height} and/or convert the image format.
1661 The parameters @var{width} and @var{height} are expressions containing
1662 the following constants:
1666 the input width and height
1669 same as @var{in_w} and @var{in_h}
1672 the output (cropped) width and height
1675 same as @var{out_w} and @var{out_h}
1678 same as @var{iw} / @var{ih}
1681 input sample aspect ratio
1684 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1687 input sample aspect ratio
1690 horizontal and vertical chroma subsample values. For example for the
1691 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1694 If the input image format is different from the format requested by
1695 the next filter, the scale filter will convert the input to the
1698 If the value for @var{width} or @var{height} is 0, the respective input
1699 size is used for the output.
1701 If the value for @var{width} or @var{height} is -1, the scale filter will
1702 use, for the respective output size, a value that maintains the aspect
1703 ratio of the input image.
1705 The default value of @var{width} and @var{height} is 0.
1707 Some examples follow:
1709 # scale the input video to a size of 200x100.
1712 # scale the input to 2x
1714 # the above is the same as
1717 # scale the input to half size
1720 # increase the width, and set the height to the same size
1723 # seek for Greek harmony
1727 # increase the height, and set the width to 3/2 of the height
1730 # increase the size, but make the size a multiple of the chroma
1731 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1733 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1734 scale='min(500\, iw*3/2):-1'
1738 Select frames to pass in output.
1740 It accepts in input an expression, which is evaluated for each input
1741 frame. If the expression is evaluated to a non-zero value, the frame
1742 is selected and passed to the output, otherwise it is discarded.
1744 The expression can contain the following constants:
1748 the sequential number of the filtered frame, starting from 0
1751 the sequential number of the selected frame, starting from 0
1753 @item prev_selected_n
1754 the sequential number of the last selected frame, NAN if undefined
1757 timebase of the input timestamps
1760 the PTS (Presentation TimeStamp) of the filtered video frame,
1761 expressed in @var{TB} units, NAN if undefined
1764 the PTS (Presentation TimeStamp) of the filtered video frame,
1765 expressed in seconds, NAN if undefined
1768 the PTS of the previously filtered video frame, NAN if undefined
1770 @item prev_selected_pts
1771 the PTS of the last previously filtered video frame, NAN if undefined
1773 @item prev_selected_t
1774 the PTS of the last previously selected video frame, NAN if undefined
1777 the PTS of the first video frame in the video, NAN if undefined
1780 the time of the first video frame in the video, NAN if undefined
1783 the type of the filtered frame, can assume one of the following
1795 @item interlace_type
1796 the frame interlace type, can assume one of the following values:
1799 the frame is progressive (not interlaced)
1801 the frame is top-field-first
1803 the frame is bottom-field-first
1807 1 if the filtered frame is a key-frame, 0 otherwise
1810 the position in the file of the filtered frame, -1 if the information
1811 is not available (e.g. for synthetic video)
1814 The default value of the select expression is "1".
1816 Some examples follow:
1819 # select all frames in input
1822 # the above is the same as:
1828 # select only I-frames
1829 select='eq(pict_type\,I)'
1831 # select one frame every 100
1832 select='not(mod(n\,100))'
1834 # select only frames contained in the 10-20 time interval
1835 select='gte(t\,10)*lte(t\,20)'
1837 # select only I frames contained in the 10-20 time interval
1838 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
1840 # select frames with a minimum distance of 10 seconds
1841 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
1847 Set the Display Aspect Ratio for the filter output video.
1849 This is done by changing the specified Sample (aka Pixel) Aspect
1850 Ratio, according to the following equation:
1851 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1853 Keep in mind that this filter does not modify the pixel dimensions of
1854 the video frame. Also the display aspect ratio set by this filter may
1855 be changed by later filters in the filterchain, e.g. in case of
1856 scaling or if another "setdar" or a "setsar" filter is applied.
1858 The filter accepts a parameter string which represents the wanted
1859 display aspect ratio.
1860 The parameter can be a floating point number string, or an expression
1861 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1862 numerator and denominator of the aspect ratio.
1863 If the parameter is not specified, it is assumed the value "0:1".
1865 For example to change the display aspect ratio to 16:9, specify:
1868 # the above is equivalent to
1872 See also the @ref{setsar} filter documentation.
1876 Change the PTS (presentation timestamp) of the input video frames.
1878 Accept in input an expression evaluated through the eval API, which
1879 can contain the following constants:
1883 the presentation timestamp in input
1895 the count of the input frame, starting from 0.
1898 the PTS of the first video frame
1901 tell if the current frame is interlaced
1904 original position in the file of the frame, or undefined if undefined
1905 for the current frame
1915 Some examples follow:
1918 # start counting PTS from zero
1930 # fixed rate 25 fps with some jitter
1931 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
1937 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1939 Note that as a consequence of the application of this filter, the
1940 output display aspect ratio will change according to the following
1942 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1944 Keep in mind that the sample aspect ratio set by this filter may be
1945 changed by later filters in the filterchain, e.g. if another "setsar"
1946 or a "setdar" filter is applied.
1948 The filter accepts a parameter string which represents the wanted
1949 sample aspect ratio.
1950 The parameter can be a floating point number string, or an expression
1951 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1952 numerator and denominator of the aspect ratio.
1953 If the parameter is not specified, it is assumed the value "0:1".
1955 For example to change the sample aspect ratio to 10:11, specify:
1962 Set the timebase to use for the output frames timestamps.
1963 It is mainly useful for testing timebase configuration.
1965 It accepts in input an arithmetic expression representing a rational.
1966 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
1967 default timebase), and "intb" (the input timebase).
1969 The default value for the input is "intb".
1971 Follow some examples.
1974 # set the timebase to 1/25
1977 # set the timebase to 1/10
1980 #set the timebase to 1001/1000
1983 #set the timebase to 2*intb
1986 #set the default timebase value
1992 Show a line containing various information for each input video frame.
1993 The input video is not modified.
1995 The shown line contains a sequence of key/value pairs of the form
1996 @var{key}:@var{value}.
1998 A description of each shown parameter follows:
2002 sequential number of the input frame, starting from 0
2005 Presentation TimeStamp of the input frame, expressed as a number of
2006 time base units. The time base unit depends on the filter input pad.
2009 Presentation TimeStamp of the input frame, expressed as a number of
2013 position of the frame in the input stream, -1 if this information in
2014 unavailable and/or meanigless (for example in case of synthetic video)
2020 sample aspect ratio of the input frame, expressed in the form
2024 size of the input frame, expressed in the form
2025 @var{width}x@var{height}
2028 interlaced mode ("P" for "progressive", "T" for top field first, "B"
2029 for bottom field first)
2032 1 if the frame is a key frame, 0 otherwise
2035 picture type of the input frame ("I" for an I-frame, "P" for a
2036 P-frame, "B" for a B-frame, "?" for unknown type).
2037 Check also the documentation of the @code{AVPictureType} enum and of
2038 the @code{av_get_picture_type_char} function defined in
2039 @file{libavutil/avutil.h}.
2042 Adler-32 checksum of all the planes of the input frame
2044 @item plane_checksum
2045 Adler-32 checksum of each plane of the input frame, expressed in the form
2046 "[@var{c0} @var{c1} @var{c2} @var{c3}]"
2051 Pass the images of input video on to next video filter as multiple
2055 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
2058 The filter accepts the slice height as parameter. If the parameter is
2059 not specified it will use the default value of 16.
2061 Adding this in the beginning of filter chains should make filtering
2062 faster due to better use of the memory cache.
2066 Pass on the input video to two outputs. Both outputs are identical to
2071 [in] split [splitout1][splitout2];
2072 [splitout1] crop=100:100:0:0 [cropout];
2073 [splitout2] pad=200:200:100:100 [padout];
2076 will create two separate outputs from the same input, one cropped and
2081 Transpose rows with columns in the input video and optionally flip it.
2083 It accepts a parameter representing an integer, which can assume the
2088 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2096 Rotate by 90 degrees clockwise, that is:
2104 Rotate by 90 degrees counterclockwise, that is:
2112 Rotate by 90 degrees clockwise and vertically flip, that is:
2122 Sharpen or blur the input video.
2124 It accepts the following parameters:
2125 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
2127 Negative values for the amount will blur the input video, while positive
2128 values will sharpen. All parameters are optional and default to the
2129 equivalent of the string '5:5:1.0:5:5:0.0'.
2134 Set the luma matrix horizontal size. It can be an integer between 3
2135 and 13, default value is 5.
2138 Set the luma matrix vertical size. It can be an integer between 3
2139 and 13, default value is 5.
2142 Set the luma effect strength. It can be a float number between -2.0
2143 and 5.0, default value is 1.0.
2145 @item chroma_msize_x
2146 Set the chroma matrix horizontal size. It can be an integer between 3
2147 and 13, default value is 5.
2149 @item chroma_msize_y
2150 Set the chroma matrix vertical size. It can be an integer between 3
2151 and 13, default value is 5.
2154 Set the chroma effect strength. It can be a float number between -2.0
2155 and 5.0, default value is 0.0.
2160 # Strong luma sharpen effect parameters
2163 # Strong blur of both luma and chroma parameters
2164 unsharp=7:7:-2:7:7:-2
2166 # Use the default values with @command{ffmpeg}
2167 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
2172 Flip the input video vertically.
2175 ./ffmpeg -i in.avi -vf "vflip" out.avi
2180 Deinterlace the input video ("yadif" means "yet another deinterlacing
2183 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
2185 @var{mode} specifies the interlacing mode to adopt, accepts one of the
2190 output 1 frame for each frame
2192 output 1 frame for each field
2194 like 0 but skips spatial interlacing check
2196 like 1 but skips spatial interlacing check
2201 @var{parity} specifies the picture field parity assumed for the input
2202 interlaced video, accepts one of the following values:
2206 assume top field first
2208 assume bottom field first
2210 enable automatic detection
2213 Default value is -1.
2214 If interlacing is unknown or decoder does not export this information,
2215 top field first will be assumed.
2217 @var{auto} specifies if deinterlacer should trust the interlaced flag
2218 and only deinterlace frames marked as interlaced
2222 deinterlace all frames
2224 only deinterlace frames marked as interlaced
2229 @c man end VIDEO FILTERS
2231 @chapter Video Sources
2232 @c man begin VIDEO SOURCES
2234 Below is a description of the currently available video sources.
2238 Buffer video frames, and make them available to the filter chain.
2240 This source is mainly intended for a programmatic use, in particular
2241 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2243 It accepts the following parameters:
2244 @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}
2246 All the parameters but @var{scale_params} need to be explicitely
2249 Follows the list of the accepted parameters.
2254 Specify the width and height of the buffered video frames.
2256 @item pix_fmt_string
2257 A string representing the pixel format of the buffered video frames.
2258 It may be a number corresponding to a pixel format, or a pixel format
2261 @item timebase_num, timebase_den
2262 Specify numerator and denomitor of the timebase assumed by the
2263 timestamps of the buffered frames.
2265 @item sample_aspect_ratio.num, sample_aspect_ratio.den
2266 Specify numerator and denominator of the sample aspect ratio assumed
2267 by the video frames.
2270 Specify the optional parameters to be used for the scale filter which
2271 is automatically inserted when an input change is detected in the
2272 input size or format.
2277 buffer=320:240:yuv410p:1:24:1:1
2280 will instruct the source to accept video frames with size 320x240 and
2281 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2282 square pixels (1:1 sample aspect ratio).
2283 Since the pixel format with name "yuv410p" corresponds to the number 6
2284 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
2285 this example corresponds to:
2287 buffer=320:240:6:1:24:1:1
2292 Provide an uniformly colored input.
2294 It accepts the following parameters:
2295 @var{color}:@var{frame_size}:@var{frame_rate}
2297 Follows the description of the accepted parameters.
2302 Specify the color of the source. It can be the name of a color (case
2303 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2304 alpha specifier. The default value is "black".
2307 Specify the size of the sourced video, it may be a string of the form
2308 @var{width}x@var{height}, or the name of a size abbreviation. The
2309 default value is "320x240".
2312 Specify the frame rate of the sourced video, as the number of frames
2313 generated per second. It has to be a string in the format
2314 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2315 number or a valid video frame rate abbreviation. The default value is
2320 For example the following graph description will generate a red source
2321 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2322 frames per second, which will be overlayed over the source connected
2323 to the pad with identifier "in".
2326 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2331 Read a video stream from a movie container.
2333 It accepts the syntax: @var{movie_name}[:@var{options}] where
2334 @var{movie_name} is the name of the resource to read (not necessarily
2335 a file but also a device or a stream accessed through some protocol),
2336 and @var{options} is an optional sequence of @var{key}=@var{value}
2337 pairs, separated by ":".
2339 The description of the accepted options follows.
2343 @item format_name, f
2344 Specifies the format assumed for the movie to read, and can be either
2345 the name of a container or an input device. If not specified the
2346 format is guessed from @var{movie_name} or by probing.
2348 @item seek_point, sp
2349 Specifies the seek point in seconds, the frames will be output
2350 starting from this seek point, the parameter is evaluated with
2351 @code{av_strtod} so the numerical value may be suffixed by an IS
2352 postfix. Default value is "0".
2354 @item stream_index, si
2355 Specifies the index of the video stream to read. If the value is -1,
2356 the best suited video stream will be automatically selected. Default
2361 This filter allows to overlay a second video on top of main input of
2362 a filtergraph as shown in this graph:
2364 input -----------> deltapts0 --> overlay --> output
2367 movie --> scale--> deltapts1 -------+
2370 Some examples follow:
2372 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
2373 # on top of the input labelled as "in".
2374 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2375 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2377 # read from a video4linux2 device, and overlay it on top of the input
2379 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2380 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2386 Generate various test patterns, as generated by the MPlayer test filter.
2388 The size of the generated video is fixed, and is 256x256.
2389 This source is useful in particular for testing encoding features.
2391 This source accepts an optional sequence of @var{key}=@var{value} pairs,
2392 separated by ":". The description of the accepted options follows.
2397 Specify the frame rate of the sourced video, as the number of frames
2398 generated per second. It has to be a string in the format
2399 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2400 number or a valid video frame rate abbreviation. The default value is
2404 Set the video duration of the sourced video. The accepted syntax is:
2406 [-]HH[:MM[:SS[.m...]]]
2409 See also the function @code{av_parse_time()}.
2411 If not specified, or the expressed duration is negative, the video is
2412 supposed to be generated forever.
2416 Set the number or the name of the test to perform. Supported tests are:
2431 Default value is "all", which will cycle through the list of all tests.
2434 For example the following:
2439 will generate a "dc_luma" test pattern.
2443 Null video source, never return images. It is mainly useful as a
2444 template and to be employed in analysis / debugging tools.
2446 It accepts as optional parameter a string of the form
2447 @var{width}:@var{height}:@var{timebase}.
2449 @var{width} and @var{height} specify the size of the configured
2450 source. The default values of @var{width} and @var{height} are
2451 respectively 352 and 288 (corresponding to the CIF size format).
2453 @var{timebase} specifies an arithmetic expression representing a
2454 timebase. The expression can contain the constants "PI", "E", "PHI",
2455 "AVTB" (the default timebase), and defaults to the value "AVTB".
2459 Provide a frei0r source.
2461 To enable compilation of this filter you need to install the frei0r
2462 header and configure FFmpeg with --enable-frei0r.
2464 The source supports the syntax:
2466 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
2469 @var{size} is the size of the video to generate, may be a string of the
2470 form @var{width}x@var{height} or a frame size abbreviation.
2471 @var{rate} is the rate of the video to generate, may be a string of
2472 the form @var{num}/@var{den} or a frame rate abbreviation.
2473 @var{src_name} is the name to the frei0r source to load. For more
2474 information regarding frei0r and how to set the parameters read the
2475 section @ref{frei0r} in the description of the video filters.
2477 Some examples follow:
2479 # generate a frei0r partik0l source with size 200x200 and framerate 10
2480 # which is overlayed on the overlay filter main input
2481 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
2484 @section rgbtestsrc, testsrc
2486 The @code{rgbtestsrc} source generates an RGB test pattern useful for
2487 detecting RGB vs BGR issues. You should see a red, green and blue
2488 stripe from top to bottom.
2490 The @code{testsrc} source generates a test video pattern, showing a
2491 color pattern, a scrolling gradient and a timestamp. This is mainly
2492 intended for testing purposes.
2494 Both sources accept an optional sequence of @var{key}=@var{value} pairs,
2495 separated by ":". The description of the accepted options follows.
2500 Specify the size of the sourced video, it may be a string of the form
2501 @var{width}x@var{heigth}, or the name of a size abbreviation. The
2502 default value is "320x240".
2505 Specify the frame rate of the sourced video, as the number of frames
2506 generated per second. It has to be a string in the format
2507 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2508 number or a valid video frame rate abbreviation. The default value is
2512 Set the sample aspect ratio of the sourced video.
2515 Set the video duration of the sourced video. The accepted syntax is:
2517 [-]HH[:MM[:SS[.m...]]]
2520 See also the function @code{av_parse_time()}.
2522 If not specified, or the expressed duration is negative, the video is
2523 supposed to be generated forever.
2526 For example the following:
2528 testsrc=duration=5.3:size=qcif:rate=10
2531 will generate a video with a duration of 5.3 seconds, with size
2532 176x144 and a framerate of 10 frames per second.
2534 @c man end VIDEO SOURCES
2536 @chapter Video Sinks
2537 @c man begin VIDEO SINKS
2539 Below is a description of the currently available video sinks.
2543 Buffer video frames, and make them available to the end of the filter
2546 This sink is mainly intended for a programmatic use, in particular
2547 through the interface defined in @file{libavfilter/buffersink.h}.
2549 It does not require a string parameter in input, but you need to
2550 specify a pointer to a list of supported pixel formats terminated by
2551 -1 in the opaque parameter provided to @code{avfilter_init_filter}
2552 when initializing this sink.
2556 Null video sink, do absolutely nothing with the input video. It is
2557 mainly useful as a template and to be employed in analysis / debugging
2560 @c man end VIDEO SINKS