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