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