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