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