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