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