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