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