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