Add erode libopencv filter.
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtergraph description
2 @c man begin FILTERGRAPH DESCRIPTION
3
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.
9
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.
13
14 A filter with no input pads is called a "source", a filter with no
15 output pads is called a "sink".
16
17 @section Filtergraph syntax
18
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{av_parse_graph()} function defined in
22 @file{libavfilter/avfiltergraph}.
23
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.
27
28 A filtergraph consists of a sequence of filterchains. A sequence of
29 filterchains is represented by a list of ";"-separated filterchain
30 descriptions.
31
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}]
34
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
39 "=@var{arguments}".
40
41 @var{arguments} is a string which contains the parameters used to
42 initialize the filter instance, and are described in the filter
43 descriptions below.
44
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.
50
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.
58
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
61 created.
62
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:
66 @example
67 nullsrc, split[L1], [L2]overlay, nullsink
68 @end example
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.
74
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.
78
79 Follows a BNF description for the filtergraph syntax:
80 @example
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}]
88 @end example
89
90 @c man end FILTERGRAPH DESCRIPTION
91
92 @chapter Audio Filters
93 @c man begin AUDIO FILTERS
94
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
98 build.
99
100 Below is a description of the currently available audio filters.
101
102 @section anull
103
104 Pass the audio source unchanged to the output.
105
106 @c man end AUDIO FILTERS
107
108 @chapter Audio Sources
109 @c man begin AUDIO SOURCES
110
111 Below is a description of the currently available audio sources.
112
113 @section anullsrc
114
115 Null audio source, never return audio frames. It is mainly useful as a
116 template and to be employed in analysis / debugging tools.
117
118 It accepts as optional parameter a string of the form
119 @var{sample_rate}:@var{channel_layout}.
120
121 @var{sample_rate} specify the sample rate, and defaults to 44100.
122
123 @var{channel_layout} specify the channel layout, and can be either an
124 integer or a string representing a channel layout. The default value
125 of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
126
127 Check the channel_layout_map definition in
128 @file{libavcodec/audioconvert.c} for the mapping between strings and
129 channel layout values.
130
131 Follow some examples:
132 @example
133 #  set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
134 anullsrc=48000:4
135
136 # same as
137 anullsrc=48000:mono
138 @end example
139
140 @c man end AUDIO SOURCES
141
142 @chapter Audio Sinks
143 @c man begin AUDIO SINKS
144
145 Below is a description of the currently available audio sinks.
146
147 @section anullsink
148
149 Null audio sink, do absolutely nothing with the input audio. It is
150 mainly useful as a template and to be employed in analysis / debugging
151 tools.
152
153 @c man end AUDIO SINKS
154
155 @chapter Video Filters
156 @c man begin VIDEO FILTERS
157
158 When you configure your FFmpeg build, you can disable any of the
159 existing filters using --disable-filters.
160 The configure output will show the video filters included in your
161 build.
162
163 Below is a description of the currently available video filters.
164
165 @section blackframe
166
167 Detect frames that are (almost) completely black. Can be useful to
168 detect chapter transitions or commercials. Output lines consist of
169 the frame number of the detected frame, the percentage of blackness,
170 the position in the file if known or -1 and the timestamp in seconds.
171
172 In order to display the output lines, you need to set the loglevel at
173 least to the AV_LOG_INFO value.
174
175 The filter accepts the syntax:
176 @example
177 blackframe[=@var{amount}:[@var{threshold}]]
178 @end example
179
180 @var{amount} is the percentage of the pixels that have to be below the
181 threshold, and defaults to 98.
182
183 @var{threshold} is the threshold below which a pixel value is
184 considered black, and defaults to 32.
185
186 @section crop
187
188 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
189
190 The parameters are expressions containing the following constants:
191
192 @table @option
193 @item E, PI, PHI
194 the corresponding mathematical approximated values for e
195 (euler number), pi (greek PI), PHI (golden ratio)
196
197 @item x, y
198 the computed values for @var{x} and @var{y}. They are evaluated for
199 each new frame.
200
201 @item in_w, in_h
202 the input width and heigth
203
204 @item iw, ih
205 same as @var{in_w} and @var{in_h}
206
207 @item out_w, out_h
208 the output (cropped) width and heigth
209
210 @item ow, oh
211 same as @var{out_w} and @var{out_h}
212
213 @item n
214 the number of input frame, starting from 0
215
216 @item pos
217 the position in the file of the input frame, NAN if unknown
218
219 @item t
220 timestamp expressed in seconds, NAN if the input timestamp is unknown
221
222 @end table
223
224 The @var{out_w} and @var{out_h} parameters specify the expressions for
225 the width and height of the output (cropped) video. They are
226 evaluated just at the configuration of the filter.
227
228 The default value of @var{out_w} is "in_w", and the default value of
229 @var{out_h} is "in_h".
230
231 The expression for @var{out_w} may depend on the value of @var{out_h},
232 and the expression for @var{out_h} may depend on @var{out_w}, but they
233 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
234 evaluated after @var{out_w} and @var{out_h}.
235
236 The @var{x} and @var{y} parameters specify the expressions for the
237 position of the top-left corner of the output (non-cropped) area. They
238 are evaluated for each frame. If the evaluated value is not valid, it
239 is approximated to the nearest valid value.
240
241 The default value of @var{x} is "(in_w-out_w)/2", and the default
242 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
243 the center of the input image.
244
245 The expression for @var{x} may depend on @var{y}, and the expression
246 for @var{y} may depend on @var{x}.
247
248 Follow some examples:
249 @example
250 # crop the central input area with size 100x100
251 crop=100:100
252
253 # crop the central input area with size 2/3 of the input video
254 "crop=2/3*in_w:2/3*in_h"
255
256 # crop the input video central square
257 crop=in_h
258
259 # delimit the rectangle with the top-left corner placed at position
260 # 100:100 and the right-bottom corner corresponding to the right-bottom
261 # corner of the input image.
262 crop=in_w-100:in_h-100:100:100
263
264 # crop 10 pixels from the lefth and right borders, and 20 pixels from
265 # the top and bottom borders
266 "crop=in_w-2*10:in_h-2*20"
267
268 # keep only the bottom right quarter of the input image
269 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
270
271 # crop height for getting Greek harmony
272 "crop=in_w:1/PHI*in_w"
273
274 # trembling effect
275 "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)"
276
277 # erratic camera effect depending on timestamp and position
278 "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)"
279
280 # set x depending on the value of y
281 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
282 @end example
283
284 @section cropdetect
285
286 Auto-detect crop size.
287
288 Calculate necessary cropping parameters and prints the recommended
289 parameters through the logging system. The detected dimensions
290 correspond to the non-black area of the input video.
291
292 It accepts the syntax:
293 @example
294 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
295 @end example
296
297 @table @option
298
299 @item limit
300 Threshold, which can be optionally specified from nothing (0) to
301 everything (255), defaults to 24.
302
303 @item round
304 Value which the width/height should be divisible by, defaults to
305 16. The offset is automatically adjusted to center the video. Use 2 to
306 get only even dimensions (needed for 4:2:2 video). 16 is best when
307 encoding to most video codecs.
308
309 @item reset
310 Counter that determines after how many frames cropdetect will reset
311 the previously detected largest video area and start over to detect
312 the current optimal crop area. Defaults to 0.
313
314 This can be useful when channel logos distort the video area. 0
315 indicates never reset and return the largest area encountered during
316 playback.
317 @end table
318
319 @section drawbox
320
321 Draw a colored box on the input image.
322
323 It accepts the syntax:
324 @example
325 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
326 @end example
327
328 @table @option
329
330 @item x, y
331 Specify the top left corner coordinates of the box. Default to 0.
332
333 @item width, height
334 Specify the width and height of the box, if 0 they are interpreted as
335 the input width and height. Default to 0.
336
337 @item color
338 Specify the color of the box to write, it can be the name of a color
339 (case insensitive match) or a 0xRRGGBB[AA] sequence.
340 @end table
341
342 Follow some examples:
343 @example
344 # draw a black box around the edge of the input image
345 drawbox
346
347 # draw a box with color red and an opacity of 50%
348 drawbox=10:20:200:60:red@@0.5"
349 @end example
350
351 @section fifo
352
353 Buffer input images and send them when they are requested.
354
355 This filter is mainly useful when auto-inserted by the libavfilter
356 framework.
357
358 The filter does not take parameters.
359
360 @section format
361
362 Convert the input video to one of the specified pixel formats.
363 Libavfilter will try to pick one that is supported for the input to
364 the next filter.
365
366 The filter accepts a list of pixel format names, separated by ":",
367 for example "yuv420p:monow:rgb24".
368
369 The following command:
370
371 @example
372 ./ffmpeg -i in.avi -vf "format=yuv420p" out.avi
373 @end example
374
375 will convert the input video to the format "yuv420p".
376
377 @anchor{frei0r}
378 @section frei0r
379
380 Apply a frei0r effect to the input video.
381
382 To enable compilation of this filter you need to install the frei0r
383 header and configure FFmpeg with --enable-frei0r.
384
385 The filter supports the syntax:
386 @example
387 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
388 @end example
389
390 @var{filter_name} is the name to the frei0r effect to load. If the
391 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
392 is searched in each one of the directories specified by the colon
393 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
394 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
395 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
396
397 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
398 for the frei0r effect.
399
400 A frei0r effect parameter can be a boolean (whose values are specified
401 with "y" and "n"), a double, a color (specified by the syntax
402 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
403 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
404 description), a position (specified by the syntax @var{X}/@var{Y},
405 @var{X} and @var{Y} being float numbers) and a string.
406
407 The number and kind of parameters depend on the loaded effect. If an
408 effect parameter is not specified the default value is set.
409
410 Some examples follow:
411 @example
412 # apply the distort0r effect, set the first two double parameters
413 frei0r=distort0r:0.5:0.01
414
415 # apply the colordistance effect, takes a color as first parameter
416 frei0r=colordistance:0.2/0.3/0.4
417 frei0r=colordistance:violet
418 frei0r=colordistance:0x112233
419
420 # apply the perspective effect, specify the top left and top right
421 # image positions
422 frei0r=perspective:0.2/0.2:0.8/0.2
423 @end example
424
425 For more information see:
426 @url{http://piksel.org/frei0r}
427
428 @section gradfun
429
430 Fix the banding artifacts that are sometimes introduced into nearly flat
431 regions by truncation to 8bit colordepth.
432 Interpolate the gradients that should go where the bands are, and
433 dither them.
434
435 The filter takes two optional parameters, separated by ':':
436 @var{strength}:@var{radius}
437
438 @var{strength} is the maximum amount by which the filter will change
439 any one pixel. Also the threshold for detecting nearly flat
440 regions. Acceptable values range from .51 to 255, default value is
441 1.2, out-of-range values will be clipped to the valid range.
442
443 @var{radius} is the neighborhood to fit the gradient to. A larger
444 radius makes for smoother gradients, but also prevents the filter from
445 modifying the pixels near detailed regions. Acceptable values are
446 8-32, default value is 16, out-of-range values will be clipped to the
447 valid range.
448
449 @example
450 # default parameters
451 gradfun=1.2:16
452
453 # omitting radius
454 gradfun=1.2
455 @end example
456
457 @section hflip
458
459 Flip the input video horizontally.
460
461 For example to horizontally flip the video in input with
462 @file{ffmpeg}:
463 @example
464 ffmpeg -i in.avi -vf "hflip" out.avi
465 @end example
466
467 @section hqdn3d
468
469 High precision/quality 3d denoise filter. This filter aims to reduce
470 image noise producing smooth images and making still images really
471 still. It should enhance compressibility.
472
473 It accepts the following optional parameters:
474 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
475
476 @table @option
477 @item luma_spatial
478 a non-negative float number which specifies spatial luma strength,
479 defaults to 4.0
480
481 @item chroma_spatial
482 a non-negative float number which specifies spatial chroma strength,
483 defaults to 3.0*@var{luma_spatial}/4.0
484
485 @item luma_tmp
486 a float number which specifies luma temporal strength, defaults to
487 6.0*@var{luma_spatial}/4.0
488
489 @item chroma_tmp
490 a float number which specifies chroma temporal strength, defaults to
491 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
492 @end table
493
494 @section noformat
495
496 Force libavfilter not to use any of the specified pixel formats for the
497 input to the next filter.
498
499 The filter accepts a list of pixel format names, separated by ":",
500 for example "yuv420p:monow:rgb24".
501
502 The following command:
503
504 @example
505 ./ffmpeg -i in.avi -vf "noformat=yuv420p, vflip" out.avi
506 @end example
507
508 will make libavfilter use a format different from "yuv420p" for the
509 input to the vflip filter.
510
511 @section null
512
513 Pass the video source unchanged to the output.
514
515 @section ocv
516
517 Apply video transform using libopencv.
518
519 To enable this filter install libopencv library and headers and
520 configure FFmpeg with --enable-libopencv.
521
522 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
523
524 @var{filter_name} is the name of the libopencv filter to apply.
525
526 @var{filter_params} specifies the parameters to pass to the libopencv
527 filter. If not specified the default values are assumed.
528
529 Refer to the official libopencv documentation for more precise
530 informations:
531 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
532
533 Follows the list of supported libopencv filters.
534
535 @anchor{dilate}
536 @subsection dilate
537
538 Dilate an image by using a specific structuring element.
539 This filter corresponds to the libopencv function @code{cvDilate}.
540
541 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
542
543 @var{struct_el} represents a structuring element, and has the syntax:
544 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
545
546 @var{cols} and @var{rows} represent the number of colums and rows of
547 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
548 point, and @var{shape} the shape for the structuring element, and
549 can be one of the values "rect", "cross", "ellipse", "custom".
550
551 If the value for @var{shape} is "custom", it must be followed by a
552 string of the form "=@var{filename}". The file with name
553 @var{filename} is assumed to represent a binary image, with each
554 printable character corresponding to a bright pixel. When a custom
555 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
556 or columns and rows of the read file are assumed instead.
557
558 The default value for @var{struct_el} is "3x3+0x0/rect".
559
560 @var{nb_iterations} specifies the number of times the transform is
561 applied to the image, and defaults to 1.
562
563 Follow some example:
564 @example
565 # use the default values
566 ocv=dilate
567
568 # dilate using a structuring element with a 5x5 cross, iterate two times
569 ocv=dilate=5x5+2x2/cross:2
570
571 # read the shape from the file diamond.shape, iterate two times
572 # the file diamond.shape may contain a pattern of characters like this:
573 #   *
574 #  ***
575 # *****
576 #  ***
577 #   *
578 # the specified cols and rows are ignored (but not the anchor point coordinates)
579 ocv=0x0+2x2/custom=diamond.shape:2
580 @end example
581
582 @subsection erode
583
584 Erode an image by using a specific structuring element.
585 This filter corresponds to the libopencv function @code{cvErode}.
586
587 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
588 with the same meaning and use of those of the dilate filter
589 (@pxref{dilate}).
590
591 @subsection smooth
592
593 Smooth the input video.
594
595 The filter takes the following parameters:
596 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
597
598 @var{type} is the type of smooth filter to apply, and can be one of
599 the following values: "blur", "blur_no_scale", "median", "gaussian",
600 "bilateral". The default value is "gaussian".
601
602 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
603 parameters whose meanings depend on smooth type. @var{param1} and
604 @var{param2} accept integer positive values or 0, @var{param3} and
605 @var{param4} accept float values.
606
607 The default value for @var{param1} is 3, the default value for the
608 other parameters is 0.
609
610 These parameters correspond to the parameters assigned to the
611 libopencv function @code{cvSmooth}.
612
613 @section overlay
614
615 Overlay one video on top of another.
616
617 It takes two inputs and one output, the first input is the "main"
618 video on which the second input is overlayed.
619
620 It accepts the parameters: @var{x}:@var{y}.
621
622 @var{x} is the x coordinate of the overlayed video on the main video,
623 @var{y} is the y coordinate. The parameters are expressions containing
624 the following parameters:
625
626 @table @option
627 @item main_w, main_h
628 main input width and height
629
630 @item W, H
631 same as @var{main_w} and @var{main_h}
632
633 @item overlay_w, overlay_h
634 overlay input width and height
635
636 @item w, h
637 same as @var{overlay_w} and @var{overlay_h}
638 @end table
639
640 Be aware that frames are taken from each input video in timestamp
641 order, hence, if their initial timestamps differ, it is a a good idea
642 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
643 have them begin in the same zero timestamp, as it does the example for
644 the @var{movie} filter.
645
646 Follow some examples:
647 @example
648 # draw the overlay at 10 pixels from the bottom right
649 # corner of the main video.
650 overlay=main_w-overlay_w-10:main_h-overlay_h-10
651
652 # insert a transparent PNG logo in the bottom left corner of the input
653 movie=0:png:logo.png [logo];
654 [in][logo] overlay=10:main_h-overlay_h-10 [out]
655
656 # insert 2 different transparent PNG logos (second logo on bottom
657 # right corner):
658 movie=0:png:logo1.png [logo1];
659 movie=0:png:logo2.png [logo2];
660 [in][logo1]       overlay=10:H-h-10 [in+logo1];
661 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
662
663 # add a transparent color layer on top of the main video,
664 # WxH specifies the size of the main input to the overlay filter
665 color=red@.3:WxH [over]; [in][over] overlay [out]
666 @end example
667
668 You can chain togheter more overlays but the efficiency of such
669 approach is yet to be tested.
670
671 @section pad
672
673 Add paddings to the input image, and places the original input at the
674 given coordinates @var{x}, @var{y}.
675
676 It accepts the following parameters:
677 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
678
679 Follows the description of the accepted parameters.
680
681 @table @option
682 @item width, height
683
684 Specify the size of the output image with the paddings added. If the
685 value for @var{width} or @var{height} is 0, the corresponding input size
686 is used for the output.
687
688 The default value of @var{width} and @var{height} is 0.
689
690 @item x, y
691
692 Specify the offsets where to place the input image in the padded area
693 with respect to the top/left border of the output image.
694
695 The default value of @var{x} and @var{y} is 0.
696
697 @item color
698
699 Specify the color of the padded area, it can be the name of a color
700 (case insensitive match) or a 0xRRGGBB[AA] sequence.
701
702 The default value of @var{color} is "black".
703
704 @end table
705
706 For example:
707
708 @example
709 # Add paddings with color "violet" to the input video. Output video
710 # size is 640x480, the top-left corner of the input video is placed at
711 # row 0, column 40.
712 pad=640:480:0:40:violet
713 @end example
714
715 @section pixdesctest
716
717 Pixel format descriptor test filter, mainly useful for internal
718 testing. The output video should be equal to the input video.
719
720 For example:
721 @example
722 format=monow, pixdesctest
723 @end example
724
725 can be used to test the monowhite pixel format descriptor definition.
726
727 @section scale
728
729 Scale the input video to @var{width}:@var{height} and/or convert the image format.
730
731 For example the command:
732
733 @example
734 ./ffmpeg -i in.avi -vf "scale=200:100" out.avi
735 @end example
736
737 will scale the input video to a size of 200x100.
738
739 If the input image format is different from the format requested by
740 the next filter, the scale filter will convert the input to the
741 requested format.
742
743 If the value for @var{width} or @var{height} is 0, the respective input
744 size is used for the output.
745
746 If the value for @var{width} or @var{height} is -1, the scale filter will
747 use, for the respective output size, a value that maintains the aspect
748 ratio of the input image.
749
750 The default value of @var{width} and @var{height} is 0.
751
752 @section setpts
753
754 Change the PTS (presentation timestamp) of the input video frames.
755
756 Accept in input an expression evaluated through the eval API, which
757 can contain the following constants:
758
759 @table @option
760 @item PTS
761 the presentation timestamp in input
762
763 @item PI
764 Greek PI
765
766 @item PHI
767 golden ratio
768
769 @item E
770 Euler number
771
772 @item N
773 the count of the input frame, starting from 0.
774
775 @item STARTPTS
776 the PTS of the first video frame
777
778 @item INTERLACED
779 tell if the current frame is interlaced
780
781 @item POS
782 original position in the file of the frame, or undefined if undefined
783 for the current frame
784
785 @item PREV_INPTS
786 previous input PTS
787
788 @item PREV_OUTPTS
789 previous output PTS
790
791 @end table
792
793 Some examples follow:
794
795 @example
796 # start counting PTS from zero
797 setpts=PTS-STARTPTS
798
799 # fast motion
800 setpts=0.5*PTS
801
802 # slow motion
803 setpts=2.0*PTS
804
805 # fixed rate 25 fps
806 setpts=N/(25*TB)
807
808 # fixed rate 25 fps with some jitter
809 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
810 @end example
811
812 @section settb
813
814 Set the timebase to use for the output frames timestamps.
815 It is mainly useful for testing timebase configuration.
816
817 It accepts in input an arithmetic expression representing a rational.
818 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
819 default timebase), and "intb" (the input timebase).
820
821 The default value for the input is "intb".
822
823 Follow some examples.
824
825 @example
826 # set the timebase to 1/25
827 settb=1/25
828
829 # set the timebase to 1/10
830 settb=0.1
831
832 #set the timebase to 1001/1000
833 settb=1+0.001
834
835 #set the timebase to 2*intb
836 settb=2*intb
837
838 #set the default timebase value
839 settb=AVTB
840 @end example
841
842 @section slicify
843
844 Pass the images of input video on to next video filter as multiple
845 slices.
846
847 @example
848 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
849 @end example
850
851 The filter accepts the slice height as parameter. If the parameter is
852 not specified it will use the default value of 16.
853
854 Adding this in the beginning of filter chains should make filtering
855 faster due to better use of the memory cache.
856
857 @section transpose
858
859 Transpose rows with columns in the input video and optionally flip it.
860
861 It accepts a parameter representing an integer, which can assume the
862 values:
863
864 @table @samp
865 @item 0
866 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
867 @example
868 L.R     L.l
869 . . ->  . .
870 l.r     R.r
871 @end example
872
873 @item 1
874 Rotate by 90 degrees clockwise, that is:
875 @example
876 L.R     l.L
877 . . ->  . .
878 l.r     r.R
879 @end example
880
881 @item 2
882 Rotate by 90 degrees counterclockwise, that is:
883 @example
884 L.R     R.r
885 . . ->  . .
886 l.r     L.l
887 @end example
888
889 @item 3
890 Rotate by 90 degrees clockwise and vertically flip, that is:
891 @example
892 L.R     r.R
893 . . ->  . .
894 l.r     l.L
895 @end example
896 @end table
897
898 @section unsharp
899
900 Sharpen or blur the input video.
901
902 It accepts the following parameters:
903 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
904
905 Negative values for the amount will blur the input video, while positive
906 values will sharpen. All parameters are optional and default to the
907 equivalent of the string '5:5:1.0:0:0:0.0'.
908
909 @table @option
910
911 @item luma_msize_x
912 Set the luma matrix horizontal size. It can be an integer between 3
913 and 13, default value is 5.
914
915 @item luma_msize_y
916 Set the luma matrix vertical size. It can be an integer between 3
917 and 13, default value is 5.
918
919 @item luma_amount
920 Set the luma effect strength. It can be a float number between -2.0
921 and 5.0, default value is 1.0.
922
923 @item chroma_msize_x
924 Set the chroma matrix horizontal size. It can be an integer between 3
925 and 13, default value is 0.
926
927 @item chroma_msize_y
928 Set the chroma matrix vertical size. It can be an integer between 3
929 and 13, default value is 0.
930
931 @item luma_amount
932 Set the chroma effect strength. It can be a float number between -2.0
933 and 5.0, default value is 0.0.
934
935 @end table
936
937 @example
938 # Strong luma sharpen effect parameters
939 unsharp=7:7:2.5
940
941 # Strong blur of both luma and chroma parameters
942 unsharp=7:7:-2:7:7:-2
943
944 # Use the default values with @command{ffmpeg}
945 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
946 @end example
947
948 @section vflip
949
950 Flip the input video vertically.
951
952 @example
953 ./ffmpeg -i in.avi -vf "vflip" out.avi
954 @end example
955
956 @section yadif
957
958 Deinterlace the input video ("yadif" means "yet another deinterlacing
959 filter").
960
961 It accepts the optional parameters: @var{mode}:@var{parity}.
962
963 @var{mode} specifies the interlacing mode to adopt, accepts one of the
964 following values:
965
966 @table @option
967 @item 0
968 output 1 frame for each frame
969 @item 1
970 output 1 frame for each field
971 @item 2
972 like 0 but skips spatial interlacing check
973 @item 3
974 like 1 but skips spatial interlacing check
975 @end table
976
977 Default value is 0.
978
979 @var{parity} specifies the picture field parity assumed for the input
980 interlaced video, accepts one of the following values:
981
982 @table @option
983 @item 0
984 assume bottom field first
985 @item 1
986 assume top field first
987 @item -1
988 enable automatic detection
989 @end table
990
991 Default value is -1.
992
993 @c man end VIDEO FILTERS
994
995 @chapter Video Sources
996 @c man begin VIDEO SOURCES
997
998 Below is a description of the currently available video sources.
999
1000 @section buffer
1001
1002 Buffer video frames, and make them available to the filter chain.
1003
1004 This source is mainly intended for a programmatic use, in particular
1005 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
1006
1007 It accepts the following parameters:
1008 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}
1009
1010 All the parameters need to be explicitely defined.
1011
1012 Follows the list of the accepted parameters.
1013
1014 @table @option
1015
1016 @item width, height
1017 Specify the width and height of the buffered video frames.
1018
1019 @item pix_fmt_string
1020 A string representing the pixel format of the buffered video frames.
1021 It may be a number corresponding to a pixel format, or a pixel format
1022 name.
1023
1024 @item timebase_num, timebase_den
1025 Specify numerator and denomitor of the timebase assumed by the
1026 timestamps of the buffered frames.
1027 @end table
1028
1029 For example:
1030 @example
1031 buffer=320:240:yuv410p:1:24
1032 @end example
1033
1034 will instruct the source to accept video frames with size 320x240 and
1035 with format "yuv410p" and assuming 1/24 as the timestamps timebase.
1036 Since the pixel format with name "yuv410p" corresponds to the number 6
1037 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
1038 this example corresponds to:
1039 @example
1040 buffer=320:240:6:1:24
1041 @end example
1042
1043 @section color
1044
1045 Provide an uniformly colored input.
1046
1047 It accepts the following parameters:
1048 @var{color}:@var{frame_size}:@var{frame_rate}
1049
1050 Follows the description of the accepted parameters.
1051
1052 @table @option
1053
1054 @item color
1055 Specify the color of the source. It can be the name of a color (case
1056 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
1057 alpha specifier. The default value is "black".
1058
1059 @item frame_size
1060 Specify the size of the sourced video, it may be a string of the form
1061 @var{width}x@var{heigth}, or the name of a size abbreviation. The
1062 default value is "320x240".
1063
1064 @item frame_rate
1065 Specify the frame rate of the sourced video, as the number of frames
1066 generated per second. It has to be a string in the format
1067 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
1068 number or a valid video frame rate abbreviation. The default value is
1069 "25".
1070
1071 @end table
1072
1073 For example the following graph description will generate a red source
1074 with an opacity of 0.2, with size "qcif" and a frame rate of 10
1075 frames per second, which will be overlayed over the source connected
1076 to the pad with identifier "in".
1077
1078 @example
1079 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
1080 @end example
1081
1082 @section nullsrc
1083
1084 Null video source, never return images. It is mainly useful as a
1085 template and to be employed in analysis / debugging tools.
1086
1087 It accepts as optional parameter a string of the form
1088 @var{width}:@var{height}:@var{timebase}.
1089
1090 @var{width} and @var{height} specify the size of the configured
1091 source. The default values of @var{width} and @var{height} are
1092 respectively 352 and 288 (corresponding to the CIF size format).
1093
1094 @var{timebase} specifies an arithmetic expression representing a
1095 timebase. The expression can contain the constants "PI", "E", "PHI",
1096 "AVTB" (the default timebase), and defaults to the value "AVTB".
1097
1098 @section frei0r_src
1099
1100 Provide a frei0r source.
1101
1102 To enable compilation of this filter you need to install the frei0r
1103 header and configure FFmpeg with --enable-frei0r.
1104
1105 The source supports the syntax:
1106 @example
1107 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
1108 @end example
1109
1110 @var{size} is the size of the video to generate, may be a string of the
1111 form @var{width}x@var{height} or a frame size abbreviation.
1112 @var{rate} is the rate of the video to generate, may be a string of
1113 the form @var{num}/@var{den} or a frame rate abbreviation.
1114 @var{src_name} is the name to the frei0r source to load. For more
1115 information regarding frei0r and how to set the parameters read the
1116 section "frei0r" (@pxref{frei0r}) in the description of the video
1117 filters.
1118
1119 Some examples follow:
1120 @example
1121 # generate a frei0r partik0l source with size 200x200 and framerate 10
1122 # which is overlayed on the overlay filter main input
1123 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
1124 @end example
1125
1126 @c man end VIDEO SOURCES
1127
1128 @chapter Video Sinks
1129 @c man begin VIDEO SINKS
1130
1131 Below is a description of the currently available video sinks.
1132
1133 @section nullsink
1134
1135 Null video sink, do absolutely nothing with the input video. It is
1136 mainly useful as a template and to be employed in analysis / debugging
1137 tools.
1138
1139 @c man end VIDEO SINKS
1140