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