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