lavfi/overlay: add format option
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtering Introduction
2 @c man begin FILTERING INTRODUCTION
3
4 Filtering in FFmpeg is enabled through the libavfilter library.
5
6 In libavfilter, it is possible for filters to have multiple inputs and
7 multiple outputs.
8 To illustrate the sorts of things that are possible, we can
9 use a complex filter graph. For example, the following one:
10
11 @example
12 input --> split ---------------------> overlay --> output
13             |                             ^
14             |                             |
15             +-----> crop --> vflip -------+
16 @end example
17
18 splits the stream in two streams, sends one stream through the crop filter
19 and the vflip filter before merging it back with the other stream by
20 overlaying it on top. You can use the following command to achieve this:
21
22 @example
23 ffmpeg -i input -vf "[in] split [T1], [T2] overlay=0:H/2 [out]; [T1] crop=iw:ih/2:0:ih/2, vflip [T2]" output
24 @end example
25
26 The result will be that in output the top half of the video is mirrored
27 onto the bottom half.
28
29 Filters are loaded using the @var{-vf} or @var{-af} option passed to
30 @command{ffmpeg} or to @command{ffplay}. Filters in the same linear
31 chain are separated by commas. In our example, @var{split,
32 overlay} are in one linear chain, and @var{crop, vflip} are in
33 another. The points where the linear chains join are labeled by names
34 enclosed in square brackets. In our example, that is @var{[T1]} and
35 @var{[T2]}. The special labels @var{[in]} and @var{[out]} are the points
36 where video is input and output.
37
38 Some filters take in input a list of parameters: they are specified
39 after the filter name and an equal sign, and are separated from each other
40 by a colon.
41
42 There exist so-called @var{source filters} that do not have an
43 audio/video input, and @var{sink filters} that will not have audio/video
44 output.
45
46 @c man end FILTERING INTRODUCTION
47
48 @chapter graph2dot
49 @c man begin GRAPH2DOT
50
51 The @file{graph2dot} program included in the FFmpeg @file{tools}
52 directory can be used to parse a filter graph description and issue a
53 corresponding textual representation in the dot language.
54
55 Invoke the command:
56 @example
57 graph2dot -h
58 @end example
59
60 to see how to use @file{graph2dot}.
61
62 You can then pass the dot description to the @file{dot} program (from
63 the graphviz suite of programs) and obtain a graphical representation
64 of the filter graph.
65
66 For example the sequence of commands:
67 @example
68 echo @var{GRAPH_DESCRIPTION} | \
69 tools/graph2dot -o graph.tmp && \
70 dot -Tpng graph.tmp -o graph.png && \
71 display graph.png
72 @end example
73
74 can be used to create and display an image representing the graph
75 described by the @var{GRAPH_DESCRIPTION} string. Note that this string must be
76 a complete self-contained graph, with its inputs and outputs explicitly defined.
77 For example if your command line is of the form:
78 @example
79 ffmpeg -i infile -vf scale=640:360 outfile
80 @end example
81 your @var{GRAPH_DESCRIPTION} string will need to be of the form:
82 @example
83 nullsrc,scale=640:360,nullsink
84 @end example
85 you may also need to set the @var{nullsrc} parameters and add a @var{format}
86 filter in order to simulate a specific input file.
87
88 @c man end GRAPH2DOT
89
90 @chapter Filtergraph description
91 @c man begin FILTERGRAPH DESCRIPTION
92
93 A filtergraph is a directed graph of connected filters. It can contain
94 cycles, and there can be multiple links between a pair of
95 filters. Each link has one input pad on one side connecting it to one
96 filter from which it takes its input, and one output pad on the other
97 side connecting it to the one filter accepting its output.
98
99 Each filter in a filtergraph is an instance of a filter class
100 registered in the application, which defines the features and the
101 number of input and output pads of the filter.
102
103 A filter with no input pads is called a "source", a filter with no
104 output pads is called a "sink".
105
106 @anchor{Filtergraph syntax}
107 @section Filtergraph syntax
108
109 A filtergraph can be represented using a textual representation, which is
110 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
111 options in @command{ffmpeg} and @option{-vf} in @command{ffplay}, and by the
112 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
113 @file{libavfilter/avfiltergraph.h}.
114
115 A filterchain consists of a sequence of connected filters, each one
116 connected to the previous one in the sequence. A filterchain is
117 represented by a list of ","-separated filter descriptions.
118
119 A filtergraph consists of a sequence of filterchains. A sequence of
120 filterchains is represented by a list of ";"-separated filterchain
121 descriptions.
122
123 A filter is represented by a string of the form:
124 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
125
126 @var{filter_name} is the name of the filter class of which the
127 described filter is an instance of, and has to be the name of one of
128 the filter classes registered in the program.
129 The name of the filter class is optionally followed by a string
130 "=@var{arguments}".
131
132 @var{arguments} is a string which contains the parameters used to
133 initialize the filter instance, and are described in the filter
134 descriptions below.
135
136 The list of arguments can be quoted using the character "'" as initial
137 and ending mark, and the character '\' for escaping the characters
138 within the quoted text; otherwise the argument string is considered
139 terminated when the next special character (belonging to the set
140 "[]=;,") is encountered.
141
142 The name and arguments of the filter are optionally preceded and
143 followed by a list of link labels.
144 A link label allows to name a link and associate it to a filter output
145 or input pad. The preceding labels @var{in_link_1}
146 ... @var{in_link_N}, are associated to the filter input pads,
147 the following labels @var{out_link_1} ... @var{out_link_M}, are
148 associated to the output pads.
149
150 When two link labels with the same name are found in the
151 filtergraph, a link between the corresponding input and output pad is
152 created.
153
154 If an output pad is not labelled, it is linked by default to the first
155 unlabelled input pad of the next filter in the filterchain.
156 For example in the filterchain:
157 @example
158 nullsrc, split[L1], [L2]overlay, nullsink
159 @end example
160 the split filter instance has two output pads, and the overlay filter
161 instance two input pads. The first output pad of split is labelled
162 "L1", the first input pad of overlay is labelled "L2", and the second
163 output pad of split is linked to the second input pad of overlay,
164 which are both unlabelled.
165
166 In a complete filterchain all the unlabelled filter input and output
167 pads must be connected. A filtergraph is considered valid if all the
168 filter input and output pads of all the filterchains are connected.
169
170 Libavfilter will automatically insert scale filters where format
171 conversion is required. It is possible to specify swscale flags
172 for those automatically inserted scalers by prepending
173 @code{sws_flags=@var{flags};}
174 to the filtergraph description.
175
176 Follows a BNF description for the filtergraph syntax:
177 @example
178 @var{NAME}             ::= sequence of alphanumeric characters and '_'
179 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
180 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
181 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
182 @var{FILTER}           ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
183 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
184 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
185 @end example
186
187 @section Notes on filtergraph escaping
188
189 Some filter arguments require the use of special characters, typically
190 @code{:} to separate key=value pairs in a named options list. In this
191 case the user should perform a first level escaping when specifying
192 the filter arguments. For example, consider the following literal
193 string to be embedded in the @ref{drawtext} filter arguments:
194 @example
195 this is a 'string': may contain one, or more, special characters
196 @end example
197
198 Since @code{:} is special for the filter arguments syntax, it needs to
199 be escaped, so you get:
200 @example
201 text=this is a \'string\'\: may contain one, or more, special characters
202 @end example
203
204 A second level of escaping is required when embedding the filter
205 arguments in a filtergraph description, in order to escape all the
206 filtergraph special characters. Thus the example above becomes:
207 @example
208 drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
209 @end example
210
211 Finally an additional level of escaping may be needed when writing the
212 filtergraph description in a shell command, which depends on the
213 escaping rules of the adopted shell. For example, assuming that
214 @code{\} is special and needs to be escaped with another @code{\}, the
215 previous string will finally result in:
216 @example
217 -vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
218 @end example
219
220 Sometimes, it might be more convenient to employ quoting in place of
221 escaping. For example the string:
222 @example
223 Caesar: tu quoque, Brute, fili mi
224 @end example
225
226 Can be quoted in the filter arguments as:
227 @example
228 text='Caesar: tu quoque, Brute, fili mi'
229 @end example
230
231 And finally inserted in a filtergraph like:
232 @example
233 drawtext=text=\'Caesar: tu quoque\, Brute\, fili mi\'
234 @end example
235
236 See the ``Quoting and escaping'' section in the ffmpeg-utils manual
237 for more information about the escaping and quoting rules adopted by
238 FFmpeg.
239
240 @c man end FILTERGRAPH DESCRIPTION
241
242 @chapter Audio Filters
243 @c man begin AUDIO FILTERS
244
245 When you configure your FFmpeg build, you can disable any of the
246 existing filters using @code{--disable-filters}.
247 The configure output will show the audio filters included in your
248 build.
249
250 Below is a description of the currently available audio filters.
251
252 @section aconvert
253
254 Convert the input audio format to the specified formats.
255
256 The filter accepts a string of the form:
257 "@var{sample_format}:@var{channel_layout}".
258
259 @var{sample_format} specifies the sample format, and can be a string or the
260 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
261 suffix for a planar sample format.
262
263 @var{channel_layout} specifies the channel layout, and can be a string
264 or the corresponding number value defined in @file{libavutil/channel_layout.h}.
265
266 The special parameter "auto", signifies that the filter will
267 automatically select the output format depending on the output filter.
268
269 Some examples follow.
270
271 @itemize
272 @item
273 Convert input to float, planar, stereo:
274 @example
275 aconvert=fltp:stereo
276 @end example
277
278 @item
279 Convert input to unsigned 8-bit, automatically select out channel layout:
280 @example
281 aconvert=u8:auto
282 @end example
283 @end itemize
284
285 @section allpass
286
287 Apply a two-pole all-pass filter with central frequency (in Hz)
288 @var{frequency}, and filter-width @var{width}.
289 An all-pass filter changes the audio's frequency to phase relationship
290 without changing its frequency to amplitude relationship.
291
292 The filter accepts parameters as a list of @var{key}=@var{value}
293 pairs, separated by ":".
294
295 A description of the accepted parameters follows.
296
297 @table @option
298 @item frequency, f
299 Set frequency in Hz.
300
301 @item width_type
302 Set method to specify band-width of filter.
303 @table @option
304 @item h
305 Hz
306 @item q
307 Q-Factor
308 @item o
309 octave
310 @item s
311 slope
312 @end table
313
314 @item width, w
315 Specify the band-width of a filter in width_type units.
316 @end table
317
318 @section highpass
319
320 Apply a high-pass filter with 3dB point frequency.
321 The filter can be either single-pole, or double-pole (the default).
322 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
323
324 The filter accepts parameters as a list of @var{key}=@var{value}
325 pairs, separated by ":".
326
327 A description of the accepted parameters follows.
328
329 @table @option
330 @item frequency, f
331 Set frequency in Hz. Default is 3000.
332
333 @item poles, p
334 Set number of poles. Default is 2.
335
336 @item width_type
337 Set method to specify band-width of filter.
338 @table @option
339 @item h
340 Hz
341 @item q
342 Q-Factor
343 @item o
344 octave
345 @item s
346 slope
347 @end table
348
349 @item width, w
350 Specify the band-width of a filter in width_type units.
351 Applies only to double-pole filter.
352 The default is 0.707q and gives a Butterworth response.
353 @end table
354
355 @section lowpass
356
357 Apply a low-pass filter with 3dB point frequency.
358 The filter can be either single-pole or double-pole (the default).
359 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
360
361 The filter accepts parameters as a list of @var{key}=@var{value}
362 pairs, separated by ":".
363
364 A description of the accepted parameters follows.
365
366 @table @option
367 @item frequency, f
368 Set frequency in Hz. Default is 500.
369
370 @item poles, p
371 Set number of poles. Default is 2.
372
373 @item width_type
374 Set method to specify band-width of filter.
375 @table @option
376 @item h
377 Hz
378 @item q
379 Q-Factor
380 @item o
381 octave
382 @item s
383 slope
384 @end table
385
386 @item width, w
387 Specify the band-width of a filter in width_type units.
388 Applies only to double-pole filter.
389 The default is 0.707q and gives a Butterworth response.
390 @end table
391
392 @section bass
393
394 Boost or cut the bass (lower) frequencies of the audio using a two-pole
395 shelving filter with a response similar to that of a standard
396 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
397
398 The filter accepts parameters as a list of @var{key}=@var{value}
399 pairs, separated by ":".
400
401 A description of the accepted parameters follows.
402
403 @table @option
404 @item gain, g
405 Give the gain at 0 Hz. Its useful range is about -20
406 (for a large cut) to +20 (for a large boost).
407 Beware of clipping when using a positive gain.
408
409 @item frequency, f
410 Set the filter's central frequency and so can be used
411 to extend or reduce the frequency range to be boosted or cut.
412 The default value is @code{100} Hz.
413
414 @item width_type
415 Set method to specify band-width of filter.
416 @table @option
417 @item h
418 Hz
419 @item q
420 Q-Factor
421 @item o
422 octave
423 @item s
424 slope
425 @end table
426
427 @item width, w
428 Determine how steep is the filter's shelf transition.
429 @end table
430
431 @section treble
432
433 Boost or cut treble (upper) frequencies of the audio using a two-pole
434 shelving filter with a response similar to that of a standard
435 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
436
437 The filter accepts parameters as a list of @var{key}=@var{value}
438 pairs, separated by ":".
439
440 A description of the accepted parameters follows.
441
442 @table @option
443 @item gain, g
444 Give the gain at whichever is the lower of ~22 kHz and the
445 Nyquist frequency. Its useful range is about -20 (for a large cut)
446 to +20 (for a large boost). Beware of clipping when using a positive gain.
447
448 @item frequency, f
449 Set the filter's central frequency and so can be used
450 to extend or reduce the frequency range to be boosted or cut.
451 The default value is @code{3000} Hz.
452
453 @item width_type
454 Set method to specify band-width of filter.
455 @table @option
456 @item h
457 Hz
458 @item q
459 Q-Factor
460 @item o
461 octave
462 @item s
463 slope
464 @end table
465
466 @item width, w
467 Determine how steep is the filter's shelf transition.
468 @end table
469
470 @section bandpass
471
472 Apply a two-pole Butterworth band-pass filter with central
473 frequency @var{frequency}, and (3dB-point) band-width width.
474 The @var{csg} option selects a constant skirt gain (peak gain = Q)
475 instead of the default: constant 0dB peak gain.
476 The filter roll off at 6dB per octave (20dB per decade).
477
478 The filter accepts parameters as a list of @var{key}=@var{value}
479 pairs, separated by ":".
480
481 A description of the accepted parameters follows.
482
483 @table @option
484 @item frequency, f
485 Set the filter's central frequency. Default is @code{3000}.
486
487 @item csg
488 Constant skirt gain if set to 1. Defaults to 0.
489
490 @item width_type
491 Set method to specify band-width of filter.
492 @table @option
493 @item h
494 Hz
495 @item q
496 Q-Factor
497 @item o
498 octave
499 @item s
500 slope
501 @end table
502
503 @item width, w
504 Specify the band-width of a filter in width_type units.
505 @end table
506
507 @section bandreject
508
509 Apply a two-pole Butterworth band-reject filter with central
510 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
511 The filter roll off at 6dB per octave (20dB per decade).
512
513 The filter accepts parameters as a list of @var{key}=@var{value}
514 pairs, separated by ":".
515
516 A description of the accepted parameters follows.
517
518 @table @option
519 @item frequency, f
520 Set the filter's central frequency. Default is @code{3000}.
521
522 @item width_type
523 Set method to specify band-width of filter.
524 @table @option
525 @item h
526 Hz
527 @item q
528 Q-Factor
529 @item o
530 octave
531 @item s
532 slope
533 @end table
534
535 @item width, w
536 Specify the band-width of a filter in width_type units.
537 @end table
538
539 @section biquad
540
541 Apply a biquad IIR filter with the given coefficients.
542 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
543 are the numerator and denominator coefficients respectively.
544
545 @section equalizer
546
547 Apply a two-pole peaking equalisation (EQ) filter. With this
548 filter, the signal-level at and around a selected frequency can
549 be increased or decreased, whilst (unlike bandpass and bandreject
550 filters) that at all other frequencies is unchanged.
551
552 In order to produce complex equalisation curves, this filter can
553 be given several times, each with a different central frequency.
554
555 The filter accepts parameters as a list of @var{key}=@var{value}
556 pairs, separated by ":".
557
558 A description of the accepted parameters follows.
559
560 @table @option
561 @item frequency, f
562 Set the filter's central frequency in Hz.
563
564 @item width_type
565 Set method to specify band-width of filter.
566 @table @option
567 @item h
568 Hz
569 @item q
570 Q-Factor
571 @item o
572 octave
573 @item s
574 slope
575 @end table
576
577 @item width, w
578 Specify the band-width of a filter in width_type units.
579
580 @item gain, g
581 Set the required gain or attenuation in dB.
582 Beware of clipping when using a positive gain.
583 @end table
584
585 @section afade
586
587 Apply fade-in/out effect to input audio.
588
589 The filter accepts parameters as a list of @var{key}=@var{value}
590 pairs, separated by ":".
591
592 A description of the accepted parameters follows.
593
594 @table @option
595 @item type, t
596 Specify the effect type, can be either @code{in} for fade-in, or
597 @code{out} for a fade-out effect. Default is @code{in}.
598
599 @item start_sample, ss
600 Specify the number of the start sample for starting to apply the fade
601 effect. Default is 0.
602
603 @item nb_samples, ns
604 Specify the number of samples for which the fade effect has to last. At
605 the end of the fade-in effect the output audio will have the same
606 volume as the input audio, at the end of the fade-out transition
607 the output audio will be silence. Default is 44100.
608
609 @item start_time, st
610 Specify time in seconds for starting to apply the fade
611 effect. Default is 0.
612 If set this option is used instead of @var{start_sample} one.
613
614 @item duration, d
615 Specify the number of seconds for which the fade effect has to last. At
616 the end of the fade-in effect the output audio will have the same
617 volume as the input audio, at the end of the fade-out transition
618 the output audio will be silence. Default is 0.
619 If set this option is used instead of @var{nb_samples} one.
620
621 @item curve
622 Set curve for fade transition.
623
624 It accepts the following values:
625 @table @option
626 @item tri
627 select triangular, linear slope (default)
628 @item qsin
629 select quarter of sine wave
630 @item hsin
631 select half of sine wave
632 @item esin
633 select exponential sine wave
634 @item log
635 select logarithmic
636 @item par
637 select inverted parabola
638 @item qua
639 select quadratic
640 @item cub
641 select cubic
642 @item squ
643 select square root
644 @item cbr
645 select cubic root
646 @end table
647 @end table
648
649 @subsection Examples
650 @itemize
651 @item
652 Fade in first 15 seconds of audio:
653 @example
654 afade=t=in:ss=0:d=15
655 @end example
656
657 @item
658 Fade out last 25 seconds of a 900 seconds audio:
659 @example
660 afade=t=out:ss=875:d=25
661 @end example
662 @end itemize
663
664 @section aformat
665
666 Set output format constraints for the input audio. The framework will
667 negotiate the most appropriate format to minimize conversions.
668
669 The filter accepts the following named parameters:
670 @table @option
671
672 @item sample_fmts
673 A comma-separated list of requested sample formats.
674
675 @item sample_rates
676 A comma-separated list of requested sample rates.
677
678 @item channel_layouts
679 A comma-separated list of requested channel layouts.
680
681 @end table
682
683 If a parameter is omitted, all values are allowed.
684
685 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
686 @example
687 aformat='sample_fmts=u8,s16:channel_layouts=stereo'
688 @end example
689
690 @section amerge
691
692 Merge two or more audio streams into a single multi-channel stream.
693
694 The filter accepts the following named options:
695
696 @table @option
697
698 @item inputs
699 Set the number of inputs. Default is 2.
700
701 @end table
702
703 If the channel layouts of the inputs are disjoint, and therefore compatible,
704 the channel layout of the output will be set accordingly and the channels
705 will be reordered as necessary. If the channel layouts of the inputs are not
706 disjoint, the output will have all the channels of the first input then all
707 the channels of the second input, in that order, and the channel layout of
708 the output will be the default value corresponding to the total number of
709 channels.
710
711 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
712 is FC+BL+BR, then the output will be in 5.1, with the channels in the
713 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
714 first input, b1 is the first channel of the second input).
715
716 On the other hand, if both input are in stereo, the output channels will be
717 in the default order: a1, a2, b1, b2, and the channel layout will be
718 arbitrarily set to 4.0, which may or may not be the expected value.
719
720 All inputs must have the same sample rate, and format.
721
722 If inputs do not have the same duration, the output will stop with the
723 shortest.
724
725 Example: merge two mono files into a stereo stream:
726 @example
727 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
728 @end example
729
730 Example: multiple merges:
731 @example
732 ffmpeg -f lavfi -i "
733 amovie=input.mkv:si=0 [a0];
734 amovie=input.mkv:si=1 [a1];
735 amovie=input.mkv:si=2 [a2];
736 amovie=input.mkv:si=3 [a3];
737 amovie=input.mkv:si=4 [a4];
738 amovie=input.mkv:si=5 [a5];
739 [a0][a1][a2][a3][a4][a5] amerge=inputs=6" -c:a pcm_s16le output.mkv
740 @end example
741
742 @section amix
743
744 Mixes multiple audio inputs into a single output.
745
746 For example
747 @example
748 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
749 @end example
750 will mix 3 input audio streams to a single output with the same duration as the
751 first input and a dropout transition time of 3 seconds.
752
753 The filter accepts the following named parameters:
754 @table @option
755
756 @item inputs
757 Number of inputs. If unspecified, it defaults to 2.
758
759 @item duration
760 How to determine the end-of-stream.
761 @table @option
762
763 @item longest
764 Duration of longest input. (default)
765
766 @item shortest
767 Duration of shortest input.
768
769 @item first
770 Duration of first input.
771
772 @end table
773
774 @item dropout_transition
775 Transition time, in seconds, for volume renormalization when an input
776 stream ends. The default value is 2 seconds.
777
778 @end table
779
780 @section anull
781
782 Pass the audio source unchanged to the output.
783
784 @section apad
785
786 Pad the end of a audio stream with silence, this can be used together with
787 -shortest to extend audio streams to the same length as the video stream.
788
789 @anchor{aresample}
790 @section aresample
791
792 Resample the input audio to the specified parameters, using the
793 libswresample library. If none are specified then the filter will
794 automatically convert between its input and output.
795
796 This filter is also able to stretch/squeeze the audio data to make it match
797 the timestamps or to inject silence / cut out audio to make it match the
798 timestamps, do a combination of both or do neither.
799
800 The filter accepts the syntax
801 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
802 expresses a sample rate and @var{resampler_options} is a list of
803 @var{key}=@var{value} pairs, separated by ":". See the
804 ffmpeg-resampler manual for the complete list of supported options.
805
806 For example, to resample the input audio to 44100Hz:
807 @example
808 aresample=44100
809 @end example
810
811 To stretch/squeeze samples to the given timestamps, with a maximum of 1000
812 samples per second compensation:
813 @example
814 aresample=async=1000
815 @end example
816
817 @section asetnsamples
818
819 Set the number of samples per each output audio frame.
820
821 The last output packet may contain a different number of samples, as
822 the filter will flush all the remaining samples when the input audio
823 signal its end.
824
825 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
826 separated by ":".
827
828 @table @option
829
830 @item nb_out_samples, n
831 Set the number of frames per each output audio frame. The number is
832 intended as the number of samples @emph{per each channel}.
833 Default value is 1024.
834
835 @item pad, p
836 If set to 1, the filter will pad the last audio frame with zeroes, so
837 that the last frame will contain the same number of samples as the
838 previous ones. Default value is 1.
839 @end table
840
841 For example, to set the number of per-frame samples to 1234 and
842 disable padding for the last frame, use:
843 @example
844 asetnsamples=n=1234:p=0
845 @end example
846
847 @section ashowinfo
848
849 Show a line containing various information for each input audio frame.
850 The input audio is not modified.
851
852 The shown line contains a sequence of key/value pairs of the form
853 @var{key}:@var{value}.
854
855 A description of each shown parameter follows:
856
857 @table @option
858 @item n
859 sequential number of the input frame, starting from 0
860
861 @item pts
862 Presentation timestamp of the input frame, in time base units; the time base
863 depends on the filter input pad, and is usually 1/@var{sample_rate}.
864
865 @item pts_time
866 presentation timestamp of the input frame in seconds
867
868 @item pos
869 position of the frame in the input stream, -1 if this information in
870 unavailable and/or meaningless (for example in case of synthetic audio)
871
872 @item fmt
873 sample format
874
875 @item chlayout
876 channel layout
877
878 @item rate
879 sample rate for the audio frame
880
881 @item nb_samples
882 number of samples (per channel) in the frame
883
884 @item checksum
885 Adler-32 checksum (printed in hexadecimal) of the audio data. For planar audio
886 the data is treated as if all the planes were concatenated.
887
888 @item plane_checksums
889 A list of Adler-32 checksums for each data plane.
890 @end table
891
892 @section asplit
893
894 Split input audio into several identical outputs.
895
896 The filter accepts a single parameter which specifies the number of outputs. If
897 unspecified, it defaults to 2.
898
899 For example:
900 @example
901 [in] asplit [out0][out1]
902 @end example
903
904 will create two separate outputs from the same input.
905
906 To create 3 or more outputs, you need to specify the number of
907 outputs, like in:
908 @example
909 [in] asplit=3 [out0][out1][out2]
910 @end example
911
912 @example
913 ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
914 @end example
915 will create 5 copies of the input audio.
916
917
918 @section astreamsync
919
920 Forward two audio streams and control the order the buffers are forwarded.
921
922 The argument to the filter is an expression deciding which stream should be
923 forwarded next: if the result is negative, the first stream is forwarded; if
924 the result is positive or zero, the second stream is forwarded. It can use
925 the following variables:
926
927 @table @var
928 @item b1 b2
929 number of buffers forwarded so far on each stream
930 @item s1 s2
931 number of samples forwarded so far on each stream
932 @item t1 t2
933 current timestamp of each stream
934 @end table
935
936 The default value is @code{t1-t2}, which means to always forward the stream
937 that has a smaller timestamp.
938
939 Example: stress-test @code{amerge} by randomly sending buffers on the wrong
940 input, while avoiding too much of a desynchronization:
941 @example
942 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
943 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
944 [a2] [b2] amerge
945 @end example
946
947 @section atempo
948
949 Adjust audio tempo.
950
951 The filter accepts exactly one parameter, the audio tempo. If not
952 specified then the filter will assume nominal 1.0 tempo. Tempo must
953 be in the [0.5, 2.0] range.
954
955 For example, to slow down audio to 80% tempo:
956 @example
957 atempo=0.8
958 @end example
959
960 For example, to speed up audio to 125% tempo:
961 @example
962 atempo=1.25
963 @end example
964
965 @section earwax
966
967 Make audio easier to listen to on headphones.
968
969 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
970 so that when listened to on headphones the stereo image is moved from
971 inside your head (standard for headphones) to outside and in front of
972 the listener (standard for speakers).
973
974 Ported from SoX.
975
976 @section pan
977
978 Mix channels with specific gain levels. The filter accepts the output
979 channel layout followed by a set of channels definitions.
980
981 This filter is also designed to remap efficiently the channels of an audio
982 stream.
983
984 The filter accepts parameters of the form:
985 "@var{l}:@var{outdef}:@var{outdef}:..."
986
987 @table @option
988 @item l
989 output channel layout or number of channels
990
991 @item outdef
992 output channel specification, of the form:
993 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
994
995 @item out_name
996 output channel to define, either a channel name (FL, FR, etc.) or a channel
997 number (c0, c1, etc.)
998
999 @item gain
1000 multiplicative coefficient for the channel, 1 leaving the volume unchanged
1001
1002 @item in_name
1003 input channel to use, see out_name for details; it is not possible to mix
1004 named and numbered input channels
1005 @end table
1006
1007 If the `=' in a channel specification is replaced by `<', then the gains for
1008 that specification will be renormalized so that the total is 1, thus
1009 avoiding clipping noise.
1010
1011 @subsection Mixing examples
1012
1013 For example, if you want to down-mix from stereo to mono, but with a bigger
1014 factor for the left channel:
1015 @example
1016 pan=1:c0=0.9*c0+0.1*c1
1017 @end example
1018
1019 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
1020 7-channels surround:
1021 @example
1022 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
1023 @end example
1024
1025 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
1026 that should be preferred (see "-ac" option) unless you have very specific
1027 needs.
1028
1029 @subsection Remapping examples
1030
1031 The channel remapping will be effective if, and only if:
1032
1033 @itemize
1034 @item gain coefficients are zeroes or ones,
1035 @item only one input per channel output,
1036 @end itemize
1037
1038 If all these conditions are satisfied, the filter will notify the user ("Pure
1039 channel mapping detected"), and use an optimized and lossless method to do the
1040 remapping.
1041
1042 For example, if you have a 5.1 source and want a stereo audio stream by
1043 dropping the extra channels:
1044 @example
1045 pan="stereo: c0=FL : c1=FR"
1046 @end example
1047
1048 Given the same source, you can also switch front left and front right channels
1049 and keep the input channel layout:
1050 @example
1051 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
1052 @end example
1053
1054 If the input is a stereo audio stream, you can mute the front left channel (and
1055 still keep the stereo channel layout) with:
1056 @example
1057 pan="stereo:c1=c1"
1058 @end example
1059
1060 Still with a stereo audio stream input, you can copy the right channel in both
1061 front left and right:
1062 @example
1063 pan="stereo: c0=FR : c1=FR"
1064 @end example
1065
1066 @section silencedetect
1067
1068 Detect silence in an audio stream.
1069
1070 This filter logs a message when it detects that the input audio volume is less
1071 or equal to a noise tolerance value for a duration greater or equal to the
1072 minimum detected noise duration.
1073
1074 The printed times and duration are expressed in seconds.
1075
1076 @table @option
1077 @item duration, d
1078 Set silence duration until notification (default is 2 seconds).
1079
1080 @item noise, n
1081 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
1082 specified value) or amplitude ratio. Default is -60dB, or 0.001.
1083 @end table
1084
1085 Detect 5 seconds of silence with -50dB noise tolerance:
1086 @example
1087 silencedetect=n=-50dB:d=5
1088 @end example
1089
1090 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
1091 tolerance in @file{silence.mp3}:
1092 @example
1093 ffmpeg -f lavfi -i amovie=silence.mp3,silencedetect=noise=0.0001 -f null -
1094 @end example
1095
1096 @section asyncts
1097 Synchronize audio data with timestamps by squeezing/stretching it and/or
1098 dropping samples/adding silence when needed.
1099
1100 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
1101
1102 The filter accepts the following named parameters:
1103 @table @option
1104
1105 @item compensate
1106 Enable stretching/squeezing the data to make it match the timestamps. Disabled
1107 by default. When disabled, time gaps are covered with silence.
1108
1109 @item min_delta
1110 Minimum difference between timestamps and audio data (in seconds) to trigger
1111 adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
1112 this filter, try setting this parameter to 0.
1113
1114 @item max_comp
1115 Maximum compensation in samples per second. Relevant only with compensate=1.
1116 Default value 500.
1117
1118 @item first_pts
1119 Assume the first pts should be this value. The time base is 1 / sample rate.
1120 This allows for padding/trimming at the start of stream. By default, no
1121 assumption is made about the first frame's expected pts, so no padding or
1122 trimming is done. For example, this could be set to 0 to pad the beginning with
1123 silence if an audio stream starts after the video stream or to trim any samples
1124 with a negative pts due to encoder delay.
1125
1126 @end table
1127
1128 @section channelsplit
1129 Split each channel in input audio stream into a separate output stream.
1130
1131 This filter accepts the following named parameters:
1132 @table @option
1133 @item channel_layout
1134 Channel layout of the input stream. Default is "stereo".
1135 @end table
1136
1137 For example, assuming a stereo input MP3 file
1138 @example
1139 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1140 @end example
1141 will create an output Matroska file with two audio streams, one containing only
1142 the left channel and the other the right channel.
1143
1144 To split a 5.1 WAV file into per-channel files
1145 @example
1146 ffmpeg -i in.wav -filter_complex
1147 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1148 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1149 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1150 side_right.wav
1151 @end example
1152
1153 @section channelmap
1154 Remap input channels to new locations.
1155
1156 This filter accepts the following named parameters:
1157 @table @option
1158 @item channel_layout
1159 Channel layout of the output stream.
1160
1161 @item map
1162 Map channels from input to output. The argument is a comma-separated list of
1163 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1164 @var{in_channel} form. @var{in_channel} can be either the name of the input
1165 channel (e.g. FL for front left) or its index in the input channel layout.
1166 @var{out_channel} is the name of the output channel or its index in the output
1167 channel layout. If @var{out_channel} is not given then it is implicitly an
1168 index, starting with zero and increasing by one for each mapping.
1169 @end table
1170
1171 If no mapping is present, the filter will implicitly map input channels to
1172 output channels preserving index.
1173
1174 For example, assuming a 5.1+downmix input MOV file
1175 @example
1176 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL\,DR-FR' out.wav
1177 @end example
1178 will create an output WAV file tagged as stereo from the downmix channels of
1179 the input.
1180
1181 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1182 @example
1183 ffmpeg -i in.wav -filter 'channelmap=1\,2\,0\,5\,3\,4:channel_layout=5.1' out.wav
1184 @end example
1185
1186 @section join
1187 Join multiple input streams into one multi-channel stream.
1188
1189 The filter accepts the following named parameters:
1190 @table @option
1191
1192 @item inputs
1193 Number of input streams. Defaults to 2.
1194
1195 @item channel_layout
1196 Desired output channel layout. Defaults to stereo.
1197
1198 @item map
1199 Map channels from inputs to output. The argument is a comma-separated list of
1200 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1201 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1202 can be either the name of the input channel (e.g. FL for front left) or its
1203 index in the specified input stream. @var{out_channel} is the name of the output
1204 channel.
1205 @end table
1206
1207 The filter will attempt to guess the mappings when those are not specified
1208 explicitly. It does so by first trying to find an unused matching input channel
1209 and if that fails it picks the first unused input channel.
1210
1211 E.g. to join 3 inputs (with properly set channel layouts)
1212 @example
1213 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1214 @end example
1215
1216 To build a 5.1 output from 6 single-channel streams:
1217 @example
1218 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1219 'join=inputs=6:channel_layout=5.1:map=0.0-FL\,1.0-FR\,2.0-FC\,3.0-SL\,4.0-SR\,5.0-LFE'
1220 out
1221 @end example
1222
1223 @section resample
1224 Convert the audio sample format, sample rate and channel layout. This filter is
1225 not meant to be used directly.
1226
1227 @section volume
1228
1229 Adjust the input audio volume.
1230
1231 The filter accepts the following named parameters. If the key of the
1232 first options is omitted, the arguments are interpreted according to
1233 the following syntax:
1234 @example
1235 volume=@var{volume}:@var{precision}
1236 @end example
1237
1238 @table @option
1239
1240 @item volume
1241 Expresses how the audio volume will be increased or decreased.
1242
1243 Output values are clipped to the maximum value.
1244
1245 The output audio volume is given by the relation:
1246 @example
1247 @var{output_volume} = @var{volume} * @var{input_volume}
1248 @end example
1249
1250 Default value for @var{volume} is 1.0.
1251
1252 @item precision
1253 Set the mathematical precision.
1254
1255 This determines which input sample formats will be allowed, which affects the
1256 precision of the volume scaling.
1257
1258 @table @option
1259 @item fixed
1260 8-bit fixed-point; limits input sample format to U8, S16, and S32.
1261 @item float
1262 32-bit floating-point; limits input sample format to FLT. (default)
1263 @item double
1264 64-bit floating-point; limits input sample format to DBL.
1265 @end table
1266 @end table
1267
1268 @subsection Examples
1269
1270 @itemize
1271 @item
1272 Halve the input audio volume:
1273 @example
1274 volume=volume=0.5
1275 volume=volume=1/2
1276 volume=volume=-6.0206dB
1277 @end example
1278
1279 In all the above example the named key for @option{volume} can be
1280 omitted, for example like in:
1281 @example
1282 volume=0.5
1283 @end example
1284
1285 @item
1286 Increase input audio power by 6 decibels using fixed-point precision:
1287 @example
1288 volume=volume=6dB:precision=fixed
1289 @end example
1290 @end itemize
1291
1292 @section volumedetect
1293
1294 Detect the volume of the input video.
1295
1296 The filter has no parameters. The input is not modified. Statistics about
1297 the volume will be printed in the log when the input stream end is reached.
1298
1299 In particular it will show the mean volume (root mean square), maximum
1300 volume (on a per-sample basis), and the beginning of an histogram of the
1301 registered volume values (from the maximum value to a cumulated 1/1000 of
1302 the samples).
1303
1304 All volumes are in decibels relative to the maximum PCM value.
1305
1306 Here is an excerpt of the output:
1307 @example
1308 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
1309 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
1310 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
1311 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
1312 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
1313 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
1314 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
1315 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
1316 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
1317 @end example
1318
1319 It means that:
1320 @itemize
1321 @item
1322 The mean square energy is approximately -27 dB, or 10^-2.7.
1323 @item
1324 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
1325 @item
1326 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
1327 @end itemize
1328
1329 In other words, raising the volume by +4 dB does not cause any clipping,
1330 raising it by +5 dB causes clipping for 6 samples, etc.
1331
1332 @c man end AUDIO FILTERS
1333
1334 @chapter Audio Sources
1335 @c man begin AUDIO SOURCES
1336
1337 Below is a description of the currently available audio sources.
1338
1339 @section abuffer
1340
1341 Buffer audio frames, and make them available to the filter chain.
1342
1343 This source is mainly intended for a programmatic use, in particular
1344 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
1345
1346 It accepts the following mandatory parameters:
1347 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}
1348
1349 @table @option
1350
1351 @item sample_rate
1352 The sample rate of the incoming audio buffers.
1353
1354 @item sample_fmt
1355 The sample format of the incoming audio buffers.
1356 Either a sample format name or its corresponging integer representation from
1357 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
1358
1359 @item channel_layout
1360 The channel layout of the incoming audio buffers.
1361 Either a channel layout name from channel_layout_map in
1362 @file{libavutil/channel_layout.c} or its corresponding integer representation
1363 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
1364
1365 @item channels
1366 The number of channels of the incoming audio buffers.
1367 If both @var{channels} and @var{channel_layout} are specified, then they
1368 must be consistent.
1369
1370 @end table
1371
1372 For example:
1373 @example
1374 abuffer=44100:s16p:stereo
1375 @end example
1376
1377 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
1378 Since the sample format with name "s16p" corresponds to the number
1379 6 and the "stereo" channel layout corresponds to the value 0x3, this is
1380 equivalent to:
1381 @example
1382 abuffer=44100:6:0x3
1383 @end example
1384
1385 @section aevalsrc
1386
1387 Generate an audio signal specified by an expression.
1388
1389 This source accepts in input one or more expressions (one for each
1390 channel), which are evaluated and used to generate a corresponding
1391 audio signal.
1392
1393 It accepts the syntax: @var{exprs}[::@var{options}].
1394 @var{exprs} is a list of expressions separated by ":", one for each
1395 separate channel. In case the @var{channel_layout} is not
1396 specified, the selected channel layout depends on the number of
1397 provided expressions.
1398
1399 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
1400 separated by ":".
1401
1402 The description of the accepted options follows.
1403
1404 @table @option
1405
1406 @item channel_layout, c
1407 Set the channel layout. The number of channels in the specified layout
1408 must be equal to the number of specified expressions.
1409
1410 @item duration, d
1411 Set the minimum duration of the sourced audio. See the function
1412 @code{av_parse_time()} for the accepted format.
1413 Note that the resulting duration may be greater than the specified
1414 duration, as the generated audio is always cut at the end of a
1415 complete frame.
1416
1417 If not specified, or the expressed duration is negative, the audio is
1418 supposed to be generated forever.
1419
1420 @item nb_samples, n
1421 Set the number of samples per channel per each output frame,
1422 default to 1024.
1423
1424 @item sample_rate, s
1425 Specify the sample rate, default to 44100.
1426 @end table
1427
1428 Each expression in @var{exprs} can contain the following constants:
1429
1430 @table @option
1431 @item n
1432 number of the evaluated sample, starting from 0
1433
1434 @item t
1435 time of the evaluated sample expressed in seconds, starting from 0
1436
1437 @item s
1438 sample rate
1439
1440 @end table
1441
1442 @subsection Examples
1443
1444 @itemize
1445
1446 @item
1447 Generate silence:
1448 @example
1449 aevalsrc=0
1450 @end example
1451
1452 @item
1453
1454 Generate a sin signal with frequency of 440 Hz, set sample rate to
1455 8000 Hz:
1456 @example
1457 aevalsrc="sin(440*2*PI*t)::s=8000"
1458 @end example
1459
1460 @item
1461 Generate a two channels signal, specify the channel layout (Front
1462 Center + Back Center) explicitly:
1463 @example
1464 aevalsrc="sin(420*2*PI*t):cos(430*2*PI*t)::c=FC|BC"
1465 @end example
1466
1467 @item
1468 Generate white noise:
1469 @example
1470 aevalsrc="-2+random(0)"
1471 @end example
1472
1473 @item
1474 Generate an amplitude modulated signal:
1475 @example
1476 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
1477 @end example
1478
1479 @item
1480 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
1481 @example
1482 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"
1483 @end example
1484
1485 @end itemize
1486
1487 @section anullsrc
1488
1489 Null audio source, return unprocessed audio frames. It is mainly useful
1490 as a template and to be employed in analysis / debugging tools, or as
1491 the source for filters which ignore the input data (for example the sox
1492 synth filter).
1493
1494 It accepts an optional sequence of @var{key}=@var{value} pairs,
1495 separated by ":".
1496
1497 The description of the accepted options follows.
1498
1499 @table @option
1500
1501 @item sample_rate, s
1502 Specify the sample rate, and defaults to 44100.
1503
1504 @item channel_layout, cl
1505
1506 Specify the channel layout, and can be either an integer or a string
1507 representing a channel layout. The default value of @var{channel_layout}
1508 is "stereo".
1509
1510 Check the channel_layout_map definition in
1511 @file{libavutil/channel_layout.c} for the mapping between strings and
1512 channel layout values.
1513
1514 @item nb_samples, n
1515 Set the number of samples per requested frames.
1516
1517 @end table
1518
1519 Follow some examples:
1520 @example
1521 #  set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
1522 anullsrc=r=48000:cl=4
1523
1524 # same as
1525 anullsrc=r=48000:cl=mono
1526 @end example
1527
1528 @section abuffer
1529 Buffer audio frames, and make them available to the filter chain.
1530
1531 This source is not intended to be part of user-supplied graph descriptions but
1532 for insertion by calling programs through the interface defined in
1533 @file{libavfilter/buffersrc.h}.
1534
1535 It accepts the following named parameters:
1536 @table @option
1537
1538 @item time_base
1539 Timebase which will be used for timestamps of submitted frames. It must be
1540 either a floating-point number or in @var{numerator}/@var{denominator} form.
1541
1542 @item sample_rate
1543 Audio sample rate.
1544
1545 @item sample_fmt
1546 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
1547
1548 @item channel_layout
1549 Channel layout of the audio data, in the form that can be accepted by
1550 @code{av_get_channel_layout()}.
1551 @end table
1552
1553 All the parameters need to be explicitly defined.
1554
1555 @section flite
1556
1557 Synthesize a voice utterance using the libflite library.
1558
1559 To enable compilation of this filter you need to configure FFmpeg with
1560 @code{--enable-libflite}.
1561
1562 Note that the flite library is not thread-safe.
1563
1564 The source accepts parameters as a list of @var{key}=@var{value} pairs,
1565 separated by ":".
1566
1567 The description of the accepted parameters follows.
1568
1569 @table @option
1570
1571 @item list_voices
1572 If set to 1, list the names of the available voices and exit
1573 immediately. Default value is 0.
1574
1575 @item nb_samples, n
1576 Set the maximum number of samples per frame. Default value is 512.
1577
1578 @item textfile
1579 Set the filename containing the text to speak.
1580
1581 @item text
1582 Set the text to speak.
1583
1584 @item voice, v
1585 Set the voice to use for the speech synthesis. Default value is
1586 @code{kal}. See also the @var{list_voices} option.
1587 @end table
1588
1589 @subsection Examples
1590
1591 @itemize
1592 @item
1593 Read from file @file{speech.txt}, and synthetize the text using the
1594 standard flite voice:
1595 @example
1596 flite=textfile=speech.txt
1597 @end example
1598
1599 @item
1600 Read the specified text selecting the @code{slt} voice:
1601 @example
1602 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1603 @end example
1604
1605 @item
1606 Input text to ffmpeg:
1607 @example
1608 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1609 @end example
1610
1611 @item
1612 Make @file{ffplay} speak the specified text, using @code{flite} and
1613 the @code{lavfi} device:
1614 @example
1615 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
1616 @end example
1617 @end itemize
1618
1619 For more information about libflite, check:
1620 @url{http://www.speech.cs.cmu.edu/flite/}
1621
1622 @c man end AUDIO SOURCES
1623
1624 @chapter Audio Sinks
1625 @c man begin AUDIO SINKS
1626
1627 Below is a description of the currently available audio sinks.
1628
1629 @section abuffersink
1630
1631 Buffer audio frames, and make them available to the end of filter chain.
1632
1633 This sink is mainly intended for programmatic use, in particular
1634 through the interface defined in @file{libavfilter/buffersink.h}.
1635
1636 It requires a pointer to an AVABufferSinkContext structure, which
1637 defines the incoming buffers' formats, to be passed as the opaque
1638 parameter to @code{avfilter_init_filter} for initialization.
1639
1640 @section anullsink
1641
1642 Null audio sink, do absolutely nothing with the input audio. It is
1643 mainly useful as a template and to be employed in analysis / debugging
1644 tools.
1645
1646 @section abuffersink
1647 This sink is intended for programmatic use. Frames that arrive on this sink can
1648 be retrieved by the calling program using the interface defined in
1649 @file{libavfilter/buffersink.h}.
1650
1651 This filter accepts no parameters.
1652
1653 @c man end AUDIO SINKS
1654
1655 @chapter Video Filters
1656 @c man begin VIDEO FILTERS
1657
1658 When you configure your FFmpeg build, you can disable any of the
1659 existing filters using @code{--disable-filters}.
1660 The configure output will show the video filters included in your
1661 build.
1662
1663 Below is a description of the currently available video filters.
1664
1665 @section alphaextract
1666
1667 Extract the alpha component from the input as a grayscale video. This
1668 is especially useful with the @var{alphamerge} filter.
1669
1670 @section alphamerge
1671
1672 Add or replace the alpha component of the primary input with the
1673 grayscale value of a second input. This is intended for use with
1674 @var{alphaextract} to allow the transmission or storage of frame
1675 sequences that have alpha in a format that doesn't support an alpha
1676 channel.
1677
1678 For example, to reconstruct full frames from a normal YUV-encoded video
1679 and a separate video created with @var{alphaextract}, you might use:
1680 @example
1681 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
1682 @end example
1683
1684 Since this filter is designed for reconstruction, it operates on frame
1685 sequences without considering timestamps, and terminates when either
1686 input reaches end of stream. This will cause problems if your encoding
1687 pipeline drops frames. If you're trying to apply an image as an
1688 overlay to a video stream, consider the @var{overlay} filter instead.
1689
1690 @section ass
1691
1692 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
1693 and libavformat to work. On the other hand, it is limited to ASS (Advanced
1694 Substation Alpha) subtitles files.
1695
1696 @section bbox
1697
1698 Compute the bounding box for the non-black pixels in the input frame
1699 luminance plane.
1700
1701 This filter computes the bounding box containing all the pixels with a
1702 luminance value greater than the minimum allowed value.
1703 The parameters describing the bounding box are printed on the filter
1704 log.
1705
1706 @section blackdetect
1707
1708 Detect video intervals that are (almost) completely black. Can be
1709 useful to detect chapter transitions, commercials, or invalid
1710 recordings. Output lines contains the time for the start, end and
1711 duration of the detected black interval expressed in seconds.
1712
1713 In order to display the output lines, you need to set the loglevel at
1714 least to the AV_LOG_INFO value.
1715
1716 This filter accepts a list of options in the form of
1717 @var{key}=@var{value} pairs separated by ":". A description of the
1718 accepted options follows.
1719
1720 @table @option
1721 @item black_min_duration, d
1722 Set the minimum detected black duration expressed in seconds. It must
1723 be a non-negative floating point number.
1724
1725 Default value is 2.0.
1726
1727 @item picture_black_ratio_th, pic_th
1728 Set the threshold for considering a picture "black".
1729 Express the minimum value for the ratio:
1730 @example
1731 @var{nb_black_pixels} / @var{nb_pixels}
1732 @end example
1733
1734 for which a picture is considered black.
1735 Default value is 0.98.
1736
1737 @item pixel_black_th, pix_th
1738 Set the threshold for considering a pixel "black".
1739
1740 The threshold expresses the maximum pixel luminance value for which a
1741 pixel is considered "black". The provided value is scaled according to
1742 the following equation:
1743 @example
1744 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1745 @end example
1746
1747 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1748 the input video format, the range is [0-255] for YUV full-range
1749 formats and [16-235] for YUV non full-range formats.
1750
1751 Default value is 0.10.
1752 @end table
1753
1754 The following example sets the maximum pixel threshold to the minimum
1755 value, and detects only black intervals of 2 or more seconds:
1756 @example
1757 blackdetect=d=2:pix_th=0.00
1758 @end example
1759
1760 @section blackframe
1761
1762 Detect frames that are (almost) completely black. Can be useful to
1763 detect chapter transitions or commercials. Output lines consist of
1764 the frame number of the detected frame, the percentage of blackness,
1765 the position in the file if known or -1 and the timestamp in seconds.
1766
1767 In order to display the output lines, you need to set the loglevel at
1768 least to the AV_LOG_INFO value.
1769
1770 The filter accepts the syntax:
1771 @example
1772 blackframe[=@var{amount}:[@var{threshold}]]
1773 @end example
1774
1775 @var{amount} is the percentage of the pixels that have to be below the
1776 threshold, and defaults to 98.
1777
1778 @var{threshold} is the threshold below which a pixel value is
1779 considered black, and defaults to 32.
1780
1781 @section boxblur
1782
1783 Apply boxblur algorithm to the input video.
1784
1785 This filter accepts the parameters:
1786 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
1787
1788 Chroma and alpha parameters are optional, if not specified they default
1789 to the corresponding values set for @var{luma_radius} and
1790 @var{luma_power}.
1791
1792 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
1793 the radius in pixels of the box used for blurring the corresponding
1794 input plane. They are expressions, and can contain the following
1795 constants:
1796 @table @option
1797 @item w, h
1798 the input width and height in pixels
1799
1800 @item cw, ch
1801 the input chroma image width and height in pixels
1802
1803 @item hsub, vsub
1804 horizontal and vertical chroma subsample values. For example for the
1805 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1806 @end table
1807
1808 The radius must be a non-negative number, and must not be greater than
1809 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
1810 and of @code{min(cw,ch)/2} for the chroma planes.
1811
1812 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
1813 how many times the boxblur filter is applied to the corresponding
1814 plane.
1815
1816 Some examples follow:
1817
1818 @itemize
1819
1820 @item
1821 Apply a boxblur filter with luma, chroma, and alpha radius
1822 set to 2:
1823 @example
1824 boxblur=2:1
1825 @end example
1826
1827 @item
1828 Set luma radius to 2, alpha and chroma radius to 0
1829 @example
1830 boxblur=2:1:0:0:0:0
1831 @end example
1832
1833 @item
1834 Set luma and chroma radius to a fraction of the video dimension
1835 @example
1836 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
1837 @end example
1838
1839 @end itemize
1840
1841 @section colormatrix
1842
1843 The colormatrix filter allows conversion between any of the following color
1844 space: BT.709 (@var{bt709}), BT.601 (@var{bt601}), SMPTE-240M (@var{smpte240m})
1845 and FCC (@var{fcc}).
1846
1847 The syntax of the parameters is @var{source}:@var{destination}:
1848
1849 @example
1850 colormatrix=bt601:smpte240m
1851 @end example
1852
1853 @section copy
1854
1855 Copy the input source unchanged to the output. Mainly useful for
1856 testing purposes.
1857
1858 @section crop
1859
1860 Crop the input video.
1861
1862 This filter accepts a list of @var{key}=@var{value} pairs as argument,
1863 separated by ':'. If the key of the first options is omitted, the
1864 arguments are interpreted according to the syntax
1865 @var{out_w}:@var{out_h}:@var{x}:@var{y}:@var{keep_aspect}.
1866
1867 A description of the accepted options follows:
1868 @table @option
1869 @item w, out_w
1870 Set the crop area width. It defaults to @code{iw}.
1871 This expression is evaluated only once during the filter
1872 configuration.
1873
1874 @item h, out_h
1875 Set the crop area width. It defaults to @code{ih}.
1876 This expression is evaluated only once during the filter
1877 configuration.
1878
1879 @item x
1880 Set the expression for the x top-left coordinate of the cropped area.
1881 It defaults to @code{(in_w-out_w)/2}.
1882 This expression is evaluated per-frame.
1883
1884 @item y
1885 Set the expression for the y top-left coordinate of the cropped area.
1886 It defaults to @code{(in_h-out_h)/2}.
1887 This expression is evaluated per-frame.
1888
1889 @item keep_aspect
1890 If set to 1 will force the output display aspect ratio
1891 to be the same of the input, by changing the output sample aspect
1892 ratio. It defaults to 0.
1893 @end table
1894
1895 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
1896 expressions containing the following constants:
1897
1898 @table @option
1899 @item x, y
1900 the computed values for @var{x} and @var{y}. They are evaluated for
1901 each new frame.
1902
1903 @item in_w, in_h
1904 the input width and height
1905
1906 @item iw, ih
1907 same as @var{in_w} and @var{in_h}
1908
1909 @item out_w, out_h
1910 the output (cropped) width and height
1911
1912 @item ow, oh
1913 same as @var{out_w} and @var{out_h}
1914
1915 @item a
1916 same as @var{iw} / @var{ih}
1917
1918 @item sar
1919 input sample aspect ratio
1920
1921 @item dar
1922 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1923
1924 @item hsub, vsub
1925 horizontal and vertical chroma subsample values. For example for the
1926 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1927
1928 @item n
1929 the number of input frame, starting from 0
1930
1931 @item pos
1932 the position in the file of the input frame, NAN if unknown
1933
1934 @item t
1935 timestamp expressed in seconds, NAN if the input timestamp is unknown
1936
1937 @end table
1938
1939 The expression for @var{out_w} may depend on the value of @var{out_h},
1940 and the expression for @var{out_h} may depend on @var{out_w}, but they
1941 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
1942 evaluated after @var{out_w} and @var{out_h}.
1943
1944 The @var{x} and @var{y} parameters specify the expressions for the
1945 position of the top-left corner of the output (non-cropped) area. They
1946 are evaluated for each frame. If the evaluated value is not valid, it
1947 is approximated to the nearest valid value.
1948
1949 The expression for @var{x} may depend on @var{y}, and the expression
1950 for @var{y} may depend on @var{x}.
1951
1952 @subsection Examples
1953 @itemize
1954 @item
1955 Crop area with size 100x100 at position (12,34).
1956 @example
1957 crop=100:100:12:34
1958 @end example
1959
1960 Using named options, the example above becomes:
1961 @example
1962 crop=w=100:h=100:x=12:y=34
1963 @end example
1964
1965 @item
1966 Crop the central input area with size 100x100:
1967 @example
1968 crop=100:100
1969 @end example
1970
1971 @item
1972 Crop the central input area with size 2/3 of the input video:
1973 @example
1974 crop=2/3*in_w:2/3*in_h
1975 @end example
1976
1977 @item
1978 Crop the input video central square:
1979 @example
1980 crop=in_h
1981 @end example
1982
1983 @item
1984 Delimit the rectangle with the top-left corner placed at position
1985 100:100 and the right-bottom corner corresponding to the right-bottom
1986 corner of the input image:
1987 @example
1988 crop=in_w-100:in_h-100:100:100
1989 @end example
1990
1991 @item
1992 Crop 10 pixels from the left and right borders, and 20 pixels from
1993 the top and bottom borders
1994 @example
1995 crop=in_w-2*10:in_h-2*20
1996 @end example
1997
1998 @item
1999 Keep only the bottom right quarter of the input image:
2000 @example
2001 crop=in_w/2:in_h/2:in_w/2:in_h/2
2002 @end example
2003
2004 @item
2005 Crop height for getting Greek harmony:
2006 @example
2007 crop=in_w:1/PHI*in_w
2008 @end example
2009
2010 @item
2011 Appply trembling effect:
2012 @example
2013 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)
2014 @end example
2015
2016 @item
2017 Apply erratic camera effect depending on timestamp:
2018 @example
2019 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)"
2020 @end example
2021
2022 @item
2023 Set x depending on the value of y:
2024 @example
2025 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
2026 @end example
2027 @end itemize
2028
2029 @section cropdetect
2030
2031 Auto-detect crop size.
2032
2033 Calculate necessary cropping parameters and prints the recommended
2034 parameters through the logging system. The detected dimensions
2035 correspond to the non-black area of the input video.
2036
2037 It accepts the syntax:
2038 @example
2039 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
2040 @end example
2041
2042 @table @option
2043
2044 @item limit
2045 Threshold, which can be optionally specified from nothing (0) to
2046 everything (255), defaults to 24.
2047
2048 @item round
2049 Value which the width/height should be divisible by, defaults to
2050 16. The offset is automatically adjusted to center the video. Use 2 to
2051 get only even dimensions (needed for 4:2:2 video). 16 is best when
2052 encoding to most video codecs.
2053
2054 @item reset
2055 Counter that determines after how many frames cropdetect will reset
2056 the previously detected largest video area and start over to detect
2057 the current optimal crop area. Defaults to 0.
2058
2059 This can be useful when channel logos distort the video area. 0
2060 indicates never reset and return the largest area encountered during
2061 playback.
2062 @end table
2063
2064 @section decimate
2065
2066 Drop frames that do not differ greatly from the previous frame in
2067 order to reduce framerate.
2068
2069 The main use of this filter is for very-low-bitrate encoding
2070 (e.g. streaming over dialup modem), but it could in theory be used for
2071 fixing movies that were inverse-telecined incorrectly.
2072
2073 The filter accepts parameters as a list of @var{key}=@var{value}
2074 pairs, separated by ":". If the key of the first options is omitted,
2075 the arguments are interpreted according to the syntax:
2076 @option{max}:@option{hi}:@option{lo}:@option{frac}.
2077
2078 A description of the accepted options follows.
2079
2080 @table @option
2081 @item max
2082 Set the maximum number of consecutive frames which can be dropped (if
2083 positive), or the minimum interval between dropped frames (if
2084 negative). If the value is 0, the frame is dropped unregarding the
2085 number of previous sequentially dropped frames.
2086
2087 Default value is 0.
2088
2089 @item hi
2090 @item lo
2091 @item frac
2092 Set the dropping threshold values.
2093
2094 Values for @option{hi} and @option{lo} are for 8x8 pixel blocks and
2095 represent actual pixel value differences, so a threshold of 64
2096 corresponds to 1 unit of difference for each pixel, or the same spread
2097 out differently over the block.
2098
2099 A frame is a candidate for dropping if no 8x8 blocks differ by more
2100 than a threshold of @option{hi}, and if no more than @option{frac} blocks (1
2101 meaning the whole image) differ by more than a threshold of @option{lo}.
2102
2103 Default value for @option{hi} is 64*12, default value for @option{lo} is
2104 64*5, and default value for @option{frac} is 0.33.
2105 @end table
2106
2107 @section delogo
2108
2109 Suppress a TV station logo by a simple interpolation of the surrounding
2110 pixels. Just set a rectangle covering the logo and watch it disappear
2111 (and sometimes something even uglier appear - your mileage may vary).
2112
2113 The filter accepts parameters as a string of the form
2114 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
2115 @var{key}=@var{value} pairs, separated by ":".
2116
2117 The description of the accepted parameters follows.
2118
2119 @table @option
2120
2121 @item x, y
2122 Specify the top left corner coordinates of the logo. They must be
2123 specified.
2124
2125 @item w, h
2126 Specify the width and height of the logo to clear. They must be
2127 specified.
2128
2129 @item band, t
2130 Specify the thickness of the fuzzy edge of the rectangle (added to
2131 @var{w} and @var{h}). The default value is 4.
2132
2133 @item show
2134 When set to 1, a green rectangle is drawn on the screen to simplify
2135 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
2136 @var{band} is set to 4. The default value is 0.
2137
2138 @end table
2139
2140 Some examples follow.
2141
2142 @itemize
2143
2144 @item
2145 Set a rectangle covering the area with top left corner coordinates 0,0
2146 and size 100x77, setting a band of size 10:
2147 @example
2148 delogo=0:0:100:77:10
2149 @end example
2150
2151 @item
2152 As the previous example, but use named options:
2153 @example
2154 delogo=x=0:y=0:w=100:h=77:band=10
2155 @end example
2156
2157 @end itemize
2158
2159 @section deshake
2160
2161 Attempt to fix small changes in horizontal and/or vertical shift. This
2162 filter helps remove camera shake from hand-holding a camera, bumping a
2163 tripod, moving on a vehicle, etc.
2164
2165 The filter accepts parameters as a string of the form
2166 "@var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}"
2167
2168 A description of the accepted parameters follows.
2169
2170 @table @option
2171
2172 @item x, y, w, h
2173 Specify a rectangular area where to limit the search for motion
2174 vectors.
2175 If desired the search for motion vectors can be limited to a
2176 rectangular area of the frame defined by its top left corner, width
2177 and height. These parameters have the same meaning as the drawbox
2178 filter which can be used to visualise the position of the bounding
2179 box.
2180
2181 This is useful when simultaneous movement of subjects within the frame
2182 might be confused for camera motion by the motion vector search.
2183
2184 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
2185 then the full frame is used. This allows later options to be set
2186 without specifying the bounding box for the motion vector search.
2187
2188 Default - search the whole frame.
2189
2190 @item rx, ry
2191 Specify the maximum extent of movement in x and y directions in the
2192 range 0-64 pixels. Default 16.
2193
2194 @item edge
2195 Specify how to generate pixels to fill blanks at the edge of the
2196 frame. An integer from 0 to 3 as follows:
2197 @table @option
2198 @item 0
2199 Fill zeroes at blank locations
2200 @item 1
2201 Original image at blank locations
2202 @item 2
2203 Extruded edge value at blank locations
2204 @item 3
2205 Mirrored edge at blank locations
2206 @end table
2207
2208 The default setting is mirror edge at blank locations.
2209
2210 @item blocksize
2211 Specify the blocksize to use for motion search. Range 4-128 pixels,
2212 default 8.
2213
2214 @item contrast
2215 Specify the contrast threshold for blocks. Only blocks with more than
2216 the specified contrast (difference between darkest and lightest
2217 pixels) will be considered. Range 1-255, default 125.
2218
2219 @item search
2220 Specify the search strategy 0 = exhaustive search, 1 = less exhaustive
2221 search. Default - exhaustive search.
2222
2223 @item filename
2224 If set then a detailed log of the motion search is written to the
2225 specified file.
2226
2227 @end table
2228
2229 @section drawbox
2230
2231 Draw a colored box on the input image.
2232
2233 The filter accepts parameters as a list of @var{key}=@var{value}
2234 pairs, separated by ":". If the key of the first options is omitted,
2235 the arguments are interpreted according to the syntax
2236 @option{x}:@option{y}:@option{width}:@option{height}:@option{color}:@option{thickness}.
2237
2238 A description of the accepted options follows.
2239
2240 @table @option
2241 @item x, y
2242 Specify the top left corner coordinates of the box. Default to 0.
2243
2244 @item width, w
2245 @item height, h
2246 Specify the width and height of the box, if 0 they are interpreted as
2247 the input width and height. Default to 0.
2248
2249 @item color, c
2250 Specify the color of the box to write, it can be the name of a color
2251 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
2252 value @code{invert} is used, the box edge color is the same as the
2253 video with inverted luma.
2254
2255 @item thickness, t
2256 Set the thickness of the box edge. Default value is @code{4}.
2257 @end table
2258
2259 Some examples follow:
2260 @itemize
2261 @item
2262 Draw a black box around the edge of the input image:
2263 @example
2264 drawbox
2265 @end example
2266
2267 @item
2268 Draw a box with color red and an opacity of 50%:
2269 @example
2270 drawbox=10:20:200:60:red@@0.5
2271 @end example
2272
2273 The previous example can be specified as:
2274 @example
2275 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
2276 @end example
2277
2278 @item
2279 Fill the box with pink color:
2280 @example
2281 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
2282 @end example
2283 @end itemize
2284
2285 @anchor{drawtext}
2286 @section drawtext
2287
2288 Draw text string or text from specified file on top of video using the
2289 libfreetype library.
2290
2291 To enable compilation of this filter you need to configure FFmpeg with
2292 @code{--enable-libfreetype}.
2293
2294 @subsection Syntax
2295
2296 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
2297 separated by ":".
2298
2299 The description of the accepted parameters follows.
2300
2301 @table @option
2302
2303 @item box
2304 Used to draw a box around text using background color.
2305 Value should be either 1 (enable) or 0 (disable).
2306 The default value of @var{box} is 0.
2307
2308 @item boxcolor
2309 The color to be used for drawing box around text.
2310 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
2311 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2312 The default value of @var{boxcolor} is "white".
2313
2314 @item draw
2315 Set an expression which specifies if the text should be drawn. If the
2316 expression evaluates to 0, the text is not drawn. This is useful for
2317 specifying that the text should be drawn only when specific conditions
2318 are met.
2319
2320 Default value is "1".
2321
2322 See below for the list of accepted constants and functions.
2323
2324 @item expansion
2325 Select how the @var{text} is expanded. Can be either @code{none},
2326 @code{strftime} (deprecated) or
2327 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
2328 below for details.
2329
2330 @item fix_bounds
2331 If true, check and fix text coords to avoid clipping.
2332
2333 @item fontcolor
2334 The color to be used for drawing fonts.
2335 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
2336 (e.g. "0xff000033"), possibly followed by an alpha specifier.
2337 The default value of @var{fontcolor} is "black".
2338
2339 @item fontfile
2340 The font file to be used for drawing text. Path must be included.
2341 This parameter is mandatory.
2342
2343 @item fontsize
2344 The font size to be used for drawing text.
2345 The default value of @var{fontsize} is 16.
2346
2347 @item ft_load_flags
2348 Flags to be used for loading the fonts.
2349
2350 The flags map the corresponding flags supported by libfreetype, and are
2351 a combination of the following values:
2352 @table @var
2353 @item default
2354 @item no_scale
2355 @item no_hinting
2356 @item render
2357 @item no_bitmap
2358 @item vertical_layout
2359 @item force_autohint
2360 @item crop_bitmap
2361 @item pedantic
2362 @item ignore_global_advance_width
2363 @item no_recurse
2364 @item ignore_transform
2365 @item monochrome
2366 @item linear_design
2367 @item no_autohint
2368 @item end table
2369 @end table
2370
2371 Default value is "render".
2372
2373 For more information consult the documentation for the FT_LOAD_*
2374 libfreetype flags.
2375
2376 @item shadowcolor
2377 The color to be used for drawing a shadow behind the drawn text.  It
2378 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
2379 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2380 The default value of @var{shadowcolor} is "black".
2381
2382 @item shadowx, shadowy
2383 The x and y offsets for the text shadow position with respect to the
2384 position of the text. They can be either positive or negative
2385 values. Default value for both is "0".
2386
2387 @item tabsize
2388 The size in number of spaces to use for rendering the tab.
2389 Default value is 4.
2390
2391 @item timecode
2392 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
2393 format. It can be used with or without text parameter. @var{timecode_rate}
2394 option must be specified.
2395
2396 @item timecode_rate, rate, r
2397 Set the timecode frame rate (timecode only).
2398
2399 @item text
2400 The text string to be drawn. The text must be a sequence of UTF-8
2401 encoded characters.
2402 This parameter is mandatory if no file is specified with the parameter
2403 @var{textfile}.
2404
2405 @item textfile
2406 A text file containing text to be drawn. The text must be a sequence
2407 of UTF-8 encoded characters.
2408
2409 This parameter is mandatory if no text string is specified with the
2410 parameter @var{text}.
2411
2412 If both @var{text} and @var{textfile} are specified, an error is thrown.
2413
2414 @item reload
2415 If set to 1, the @var{textfile} will be reloaded before each frame.
2416 Be sure to update it atomically, or it may be read partially, or even fail.
2417
2418 @item x, y
2419 The expressions which specify the offsets where text will be drawn
2420 within the video frame. They are relative to the top/left border of the
2421 output image.
2422
2423 The default value of @var{x} and @var{y} is "0".
2424
2425 See below for the list of accepted constants and functions.
2426 @end table
2427
2428 The parameters for @var{x} and @var{y} are expressions containing the
2429 following constants and functions:
2430
2431 @table @option
2432 @item dar
2433 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
2434
2435 @item hsub, vsub
2436 horizontal and vertical chroma subsample values. For example for the
2437 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2438
2439 @item line_h, lh
2440 the height of each text line
2441
2442 @item main_h, h, H
2443 the input height
2444
2445 @item main_w, w, W
2446 the input width
2447
2448 @item max_glyph_a, ascent
2449 the maximum distance from the baseline to the highest/upper grid
2450 coordinate used to place a glyph outline point, for all the rendered
2451 glyphs.
2452 It is a positive value, due to the grid's orientation with the Y axis
2453 upwards.
2454
2455 @item max_glyph_d, descent
2456 the maximum distance from the baseline to the lowest grid coordinate
2457 used to place a glyph outline point, for all the rendered glyphs.
2458 This is a negative value, due to the grid's orientation, with the Y axis
2459 upwards.
2460
2461 @item max_glyph_h
2462 maximum glyph height, that is the maximum height for all the glyphs
2463 contained in the rendered text, it is equivalent to @var{ascent} -
2464 @var{descent}.
2465
2466 @item max_glyph_w
2467 maximum glyph width, that is the maximum width for all the glyphs
2468 contained in the rendered text
2469
2470 @item n
2471 the number of input frame, starting from 0
2472
2473 @item rand(min, max)
2474 return a random number included between @var{min} and @var{max}
2475
2476 @item sar
2477 input sample aspect ratio
2478
2479 @item t
2480 timestamp expressed in seconds, NAN if the input timestamp is unknown
2481
2482 @item text_h, th
2483 the height of the rendered text
2484
2485 @item text_w, tw
2486 the width of the rendered text
2487
2488 @item x, y
2489 the x and y offset coordinates where the text is drawn.
2490
2491 These parameters allow the @var{x} and @var{y} expressions to refer
2492 each other, so you can for example specify @code{y=x/dar}.
2493 @end table
2494
2495 If libavfilter was built with @code{--enable-fontconfig}, then
2496 @option{fontfile} can be a fontconfig pattern or omitted.
2497
2498 @anchor{drawtext_expansion}
2499 @subsection Text expansion
2500
2501 If @option{expansion} is set to @code{strftime},
2502 the filter recognizes strftime() sequences in the provided text and
2503 expands them accordingly. Check the documentation of strftime(). This
2504 feature is deprecated.
2505
2506 If @option{expansion} is set to @code{none}, the text is printed verbatim.
2507
2508 If @option{expansion} is set to @code{normal} (which is the default),
2509 the following expansion mechanism is used.
2510
2511 The backslash character '\', followed by any character, always expands to
2512 the second character.
2513
2514 Sequence of the form @code{%@{...@}} are expanded. The text between the
2515 braces is a function name, possibly followed by arguments separated by ':'.
2516 If the arguments contain special characters or delimiters (':' or '@}'),
2517 they should be escaped.
2518
2519 Note that they probably must also be escaped as the value for the
2520 @option{text} option in the filter argument string and as the filter
2521 argument in the filter graph description, and possibly also for the shell,
2522 that makes up to four levels of escaping; using a text file avoids these
2523 problems.
2524
2525 The following functions are available:
2526
2527 @table @command
2528
2529 @item expr, e
2530 The expression evaluation result.
2531
2532 It must take one argument specifying the expression to be evaluated,
2533 which accepts the same constants and functions as the @var{x} and
2534 @var{y} values. Note that not all constants should be used, for
2535 example the text size is not known when evaluating the expression, so
2536 the constants @var{text_w} and @var{text_h} will have an undefined
2537 value.
2538
2539 @item gmtime
2540 The time at which the filter is running, expressed in UTC.
2541 It can accept an argument: a strftime() format string.
2542
2543 @item localtime
2544 The time at which the filter is running, expressed in the local time zone.
2545 It can accept an argument: a strftime() format string.
2546
2547 @item n, frame_num
2548 The frame number, starting from 0.
2549
2550 @item pts
2551 The timestamp of the current frame, in seconds, with microsecond accuracy.
2552
2553 @end table
2554
2555 @subsection Examples
2556
2557 Some examples follow.
2558
2559 @itemize
2560
2561 @item
2562 Draw "Test Text" with font FreeSerif, using the default values for the
2563 optional parameters.
2564
2565 @example
2566 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
2567 @end example
2568
2569 @item
2570 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
2571 and y=50 (counting from the top-left corner of the screen), text is
2572 yellow with a red box around it. Both the text and the box have an
2573 opacity of 20%.
2574
2575 @example
2576 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
2577           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
2578 @end example
2579
2580 Note that the double quotes are not necessary if spaces are not used
2581 within the parameter list.
2582
2583 @item
2584 Show the text at the center of the video frame:
2585 @example
2586 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
2587 @end example
2588
2589 @item
2590 Show a text line sliding from right to left in the last row of the video
2591 frame. The file @file{LONG_LINE} is assumed to contain a single line
2592 with no newlines.
2593 @example
2594 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
2595 @end example
2596
2597 @item
2598 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
2599 @example
2600 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
2601 @end example
2602
2603 @item
2604 Draw a single green letter "g", at the center of the input video.
2605 The glyph baseline is placed at half screen height.
2606 @example
2607 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
2608 @end example
2609
2610 @item
2611 Show text for 1 second every 3 seconds:
2612 @example
2613 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
2614 @end example
2615
2616 @item
2617 Use fontconfig to set the font. Note that the colons need to be escaped.
2618 @example
2619 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
2620 @end example
2621
2622 @item
2623 Print the date of a real-time encoding (see strftime(3)):
2624 @example
2625 drawtext='fontfile=FreeSans.ttf:text=%@{localtime:%a %b %d %Y@}'
2626 @end example
2627
2628 @end itemize
2629
2630 For more information about libfreetype, check:
2631 @url{http://www.freetype.org/}.
2632
2633 For more information about fontconfig, check:
2634 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
2635
2636 @section edgedetect
2637
2638 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
2639
2640 This filter accepts the following optional named parameters:
2641
2642 @table @option
2643 @item low, high
2644 Set low and high threshold values used by the Canny thresholding
2645 algorithm.
2646
2647 The high threshold selects the "strong" edge pixels, which are then
2648 connected through 8-connectivity with the "weak" edge pixels selected
2649 by the low threshold.
2650
2651 @var{low} and @var{high} threshold values must be choosen in the range
2652 [0,1], and @var{low} should be lesser or equal to @var{high}.
2653
2654 Default value for @var{low} is @code{20/255}, and default value for @var{high}
2655 is @code{50/255}.
2656 @end table
2657
2658 Example:
2659 @example
2660 edgedetect=low=0.1:high=0.4
2661 @end example
2662
2663 @section fade
2664
2665 Apply fade-in/out effect to input video.
2666
2667 The filter accepts parameters as a list of @var{key}=@var{value}
2668 pairs, separated by ":". If the key of the first options is omitted,
2669 the arguments are interpreted according to the syntax
2670 @var{type}:@var{start_frame}:@var{nb_frames}.
2671
2672 A description of the accepted parameters follows.
2673
2674 @table @option
2675 @item type, t
2676 Specify if the effect type, can be either @code{in} for fade-in, or
2677 @code{out} for a fade-out effect. Default is @code{in}.
2678
2679 @item start_frame, s
2680 Specify the number of the start frame for starting to apply the fade
2681 effect. Default is 0.
2682
2683 @item nb_frames, n
2684 Specify the number of frames for which the fade effect has to last. At
2685 the end of the fade-in effect the output video will have the same
2686 intensity as the input video, at the end of the fade-out transition
2687 the output video will be completely black. Default is 25.
2688
2689 @item alpha
2690 If set to 1, fade only alpha channel, if one exists on the input.
2691 Default value is 0.
2692 @end table
2693
2694 @subsection Examples
2695 @itemize
2696 @item
2697 Fade in first 30 frames of video:
2698 @example
2699 fade=in:0:30
2700 @end example
2701
2702 The command above is equivalent to:
2703 @example
2704 fade=t=in:s=0:n=30
2705 @end example
2706
2707 @item
2708 Fade out last 45 frames of a 200-frame video:
2709 @example
2710 fade=out:155:45
2711 @end example
2712
2713 @item
2714 Fade in first 25 frames and fade out last 25 frames of a 1000-frame video:
2715 @example
2716 fade=in:0:25, fade=out:975:25
2717 @end example
2718
2719 @item
2720 Make first 5 frames black, then fade in from frame 5-24:
2721 @example
2722 fade=in:5:20
2723 @end example
2724
2725 @item
2726 Fade in alpha over first 25 frames of video:
2727 @example
2728 fade=in:0:25:alpha=1
2729 @end example
2730 @end itemize
2731
2732 @section field
2733
2734 Extract a single field from an interlaced image using stride
2735 arithmetic to avoid wasting CPU time. The output frames are marked as
2736 non-interlaced.
2737
2738 This filter accepts the following named options:
2739 @table @option
2740 @item type
2741 Specify whether to extract the top (if the value is @code{0} or
2742 @code{top}) or the bottom field (if the value is @code{1} or
2743 @code{bottom}).
2744 @end table
2745
2746 If the option key is not specified, the first value sets the @var{type}
2747 option. For example:
2748 @example
2749 field=bottom
2750 @end example
2751
2752 is equivalent to:
2753 @example
2754 field=type=bottom
2755 @end example
2756
2757 @section fieldorder
2758
2759 Transform the field order of the input video.
2760
2761 It accepts one parameter which specifies the required field order that
2762 the input interlaced video will be transformed to. The parameter can
2763 assume one of the following values:
2764
2765 @table @option
2766 @item 0 or bff
2767 output bottom field first
2768 @item 1 or tff
2769 output top field first
2770 @end table
2771
2772 Default value is "tff".
2773
2774 Transformation is achieved by shifting the picture content up or down
2775 by one line, and filling the remaining line with appropriate picture content.
2776 This method is consistent with most broadcast field order converters.
2777
2778 If the input video is not flagged as being interlaced, or it is already
2779 flagged as being of the required output field order then this filter does
2780 not alter the incoming video.
2781
2782 This filter is very useful when converting to or from PAL DV material,
2783 which is bottom field first.
2784
2785 For example:
2786 @example
2787 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
2788 @end example
2789
2790 @section fifo
2791
2792 Buffer input images and send them when they are requested.
2793
2794 This filter is mainly useful when auto-inserted by the libavfilter
2795 framework.
2796
2797 The filter does not take parameters.
2798
2799 @section format
2800
2801 Convert the input video to one of the specified pixel formats.
2802 Libavfilter will try to pick one that is supported for the input to
2803 the next filter.
2804
2805 The filter accepts a list of pixel format names, separated by ":",
2806 for example "yuv420p:monow:rgb24".
2807
2808 Some examples follow:
2809 @example
2810 # convert the input video to the format "yuv420p"
2811 format=yuv420p
2812
2813 # convert the input video to any of the formats in the list
2814 format=yuv420p:yuv444p:yuv410p
2815 @end example
2816
2817 @section fps
2818
2819 Convert the video to specified constant framerate by duplicating or dropping
2820 frames as necessary.
2821
2822 This filter accepts the following named parameters:
2823 @table @option
2824
2825 @item fps
2826 Desired output framerate. The default is @code{25}.
2827
2828 @item round
2829 Rounding method.
2830
2831 Possible values are:
2832 @table @option
2833 @item zero
2834 zero round towards 0
2835 @item inf
2836 round away from 0
2837 @item down
2838 round towards -infinity
2839 @item up
2840 round towards +infinity
2841 @item near
2842 round to nearest
2843 @end table
2844 The default is @code{near}.
2845
2846 @end table
2847
2848 Alternatively, the options can be specified as a flat string:
2849 @var{fps}[:@var{round}].
2850
2851 See also the @ref{setpts} filter.
2852
2853 @section framestep
2854
2855 Select one frame every N.
2856
2857 This filter accepts in input a string representing a positive
2858 integer. Default argument is @code{1}.
2859
2860 @anchor{frei0r}
2861 @section frei0r
2862
2863 Apply a frei0r effect to the input video.
2864
2865 To enable compilation of this filter you need to install the frei0r
2866 header and configure FFmpeg with @code{--enable-frei0r}.
2867
2868 The filter supports the syntax:
2869 @example
2870 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
2871 @end example
2872
2873 @var{filter_name} is the name of the frei0r effect to load. If the
2874 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
2875 is searched in each one of the directories specified by the colon (or
2876 semicolon on Windows platforms) separated list in @env{FREIOR_PATH},
2877 otherwise in the standard frei0r paths, which are in this order:
2878 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
2879 @file{/usr/lib/frei0r-1/}.
2880
2881 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
2882 for the frei0r effect.
2883
2884 A frei0r effect parameter can be a boolean (whose values are specified
2885 with "y" and "n"), a double, a color (specified by the syntax
2886 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
2887 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
2888 description), a position (specified by the syntax @var{X}/@var{Y},
2889 @var{X} and @var{Y} being float numbers) and a string.
2890
2891 The number and kind of parameters depend on the loaded effect. If an
2892 effect parameter is not specified the default value is set.
2893
2894 Some examples follow:
2895
2896 @itemize
2897 @item
2898 Apply the distort0r effect, set the first two double parameters:
2899 @example
2900 frei0r=distort0r:0.5:0.01
2901 @end example
2902
2903 @item
2904 Apply the colordistance effect, take a color as first parameter:
2905 @example
2906 frei0r=colordistance:0.2/0.3/0.4
2907 frei0r=colordistance:violet
2908 frei0r=colordistance:0x112233
2909 @end example
2910
2911 @item
2912 Apply the perspective effect, specify the top left and top right image
2913 positions:
2914 @example
2915 frei0r=perspective:0.2/0.2:0.8/0.2
2916 @end example
2917 @end itemize
2918
2919 For more information see:
2920 @url{http://frei0r.dyne.org}
2921
2922 @section geq
2923
2924 The filter takes one, two or three equations as parameter, separated by ':'.
2925 The first equation is mandatory and applies to the luma plane. The two
2926 following are respectively for chroma blue and chroma red planes.
2927
2928 The filter syntax allows named parameters:
2929
2930 @table @option
2931 @item lum_expr
2932 the luminance expression
2933 @item cb_expr
2934 the chrominance blue expression
2935 @item cr_expr
2936 the chrominance red expression
2937 @end table
2938
2939 If one of the chrominance expression is not defined, it falls back on the other
2940 one. If none of them are specified, they will evaluate the luminance
2941 expression.
2942
2943 The expressions can use the following variables and functions:
2944
2945 @table @option
2946 @item N
2947 The sequential number of the filtered frame, starting from @code{0}.
2948
2949 @item X, Y
2950 The coordinates of the current sample.
2951
2952 @item W, H
2953 The width and height of the image.
2954
2955 @item SW, SH
2956 Width and height scale depending on the currently filtered plane. It is the
2957 ratio between the corresponding luma plane number of pixels and the current
2958 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
2959 @code{0.5,0.5} for chroma planes.
2960
2961 @item T
2962 Time of the current frame, expressed in seconds.
2963
2964 @item p(x, y)
2965 Return the value of the pixel at location (@var{x},@var{y}) of the current
2966 plane.
2967
2968 @item lum(x, y)
2969 Return the value of the pixel at location (@var{x},@var{y}) of the luminance
2970 plane.
2971
2972 @item cb(x, y)
2973 Return the value of the pixel at location (@var{x},@var{y}) of the
2974 blue-difference chroma plane.
2975
2976 @item cr(x, y)
2977 Return the value of the pixel at location (@var{x},@var{y}) of the
2978 red-difference chroma plane.
2979 @end table
2980
2981 For functions, if @var{x} and @var{y} are outside the area, the value will be
2982 automatically clipped to the closer edge.
2983
2984 Some examples follow:
2985
2986 @itemize
2987 @item
2988 Flip the image horizontally:
2989 @example
2990 geq=p(W-X\,Y)
2991 @end example
2992
2993 @item
2994 Generate a bidimensional sine wave, with angle @code{PI/3} and a
2995 wavelength of 100 pixels:
2996 @example
2997 geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
2998 @end example
2999
3000 @item
3001 Generate a fancy enigmatic moving light:
3002 @example
3003 nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
3004 @end example
3005 @end itemize
3006
3007 @section gradfun
3008
3009 Fix the banding artifacts that are sometimes introduced into nearly flat
3010 regions by truncation to 8bit color depth.
3011 Interpolate the gradients that should go where the bands are, and
3012 dither them.
3013
3014 This filter is designed for playback only.  Do not use it prior to
3015 lossy compression, because compression tends to lose the dither and
3016 bring back the bands.
3017
3018 The filter accepts a list of options in the form of @var{key}=@var{value} pairs
3019 separated by ":". A description of the accepted options follows.
3020
3021 @table @option
3022
3023 @item strength
3024 The maximum amount by which the filter will change
3025 any one pixel. Also the threshold for detecting nearly flat
3026 regions. Acceptable values range from @code{0.51} to @code{64}, default value
3027 is @code{1.2}.
3028
3029 @item radius
3030 The neighborhood to fit the gradient to. A larger
3031 radius makes for smoother gradients, but also prevents the filter from
3032 modifying the pixels near detailed regions. Acceptable values are
3033 @code{8-32}, default value is @code{16}.
3034
3035 @end table
3036
3037 Alternatively, the options can be specified as a flat string:
3038 @var{strength}[:@var{radius}]
3039
3040 @subsection Examples
3041
3042 @itemize
3043 @item
3044 Apply the filter with a @code{3.5} strength and radius of @code{8}:
3045 @example
3046 gradfun=3.5:8
3047 @end example
3048
3049 @item
3050 Specify radius, omitting the strength (which will fall-back to the default
3051 value):
3052 @example
3053 gradfun=radius=8
3054 @end example
3055
3056 @end itemize
3057
3058 @section hflip
3059
3060 Flip the input video horizontally.
3061
3062 For example to horizontally flip the input video with @command{ffmpeg}:
3063 @example
3064 ffmpeg -i in.avi -vf "hflip" out.avi
3065 @end example
3066
3067 @section histeq
3068 This filter applies a global color histogram equalization on a
3069 per-frame basis.
3070
3071 It can be used to correct video that has a compressed range of pixel
3072 intensities.  The filter redistributes the pixel intensities to
3073 equalize their distribution across the intensity range. It may be
3074 viewed as an "automatically adjusting contrast filter". This filter is
3075 useful only for correcting degraded or poorly captured source
3076 video.
3077
3078 The filter accepts parameters as a list of @var{key}=@var{value}
3079 pairs, separated by ":". If the key of the first options is omitted,
3080 the arguments are interpreted according to syntax
3081 @var{strength}:@var{intensity}:@var{antibanding}.
3082
3083 This filter accepts the following named options:
3084
3085 @table @option
3086 @item strength
3087 Determine the amount of equalization to be applied.  As the strength
3088 is reduced, the distribution of pixel intensities more-and-more
3089 approaches that of the input frame. The value must be a float number
3090 in the range [0,1] and defaults to 0.200.
3091
3092 @item intensity
3093 Set the maximum intensity that can generated and scale the output
3094 values appropriately.  The strength should be set as desired and then
3095 the intensity can be limited if needed to avoid washing-out. The value
3096 must be a float number in the range [0,1] and defaults to 0.210.
3097
3098 @item antibanding
3099 Set the antibanding level. If enabled the filter will randomly vary
3100 the luminance of output pixels by a small amount to avoid banding of
3101 the histogram. Possible values are @code{none}, @code{weak} or
3102 @code{strong}. It defaults to @code{none}.
3103 @end table
3104
3105 @section histogram
3106
3107 Compute and draw a color distribution histogram for the input video.
3108
3109 The computed histogram is a representation of distribution of color components
3110 in an image.
3111
3112 The filter accepts the following named parameters:
3113
3114 @table @option
3115 @item mode
3116 Set histogram mode.
3117
3118 It accepts the following values:
3119 @table @samp
3120 @item levels
3121 standard histogram that display color components distribution in an image.
3122 Displays color graph for each color component. Shows distribution
3123 of the Y, U, V, A or G, B, R components, depending on input format,
3124 in current frame. Bellow each graph is color component scale meter.
3125
3126 @item color
3127 chroma values in vectorscope, if brighter more such chroma values are
3128 distributed in an image.
3129 Displays chroma values (U/V color placement) in two dimensional graph
3130 (which is called a vectorscope). It can be used to read of the hue and
3131 saturation of the current frame. At a same time it is a histogram.
3132 The whiter a pixel in the vectorscope, the more pixels of the input frame
3133 correspond to that pixel (that is the more pixels have this chroma value).
3134 The V component is displayed on the horizontal (X) axis, with the leftmost
3135 side being V = 0 and the rightmost side being V = 255.
3136 The U component is displayed on the vertical (Y) axis, with the top
3137 representing U = 0 and the bottom representing U = 255.
3138
3139 The position of a white pixel in the graph corresponds to the chroma value
3140 of a pixel of the input clip. So the graph can be used to read of the
3141 hue (color flavor) and the saturation (the dominance of the hue in the color).
3142 As the hue of a color changes, it moves around the square. At the center of
3143 the square, the saturation is zero, which means that the corresponding pixel
3144 has no color. If you increase the amount of a specific color, while leaving
3145 the other colors unchanged, the saturation increases, and you move towards
3146 the edge of the square.
3147
3148 @item color2
3149 chroma values in vectorscope, similar as @code{color} but actual chroma values
3150 are displayed.
3151
3152 @item waveform
3153 per row/column color component graph. In row mode graph in the left side represents
3154 color component value 0 and right side represents value = 255. In column mode top
3155 side represents color component value = 0 and bottom side represents value = 255.
3156 @end table
3157 Default value is @code{levels}.
3158
3159 @item level_height
3160 Set height of level in @code{levels}. Default value is @code{200}.
3161 Allowed range is [50, 2048].
3162
3163 @item scale_height
3164 Set height of color scale in @code{levels}. Default value is @code{12}.
3165 Allowed range is [0, 40].
3166
3167 @item step
3168 Set step for @code{waveform} mode. Smaller values are useful to find out how much
3169 of same luminance values across input rows/columns are distributed.
3170 Default value is @code{10}. Allowed range is [1, 255].
3171
3172 @item waveform_mode
3173 Set mode for @code{waveform}. Can be either @code{row}, or @code{column}.
3174 Default is @code{row}.
3175
3176 @item display_mode
3177 Set display mode for @code{waveform} and @code{levels}.
3178 It accepts the following values:
3179 @table @samp
3180 @item parade
3181 Display separate graph for the color components side by side in
3182 @code{row} waveform mode or one below other in @code{column} waveform mode
3183 for @code{waveform} histogram mode. For @code{levels} histogram mode
3184 per color component graphs are placed one bellow other.
3185
3186 This display mode in @code{waveform} histogram mode makes it easy to spot
3187 color casts in the highlights and shadows of an image, by comparing the
3188 contours of the top and the bottom of each waveform.
3189 Since whites, grays, and blacks are characterized by
3190 exactly equal amounts of red, green, and blue, neutral areas of the
3191 picture should display three waveforms of roughly equal width/height.
3192 If not, the correction is easy to make by making adjustments to level the
3193 three waveforms.
3194
3195 @item overlay
3196 Presents information that's identical to that in the @code{parade}, except
3197 that the graphs representing color components are superimposed directly
3198 over one another.
3199
3200 This display mode in @code{waveform} histogram mode can make it easier to spot
3201 the relative differences or similarities in overlapping areas of the color
3202 components that are supposed to be identical, such as neutral whites, grays,
3203 or blacks.
3204 @end table
3205 Default is @code{parade}.
3206 @end table
3207
3208 @subsection Examples
3209
3210 @itemize
3211
3212 @item
3213 Calculate and draw histogram:
3214 @example
3215 ffplay -i input -vf histogram
3216 @end example
3217
3218 @end itemize
3219
3220 @section hqdn3d
3221
3222 High precision/quality 3d denoise filter. This filter aims to reduce
3223 image noise producing smooth images and making still images really
3224 still. It should enhance compressibility.
3225
3226 It accepts the following optional parameters:
3227 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
3228
3229 @table @option
3230 @item luma_spatial
3231 a non-negative float number which specifies spatial luma strength,
3232 defaults to 4.0
3233
3234 @item chroma_spatial
3235 a non-negative float number which specifies spatial chroma strength,
3236 defaults to 3.0*@var{luma_spatial}/4.0
3237
3238 @item luma_tmp
3239 a float number which specifies luma temporal strength, defaults to
3240 6.0*@var{luma_spatial}/4.0
3241
3242 @item chroma_tmp
3243 a float number which specifies chroma temporal strength, defaults to
3244 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
3245 @end table
3246
3247 @section hue
3248
3249 Modify the hue and/or the saturation of the input.
3250
3251 This filter accepts the following optional named options:
3252
3253 @table @option
3254 @item h
3255 Specify the hue angle as a number of degrees. It accepts a float
3256 number or an expression, and defaults to 0.0.
3257
3258 @item H
3259 Specify the hue angle as a number of degrees. It accepts a float
3260 number or an expression, and defaults to 0.0.
3261
3262 @item s
3263 Specify the saturation in the [-10,10] range. It accepts a float number and
3264 defaults to 1.0.
3265 @end table
3266
3267 The @var{h}, @var{H} and @var{s} parameters are expressions containing the
3268 following constants:
3269
3270 @table @option
3271 @item n
3272 frame count of the input frame starting from 0
3273
3274 @item pts
3275 presentation timestamp of the input frame expressed in time base units
3276
3277 @item r
3278 frame rate of the input video, NAN if the input frame rate is unknown
3279
3280 @item t
3281 timestamp expressed in seconds, NAN if the input timestamp is unknown
3282
3283 @item tb
3284 time base of the input video
3285 @end table
3286
3287 The options can also be set using the syntax: @var{hue}:@var{saturation}
3288
3289 In this case @var{hue} is expressed in degrees.
3290
3291 Some examples follow:
3292 @itemize
3293 @item
3294 Set the hue to 90 degrees and the saturation to 1.0:
3295 @example
3296 hue=h=90:s=1
3297 @end example
3298
3299 @item
3300 Same command but expressing the hue in radians:
3301 @example
3302 hue=H=PI/2:s=1
3303 @end example
3304
3305 @item
3306 Same command without named options, hue must be expressed in degrees:
3307 @example
3308 hue=90:1
3309 @end example
3310
3311 @item
3312 Note that "h:s" syntax does not support expressions for the values of
3313 h and s, so the following example will issue an error:
3314 @example
3315 hue=PI/2:1
3316 @end example
3317
3318 @item
3319 Rotate hue and make the saturation swing between 0
3320 and 2 over a period of 1 second:
3321 @example
3322 hue="H=2*PI*t: s=sin(2*PI*t)+1"
3323 @end example
3324
3325 @item
3326 Apply a 3 seconds saturation fade-in effect starting at 0:
3327 @example
3328 hue="s=min(t/3\,1)"
3329 @end example
3330
3331 The general fade-in expression can be written as:
3332 @example
3333 hue="s=min(0\, max((t-START)/DURATION\, 1))"
3334 @end example
3335
3336 @item
3337 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
3338 @example
3339 hue="s=max(0\, min(1\, (8-t)/3))"
3340 @end example
3341
3342 The general fade-out expression can be written as:
3343 @example
3344 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
3345 @end example
3346
3347 @end itemize
3348
3349 @subsection Commands
3350
3351 This filter supports the following command:
3352 @table @option
3353 @item reinit
3354 Modify the hue and/or the saturation of the input video.
3355 The command accepts the same named options and syntax than when calling the
3356 filter from the command-line.
3357
3358 If a parameter is omitted, it is kept at its current value.
3359 @end table
3360
3361 @section idet
3362
3363 Detect video interlacing type.
3364
3365 This filter tries to detect if the input is interlaced or progressive,
3366 top or bottom field first.
3367
3368 @section il
3369
3370 Deinterleave or interleave fields.
3371
3372 This filter allows to process interlaced images fields without
3373 deinterlacing them. Deinterleaving splits the input frame into 2
3374 fields (so called half pictures). Odd lines are moved to the top
3375 half of the output image, even lines to the bottom half.
3376 You can process (filter) them independently and then re-interleave them.
3377
3378 It accepts a list of options in the form of @var{key}=@var{value} pairs
3379 separated by ":". A description of the accepted options follows.
3380
3381 @table @option
3382 @item luma_mode, l
3383 @item chroma_mode, s
3384 @item alpha_mode, a
3385 Available values for @var{luma_mode}, @var{chroma_mode} and
3386 @var{alpha_mode} are:
3387
3388 @table @samp
3389 @item none
3390 Do nothing.
3391
3392 @item deinterleave, d
3393 Deinterleave fields, placing one above the other.
3394
3395 @item interleave, i
3396 Interleave fields. Reverse the effect of deinterleaving.
3397 @end table
3398 Default value is @code{none}.
3399
3400 @item luma_swap, ls
3401 @item chroma_swap, cs
3402 @item alpha_swap, as
3403 Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is @code{0}.
3404 @end table
3405
3406 @section kerndeint
3407
3408 Deinterlace input video by applying Donald Graft's adaptive kernel
3409 deinterling. Work on interlaced parts of a video to produce
3410 progressive frames.
3411
3412 This filter accepts parameters as a list of @var{key}=@var{value}
3413 pairs, separated by ":". If the key of the first options is omitted,
3414 the arguments are interpreted according to the following syntax:
3415 @var{thresh}:@var{map}:@var{order}:@var{sharp}:@var{twoway}.
3416
3417 The description of the accepted parameters follows.
3418
3419 @table @option
3420 @item thresh
3421 Set the threshold which affects the filter's tolerance when
3422 determining if a pixel line must be processed. It must be an integer
3423 in the range [0,255] and defaults to 10. A value of 0 will result in
3424 applying the process on every pixels.
3425
3426 @item map
3427 Paint pixels exceeding the threshold value to white if set to 1.
3428 Default is 0.
3429
3430 @item order
3431 Set the fields order. Swap fields if set to 1, leave fields alone if
3432 0. Default is 0.
3433
3434 @item sharp
3435 Enable additional sharpening if set to 1. Default is 0.
3436
3437 @item twoway
3438 Enable twoway sharpening if set to 1. Default is 0.
3439 @end table
3440
3441 @subsection Examples
3442
3443 @itemize
3444 @item
3445 Apply default values:
3446 @example
3447 kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
3448 @end example
3449
3450 @item
3451 Enable additional sharpening:
3452 @example
3453 kerndeint=sharp=1
3454 @end example
3455
3456 @item
3457 Paint processed pixels in white:
3458 @example
3459 kerndeint=map=1
3460 @end example
3461 @end itemize
3462
3463 @section lut, lutrgb, lutyuv
3464
3465 Compute a look-up table for binding each pixel component input value
3466 to an output value, and apply it to input video.
3467
3468 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
3469 to an RGB input video.
3470
3471 These filters accept in input a ":"-separated list of options, which
3472 specify the expressions used for computing the lookup table for the
3473 corresponding pixel component values.
3474
3475 The @var{lut} filter requires either YUV or RGB pixel formats in
3476 input, and accepts the options:
3477 @table @option
3478 @item c0
3479 set first pixel component expression
3480 @item c1
3481 set second pixel component expression
3482 @item c2
3483 set third pixel component expression
3484 @item c3
3485 set fourth pixel component expression, corresponds to the alpha component
3486 @end table
3487
3488 The exact component associated to each option depends on the format in
3489 input.
3490
3491 The @var{lutrgb} filter requires RGB pixel formats in input, and
3492 accepts the options:
3493 @table @option
3494 @item r
3495 set red component expression
3496 @item g
3497 set green component expression
3498 @item b
3499 set blue component expression
3500 @item a
3501 alpha component expression
3502 @end table
3503
3504 The @var{lutyuv} filter requires YUV pixel formats in input, and
3505 accepts the options:
3506 @table @option
3507 @item y
3508 set Y/luminance component expression
3509 @item u
3510 set U/Cb component expression
3511 @item v
3512 set V/Cr component expression
3513 @item a
3514 set alpha component expression
3515 @end table
3516
3517 The expressions can contain the following constants and functions:
3518
3519 @table @option
3520 @item w, h
3521 the input width and height
3522
3523 @item val
3524 input value for the pixel component
3525
3526 @item clipval
3527 the input value clipped in the @var{minval}-@var{maxval} range
3528
3529 @item maxval
3530 maximum value for the pixel component
3531
3532 @item minval
3533 minimum value for the pixel component
3534
3535 @item negval
3536 the negated value for the pixel component value clipped in the
3537 @var{minval}-@var{maxval} range , it corresponds to the expression
3538 "maxval-clipval+minval"
3539
3540 @item clip(val)
3541 the computed value in @var{val} clipped in the
3542 @var{minval}-@var{maxval} range
3543
3544 @item gammaval(gamma)
3545 the computed gamma correction value of the pixel component value
3546 clipped in the @var{minval}-@var{maxval} range, corresponds to the
3547 expression
3548 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
3549
3550 @end table
3551
3552 All expressions default to "val".
3553
3554 @subsection Examples
3555
3556 @itemize
3557 @item
3558 Negate input video:
3559 @example
3560 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
3561 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
3562 @end example
3563
3564 The above is the same as:
3565 @example
3566 lutrgb="r=negval:g=negval:b=negval"
3567 lutyuv="y=negval:u=negval:v=negval"
3568 @end example
3569
3570 @item
3571 Negate luminance:
3572 @example
3573 lutyuv=y=negval
3574 @end example
3575
3576 @item
3577 Remove chroma components, turns the video into a graytone image:
3578 @example
3579 lutyuv="u=128:v=128"
3580 @end example
3581
3582 @item
3583 Apply a luma burning effect:
3584 @example
3585 lutyuv="y=2*val"
3586 @end example
3587
3588 @item
3589 Remove green and blue components:
3590 @example
3591 lutrgb="g=0:b=0"
3592 @end example
3593
3594 @item
3595 Set a constant alpha channel value on input:
3596 @example
3597 format=rgba,lutrgb=a="maxval-minval/2"
3598 @end example
3599
3600 @item
3601 Correct luminance gamma by a 0.5 factor:
3602 @example
3603 lutyuv=y=gammaval(0.5)
3604 @end example
3605 @end itemize
3606
3607 @section mp
3608
3609 Apply an MPlayer filter to the input video.
3610
3611 This filter provides a wrapper around most of the filters of
3612 MPlayer/MEncoder.
3613
3614 This wrapper is considered experimental. Some of the wrapped filters
3615 may not work properly and we may drop support for them, as they will
3616 be implemented natively into FFmpeg. Thus you should avoid
3617 depending on them when writing portable scripts.
3618
3619 The filters accepts the parameters:
3620 @var{filter_name}[:=]@var{filter_params}
3621
3622 @var{filter_name} is the name of a supported MPlayer filter,
3623 @var{filter_params} is a string containing the parameters accepted by
3624 the named filter.
3625
3626 The list of the currently supported filters follows:
3627 @table @var
3628 @item detc
3629 @item dint
3630 @item divtc
3631 @item down3dright
3632 @item eq2
3633 @item eq
3634 @item fil
3635 @item fspp
3636 @item harddup
3637 @item ilpack
3638 @item ivtc
3639 @item mcdeint
3640 @item ow
3641 @item perspective
3642 @item phase
3643 @item pp7
3644 @item pullup
3645 @item qp
3646 @item sab
3647 @item softpulldown
3648 @item spp
3649 @item telecine
3650 @item tinterlace
3651 @item uspp
3652 @end table
3653
3654 The parameter syntax and behavior for the listed filters are the same
3655 of the corresponding MPlayer filters. For detailed instructions check
3656 the "VIDEO FILTERS" section in the MPlayer manual.
3657
3658 Some examples follow:
3659 @itemize
3660 @item
3661 Adjust gamma, brightness, contrast:
3662 @example
3663 mp=eq2=1.0:2:0.5
3664 @end example
3665 @end itemize
3666
3667 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
3668
3669 @section negate
3670
3671 Negate input video.
3672
3673 This filter accepts an integer in input, if non-zero it negates the
3674 alpha component (if available). The default value in input is 0.
3675
3676 @section noformat
3677
3678 Force libavfilter not to use any of the specified pixel formats for the
3679 input to the next filter.
3680
3681 The filter accepts a list of pixel format names, separated by ":",
3682 for example "yuv420p:monow:rgb24".
3683
3684 Some examples follow:
3685 @example
3686 # force libavfilter to use a format different from "yuv420p" for the
3687 # input to the vflip filter
3688 noformat=yuv420p,vflip
3689
3690 # convert the input video to any of the formats not contained in the list
3691 noformat=yuv420p:yuv444p:yuv410p
3692 @end example
3693
3694 @section noise
3695
3696 Add noise on video input frame.
3697
3698 This filter accepts a list of options in the form of @var{key}=@var{value}
3699 pairs separated by ":". A description of the accepted options follows.
3700
3701 @table @option
3702 @item all_seed
3703 @item c0_seed
3704 @item c1_seed
3705 @item c2_seed
3706 @item c3_seed
3707 Set noise seed for specific pixel component or all pixel components in case
3708 of @var{all_seed}. Default value is @code{123457}.
3709
3710 @item all_strength, as
3711 @item c0_strength, c0s
3712 @item c1_strength, c1s
3713 @item c2_strength, c2s
3714 @item c3_strength, c3s
3715 Set noise strength for specific pixel component or all pixel components in case
3716 @var{all_strength}. Default value is @code{0}. Allowed range is [0, 100].
3717
3718 @item all_flags, af
3719 @item c0_flags, c0f
3720 @item c1_flags, c1f
3721 @item c2_flags, c2f
3722 @item c3_flags, c3f
3723 Set pixel component flags or set flags for all components if @var{all_flags}.
3724 Available values for component flags are:
3725 @table @samp
3726 @item a
3727 averaged temporal noise (smoother)
3728 @item p
3729 mix random noise with a (semi)regular pattern
3730 @item q
3731 higher quality (slightly better looking, slightly slower)
3732 @item t
3733 temporal noise (noise pattern changes between frames)
3734 @item u
3735 uniform noise (gaussian otherwise)
3736 @end table
3737 @end table
3738
3739 Some examples follow:
3740 @example
3741 Add temporal and uniform noise to input video:
3742 noise=alls=20:allf=t+u
3743 @end example
3744
3745 @section null
3746
3747 Pass the video source unchanged to the output.
3748
3749 @section ocv
3750
3751 Apply video transform using libopencv.
3752
3753 To enable this filter install libopencv library and headers and
3754 configure FFmpeg with @code{--enable-libopencv}.
3755
3756 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
3757
3758 @var{filter_name} is the name of the libopencv filter to apply.
3759
3760 @var{filter_params} specifies the parameters to pass to the libopencv
3761 filter. If not specified the default values are assumed.
3762
3763 Refer to the official libopencv documentation for more precise
3764 information:
3765 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
3766
3767 Follows the list of supported libopencv filters.
3768
3769 @anchor{dilate}
3770 @subsection dilate
3771
3772 Dilate an image by using a specific structuring element.
3773 This filter corresponds to the libopencv function @code{cvDilate}.
3774
3775 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
3776
3777 @var{struct_el} represents a structuring element, and has the syntax:
3778 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
3779
3780 @var{cols} and @var{rows} represent the number of columns and rows of
3781 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
3782 point, and @var{shape} the shape for the structuring element, and
3783 can be one of the values "rect", "cross", "ellipse", "custom".
3784
3785 If the value for @var{shape} is "custom", it must be followed by a
3786 string of the form "=@var{filename}". The file with name
3787 @var{filename} is assumed to represent a binary image, with each
3788 printable character corresponding to a bright pixel. When a custom
3789 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
3790 or columns and rows of the read file are assumed instead.
3791
3792 The default value for @var{struct_el} is "3x3+0x0/rect".
3793
3794 @var{nb_iterations} specifies the number of times the transform is
3795 applied to the image, and defaults to 1.
3796
3797 Follow some example:
3798 @example
3799 # use the default values
3800 ocv=dilate
3801
3802 # dilate using a structuring element with a 5x5 cross, iterate two times
3803 ocv=dilate=5x5+2x2/cross:2
3804
3805 # read the shape from the file diamond.shape, iterate two times
3806 # the file diamond.shape may contain a pattern of characters like this:
3807 #   *
3808 #  ***
3809 # *****
3810 #  ***
3811 #   *
3812 # the specified cols and rows are ignored (but not the anchor point coordinates)
3813 ocv=0x0+2x2/custom=diamond.shape:2
3814 @end example
3815
3816 @subsection erode
3817
3818 Erode an image by using a specific structuring element.
3819 This filter corresponds to the libopencv function @code{cvErode}.
3820
3821 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
3822 with the same syntax and semantics as the @ref{dilate} filter.
3823
3824 @subsection smooth
3825
3826 Smooth the input video.
3827
3828 The filter takes the following parameters:
3829 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
3830
3831 @var{type} is the type of smooth filter to apply, and can be one of
3832 the following values: "blur", "blur_no_scale", "median", "gaussian",
3833 "bilateral". The default value is "gaussian".
3834
3835 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
3836 parameters whose meanings depend on smooth type. @var{param1} and
3837 @var{param2} accept integer positive values or 0, @var{param3} and
3838 @var{param4} accept float values.
3839
3840 The default value for @var{param1} is 3, the default value for the
3841 other parameters is 0.
3842
3843 These parameters correspond to the parameters assigned to the
3844 libopencv function @code{cvSmooth}.
3845
3846 @anchor{overlay}
3847 @section overlay
3848
3849 Overlay one video on top of another.
3850
3851 It takes two inputs and one output, the first input is the "main"
3852 video on which the second input is overlayed.
3853
3854 This filter accepts a list of @var{key}=@var{value} pairs as argument,
3855 separated by ":". If the key of the first options is omitted, the
3856 arguments are interpreted according to the syntax @var{x}:@var{y}.
3857
3858 A description of the accepted options follows.
3859
3860 @table @option
3861 @item x, y
3862 Set the expression for the x and y coordinates of the overlayed video
3863 on the main video. Default value is 0.
3864
3865 The @var{x} and @var{y} expressions can contain the following
3866 parameters:
3867 @table @option
3868 @item main_w, main_h
3869 main input width and height
3870
3871 @item W, H
3872 same as @var{main_w} and @var{main_h}
3873
3874 @item overlay_w, overlay_h
3875 overlay input width and height
3876
3877 @item w, h
3878 same as @var{overlay_w} and @var{overlay_h}
3879 @end table
3880
3881 @item format
3882 Set the format for the output video.
3883
3884 It accepts the following values:
3885 @table @samp
3886 @item yuv420
3887 force YUV420 output
3888
3889 @item yuv444
3890 force YUV444 output
3891
3892 @item rgb
3893 force RGB output
3894 @end table
3895
3896 Default value is @samp{yuv420}.
3897
3898 @item rgb @emph{(deprecated)}
3899 If set to 1, force the filter to accept inputs in the RGB
3900 color space. Default value is 0. This option is deprecated, use
3901 @option{format} instead.
3902
3903 @item shortest
3904 If set to 1, force the output to terminate when the shortest input
3905 terminates. Default value is 0.
3906 @end table
3907
3908 Be aware that frames are taken from each input video in timestamp
3909 order, hence, if their initial timestamps differ, it is a a good idea
3910 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
3911 have them begin in the same zero timestamp, as it does the example for
3912 the @var{movie} filter.
3913
3914 You can chain together more overlays but you should test the
3915 efficiency of such approach.
3916
3917 @subsection Examples
3918
3919 @itemize
3920 @item
3921 Draw the overlay at 10 pixels from the bottom right corner of the main
3922 video:
3923 @example
3924 overlay=main_w-overlay_w-10:main_h-overlay_h-10
3925 @end example
3926
3927 Using named options the example above becomes:
3928 @example
3929 overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
3930 @end example
3931
3932 @item
3933 Insert a transparent PNG logo in the bottom left corner of the input,
3934 using the @command{ffmpeg} tool with the @code{-filter_complex} option:
3935 @example
3936 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
3937 @end example
3938
3939 @item
3940 Insert 2 different transparent PNG logos (second logo on bottom
3941 right corner) using the @command{ffmpeg} tool:
3942 @example
3943 ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
3944 @end example
3945
3946 @item
3947 Add a transparent color layer on top of the main video, WxH specifies
3948 the size of the main input to the overlay filter:
3949 @example
3950 color=red@@.3:WxH [over]; [in][over] overlay [out]
3951 @end example
3952
3953 @item
3954 Play an original video and a filtered version (here with the deshake
3955 filter) side by side using the @command{ffplay} tool:
3956 @example
3957 ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
3958 @end example
3959
3960 The above command is the same as:
3961 @example
3962 ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
3963 @end example
3964
3965 @item
3966 Compose output by putting two input videos side to side:
3967 @example
3968 ffmpeg -i left.avi -i right.avi -filter_complex "
3969 nullsrc=size=200x100 [background];
3970 [0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
3971 [1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
3972 [background][left]       overlay=shortest=1       [background+left];
3973 [background+left][right] overlay=shortest=1:x=100 [left+right]
3974 "
3975 @end example
3976
3977 @item
3978 Chain several overlays in cascade:
3979 @example
3980 nullsrc=s=200x200 [bg];
3981 testsrc=s=100x100, split=4 [in0][in1][in2][in3];
3982 [in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
3983 [in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
3984 [in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
3985 [in3] null,       [mid2] overlay=100:100 [out0]
3986 @end example
3987
3988 @end itemize
3989
3990 @section pad
3991
3992 Add paddings to the input image, and place the original input at the
3993 given coordinates @var{x}, @var{y}.
3994
3995 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
3996 separated by ":".
3997
3998 If the key of the first options is omitted, the arguments are
3999 interpreted according to the syntax
4000 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
4001
4002 A description of the accepted options follows.
4003
4004 @table @option
4005 @item width, w
4006 @item height, h
4007 Specify an expression for the size of the output image with the
4008 paddings added. If the value for @var{width} or @var{height} is 0, the
4009 corresponding input size is used for the output.
4010
4011 The @var{width} expression can reference the value set by the
4012 @var{height} expression, and vice versa.
4013
4014 The default value of @var{width} and @var{height} is 0.
4015
4016 @item x
4017 @item y
4018 Specify an expression for the offsets where to place the input image
4019 in the padded area with respect to the top/left border of the output
4020 image.
4021
4022 The @var{x} expression can reference the value set by the @var{y}
4023 expression, and vice versa.
4024
4025 The default value of @var{x} and @var{y} is 0.
4026
4027 @item color
4028 Specify the color of the padded area, it can be the name of a color
4029 (case insensitive match) or a 0xRRGGBB[AA] sequence.
4030
4031 The default value of @var{color} is "black".
4032 @end table
4033
4034 The value for the @var{width}, @var{height}, @var{x}, and @var{y}
4035 options are expressions containing the following constants:
4036
4037 @table @option
4038 @item in_w, in_h
4039 the input video width and height
4040
4041 @item iw, ih
4042 same as @var{in_w} and @var{in_h}
4043
4044 @item out_w, out_h
4045 the output width and height, that is the size of the padded area as
4046 specified by the @var{width} and @var{height} expressions
4047
4048 @item ow, oh
4049 same as @var{out_w} and @var{out_h}
4050
4051 @item x, y
4052 x and y offsets as specified by the @var{x} and @var{y}
4053 expressions, or NAN if not yet specified
4054
4055 @item a
4056 same as @var{iw} / @var{ih}
4057
4058 @item sar
4059 input sample aspect ratio
4060
4061 @item dar
4062 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
4063
4064 @item hsub, vsub
4065 horizontal and vertical chroma subsample values. For example for the
4066 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4067 @end table
4068
4069 @subsection Examples
4070
4071 @itemize
4072 @item
4073 Add paddings with color "violet" to the input video. Output video
4074 size is 640x480, the top-left corner of the input video is placed at
4075 column 0, row 40:
4076 @example
4077 pad=640:480:0:40:violet
4078 @end example
4079
4080 The example above is equivalent to the following command:
4081 @example
4082 pad=width=640:height=480:x=0:y=40:color=violet
4083 @end example
4084
4085 @item
4086 Pad the input to get an output with dimensions increased by 3/2,
4087 and put the input video at the center of the padded area:
4088 @example
4089 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
4090 @end example
4091
4092 @item
4093 Pad the input to get a squared output with size equal to the maximum
4094 value between the input width and height, and put the input video at
4095 the center of the padded area:
4096 @example
4097 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
4098 @end example
4099
4100 @item
4101 Pad the input to get a final w/h ratio of 16:9:
4102 @example
4103 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
4104 @end example
4105
4106 @item
4107 In case of anamorphic video, in order to set the output display aspect
4108 correctly, it is necessary to use @var{sar} in the expression,
4109 according to the relation:
4110 @example
4111 (ih * X / ih) * sar = output_dar
4112 X = output_dar / sar
4113 @end example
4114
4115 Thus the previous example needs to be modified to:
4116 @example
4117 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
4118 @end example
4119
4120 @item
4121 Double output size and put the input video in the bottom-right
4122 corner of the output padded area:
4123 @example
4124 pad="2*iw:2*ih:ow-iw:oh-ih"
4125 @end example
4126 @end itemize
4127
4128 @section pixdesctest
4129
4130 Pixel format descriptor test filter, mainly useful for internal
4131 testing. The output video should be equal to the input video.
4132
4133 For example:
4134 @example
4135 format=monow, pixdesctest
4136 @end example
4137
4138 can be used to test the monowhite pixel format descriptor definition.
4139
4140 @section pp
4141
4142 Enable the specified chain of postprocessing subfilters using libpostproc. This
4143 library should be automatically selected with a GPL build (@code{--enable-gpl}).
4144 Subfilters must be separated by '/' and can be disabled by prepending a '-'.
4145 Each subfilter and some options have a short and a long name that can be used
4146 interchangeably, i.e. dr/dering are the same.
4147
4148 All subfilters share common options to determine their scope:
4149
4150 @table @option
4151 @item a/autoq
4152 Honor the quality commands for this subfilter.
4153
4154 @item c/chrom
4155 Do chrominance filtering, too (default).
4156
4157 @item y/nochrom
4158 Do luminance filtering only (no chrominance).
4159
4160 @item n/noluma
4161 Do chrominance filtering only (no luminance).
4162 @end table
4163
4164 These options can be appended after the subfilter name, separated by a ':'.
4165
4166 Available subfilters are:
4167
4168 @table @option
4169 @item hb/hdeblock[:difference[:flatness]]
4170 Horizontal deblocking filter
4171 @table @option
4172 @item difference
4173 Difference factor where higher values mean more deblocking (default: @code{32}).
4174 @item flatness
4175 Flatness threshold where lower values mean more deblocking (default: @code{39}).
4176 @end table
4177
4178 @item vb/vdeblock[:difference[:flatness]]
4179 Vertical deblocking filter
4180 @table @option
4181 @item difference
4182 Difference factor where higher values mean more deblocking (default: @code{32}).
4183 @item flatness
4184 Flatness threshold where lower values mean more deblocking (default: @code{39}).
4185 @end table
4186
4187 @item ha/hadeblock[:difference[:flatness]]
4188 Accurate horizontal deblocking filter
4189 @table @option
4190 @item difference
4191 Difference factor where higher values mean more deblocking (default: @code{32}).
4192 @item flatness
4193 Flatness threshold where lower values mean more deblocking (default: @code{39}).
4194 @end table
4195
4196 @item va/vadeblock[:difference[:flatness]]
4197 Accurate vertical deblocking filter
4198 @table @option
4199 @item difference
4200 Difference factor where higher values mean more deblocking (default: @code{32}).
4201 @item flatness
4202 Flatness threshold where lower values mean more deblocking (default: @code{39}).
4203 @end table
4204 @end table
4205
4206 The horizontal and vertical deblocking filters share the difference and
4207 flatness values so you cannot set different horizontal and vertical
4208 thresholds.
4209
4210 @table @option
4211 @item h1/x1hdeblock
4212 Experimental horizontal deblocking filter
4213
4214 @item v1/x1vdeblock
4215 Experimental vertical deblocking filter
4216
4217 @item dr/dering
4218 Deringing filter
4219
4220 @item tn/tmpnoise[:threshold1[:threshold2[:threshold3]]], temporal noise reducer
4221 @table @option
4222 @item threshold1