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