80f6fb0a9b9f510615605bba321a389462524cc5
[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{av_parse_graph()} function defined in
22 @file{libavfilter/avfiltergraph}.
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 anull
103
104 Pass the audio source unchanged to the output.
105
106 @c man end AUDIO FILTERS
107
108 @chapter Audio Sources
109 @c man begin AUDIO SOURCES
110
111 Below is a description of the currently available audio sources.
112
113 @section anullsrc
114
115 Null audio source, never return audio frames. It is mainly useful as a
116 template and to be employed in analysis / debugging tools.
117
118 It accepts as optional parameter a string of the form
119 @var{sample_rate}:@var{channel_layout}.
120
121 @var{sample_rate} specify the sample rate, and defaults to 44100.
122
123 @var{channel_layout} specify the channel layout, and can be either an
124 integer or a string representing a channel layout. The default value
125 of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
126
127 Check the channel_layout_map definition in
128 @file{libavcodec/audioconvert.c} for the mapping between strings and
129 channel layout values.
130
131 Follow some examples:
132 @example
133 #  set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
134 anullsrc=48000:4
135
136 # same as
137 anullsrc=48000:mono
138 @end example
139
140 @c man end AUDIO SOURCES
141
142 @chapter Audio Sinks
143 @c man begin AUDIO SINKS
144
145 Below is a description of the currently available audio sinks.
146
147 @section anullsink
148
149 Null audio sink, do absolutely nothing with the input audio. It is
150 mainly useful as a template and to be employed in analysis / debugging
151 tools.
152
153 @c man end AUDIO SINKS
154
155 @chapter Video Filters
156 @c man begin VIDEO FILTERS
157
158 When you configure your FFmpeg build, you can disable any of the
159 existing filters using --disable-filters.
160 The configure output will show the video filters included in your
161 build.
162
163 Below is a description of the currently available video filters.
164
165 @section blackframe
166
167 Detect frames that are (almost) completely black. Can be useful to
168 detect chapter transitions or commercials. Output lines consist of
169 the frame number of the detected frame, the percentage of blackness,
170 the position in the file if known or -1 and the timestamp in seconds.
171
172 In order to display the output lines, you need to set the loglevel at
173 least to the AV_LOG_INFO value.
174
175 The filter accepts the syntax:
176 @example
177 blackframe[=@var{amount}:[@var{threshold}]]
178 @end example
179
180 @var{amount} is the percentage of the pixels that have to be below the
181 threshold, and defaults to 98.
182
183 @var{threshold} is the threshold below which a pixel value is
184 considered black, and defaults to 32.
185
186 @section copy
187
188 Copy the input source unchanged to the output. Mainly useful for
189 testing purposes.
190
191 @section crop
192
193 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
194
195 The parameters are expressions containing the following constants:
196
197 @table @option
198 @item E, PI, PHI
199 the corresponding mathematical approximated values for e
200 (euler number), pi (greek PI), PHI (golden ratio)
201
202 @item x, y
203 the computed values for @var{x} and @var{y}. They are evaluated for
204 each new frame.
205
206 @item in_w, in_h
207 the input width and heigth
208
209 @item iw, ih
210 same as @var{in_w} and @var{in_h}
211
212 @item out_w, out_h
213 the output (cropped) width and heigth
214
215 @item ow, oh
216 same as @var{out_w} and @var{out_h}
217
218 @item n
219 the number of input frame, starting from 0
220
221 @item pos
222 the position in the file of the input frame, NAN if unknown
223
224 @item t
225 timestamp expressed in seconds, NAN if the input timestamp is unknown
226
227 @end table
228
229 The @var{out_w} and @var{out_h} parameters specify the expressions for
230 the width and height of the output (cropped) video. They are
231 evaluated just at the configuration of the filter.
232
233 The default value of @var{out_w} is "in_w", and the default value of
234 @var{out_h} is "in_h".
235
236 The expression for @var{out_w} may depend on the value of @var{out_h},
237 and the expression for @var{out_h} may depend on @var{out_w}, but they
238 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
239 evaluated after @var{out_w} and @var{out_h}.
240
241 The @var{x} and @var{y} parameters specify the expressions for the
242 position of the top-left corner of the output (non-cropped) area. They
243 are evaluated for each frame. If the evaluated value is not valid, it
244 is approximated to the nearest valid value.
245
246 The default value of @var{x} is "(in_w-out_w)/2", and the default
247 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
248 the center of the input image.
249
250 The expression for @var{x} may depend on @var{y}, and the expression
251 for @var{y} may depend on @var{x}.
252
253 Follow some examples:
254 @example
255 # crop the central input area with size 100x100
256 crop=100:100
257
258 # crop the central input area with size 2/3 of the input video
259 "crop=2/3*in_w:2/3*in_h"
260
261 # crop the input video central square
262 crop=in_h
263
264 # delimit the rectangle with the top-left corner placed at position
265 # 100:100 and the right-bottom corner corresponding to the right-bottom
266 # corner of the input image.
267 crop=in_w-100:in_h-100:100:100
268
269 # crop 10 pixels from the left and right borders, and 20 pixels from
270 # the top and bottom borders
271 "crop=in_w-2*10:in_h-2*20"
272
273 # keep only the bottom right quarter of the input image
274 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
275
276 # crop height for getting Greek harmony
277 "crop=in_w:1/PHI*in_w"
278
279 # trembling effect
280 "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)"
281
282 # erratic camera effect depending on timestamp
283 "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)"
284
285 # set x depending on the value of y
286 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
287 @end example
288
289 @section cropdetect
290
291 Auto-detect crop size.
292
293 Calculate necessary cropping parameters and prints the recommended
294 parameters through the logging system. The detected dimensions
295 correspond to the non-black area of the input video.
296
297 It accepts the syntax:
298 @example
299 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
300 @end example
301
302 @table @option
303
304 @item limit
305 Threshold, which can be optionally specified from nothing (0) to
306 everything (255), defaults to 24.
307
308 @item round
309 Value which the width/height should be divisible by, defaults to
310 16. The offset is automatically adjusted to center the video. Use 2 to
311 get only even dimensions (needed for 4:2:2 video). 16 is best when
312 encoding to most video codecs.
313
314 @item reset
315 Counter that determines after how many frames cropdetect will reset
316 the previously detected largest video area and start over to detect
317 the current optimal crop area. Defaults to 0.
318
319 This can be useful when channel logos distort the video area. 0
320 indicates never reset and return the largest area encountered during
321 playback.
322 @end table
323
324 @section drawbox
325
326 Draw a colored box on the input image.
327
328 It accepts the syntax:
329 @example
330 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
331 @end example
332
333 @table @option
334
335 @item x, y
336 Specify the top left corner coordinates of the box. Default to 0.
337
338 @item width, height
339 Specify the width and height of the box, if 0 they are interpreted as
340 the input width and height. Default to 0.
341
342 @item color
343 Specify the color of the box to write, it can be the name of a color
344 (case insensitive match) or a 0xRRGGBB[AA] sequence.
345 @end table
346
347 Follow some examples:
348 @example
349 # draw a black box around the edge of the input image
350 drawbox
351
352 # draw a box with color red and an opacity of 50%
353 drawbox=10:20:200:60:red@@0.5"
354 @end example
355
356 @section drawtext
357
358 Draw text string or text from specified file on top of video using the
359 libfreetype library.
360
361 To enable compilation of this filter you need to configure FFmpeg with
362 @code{--enable-libfreetype}.
363
364 The filter also recognizes strftime() sequences in the provided text
365 and expands them accordingly. Check the documentation of strftime().
366
367 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
368 separated by ":".
369
370 The description of the accepted parameters follows.
371
372 @table @option
373
374 @item fontfile
375 The font file to be used for drawing text. Path must be included.
376 This parameter is mandatory.
377
378 @item text
379 The text string to be drawn. The text must be a sequence of UTF-8
380 encoded characters.
381 This parameter is mandatory if no file is specified with the parameter
382 @var{textfile}.
383
384 @item textfile
385 A text file containing text to be drawn. The text must be a sequence
386 of UTF-8 encoded characters.
387
388 This parameter is mandatory if no text string is specified with the
389 parameter @var{text}.
390
391 If both text and textfile are specified, an error is thrown.
392
393 @item x, y
394 The offsets where text will be drawn within the video frame.
395 Relative to the top/left border of the output image.
396
397 The default value of @var{x} and @var{y} is 0.
398
399 @item fontsize
400 The font size to be used for drawing text.
401 The default value of @var{fontsize} is 16.
402
403 @item fontcolor
404 The color to be used for drawing fonts.
405 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
406 (e.g. "0xff000033"), possibly followed by an alpha specifier.
407 The default value of @var{fontcolor} is "black".
408
409 @item boxcolor
410 The color to be used for drawing box around text.
411 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
412 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
413
414 The default value of @var{bgcolor} is "white".
415
416 @item box
417 Used to draw a box around text using background color.
418 Value should be either 1 (enable) or 0 (disable).
419 The default value of @var{box} is 0.
420
421 @item ft_load_flags
422 Flags to be used for loading the fonts.
423
424 The flags map the corresponding flags supported by libfreetype, and are
425 a combination of the following values:
426 @table @var
427 @item default
428 @item no_scale
429 @item no_hinting
430 @item render
431 @item no_bitmap
432 @item vertical_layout
433 @item force_autohint
434 @item crop_bitmap
435 @item pedantic
436 @item ignore_global_advance_width
437 @item no_recurse
438 @item ignore_transform
439 @item monochrome
440 @item linear_design
441 @item no_autohint
442 @item end table
443 @end table
444
445 Default value is "render".
446
447 For more information consult the documentation for the FT_LOAD_*
448 libfreetype flags.
449
450 @item tabsize
451 The size in number of spaces to use for rendering the tab.
452 Default value is 4.
453 @end table
454
455 For example the command:
456 @example
457 drawtext="fontfile=FreeSerif.ttf: text='Test Text': x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: boxcolor=red@@0.2: box=1"
458 @end example
459
460 will draw 'Test Text' with font FreeSerif of size 24 at position
461 (100,50), text color is yellow, and draw a red box around text. Both
462 the text and the box have an opacity of 20%.
463
464 Note that the double quotes are not necessary if spaces are not used
465 within the parameter list.
466
467 For more information about libfreetype, check:
468 @url{http://www.freetype.org/}.
469
470 @section fade
471
472 Apply fade-in/out effect to input video.
473
474 It accepts the parameters:
475 @var{type}:@var{start_frame}:@var{nb_frames}
476
477 @var{type} specifies if the effect type, can be either "in" for
478 fade-in, or "out" for a fade-out effect.
479
480 @var{start_frame} specifies the number of the start frame for starting
481 to apply the fade effect.
482
483 @var{nb_frames} specifies the number of frames for which the fade
484 effect has to last. At the end of the fade-in effect the output video
485 will have the same intensity as the input video, at the end of the
486 fade-out transition the output video will be completely black.
487
488 A few usage examples follow, usable too as test scenarios.
489 @example
490 # fade in first 30 frames of video
491 fade=in:0:30
492
493 # fade out last 45 frames of a 200-frame video
494 fade=out:155:45
495
496 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
497 fade=in:0:25, fade=out:975:25
498
499 # make first 5 frames black, then fade in from frame 5-24
500 fade=in:5:20
501 @end example
502
503 @section fifo
504
505 Buffer input images and send them when they are requested.
506
507 This filter is mainly useful when auto-inserted by the libavfilter
508 framework.
509
510 The filter does not take parameters.
511
512 @section format
513
514 Convert the input video to one of the specified pixel formats.
515 Libavfilter will try to pick one that is supported for the input to
516 the next filter.
517
518 The filter accepts a list of pixel format names, separated by ":",
519 for example "yuv420p:monow:rgb24".
520
521 Some examples follow:
522 @example
523 # convert the input video to the format "yuv420p"
524 format=yuv420p
525
526 # convert the input video to any of the formats in the list
527 format=yuv420p:yuv444p:yuv410p
528 @end example
529
530 @anchor{frei0r}
531 @section frei0r
532
533 Apply a frei0r effect to the input video.
534
535 To enable compilation of this filter you need to install the frei0r
536 header and configure FFmpeg with --enable-frei0r.
537
538 The filter supports the syntax:
539 @example
540 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
541 @end example
542
543 @var{filter_name} is the name to the frei0r effect to load. If the
544 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
545 is searched in each one of the directories specified by the colon
546 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
547 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
548 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
549
550 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
551 for the frei0r effect.
552
553 A frei0r effect parameter can be a boolean (whose values are specified
554 with "y" and "n"), a double, a color (specified by the syntax
555 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
556 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
557 description), a position (specified by the syntax @var{X}/@var{Y},
558 @var{X} and @var{Y} being float numbers) and a string.
559
560 The number and kind of parameters depend on the loaded effect. If an
561 effect parameter is not specified the default value is set.
562
563 Some examples follow:
564 @example
565 # apply the distort0r effect, set the first two double parameters
566 frei0r=distort0r:0.5:0.01
567
568 # apply the colordistance effect, takes a color as first parameter
569 frei0r=colordistance:0.2/0.3/0.4
570 frei0r=colordistance:violet
571 frei0r=colordistance:0x112233
572
573 # apply the perspective effect, specify the top left and top right
574 # image positions
575 frei0r=perspective:0.2/0.2:0.8/0.2
576 @end example
577
578 For more information see:
579 @url{http://piksel.org/frei0r}
580
581 @section gradfun
582
583 Fix the banding artifacts that are sometimes introduced into nearly flat
584 regions by truncation to 8bit colordepth.
585 Interpolate the gradients that should go where the bands are, and
586 dither them.
587
588 This filter is designed for playback only.  Do not use it prior to
589 lossy compression, because compression tends to lose the dither and
590 bring back the bands.
591
592 The filter takes two optional parameters, separated by ':':
593 @var{strength}:@var{radius}
594
595 @var{strength} is the maximum amount by which the filter will change
596 any one pixel. Also the threshold for detecting nearly flat
597 regions. Acceptable values range from .51 to 255, default value is
598 1.2, out-of-range values will be clipped to the valid range.
599
600 @var{radius} is the neighborhood to fit the gradient to. A larger
601 radius makes for smoother gradients, but also prevents the filter from
602 modifying the pixels near detailed regions. Acceptable values are
603 8-32, default value is 16, out-of-range values will be clipped to the
604 valid range.
605
606 @example
607 # default parameters
608 gradfun=1.2:16
609
610 # omitting radius
611 gradfun=1.2
612 @end example
613
614 @section hflip
615
616 Flip the input video horizontally.
617
618 For example to horizontally flip the video in input with
619 @file{ffmpeg}:
620 @example
621 ffmpeg -i in.avi -vf "hflip" out.avi
622 @end example
623
624 @section hqdn3d
625
626 High precision/quality 3d denoise filter. This filter aims to reduce
627 image noise producing smooth images and making still images really
628 still. It should enhance compressibility.
629
630 It accepts the following optional parameters:
631 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
632
633 @table @option
634 @item luma_spatial
635 a non-negative float number which specifies spatial luma strength,
636 defaults to 4.0
637
638 @item chroma_spatial
639 a non-negative float number which specifies spatial chroma strength,
640 defaults to 3.0*@var{luma_spatial}/4.0
641
642 @item luma_tmp
643 a float number which specifies luma temporal strength, defaults to
644 6.0*@var{luma_spatial}/4.0
645
646 @item chroma_tmp
647 a float number which specifies chroma temporal strength, defaults to
648 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
649 @end table
650
651 @section mp
652
653 Apply an MPlayer filter to the input video.
654
655 This filter provides a wrapper around most of the filters of
656 MPlayer/MEncoder.
657
658 This wrapper is considered experimental. Some of the wrapped filters
659 may not work properly and we may drop support for them, as they will
660 be implemented natively into FFmpeg. Thus you should avoid
661 depending on them when writing portable scripts.
662
663 The filters accepts the parameters:
664 @var{filter_name}[:=]@var{filter_params}
665
666 @var{filter_name} is the name of a supported MPlayer filter,
667 @var{filter_params} is a string containing the parameters accepted by
668 the named filter.
669
670 The list of the currently supported filters follows:
671 @table @var
672 @item 2xsai
673 @item blackframe
674 @item boxblur
675 @item cropdetect
676 @item decimate
677 @item delogo
678 @item denoise3d
679 @item detc
680 @item dint
681 @item divtc
682 @item down3dright
683 @item dsize
684 @item eq2
685 @item eq
686 @item field
687 @item fil
688 @item fixpts
689 @item framestep
690 @item fspp
691 @item geq
692 @item gradfun
693 @item harddup
694 @item hqdn3d
695 @item hue
696 @item il
697 @item ilpack
698 @item ivtc
699 @item kerndeint
700 @item mcdeint
701 @item mirror
702 @item noise
703 @item ow
704 @item palette
705 @item perspective
706 @item phase
707 @item pp7
708 @item pullup
709 @item qp
710 @item rectangle
711 @item remove_logo
712 @item rgbtest
713 @item rotate
714 @item sab
715 @item screenshot
716 @item smartblur
717 @item softpulldown
718 @item softskip
719 @item spp
720 @item swapuv
721 @item telecine
722 @item test
723 @item tile
724 @item tinterlace
725 @item unsharp
726 @item uspp
727 @item yuvcsp
728 @item yvu9
729 @end table
730
731 The parameter syntax and behavior for the listed filters are the same
732 of the corresponding MPlayer filters. For detailed instructions check
733 the "VIDEO FILTERS" section in the MPlayer manual.
734
735 Some examples follow:
736 @example
737 # remove a logo by interpolating the surrounding pixels
738 mp=delogo=200:200:80:20:1
739
740 # adjust gamma, brightness, contrast
741 mp=eq2=1.0:2:0.5
742
743 # tweak hue and saturation
744 mp=hue=100:-10
745 @end example
746
747 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
748
749 @section noformat
750
751 Force libavfilter not to use any of the specified pixel formats for the
752 input to the next filter.
753
754 The filter accepts a list of pixel format names, separated by ":",
755 for example "yuv420p:monow:rgb24".
756
757 Some examples follow:
758 @example
759 # force libavfilter to use a format different from "yuv420p" for the
760 # input to the vflip filter
761 noformat=yuv420p,vflip
762
763 # convert the input video to any of the formats not contained in the list
764 noformat=yuv420p:yuv444p:yuv410p
765 @end example
766
767 @section null
768
769 Pass the video source unchanged to the output.
770
771 @section ocv
772
773 Apply video transform using libopencv.
774
775 To enable this filter install libopencv library and headers and
776 configure FFmpeg with --enable-libopencv.
777
778 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
779
780 @var{filter_name} is the name of the libopencv filter to apply.
781
782 @var{filter_params} specifies the parameters to pass to the libopencv
783 filter. If not specified the default values are assumed.
784
785 Refer to the official libopencv documentation for more precise
786 informations:
787 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
788
789 Follows the list of supported libopencv filters.
790
791 @anchor{dilate}
792 @subsection dilate
793
794 Dilate an image by using a specific structuring element.
795 This filter corresponds to the libopencv function @code{cvDilate}.
796
797 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
798
799 @var{struct_el} represents a structuring element, and has the syntax:
800 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
801
802 @var{cols} and @var{rows} represent the number of colums and rows of
803 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
804 point, and @var{shape} the shape for the structuring element, and
805 can be one of the values "rect", "cross", "ellipse", "custom".
806
807 If the value for @var{shape} is "custom", it must be followed by a
808 string of the form "=@var{filename}". The file with name
809 @var{filename} is assumed to represent a binary image, with each
810 printable character corresponding to a bright pixel. When a custom
811 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
812 or columns and rows of the read file are assumed instead.
813
814 The default value for @var{struct_el} is "3x3+0x0/rect".
815
816 @var{nb_iterations} specifies the number of times the transform is
817 applied to the image, and defaults to 1.
818
819 Follow some example:
820 @example
821 # use the default values
822 ocv=dilate
823
824 # dilate using a structuring element with a 5x5 cross, iterate two times
825 ocv=dilate=5x5+2x2/cross:2
826
827 # read the shape from the file diamond.shape, iterate two times
828 # the file diamond.shape may contain a pattern of characters like this:
829 #   *
830 #  ***
831 # *****
832 #  ***
833 #   *
834 # the specified cols and rows are ignored (but not the anchor point coordinates)
835 ocv=0x0+2x2/custom=diamond.shape:2
836 @end example
837
838 @subsection erode
839
840 Erode an image by using a specific structuring element.
841 This filter corresponds to the libopencv function @code{cvErode}.
842
843 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
844 with the same meaning and use of those of the dilate filter
845 (@pxref{dilate}).
846
847 @subsection smooth
848
849 Smooth the input video.
850
851 The filter takes the following parameters:
852 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
853
854 @var{type} is the type of smooth filter to apply, and can be one of
855 the following values: "blur", "blur_no_scale", "median", "gaussian",
856 "bilateral". The default value is "gaussian".
857
858 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
859 parameters whose meanings depend on smooth type. @var{param1} and
860 @var{param2} accept integer positive values or 0, @var{param3} and
861 @var{param4} accept float values.
862
863 The default value for @var{param1} is 3, the default value for the
864 other parameters is 0.
865
866 These parameters correspond to the parameters assigned to the
867 libopencv function @code{cvSmooth}.
868
869 @section overlay
870
871 Overlay one video on top of another.
872
873 It takes two inputs and one output, the first input is the "main"
874 video on which the second input is overlayed.
875
876 It accepts the parameters: @var{x}:@var{y}.
877
878 @var{x} is the x coordinate of the overlayed video on the main video,
879 @var{y} is the y coordinate. The parameters are expressions containing
880 the following parameters:
881
882 @table @option
883 @item main_w, main_h
884 main input width and height
885
886 @item W, H
887 same as @var{main_w} and @var{main_h}
888
889 @item overlay_w, overlay_h
890 overlay input width and height
891
892 @item w, h
893 same as @var{overlay_w} and @var{overlay_h}
894 @end table
895
896 Be aware that frames are taken from each input video in timestamp
897 order, hence, if their initial timestamps differ, it is a a good idea
898 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
899 have them begin in the same zero timestamp, as it does the example for
900 the @var{movie} filter.
901
902 Follow some examples:
903 @example
904 # draw the overlay at 10 pixels from the bottom right
905 # corner of the main video.
906 overlay=main_w-overlay_w-10:main_h-overlay_h-10
907
908 # insert a transparent PNG logo in the bottom left corner of the input
909 movie=logo.png [logo];
910 [in][logo] overlay=10:main_h-overlay_h-10 [out]
911
912 # insert 2 different transparent PNG logos (second logo on bottom
913 # right corner):
914 movie=logo1.png [logo1];
915 movie=logo2.png [logo2];
916 [in][logo1]       overlay=10:H-h-10 [in+logo1];
917 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
918
919 # add a transparent color layer on top of the main video,
920 # WxH specifies the size of the main input to the overlay filter
921 color=red@.3:WxH [over]; [in][over] overlay [out]
922 @end example
923
924 You can chain togheter more overlays but the efficiency of such
925 approach is yet to be tested.
926
927 @section pad
928
929 Add paddings to the input image, and places the original input at the
930 given coordinates @var{x}, @var{y}.
931
932 It accepts the following parameters:
933 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
934
935 Follows the description of the accepted parameters.
936
937 @table @option
938 @item width, height
939
940 Specify the size of the output image with the paddings added. If the
941 value for @var{width} or @var{height} is 0, the corresponding input size
942 is used for the output.
943
944 The default value of @var{width} and @var{height} is 0.
945
946 @item x, y
947
948 Specify the offsets where to place the input image in the padded area
949 with respect to the top/left border of the output image.
950
951 The default value of @var{x} and @var{y} is 0.
952
953 @item color
954
955 Specify the color of the padded area, it can be the name of a color
956 (case insensitive match) or a 0xRRGGBB[AA] sequence.
957
958 The default value of @var{color} is "black".
959
960 @end table
961
962 For example:
963
964 @example
965 # Add paddings with color "violet" to the input video. Output video
966 # size is 640x480, the top-left corner of the input video is placed at
967 # row 0, column 40.
968 pad=640:480:0:40:violet
969 @end example
970
971 @section pixdesctest
972
973 Pixel format descriptor test filter, mainly useful for internal
974 testing. The output video should be equal to the input video.
975
976 For example:
977 @example
978 format=monow, pixdesctest
979 @end example
980
981 can be used to test the monowhite pixel format descriptor definition.
982
983 @section scale
984
985 Scale the input video to @var{width}:@var{height} and/or convert the image format.
986
987 For example the command:
988
989 @example
990 ./ffmpeg -i in.avi -vf "scale=200:100" out.avi
991 @end example
992
993 will scale the input video to a size of 200x100.
994
995 If the input image format is different from the format requested by
996 the next filter, the scale filter will convert the input to the
997 requested format.
998
999 If the value for @var{width} or @var{height} is 0, the respective input
1000 size is used for the output.
1001
1002 If the value for @var{width} or @var{height} is -1, the scale filter will
1003 use, for the respective output size, a value that maintains the aspect
1004 ratio of the input image.
1005
1006 The default value of @var{width} and @var{height} is 0.
1007
1008 @anchor{setdar}
1009 @section setdar
1010
1011 Set the Display Aspect Ratio for the filter output video.
1012
1013 This is done by changing the specified Sample (aka Pixel) Aspect
1014 Ratio, according to the following equation:
1015 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1016
1017 Keep in mind that this filter does not modify the pixel dimensions of
1018 the video frame. Also the display aspect ratio set by this filter may
1019 be changed by later filters in the filterchain, e.g. in case of
1020 scaling or if another "setdar" or a "setsar" filter is applied.
1021
1022 The filter accepts a parameter string which represents the wanted
1023 display aspect ratio.
1024 The parameter can be a floating point number string, or an expression
1025 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1026 numerator and denominator of the aspect ratio.
1027 If the parameter is not specified, it is assumed the value "0:1".
1028
1029 For example to change the display aspect ratio to 16:9, specify:
1030 @example
1031 setdar=16:9
1032 # the above is equivalent to
1033 setdar=1.77777
1034 @end example
1035
1036 See also the "setsar" filter documentation (@pxref{setsar}).
1037
1038 @section setpts
1039
1040 Change the PTS (presentation timestamp) of the input video frames.
1041
1042 Accept in input an expression evaluated through the eval API, which
1043 can contain the following constants:
1044
1045 @table @option
1046 @item PTS
1047 the presentation timestamp in input
1048
1049 @item PI
1050 Greek PI
1051
1052 @item PHI
1053 golden ratio
1054
1055 @item E
1056 Euler number
1057
1058 @item N
1059 the count of the input frame, starting from 0.
1060
1061 @item STARTPTS
1062 the PTS of the first video frame
1063
1064 @item INTERLACED
1065 tell if the current frame is interlaced
1066
1067 @item POS
1068 original position in the file of the frame, or undefined if undefined
1069 for the current frame
1070
1071 @item PREV_INPTS
1072 previous input PTS
1073
1074 @item PREV_OUTPTS
1075 previous output PTS
1076
1077 @end table
1078
1079 Some examples follow:
1080
1081 @example
1082 # start counting PTS from zero
1083 setpts=PTS-STARTPTS
1084
1085 # fast motion
1086 setpts=0.5*PTS
1087
1088 # slow motion
1089 setpts=2.0*PTS
1090
1091 # fixed rate 25 fps
1092 setpts=N/(25*TB)
1093
1094 # fixed rate 25 fps with some jitter
1095 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
1096 @end example
1097
1098 @anchor{setsar}
1099 @section setsar
1100
1101 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1102
1103 Note that as a consequence of the application of this filter, the
1104 output display aspect ratio will change according to the following
1105 equation:
1106 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1107
1108 Keep in mind that the sample aspect ratio set by this filter may be
1109 changed by later filters in the filterchain, e.g. if another "setsar"
1110 or a "setdar" filter is applied.
1111
1112 The filter accepts a parameter string which represents the wanted
1113 sample aspect ratio.
1114 The parameter can be a floating point number string, or an expression
1115 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1116 numerator and denominator of the aspect ratio.
1117 If the parameter is not specified, it is assumed the value "0:1".
1118
1119 For example to change the sample aspect ratio to 10:11, specify:
1120 @example
1121 setsar=10:11
1122 @end example
1123
1124 @section settb
1125
1126 Set the timebase to use for the output frames timestamps.
1127 It is mainly useful for testing timebase configuration.
1128
1129 It accepts in input an arithmetic expression representing a rational.
1130 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
1131 default timebase), and "intb" (the input timebase).
1132
1133 The default value for the input is "intb".
1134
1135 Follow some examples.
1136
1137 @example
1138 # set the timebase to 1/25
1139 settb=1/25
1140
1141 # set the timebase to 1/10
1142 settb=0.1
1143
1144 #set the timebase to 1001/1000
1145 settb=1+0.001
1146
1147 #set the timebase to 2*intb
1148 settb=2*intb
1149
1150 #set the default timebase value
1151 settb=AVTB
1152 @end example
1153
1154 @section slicify
1155
1156 Pass the images of input video on to next video filter as multiple
1157 slices.
1158
1159 @example
1160 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
1161 @end example
1162
1163 The filter accepts the slice height as parameter. If the parameter is
1164 not specified it will use the default value of 16.
1165
1166 Adding this in the beginning of filter chains should make filtering
1167 faster due to better use of the memory cache.
1168
1169 @section transpose
1170
1171 Transpose rows with columns in the input video and optionally flip it.
1172
1173 It accepts a parameter representing an integer, which can assume the
1174 values:
1175
1176 @table @samp
1177 @item 0
1178 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
1179 @example
1180 L.R     L.l
1181 . . ->  . .
1182 l.r     R.r
1183 @end example
1184
1185 @item 1
1186 Rotate by 90 degrees clockwise, that is:
1187 @example
1188 L.R     l.L
1189 . . ->  . .
1190 l.r     r.R
1191 @end example
1192
1193 @item 2
1194 Rotate by 90 degrees counterclockwise, that is:
1195 @example
1196 L.R     R.r
1197 . . ->  . .
1198 l.r     L.l
1199 @end example
1200
1201 @item 3
1202 Rotate by 90 degrees clockwise and vertically flip, that is:
1203 @example
1204 L.R     r.R
1205 . . ->  . .
1206 l.r     l.L
1207 @end example
1208 @end table
1209
1210 @section unsharp
1211
1212 Sharpen or blur the input video.
1213
1214 It accepts the following parameters:
1215 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
1216
1217 Negative values for the amount will blur the input video, while positive
1218 values will sharpen. All parameters are optional and default to the
1219 equivalent of the string '5:5:1.0:0:0:0.0'.
1220
1221 @table @option
1222
1223 @item luma_msize_x
1224 Set the luma matrix horizontal size. It can be an integer between 3
1225 and 13, default value is 5.
1226
1227 @item luma_msize_y
1228 Set the luma matrix vertical size. It can be an integer between 3
1229 and 13, default value is 5.
1230
1231 @item luma_amount
1232 Set the luma effect strength. It can be a float number between -2.0
1233 and 5.0, default value is 1.0.
1234
1235 @item chroma_msize_x
1236 Set the chroma matrix horizontal size. It can be an integer between 3
1237 and 13, default value is 0.
1238
1239 @item chroma_msize_y
1240 Set the chroma matrix vertical size. It can be an integer between 3
1241 and 13, default value is 0.
1242
1243 @item luma_amount
1244 Set the chroma effect strength. It can be a float number between -2.0
1245 and 5.0, default value is 0.0.
1246
1247 @end table
1248
1249 @example
1250 # Strong luma sharpen effect parameters
1251 unsharp=7:7:2.5
1252
1253 # Strong blur of both luma and chroma parameters
1254 unsharp=7:7:-2:7:7:-2
1255
1256 # Use the default values with @command{ffmpeg}
1257 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
1258 @end example
1259
1260 @section vflip
1261
1262 Flip the input video vertically.
1263
1264 @example
1265 ./ffmpeg -i in.avi -vf "vflip" out.avi
1266 @end example
1267
1268 @section yadif
1269
1270 Deinterlace the input video ("yadif" means "yet another deinterlacing
1271 filter").
1272
1273 It accepts the optional parameters: @var{mode}:@var{parity}.
1274
1275 @var{mode} specifies the interlacing mode to adopt, accepts one of the
1276 following values:
1277
1278 @table @option
1279 @item 0
1280 output 1 frame for each frame
1281 @item 1
1282 output 1 frame for each field
1283 @item 2
1284 like 0 but skips spatial interlacing check
1285 @item 3
1286 like 1 but skips spatial interlacing check
1287 @end table
1288
1289 Default value is 0.
1290
1291 @var{parity} specifies the picture field parity assumed for the input
1292 interlaced video, accepts one of the following values:
1293
1294 @table @option
1295 @item 0
1296 assume bottom field first
1297 @item 1
1298 assume top field first
1299 @item -1
1300 enable automatic detection
1301 @end table
1302
1303 Default value is -1.
1304 If interlacing is unknown or decoder does not export this information,
1305 top field first will be assumed.
1306
1307 @c man end VIDEO FILTERS
1308
1309 @chapter Video Sources
1310 @c man begin VIDEO SOURCES
1311
1312 Below is a description of the currently available video sources.
1313
1314 @section buffer
1315
1316 Buffer video frames, and make them available to the filter chain.
1317
1318 This source is mainly intended for a programmatic use, in particular
1319 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
1320
1321 It accepts the following parameters:
1322 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den}
1323
1324 All the parameters need to be explicitely defined.
1325
1326 Follows the list of the accepted parameters.
1327
1328 @table @option
1329
1330 @item width, height
1331 Specify the width and height of the buffered video frames.
1332
1333 @item pix_fmt_string
1334 A string representing the pixel format of the buffered video frames.
1335 It may be a number corresponding to a pixel format, or a pixel format
1336 name.
1337
1338 @item timebase_num, timebase_den
1339 Specify numerator and denomitor of the timebase assumed by the
1340 timestamps of the buffered frames.
1341
1342 @item sample_aspect_ratio.num, sample_aspect_ratio.den
1343 Specify numerator and denominator of the sample aspect ratio assumed
1344 by the video frames.
1345 @end table
1346
1347 For example:
1348 @example
1349 buffer=320:240:yuv410p:1:24:1:1
1350 @end example
1351
1352 will instruct the source to accept video frames with size 320x240 and
1353 with format "yuv410p", assuming 1/24 as the timestamps timebase and
1354 square pixels (1:1 sample aspect ratio).
1355 Since the pixel format with name "yuv410p" corresponds to the number 6
1356 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
1357 this example corresponds to:
1358 @example
1359 buffer=320:240:6:1:24
1360 @end example
1361
1362 @section color
1363
1364 Provide an uniformly colored input.
1365
1366 It accepts the following parameters:
1367 @var{color}:@var{frame_size}:@var{frame_rate}
1368
1369 Follows the description of the accepted parameters.
1370
1371 @table @option
1372
1373 @item color
1374 Specify the color of the source. It can be the name of a color (case
1375 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
1376 alpha specifier. The default value is "black".
1377
1378 @item frame_size
1379 Specify the size of the sourced video, it may be a string of the form
1380 @var{width}x@var{heigth}, or the name of a size abbreviation. The
1381 default value is "320x240".
1382
1383 @item frame_rate
1384 Specify the frame rate of the sourced video, as the number of frames
1385 generated per second. It has to be a string in the format
1386 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
1387 number or a valid video frame rate abbreviation. The default value is
1388 "25".
1389
1390 @end table
1391
1392 For example the following graph description will generate a red source
1393 with an opacity of 0.2, with size "qcif" and a frame rate of 10
1394 frames per second, which will be overlayed over the source connected
1395 to the pad with identifier "in".
1396
1397 @example
1398 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
1399 @end example
1400
1401 @section movie
1402
1403 Read a video stream from a movie container.
1404
1405 It accepts the syntax: @var{movie_name}[:@var{options}] where
1406 @var{movie_name} is the name of the resource to read (not necessarily
1407 a file but also a device or a stream accessed through some protocol),
1408 and @var{options} is an optional sequence of @var{key}=@var{value}
1409 pairs, separated by ":".
1410
1411 The description of the accepted options follows.
1412
1413 @table @option
1414
1415 @item format_name, f
1416 Specifies the format assumed for the movie to read, and can be either
1417 the name of a container or an input device. If not specified the
1418 format is guessed from @var{movie_name} or by probing.
1419
1420 @item seek_point, sp
1421 Specifies the seek point in seconds, the frames will be output
1422 starting from this seek point, the parameter is evaluated with
1423 @code{av_strtod} so the numerical value may be suffixed by an IS
1424 postfix. Default value is "0".
1425
1426 @item stream_index, si
1427 Specifies the index of the video stream to read. If the value is -1,
1428 the best suited video stream will be automatically selected. Default
1429 value is "-1".
1430
1431 @end table
1432
1433 This filter allows to overlay a second video on top of main input of
1434 a filtergraph as shown in this graph:
1435 @example
1436 input -----------> deltapts0 --> overlay --> output
1437                                     ^
1438                                     |
1439 movie --> scale--> deltapts1 -------+
1440 @end example
1441
1442 Some examples follow:
1443 @example
1444 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
1445 # on top of the input labelled as "in".
1446 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1447 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1448
1449 # read from a video4linux2 device, and overlay it on top of the input
1450 # labelled as "in"
1451 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1452 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1453
1454 @end example
1455
1456 @section nullsrc
1457
1458 Null video source, never return images. It is mainly useful as a
1459 template and to be employed in analysis / debugging tools.
1460
1461 It accepts as optional parameter a string of the form
1462 @var{width}:@var{height}:@var{timebase}.
1463
1464 @var{width} and @var{height} specify the size of the configured
1465 source. The default values of @var{width} and @var{height} are
1466 respectively 352 and 288 (corresponding to the CIF size format).
1467
1468 @var{timebase} specifies an arithmetic expression representing a
1469 timebase. The expression can contain the constants "PI", "E", "PHI",
1470 "AVTB" (the default timebase), and defaults to the value "AVTB".
1471
1472 @section frei0r_src
1473
1474 Provide a frei0r source.
1475
1476 To enable compilation of this filter you need to install the frei0r
1477 header and configure FFmpeg with --enable-frei0r.
1478
1479 The source supports the syntax:
1480 @example
1481 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
1482 @end example
1483
1484 @var{size} is the size of the video to generate, may be a string of the
1485 form @var{width}x@var{height} or a frame size abbreviation.
1486 @var{rate} is the rate of the video to generate, may be a string of
1487 the form @var{num}/@var{den} or a frame rate abbreviation.
1488 @var{src_name} is the name to the frei0r source to load. For more
1489 information regarding frei0r and how to set the parameters read the
1490 section "frei0r" (@pxref{frei0r}) in the description of the video
1491 filters.
1492
1493 Some examples follow:
1494 @example
1495 # generate a frei0r partik0l source with size 200x200 and framerate 10
1496 # which is overlayed on the overlay filter main input
1497 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
1498 @end example
1499
1500 @c man end VIDEO SOURCES
1501
1502 @chapter Video Sinks
1503 @c man begin VIDEO SINKS
1504
1505 Below is a description of the currently available video sinks.
1506
1507 @section nullsink
1508
1509 Null video sink, do absolutely nothing with the input video. It is
1510 mainly useful as a template and to be employed in analysis / debugging
1511 tools.
1512
1513 @c man end VIDEO SINKS
1514