lavfi: add select 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{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 Libav 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 Libav 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 The default value of @var{boxcolor} is "white".
414
415 @item box
416 Used to draw a box around text using background color.
417 Value should be either 1 (enable) or 0 (disable).
418 The default value of @var{box} is 0.
419
420 @item shadowx, shadowy
421 The x and y offsets for the text shadow position with respect to the
422 position of the text. They can be either positive or negative
423 values. Default value for both is "0".
424
425 @item shadowcolor
426 The color to be used for drawing a shadow behind the drawn text.  It
427 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
428 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
429 The default value of @var{shadowcolor} is "black".
430
431 @item ft_load_flags
432 Flags to be used for loading the fonts.
433
434 The flags map the corresponding flags supported by libfreetype, and are
435 a combination of the following values:
436 @table @var
437 @item default
438 @item no_scale
439 @item no_hinting
440 @item render
441 @item no_bitmap
442 @item vertical_layout
443 @item force_autohint
444 @item crop_bitmap
445 @item pedantic
446 @item ignore_global_advance_width
447 @item no_recurse
448 @item ignore_transform
449 @item monochrome
450 @item linear_design
451 @item no_autohint
452 @item end table
453 @end table
454
455 Default value is "render".
456
457 For more information consult the documentation for the FT_LOAD_*
458 libfreetype flags.
459
460 @item tabsize
461 The size in number of spaces to use for rendering the tab.
462 Default value is 4.
463 @end table
464
465 For example the command:
466 @example
467 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
468 @end example
469
470 will draw "Test Text" with font FreeSerif, using the default values
471 for the optional parameters.
472
473 The command:
474 @example
475 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
476           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
477 @end example
478
479 will draw 'Test Text' with font FreeSerif of size 24 at position x=100
480 and y=50 (counting from the top-left corner of the screen), text is
481 yellow with a red box around it. Both the text and the box have an
482 opacity of 20%.
483
484 Note that the double quotes are not necessary if spaces are not used
485 within the parameter list.
486
487 For more information about libfreetype, check:
488 @url{http://www.freetype.org/}.
489
490 @section fade
491
492 Apply fade-in/out effect to input video.
493
494 It accepts the parameters:
495 @var{type}:@var{start_frame}:@var{nb_frames}
496
497 @var{type} specifies if the effect type, can be either "in" for
498 fade-in, or "out" for a fade-out effect.
499
500 @var{start_frame} specifies the number of the start frame for starting
501 to apply the fade effect.
502
503 @var{nb_frames} specifies the number of frames for which the fade
504 effect has to last. At the end of the fade-in effect the output video
505 will have the same intensity as the input video, at the end of the
506 fade-out transition the output video will be completely black.
507
508 A few usage examples follow, usable too as test scenarios.
509 @example
510 # fade in first 30 frames of video
511 fade=in:0:30
512
513 # fade out last 45 frames of a 200-frame video
514 fade=out:155:45
515
516 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
517 fade=in:0:25, fade=out:975:25
518
519 # make first 5 frames black, then fade in from frame 5-24
520 fade=in:5:20
521 @end example
522
523 @section fieldorder
524
525 Transform the field order of the input video.
526
527 It accepts one parameter which specifies the required field order that
528 the input interlaced video will be transformed to. The parameter can
529 assume one of the following values:
530
531 @table @option
532 @item 0 or bff
533 output bottom field first
534 @item 1 or tff
535 output top field first
536 @end table
537
538 Default value is "tff".
539
540 Transformation is achieved by shifting the picture content up or down
541 by one line, and filling the remaining line with appropriate picture content.
542 This method is consistent with most broadcast field order converters.
543
544 If the input video is not flagged as being interlaced, or it is already
545 flagged as being of the required output field order then this filter does
546 not alter the incoming video.
547
548 This filter is very useful when converting to or from PAL DV material,
549 which is bottom field first.
550
551 For example:
552 @example
553 ./ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
554 @end example
555
556 @section fifo
557
558 Buffer input images and send them when they are requested.
559
560 This filter is mainly useful when auto-inserted by the libavfilter
561 framework.
562
563 The filter does not take parameters.
564
565 @section format
566
567 Convert the input video to one of the specified pixel formats.
568 Libavfilter will try to pick one that is supported for the input to
569 the next filter.
570
571 The filter accepts a list of pixel format names, separated by ":",
572 for example "yuv420p:monow:rgb24".
573
574 Some examples follow:
575 @example
576 # convert the input video to the format "yuv420p"
577 format=yuv420p
578
579 # convert the input video to any of the formats in the list
580 format=yuv420p:yuv444p:yuv410p
581 @end example
582
583 @anchor{frei0r}
584 @section frei0r
585
586 Apply a frei0r effect to the input video.
587
588 To enable compilation of this filter you need to install the frei0r
589 header and configure Libav with --enable-frei0r.
590
591 The filter supports the syntax:
592 @example
593 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
594 @end example
595
596 @var{filter_name} is the name to the frei0r effect to load. If the
597 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
598 is searched in each one of the directories specified by the colon
599 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
600 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
601 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
602
603 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
604 for the frei0r effect.
605
606 A frei0r effect parameter can be a boolean (whose values are specified
607 with "y" and "n"), a double, a color (specified by the syntax
608 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
609 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
610 description), a position (specified by the syntax @var{X}/@var{Y},
611 @var{X} and @var{Y} being float numbers) and a string.
612
613 The number and kind of parameters depend on the loaded effect. If an
614 effect parameter is not specified the default value is set.
615
616 Some examples follow:
617 @example
618 # apply the distort0r effect, set the first two double parameters
619 frei0r=distort0r:0.5:0.01
620
621 # apply the colordistance effect, takes a color as first parameter
622 frei0r=colordistance:0.2/0.3/0.4
623 frei0r=colordistance:violet
624 frei0r=colordistance:0x112233
625
626 # apply the perspective effect, specify the top left and top right
627 # image positions
628 frei0r=perspective:0.2/0.2:0.8/0.2
629 @end example
630
631 For more information see:
632 @url{http://piksel.org/frei0r}
633
634 @section gradfun
635
636 Fix the banding artifacts that are sometimes introduced into nearly flat
637 regions by truncation to 8bit colordepth.
638 Interpolate the gradients that should go where the bands are, and
639 dither them.
640
641 This filter is designed for playback only.  Do not use it prior to
642 lossy compression, because compression tends to lose the dither and
643 bring back the bands.
644
645 The filter takes two optional parameters, separated by ':':
646 @var{strength}:@var{radius}
647
648 @var{strength} is the maximum amount by which the filter will change
649 any one pixel. Also the threshold for detecting nearly flat
650 regions. Acceptable values range from .51 to 255, default value is
651 1.2, out-of-range values will be clipped to the valid range.
652
653 @var{radius} is the neighborhood to fit the gradient to. A larger
654 radius makes for smoother gradients, but also prevents the filter from
655 modifying the pixels near detailed regions. Acceptable values are
656 8-32, default value is 16, out-of-range values will be clipped to the
657 valid range.
658
659 @example
660 # default parameters
661 gradfun=1.2:16
662
663 # omitting radius
664 gradfun=1.2
665 @end example
666
667 @section hflip
668
669 Flip the input video horizontally.
670
671 For example to horizontally flip the video in input with
672 @file{ffmpeg}:
673 @example
674 ffmpeg -i in.avi -vf "hflip" out.avi
675 @end example
676
677 @section hqdn3d
678
679 High precision/quality 3d denoise filter. This filter aims to reduce
680 image noise producing smooth images and making still images really
681 still. It should enhance compressibility.
682
683 It accepts the following optional parameters:
684 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
685
686 @table @option
687 @item luma_spatial
688 a non-negative float number which specifies spatial luma strength,
689 defaults to 4.0
690
691 @item chroma_spatial
692 a non-negative float number which specifies spatial chroma strength,
693 defaults to 3.0*@var{luma_spatial}/4.0
694
695 @item luma_tmp
696 a float number which specifies luma temporal strength, defaults to
697 6.0*@var{luma_spatial}/4.0
698
699 @item chroma_tmp
700 a float number which specifies chroma temporal strength, defaults to
701 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
702 @end table
703
704 @section noformat
705
706 Force libavfilter not to use any of the specified pixel formats for the
707 input to the next filter.
708
709 The filter accepts a list of pixel format names, separated by ":",
710 for example "yuv420p:monow:rgb24".
711
712 Some examples follow:
713 @example
714 # force libavfilter to use a format different from "yuv420p" for the
715 # input to the vflip filter
716 noformat=yuv420p,vflip
717
718 # convert the input video to any of the formats not contained in the list
719 noformat=yuv420p:yuv444p:yuv410p
720 @end example
721
722 @section null
723
724 Pass the video source unchanged to the output.
725
726 @section ocv
727
728 Apply video transform using libopencv.
729
730 To enable this filter install libopencv library and headers and
731 configure Libav with --enable-libopencv.
732
733 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
734
735 @var{filter_name} is the name of the libopencv filter to apply.
736
737 @var{filter_params} specifies the parameters to pass to the libopencv
738 filter. If not specified the default values are assumed.
739
740 Refer to the official libopencv documentation for more precise
741 informations:
742 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
743
744 Follows the list of supported libopencv filters.
745
746 @anchor{dilate}
747 @subsection dilate
748
749 Dilate an image by using a specific structuring element.
750 This filter corresponds to the libopencv function @code{cvDilate}.
751
752 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
753
754 @var{struct_el} represents a structuring element, and has the syntax:
755 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
756
757 @var{cols} and @var{rows} represent the number of colums and rows of
758 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
759 point, and @var{shape} the shape for the structuring element, and
760 can be one of the values "rect", "cross", "ellipse", "custom".
761
762 If the value for @var{shape} is "custom", it must be followed by a
763 string of the form "=@var{filename}". The file with name
764 @var{filename} is assumed to represent a binary image, with each
765 printable character corresponding to a bright pixel. When a custom
766 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
767 or columns and rows of the read file are assumed instead.
768
769 The default value for @var{struct_el} is "3x3+0x0/rect".
770
771 @var{nb_iterations} specifies the number of times the transform is
772 applied to the image, and defaults to 1.
773
774 Follow some example:
775 @example
776 # use the default values
777 ocv=dilate
778
779 # dilate using a structuring element with a 5x5 cross, iterate two times
780 ocv=dilate=5x5+2x2/cross:2
781
782 # read the shape from the file diamond.shape, iterate two times
783 # the file diamond.shape may contain a pattern of characters like this:
784 #   *
785 #  ***
786 # *****
787 #  ***
788 #   *
789 # the specified cols and rows are ignored (but not the anchor point coordinates)
790 ocv=0x0+2x2/custom=diamond.shape:2
791 @end example
792
793 @subsection erode
794
795 Erode an image by using a specific structuring element.
796 This filter corresponds to the libopencv function @code{cvErode}.
797
798 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
799 with the same syntax and semantics as the @ref{dilate} filter.
800
801 @subsection smooth
802
803 Smooth the input video.
804
805 The filter takes the following parameters:
806 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
807
808 @var{type} is the type of smooth filter to apply, and can be one of
809 the following values: "blur", "blur_no_scale", "median", "gaussian",
810 "bilateral". The default value is "gaussian".
811
812 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
813 parameters whose meanings depend on smooth type. @var{param1} and
814 @var{param2} accept integer positive values or 0, @var{param3} and
815 @var{param4} accept float values.
816
817 The default value for @var{param1} is 3, the default value for the
818 other parameters is 0.
819
820 These parameters correspond to the parameters assigned to the
821 libopencv function @code{cvSmooth}.
822
823 @section overlay
824
825 Overlay one video on top of another.
826
827 It takes two inputs and one output, the first input is the "main"
828 video on which the second input is overlayed.
829
830 It accepts the parameters: @var{x}:@var{y}.
831
832 @var{x} is the x coordinate of the overlayed video on the main video,
833 @var{y} is the y coordinate. The parameters are expressions containing
834 the following parameters:
835
836 @table @option
837 @item main_w, main_h
838 main input width and height
839
840 @item W, H
841 same as @var{main_w} and @var{main_h}
842
843 @item overlay_w, overlay_h
844 overlay input width and height
845
846 @item w, h
847 same as @var{overlay_w} and @var{overlay_h}
848 @end table
849
850 Be aware that frames are taken from each input video in timestamp
851 order, hence, if their initial timestamps differ, it is a a good idea
852 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
853 have them begin in the same zero timestamp, as it does the example for
854 the @var{movie} filter.
855
856 Follow some examples:
857 @example
858 # draw the overlay at 10 pixels from the bottom right
859 # corner of the main video.
860 overlay=main_w-overlay_w-10:main_h-overlay_h-10
861
862 # insert a transparent PNG logo in the bottom left corner of the input
863 movie=logo.png [logo];
864 [in][logo] overlay=10:main_h-overlay_h-10 [out]
865
866 # insert 2 different transparent PNG logos (second logo on bottom
867 # right corner):
868 movie=logo1.png [logo1];
869 movie=logo2.png [logo2];
870 [in][logo1]       overlay=10:H-h-10 [in+logo1];
871 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
872
873 # add a transparent color layer on top of the main video,
874 # WxH specifies the size of the main input to the overlay filter
875 color=red@.3:WxH [over]; [in][over] overlay [out]
876 @end example
877
878 You can chain togheter more overlays but the efficiency of such
879 approach is yet to be tested.
880
881 @section pad
882
883 Add paddings to the input image, and places the original input at the
884 given coordinates @var{x}, @var{y}.
885
886 It accepts the following parameters:
887 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
888
889 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
890 expressions containing the following constants:
891
892 @table @option
893 @item E, PI, PHI
894 the corresponding mathematical approximated values for e
895 (euler number), pi (greek PI), phi (golden ratio)
896
897 @item in_w, in_h
898 the input video width and heigth
899
900 @item iw, ih
901 same as @var{in_w} and @var{in_h}
902
903 @item out_w, out_h
904 the output width and heigth, that is the size of the padded area as
905 specified by the @var{width} and @var{height} expressions
906
907 @item ow, oh
908 same as @var{out_w} and @var{out_h}
909
910 @item x, y
911 x and y offsets as specified by the @var{x} and @var{y}
912 expressions, or NAN if not yet specified
913
914 @item a
915 input display aspect ratio, same as @var{iw} / @var{ih}
916
917 @item hsub, vsub
918 horizontal and vertical chroma subsample values. For example for the
919 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
920 @end table
921
922 Follows the description of the accepted parameters.
923
924 @table @option
925 @item width, height
926
927 Specify the size of the output image with the paddings added. If the
928 value for @var{width} or @var{height} is 0, the corresponding input size
929 is used for the output.
930
931 The @var{width} expression can reference the value set by the
932 @var{height} expression, and viceversa.
933
934 The default value of @var{width} and @var{height} is 0.
935
936 @item x, y
937
938 Specify the offsets where to place the input image in the padded area
939 with respect to the top/left border of the output image.
940
941 The @var{x} expression can reference the value set by the @var{y}
942 expression, and viceversa.
943
944 The default value of @var{x} and @var{y} is 0.
945
946 @item color
947
948 Specify the color of the padded area, it can be the name of a color
949 (case insensitive match) or a 0xRRGGBB[AA] sequence.
950
951 The default value of @var{color} is "black".
952
953 @end table
954
955 Some examples follow:
956
957 @example
958 # Add paddings with color "violet" to the input video. Output video
959 # size is 640x480, the top-left corner of the input video is placed at
960 # column 0, row 40.
961 pad=640:480:0:40:violet
962
963 # pad the input to get an output with dimensions increased bt 3/2,
964 # and put the input video at the center of the padded area
965 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
966
967 # pad the input to get a squared output with size equal to the maximum
968 # value between the input width and height, and put the input video at
969 # the center of the padded area
970 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
971
972 # pad the input to get a final w/h ratio of 16:9
973 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
974
975 # double output size and put the input video in the bottom-right
976 # corner of the output padded area
977 pad="2*iw:2*ih:ow-iw:oh-ih"
978 @end example
979
980 @section pixdesctest
981
982 Pixel format descriptor test filter, mainly useful for internal
983 testing. The output video should be equal to the input video.
984
985 For example:
986 @example
987 format=monow, pixdesctest
988 @end example
989
990 can be used to test the monowhite pixel format descriptor definition.
991
992 @section scale
993
994 Scale the input video to @var{width}:@var{height} and/or convert the image format.
995
996 The parameters @var{width} and @var{height} are expressions containing
997 the following constants:
998
999 @table @option
1000 @item E, PI, PHI
1001 the corresponding mathematical approximated values for e
1002 (euler number), pi (greek PI), phi (golden ratio)
1003
1004 @item in_w, in_h
1005 the input width and heigth
1006
1007 @item iw, ih
1008 same as @var{in_w} and @var{in_h}
1009
1010 @item out_w, out_h
1011 the output (cropped) width and heigth
1012
1013 @item ow, oh
1014 same as @var{out_w} and @var{out_h}
1015
1016 @item a
1017 input display aspect ratio, same as @var{iw} / @var{ih}
1018
1019 @item hsub, vsub
1020 horizontal and vertical chroma subsample values. For example for the
1021 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1022 @end table
1023
1024 If the input image format is different from the format requested by
1025 the next filter, the scale filter will convert the input to the
1026 requested format.
1027
1028 If the value for @var{width} or @var{height} is 0, the respective input
1029 size is used for the output.
1030
1031 If the value for @var{width} or @var{height} is -1, the scale filter will
1032 use, for the respective output size, a value that maintains the aspect
1033 ratio of the input image.
1034
1035 The default value of @var{width} and @var{height} is 0.
1036
1037 Some examples follow:
1038 @example
1039 # scale the input video to a size of 200x100.
1040 scale=200:100
1041
1042 # scale the input to 2x
1043 scale=2*iw:2*ih
1044 # the above is the same as
1045 scale=2*in_w:2*in_h
1046
1047 # scale the input to half size
1048 scale=iw/2:ih/2
1049
1050 # increase the width, and set the height to the same size
1051 scale=3/2*iw:ow
1052
1053 # seek for Greek harmony
1054 scale=iw:1/PHI*iw
1055 scale=ih*PHI:ih
1056
1057 # increase the height, and set the width to 3/2 of the height
1058 scale=3/2*oh:3/5*ih
1059
1060 # increase the size, but make the size a multiple of the chroma
1061 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1062
1063 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1064 scale='min(500\, iw*3/2):-1'
1065 @end example
1066
1067 @section select
1068 Select frames to pass in output.
1069
1070 It accepts in input an expression, which is evaluated for each input
1071 frame. If the expression is evaluated to a non-zero value, the frame
1072 is selected and passed to the output, otherwise it is discarded.
1073
1074 The expression can contain the following constants:
1075
1076 @table @option
1077 @item PI
1078 Greek PI
1079
1080 @item PHI
1081 golden ratio
1082
1083 @item E
1084 Euler number
1085
1086 @item n
1087 the sequential number of the filtered frame, starting from 0
1088
1089 @item selected_n
1090 the sequential number of the selected frame, starting from 0
1091
1092 @item prev_selected_n
1093 the sequential number of the last selected frame, NAN if undefined
1094
1095 @item TB
1096 timebase of the input timestamps
1097
1098 @item pts
1099 the PTS (Presentation TimeStamp) of the filtered video frame,
1100 expressed in @var{TB} units, NAN if undefined
1101
1102 @item t
1103 the PTS (Presentation TimeStamp) of the filtered video frame,
1104 expressed in seconds, NAN if undefined
1105
1106 @item prev_pts
1107 the PTS of the previously filtered video frame, NAN if undefined
1108
1109 @item prev_selected_pts
1110 the PTS of the last previously filtered video frame, NAN if undefined
1111
1112 @item prev_selected_t
1113 the PTS of the last previously selected video frame, NAN if undefined
1114
1115 @item start_pts
1116 the PTS of the first video frame in the video, NAN if undefined
1117
1118 @item start_t
1119 the time of the first video frame in the video, NAN if undefined
1120
1121 @item pict_type
1122 the type of the filtered frame, can assume one of the following
1123 values:
1124 @table @option
1125 @item I
1126 @item P
1127 @item B
1128 @item S
1129 @item SI
1130 @item SP
1131 @item BI
1132 @end table
1133
1134 @item interlace_type
1135 the frame interlace type, can assume one of the following values:
1136 @table @option
1137 @item PROGRESSIVE
1138 the frame is progressive (not interlaced)
1139 @item TOPFIRST
1140 the frame is top-field-first
1141 @item BOTTOMFIRST
1142 the frame is bottom-field-first
1143 @end table
1144
1145 @item key
1146 1 if the filtered frame is a key-frame, 0 otherwise
1147
1148 @item pos
1149 the position in the file of the filtered frame, -1 if the information
1150 is not available (e.g. for synthetic video)
1151 @end table
1152
1153 The default value of the select expression is "1".
1154
1155 Some examples follow:
1156
1157 @example
1158 # select all frames in input
1159 select
1160
1161 # the above is the same as:
1162 select=1
1163
1164 # skip all frames:
1165 select=0
1166
1167 # select only I-frames
1168 select='eq(pict_type\,I)'
1169
1170 # select one frame every 100
1171 select='not(mod(n\,100))'
1172
1173 # select only frames contained in the 10-20 time interval
1174 select='gte(t\,10)*lte(t\,20)'
1175
1176 # select only I frames contained in the 10-20 time interval
1177 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
1178
1179 # select frames with a minimum distance of 10 seconds
1180 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
1181 @end example
1182
1183 @anchor{setdar}
1184 @section setdar
1185
1186 Set the Display Aspect Ratio for the filter output video.
1187
1188 This is done by changing the specified Sample (aka Pixel) Aspect
1189 Ratio, according to the following equation:
1190 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1191
1192 Keep in mind that this filter does not modify the pixel dimensions of
1193 the video frame. Also the display aspect ratio set by this filter may
1194 be changed by later filters in the filterchain, e.g. in case of
1195 scaling or if another "setdar" or a "setsar" filter is applied.
1196
1197 The filter accepts a parameter string which represents the wanted
1198 display aspect ratio.
1199 The parameter can be a floating point number string, or an expression
1200 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1201 numerator and denominator of the aspect ratio.
1202 If the parameter is not specified, it is assumed the value "0:1".
1203
1204 For example to change the display aspect ratio to 16:9, specify:
1205 @example
1206 setdar=16:9
1207 # the above is equivalent to
1208 setdar=1.77777
1209 @end example
1210
1211 See also the @ref{setsar} filter documentation.
1212
1213 @section setpts
1214
1215 Change the PTS (presentation timestamp) of the input video frames.
1216
1217 Accept in input an expression evaluated through the eval API, which
1218 can contain the following constants:
1219
1220 @table @option
1221 @item PTS
1222 the presentation timestamp in input
1223
1224 @item PI
1225 Greek PI
1226
1227 @item PHI
1228 golden ratio
1229
1230 @item E
1231 Euler number
1232
1233 @item N
1234 the count of the input frame, starting from 0.
1235
1236 @item STARTPTS
1237 the PTS of the first video frame
1238
1239 @item INTERLACED
1240 tell if the current frame is interlaced
1241
1242 @item POS
1243 original position in the file of the frame, or undefined if undefined
1244 for the current frame
1245
1246 @item PREV_INPTS
1247 previous input PTS
1248
1249 @item PREV_OUTPTS
1250 previous output PTS
1251
1252 @end table
1253
1254 Some examples follow:
1255
1256 @example
1257 # start counting PTS from zero
1258 setpts=PTS-STARTPTS
1259
1260 # fast motion
1261 setpts=0.5*PTS
1262
1263 # slow motion
1264 setpts=2.0*PTS
1265
1266 # fixed rate 25 fps
1267 setpts=N/(25*TB)
1268
1269 # fixed rate 25 fps with some jitter
1270 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
1271 @end example
1272
1273 @anchor{setsar}
1274 @section setsar
1275
1276 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1277
1278 Note that as a consequence of the application of this filter, the
1279 output display aspect ratio will change according to the following
1280 equation:
1281 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1282
1283 Keep in mind that the sample aspect ratio set by this filter may be
1284 changed by later filters in the filterchain, e.g. if another "setsar"
1285 or a "setdar" filter is applied.
1286
1287 The filter accepts a parameter string which represents the wanted
1288 sample aspect ratio.
1289 The parameter can be a floating point number string, or an expression
1290 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1291 numerator and denominator of the aspect ratio.
1292 If the parameter is not specified, it is assumed the value "0:1".
1293
1294 For example to change the sample aspect ratio to 10:11, specify:
1295 @example
1296 setsar=10:11
1297 @end example
1298
1299 @section settb
1300
1301 Set the timebase to use for the output frames timestamps.
1302 It is mainly useful for testing timebase configuration.
1303
1304 It accepts in input an arithmetic expression representing a rational.
1305 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
1306 default timebase), and "intb" (the input timebase).
1307
1308 The default value for the input is "intb".
1309
1310 Follow some examples.
1311
1312 @example
1313 # set the timebase to 1/25
1314 settb=1/25
1315
1316 # set the timebase to 1/10
1317 settb=0.1
1318
1319 #set the timebase to 1001/1000
1320 settb=1+0.001
1321
1322 #set the timebase to 2*intb
1323 settb=2*intb
1324
1325 #set the default timebase value
1326 settb=AVTB
1327 @end example
1328
1329 @section showinfo
1330
1331 Show a line containing various information for each input video frame.
1332 The input video is not modified.
1333
1334 The shown line contains a sequence of key/value pairs of the form
1335 @var{key}:@var{value}.
1336
1337 A description of each shown parameter follows:
1338
1339 @table @option
1340 @item n
1341 sequential number of the input frame, starting from 0
1342
1343 @item pts
1344 Presentation TimeStamp of the input frame, expressed as a number of
1345 time base units. The time base unit depends on the filter input pad.
1346
1347 @item pts_time
1348 Presentation TimeStamp of the input frame, expressed as a number of
1349 seconds
1350
1351 @item pos
1352 position of the frame in the input stream, -1 if this information in
1353 unavailable and/or meanigless (for example in case of synthetic video)
1354
1355 @item fmt
1356 pixel format name
1357
1358 @item sar
1359 sample aspect ratio of the input frame, expressed in the form
1360 @var{num}/@var{den}
1361
1362 @item s
1363 size of the input frame, expressed in the form
1364 @var{width}x@var{height}
1365
1366 @item i
1367 interlaced mode ("P" for "progressive", "T" for top field first, "B"
1368 for bottom field first)
1369
1370 @item iskey
1371 1 if the frame is a key frame, 0 otherwise
1372
1373 @item type
1374 picture type of the input frame ("I" for an I-frame, "P" for a
1375 P-frame, "B" for a B-frame, "?" for unknown type).
1376 Check also the documentation of the @code{AVPictureType} enum and of
1377 the @code{av_get_picture_type_char} function defined in
1378 @file{libavutil/avutil.h}.
1379
1380 @item checksum
1381 Adler-32 checksum of all the planes of the input frame
1382
1383 @item plane_checksum
1384 Adler-32 checksum of each plane of the input frame, expressed in the form
1385 "[@var{c0} @var{c1} @var{c2} @var{c3}]"
1386 @end table
1387
1388 @section slicify
1389
1390 Pass the images of input video on to next video filter as multiple
1391 slices.
1392
1393 @example
1394 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
1395 @end example
1396
1397 The filter accepts the slice height as parameter. If the parameter is
1398 not specified it will use the default value of 16.
1399
1400 Adding this in the beginning of filter chains should make filtering
1401 faster due to better use of the memory cache.
1402
1403 @section transpose
1404
1405 Transpose rows with columns in the input video and optionally flip it.
1406
1407 It accepts a parameter representing an integer, which can assume the
1408 values:
1409
1410 @table @samp
1411 @item 0
1412 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
1413 @example
1414 L.R     L.l
1415 . . ->  . .
1416 l.r     R.r
1417 @end example
1418
1419 @item 1
1420 Rotate by 90 degrees clockwise, that is:
1421 @example
1422 L.R     l.L
1423 . . ->  . .
1424 l.r     r.R
1425 @end example
1426
1427 @item 2
1428 Rotate by 90 degrees counterclockwise, that is:
1429 @example
1430 L.R     R.r
1431 . . ->  . .
1432 l.r     L.l
1433 @end example
1434
1435 @item 3
1436 Rotate by 90 degrees clockwise and vertically flip, that is:
1437 @example
1438 L.R     r.R
1439 . . ->  . .
1440 l.r     l.L
1441 @end example
1442 @end table
1443
1444 @section unsharp
1445
1446 Sharpen or blur the input video.
1447
1448 It accepts the following parameters:
1449 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
1450
1451 Negative values for the amount will blur the input video, while positive
1452 values will sharpen. All parameters are optional and default to the
1453 equivalent of the string '5:5:1.0:0:0:0.0'.
1454
1455 @table @option
1456
1457 @item luma_msize_x
1458 Set the luma matrix horizontal size. It can be an integer between 3
1459 and 13, default value is 5.
1460
1461 @item luma_msize_y
1462 Set the luma matrix vertical size. It can be an integer between 3
1463 and 13, default value is 5.
1464
1465 @item luma_amount
1466 Set the luma effect strength. It can be a float number between -2.0
1467 and 5.0, default value is 1.0.
1468
1469 @item chroma_msize_x
1470 Set the chroma matrix horizontal size. It can be an integer between 3
1471 and 13, default value is 0.
1472
1473 @item chroma_msize_y
1474 Set the chroma matrix vertical size. It can be an integer between 3
1475 and 13, default value is 0.
1476
1477 @item luma_amount
1478 Set the chroma effect strength. It can be a float number between -2.0
1479 and 5.0, default value is 0.0.
1480
1481 @end table
1482
1483 @example
1484 # Strong luma sharpen effect parameters
1485 unsharp=7:7:2.5
1486
1487 # Strong blur of both luma and chroma parameters
1488 unsharp=7:7:-2:7:7:-2
1489
1490 # Use the default values with @command{ffmpeg}
1491 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
1492 @end example
1493
1494 @section vflip
1495
1496 Flip the input video vertically.
1497
1498 @example
1499 ./ffmpeg -i in.avi -vf "vflip" out.avi
1500 @end example
1501
1502 @section yadif
1503
1504 Deinterlace the input video ("yadif" means "yet another deinterlacing
1505 filter").
1506
1507 It accepts the optional parameters: @var{mode}:@var{parity}.
1508
1509 @var{mode} specifies the interlacing mode to adopt, accepts one of the
1510 following values:
1511
1512 @table @option
1513 @item 0
1514 output 1 frame for each frame
1515 @item 1
1516 output 1 frame for each field
1517 @item 2
1518 like 0 but skips spatial interlacing check
1519 @item 3
1520 like 1 but skips spatial interlacing check
1521 @end table
1522
1523 Default value is 0.
1524
1525 @var{parity} specifies the picture field parity assumed for the input
1526 interlaced video, accepts one of the following values:
1527
1528 @table @option
1529 @item 0
1530 assume bottom field first
1531 @item 1
1532 assume top field first
1533 @item -1
1534 enable automatic detection
1535 @end table
1536
1537 Default value is -1.
1538 If interlacing is unknown or decoder does not export this information,
1539 top field first will be assumed.
1540
1541 @c man end VIDEO FILTERS
1542
1543 @chapter Video Sources
1544 @c man begin VIDEO SOURCES
1545
1546 Below is a description of the currently available video sources.
1547
1548 @section buffer
1549
1550 Buffer video frames, and make them available to the filter chain.
1551
1552 This source is mainly intended for a programmatic use, in particular
1553 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
1554
1555 It accepts the following parameters:
1556 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den}
1557
1558 All the parameters need to be explicitely defined.
1559
1560 Follows the list of the accepted parameters.
1561
1562 @table @option
1563
1564 @item width, height
1565 Specify the width and height of the buffered video frames.
1566
1567 @item pix_fmt_string
1568 A string representing the pixel format of the buffered video frames.
1569 It may be a number corresponding to a pixel format, or a pixel format
1570 name.
1571
1572 @item timebase_num, timebase_den
1573 Specify numerator and denomitor of the timebase assumed by the
1574 timestamps of the buffered frames.
1575
1576 @item sample_aspect_ratio.num, sample_aspect_ratio.den
1577 Specify numerator and denominator of the sample aspect ratio assumed
1578 by the video frames.
1579 @end table
1580
1581 For example:
1582 @example
1583 buffer=320:240:yuv410p:1:24:1:1
1584 @end example
1585
1586 will instruct the source to accept video frames with size 320x240 and
1587 with format "yuv410p", assuming 1/24 as the timestamps timebase and
1588 square pixels (1:1 sample aspect ratio).
1589 Since the pixel format with name "yuv410p" corresponds to the number 6
1590 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
1591 this example corresponds to:
1592 @example
1593 buffer=320:240:6:1:24
1594 @end example
1595
1596 @section color
1597
1598 Provide an uniformly colored input.
1599
1600 It accepts the following parameters:
1601 @var{color}:@var{frame_size}:@var{frame_rate}
1602
1603 Follows the description of the accepted parameters.
1604
1605 @table @option
1606
1607 @item color
1608 Specify the color of the source. It can be the name of a color (case
1609 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
1610 alpha specifier. The default value is "black".
1611
1612 @item frame_size
1613 Specify the size of the sourced video, it may be a string of the form
1614 @var{width}x@var{heigth}, or the name of a size abbreviation. The
1615 default value is "320x240".
1616
1617 @item frame_rate
1618 Specify the frame rate of the sourced video, as the number of frames
1619 generated per second. It has to be a string in the format
1620 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
1621 number or a valid video frame rate abbreviation. The default value is
1622 "25".
1623
1624 @end table
1625
1626 For example the following graph description will generate a red source
1627 with an opacity of 0.2, with size "qcif" and a frame rate of 10
1628 frames per second, which will be overlayed over the source connected
1629 to the pad with identifier "in".
1630
1631 @example
1632 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
1633 @end example
1634
1635 @section movie
1636
1637 Read a video stream from a movie container.
1638
1639 It accepts the syntax: @var{movie_name}[:@var{options}] where
1640 @var{movie_name} is the name of the resource to read (not necessarily
1641 a file but also a device or a stream accessed through some protocol),
1642 and @var{options} is an optional sequence of @var{key}=@var{value}
1643 pairs, separated by ":".
1644
1645 The description of the accepted options follows.
1646
1647 @table @option
1648
1649 @item format_name, f
1650 Specifies the format assumed for the movie to read, and can be either
1651 the name of a container or an input device. If not specified the
1652 format is guessed from @var{movie_name} or by probing.
1653
1654 @item seek_point, sp
1655 Specifies the seek point in seconds, the frames will be output
1656 starting from this seek point, the parameter is evaluated with
1657 @code{av_strtod} so the numerical value may be suffixed by an IS
1658 postfix. Default value is "0".
1659
1660 @item stream_index, si
1661 Specifies the index of the video stream to read. If the value is -1,
1662 the best suited video stream will be automatically selected. Default
1663 value is "-1".
1664
1665 @end table
1666
1667 This filter allows to overlay a second video on top of main input of
1668 a filtergraph as shown in this graph:
1669 @example
1670 input -----------> deltapts0 --> overlay --> output
1671                                     ^
1672                                     |
1673 movie --> scale--> deltapts1 -------+
1674 @end example
1675
1676 Some examples follow:
1677 @example
1678 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
1679 # on top of the input labelled as "in".
1680 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1681 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1682
1683 # read from a video4linux2 device, and overlay it on top of the input
1684 # labelled as "in"
1685 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1686 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1687
1688 @end example
1689
1690 @section nullsrc
1691
1692 Null video source, never return images. It is mainly useful as a
1693 template and to be employed in analysis / debugging tools.
1694
1695 It accepts as optional parameter a string of the form
1696 @var{width}:@var{height}:@var{timebase}.
1697
1698 @var{width} and @var{height} specify the size of the configured
1699 source. The default values of @var{width} and @var{height} are
1700 respectively 352 and 288 (corresponding to the CIF size format).
1701
1702 @var{timebase} specifies an arithmetic expression representing a
1703 timebase. The expression can contain the constants "PI", "E", "PHI",
1704 "AVTB" (the default timebase), and defaults to the value "AVTB".
1705
1706 @section frei0r_src
1707
1708 Provide a frei0r source.
1709
1710 To enable compilation of this filter you need to install the frei0r
1711 header and configure Libav with --enable-frei0r.
1712
1713 The source supports the syntax:
1714 @example
1715 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
1716 @end example
1717
1718 @var{size} is the size of the video to generate, may be a string of the
1719 form @var{width}x@var{height} or a frame size abbreviation.
1720 @var{rate} is the rate of the video to generate, may be a string of
1721 the form @var{num}/@var{den} or a frame rate abbreviation.
1722 @var{src_name} is the name to the frei0r source to load. For more
1723 information regarding frei0r and how to set the parameters read the
1724 section @ref{frei0r} in the description of the video filters.
1725
1726 Some examples follow:
1727 @example
1728 # generate a frei0r partik0l source with size 200x200 and framerate 10
1729 # which is overlayed on the overlay filter main input
1730 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
1731 @end example
1732
1733 @c man end VIDEO SOURCES
1734
1735 @chapter Video Sinks
1736 @c man begin VIDEO SINKS
1737
1738 Below is a description of the currently available video sinks.
1739
1740 @section nullsink
1741
1742 Null video sink, do absolutely nothing with the input video. It is
1743 mainly useful as a template and to be employed in analysis / debugging
1744 tools.
1745
1746 @c man end VIDEO SINKS
1747