c2e5aed84c8d65120755dcdf906428f2ea40c479
[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 Libav 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 Libav 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 left 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
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 fade
357
358 Apply fade-in/out effect to input video.
359
360 It accepts the parameters:
361 @var{type}:@var{start_frame}:@var{nb_frames}
362
363 @var{type} specifies if the effect type, can be either "in" for
364 fade-in, or "out" for a fade-out effect.
365
366 @var{start_frame} specifies the number of the start frame for starting
367 to apply the fade effect.
368
369 @var{nb_frames} specifies the number of frames for which the fade
370 effect has to last. At the end of the fade-in effect the output video
371 will have the same intensity as the input video, at the end of the
372 fade-out transition the output video will be completely black.
373
374 A few usage examples follow, usable too as test scenarios.
375 @example
376 # fade in first 30 frames of video
377 fade=in:0:30
378
379 # fade out last 45 frames of a 200-frame video
380 fade=out:155:45
381
382 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
383 fade=in:0:25, fade=out:975:25
384
385 # make first 5 frames black, then fade in from frame 5-24
386 fade=in:5:20
387 @end example
388
389 @section fifo
390
391 Buffer input images and send them when they are requested.
392
393 This filter is mainly useful when auto-inserted by the libavfilter
394 framework.
395
396 The filter does not take parameters.
397
398 @section format
399
400 Convert the input video to one of the specified pixel formats.
401 Libavfilter will try to pick one that is supported for the input to
402 the next filter.
403
404 The filter accepts a list of pixel format names, separated by ":",
405 for example "yuv420p:monow:rgb24".
406
407 Some examples follow:
408 @example
409 # convert the input video to the format "yuv420p"
410 format=yuv420p
411
412 # convert the input video to any of the formats in the list
413 format=yuv420p:yuv444p:yuv410p
414 @end example
415
416 @anchor{frei0r}
417 @section frei0r
418
419 Apply a frei0r effect to the input video.
420
421 To enable compilation of this filter you need to install the frei0r
422 header and configure Libav with --enable-frei0r.
423
424 The filter supports the syntax:
425 @example
426 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
427 @end example
428
429 @var{filter_name} is the name to the frei0r effect to load. If the
430 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
431 is searched in each one of the directories specified by the colon
432 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
433 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
434 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
435
436 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
437 for the frei0r effect.
438
439 A frei0r effect parameter can be a boolean (whose values are specified
440 with "y" and "n"), a double, a color (specified by the syntax
441 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
442 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
443 description), a position (specified by the syntax @var{X}/@var{Y},
444 @var{X} and @var{Y} being float numbers) and a string.
445
446 The number and kind of parameters depend on the loaded effect. If an
447 effect parameter is not specified the default value is set.
448
449 Some examples follow:
450 @example
451 # apply the distort0r effect, set the first two double parameters
452 frei0r=distort0r:0.5:0.01
453
454 # apply the colordistance effect, takes a color as first parameter
455 frei0r=colordistance:0.2/0.3/0.4
456 frei0r=colordistance:violet
457 frei0r=colordistance:0x112233
458
459 # apply the perspective effect, specify the top left and top right
460 # image positions
461 frei0r=perspective:0.2/0.2:0.8/0.2
462 @end example
463
464 For more information see:
465 @url{http://piksel.org/frei0r}
466
467 @section gradfun
468
469 Fix the banding artifacts that are sometimes introduced into nearly flat
470 regions by truncation to 8bit colordepth.
471 Interpolate the gradients that should go where the bands are, and
472 dither them.
473
474 This filter is designed for playback only.  Do not use it prior to
475 lossy compression, because compression tends to lose the dither and
476 bring back the bands.
477
478 The filter takes two optional parameters, separated by ':':
479 @var{strength}:@var{radius}
480
481 @var{strength} is the maximum amount by which the filter will change
482 any one pixel. Also the threshold for detecting nearly flat
483 regions. Acceptable values range from .51 to 255, default value is
484 1.2, out-of-range values will be clipped to the valid range.
485
486 @var{radius} is the neighborhood to fit the gradient to. A larger
487 radius makes for smoother gradients, but also prevents the filter from
488 modifying the pixels near detailed regions. Acceptable values are
489 8-32, default value is 16, out-of-range values will be clipped to the
490 valid range.
491
492 @example
493 # default parameters
494 gradfun=1.2:16
495
496 # omitting radius
497 gradfun=1.2
498 @end example
499
500 @section hflip
501
502 Flip the input video horizontally.
503
504 For example to horizontally flip the video in input with
505 @file{ffmpeg}:
506 @example
507 ffmpeg -i in.avi -vf "hflip" out.avi
508 @end example
509
510 @section hqdn3d
511
512 High precision/quality 3d denoise filter. This filter aims to reduce
513 image noise producing smooth images and making still images really
514 still. It should enhance compressibility.
515
516 It accepts the following optional parameters:
517 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
518
519 @table @option
520 @item luma_spatial
521 a non-negative float number which specifies spatial luma strength,
522 defaults to 4.0
523
524 @item chroma_spatial
525 a non-negative float number which specifies spatial chroma strength,
526 defaults to 3.0*@var{luma_spatial}/4.0
527
528 @item luma_tmp
529 a float number which specifies luma temporal strength, defaults to
530 6.0*@var{luma_spatial}/4.0
531
532 @item chroma_tmp
533 a float number which specifies chroma temporal strength, defaults to
534 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
535 @end table
536
537 @section noformat
538
539 Force libavfilter not to use any of the specified pixel formats for the
540 input to the next filter.
541
542 The filter accepts a list of pixel format names, separated by ":",
543 for example "yuv420p:monow:rgb24".
544
545 Some examples follow:
546 @example
547 # force libavfilter to use a format different from "yuv420p" for the
548 # input to the vflip filter
549 noformat=yuv420p,vflip
550
551 # convert the input video to any of the formats not contained in the list
552 noformat=yuv420p:yuv444p:yuv410p
553 @end example
554
555 @section null
556
557 Pass the video source unchanged to the output.
558
559 @section ocv
560
561 Apply video transform using libopencv.
562
563 To enable this filter install libopencv library and headers and
564 configure Libav with --enable-libopencv.
565
566 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
567
568 @var{filter_name} is the name of the libopencv filter to apply.
569
570 @var{filter_params} specifies the parameters to pass to the libopencv
571 filter. If not specified the default values are assumed.
572
573 Refer to the official libopencv documentation for more precise
574 informations:
575 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
576
577 Follows the list of supported libopencv filters.
578
579 @anchor{dilate}
580 @subsection dilate
581
582 Dilate an image by using a specific structuring element.
583 This filter corresponds to the libopencv function @code{cvDilate}.
584
585 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
586
587 @var{struct_el} represents a structuring element, and has the syntax:
588 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
589
590 @var{cols} and @var{rows} represent the number of colums and rows of
591 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
592 point, and @var{shape} the shape for the structuring element, and
593 can be one of the values "rect", "cross", "ellipse", "custom".
594
595 If the value for @var{shape} is "custom", it must be followed by a
596 string of the form "=@var{filename}". The file with name
597 @var{filename} is assumed to represent a binary image, with each
598 printable character corresponding to a bright pixel. When a custom
599 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
600 or columns and rows of the read file are assumed instead.
601
602 The default value for @var{struct_el} is "3x3+0x0/rect".
603
604 @var{nb_iterations} specifies the number of times the transform is
605 applied to the image, and defaults to 1.
606
607 Follow some example:
608 @example
609 # use the default values
610 ocv=dilate
611
612 # dilate using a structuring element with a 5x5 cross, iterate two times
613 ocv=dilate=5x5+2x2/cross:2
614
615 # read the shape from the file diamond.shape, iterate two times
616 # the file diamond.shape may contain a pattern of characters like this:
617 #   *
618 #  ***
619 # *****
620 #  ***
621 #   *
622 # the specified cols and rows are ignored (but not the anchor point coordinates)
623 ocv=0x0+2x2/custom=diamond.shape:2
624 @end example
625
626 @subsection erode
627
628 Erode an image by using a specific structuring element.
629 This filter corresponds to the libopencv function @code{cvErode}.
630
631 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
632 with the same meaning and use of those of the dilate filter
633 (@pxref{dilate}).
634
635 @subsection smooth
636
637 Smooth the input video.
638
639 The filter takes the following parameters:
640 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
641
642 @var{type} is the type of smooth filter to apply, and can be one of
643 the following values: "blur", "blur_no_scale", "median", "gaussian",
644 "bilateral". The default value is "gaussian".
645
646 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
647 parameters whose meanings depend on smooth type. @var{param1} and
648 @var{param2} accept integer positive values or 0, @var{param3} and
649 @var{param4} accept float values.
650
651 The default value for @var{param1} is 3, the default value for the
652 other parameters is 0.
653
654 These parameters correspond to the parameters assigned to the
655 libopencv function @code{cvSmooth}.
656
657 @section overlay
658
659 Overlay one video on top of another.
660
661 It takes two inputs and one output, the first input is the "main"
662 video on which the second input is overlayed.
663
664 It accepts the parameters: @var{x}:@var{y}.
665
666 @var{x} is the x coordinate of the overlayed video on the main video,
667 @var{y} is the y coordinate. The parameters are expressions containing
668 the following parameters:
669
670 @table @option
671 @item main_w, main_h
672 main input width and height
673
674 @item W, H
675 same as @var{main_w} and @var{main_h}
676
677 @item overlay_w, overlay_h
678 overlay input width and height
679
680 @item w, h
681 same as @var{overlay_w} and @var{overlay_h}
682 @end table
683
684 Be aware that frames are taken from each input video in timestamp
685 order, hence, if their initial timestamps differ, it is a a good idea
686 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
687 have them begin in the same zero timestamp, as it does the example for
688 the @var{movie} filter.
689
690 Follow some examples:
691 @example
692 # draw the overlay at 10 pixels from the bottom right
693 # corner of the main video.
694 overlay=main_w-overlay_w-10:main_h-overlay_h-10
695
696 # insert a transparent PNG logo in the bottom left corner of the input
697 movie=logo.png [logo];
698 [in][logo] overlay=10:main_h-overlay_h-10 [out]
699
700 # insert 2 different transparent PNG logos (second logo on bottom
701 # right corner):
702 movie=logo1.png [logo1];
703 movie=logo2.png [logo2];
704 [in][logo1]       overlay=10:H-h-10 [in+logo1];
705 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
706
707 # add a transparent color layer on top of the main video,
708 # WxH specifies the size of the main input to the overlay filter
709 color=red@.3:WxH [over]; [in][over] overlay [out]
710 @end example
711
712 You can chain togheter more overlays but the efficiency of such
713 approach is yet to be tested.
714
715 @section pad
716
717 Add paddings to the input image, and places the original input at the
718 given coordinates @var{x}, @var{y}.
719
720 It accepts the following parameters:
721 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
722
723 Follows the description of the accepted parameters.
724
725 @table @option
726 @item width, height
727
728 Specify the size of the output image with the paddings added. If the
729 value for @var{width} or @var{height} is 0, the corresponding input size
730 is used for the output.
731
732 The default value of @var{width} and @var{height} is 0.
733
734 @item x, y
735
736 Specify the offsets where to place the input image in the padded area
737 with respect to the top/left border of the output image.
738
739 The default value of @var{x} and @var{y} is 0.
740
741 @item color
742
743 Specify the color of the padded area, it can be the name of a color
744 (case insensitive match) or a 0xRRGGBB[AA] sequence.
745
746 The default value of @var{color} is "black".
747
748 @end table
749
750 For example:
751
752 @example
753 # Add paddings with color "violet" to the input video. Output video
754 # size is 640x480, the top-left corner of the input video is placed at
755 # row 0, column 40.
756 pad=640:480:0:40:violet
757 @end example
758
759 @section pixdesctest
760
761 Pixel format descriptor test filter, mainly useful for internal
762 testing. The output video should be equal to the input video.
763
764 For example:
765 @example
766 format=monow, pixdesctest
767 @end example
768
769 can be used to test the monowhite pixel format descriptor definition.
770
771 @section scale
772
773 Scale the input video to @var{width}:@var{height} and/or convert the image format.
774
775 For example the command:
776
777 @example
778 ./ffmpeg -i in.avi -vf "scale=200:100" out.avi
779 @end example
780
781 will scale the input video to a size of 200x100.
782
783 If the input image format is different from the format requested by
784 the next filter, the scale filter will convert the input to the
785 requested format.
786
787 If the value for @var{width} or @var{height} is 0, the respective input
788 size is used for the output.
789
790 If the value for @var{width} or @var{height} is -1, the scale filter will
791 use, for the respective output size, a value that maintains the aspect
792 ratio of the input image.
793
794 The default value of @var{width} and @var{height} is 0.
795
796 @anchor{setdar}
797 @section setdar
798
799 Set the Display Aspect Ratio for the filter output video.
800
801 This is done by changing the specified Sample (aka Pixel) Aspect
802 Ratio, according to the following equation:
803 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
804
805 Keep in mind that this filter does not modify the pixel dimensions of
806 the video frame. Also the display aspect ratio set by this filter may
807 be changed by later filters in the filterchain, e.g. in case of
808 scaling or if another "setdar" or a "setsar" filter is applied.
809
810 The filter accepts a parameter string which represents the wanted
811 display aspect ratio.
812 The parameter can be a floating point number string, or an expression
813 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
814 numerator and denominator of the aspect ratio.
815 If the parameter is not specified, it is assumed the value "0:1".
816
817 For example to change the display aspect ratio to 16:9, specify:
818 @example
819 setdar=16:9
820 # the above is equivalent to
821 setdar=1.77777
822 @end example
823
824 See also the "setsar" filter documentation (@pxref{setsar}).
825
826 @section setpts
827
828 Change the PTS (presentation timestamp) of the input video frames.
829
830 Accept in input an expression evaluated through the eval API, which
831 can contain the following constants:
832
833 @table @option
834 @item PTS
835 the presentation timestamp in input
836
837 @item PI
838 Greek PI
839
840 @item PHI
841 golden ratio
842
843 @item E
844 Euler number
845
846 @item N
847 the count of the input frame, starting from 0.
848
849 @item STARTPTS
850 the PTS of the first video frame
851
852 @item INTERLACED
853 tell if the current frame is interlaced
854
855 @item POS
856 original position in the file of the frame, or undefined if undefined
857 for the current frame
858
859 @item PREV_INPTS
860 previous input PTS
861
862 @item PREV_OUTPTS
863 previous output PTS
864
865 @end table
866
867 Some examples follow:
868
869 @example
870 # start counting PTS from zero
871 setpts=PTS-STARTPTS
872
873 # fast motion
874 setpts=0.5*PTS
875
876 # slow motion
877 setpts=2.0*PTS
878
879 # fixed rate 25 fps
880 setpts=N/(25*TB)
881
882 # fixed rate 25 fps with some jitter
883 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
884 @end example
885
886 @anchor{setsar}
887 @section setsar
888
889 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
890
891 Note that as a consequence of the application of this filter, the
892 output display aspect ratio will change according to the following
893 equation:
894 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
895
896 Keep in mind that the sample aspect ratio set by this filter may be
897 changed by later filters in the filterchain, e.g. if another "setsar"
898 or a "setdar" filter is applied.
899
900 The filter accepts a parameter string which represents the wanted
901 sample aspect ratio.
902 The parameter can be a floating point number string, or an expression
903 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
904 numerator and denominator of the aspect ratio.
905 If the parameter is not specified, it is assumed the value "0:1".
906
907 For example to change the sample aspect ratio to 10:11, specify:
908 @example
909 setsar=10:11
910 @end example
911
912 @section settb
913
914 Set the timebase to use for the output frames timestamps.
915 It is mainly useful for testing timebase configuration.
916
917 It accepts in input an arithmetic expression representing a rational.
918 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
919 default timebase), and "intb" (the input timebase).
920
921 The default value for the input is "intb".
922
923 Follow some examples.
924
925 @example
926 # set the timebase to 1/25
927 settb=1/25
928
929 # set the timebase to 1/10
930 settb=0.1
931
932 #set the timebase to 1001/1000
933 settb=1+0.001
934
935 #set the timebase to 2*intb
936 settb=2*intb
937
938 #set the default timebase value
939 settb=AVTB
940 @end example
941
942 @section slicify
943
944 Pass the images of input video on to next video filter as multiple
945 slices.
946
947 @example
948 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
949 @end example
950
951 The filter accepts the slice height as parameter. If the parameter is
952 not specified it will use the default value of 16.
953
954 Adding this in the beginning of filter chains should make filtering
955 faster due to better use of the memory cache.
956
957 @section transpose
958
959 Transpose rows with columns in the input video and optionally flip it.
960
961 It accepts a parameter representing an integer, which can assume the
962 values:
963
964 @table @samp
965 @item 0
966 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
967 @example
968 L.R     L.l
969 . . ->  . .
970 l.r     R.r
971 @end example
972
973 @item 1
974 Rotate by 90 degrees clockwise, that is:
975 @example
976 L.R     l.L
977 . . ->  . .
978 l.r     r.R
979 @end example
980
981 @item 2
982 Rotate by 90 degrees counterclockwise, that is:
983 @example
984 L.R     R.r
985 . . ->  . .
986 l.r     L.l
987 @end example
988
989 @item 3
990 Rotate by 90 degrees clockwise and vertically flip, that is:
991 @example
992 L.R     r.R
993 . . ->  . .
994 l.r     l.L
995 @end example
996 @end table
997
998 @section unsharp
999
1000 Sharpen or blur the input video.
1001
1002 It accepts the following parameters:
1003 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
1004
1005 Negative values for the amount will blur the input video, while positive
1006 values will sharpen. All parameters are optional and default to the
1007 equivalent of the string '5:5:1.0:0:0:0.0'.
1008
1009 @table @option
1010
1011 @item luma_msize_x
1012 Set the luma matrix horizontal size. It can be an integer between 3
1013 and 13, default value is 5.
1014
1015 @item luma_msize_y
1016 Set the luma matrix vertical size. It can be an integer between 3
1017 and 13, default value is 5.
1018
1019 @item luma_amount
1020 Set the luma effect strength. It can be a float number between -2.0
1021 and 5.0, default value is 1.0.
1022
1023 @item chroma_msize_x
1024 Set the chroma matrix horizontal size. It can be an integer between 3
1025 and 13, default value is 0.
1026
1027 @item chroma_msize_y
1028 Set the chroma matrix vertical size. It can be an integer between 3
1029 and 13, default value is 0.
1030
1031 @item luma_amount
1032 Set the chroma effect strength. It can be a float number between -2.0
1033 and 5.0, default value is 0.0.
1034
1035 @end table
1036
1037 @example
1038 # Strong luma sharpen effect parameters
1039 unsharp=7:7:2.5
1040
1041 # Strong blur of both luma and chroma parameters
1042 unsharp=7:7:-2:7:7:-2
1043
1044 # Use the default values with @command{ffmpeg}
1045 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
1046 @end example
1047
1048 @section vflip
1049
1050 Flip the input video vertically.
1051
1052 @example
1053 ./ffmpeg -i in.avi -vf "vflip" out.avi
1054 @end example
1055
1056 @section yadif
1057
1058 Deinterlace the input video ("yadif" means "yet another deinterlacing
1059 filter").
1060
1061 It accepts the optional parameters: @var{mode}:@var{parity}.
1062
1063 @var{mode} specifies the interlacing mode to adopt, accepts one of the
1064 following values:
1065
1066 @table @option
1067 @item 0
1068 output 1 frame for each frame
1069 @item 1
1070 output 1 frame for each field
1071 @item 2
1072 like 0 but skips spatial interlacing check
1073 @item 3
1074 like 1 but skips spatial interlacing check
1075 @end table
1076
1077 Default value is 0.
1078
1079 @var{parity} specifies the picture field parity assumed for the input
1080 interlaced video, accepts one of the following values:
1081
1082 @table @option
1083 @item 0
1084 assume bottom field first
1085 @item 1
1086 assume top field first
1087 @item -1
1088 enable automatic detection
1089 @end table
1090
1091 Default value is -1.
1092 If interlacing is unknown or decoder does not export this information,
1093 top field first will be assumed.
1094
1095 @c man end VIDEO FILTERS
1096
1097 @chapter Video Sources
1098 @c man begin VIDEO SOURCES
1099
1100 Below is a description of the currently available video sources.
1101
1102 @section buffer
1103
1104 Buffer video frames, and make them available to the filter chain.
1105
1106 This source is mainly intended for a programmatic use, in particular
1107 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
1108
1109 It accepts the following parameters:
1110 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}
1111
1112 All the parameters need to be explicitely defined.
1113
1114 Follows the list of the accepted parameters.
1115
1116 @table @option
1117
1118 @item width, height
1119 Specify the width and height of the buffered video frames.
1120
1121 @item pix_fmt_string
1122 A string representing the pixel format of the buffered video frames.
1123 It may be a number corresponding to a pixel format, or a pixel format
1124 name.
1125
1126 @item timebase_num, timebase_den
1127 Specify numerator and denomitor of the timebase assumed by the
1128 timestamps of the buffered frames.
1129 @end table
1130
1131 For example:
1132 @example
1133 buffer=320:240:yuv410p:1:24
1134 @end example
1135
1136 will instruct the source to accept video frames with size 320x240 and
1137 with format "yuv410p" and assuming 1/24 as the timestamps timebase.
1138 Since the pixel format with name "yuv410p" corresponds to the number 6
1139 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
1140 this example corresponds to:
1141 @example
1142 buffer=320:240:6:1:24
1143 @end example
1144
1145 @section color
1146
1147 Provide an uniformly colored input.
1148
1149 It accepts the following parameters:
1150 @var{color}:@var{frame_size}:@var{frame_rate}
1151
1152 Follows the description of the accepted parameters.
1153
1154 @table @option
1155
1156 @item color
1157 Specify the color of the source. It can be the name of a color (case
1158 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
1159 alpha specifier. The default value is "black".
1160
1161 @item frame_size
1162 Specify the size of the sourced video, it may be a string of the form
1163 @var{width}x@var{heigth}, or the name of a size abbreviation. The
1164 default value is "320x240".
1165
1166 @item frame_rate
1167 Specify the frame rate of the sourced video, as the number of frames
1168 generated per second. It has to be a string in the format
1169 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
1170 number or a valid video frame rate abbreviation. The default value is
1171 "25".
1172
1173 @end table
1174
1175 For example the following graph description will generate a red source
1176 with an opacity of 0.2, with size "qcif" and a frame rate of 10
1177 frames per second, which will be overlayed over the source connected
1178 to the pad with identifier "in".
1179
1180 @example
1181 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
1182 @end example
1183
1184 @section movie
1185
1186 Read a video stream from a movie container.
1187
1188 It accepts the syntax: @var{movie_name}[:@var{options}] where
1189 @var{movie_name} is the name of the resource to read (not necessarily
1190 a file but also a device or a stream accessed through some protocol),
1191 and @var{options} is an optional sequence of @var{key}=@var{value}
1192 pairs, separated by ":".
1193
1194 The description of the accepted options follows.
1195
1196 @table @option
1197
1198 @item format_name, f
1199 Specifies the format assumed for the movie to read, and can be either
1200 the name of a container or an input device. If not specified the
1201 format is guessed from @var{movie_name} or by probing.
1202
1203 @item seek_point, sp
1204 Specifies the seek point in seconds, the frames will be output
1205 starting from this seek point, the parameter is evaluated with
1206 @code{av_strtod} so the numerical value may be suffixed by an IS
1207 postfix. Default value is "0".
1208
1209 @item stream_index, si
1210 Specifies the index of the video stream to read. If the value is -1,
1211 the best suited video stream will be automatically selected. Default
1212 value is "-1".
1213
1214 @end table
1215
1216 This filter allows to overlay a second video on top of main input of
1217 a filtergraph as shown in this graph:
1218 @example
1219 input -----------> deltapts0 --> overlay --> output
1220                                     ^
1221                                     |
1222 movie --> scale--> deltapts1 -------+
1223 @end example
1224
1225 Some examples follow:
1226 @example
1227 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
1228 # on top of the input labelled as "in".
1229 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1230 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1231
1232 # read from a video4linux2 device, and overlay it on top of the input
1233 # labelled as "in"
1234 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1235 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1236
1237 @end example
1238
1239 @section nullsrc
1240
1241 Null video source, never return images. It is mainly useful as a
1242 template and to be employed in analysis / debugging tools.
1243
1244 It accepts as optional parameter a string of the form
1245 @var{width}:@var{height}:@var{timebase}.
1246
1247 @var{width} and @var{height} specify the size of the configured
1248 source. The default values of @var{width} and @var{height} are
1249 respectively 352 and 288 (corresponding to the CIF size format).
1250
1251 @var{timebase} specifies an arithmetic expression representing a
1252 timebase. The expression can contain the constants "PI", "E", "PHI",
1253 "AVTB" (the default timebase), and defaults to the value "AVTB".
1254
1255 @section frei0r_src
1256
1257 Provide a frei0r source.
1258
1259 To enable compilation of this filter you need to install the frei0r
1260 header and configure Libav with --enable-frei0r.
1261
1262 The source supports the syntax:
1263 @example
1264 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
1265 @end example
1266
1267 @var{size} is the size of the video to generate, may be a string of the
1268 form @var{width}x@var{height} or a frame size abbreviation.
1269 @var{rate} is the rate of the video to generate, may be a string of
1270 the form @var{num}/@var{den} or a frame rate abbreviation.
1271 @var{src_name} is the name to the frei0r source to load. For more
1272 information regarding frei0r and how to set the parameters read the
1273 section "frei0r" (@pxref{frei0r}) in the description of the video
1274 filters.
1275
1276 Some examples follow:
1277 @example
1278 # generate a frei0r partik0l source with size 200x200 and framerate 10
1279 # which is overlayed on the overlay filter main input
1280 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
1281 @end example
1282
1283 @c man end VIDEO SOURCES
1284
1285 @chapter Video Sinks
1286 @c man begin VIDEO SINKS
1287
1288 Below is a description of the currently available video sinks.
1289
1290 @section nullsink
1291
1292 Null video sink, do absolutely nothing with the input video. It is
1293 mainly useful as a template and to be employed in analysis / debugging
1294 tools.
1295
1296 @c man end VIDEO SINKS
1297