avcodec: move some AVCodecContext fields to an internal struct.
[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 boxblur
187
188 Apply boxblur algorithm to the input video.
189
190 This filter accepts the parameters:
191 @var{luma_power}:@var{luma_radius}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
192
193 Chroma and alpha parameters are optional, if not specified they default
194 to the corresponding values set for @var{luma_radius} and
195 @var{luma_power}.
196
197 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
198 the radius in pixels of the box used for blurring the corresponding
199 input plane. They are expressions, and can contain the following
200 constants:
201 @table @option
202 @item w, h
203 the input width and heigth in pixels
204
205 @item cw, ch
206 the input chroma image width and height in pixels
207
208 @item hsub, vsub
209 horizontal and vertical chroma subsample values. For example for the
210 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
211 @end table
212
213 The radius must be a non-negative number, and must not be greater than
214 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
215 and of @code{min(cw,ch)/2} for the chroma planes.
216
217 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
218 how many times the boxblur filter is applied to the corresponding
219 plane.
220
221 Some examples follow:
222
223 @itemize
224
225 @item
226 Apply a boxblur filter with luma, chroma, and alpha radius
227 set to 2:
228 @example
229 boxblur=2:1
230 @end example
231
232 @item
233 Set luma radius to 2, alpha and chroma radius to 0
234 @example
235 boxblur=2:1:0:0:0:0
236 @end example
237
238 @item
239 Set luma and chroma radius to a fraction of the video dimension
240 @example
241 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
242 @end example
243
244 @end itemize
245
246 @section copy
247
248 Copy the input source unchanged to the output. Mainly useful for
249 testing purposes.
250
251 @section crop
252
253 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
254
255 The parameters are expressions containing the following constants:
256
257 @table @option
258 @item E, PI, PHI
259 the corresponding mathematical approximated values for e
260 (euler number), pi (greek PI), PHI (golden ratio)
261
262 @item x, y
263 the computed values for @var{x} and @var{y}. They are evaluated for
264 each new frame.
265
266 @item in_w, in_h
267 the input width and height
268
269 @item iw, ih
270 same as @var{in_w} and @var{in_h}
271
272 @item out_w, out_h
273 the output (cropped) width and height
274
275 @item ow, oh
276 same as @var{out_w} and @var{out_h}
277
278 @item n
279 the number of input frame, starting from 0
280
281 @item pos
282 the position in the file of the input frame, NAN if unknown
283
284 @item t
285 timestamp expressed in seconds, NAN if the input timestamp is unknown
286
287 @end table
288
289 The @var{out_w} and @var{out_h} parameters specify the expressions for
290 the width and height of the output (cropped) video. They are
291 evaluated just at the configuration of the filter.
292
293 The default value of @var{out_w} is "in_w", and the default value of
294 @var{out_h} is "in_h".
295
296 The expression for @var{out_w} may depend on the value of @var{out_h},
297 and the expression for @var{out_h} may depend on @var{out_w}, but they
298 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
299 evaluated after @var{out_w} and @var{out_h}.
300
301 The @var{x} and @var{y} parameters specify the expressions for the
302 position of the top-left corner of the output (non-cropped) area. They
303 are evaluated for each frame. If the evaluated value is not valid, it
304 is approximated to the nearest valid value.
305
306 The default value of @var{x} is "(in_w-out_w)/2", and the default
307 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
308 the center of the input image.
309
310 The expression for @var{x} may depend on @var{y}, and the expression
311 for @var{y} may depend on @var{x}.
312
313 Follow some examples:
314 @example
315 # crop the central input area with size 100x100
316 crop=100:100
317
318 # crop the central input area with size 2/3 of the input video
319 "crop=2/3*in_w:2/3*in_h"
320
321 # crop the input video central square
322 crop=in_h
323
324 # delimit the rectangle with the top-left corner placed at position
325 # 100:100 and the right-bottom corner corresponding to the right-bottom
326 # corner of the input image.
327 crop=in_w-100:in_h-100:100:100
328
329 # crop 10 pixels from the left and right borders, and 20 pixels from
330 # the top and bottom borders
331 "crop=in_w-2*10:in_h-2*20"
332
333 # keep only the bottom right quarter of the input image
334 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
335
336 # crop height for getting Greek harmony
337 "crop=in_w:1/PHI*in_w"
338
339 # trembling effect
340 "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)"
341
342 # erratic camera effect depending on timestamp
343 "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)"
344
345 # set x depending on the value of y
346 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
347 @end example
348
349 @section cropdetect
350
351 Auto-detect crop size.
352
353 Calculate necessary cropping parameters and prints the recommended
354 parameters through the logging system. The detected dimensions
355 correspond to the non-black area of the input video.
356
357 It accepts the syntax:
358 @example
359 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
360 @end example
361
362 @table @option
363
364 @item limit
365 Threshold, which can be optionally specified from nothing (0) to
366 everything (255), defaults to 24.
367
368 @item round
369 Value which the width/height should be divisible by, defaults to
370 16. The offset is automatically adjusted to center the video. Use 2 to
371 get only even dimensions (needed for 4:2:2 video). 16 is best when
372 encoding to most video codecs.
373
374 @item reset
375 Counter that determines after how many frames cropdetect will reset
376 the previously detected largest video area and start over to detect
377 the current optimal crop area. Defaults to 0.
378
379 This can be useful when channel logos distort the video area. 0
380 indicates never reset and return the largest area encountered during
381 playback.
382 @end table
383
384 @section delogo
385
386 Suppress a TV station logo by a simple interpolation of the surrounding
387 pixels. Just set a rectangle covering the logo and watch it disappear
388 (and sometimes something even uglier appear - your mileage may vary).
389
390 The filter accepts parameters as a string of the form
391 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
392 @var{key}=@var{value} pairs, separated by ":".
393
394 The description of the accepted parameters follows.
395
396 @table @option
397
398 @item x, y
399 Specify the top left corner coordinates of the logo. They must be
400 specified.
401
402 @item w, h
403 Specify the width and height of the logo to clear. They must be
404 specified.
405
406 @item band, t
407 Specify the thickness of the fuzzy edge of the rectangle (added to
408 @var{w} and @var{h}). The default value is 4.
409
410 @item show
411 When set to 1, a green rectangle is drawn on the screen to simplify
412 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
413 @var{band} is set to 4. The default value is 0.
414
415 @end table
416
417 Some examples follow.
418
419 @itemize
420
421 @item
422 Set a rectangle covering the area with top left corner coordinates 0,0
423 and size 100x77, setting a band of size 10:
424 @example
425 delogo=0:0:100:77:10
426 @end example
427
428 @item
429 As the previous example, but use named options:
430 @example
431 delogo=x=0:y=0:w=100:h=77:band=10
432 @end example
433
434 @end itemize
435
436 @section drawbox
437
438 Draw a colored box on the input image.
439
440 It accepts the syntax:
441 @example
442 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
443 @end example
444
445 @table @option
446
447 @item x, y
448 Specify the top left corner coordinates of the box. Default to 0.
449
450 @item width, height
451 Specify the width and height of the box, if 0 they are interpreted as
452 the input width and height. Default to 0.
453
454 @item color
455 Specify the color of the box to write, it can be the name of a color
456 (case insensitive match) or a 0xRRGGBB[AA] sequence.
457 @end table
458
459 Follow some examples:
460 @example
461 # draw a black box around the edge of the input image
462 drawbox
463
464 # draw a box with color red and an opacity of 50%
465 drawbox=10:20:200:60:red@@0.5"
466 @end example
467
468 @section drawtext
469
470 Draw text string or text from specified file on top of video using the
471 libfreetype library.
472
473 To enable compilation of this filter you need to configure FFmpeg with
474 @code{--enable-libfreetype}.
475
476 The filter also recognizes strftime() sequences in the provided text
477 and expands them accordingly. Check the documentation of strftime().
478
479 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
480 separated by ":".
481
482 The description of the accepted parameters follows.
483
484 @table @option
485
486 @item fontfile
487 The font file to be used for drawing text. Path must be included.
488 This parameter is mandatory.
489
490 @item text
491 The text string to be drawn. The text must be a sequence of UTF-8
492 encoded characters.
493 This parameter is mandatory if no file is specified with the parameter
494 @var{textfile}.
495
496 @item textfile
497 A text file containing text to be drawn. The text must be a sequence
498 of UTF-8 encoded characters.
499
500 This parameter is mandatory if no text string is specified with the
501 parameter @var{text}.
502
503 If both text and textfile are specified, an error is thrown.
504
505 @item x, y
506 The offsets where text will be drawn within the video frame.
507 Relative to the top/left border of the output image.
508
509 The default value of @var{x} and @var{y} is 0.
510
511 @item fontsize
512 The font size to be used for drawing text.
513 The default value of @var{fontsize} is 16.
514
515 @item fontcolor
516 The color to be used for drawing fonts.
517 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
518 (e.g. "0xff000033"), possibly followed by an alpha specifier.
519 The default value of @var{fontcolor} is "black".
520
521 @item boxcolor
522 The color to be used for drawing box around text.
523 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
524 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
525 The default value of @var{boxcolor} is "white".
526
527 @item box
528 Used to draw a box around text using background color.
529 Value should be either 1 (enable) or 0 (disable).
530 The default value of @var{box} is 0.
531
532 @item shadowx, shadowy
533 The x and y offsets for the text shadow position with respect to the
534 position of the text. They can be either positive or negative
535 values. Default value for both is "0".
536
537 @item shadowcolor
538 The color to be used for drawing a shadow behind the drawn text.  It
539 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
540 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
541 The default value of @var{shadowcolor} is "black".
542
543 @item ft_load_flags
544 Flags to be used for loading the fonts.
545
546 The flags map the corresponding flags supported by libfreetype, and are
547 a combination of the following values:
548 @table @var
549 @item default
550 @item no_scale
551 @item no_hinting
552 @item render
553 @item no_bitmap
554 @item vertical_layout
555 @item force_autohint
556 @item crop_bitmap
557 @item pedantic
558 @item ignore_global_advance_width
559 @item no_recurse
560 @item ignore_transform
561 @item monochrome
562 @item linear_design
563 @item no_autohint
564 @item end table
565 @end table
566
567 Default value is "render".
568
569 For more information consult the documentation for the FT_LOAD_*
570 libfreetype flags.
571
572 @item tabsize
573 The size in number of spaces to use for rendering the tab.
574 Default value is 4.
575 @end table
576
577 For example the command:
578 @example
579 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
580 @end example
581
582 will draw "Test Text" with font FreeSerif, using the default values
583 for the optional parameters.
584
585 The command:
586 @example
587 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
588           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
589 @end example
590
591 will draw 'Test Text' with font FreeSerif of size 24 at position x=100
592 and y=50 (counting from the top-left corner of the screen), text is
593 yellow with a red box around it. Both the text and the box have an
594 opacity of 20%.
595
596 Note that the double quotes are not necessary if spaces are not used
597 within the parameter list.
598
599 For more information about libfreetype, check:
600 @url{http://www.freetype.org/}.
601
602 @section fade
603
604 Apply fade-in/out effect to input video.
605
606 It accepts the parameters:
607 @var{type}:@var{start_frame}:@var{nb_frames}
608
609 @var{type} specifies if the effect type, can be either "in" for
610 fade-in, or "out" for a fade-out effect.
611
612 @var{start_frame} specifies the number of the start frame for starting
613 to apply the fade effect.
614
615 @var{nb_frames} specifies the number of frames for which the fade
616 effect has to last. At the end of the fade-in effect the output video
617 will have the same intensity as the input video, at the end of the
618 fade-out transition the output video will be completely black.
619
620 A few usage examples follow, usable too as test scenarios.
621 @example
622 # fade in first 30 frames of video
623 fade=in:0:30
624
625 # fade out last 45 frames of a 200-frame video
626 fade=out:155:45
627
628 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
629 fade=in:0:25, fade=out:975:25
630
631 # make first 5 frames black, then fade in from frame 5-24
632 fade=in:5:20
633 @end example
634
635 @section fieldorder
636
637 Transform the field order of the input video.
638
639 It accepts one parameter which specifies the required field order that
640 the input interlaced video will be transformed to. The parameter can
641 assume one of the following values:
642
643 @table @option
644 @item 0 or bff
645 output bottom field first
646 @item 1 or tff
647 output top field first
648 @end table
649
650 Default value is "tff".
651
652 Transformation is achieved by shifting the picture content up or down
653 by one line, and filling the remaining line with appropriate picture content.
654 This method is consistent with most broadcast field order converters.
655
656 If the input video is not flagged as being interlaced, or it is already
657 flagged as being of the required output field order then this filter does
658 not alter the incoming video.
659
660 This filter is very useful when converting to or from PAL DV material,
661 which is bottom field first.
662
663 For example:
664 @example
665 ./ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
666 @end example
667
668 @section fifo
669
670 Buffer input images and send them when they are requested.
671
672 This filter is mainly useful when auto-inserted by the libavfilter
673 framework.
674
675 The filter does not take parameters.
676
677 @section format
678
679 Convert the input video to one of the specified pixel formats.
680 Libavfilter will try to pick one that is supported for the input to
681 the next filter.
682
683 The filter accepts a list of pixel format names, separated by ":",
684 for example "yuv420p:monow:rgb24".
685
686 Some examples follow:
687 @example
688 # convert the input video to the format "yuv420p"
689 format=yuv420p
690
691 # convert the input video to any of the formats in the list
692 format=yuv420p:yuv444p:yuv410p
693 @end example
694
695 @anchor{frei0r}
696 @section frei0r
697
698 Apply a frei0r effect to the input video.
699
700 To enable compilation of this filter you need to install the frei0r
701 header and configure Libav with --enable-frei0r.
702
703 The filter supports the syntax:
704 @example
705 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
706 @end example
707
708 @var{filter_name} is the name to the frei0r effect to load. If the
709 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
710 is searched in each one of the directories specified by the colon
711 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
712 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
713 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
714
715 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
716 for the frei0r effect.
717
718 A frei0r effect parameter can be a boolean (whose values are specified
719 with "y" and "n"), a double, a color (specified by the syntax
720 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
721 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
722 description), a position (specified by the syntax @var{X}/@var{Y},
723 @var{X} and @var{Y} being float numbers) and a string.
724
725 The number and kind of parameters depend on the loaded effect. If an
726 effect parameter is not specified the default value is set.
727
728 Some examples follow:
729 @example
730 # apply the distort0r effect, set the first two double parameters
731 frei0r=distort0r:0.5:0.01
732
733 # apply the colordistance effect, takes a color as first parameter
734 frei0r=colordistance:0.2/0.3/0.4
735 frei0r=colordistance:violet
736 frei0r=colordistance:0x112233
737
738 # apply the perspective effect, specify the top left and top right
739 # image positions
740 frei0r=perspective:0.2/0.2:0.8/0.2
741 @end example
742
743 For more information see:
744 @url{http://piksel.org/frei0r}
745
746 @section gradfun
747
748 Fix the banding artifacts that are sometimes introduced into nearly flat
749 regions by truncation to 8bit colordepth.
750 Interpolate the gradients that should go where the bands are, and
751 dither them.
752
753 This filter is designed for playback only.  Do not use it prior to
754 lossy compression, because compression tends to lose the dither and
755 bring back the bands.
756
757 The filter takes two optional parameters, separated by ':':
758 @var{strength}:@var{radius}
759
760 @var{strength} is the maximum amount by which the filter will change
761 any one pixel. Also the threshold for detecting nearly flat
762 regions. Acceptable values range from .51 to 255, default value is
763 1.2, out-of-range values will be clipped to the valid range.
764
765 @var{radius} is the neighborhood to fit the gradient to. A larger
766 radius makes for smoother gradients, but also prevents the filter from
767 modifying the pixels near detailed regions. Acceptable values are
768 8-32, default value is 16, out-of-range values will be clipped to the
769 valid range.
770
771 @example
772 # default parameters
773 gradfun=1.2:16
774
775 # omitting radius
776 gradfun=1.2
777 @end example
778
779 @section hflip
780
781 Flip the input video horizontally.
782
783 For example to horizontally flip the video in input with
784 @file{ffmpeg}:
785 @example
786 ffmpeg -i in.avi -vf "hflip" out.avi
787 @end example
788
789 @section hqdn3d
790
791 High precision/quality 3d denoise filter. This filter aims to reduce
792 image noise producing smooth images and making still images really
793 still. It should enhance compressibility.
794
795 It accepts the following optional parameters:
796 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
797
798 @table @option
799 @item luma_spatial
800 a non-negative float number which specifies spatial luma strength,
801 defaults to 4.0
802
803 @item chroma_spatial
804 a non-negative float number which specifies spatial chroma strength,
805 defaults to 3.0*@var{luma_spatial}/4.0
806
807 @item luma_tmp
808 a float number which specifies luma temporal strength, defaults to
809 6.0*@var{luma_spatial}/4.0
810
811 @item chroma_tmp
812 a float number which specifies chroma temporal strength, defaults to
813 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
814 @end table
815
816 @section lut, lutrgb, lutyuv
817
818 Compute a look-up table for binding each pixel component input value
819 to an output value, and apply it to input video.
820
821 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
822 to an RGB input video.
823
824 These filters accept in input a ":"-separated list of options, which
825 specify the expressions used for computing the lookup table for the
826 corresponding pixel component values.
827
828 The @var{lut} filter requires either YUV or RGB pixel formats in
829 input, and accepts the options:
830 @table @option
831 @var{c0} (first  pixel component)
832 @var{c1} (second pixel component)
833 @var{c2} (third  pixel component)
834 @var{c3} (fourth pixel component, corresponds to the alpha component)
835 @end table
836
837 The exact component associated to each option depends on the format in
838 input.
839
840 The @var{lutrgb} filter requires RGB pixel formats in input, and
841 accepts the options:
842 @table @option
843 @var{r} (red component)
844 @var{g} (green component)
845 @var{b} (blue component)
846 @var{a} (alpha component)
847 @end table
848
849 The @var{lutyuv} filter requires YUV pixel formats in input, and
850 accepts the options:
851 @table @option
852 @var{y} (Y/luminance component)
853 @var{u} (U/Cb component)
854 @var{v} (V/Cr component)
855 @var{a} (alpha component)
856 @end table
857
858 The expressions can contain the following constants and functions:
859
860 @table @option
861 @item E, PI, PHI
862 the corresponding mathematical approximated values for e
863 (euler number), pi (greek PI), PHI (golden ratio)
864
865 @item w, h
866 the input width and heigth
867
868 @item val
869 input value for the pixel component
870
871 @item clipval
872 the input value clipped in the @var{minval}-@var{maxval} range
873
874 @item maxval
875 maximum value for the pixel component
876
877 @item minval
878 minimum value for the pixel component
879
880 @item negval
881 the negated value for the pixel component value clipped in the
882 @var{minval}-@var{maxval} range , it corresponds to the expression
883 "maxval-clipval+minval"
884
885 @item clip(val)
886 the computed value in @var{val} clipped in the
887 @var{minval}-@var{maxval} range
888
889 @item gammaval(gamma)
890 the computed gamma correction value of the pixel component value
891 clipped in the @var{minval}-@var{maxval} range, corresponds to the
892 expression
893 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
894
895 @end table
896
897 All expressions default to "val".
898
899 Some examples follow:
900 @example
901 # negate input video
902 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
903 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
904
905 # the above is the same as
906 lutrgb="r=negval:g=negval:b=negval"
907 lutyuv="y=negval:u=negval:v=negval"
908
909 # negate luminance
910 lutyuv=negval
911
912 # remove chroma components, turns the video into a graytone image
913 lutyuv="u=128:v=128"
914
915 # apply a luma burning effect
916 lutyuv="y=2*val"
917
918 # remove green and blue components
919 lutrgb="g=0:b=0"
920
921 # set a constant alpha channel value on input
922 format=rgba,lutrgb=a="maxval-minval/2"
923
924 # correct luminance gamma by a 0.5 factor
925 lutyuv=y=gammaval(0.5)
926 @end example
927
928 @section negate
929
930 Negate input video.
931
932 This filter accepts an integer in input, if non-zero it negates the
933 alpha component (if available). The default value in input is 0.
934
935 Force libavfilter not to use any of the specified pixel formats for the
936 input to the next filter.
937
938 The filter accepts a list of pixel format names, separated by ":",
939 for example "yuv420p:monow:rgb24".
940
941 Some examples follow:
942 @example
943 # force libavfilter to use a format different from "yuv420p" for the
944 # input to the vflip filter
945 noformat=yuv420p,vflip
946
947 # convert the input video to any of the formats not contained in the list
948 noformat=yuv420p:yuv444p:yuv410p
949 @end example
950
951 @section null
952
953 Pass the video source unchanged to the output.
954
955 @section ocv
956
957 Apply video transform using libopencv.
958
959 To enable this filter install libopencv library and headers and
960 configure Libav with --enable-libopencv.
961
962 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
963
964 @var{filter_name} is the name of the libopencv filter to apply.
965
966 @var{filter_params} specifies the parameters to pass to the libopencv
967 filter. If not specified the default values are assumed.
968
969 Refer to the official libopencv documentation for more precise
970 informations:
971 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
972
973 Follows the list of supported libopencv filters.
974
975 @anchor{dilate}
976 @subsection dilate
977
978 Dilate an image by using a specific structuring element.
979 This filter corresponds to the libopencv function @code{cvDilate}.
980
981 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
982
983 @var{struct_el} represents a structuring element, and has the syntax:
984 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
985
986 @var{cols} and @var{rows} represent the number of colums and rows of
987 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
988 point, and @var{shape} the shape for the structuring element, and
989 can be one of the values "rect", "cross", "ellipse", "custom".
990
991 If the value for @var{shape} is "custom", it must be followed by a
992 string of the form "=@var{filename}". The file with name
993 @var{filename} is assumed to represent a binary image, with each
994 printable character corresponding to a bright pixel. When a custom
995 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
996 or columns and rows of the read file are assumed instead.
997
998 The default value for @var{struct_el} is "3x3+0x0/rect".
999
1000 @var{nb_iterations} specifies the number of times the transform is
1001 applied to the image, and defaults to 1.
1002
1003 Follow some example:
1004 @example
1005 # use the default values
1006 ocv=dilate
1007
1008 # dilate using a structuring element with a 5x5 cross, iterate two times
1009 ocv=dilate=5x5+2x2/cross:2
1010
1011 # read the shape from the file diamond.shape, iterate two times
1012 # the file diamond.shape may contain a pattern of characters like this:
1013 #   *
1014 #  ***
1015 # *****
1016 #  ***
1017 #   *
1018 # the specified cols and rows are ignored (but not the anchor point coordinates)
1019 ocv=0x0+2x2/custom=diamond.shape:2
1020 @end example
1021
1022 @subsection erode
1023
1024 Erode an image by using a specific structuring element.
1025 This filter corresponds to the libopencv function @code{cvErode}.
1026
1027 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1028 with the same syntax and semantics as the @ref{dilate} filter.
1029
1030 @subsection smooth
1031
1032 Smooth the input video.
1033
1034 The filter takes the following parameters:
1035 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
1036
1037 @var{type} is the type of smooth filter to apply, and can be one of
1038 the following values: "blur", "blur_no_scale", "median", "gaussian",
1039 "bilateral". The default value is "gaussian".
1040
1041 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1042 parameters whose meanings depend on smooth type. @var{param1} and
1043 @var{param2} accept integer positive values or 0, @var{param3} and
1044 @var{param4} accept float values.
1045
1046 The default value for @var{param1} is 3, the default value for the
1047 other parameters is 0.
1048
1049 These parameters correspond to the parameters assigned to the
1050 libopencv function @code{cvSmooth}.
1051
1052 @section overlay
1053
1054 Overlay one video on top of another.
1055
1056 It takes two inputs and one output, the first input is the "main"
1057 video on which the second input is overlayed.
1058
1059 It accepts the parameters: @var{x}:@var{y}.
1060
1061 @var{x} is the x coordinate of the overlayed video on the main video,
1062 @var{y} is the y coordinate. The parameters are expressions containing
1063 the following parameters:
1064
1065 @table @option
1066 @item main_w, main_h
1067 main input width and height
1068
1069 @item W, H
1070 same as @var{main_w} and @var{main_h}
1071
1072 @item overlay_w, overlay_h
1073 overlay input width and height
1074
1075 @item w, h
1076 same as @var{overlay_w} and @var{overlay_h}
1077 @end table
1078
1079 Be aware that frames are taken from each input video in timestamp
1080 order, hence, if their initial timestamps differ, it is a a good idea
1081 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1082 have them begin in the same zero timestamp, as it does the example for
1083 the @var{movie} filter.
1084
1085 Follow some examples:
1086 @example
1087 # draw the overlay at 10 pixels from the bottom right
1088 # corner of the main video.
1089 overlay=main_w-overlay_w-10:main_h-overlay_h-10
1090
1091 # insert a transparent PNG logo in the bottom left corner of the input
1092 movie=logo.png [logo];
1093 [in][logo] overlay=10:main_h-overlay_h-10 [out]
1094
1095 # insert 2 different transparent PNG logos (second logo on bottom
1096 # right corner):
1097 movie=logo1.png [logo1];
1098 movie=logo2.png [logo2];
1099 [in][logo1]       overlay=10:H-h-10 [in+logo1];
1100 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
1101
1102 # add a transparent color layer on top of the main video,
1103 # WxH specifies the size of the main input to the overlay filter
1104 color=red@.3:WxH [over]; [in][over] overlay [out]
1105 @end example
1106
1107 You can chain togheter more overlays but the efficiency of such
1108 approach is yet to be tested.
1109
1110 @section pad
1111
1112 Add paddings to the input image, and places the original input at the
1113 given coordinates @var{x}, @var{y}.
1114
1115 It accepts the following parameters:
1116 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
1117
1118 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1119 expressions containing the following constants:
1120
1121 @table @option
1122 @item E, PI, PHI
1123 the corresponding mathematical approximated values for e
1124 (euler number), pi (greek PI), phi (golden ratio)
1125
1126 @item in_w, in_h
1127 the input video width and height
1128
1129 @item iw, ih
1130 same as @var{in_w} and @var{in_h}
1131
1132 @item out_w, out_h
1133 the output width and height, that is the size of the padded area as
1134 specified by the @var{width} and @var{height} expressions
1135
1136 @item ow, oh
1137 same as @var{out_w} and @var{out_h}
1138
1139 @item x, y
1140 x and y offsets as specified by the @var{x} and @var{y}
1141 expressions, or NAN if not yet specified
1142
1143 @item a
1144 input display aspect ratio, same as @var{iw} / @var{ih}
1145
1146 @item hsub, vsub
1147 horizontal and vertical chroma subsample values. For example for the
1148 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1149 @end table
1150
1151 Follows the description of the accepted parameters.
1152
1153 @table @option
1154 @item width, height
1155
1156 Specify the size of the output image with the paddings added. If the
1157 value for @var{width} or @var{height} is 0, the corresponding input size
1158 is used for the output.
1159
1160 The @var{width} expression can reference the value set by the
1161 @var{height} expression, and viceversa.
1162
1163 The default value of @var{width} and @var{height} is 0.
1164
1165 @item x, y
1166
1167 Specify the offsets where to place the input image in the padded area
1168 with respect to the top/left border of the output image.
1169
1170 The @var{x} expression can reference the value set by the @var{y}
1171 expression, and viceversa.
1172
1173 The default value of @var{x} and @var{y} is 0.
1174
1175 @item color
1176
1177 Specify the color of the padded area, it can be the name of a color
1178 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1179
1180 The default value of @var{color} is "black".
1181
1182 @end table
1183
1184 Some examples follow:
1185
1186 @example
1187 # Add paddings with color "violet" to the input video. Output video
1188 # size is 640x480, the top-left corner of the input video is placed at
1189 # column 0, row 40.
1190 pad=640:480:0:40:violet
1191
1192 # pad the input to get an output with dimensions increased bt 3/2,
1193 # and put the input video at the center of the padded area
1194 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1195
1196 # pad the input to get a squared output with size equal to the maximum
1197 # value between the input width and height, and put the input video at
1198 # the center of the padded area
1199 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1200
1201 # pad the input to get a final w/h ratio of 16:9
1202 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1203
1204 # double output size and put the input video in the bottom-right
1205 # corner of the output padded area
1206 pad="2*iw:2*ih:ow-iw:oh-ih"
1207 @end example
1208
1209 @section pixdesctest
1210
1211 Pixel format descriptor test filter, mainly useful for internal
1212 testing. The output video should be equal to the input video.
1213
1214 For example:
1215 @example
1216 format=monow, pixdesctest
1217 @end example
1218
1219 can be used to test the monowhite pixel format descriptor definition.
1220
1221 @section scale
1222
1223 Scale the input video to @var{width}:@var{height} and/or convert the image format.
1224
1225 The parameters @var{width} and @var{height} are expressions containing
1226 the following constants:
1227
1228 @table @option
1229 @item E, PI, PHI
1230 the corresponding mathematical approximated values for e
1231 (euler number), pi (greek PI), phi (golden ratio)
1232
1233 @item in_w, in_h
1234 the input width and height
1235
1236 @item iw, ih
1237 same as @var{in_w} and @var{in_h}
1238
1239 @item out_w, out_h
1240 the output (cropped) width and height
1241
1242 @item ow, oh
1243 same as @var{out_w} and @var{out_h}
1244
1245 @item dar, a
1246 input display aspect ratio, same as @var{iw} / @var{ih}
1247
1248 @item sar
1249 input sample aspect ratio
1250
1251 @item hsub, vsub
1252 horizontal and vertical chroma subsample values. For example for the
1253 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1254 @end table
1255
1256 If the input image format is different from the format requested by
1257 the next filter, the scale filter will convert the input to the
1258 requested format.
1259
1260 If the value for @var{width} or @var{height} is 0, the respective input
1261 size is used for the output.
1262
1263 If the value for @var{width} or @var{height} is -1, the scale filter will
1264 use, for the respective output size, a value that maintains the aspect
1265 ratio of the input image.
1266
1267 The default value of @var{width} and @var{height} is 0.
1268
1269 Some examples follow:
1270 @example
1271 # scale the input video to a size of 200x100.
1272 scale=200:100
1273
1274 # scale the input to 2x
1275 scale=2*iw:2*ih
1276 # the above is the same as
1277 scale=2*in_w:2*in_h
1278
1279 # scale the input to half size
1280 scale=iw/2:ih/2
1281
1282 # increase the width, and set the height to the same size
1283 scale=3/2*iw:ow
1284
1285 # seek for Greek harmony
1286 scale=iw:1/PHI*iw
1287 scale=ih*PHI:ih
1288
1289 # increase the height, and set the width to 3/2 of the height
1290 scale=3/2*oh:3/5*ih
1291
1292 # increase the size, but make the size a multiple of the chroma
1293 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1294
1295 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1296 scale='min(500\, iw*3/2):-1'
1297 @end example
1298
1299 @section select
1300 Select frames to pass in output.
1301
1302 It accepts in input an expression, which is evaluated for each input
1303 frame. If the expression is evaluated to a non-zero value, the frame
1304 is selected and passed to the output, otherwise it is discarded.
1305
1306 The expression can contain the following constants:
1307
1308 @table @option
1309 @item PI
1310 Greek PI
1311
1312 @item PHI
1313 golden ratio
1314
1315 @item E
1316 Euler number
1317
1318 @item n
1319 the sequential number of the filtered frame, starting from 0
1320
1321 @item selected_n
1322 the sequential number of the selected frame, starting from 0
1323
1324 @item prev_selected_n
1325 the sequential number of the last selected frame, NAN if undefined
1326
1327 @item TB
1328 timebase of the input timestamps
1329
1330 @item pts
1331 the PTS (Presentation TimeStamp) of the filtered video frame,
1332 expressed in @var{TB} units, NAN if undefined
1333
1334 @item t
1335 the PTS (Presentation TimeStamp) of the filtered video frame,
1336 expressed in seconds, NAN if undefined
1337
1338 @item prev_pts
1339 the PTS of the previously filtered video frame, NAN if undefined
1340
1341 @item prev_selected_pts
1342 the PTS of the last previously filtered video frame, NAN if undefined
1343
1344 @item prev_selected_t
1345 the PTS of the last previously selected video frame, NAN if undefined
1346
1347 @item start_pts
1348 the PTS of the first video frame in the video, NAN if undefined
1349
1350 @item start_t
1351 the time of the first video frame in the video, NAN if undefined
1352
1353 @item pict_type
1354 the type of the filtered frame, can assume one of the following
1355 values:
1356 @table @option
1357 @item I
1358 @item P
1359 @item B
1360 @item S
1361 @item SI
1362 @item SP
1363 @item BI
1364 @end table
1365
1366 @item interlace_type
1367 the frame interlace type, can assume one of the following values:
1368 @table @option
1369 @item PROGRESSIVE
1370 the frame is progressive (not interlaced)
1371 @item TOPFIRST
1372 the frame is top-field-first
1373 @item BOTTOMFIRST
1374 the frame is bottom-field-first
1375 @end table
1376
1377 @item key
1378 1 if the filtered frame is a key-frame, 0 otherwise
1379
1380 @item pos
1381 the position in the file of the filtered frame, -1 if the information
1382 is not available (e.g. for synthetic video)
1383 @end table
1384
1385 The default value of the select expression is "1".
1386
1387 Some examples follow:
1388
1389 @example
1390 # select all frames in input
1391 select
1392
1393 # the above is the same as:
1394 select=1
1395
1396 # skip all frames:
1397 select=0
1398
1399 # select only I-frames
1400 select='eq(pict_type\,I)'
1401
1402 # select one frame every 100
1403 select='not(mod(n\,100))'
1404
1405 # select only frames contained in the 10-20 time interval
1406 select='gte(t\,10)*lte(t\,20)'
1407
1408 # select only I frames contained in the 10-20 time interval
1409 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
1410
1411 # select frames with a minimum distance of 10 seconds
1412 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
1413 @end example
1414
1415 @anchor{setdar}
1416 @section setdar
1417
1418 Set the Display Aspect Ratio for the filter output video.
1419
1420 This is done by changing the specified Sample (aka Pixel) Aspect
1421 Ratio, according to the following equation:
1422 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1423
1424 Keep in mind that this filter does not modify the pixel dimensions of
1425 the video frame. Also the display aspect ratio set by this filter may
1426 be changed by later filters in the filterchain, e.g. in case of
1427 scaling or if another "setdar" or a "setsar" filter is applied.
1428
1429 The filter accepts a parameter string which represents the wanted
1430 display aspect ratio.
1431 The parameter can be a floating point number string, or an expression
1432 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1433 numerator and denominator of the aspect ratio.
1434 If the parameter is not specified, it is assumed the value "0:1".
1435
1436 For example to change the display aspect ratio to 16:9, specify:
1437 @example
1438 setdar=16:9
1439 # the above is equivalent to
1440 setdar=1.77777
1441 @end example
1442
1443 See also the @ref{setsar} filter documentation.
1444
1445 @section setpts
1446
1447 Change the PTS (presentation timestamp) of the input video frames.
1448
1449 Accept in input an expression evaluated through the eval API, which
1450 can contain the following constants:
1451
1452 @table @option
1453 @item PTS
1454 the presentation timestamp in input
1455
1456 @item PI
1457 Greek PI
1458
1459 @item PHI
1460 golden ratio
1461
1462 @item E
1463 Euler number
1464
1465 @item N
1466 the count of the input frame, starting from 0.
1467
1468 @item STARTPTS
1469 the PTS of the first video frame
1470
1471 @item INTERLACED
1472 tell if the current frame is interlaced
1473
1474 @item POS
1475 original position in the file of the frame, or undefined if undefined
1476 for the current frame
1477
1478 @item PREV_INPTS
1479 previous input PTS
1480
1481 @item PREV_OUTPTS
1482 previous output PTS
1483
1484 @end table
1485
1486 Some examples follow:
1487
1488 @example
1489 # start counting PTS from zero
1490 setpts=PTS-STARTPTS
1491
1492 # fast motion
1493 setpts=0.5*PTS
1494
1495 # slow motion
1496 setpts=2.0*PTS
1497
1498 # fixed rate 25 fps
1499 setpts=N/(25*TB)
1500
1501 # fixed rate 25 fps with some jitter
1502 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
1503 @end example
1504
1505 @anchor{setsar}
1506 @section setsar
1507
1508 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1509
1510 Note that as a consequence of the application of this filter, the
1511 output display aspect ratio will change according to the following
1512 equation:
1513 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1514
1515 Keep in mind that the sample aspect ratio set by this filter may be
1516 changed by later filters in the filterchain, e.g. if another "setsar"
1517 or a "setdar" filter is applied.
1518
1519 The filter accepts a parameter string which represents the wanted
1520 sample aspect ratio.
1521 The parameter can be a floating point number string, or an expression
1522 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1523 numerator and denominator of the aspect ratio.
1524 If the parameter is not specified, it is assumed the value "0:1".
1525
1526 For example to change the sample aspect ratio to 10:11, specify:
1527 @example
1528 setsar=10:11
1529 @end example
1530
1531 @section settb
1532
1533 Set the timebase to use for the output frames timestamps.
1534 It is mainly useful for testing timebase configuration.
1535
1536 It accepts in input an arithmetic expression representing a rational.
1537 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
1538 default timebase), and "intb" (the input timebase).
1539
1540 The default value for the input is "intb".
1541
1542 Follow some examples.
1543
1544 @example
1545 # set the timebase to 1/25
1546 settb=1/25
1547
1548 # set the timebase to 1/10
1549 settb=0.1
1550
1551 #set the timebase to 1001/1000
1552 settb=1+0.001
1553
1554 #set the timebase to 2*intb
1555 settb=2*intb
1556
1557 #set the default timebase value
1558 settb=AVTB
1559 @end example
1560
1561 @section showinfo
1562
1563 Show a line containing various information for each input video frame.
1564 The input video is not modified.
1565
1566 The shown line contains a sequence of key/value pairs of the form
1567 @var{key}:@var{value}.
1568
1569 A description of each shown parameter follows:
1570
1571 @table @option
1572 @item n
1573 sequential number of the input frame, starting from 0
1574
1575 @item pts
1576 Presentation TimeStamp of the input frame, expressed as a number of
1577 time base units. The time base unit depends on the filter input pad.
1578
1579 @item pts_time
1580 Presentation TimeStamp of the input frame, expressed as a number of
1581 seconds
1582
1583 @item pos
1584 position of the frame in the input stream, -1 if this information in
1585 unavailable and/or meanigless (for example in case of synthetic video)
1586
1587 @item fmt
1588 pixel format name
1589
1590 @item sar
1591 sample aspect ratio of the input frame, expressed in the form
1592 @var{num}/@var{den}
1593
1594 @item s
1595 size of the input frame, expressed in the form
1596 @var{width}x@var{height}
1597
1598 @item i
1599 interlaced mode ("P" for "progressive", "T" for top field first, "B"
1600 for bottom field first)
1601
1602 @item iskey
1603 1 if the frame is a key frame, 0 otherwise
1604
1605 @item type
1606 picture type of the input frame ("I" for an I-frame, "P" for a
1607 P-frame, "B" for a B-frame, "?" for unknown type).
1608 Check also the documentation of the @code{AVPictureType} enum and of
1609 the @code{av_get_picture_type_char} function defined in
1610 @file{libavutil/avutil.h}.
1611
1612 @item checksum
1613 Adler-32 checksum of all the planes of the input frame
1614
1615 @item plane_checksum
1616 Adler-32 checksum of each plane of the input frame, expressed in the form
1617 "[@var{c0} @var{c1} @var{c2} @var{c3}]"
1618 @end table
1619
1620 @section slicify
1621
1622 Pass the images of input video on to next video filter as multiple
1623 slices.
1624
1625 @example
1626 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
1627 @end example
1628
1629 The filter accepts the slice height as parameter. If the parameter is
1630 not specified it will use the default value of 16.
1631
1632 Adding this in the beginning of filter chains should make filtering
1633 faster due to better use of the memory cache.
1634
1635 @section transpose
1636
1637 Transpose rows with columns in the input video and optionally flip it.
1638
1639 It accepts a parameter representing an integer, which can assume the
1640 values:
1641
1642 @table @samp
1643 @item 0
1644 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
1645 @example
1646 L.R     L.l
1647 . . ->  . .
1648 l.r     R.r
1649 @end example
1650
1651 @item 1
1652 Rotate by 90 degrees clockwise, that is:
1653 @example
1654 L.R     l.L
1655 . . ->  . .
1656 l.r     r.R
1657 @end example
1658
1659 @item 2
1660 Rotate by 90 degrees counterclockwise, that is:
1661 @example
1662 L.R     R.r
1663 . . ->  . .
1664 l.r     L.l
1665 @end example
1666
1667 @item 3
1668 Rotate by 90 degrees clockwise and vertically flip, that is:
1669 @example
1670 L.R     r.R
1671 . . ->  . .
1672 l.r     l.L
1673 @end example
1674 @end table
1675
1676 @section unsharp
1677
1678 Sharpen or blur the input video.
1679
1680 It accepts the following parameters:
1681 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
1682
1683 Negative values for the amount will blur the input video, while positive
1684 values will sharpen. All parameters are optional and default to the
1685 equivalent of the string '5:5:1.0:5:5:0.0'.
1686
1687 @table @option
1688
1689 @item luma_msize_x
1690 Set the luma matrix horizontal size. It can be an integer between 3
1691 and 13, default value is 5.
1692
1693 @item luma_msize_y
1694 Set the luma matrix vertical size. It can be an integer between 3
1695 and 13, default value is 5.
1696
1697 @item luma_amount
1698 Set the luma effect strength. It can be a float number between -2.0
1699 and 5.0, default value is 1.0.
1700
1701 @item chroma_msize_x
1702 Set the chroma matrix horizontal size. It can be an integer between 3
1703 and 13, default value is 5.
1704
1705 @item chroma_msize_y
1706 Set the chroma matrix vertical size. It can be an integer between 3
1707 and 13, default value is 5.
1708
1709 @item luma_amount
1710 Set the chroma effect strength. It can be a float number between -2.0
1711 and 5.0, default value is 0.0.
1712
1713 @end table
1714
1715 @example
1716 # Strong luma sharpen effect parameters
1717 unsharp=7:7:2.5
1718
1719 # Strong blur of both luma and chroma parameters
1720 unsharp=7:7:-2:7:7:-2
1721
1722 # Use the default values with @command{ffmpeg}
1723 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
1724 @end example
1725
1726 @section vflip
1727
1728 Flip the input video vertically.
1729
1730 @example
1731 ./ffmpeg -i in.avi -vf "vflip" out.avi
1732 @end example
1733
1734 @section yadif
1735
1736 Deinterlace the input video ("yadif" means "yet another deinterlacing
1737 filter").
1738
1739 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
1740
1741 @var{mode} specifies the interlacing mode to adopt, accepts one of the
1742 following values:
1743
1744 @table @option
1745 @item 0
1746 output 1 frame for each frame
1747 @item 1
1748 output 1 frame for each field
1749 @item 2
1750 like 0 but skips spatial interlacing check
1751 @item 3
1752 like 1 but skips spatial interlacing check
1753 @end table
1754
1755 Default value is 0.
1756
1757 @var{parity} specifies the picture field parity assumed for the input
1758 interlaced video, accepts one of the following values:
1759
1760 @table @option
1761 @item 0
1762 assume top field first
1763 @item 1
1764 assume bottom field first
1765 @item -1
1766 enable automatic detection
1767 @end table
1768
1769 Default value is -1.
1770 If interlacing is unknown or decoder does not export this information,
1771 top field first will be assumed.
1772
1773 @var{auto] specifies if deinterlacer should trust the interlaced flag
1774 and only deinterlace frames marked as interlaced
1775
1776 @table @option
1777 @item 0
1778 deinterlace all frames
1779 @item 1
1780 only deinterlace frames marked as interlaced
1781 @end table
1782
1783 Default value is 0.
1784
1785 @c man end VIDEO FILTERS
1786
1787 @chapter Video Sources
1788 @c man begin VIDEO SOURCES
1789
1790 Below is a description of the currently available video sources.
1791
1792 @section buffer
1793
1794 Buffer video frames, and make them available to the filter chain.
1795
1796 This source is mainly intended for a programmatic use, in particular
1797 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
1798
1799 It accepts the following parameters:
1800 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den}
1801
1802 All the parameters need to be explicitely defined.
1803
1804 Follows the list of the accepted parameters.
1805
1806 @table @option
1807
1808 @item width, height
1809 Specify the width and height of the buffered video frames.
1810
1811 @item pix_fmt_string
1812 A string representing the pixel format of the buffered video frames.
1813 It may be a number corresponding to a pixel format, or a pixel format
1814 name.
1815
1816 @item timebase_num, timebase_den
1817 Specify numerator and denomitor of the timebase assumed by the
1818 timestamps of the buffered frames.
1819
1820 @item sample_aspect_ratio.num, sample_aspect_ratio.den
1821 Specify numerator and denominator of the sample aspect ratio assumed
1822 by the video frames.
1823 @end table
1824
1825 For example:
1826 @example
1827 buffer=320:240:yuv410p:1:24:1:1
1828 @end example
1829
1830 will instruct the source to accept video frames with size 320x240 and
1831 with format "yuv410p", assuming 1/24 as the timestamps timebase and
1832 square pixels (1:1 sample aspect ratio).
1833 Since the pixel format with name "yuv410p" corresponds to the number 6
1834 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
1835 this example corresponds to:
1836 @example
1837 buffer=320:240:6:1:24
1838 @end example
1839
1840 @section color
1841
1842 Provide an uniformly colored input.
1843
1844 It accepts the following parameters:
1845 @var{color}:@var{frame_size}:@var{frame_rate}
1846
1847 Follows the description of the accepted parameters.
1848
1849 @table @option
1850
1851 @item color
1852 Specify the color of the source. It can be the name of a color (case
1853 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
1854 alpha specifier. The default value is "black".
1855
1856 @item frame_size
1857 Specify the size of the sourced video, it may be a string of the form
1858 @var{width}x@var{height}, or the name of a size abbreviation. The
1859 default value is "320x240".
1860
1861 @item frame_rate
1862 Specify the frame rate of the sourced video, as the number of frames
1863 generated per second. It has to be a string in the format
1864 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
1865 number or a valid video frame rate abbreviation. The default value is
1866 "25".
1867
1868 @end table
1869
1870 For example the following graph description will generate a red source
1871 with an opacity of 0.2, with size "qcif" and a frame rate of 10
1872 frames per second, which will be overlayed over the source connected
1873 to the pad with identifier "in".
1874
1875 @example
1876 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
1877 @end example
1878
1879 @section movie
1880
1881 Read a video stream from a movie container.
1882
1883 It accepts the syntax: @var{movie_name}[:@var{options}] where
1884 @var{movie_name} is the name of the resource to read (not necessarily
1885 a file but also a device or a stream accessed through some protocol),
1886 and @var{options} is an optional sequence of @var{key}=@var{value}
1887 pairs, separated by ":".
1888
1889 The description of the accepted options follows.
1890
1891 @table @option
1892
1893 @item format_name, f
1894 Specifies the format assumed for the movie to read, and can be either
1895 the name of a container or an input device. If not specified the
1896 format is guessed from @var{movie_name} or by probing.
1897
1898 @item seek_point, sp
1899 Specifies the seek point in seconds, the frames will be output
1900 starting from this seek point, the parameter is evaluated with
1901 @code{av_strtod} so the numerical value may be suffixed by an IS
1902 postfix. Default value is "0".
1903
1904 @item stream_index, si
1905 Specifies the index of the video stream to read. If the value is -1,
1906 the best suited video stream will be automatically selected. Default
1907 value is "-1".
1908
1909 @end table
1910
1911 This filter allows to overlay a second video on top of main input of
1912 a filtergraph as shown in this graph:
1913 @example
1914 input -----------> deltapts0 --> overlay --> output
1915                                     ^
1916                                     |
1917 movie --> scale--> deltapts1 -------+
1918 @end example
1919
1920 Some examples follow:
1921 @example
1922 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
1923 # on top of the input labelled as "in".
1924 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1925 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1926
1927 # read from a video4linux2 device, and overlay it on top of the input
1928 # labelled as "in"
1929 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1930 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1931
1932 @end example
1933
1934 @section nullsrc
1935
1936 Null video source, never return images. It is mainly useful as a
1937 template and to be employed in analysis / debugging tools.
1938
1939 It accepts as optional parameter a string of the form
1940 @var{width}:@var{height}:@var{timebase}.
1941
1942 @var{width} and @var{height} specify the size of the configured
1943 source. The default values of @var{width} and @var{height} are
1944 respectively 352 and 288 (corresponding to the CIF size format).
1945
1946 @var{timebase} specifies an arithmetic expression representing a
1947 timebase. The expression can contain the constants "PI", "E", "PHI",
1948 "AVTB" (the default timebase), and defaults to the value "AVTB".
1949
1950 @section frei0r_src
1951
1952 Provide a frei0r source.
1953
1954 To enable compilation of this filter you need to install the frei0r
1955 header and configure Libav with --enable-frei0r.
1956
1957 The source supports the syntax:
1958 @example
1959 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
1960 @end example
1961
1962 @var{size} is the size of the video to generate, may be a string of the
1963 form @var{width}x@var{height} or a frame size abbreviation.
1964 @var{rate} is the rate of the video to generate, may be a string of
1965 the form @var{num}/@var{den} or a frame rate abbreviation.
1966 @var{src_name} is the name to the frei0r source to load. For more
1967 information regarding frei0r and how to set the parameters read the
1968 section @ref{frei0r} in the description of the video filters.
1969
1970 Some examples follow:
1971 @example
1972 # generate a frei0r partik0l source with size 200x200 and framerate 10
1973 # which is overlayed on the overlay filter main input
1974 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
1975 @end example
1976
1977 @section rgbtestsrc, testsrc
1978
1979 The @code{rgbtestsrc} source generates an RGB test pattern useful for
1980 detecting RGB vs BGR issues. You should see a red, green and blue
1981 stripe from top to bottom.
1982
1983 The @code{testsrc} source generates a test video pattern, showing a
1984 color pattern, a scrolling gradient and a timestamp. This is mainly
1985 intended for testing purposes.
1986
1987 Both sources accept an optional sequence of @var{key}=@var{value} pairs,
1988 separated by ":". The description of the accepted options follows.
1989
1990 @table @option
1991
1992 @item size, s
1993 Specify the size of the sourced video, it may be a string of the form
1994 @var{width}x@var{heigth}, or the name of a size abbreviation. The
1995 default value is "320x240".
1996
1997 @item rate, r
1998 Specify the frame rate of the sourced video, as the number of frames
1999 generated per second. It has to be a string in the format
2000 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2001 number or a valid video frame rate abbreviation. The default value is
2002 "25".
2003
2004 @item sar
2005 Set the sample aspect ratio of the sourced video.
2006
2007 @item duration
2008 Set the video duration of the sourced video. The accepted syntax is:
2009 @example
2010 [-]HH[:MM[:SS[.m...]]]
2011 [-]S+[.m...]
2012 @end example
2013 See also the function @code{av_parse_time()}.
2014
2015 If not specified, or the expressed duration is negative, the video is
2016 supposed to be generated forever.
2017 @end table
2018
2019 For example the following:
2020 @example
2021 testsrc=duration=5.3:size=qcif:rate=10
2022 @end example
2023
2024 will generate a video with a duration of 5.3 seconds, with size
2025 176x144 and a framerate of 10 frames per second.
2026
2027 @c man end VIDEO SOURCES
2028
2029 @chapter Video Sinks
2030 @c man begin VIDEO SINKS
2031
2032 Below is a description of the currently available video sinks.
2033
2034 @section nullsink
2035
2036 Null video sink, do absolutely nothing with the input video. It is
2037 mainly useful as a template and to be employed in analysis / debugging
2038 tools.
2039
2040 @c man end VIDEO SINKS
2041