opencore-amr: Add missing initializer braces to shut up gcc warning.
[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 meaning and use of those of the dilate filter
800 (@pxref{dilate}).
801
802 @subsection smooth
803
804 Smooth the input video.
805
806 The filter takes the following parameters:
807 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
808
809 @var{type} is the type of smooth filter to apply, and can be one of
810 the following values: "blur", "blur_no_scale", "median", "gaussian",
811 "bilateral". The default value is "gaussian".
812
813 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
814 parameters whose meanings depend on smooth type. @var{param1} and
815 @var{param2} accept integer positive values or 0, @var{param3} and
816 @var{param4} accept float values.
817
818 The default value for @var{param1} is 3, the default value for the
819 other parameters is 0.
820
821 These parameters correspond to the parameters assigned to the
822 libopencv function @code{cvSmooth}.
823
824 @section overlay
825
826 Overlay one video on top of another.
827
828 It takes two inputs and one output, the first input is the "main"
829 video on which the second input is overlayed.
830
831 It accepts the parameters: @var{x}:@var{y}.
832
833 @var{x} is the x coordinate of the overlayed video on the main video,
834 @var{y} is the y coordinate. The parameters are expressions containing
835 the following parameters:
836
837 @table @option
838 @item main_w, main_h
839 main input width and height
840
841 @item W, H
842 same as @var{main_w} and @var{main_h}
843
844 @item overlay_w, overlay_h
845 overlay input width and height
846
847 @item w, h
848 same as @var{overlay_w} and @var{overlay_h}
849 @end table
850
851 Be aware that frames are taken from each input video in timestamp
852 order, hence, if their initial timestamps differ, it is a a good idea
853 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
854 have them begin in the same zero timestamp, as it does the example for
855 the @var{movie} filter.
856
857 Follow some examples:
858 @example
859 # draw the overlay at 10 pixels from the bottom right
860 # corner of the main video.
861 overlay=main_w-overlay_w-10:main_h-overlay_h-10
862
863 # insert a transparent PNG logo in the bottom left corner of the input
864 movie=logo.png [logo];
865 [in][logo] overlay=10:main_h-overlay_h-10 [out]
866
867 # insert 2 different transparent PNG logos (second logo on bottom
868 # right corner):
869 movie=logo1.png [logo1];
870 movie=logo2.png [logo2];
871 [in][logo1]       overlay=10:H-h-10 [in+logo1];
872 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
873
874 # add a transparent color layer on top of the main video,
875 # WxH specifies the size of the main input to the overlay filter
876 color=red@.3:WxH [over]; [in][over] overlay [out]
877 @end example
878
879 You can chain togheter more overlays but the efficiency of such
880 approach is yet to be tested.
881
882 @section pad
883
884 Add paddings to the input image, and places the original input at the
885 given coordinates @var{x}, @var{y}.
886
887 It accepts the following parameters:
888 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
889
890 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
891 expressions containing the following constants:
892
893 @table @option
894 @item E, PI, PHI
895 the corresponding mathematical approximated values for e
896 (euler number), pi (greek PI), phi (golden ratio)
897
898 @item in_w, in_h
899 the input video width and heigth
900
901 @item iw, ih
902 same as @var{in_w} and @var{in_h}
903
904 @item out_w, out_h
905 the output width and heigth, that is the size of the padded area as
906 specified by the @var{width} and @var{height} expressions
907
908 @item ow, oh
909 same as @var{out_w} and @var{out_h}
910
911 @item x, y
912 x and y offsets as specified by the @var{x} and @var{y}
913 expressions, or NAN if not yet specified
914
915 @item a
916 input display aspect ratio, same as @var{iw} / @var{ih}
917
918 @item hsub, vsub
919 horizontal and vertical chroma subsample values. For example for the
920 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
921 @end table
922
923 Follows the description of the accepted parameters.
924
925 @table @option
926 @item width, height
927
928 Specify the size of the output image with the paddings added. If the
929 value for @var{width} or @var{height} is 0, the corresponding input size
930 is used for the output.
931
932 The @var{width} expression can reference the value set by the
933 @var{height} expression, and viceversa.
934
935 The default value of @var{width} and @var{height} is 0.
936
937 @item x, y
938
939 Specify the offsets where to place the input image in the padded area
940 with respect to the top/left border of the output image.
941
942 The @var{x} expression can reference the value set by the @var{y}
943 expression, and viceversa.
944
945 The default value of @var{x} and @var{y} is 0.
946
947 @item color
948
949 Specify the color of the padded area, it can be the name of a color
950 (case insensitive match) or a 0xRRGGBB[AA] sequence.
951
952 The default value of @var{color} is "black".
953
954 @end table
955
956 Some examples follow:
957
958 @example
959 # Add paddings with color "violet" to the input video. Output video
960 # size is 640x480, the top-left corner of the input video is placed at
961 # column 0, row 40.
962 pad=640:480:0:40:violet
963
964 # pad the input to get an output with dimensions increased bt 3/2,
965 # and put the input video at the center of the padded area
966 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
967
968 # pad the input to get a squared output with size equal to the maximum
969 # value between the input width and height, and put the input video at
970 # the center of the padded area
971 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
972
973 # pad the input to get a final w/h ratio of 16:9
974 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
975
976 # double output size and put the input video in the bottom-right
977 # corner of the output padded area
978 pad="2*iw:2*ih:ow-iw:oh-ih"
979 @end example
980
981 @section pixdesctest
982
983 Pixel format descriptor test filter, mainly useful for internal
984 testing. The output video should be equal to the input video.
985
986 For example:
987 @example
988 format=monow, pixdesctest
989 @end example
990
991 can be used to test the monowhite pixel format descriptor definition.
992
993 @section scale
994
995 Scale the input video to @var{width}:@var{height} and/or convert the image format.
996
997 The parameters @var{width} and @var{height} are expressions containing
998 the following constants:
999
1000 @table @option
1001 @item E, PI, PHI
1002 the corresponding mathematical approximated values for e
1003 (euler number), pi (greek PI), phi (golden ratio)
1004
1005 @item in_w, in_h
1006 the input width and heigth
1007
1008 @item iw, ih
1009 same as @var{in_w} and @var{in_h}
1010
1011 @item out_w, out_h
1012 the output (cropped) width and heigth
1013
1014 @item ow, oh
1015 same as @var{out_w} and @var{out_h}
1016
1017 @item a
1018 input display aspect ratio, same as @var{iw} / @var{ih}
1019
1020 @item hsub, vsub
1021 horizontal and vertical chroma subsample values. For example for the
1022 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1023 @end table
1024
1025 If the input image format is different from the format requested by
1026 the next filter, the scale filter will convert the input to the
1027 requested format.
1028
1029 If the value for @var{width} or @var{height} is 0, the respective input
1030 size is used for the output.
1031
1032 If the value for @var{width} or @var{height} is -1, the scale filter will
1033 use, for the respective output size, a value that maintains the aspect
1034 ratio of the input image.
1035
1036 The default value of @var{width} and @var{height} is 0.
1037
1038 Some examples follow:
1039 @example
1040 # scale the input video to a size of 200x100.
1041 scale=200:100
1042
1043 # scale the input to 2x
1044 scale=2*iw:2*ih
1045 # the above is the same as
1046 scale=2*in_w:2*in_h
1047
1048 # scale the input to half size
1049 scale=iw/2:ih/2
1050
1051 # increase the width, and set the height to the same size
1052 scale=3/2*iw:ow
1053
1054 # seek for Greek harmony
1055 scale=iw:1/PHI*iw
1056 scale=ih*PHI:ih
1057
1058 # increase the height, and set the width to 3/2 of the height
1059 scale=3/2*oh:3/5*ih
1060
1061 # increase the size, but make the size a multiple of the chroma
1062 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1063
1064 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1065 scale='min(500\, iw*3/2):-1'
1066 @end example
1067
1068 @anchor{setdar}
1069 @section setdar
1070
1071 Set the Display Aspect Ratio for the filter output video.
1072
1073 This is done by changing the specified Sample (aka Pixel) Aspect
1074 Ratio, according to the following equation:
1075 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1076
1077 Keep in mind that this filter does not modify the pixel dimensions of
1078 the video frame. Also the display aspect ratio set by this filter may
1079 be changed by later filters in the filterchain, e.g. in case of
1080 scaling or if another "setdar" or a "setsar" filter is applied.
1081
1082 The filter accepts a parameter string which represents the wanted
1083 display aspect ratio.
1084 The parameter can be a floating point number string, or an expression
1085 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1086 numerator and denominator of the aspect ratio.
1087 If the parameter is not specified, it is assumed the value "0:1".
1088
1089 For example to change the display aspect ratio to 16:9, specify:
1090 @example
1091 setdar=16:9
1092 # the above is equivalent to
1093 setdar=1.77777
1094 @end example
1095
1096 See also the "setsar" filter documentation (@pxref{setsar}).
1097
1098 @section setpts
1099
1100 Change the PTS (presentation timestamp) of the input video frames.
1101
1102 Accept in input an expression evaluated through the eval API, which
1103 can contain the following constants:
1104
1105 @table @option
1106 @item PTS
1107 the presentation timestamp in input
1108
1109 @item PI
1110 Greek PI
1111
1112 @item PHI
1113 golden ratio
1114
1115 @item E
1116 Euler number
1117
1118 @item N
1119 the count of the input frame, starting from 0.
1120
1121 @item STARTPTS
1122 the PTS of the first video frame
1123
1124 @item INTERLACED
1125 tell if the current frame is interlaced
1126
1127 @item POS
1128 original position in the file of the frame, or undefined if undefined
1129 for the current frame
1130
1131 @item PREV_INPTS
1132 previous input PTS
1133
1134 @item PREV_OUTPTS
1135 previous output PTS
1136
1137 @end table
1138
1139 Some examples follow:
1140
1141 @example
1142 # start counting PTS from zero
1143 setpts=PTS-STARTPTS
1144
1145 # fast motion
1146 setpts=0.5*PTS
1147
1148 # slow motion
1149 setpts=2.0*PTS
1150
1151 # fixed rate 25 fps
1152 setpts=N/(25*TB)
1153
1154 # fixed rate 25 fps with some jitter
1155 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
1156 @end example
1157
1158 @anchor{setsar}
1159 @section setsar
1160
1161 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1162
1163 Note that as a consequence of the application of this filter, the
1164 output display aspect ratio will change according to the following
1165 equation:
1166 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1167
1168 Keep in mind that the sample aspect ratio set by this filter may be
1169 changed by later filters in the filterchain, e.g. if another "setsar"
1170 or a "setdar" filter is applied.
1171
1172 The filter accepts a parameter string which represents the wanted
1173 sample aspect ratio.
1174 The parameter can be a floating point number string, or an expression
1175 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1176 numerator and denominator of the aspect ratio.
1177 If the parameter is not specified, it is assumed the value "0:1".
1178
1179 For example to change the sample aspect ratio to 10:11, specify:
1180 @example
1181 setsar=10:11
1182 @end example
1183
1184 @section settb
1185
1186 Set the timebase to use for the output frames timestamps.
1187 It is mainly useful for testing timebase configuration.
1188
1189 It accepts in input an arithmetic expression representing a rational.
1190 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
1191 default timebase), and "intb" (the input timebase).
1192
1193 The default value for the input is "intb".
1194
1195 Follow some examples.
1196
1197 @example
1198 # set the timebase to 1/25
1199 settb=1/25
1200
1201 # set the timebase to 1/10
1202 settb=0.1
1203
1204 #set the timebase to 1001/1000
1205 settb=1+0.001
1206
1207 #set the timebase to 2*intb
1208 settb=2*intb
1209
1210 #set the default timebase value
1211 settb=AVTB
1212 @end example
1213
1214 @section slicify
1215
1216 Pass the images of input video on to next video filter as multiple
1217 slices.
1218
1219 @example
1220 ./ffmpeg -i in.avi -vf "slicify=32" out.avi
1221 @end example
1222
1223 The filter accepts the slice height as parameter. If the parameter is
1224 not specified it will use the default value of 16.
1225
1226 Adding this in the beginning of filter chains should make filtering
1227 faster due to better use of the memory cache.
1228
1229 @section transpose
1230
1231 Transpose rows with columns in the input video and optionally flip it.
1232
1233 It accepts a parameter representing an integer, which can assume the
1234 values:
1235
1236 @table @samp
1237 @item 0
1238 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
1239 @example
1240 L.R     L.l
1241 . . ->  . .
1242 l.r     R.r
1243 @end example
1244
1245 @item 1
1246 Rotate by 90 degrees clockwise, that is:
1247 @example
1248 L.R     l.L
1249 . . ->  . .
1250 l.r     r.R
1251 @end example
1252
1253 @item 2
1254 Rotate by 90 degrees counterclockwise, that is:
1255 @example
1256 L.R     R.r
1257 . . ->  . .
1258 l.r     L.l
1259 @end example
1260
1261 @item 3
1262 Rotate by 90 degrees clockwise and vertically flip, that is:
1263 @example
1264 L.R     r.R
1265 . . ->  . .
1266 l.r     l.L
1267 @end example
1268 @end table
1269
1270 @section unsharp
1271
1272 Sharpen or blur the input video.
1273
1274 It accepts the following parameters:
1275 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
1276
1277 Negative values for the amount will blur the input video, while positive
1278 values will sharpen. All parameters are optional and default to the
1279 equivalent of the string '5:5:1.0:0:0:0.0'.
1280
1281 @table @option
1282
1283 @item luma_msize_x
1284 Set the luma matrix horizontal size. It can be an integer between 3
1285 and 13, default value is 5.
1286
1287 @item luma_msize_y
1288 Set the luma matrix vertical size. It can be an integer between 3
1289 and 13, default value is 5.
1290
1291 @item luma_amount
1292 Set the luma effect strength. It can be a float number between -2.0
1293 and 5.0, default value is 1.0.
1294
1295 @item chroma_msize_x
1296 Set the chroma matrix horizontal size. It can be an integer between 3
1297 and 13, default value is 0.
1298
1299 @item chroma_msize_y
1300 Set the chroma matrix vertical size. It can be an integer between 3
1301 and 13, default value is 0.
1302
1303 @item luma_amount
1304 Set the chroma effect strength. It can be a float number between -2.0
1305 and 5.0, default value is 0.0.
1306
1307 @end table
1308
1309 @example
1310 # Strong luma sharpen effect parameters
1311 unsharp=7:7:2.5
1312
1313 # Strong blur of both luma and chroma parameters
1314 unsharp=7:7:-2:7:7:-2
1315
1316 # Use the default values with @command{ffmpeg}
1317 ./ffmpeg -i in.avi -vf "unsharp" out.mp4
1318 @end example
1319
1320 @section vflip
1321
1322 Flip the input video vertically.
1323
1324 @example
1325 ./ffmpeg -i in.avi -vf "vflip" out.avi
1326 @end example
1327
1328 @section yadif
1329
1330 Deinterlace the input video ("yadif" means "yet another deinterlacing
1331 filter").
1332
1333 It accepts the optional parameters: @var{mode}:@var{parity}.
1334
1335 @var{mode} specifies the interlacing mode to adopt, accepts one of the
1336 following values:
1337
1338 @table @option
1339 @item 0
1340 output 1 frame for each frame
1341 @item 1
1342 output 1 frame for each field
1343 @item 2
1344 like 0 but skips spatial interlacing check
1345 @item 3
1346 like 1 but skips spatial interlacing check
1347 @end table
1348
1349 Default value is 0.
1350
1351 @var{parity} specifies the picture field parity assumed for the input
1352 interlaced video, accepts one of the following values:
1353
1354 @table @option
1355 @item 0
1356 assume bottom field first
1357 @item 1
1358 assume top field first
1359 @item -1
1360 enable automatic detection
1361 @end table
1362
1363 Default value is -1.
1364 If interlacing is unknown or decoder does not export this information,
1365 top field first will be assumed.
1366
1367 @c man end VIDEO FILTERS
1368
1369 @chapter Video Sources
1370 @c man begin VIDEO SOURCES
1371
1372 Below is a description of the currently available video sources.
1373
1374 @section buffer
1375
1376 Buffer video frames, and make them available to the filter chain.
1377
1378 This source is mainly intended for a programmatic use, in particular
1379 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
1380
1381 It accepts the following parameters:
1382 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den}
1383
1384 All the parameters need to be explicitely defined.
1385
1386 Follows the list of the accepted parameters.
1387
1388 @table @option
1389
1390 @item width, height
1391 Specify the width and height of the buffered video frames.
1392
1393 @item pix_fmt_string
1394 A string representing the pixel format of the buffered video frames.
1395 It may be a number corresponding to a pixel format, or a pixel format
1396 name.
1397
1398 @item timebase_num, timebase_den
1399 Specify numerator and denomitor of the timebase assumed by the
1400 timestamps of the buffered frames.
1401
1402 @item sample_aspect_ratio.num, sample_aspect_ratio.den
1403 Specify numerator and denominator of the sample aspect ratio assumed
1404 by the video frames.
1405 @end table
1406
1407 For example:
1408 @example
1409 buffer=320:240:yuv410p:1:24:1:1
1410 @end example
1411
1412 will instruct the source to accept video frames with size 320x240 and
1413 with format "yuv410p", assuming 1/24 as the timestamps timebase and
1414 square pixels (1:1 sample aspect ratio).
1415 Since the pixel format with name "yuv410p" corresponds to the number 6
1416 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
1417 this example corresponds to:
1418 @example
1419 buffer=320:240:6:1:24
1420 @end example
1421
1422 @section color
1423
1424 Provide an uniformly colored input.
1425
1426 It accepts the following parameters:
1427 @var{color}:@var{frame_size}:@var{frame_rate}
1428
1429 Follows the description of the accepted parameters.
1430
1431 @table @option
1432
1433 @item color
1434 Specify the color of the source. It can be the name of a color (case
1435 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
1436 alpha specifier. The default value is "black".
1437
1438 @item frame_size
1439 Specify the size of the sourced video, it may be a string of the form
1440 @var{width}x@var{heigth}, or the name of a size abbreviation. The
1441 default value is "320x240".
1442
1443 @item frame_rate
1444 Specify the frame rate of the sourced video, as the number of frames
1445 generated per second. It has to be a string in the format
1446 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
1447 number or a valid video frame rate abbreviation. The default value is
1448 "25".
1449
1450 @end table
1451
1452 For example the following graph description will generate a red source
1453 with an opacity of 0.2, with size "qcif" and a frame rate of 10
1454 frames per second, which will be overlayed over the source connected
1455 to the pad with identifier "in".
1456
1457 @example
1458 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
1459 @end example
1460
1461 @section movie
1462
1463 Read a video stream from a movie container.
1464
1465 It accepts the syntax: @var{movie_name}[:@var{options}] where
1466 @var{movie_name} is the name of the resource to read (not necessarily
1467 a file but also a device or a stream accessed through some protocol),
1468 and @var{options} is an optional sequence of @var{key}=@var{value}
1469 pairs, separated by ":".
1470
1471 The description of the accepted options follows.
1472
1473 @table @option
1474
1475 @item format_name, f
1476 Specifies the format assumed for the movie to read, and can be either
1477 the name of a container or an input device. If not specified the
1478 format is guessed from @var{movie_name} or by probing.
1479
1480 @item seek_point, sp
1481 Specifies the seek point in seconds, the frames will be output
1482 starting from this seek point, the parameter is evaluated with
1483 @code{av_strtod} so the numerical value may be suffixed by an IS
1484 postfix. Default value is "0".
1485
1486 @item stream_index, si
1487 Specifies the index of the video stream to read. If the value is -1,
1488 the best suited video stream will be automatically selected. Default
1489 value is "-1".
1490
1491 @end table
1492
1493 This filter allows to overlay a second video on top of main input of
1494 a filtergraph as shown in this graph:
1495 @example
1496 input -----------> deltapts0 --> overlay --> output
1497                                     ^
1498                                     |
1499 movie --> scale--> deltapts1 -------+
1500 @end example
1501
1502 Some examples follow:
1503 @example
1504 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
1505 # on top of the input labelled as "in".
1506 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1507 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1508
1509 # read from a video4linux2 device, and overlay it on top of the input
1510 # labelled as "in"
1511 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
1512 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
1513
1514 @end example
1515
1516 @section nullsrc
1517
1518 Null video source, never return images. It is mainly useful as a
1519 template and to be employed in analysis / debugging tools.
1520
1521 It accepts as optional parameter a string of the form
1522 @var{width}:@var{height}:@var{timebase}.
1523
1524 @var{width} and @var{height} specify the size of the configured
1525 source. The default values of @var{width} and @var{height} are
1526 respectively 352 and 288 (corresponding to the CIF size format).
1527
1528 @var{timebase} specifies an arithmetic expression representing a
1529 timebase. The expression can contain the constants "PI", "E", "PHI",
1530 "AVTB" (the default timebase), and defaults to the value "AVTB".
1531
1532 @section frei0r_src
1533
1534 Provide a frei0r source.
1535
1536 To enable compilation of this filter you need to install the frei0r
1537 header and configure Libav with --enable-frei0r.
1538
1539 The source supports the syntax:
1540 @example
1541 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
1542 @end example
1543
1544 @var{size} is the size of the video to generate, may be a string of the
1545 form @var{width}x@var{height} or a frame size abbreviation.
1546 @var{rate} is the rate of the video to generate, may be a string of
1547 the form @var{num}/@var{den} or a frame rate abbreviation.
1548 @var{src_name} is the name to the frei0r source to load. For more
1549 information regarding frei0r and how to set the parameters read the
1550 section "frei0r" (@pxref{frei0r}) in the description of the video
1551 filters.
1552
1553 Some examples follow:
1554 @example
1555 # generate a frei0r partik0l source with size 200x200 and framerate 10
1556 # which is overlayed on the overlay filter main input
1557 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
1558 @end example
1559
1560 @c man end VIDEO SOURCES
1561
1562 @chapter Video Sinks
1563 @c man begin VIDEO SINKS
1564
1565 Below is a description of the currently available video sinks.
1566
1567 @section nullsink
1568
1569 Null video sink, do absolutely nothing with the input video. It is
1570 mainly useful as a template and to be employed in analysis / debugging
1571 tools.
1572
1573 @c man end VIDEO SINKS
1574