Merge commit 'd28cb849899abd98bf2dd72f5a3dd56d441aeb27'
[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 comma-separated list of requested sample formats.
693
694 @item sample_rates
695 A comma-separated list of requested sample rates.
696
697 @item channel_layouts
698 A comma-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 A description of the accepted options follows.
1878
1879 @table @option
1880 @item amount
1881 Set the percentage of pixels that have to be below the
1882 threshold to enable black detection. Default value is 98.
1883
1884 @item threshold
1885 Set the threshold below which a pixel value is considered
1886 black. Default value is 32.
1887 @end table
1888
1889 @section blend
1890
1891 Blend two video frames into each other.
1892
1893 It takes two input streams and outputs one stream, the first input is the
1894 "top" layer and second input is "bottom" layer.
1895 Output terminates when shortest input terminates.
1896
1897 This filter accepts a list of options in the form of @var{key}=@var{value}
1898 pairs separated by ":". A description of the accepted options follows.
1899
1900 @table @option
1901 @item c0_mode
1902 @item c1_mode
1903 @item c2_mode
1904 @item c3_mode
1905 @item all_mode
1906 Set blend mode for specific pixel component or all pixel components in case
1907 of @var{all_mode}. Default value is @code{normal}.
1908
1909 Available values for component modes are:
1910 @table @samp
1911 @item addition
1912 @item and
1913 @item average
1914 @item burn
1915 @item darken
1916 @item difference
1917 @item divide
1918 @item dodge
1919 @item exclusion
1920 @item hardlight
1921 @item lighten
1922 @item multiply
1923 @item negation
1924 @item normal
1925 @item or
1926 @item overlay
1927 @item phoenix
1928 @item pinlight
1929 @item reflect
1930 @item screen
1931 @item softlight
1932 @item subtract
1933 @item vividlight
1934 @item xor
1935 @end table
1936
1937 @item c0_opacity
1938 @item c1_opacity
1939 @item c2_opacity
1940 @item c3_opacity
1941 @item all_opacity
1942 Set blend opacity for specific pixel component or all pixel components in case
1943 of @var{all_opacity}. Only used in combination with pixel component blend modes.
1944
1945 @item c0_expr
1946 @item c1_expr
1947 @item c2_expr
1948 @item c3_expr
1949 @item all_expr
1950 Set blend expression for specific pixel component or all pixel components in case
1951 of @var{all_expr}. Note that related mode options will be ignored if those are set.
1952
1953 The expressions can use the following variables:
1954
1955 @table @option
1956 @item N
1957 The sequential number of the filtered frame, starting from @code{0}.
1958
1959 @item X
1960 @item Y
1961 the coordinates of the current sample
1962
1963 @item W
1964 @item H
1965 the width and height of currently filtered plane
1966
1967 @item SW
1968 @item SH
1969 Width and height scale depending on the currently filtered plane. It is the
1970 ratio between the corresponding luma plane number of pixels and the current
1971 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
1972 @code{0.5,0.5} for chroma planes.
1973
1974 @item T
1975 Time of the current frame, expressed in seconds.
1976
1977 @item TOP, A
1978 Value of pixel component at current location for first video frame (top layer).
1979
1980 @item BOTTOM, B
1981 Value of pixel component at current location for second video frame (bottom layer).
1982 @end table
1983 @end table
1984
1985 @subsection Examples
1986
1987 @itemize
1988 @item
1989 Apply transition from bottom layer to top layer in first 10 seconds:
1990 @example
1991 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
1992 @end example
1993
1994 @item
1995 Apply 1x1 checkerboard effect:
1996 @example
1997 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
1998 @end example
1999 @end itemize
2000
2001 @section boxblur
2002
2003 Apply boxblur algorithm to the input video.
2004
2005 The filter accepts parameters as a list of @var{key}=@var{value}
2006 pairs, separated by ":". If the key of the first options is omitted,
2007 the arguments are interpreted according to the syntax
2008 @option{luma_radius}:@option{luma_power}:@option{chroma_radius}:@option{chroma_power}:@option{alpha_radius}:@option{alpha_power}.
2009
2010 A description of the accepted options follows.
2011
2012 @table @option
2013 @item luma_radius, lr
2014 @item chroma_radius, cr
2015 @item alpha_radius, ar
2016 Set an expression for the box radius in pixels used for blurring the
2017 corresponding input plane.
2018
2019 The radius value must be a non-negative number, and must not be
2020 greater than the value of the expression @code{min(w,h)/2} for the
2021 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
2022 planes.
2023
2024 Default value for @option{luma_radius} is "2". If not specified,
2025 @option{chroma_radius} and @option{alpha_radius} default to the
2026 corresponding value set for @option{luma_radius}.
2027
2028 The expressions can contain the following constants:
2029 @table @option
2030 @item w, h
2031 the input width and height in pixels
2032
2033 @item cw, ch
2034 the input chroma image width and height in pixels
2035
2036 @item hsub, vsub
2037 horizontal and vertical chroma subsample values. For example for the
2038 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2039 @end table
2040
2041 @item luma_power, lp
2042 @item chroma_power, cp
2043 @item alpha_power, ap
2044 Specify how many times the boxblur filter is applied to the
2045 corresponding plane.
2046
2047 Default value for @option{luma_power} is 2. If not specified,
2048 @option{chroma_power} and @option{alpha_power} default to the
2049 corresponding value set for @option{luma_power}.
2050
2051 A value of 0 will disable the effect.
2052 @end table
2053
2054 @subsection Examples
2055
2056 @itemize
2057 @item
2058 Apply a boxblur filter with luma, chroma, and alpha radius
2059 set to 2:
2060 @example
2061 boxblur=2:1
2062 @end example
2063
2064 @item
2065 Set luma radius to 2, alpha and chroma radius to 0:
2066 @example
2067 boxblur=2:1:cr=0:ar=0
2068 @end example
2069
2070 @item
2071 Set luma and chroma radius to a fraction of the video dimension:
2072 @example
2073 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
2074 @end example
2075 @end itemize
2076
2077 @section colormatrix
2078
2079 Convert color matrix.
2080
2081 The filter accepts parameters as a list of @var{key}=@var{value}
2082 pairs, separated by ":". If the key of the first options is omitted,
2083 the arguments are interpreted according to the syntax
2084 @var{src}:@var{dst}.
2085
2086 A description of the accepted options follows:
2087 @table @option
2088 @item src
2089 @item dst
2090 Specify the source and destination color matrix. Both values must be
2091 specified.
2092
2093 The accepted values are:
2094 @table @samp
2095 @item bt709
2096 BT.709
2097
2098 @item bt601
2099 BT.601
2100
2101 @item smpte240m
2102 SMPTE-240M
2103
2104 @item fcc
2105 FCC
2106 @end table
2107 @end table
2108
2109 For example to convert from BT.601 to SMPTE-240M, use the command:
2110 @example
2111 colormatrix=bt601:smpte240m
2112 @end example
2113
2114 @section copy
2115
2116 Copy the input source unchanged to the output. Mainly useful for
2117 testing purposes.
2118
2119 @section crop
2120
2121 Crop the input video.
2122
2123 This filter accepts a list of @var{key}=@var{value} pairs as argument,
2124 separated by ':'. If the key of the first options is omitted, the
2125 arguments are interpreted according to the syntax
2126 @var{out_w}:@var{out_h}:@var{x}:@var{y}:@var{keep_aspect}.
2127
2128 A description of the accepted options follows:
2129 @table @option
2130 @item w, out_w
2131 Set the crop area width. It defaults to @code{iw}.
2132 This expression is evaluated only once during the filter
2133 configuration.
2134
2135 @item h, out_h
2136 Set the crop area height. It defaults to @code{ih}.
2137 This expression is evaluated only once during the filter
2138 configuration.
2139
2140 @item x
2141 Set the expression for the x top-left coordinate of the cropped area.
2142 It defaults to @code{(in_w-out_w)/2}.
2143 This expression is evaluated per-frame.
2144
2145 @item y
2146 Set the expression for the y top-left coordinate of the cropped area.
2147 It defaults to @code{(in_h-out_h)/2}.
2148 This expression is evaluated per-frame.
2149
2150 @item keep_aspect
2151 If set to 1 will force the output display aspect ratio
2152 to be the same of the input, by changing the output sample aspect
2153 ratio. It defaults to 0.
2154 @end table
2155
2156 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
2157 expressions containing the following constants:
2158
2159 @table @option
2160 @item x, y
2161 the computed values for @var{x} and @var{y}. They are evaluated for
2162 each new frame.
2163
2164 @item in_w, in_h
2165 the input width and height
2166
2167 @item iw, ih
2168 same as @var{in_w} and @var{in_h}
2169
2170 @item out_w, out_h
2171 the output (cropped) width and height
2172
2173 @item ow, oh
2174 same as @var{out_w} and @var{out_h}
2175
2176 @item a
2177 same as @var{iw} / @var{ih}
2178
2179 @item sar
2180 input sample aspect ratio
2181
2182 @item dar
2183 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2184
2185 @item hsub, vsub
2186 horizontal and vertical chroma subsample values. For example for the
2187 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2188
2189 @item n
2190 the number of input frame, starting from 0
2191
2192 @item t
2193 timestamp expressed in seconds, NAN if the input timestamp is unknown
2194
2195 @end table
2196
2197 The expression for @var{out_w} may depend on the value of @var{out_h},
2198 and the expression for @var{out_h} may depend on @var{out_w}, but they
2199 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
2200 evaluated after @var{out_w} and @var{out_h}.
2201
2202 The @var{x} and @var{y} parameters specify the expressions for the
2203 position of the top-left corner of the output (non-cropped) area. They
2204 are evaluated for each frame. If the evaluated value is not valid, it
2205 is approximated to the nearest valid value.
2206
2207 The expression for @var{x} may depend on @var{y}, and the expression
2208 for @var{y} may depend on @var{x}.
2209
2210 @subsection Examples
2211
2212 @itemize
2213 @item
2214 Crop area with size 100x100 at position (12,34).
2215 @example
2216 crop=100:100:12:34
2217 @end example
2218
2219 Using named options, the example above becomes:
2220 @example
2221 crop=w=100:h=100:x=12:y=34
2222 @end example
2223
2224 @item
2225 Crop the central input area with size 100x100:
2226 @example
2227 crop=100:100
2228 @end example
2229
2230 @item
2231 Crop the central input area with size 2/3 of the input video:
2232 @example
2233 crop=2/3*in_w:2/3*in_h
2234 @end example
2235
2236 @item
2237 Crop the input video central square:
2238 @example
2239 crop=in_h
2240 @end example
2241
2242 @item
2243 Delimit the rectangle with the top-left corner placed at position
2244 100:100 and the right-bottom corner corresponding to the right-bottom
2245 corner of the input image:
2246 @example
2247 crop=in_w-100:in_h-100:100:100
2248 @end example
2249
2250 @item
2251 Crop 10 pixels from the left and right borders, and 20 pixels from
2252 the top and bottom borders
2253 @example
2254 crop=in_w-2*10:in_h-2*20
2255 @end example
2256
2257 @item
2258 Keep only the bottom right quarter of the input image:
2259 @example
2260 crop=in_w/2:in_h/2:in_w/2:in_h/2
2261 @end example
2262
2263 @item
2264 Crop height for getting Greek harmony:
2265 @example
2266 crop=in_w:1/PHI*in_w
2267 @end example
2268
2269 @item
2270 Appply trembling effect:
2271 @example
2272 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)
2273 @end example
2274
2275 @item
2276 Apply erratic camera effect depending on timestamp:
2277 @example
2278 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)"
2279 @end example
2280
2281 @item
2282 Set x depending on the value of y:
2283 @example
2284 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
2285 @end example
2286 @end itemize
2287
2288 @section cropdetect
2289
2290 Auto-detect crop size.
2291
2292 Calculate necessary cropping parameters and prints the recommended
2293 parameters through the logging system. The detected dimensions
2294 correspond to the non-black area of the input video.
2295
2296 The filter accepts parameters as a list of @var{key}=@var{value}
2297 pairs, separated by ":". If the key of the first options is omitted,
2298 the arguments are interpreted according to the syntax
2299 [@option{limit}[:@option{round}[:@option{reset}]]].
2300
2301 A description of the accepted options follows.
2302
2303 @table @option
2304
2305 @item limit
2306 Set higher black value threshold, which can be optionally specified
2307 from nothing (0) to everything (255). An intensity value greater
2308 to the set value is considered non-black. Default value is 24.
2309
2310 @item round
2311 Set the value for which the width/height should be divisible by. The
2312 offset is automatically adjusted to center the video. Use 2 to get
2313 only even dimensions (needed for 4:2:2 video). 16 is best when
2314 encoding to most video codecs. Default value is 16.
2315
2316 @item reset
2317 Set the counter that determines after how many frames cropdetect will
2318 reset the previously detected largest video area and start over to
2319 detect the current optimal crop area. Default value is 0.
2320
2321 This can be useful when channel logos distort the video area. 0
2322 indicates never reset and return the largest area encountered during
2323 playback.
2324 @end table
2325
2326 @section curves
2327
2328 Apply color adjustments using curves.
2329
2330 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
2331 component (red, green and blue) has its values defined by @var{N} key points
2332 tied from each other using a smooth curve. The x-axis represents the pixel
2333 values from the input frame, and the y-axis the new pixel values to be set for
2334 the output frame.
2335
2336 By default, a component curve is defined by the two points @var{(0;0)} and
2337 @var{(1;1)}. This creates a straight line where each original pixel value is
2338 "adjusted" to its own value, which means no change to the image.
2339
2340 The filter allows you to redefine these two points and add some more. A new
2341 curve (using a natural cubic spline interpolation) will be define to pass
2342 smoothly through all these new coordinates. The new defined points needs to be
2343 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
2344 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
2345 the vector spaces, the values will be clipped accordingly.
2346
2347 If there is no key point defined in @code{x=0}, the filter will automatically
2348 insert a @var{(0;0)} point. In the same way, if there is no key point defined
2349 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
2350
2351 The filter accepts parameters as a list of @var{key}=@var{value}
2352 pairs, separated by ":". If the key of the first options is omitted,
2353 the arguments are interpreted according to the syntax
2354 curves[=@var{preset}].
2355
2356 A description of the accepted parameters follows.
2357
2358 @table @option
2359 @item red, r
2360 Set the key points for the red component.
2361 @item green, g
2362 Set the key points for the green component.
2363 @item blue, b
2364 Set the key points for the blue component.
2365 @item preset
2366 Select one of the available color presets. This option can not be used in
2367 addition to the @option{r}, @option{g}, @option{b} parameters.
2368 Available presets are:
2369 @table @samp
2370 @item color_negative
2371 @item cross_process
2372 @item darker
2373 @item increase_contrast
2374 @item lighter
2375 @item linear_contrast
2376 @item medium_contrast
2377 @item negative
2378 @item strong_contrast
2379 @item vintage
2380 @end table
2381 Default is unset.
2382 @end table
2383
2384 To avoid some filtergraph syntax conflicts, each key points list need to be
2385 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
2386
2387 @subsection Examples
2388
2389 @itemize
2390 @item
2391 Increase slightly the middle level of blue:
2392 @example
2393 curves=blue='0.5/0.58'
2394 @end example
2395
2396 @item
2397 Vintage effect:
2398 @example
2399 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
2400 @end example
2401 Here we obtain the following coordinates for each components:
2402 @table @var
2403 @item red
2404 @code{(0;0.11) (0.42;0.51) (1;0.95)}
2405 @item green
2406 @code{(0;0) (0.50;0.48) (1;1)}
2407 @item blue
2408 @code{(0;0.22) (0.49;0.44) (1;0.80)}
2409 @end table
2410
2411 @item
2412 The previous example can also be achieved with the associated built-in preset:
2413 @example
2414 curves=preset=vintage
2415 @end example
2416
2417 @item
2418 Or simply:
2419 @example
2420 curves=vintage
2421 @end example
2422 @end itemize
2423
2424 @section decimate
2425
2426 Drop frames that do not differ greatly from the previous frame in
2427 order to reduce frame rate.
2428
2429 The main use of this filter is for very-low-bitrate encoding
2430 (e.g. streaming over dialup modem), but it could in theory be used for
2431 fixing movies that were inverse-telecined incorrectly.
2432
2433 The filter accepts parameters as a list of @var{key}=@var{value}
2434 pairs, separated by ":". If the key of the first options is omitted,
2435 the arguments are interpreted according to the syntax:
2436 @option{max}:@option{hi}:@option{lo}:@option{frac}.
2437
2438 A description of the accepted options follows.
2439
2440 @table @option
2441 @item max
2442 Set the maximum number of consecutive frames which can be dropped (if
2443 positive), or the minimum interval between dropped frames (if
2444 negative). If the value is 0, the frame is dropped unregarding the
2445 number of previous sequentially dropped frames.
2446
2447 Default value is 0.
2448
2449 @item hi
2450 @item lo
2451 @item frac
2452 Set the dropping threshold values.
2453
2454 Values for @option{hi} and @option{lo} are for 8x8 pixel blocks and
2455 represent actual pixel value differences, so a threshold of 64
2456 corresponds to 1 unit of difference for each pixel, or the same spread
2457 out differently over the block.
2458
2459 A frame is a candidate for dropping if no 8x8 blocks differ by more
2460 than a threshold of @option{hi}, and if no more than @option{frac} blocks (1
2461 meaning the whole image) differ by more than a threshold of @option{lo}.
2462
2463 Default value for @option{hi} is 64*12, default value for @option{lo} is
2464 64*5, and default value for @option{frac} is 0.33.
2465 @end table
2466
2467 @section delogo
2468
2469 Suppress a TV station logo by a simple interpolation of the surrounding
2470 pixels. Just set a rectangle covering the logo and watch it disappear
2471 (and sometimes something even uglier appear - your mileage may vary).
2472
2473 The filter accepts parameters as a string of the form
2474 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
2475 @var{key}=@var{value} pairs, separated by ":".
2476
2477 The description of the accepted parameters follows.
2478
2479 @table @option
2480
2481 @item x, y
2482 Specify the top left corner coordinates of the logo. They must be
2483 specified.
2484
2485 @item w, h
2486 Specify the width and height of the logo to clear. They must be
2487 specified.
2488
2489 @item band, t
2490 Specify the thickness of the fuzzy edge of the rectangle (added to
2491 @var{w} and @var{h}). The default value is 4.
2492
2493 @item show
2494 When set to 1, a green rectangle is drawn on the screen to simplify
2495 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
2496 @var{band} is set to 4. The default value is 0.
2497
2498 @end table
2499
2500 @subsection Examples
2501
2502 @itemize
2503 @item
2504 Set a rectangle covering the area with top left corner coordinates 0,0
2505 and size 100x77, setting a band of size 10:
2506 @example
2507 delogo=0:0:100:77:10
2508 @end example
2509
2510 @item
2511 As the previous example, but use named options:
2512 @example
2513 delogo=x=0:y=0:w=100:h=77:band=10
2514 @end example
2515
2516 @end itemize
2517
2518 @section deshake
2519
2520 Attempt to fix small changes in horizontal and/or vertical shift. This
2521 filter helps remove camera shake from hand-holding a camera, bumping a
2522 tripod, moving on a vehicle, etc.
2523
2524 The filter accepts parameters as a list of @var{key}=@var{value}
2525 pairs, separated by ":". If the key of the first options is omitted,
2526 the arguments are interpreted according to the syntax
2527 @var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}:@var{opencl}.
2528
2529 A description of the accepted parameters follows.
2530
2531 @table @option
2532
2533 @item x, y, w, h
2534 Specify a rectangular area where to limit the search for motion
2535 vectors.
2536 If desired the search for motion vectors can be limited to a
2537 rectangular area of the frame defined by its top left corner, width
2538 and height. These parameters have the same meaning as the drawbox
2539 filter which can be used to visualise the position of the bounding
2540 box.
2541
2542 This is useful when simultaneous movement of subjects within the frame
2543 might be confused for camera motion by the motion vector search.
2544
2545 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
2546 then the full frame is used. This allows later options to be set
2547 without specifying the bounding box for the motion vector search.
2548
2549 Default - search the whole frame.
2550
2551 @item rx, ry
2552 Specify the maximum extent of movement in x and y directions in the
2553 range 0-64 pixels. Default 16.
2554
2555 @item edge
2556 Specify how to generate pixels to fill blanks at the edge of the
2557 frame. Available values are:
2558 @table @samp
2559 @item blank, 0
2560 Fill zeroes at blank locations
2561 @item original, 1
2562 Original image at blank locations
2563 @item clamp, 2
2564 Extruded edge value at blank locations
2565 @item mirror, 3
2566 Mirrored edge at blank locations
2567 @end table
2568 Default value is @samp{mirror}.
2569
2570 @item blocksize
2571 Specify the blocksize to use for motion search. Range 4-128 pixels,
2572 default 8.
2573
2574 @item contrast
2575 Specify the contrast threshold for blocks. Only blocks with more than
2576 the specified contrast (difference between darkest and lightest
2577 pixels) will be considered. Range 1-255, default 125.
2578
2579 @item search
2580 Specify the search strategy. Available values are:
2581 @table @samp
2582 @item exhaustive, 0
2583 Set exhaustive search
2584 @item less, 1
2585 Set less exhaustive search.
2586 @end table
2587 Default value is @samp{exhaustive}.
2588
2589 @item filename
2590 If set then a detailed log of the motion search is written to the
2591 specified file.
2592
2593 @item opencl
2594 If set to 1, specify using OpenCL capabilities, only available if
2595 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
2596
2597 @end table
2598
2599 @section drawbox
2600
2601 Draw a colored box on the input image.
2602
2603 The filter accepts parameters as a list of @var{key}=@var{value}
2604 pairs, separated by ":". If the key of the first options is omitted,
2605 the arguments are interpreted according to the syntax
2606 @option{x}:@option{y}:@option{width}:@option{height}:@option{color}:@option{thickness}.
2607
2608 A description of the accepted options follows.
2609
2610 @table @option
2611 @item x, y
2612 Specify the top left corner coordinates of the box. Default to 0.
2613
2614 @item width, w
2615 @item height, h
2616 Specify the width and height of the box, if 0 they are interpreted as
2617 the input width and height. Default to 0.
2618
2619 @item color, c
2620 Specify the color of the box to write, it can be the name of a color
2621 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
2622 value @code{invert} is used, the box edge color is the same as the
2623 video with inverted luma.
2624
2625 @item thickness, t
2626 Set the thickness of the box edge. Default value is @code{4}.
2627 @end table
2628
2629 @subsection Examples
2630
2631 @itemize
2632 @item
2633 Draw a black box around the edge of the input image:
2634 @example
2635 drawbox
2636 @end example
2637
2638 @item
2639 Draw a box with color red and an opacity of 50%:
2640 @example
2641 drawbox=10:20:200:60:red@@0.5
2642 @end example
2643
2644 The previous example can be specified as:
2645 @example
2646 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
2647 @end example
2648
2649 @item
2650 Fill the box with pink color:
2651 @example
2652 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
2653 @end example
2654 @end itemize
2655
2656 @anchor{drawtext}
2657 @section drawtext
2658
2659 Draw text string or text from specified file on top of video using the
2660 libfreetype library.
2661
2662 To enable compilation of this filter you need to configure FFmpeg with
2663 @code{--enable-libfreetype}.
2664
2665 @subsection Syntax
2666
2667 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
2668 separated by ":".
2669
2670 The description of the accepted parameters follows.
2671
2672 @table @option
2673
2674 @item box
2675 Used to draw a box around text using background color.
2676 Value should be either 1 (enable) or 0 (disable).
2677 The default value of @var{box} is 0.
2678
2679 @item boxcolor
2680 The color to be used for drawing box around text.
2681 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
2682 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2683 The default value of @var{boxcolor} is "white".
2684
2685 @item draw
2686 Set an expression which specifies if the text should be drawn. If the
2687 expression evaluates to 0, the text is not drawn. This is useful for
2688 specifying that the text should be drawn only when specific conditions
2689 are met.
2690
2691 Default value is "1".
2692
2693 See below for the list of accepted constants and functions.
2694
2695 @item expansion
2696 Select how the @var{text} is expanded. Can be either @code{none},
2697 @code{strftime} (deprecated) or
2698 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
2699 below for details.
2700
2701 @item fix_bounds
2702 If true, check and fix text coords to avoid clipping.
2703
2704 @item fontcolor
2705 The color to be used for drawing fonts.
2706 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
2707 (e.g. "0xff000033"), possibly followed by an alpha specifier.
2708 The default value of @var{fontcolor} is "black".
2709
2710 @item fontfile
2711 The font file to be used for drawing text. Path must be included.
2712 This parameter is mandatory.
2713
2714 @item fontsize
2715 The font size to be used for drawing text.
2716 The default value of @var{fontsize} is 16.
2717
2718 @item ft_load_flags
2719 Flags to be used for loading the fonts.
2720
2721 The flags map the corresponding flags supported by libfreetype, and are
2722 a combination of the following values:
2723 @table @var
2724 @item default
2725 @item no_scale
2726 @item no_hinting
2727 @item render
2728 @item no_bitmap
2729 @item vertical_layout
2730 @item force_autohint
2731 @item crop_bitmap
2732 @item pedantic
2733 @item ignore_global_advance_width
2734 @item no_recurse
2735 @item ignore_transform
2736 @item monochrome
2737 @item linear_design
2738 @item no_autohint
2739 @item end table
2740 @end table
2741
2742 Default value is "render".
2743
2744 For more information consult the documentation for the FT_LOAD_*
2745 libfreetype flags.
2746
2747 @item shadowcolor
2748 The color to be used for drawing a shadow behind the drawn text.  It
2749 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
2750 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2751 The default value of @var{shadowcolor} is "black".
2752
2753 @item shadowx, shadowy
2754 The x and y offsets for the text shadow position with respect to the
2755 position of the text. They can be either positive or negative
2756 values. Default value for both is "0".
2757
2758 @item tabsize
2759 The size in number of spaces to use for rendering the tab.
2760 Default value is 4.
2761
2762 @item timecode
2763 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
2764 format. It can be used with or without text parameter. @var{timecode_rate}
2765 option must be specified.
2766
2767 @item timecode_rate, rate, r
2768 Set the timecode frame rate (timecode only).
2769
2770 @item text
2771 The text string to be drawn. The text must be a sequence of UTF-8
2772 encoded characters.
2773 This parameter is mandatory if no file is specified with the parameter
2774 @var{textfile}.
2775
2776 @item textfile
2777 A text file containing text to be drawn. The text must be a sequence
2778 of UTF-8 encoded characters.
2779
2780 This parameter is mandatory if no text string is specified with the
2781 parameter @var{text}.
2782
2783 If both @var{text} and @var{textfile} are specified, an error is thrown.
2784
2785 @item reload
2786 If set to 1, the @var{textfile} will be reloaded before each frame.
2787 Be sure to update it atomically, or it may be read partially, or even fail.
2788
2789 @item x, y
2790 The expressions which specify the offsets where text will be drawn
2791 within the video frame. They are relative to the top/left border of the
2792 output image.
2793
2794 The default value of @var{x} and @var{y} is "0".
2795
2796 See below for the list of accepted constants and functions.
2797 @end table
2798
2799 The parameters for @var{x} and @var{y} are expressions containing the
2800 following constants and functions:
2801
2802 @table @option
2803 @item dar
2804 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
2805
2806 @item hsub, vsub
2807 horizontal and vertical chroma subsample values. For example for the
2808 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2809
2810 @item line_h, lh
2811 the height of each text line
2812
2813 @item main_h, h, H
2814 the input height
2815
2816 @item main_w, w, W
2817 the input width
2818
2819 @item max_glyph_a, ascent
2820 the maximum distance from the baseline to the highest/upper grid
2821 coordinate used to place a glyph outline point, for all the rendered
2822 glyphs.
2823 It is a positive value, due to the grid's orientation with the Y axis
2824 upwards.
2825
2826 @item max_glyph_d, descent
2827 the maximum distance from the baseline to the lowest grid coordinate
2828 used to place a glyph outline point, for all the rendered glyphs.
2829 This is a negative value, due to the grid's orientation, with the Y axis
2830 upwards.
2831
2832 @item max_glyph_h
2833 maximum glyph height, that is the maximum height for all the glyphs
2834 contained in the rendered text, it is equivalent to @var{ascent} -
2835 @var{descent}.
2836
2837 @item max_glyph_w
2838 maximum glyph width, that is the maximum width for all the glyphs
2839 contained in the rendered text
2840
2841 @item n
2842 the number of input frame, starting from 0
2843
2844 @item rand(min, max)
2845 return a random number included between @var{min} and @var{max}
2846
2847 @item sar
2848 input sample aspect ratio
2849
2850 @item t
2851 timestamp expressed in seconds, NAN if the input timestamp is unknown
2852
2853 @item text_h, th
2854 the height of the rendered text
2855
2856 @item text_w, tw
2857 the width of the rendered text
2858
2859 @item x, y
2860 the x and y offset coordinates where the text is drawn.
2861
2862 These parameters allow the @var{x} and @var{y} expressions to refer
2863 each other, so you can for example specify @code{y=x/dar}.
2864 @end table
2865
2866 If libavfilter was built with @code{--enable-fontconfig}, then
2867 @option{fontfile} can be a fontconfig pattern or omitted.
2868
2869 @anchor{drawtext_expansion}
2870 @subsection Text expansion
2871
2872 If @option{expansion} is set to @code{strftime},
2873 the filter recognizes strftime() sequences in the provided text and
2874 expands them accordingly. Check the documentation of strftime(). This
2875 feature is deprecated.
2876
2877 If @option{expansion} is set to @code{none}, the text is printed verbatim.
2878
2879 If @option{expansion} is set to @code{normal} (which is the default),
2880 the following expansion mechanism is used.
2881
2882 The backslash character '\', followed by any character, always expands to
2883 the second character.
2884
2885 Sequence of the form @code{%@{...@}} are expanded. The text between the
2886 braces is a function name, possibly followed by arguments separated by ':'.
2887 If the arguments contain special characters or delimiters (':' or '@}'),
2888 they should be escaped.
2889
2890 Note that they probably must also be escaped as the value for the
2891 @option{text} option in the filter argument string and as the filter
2892 argument in the filtergraph description, and possibly also for the shell,
2893 that makes up to four levels of escaping; using a text file avoids these
2894 problems.
2895
2896 The following functions are available:
2897
2898 @table @command
2899
2900 @item expr, e
2901 The expression evaluation result.
2902
2903 It must take one argument specifying the expression to be evaluated,
2904 which accepts the same constants and functions as the @var{x} and
2905 @var{y} values. Note that not all constants should be used, for
2906 example the text size is not known when evaluating the expression, so
2907 the constants @var{text_w} and @var{text_h} will have an undefined
2908 value.
2909
2910 @item gmtime
2911 The time at which the filter is running, expressed in UTC.
2912 It can accept an argument: a strftime() format string.
2913
2914 @item localtime
2915 The time at which the filter is running, expressed in the local time zone.
2916 It can accept an argument: a strftime() format string.
2917
2918 @item n, frame_num
2919 The frame number, starting from 0.
2920
2921 @item pts
2922 The timestamp of the current frame, in seconds, with microsecond accuracy.
2923
2924 @end table
2925
2926 @subsection Examples
2927
2928 @itemize
2929 @item
2930 Draw "Test Text" with font FreeSerif, using the default values for the
2931 optional parameters.
2932
2933 @example
2934 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
2935 @end example
2936
2937 @item
2938 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
2939 and y=50 (counting from the top-left corner of the screen), text is
2940 yellow with a red box around it. Both the text and the box have an
2941 opacity of 20%.
2942
2943 @example
2944 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
2945           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
2946 @end example
2947
2948 Note that the double quotes are not necessary if spaces are not used
2949 within the parameter list.
2950
2951 @item
2952 Show the text at the center of the video frame:
2953 @example
2954 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
2955 @end example
2956
2957 @item
2958 Show a text line sliding from right to left in the last row of the video
2959 frame. The file @file{LONG_LINE} is assumed to contain a single line
2960 with no newlines.
2961 @example
2962 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
2963 @end example
2964
2965 @item
2966 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
2967 @example
2968 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
2969 @end example
2970
2971 @item
2972 Draw a single green letter "g", at the center of the input video.
2973 The glyph baseline is placed at half screen height.
2974 @example
2975 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
2976 @end example
2977
2978 @item
2979 Show text for 1 second every 3 seconds:
2980 @example
2981 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
2982 @end example
2983
2984 @item
2985 Use fontconfig to set the font. Note that the colons need to be escaped.
2986 @example
2987 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
2988 @end example
2989
2990 @item
2991 Print the date of a real-time encoding (see strftime(3)):
2992 @example
2993 drawtext='fontfile=FreeSans.ttf:text=%@{localtime:%a %b %d %Y@}'
2994 @end example
2995
2996 @end itemize
2997
2998 For more information about libfreetype, check:
2999 @url{http://www.freetype.org/}.
3000
3001 For more information about fontconfig, check:
3002 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
3003
3004 @section edgedetect
3005
3006 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
3007
3008 This filter accepts the following optional named parameters:
3009
3010 @table @option
3011 @item low, high
3012 Set low and high threshold values used by the Canny thresholding
3013 algorithm.
3014
3015 The high threshold selects the "strong" edge pixels, which are then
3016 connected through 8-connectivity with the "weak" edge pixels selected
3017 by the low threshold.
3018
3019 @var{low} and @var{high} threshold values must be choosen in the range
3020 [0,1], and @var{low} should be lesser or equal to @var{high}.
3021
3022 Default value for @var{low} is @code{20/255}, and default value for @var{high}
3023 is @code{50/255}.
3024 @end table
3025
3026 Example:
3027 @example
3028 edgedetect=low=0.1:high=0.4
3029 @end example
3030
3031 @section fade
3032
3033 Apply fade-in/out effect to input video.
3034
3035 The filter accepts parameters as a list of @var{key}=@var{value}
3036 pairs, separated by ":". If the key of the first options is omitted,
3037 the arguments are interpreted according to the syntax
3038 @var{type}:@var{start_frame}:@var{nb_frames}.
3039
3040 A description of the accepted parameters follows.
3041
3042 @table @option
3043 @item type, t
3044 Specify if the effect type, can be either @code{in} for fade-in, or
3045 @code{out} for a fade-out effect. Default is @code{in}.
3046
3047 @item start_frame, s
3048 Specify the number of the start frame for starting to apply the fade
3049 effect. Default is 0.
3050
3051 @item nb_frames, n
3052 Specify the number of frames for which the fade effect has to last. At
3053 the end of the fade-in effect the output video will have the same
3054 intensity as the input video, at the end of the fade-out transition
3055 the output video will be completely black. Default is 25.
3056
3057 @item alpha
3058 If set to 1, fade only alpha channel, if one exists on the input.
3059 Default value is 0.
3060 @end table
3061
3062 @subsection Examples
3063
3064 @itemize
3065 @item
3066 Fade in first 30 frames of video:
3067 @example
3068 fade=in:0:30
3069 @end example
3070
3071 The command above is equivalent to:
3072 @example
3073 fade=t=in:s=0:n=30
3074 @end example
3075
3076 @item
3077 Fade out last 45 frames of a 200-frame video:
3078 @example
3079 fade=out:155:45
3080 @end example
3081
3082 @item
3083 Fade in first 25 frames and fade out last 25 frames of a 1000-frame video:
3084 @example
3085 fade=in:0:25, fade=out:975:25
3086 @end example
3087
3088 @item
3089 Make first 5 frames black, then fade in from frame 5-24:
3090 @example
3091 fade=in:5:20
3092 @end example
3093
3094 @item
3095 Fade in alpha over first 25 frames of video:
3096 @example
3097 fade=in:0:25:alpha=1
3098 @end example
3099 @end itemize
3100
3101 @section field
3102
3103 Extract a single field from an interlaced image using stride
3104 arithmetic to avoid wasting CPU time. The output frames are marked as
3105 non-interlaced.
3106
3107 This filter accepts the following named options:
3108 @table @option
3109 @item type
3110 Specify whether to extract the top (if the value is @code{0} or
3111 @code{top}) or the bottom field (if the value is @code{1} or
3112 @code{bottom}).
3113 @end table
3114
3115 If the option key is not specified, the first value sets the @var{type}
3116 option. For example:
3117 @example
3118 field=bottom
3119 @end example
3120
3121 is equivalent to:
3122 @example
3123 field=type=bottom
3124 @end example
3125
3126 @section fieldorder
3127
3128 Transform the field order of the input video.
3129
3130 This filter accepts the named option @option{order} which
3131 specifies the required field order that the input interlaced video
3132 will be transformed to. The option name can be omitted.
3133
3134 The option @option{order} can assume one of the following values:
3135 @table @samp
3136 @item bff
3137 output bottom field first
3138 @item tff
3139 output top field first
3140 @end table
3141
3142 Default value is @samp{tff}.
3143
3144 Transformation is achieved by shifting the picture content up or down
3145 by one line, and filling the remaining line with appropriate picture content.
3146 This method is consistent with most broadcast field order converters.
3147
3148 If the input video is not flagged as being interlaced, or it is already
3149 flagged as being of the required output field order then this filter does
3150 not alter the incoming video.
3151
3152 This filter is very useful when converting to or from PAL DV material,
3153 which is bottom field first.
3154
3155 For example:
3156 @example
3157 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
3158 @end example
3159
3160 @section fifo
3161
3162 Buffer input images and send them when they are requested.
3163
3164 This filter is mainly useful when auto-inserted by the libavfilter
3165 framework.
3166
3167 The filter does not take parameters.
3168
3169 @anchor{format}
3170 @section format
3171
3172 Convert the input video to one of the specified pixel formats.
3173 Libavfilter will try to pick one that is supported for the input to
3174 the next filter.
3175
3176 The filter accepts a list of pixel format names, separated by ":",
3177 for example "yuv420p:monow:rgb24".
3178
3179 @subsection Examples
3180
3181 @itemize
3182 @item
3183 Convert the input video to the format @var{yuv420p}
3184 @example
3185 format=yuv420p
3186 @end example
3187
3188 Convert the input video to any of the formats in the list
3189 @example
3190 format=yuv420p:yuv444p:yuv410p
3191 @end example
3192 @end itemize
3193
3194 @section fps
3195
3196 Convert the video to specified constant frame rate by duplicating or dropping
3197 frames as necessary.
3198
3199 This filter accepts the following named parameters:
3200 @table @option
3201
3202 @item fps
3203 Desired output frame rate. The default is @code{25}.
3204
3205 @item round
3206 Rounding method.
3207
3208 Possible values are:
3209 @table @option
3210 @item zero
3211 zero round towards 0
3212 @item inf
3213 round away from 0
3214 @item down
3215 round towards -infinity
3216 @item up
3217 round towards +infinity
3218 @item near
3219 round to nearest
3220 @end table
3221 The default is @code{near}.
3222
3223 @end table
3224
3225 Alternatively, the options can be specified as a flat string:
3226 @var{fps}[:@var{round}].
3227
3228 See also the @ref{setpts} filter.
3229
3230 @section framestep
3231
3232 Select one frame every N.
3233
3234 This filter accepts in input a string representing a positive
3235 integer. Default argument is @code{1}.
3236
3237 @anchor{frei0r}
3238 @section frei0r
3239
3240 Apply a frei0r effect to the input video.
3241
3242 To enable compilation of this filter you need to install the frei0r
3243 header and configure FFmpeg with @code{--enable-frei0r}.
3244
3245 The filter supports the syntax:
3246 @example
3247 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
3248 @end example
3249
3250 @var{filter_name} is the name of the frei0r effect to load. If the
3251 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
3252 is searched in each one of the directories specified by the colon (or
3253 semicolon on Windows platforms) separated list in @env{FREIOR_PATH},
3254 otherwise in the standard frei0r paths, which are in this order:
3255 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
3256 @file{/usr/lib/frei0r-1/}.
3257
3258 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
3259 for the frei0r effect.
3260
3261 A frei0r effect parameter can be a boolean (whose values are specified
3262 with "y" and "n"), a double, a color (specified by the syntax
3263 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
3264 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
3265 description), a position (specified by the syntax @var{X}/@var{Y},
3266 @var{X} and @var{Y} being float numbers) and a string.
3267
3268 The number and kind of parameters depend on the loaded effect. If an
3269 effect parameter is not specified the default value is set.
3270
3271 @subsection Examples
3272
3273 @itemize
3274 @item
3275 Apply the distort0r effect, set the first two double parameters:
3276 @example
3277 frei0r=distort0r:0.5:0.01
3278 @end example
3279
3280 @item
3281 Apply the colordistance effect, take a color as first parameter:
3282 @example
3283 frei0r=colordistance:0.2/0.3/0.4
3284 frei0r=colordistance:violet
3285 frei0r=colordistance:0x112233
3286 @end example
3287
3288 @item
3289 Apply the perspective effect, specify the top left and top right image
3290 positions:
3291 @example
3292 frei0r=perspective:0.2/0.2:0.8/0.2
3293 @end example
3294 @end itemize
3295
3296 For more information see:
3297 @url{http://frei0r.dyne.org}
3298
3299 @section geq
3300
3301 The filter takes one, two, three or four equations as parameter, separated by ':'.
3302 The first equation is mandatory and applies to the luma plane. The two
3303 following are respectively for chroma blue and chroma red planes.
3304
3305 The filter syntax allows named parameters:
3306
3307 @table @option
3308 @item lum_expr
3309 the luminance expression
3310 @item cb_expr
3311 the chrominance blue expression
3312 @item cr_expr
3313 the chrominance red expression
3314 @item alpha_expr
3315 the alpha expression
3316 @end table
3317
3318 If one of the chrominance expression is not defined, it falls back on the other
3319 one. If no alpha expression is specified it will evaluate to opaque value.
3320 If none of chrominance expressions are
3321 specified, they will evaluate the luminance expression.
3322
3323 The expressions can use the following variables and functions:
3324
3325 @table @option
3326 @item N
3327 The sequential number of the filtered frame, starting from @code{0}.
3328
3329 @item X
3330 @item Y
3331 The coordinates of the current sample.
3332
3333 @item W
3334 @item H
3335 The width and height of the image.
3336
3337 @item SW
3338 @item SH
3339 Width and height scale depending on the currently filtered plane. It is the
3340 ratio between the corresponding luma plane number of pixels and the current
3341 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
3342 @code{0.5,0.5} for chroma planes.
3343
3344 @item T
3345 Time of the current frame, expressed in seconds.
3346
3347 @item p(x, y)
3348 Return the value of the pixel at location (@var{x},@var{y}) of the current
3349 plane.
3350
3351 @item lum(x, y)
3352 Return the value of the pixel at location (@var{x},@var{y}) of the luminance
3353 plane.
3354
3355 @item cb(x, y)
3356 Return the value of the pixel at location (@var{x},@var{y}) of the
3357 blue-difference chroma plane. Returns 0 if there is no such plane.
3358
3359 @item cr(x, y)
3360 Return the value of the pixel at location (@var{x},@var{y}) of the
3361 red-difference chroma plane. Returns 0 if there is no such plane.
3362
3363 @item alpha(x, y)
3364 Return the value of the pixel at location (@var{x},@var{y}) of the alpha
3365 plane. Returns 0 if there is no such plane.
3366 @end table
3367
3368 For functions, if @var{x} and @var{y} are outside the area, the value will be
3369 automatically clipped to the closer edge.
3370
3371 @subsection Examples
3372
3373 @itemize
3374 @item
3375 Flip the image horizontally:
3376 @example
3377 geq=p(W-X\,Y)
3378 @end example
3379
3380 @item
3381 Generate a bidimensional sine wave, with angle @code{PI/3} and a
3382 wavelength of 100 pixels:
3383 @example
3384 geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
3385 @end example
3386
3387 @item
3388 Generate a fancy enigmatic moving light:
3389 @example
3390 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
3391 @end example
3392 @end itemize
3393
3394 @section gradfun
3395
3396 Fix the banding artifacts that are sometimes introduced into nearly flat
3397 regions by truncation to 8bit color depth.
3398 Interpolate the gradients that should go where the bands are, and
3399 dither them.
3400
3401 This filter is designed for playback only.  Do not use it prior to
3402 lossy compression, because compression tends to lose the dither and
3403 bring back the bands.
3404
3405 The filter accepts a list of options in the form of @var{key}=@var{value} pairs
3406 separated by ":". A description of the accepted options follows.
3407
3408 @table @option
3409
3410 @item strength
3411 The maximum amount by which the filter will change
3412 any one pixel. Also the threshold for detecting nearly flat
3413 regions. Acceptable values range from @code{0.51} to @code{64}, default value
3414 is @code{1.2}.
3415
3416 @item radius
3417 The neighborhood to fit the gradient to. A larger
3418 radius makes for smoother gradients, but also prevents the filter from
3419 modifying the pixels near detailed regions. Acceptable values are
3420 @code{8-32}, default value is @code{16}.
3421
3422 @end table
3423
3424 Alternatively, the options can be specified as a flat string:
3425 @var{strength}[:@var{radius}]
3426
3427 @subsection Examples
3428
3429 @itemize
3430 @item
3431 Apply the filter with a @code{3.5} strength and radius of @code{8}:
3432 @example
3433 gradfun=3.5:8
3434 @end example
3435
3436 @item
3437 Specify radius, omitting the strength (which will fall-back to the default
3438 value):
3439 @example
3440 gradfun=radius=8
3441 @end example
3442
3443 @end itemize
3444
3445 @section hflip
3446
3447 Flip the input video horizontally.
3448
3449 For example to horizontally flip the input video with @command{ffmpeg}:
3450 @example
3451 ffmpeg -i in.avi -vf "hflip" out.avi
3452 @end example
3453
3454 @section histeq
3455 This filter applies a global color histogram equalization on a
3456 per-frame basis.
3457
3458 It can be used to correct video that has a compressed range of pixel
3459 intensities.  The filter redistributes the pixel intensities to
3460 equalize their distribution across the intensity range. It may be
3461 viewed as an "automatically adjusting contrast filter". This filter is
3462 useful only for correcting degraded or poorly captured source
3463 video.
3464
3465 The filter accepts parameters as a list of @var{key}=@var{value}
3466 pairs, separated by ":". If the key of the first options is omitted,
3467 the arguments are interpreted according to syntax
3468 @var{strength}:@var{intensity}:@var{antibanding}.
3469
3470 This filter accepts the following named options:
3471
3472 @table @option
3473 @item strength
3474 Determine the amount of equalization to be applied.  As the strength
3475 is reduced, the distribution of pixel intensities more-and-more
3476 approaches that of the input frame. The value must be a float number
3477 in the range [0,1] and defaults to 0.200.
3478
3479 @item intensity
3480 Set the maximum intensity that can generated and scale the output
3481 values appropriately.  The strength should be set as desired and then
3482 the intensity can be limited if needed to avoid washing-out. The value
3483 must be a float number in the range [0,1] and defaults to 0.210.
3484
3485 @item antibanding
3486 Set the antibanding level. If enabled the filter will randomly vary
3487 the luminance of output pixels by a small amount to avoid banding of
3488 the histogram. Possible values are @code{none}, @code{weak} or
3489 @code{strong}. It defaults to @code{none}.
3490 @end table
3491
3492 @section histogram
3493
3494 Compute and draw a color distribution histogram for the input video.
3495
3496 The computed histogram is a representation of distribution of color components
3497 in an image.
3498
3499 The filter accepts the following named parameters:
3500
3501 @table @option
3502 @item mode
3503 Set histogram mode.
3504
3505 It accepts the following values:
3506 @table @samp
3507 @item levels
3508 standard histogram that display color components distribution in an image.
3509 Displays color graph for each color component. Shows distribution
3510 of the Y, U, V, A or G, B, R components, depending on input format,
3511 in current frame. Bellow each graph is color component scale meter.
3512
3513 @item color
3514 chroma values in vectorscope, if brighter more such chroma values are
3515 distributed in an image.
3516 Displays chroma values (U/V color placement) in two dimensional graph
3517 (which is called a vectorscope). It can be used to read of the hue and
3518 saturation of the current frame. At a same time it is a histogram.
3519 The whiter a pixel in the vectorscope, the more pixels of the input frame
3520 correspond to that pixel (that is the more pixels have this chroma value).
3521 The V component is displayed on the horizontal (X) axis, with the leftmost
3522 side being V = 0 and the rightmost side being V = 255.
3523 The U component is displayed on the vertical (Y) axis, with the top
3524 representing U = 0 and the bottom representing U = 255.
3525
3526 The position of a white pixel in the graph corresponds to the chroma value
3527 of a pixel of the input clip. So the graph can be used to read of the
3528 hue (color flavor) and the saturation (the dominance of the hue in the color).
3529 As the hue of a color changes, it moves around the square. At the center of
3530 the square, the saturation is zero, which means that the corresponding pixel
3531 has no color. If you increase the amount of a specific color, while leaving
3532 the other colors unchanged, the saturation increases, and you move towards
3533 the edge of the square.
3534
3535 @item color2
3536 chroma values in vectorscope, similar as @code{color} but actual chroma values
3537 are displayed.
3538
3539 @item waveform
3540 per row/column color component graph. In row mode graph in the left side represents
3541 color component value 0 and right side represents value = 255. In column mode top
3542 side represents color component value = 0 and bottom side represents value = 255.
3543 @end table
3544 Default value is @code{levels}.
3545
3546 @item level_height
3547 Set height of level in @code{levels}. Default value is @code{200}.
3548 Allowed range is [50, 2048].
3549
3550 @item scale_height
3551 Set height of color scale in @code{levels}. Default value is @code{12}.
3552 Allowed range is [0, 40].
3553
3554 @item step
3555 Set step for @code{waveform} mode. Smaller values are useful to find out how much
3556 of same luminance values across input rows/columns are distributed.
3557 Default value is @code{10}. Allowed range is [1, 255].
3558
3559 @item waveform_mode
3560 Set mode for @code{waveform}. Can be either @code{row}, or @code{column}.
3561 Default is @code{row}.
3562
3563 @item display_mode
3564 Set display mode for @code{waveform} and @code{levels}.
3565 It accepts the following values:
3566 @table @samp
3567 @item parade
3568 Display separate graph for the color components side by side in
3569 @code{row} waveform mode or one below other in @code{column} waveform mode
3570 for @code{waveform} histogram mode. For @code{levels} histogram mode
3571 per color component graphs are placed one bellow other.
3572
3573 This display mode in @code{waveform} histogram mode makes it easy to spot
3574 color casts in the highlights and shadows of an image, by comparing the
3575 contours of the top and the bottom of each waveform.
3576 Since whites, grays, and blacks are characterized by
3577 exactly equal amounts of red, green, and blue, neutral areas of the
3578 picture should display three waveforms of roughly equal width/height.
3579 If not, the correction is easy to make by making adjustments to level the
3580 three waveforms.
3581
3582 @item overlay
3583 Presents information that's identical to that in the @code{parade}, except
3584 that the graphs representing color components are superimposed directly
3585 over one another.
3586
3587 This display mode in @code{waveform} histogram mode can make it easier to spot
3588 the relative differences or similarities in overlapping areas of the color
3589 components that are supposed to be identical, such as neutral whites, grays,
3590 or blacks.
3591 @end table
3592 Default is @code{parade}.
3593 @end table
3594
3595 @subsection Examples
3596
3597 @itemize
3598
3599 @item
3600 Calculate and draw histogram:
3601 @example
3602 ffplay -i input -vf histogram
3603 @end example
3604
3605 @end itemize
3606
3607 @section hqdn3d
3608
3609 High precision/quality 3d denoise filter. This filter aims to reduce
3610 image noise producing smooth images and making still images really
3611 still. It should enhance compressibility.
3612
3613 It accepts the following optional parameters:
3614 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
3615
3616 @table @option
3617 @item luma_spatial
3618 a non-negative float number which specifies spatial luma strength,
3619 defaults to 4.0
3620
3621 @item chroma_spatial
3622 a non-negative float number which specifies spatial chroma strength,
3623 defaults to 3.0*@var{luma_spatial}/4.0
3624
3625 @item luma_tmp
3626 a float number which specifies luma temporal strength, defaults to
3627 6.0*@var{luma_spatial}/4.0
3628
3629 @item chroma_tmp
3630 a float number which specifies chroma temporal strength, defaults to
3631 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
3632 @end table
3633
3634 @section hue
3635
3636 Modify the hue and/or the saturation of the input.
3637
3638 This filter accepts the following optional named options:
3639
3640 @table @option
3641 @item h
3642 Specify the hue angle as a number of degrees. It accepts a float
3643 number or an expression, and defaults to 0.0.
3644
3645 @item H
3646 Specify the hue angle as a number of radians. It accepts a float
3647 number or an expression, and defaults to 0.0.
3648
3649 @item s
3650 Specify the saturation in the [-10,10] range. It accepts a float number and
3651 defaults to 1.0.
3652 @end table
3653
3654 The @var{h}, @var{H} and @var{s} parameters are expressions containing the
3655 following constants:
3656
3657 @table @option
3658 @item n
3659 frame count of the input frame starting from 0
3660
3661 @item pts
3662 presentation timestamp of the input frame expressed in time base units
3663
3664 @item r
3665 frame rate of the input video, NAN if the input frame rate is unknown
3666
3667 @item t
3668 timestamp expressed in seconds, NAN if the input timestamp is unknown
3669
3670 @item tb
3671 time base of the input video
3672 @end table
3673
3674 The options can also be set using the syntax: @var{hue}:@var{saturation}
3675
3676 In this case @var{hue} is expressed in degrees.
3677
3678 @subsection Examples
3679
3680 @itemize
3681 @item
3682 Set the hue to 90 degrees and the saturation to 1.0:
3683 @example
3684 hue=h=90:s=1
3685 @end example
3686
3687 @item
3688 Same command but expressing the hue in radians:
3689 @example
3690 hue=H=PI/2:s=1
3691 @end example
3692
3693 @item
3694 Same command without named options, hue must be expressed in degrees:
3695 @example
3696 hue=90:1
3697 @end example
3698
3699 @item
3700 Note that "h:s" syntax does not support expressions for the values of
3701 h and s, so the following example will issue an error:
3702 @example
3703 hue=PI/2:1
3704 @end example
3705
3706 @item
3707 Rotate hue and make the saturation swing between 0
3708 and 2 over a period of 1 second:
3709 @example
3710 hue="H=2*PI*t: s=sin(2*PI*t)+1"
3711 @end example
3712
3713 @item
3714 Apply a 3 seconds saturation fade-in effect starting at 0:
3715 @example
3716 hue="s=min(t/3\,1)"
3717 @end example
3718
3719 The general fade-in expression can be written as:
3720 @example
3721 hue="s=min(0\, max((t-START)/DURATION\, 1))"
3722 @end example
3723
3724 @item
3725 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
3726 @example
3727 hue="s=max(0\, min(1\, (8-t)/3))"
3728 @end example
3729
3730 The general fade-out expression can be written as:
3731 @example
3732 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
3733 @end example
3734
3735 @end itemize
3736
3737 @subsection Commands
3738
3739 This filter supports the following command:
3740 @table @option
3741 @item reinit
3742 Modify the hue and/or the saturation of the input video.
3743 The command accepts the same named options and syntax than when calling the
3744 filter from the command-line.
3745
3746 If a parameter is omitted, it is kept at its current value.
3747 @end table
3748
3749 @section idet
3750
3751 Detect video interlacing type.
3752
3753 This filter tries to detect if the input is interlaced or progressive,
3754 top or bottom field first.
3755
3756 @section il
3757
3758 Deinterleave or interleave fields.
3759
3760 This filter allows to process interlaced images fields without
3761 deinterlacing them. Deinterleaving splits the input frame into 2
3762 fields (so called half pictures). Odd lines are moved to the top
3763 half of the output image, even lines to the bottom half.
3764 You can process (filter) them independently and then re-interleave them.
3765
3766 It accepts a list of options in the form of @var{key}=@var{value} pairs
3767 separated by ":". A description of the accepted options follows.
3768
3769 @table @option
3770 @item luma_mode, l
3771 @item chroma_mode, s
3772 @item alpha_mode, a
3773 Available values for @var{luma_mode}, @var{chroma_mode} and
3774 @var{alpha_mode} are:
3775
3776 @table @samp
3777 @item none
3778 Do nothing.
3779
3780 @item deinterleave, d
3781 Deinterleave fields, placing one above the other.
3782
3783 @item interleave, i
3784 Interleave fields. Reverse the effect of deinterleaving.
3785 @end table
3786 Default value is @code{none}.
3787
3788 @item luma_swap, ls
3789 @item chroma_swap, cs
3790 @item alpha_swap, as
3791 Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is @code{0}.
3792 @end table
3793
3794 @section kerndeint
3795
3796 Deinterlace input video by applying Donald Graft's adaptive kernel
3797 deinterling. Work on interlaced parts of a video to produce
3798 progressive frames.
3799
3800 This filter accepts parameters as a list of @var{key}=@var{value}
3801 pairs, separated by ":". If the key of the first options is omitted,
3802 the arguments are interpreted according to the following syntax:
3803 @var{thresh}:@var{map}:@var{order}:@var{sharp}:@var{twoway}.
3804
3805 The description of the accepted parameters follows.
3806
3807 @table @option
3808 @item thresh
3809 Set the threshold which affects the filter's tolerance when
3810 determining if a pixel line must be processed. It must be an integer
3811 in the range [0,255] and defaults to 10. A value of 0 will result in
3812 applying the process on every pixels.
3813
3814 @item map
3815 Paint pixels exceeding the threshold value to white if set to 1.
3816 Default is 0.
3817
3818 @item order
3819 Set the fields order. Swap fields if set to 1, leave fields alone if
3820 0. Default is 0.
3821
3822 @item sharp
3823 Enable additional sharpening if set to 1. Default is 0.
3824
3825 @item twoway
3826 Enable twoway sharpening if set to 1. Default is 0.
3827 @end table
3828
3829 @subsection Examples
3830
3831 @itemize
3832 @item
3833 Apply default values:
3834 @example
3835 kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
3836 @end example
3837
3838 @item
3839 Enable additional sharpening:
3840 @example
3841 kerndeint=sharp=1
3842 @end example
3843
3844 @item
3845 Paint processed pixels in white:
3846 @example
3847 kerndeint=map=1
3848 @end example
3849 @end itemize
3850
3851 @section lut, lutrgb, lutyuv
3852
3853 Compute a look-up table for binding each pixel component input value
3854 to an output value, and apply it to input video.
3855
3856 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
3857 to an RGB input video.
3858
3859 These filters accept in input a ":"-separated list of options, which
3860 specify the expressions used for computing the lookup table for the
3861 corresponding pixel component values.
3862
3863 The @var{lut} filter requires either YUV or RGB pixel formats in
3864 input, and accepts the options:
3865 @table @option
3866 @item c0
3867 set first pixel component expression
3868 @item c1
3869 set second pixel component expression
3870 @item c2
3871 set third pixel component expression
3872 @item c3
3873 set fourth pixel component expression, corresponds to the alpha component
3874 @end table
3875
3876 The exact component associated to each option depends on the format in
3877 input.
3878
3879 The @var{lutrgb} filter requires RGB pixel formats in input, and
3880 accepts the options:
3881 @table @option
3882 @item r
3883 set red component expression
3884 @item g
3885 set green component expression
3886 @item b
3887 set blue component expression
3888 @item a
3889 alpha component expression
3890 @end table
3891
3892 The @var{lutyuv} filter requires YUV pixel formats in input, and
3893 accepts the options:
3894 @table @option
3895 @item y
3896 set Y/luminance component expression
3897 @item u
3898 set U/Cb component expression
3899 @item v
3900 set V/Cr component expression
3901 @item a
3902 set alpha component expression
3903 @end table
3904
3905 The expressions can contain the following constants and functions:
3906
3907 @table @option
3908 @item w, h
3909 the input width and height
3910
3911 @item val
3912 input value for the pixel component
3913
3914 @item clipval
3915 the input value clipped in the @var{minval}-@var{maxval} range
3916
3917 @item maxval
3918 maximum value for the pixel component
3919
3920 @item minval
3921 minimum value for the pixel component
3922
3923 @item negval
3924 the negated value for the pixel component value clipped in the
3925 @var{minval}-@var{maxval} range , it corresponds to the expression
3926 "maxval-clipval+minval"
3927
3928 @item clip(val)
3929 the computed value in @var{val} clipped in the
3930 @var{minval}-@var{maxval} range
3931
3932 @item gammaval(gamma)
3933 the computed gamma correction value of the pixel component value
3934 clipped in the @var{minval}-@var{maxval} range, corresponds to the
3935 expression
3936 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
3937
3938 @end table
3939
3940 All expressions default to "val".
3941
3942 @subsection Examples
3943
3944 @itemize
3945 @item
3946 Negate input video:
3947 @example
3948 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
3949 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
3950 @end example
3951
3952 The above is the same as:
3953 @example
3954 lutrgb="r=negval:g=negval:b=negval"
3955 lutyuv="y=negval:u=negval:v=negval"
3956 @end example
3957
3958 @item
3959 Negate luminance:
3960 @example
3961 lutyuv=y=negval
3962 @end example
3963
3964 @item
3965 Remove chroma components, turns the video into a graytone image:
3966 @example
3967 lutyuv="u=128:v=128"
3968 @end example
3969
3970 @item
3971 Apply a luma burning effect:
3972 @example
3973 lutyuv="y=2*val"
3974 @end example
3975
3976 @item
3977 Remove green and blue components:
3978 @example
3979 lutrgb="g=0:b=0"
3980 @end example
3981
3982 @item
3983 Set a constant alpha channel value on input:
3984 @example
3985 format=rgba,lutrgb=a="maxval-minval/2"
3986 @end example
3987
3988 @item
3989 Correct luminance gamma by a 0.5 factor:
3990 @example
3991 lutyuv=y=gammaval(0.5)
3992 @end example
3993
3994 @item
3995 Discard least significant bits of luma:
3996 @example
3997 lutyuv=y='bitand(val, 128+64+32)'
3998 @end example
3999 @end itemize
4000
4001 @section mp
4002
4003 Apply an MPlayer filter to the input video.
4004
4005 This filter provides a wrapper around most of the filters of
4006 MPlayer/MEncoder.
4007
4008 This wrapper is considered experimental. Some of the wrapped filters
4009 may not work properly and we may drop support for them, as they will
4010 be implemented natively into FFmpeg. Thus you should avoid
4011 depending on them when writing portable scripts.
4012
4013 The filters accepts the parameters:
4014 @var{filter_name}[:=]@var{filter_params}
4015
4016 @var{filter_name} is the name of a supported MPlayer filter,
4017 @var{filter_params} is a string containing the parameters accepted by
4018 the named filter.
4019
4020 The list of the currently supported filters follows:
4021 @table @var
4022 @item detc
4023 @item dint
4024 @item divtc
4025 @item down3dright
4026 @item eq2
4027 @item eq
4028 @item fil
4029 @item fspp
4030 @item ilpack
4031 @item ivtc
4032 @item mcdeint
4033 @item ow
4034 @item perspective
4035 @item phase
4036 @item pp7
4037 @item pullup
4038 @item qp
4039 @item sab
4040 @item softpulldown
4041 @item spp
4042 @item telecine
4043 @item tinterlace
4044 @item uspp
4045 @end table
4046
4047 The parameter syntax and behavior for the listed filters are the same
4048 of the corresponding MPlayer filters. For detailed instructions check
4049 the "VIDEO FILTERS" section in the MPlayer manual.
4050
4051 @subsection Examples
4052
4053 @itemize
4054 @item
4055 Adjust gamma, brightness, contrast:
4056 @example
4057 mp=eq2=1.0:2:0.5
4058 @end example
4059 @end itemize
4060
4061 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
4062
4063 @section negate
4064
4065 Negate input video.
4066
4067 This filter accepts an integer in input, if non-zero it negates the
4068 alpha component (if available). The default value in input is 0.
4069
4070 @section noformat
4071
4072 Force libavfilter not to use any of the specified pixel formats for the
4073 input to the next filter.
4074
4075 The filter accepts a list of pixel format names, separated by ":",
4076 for example "yuv420p:monow:rgb24".
4077
4078 @subsection Examples
4079
4080 @itemize
4081 @item
4082 Force libavfilter to use a format different from @var{yuv420p} for the
4083 input to the vflip filter:
4084 @example
4085 noformat=yuv420p,vflip
4086 @end example
4087
4088 @item
4089 Convert the input video to any of the formats not contained in the list:
4090 @example
4091 noformat=yuv420p:yuv444p:yuv410p
4092 @end example
4093 @end itemize
4094
4095 @section noise
4096
4097 Add noise on video input frame.
4098
4099 This filter accepts a list of options in the form of @var{key}=@var{value}
4100 pairs separated by ":". A description of the accepted options follows.
4101
4102 @table @option
4103 @item all_seed
4104 @item c0_seed
4105 @item c1_seed
4106 @item c2_seed
4107 @item c3_seed
4108 Set noise seed for specific pixel component or all pixel components in case
4109 of @var{all_seed}. Default value is @code{123457}.
4110
4111 @item all_strength, alls
4112 @item c0_strength, c0s
4113 @item c1_strength, c1s
4114 @item c2_strength, c2s
4115 @item c3_strength, c3s
4116 Set noise strength for specific pixel component or all pixel components in case
4117 @var{all_strength}. Default value is @code{0}. Allowed range is [0, 100].
4118
4119 @item all_flags, allf
4120 @item c0_flags, c0f
4121 @item c1_flags, c1f
4122 @item c2_flags, c2f
4123 @item c3_flags, c3f
4124 Set pixel component flags or set flags for all components if @var{all_flags}.
4125 Available values for component flags are:
4126 @table @samp
4127 @item a
4128 averaged temporal noise (smoother)
4129 @item p
4130 mix random noise with a (semi)regular pattern
4131 @item q
4132 higher quality (slightly better looking, slightly slower)
4133 @item t
4134 temporal noise (noise pattern changes between frames)
4135 @item u
4136 uniform noise (gaussian otherwise)
4137 @end table
4138 @end table
4139
4140 @subsection Examples
4141
4142 Add temporal and uniform noise to input video:
4143 @example
4144 noise=alls=20:allf=t+u
4145 @end example
4146
4147 @section null
4148
4149 Pass the video source unchanged to the output.
4150
4151 @section ocv
4152
4153 Apply video transform using libopencv.
4154
4155 To enable this filter install libopencv library and headers and
4156 configure FFmpeg with @code{--enable-libopencv}.
4157
4158 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
4159
4160 @var{filter_name} is the name of the libopencv filter to apply.
4161
4162 @var{filter_params} specifies the parameters to pass to the libopencv
4163 filter. If not specified the default values are assumed.
4164
4165 Refer to the official libopencv documentation for more precise
4166 information:
4167 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
4168
4169 Follows the list of supported libopencv filters.
4170
4171 @anchor{dilate}
4172 @subsection dilate
4173
4174 Dilate an image by using a specific structuring element.
4175 This filter corresponds to the libopencv function @code{cvDilate}.
4176
4177 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
4178
4179 @var{struct_el} represents a structuring element, and has the syntax:
4180 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
4181
4182 @var{cols} and @var{rows} represent the number of columns and rows of
4183 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
4184 point, and @var{shape} the shape for the structuring element, and
4185 can be one of the values "rect", "cross", "ellipse", "custom".
4186
4187 If the value for @var{shape} is "custom", it must be followed by a
4188 string of the form "=@var{filename}". The file with name
4189 @var{filename} is assumed to represent a binary image, with each
4190 printable character corresponding to a bright pixel. When a custom
4191 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
4192 or columns and rows of the read file are assumed instead.
4193
4194 The default value for @var{struct_el} is "3x3+0x0/rect".
4195
4196 @var{nb_iterations} specifies the number of times the transform is
4197 applied to the image, and defaults to 1.
4198
4199 Follow some example:
4200 @example
4201 # use the default values
4202 ocv=dilate
4203
4204 # dilate using a structuring element with a 5x5 cross, iterate two times
4205 ocv=dilate=5x5+2x2/cross:2
4206
4207 # read the shape from the file diamond.shape, iterate two times
4208 # the file diamond.shape may contain a pattern of characters like this:
4209 #   *
4210 #  ***
4211 # *****
4212 #  ***
4213 #   *
4214 # the specified cols and rows are ignored (but not the anchor point coordinates)
4215 ocv=0x0+2x2/custom=diamond.shape:2
4216 @end example
4217
4218 @subsection erode
4219
4220 Erode an image by using a specific structuring element.
4221 This filter corresponds to the libopencv function @code{cvErode}.
4222
4223 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
4224 with the same syntax and semantics as the @ref{dilate} filter.
4225
4226 @subsection smooth
4227
4228 Smooth the input video.
4229
4230 The filter takes the following parameters: