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