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