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