avfilter/avf_showvolume: fix several issues
[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 @verbatim
12                 [main]
13 input --> split ---------------------> overlay --> output
14             |                             ^
15             |[tmp]                  [flip]|
16             +-----> crop --> vflip -------+
17 @end verbatim
18
19 This filtergraph splits the input stream in two streams, then sends one
20 stream through the crop filter and the vflip filter, before merging it
21 back with the other stream by overlaying it on top. You can use the
22 following command to achieve this:
23
24 @example
25 ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
26 @end example
27
28 The result will be that the top half of the video is mirrored
29 onto the bottom half of the output video.
30
31 Filters in the same linear chain are separated by commas, and distinct
32 linear chains of filters are separated by semicolons. In our example,
33 @var{crop,vflip} are in one linear chain, @var{split} and
34 @var{overlay} are separately in another. The points where the linear
35 chains join are labelled by names enclosed in square brackets. In the
36 example, the split filter generates two outputs that are associated to
37 the labels @var{[main]} and @var{[tmp]}.
38
39 The stream sent to the second output of @var{split}, labelled as
40 @var{[tmp]}, is processed through the @var{crop} filter, which crops
41 away the lower half part of the video, and then vertically flipped. The
42 @var{overlay} filter takes in input the first unchanged output of the
43 split filter (which was labelled as @var{[main]}), and overlay on its
44 lower half the output generated by the @var{crop,vflip} filterchain.
45
46 Some filters take in input a list of parameters: they are specified
47 after the filter name and an equal sign, and are separated from each other
48 by a colon.
49
50 There exist so-called @var{source filters} that do not have an
51 audio/video input, and @var{sink filters} that will not have audio/video
52 output.
53
54 @c man end FILTERING INTRODUCTION
55
56 @chapter graph2dot
57 @c man begin GRAPH2DOT
58
59 The @file{graph2dot} program included in the FFmpeg @file{tools}
60 directory can be used to parse a filtergraph description and issue a
61 corresponding textual representation in the dot language.
62
63 Invoke the command:
64 @example
65 graph2dot -h
66 @end example
67
68 to see how to use @file{graph2dot}.
69
70 You can then pass the dot description to the @file{dot} program (from
71 the graphviz suite of programs) and obtain a graphical representation
72 of the filtergraph.
73
74 For example the sequence of commands:
75 @example
76 echo @var{GRAPH_DESCRIPTION} | \
77 tools/graph2dot -o graph.tmp && \
78 dot -Tpng graph.tmp -o graph.png && \
79 display graph.png
80 @end example
81
82 can be used to create and display an image representing the graph
83 described by the @var{GRAPH_DESCRIPTION} string. Note that this string must be
84 a complete self-contained graph, with its inputs and outputs explicitly defined.
85 For example if your command line is of the form:
86 @example
87 ffmpeg -i infile -vf scale=640:360 outfile
88 @end example
89 your @var{GRAPH_DESCRIPTION} string will need to be of the form:
90 @example
91 nullsrc,scale=640:360,nullsink
92 @end example
93 you may also need to set the @var{nullsrc} parameters and add a @var{format}
94 filter in order to simulate a specific input file.
95
96 @c man end GRAPH2DOT
97
98 @chapter Filtergraph description
99 @c man begin FILTERGRAPH DESCRIPTION
100
101 A filtergraph is a directed graph of connected filters. It can contain
102 cycles, and there can be multiple links between a pair of
103 filters. Each link has one input pad on one side connecting it to one
104 filter from which it takes its input, and one output pad on the other
105 side connecting it to one filter accepting its output.
106
107 Each filter in a filtergraph is an instance of a filter class
108 registered in the application, which defines the features and the
109 number of input and output pads of the filter.
110
111 A filter with no input pads is called a "source", and a filter with no
112 output pads is called a "sink".
113
114 @anchor{Filtergraph syntax}
115 @section Filtergraph syntax
116
117 A filtergraph has a textual representation, which is recognized by the
118 @option{-filter}/@option{-vf}/@option{-af} and
119 @option{-filter_complex} options in @command{ffmpeg} and
120 @option{-vf}/@option{-af} in @command{ffplay}, and by the
121 @code{avfilter_graph_parse_ptr()} function defined in
122 @file{libavfilter/avfilter.h}.
123
124 A filterchain consists of a sequence of connected filters, each one
125 connected to the previous one in the sequence. A filterchain is
126 represented by a list of ","-separated filter descriptions.
127
128 A filtergraph consists of a sequence of filterchains. A sequence of
129 filterchains is represented by a list of ";"-separated filterchain
130 descriptions.
131
132 A filter is represented by a string of the form:
133 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
134
135 @var{filter_name} is the name of the filter class of which the
136 described filter is an instance of, and has to be the name of one of
137 the filter classes registered in the program.
138 The name of the filter class is optionally followed by a string
139 "=@var{arguments}".
140
141 @var{arguments} is a string which contains the parameters used to
142 initialize the filter instance. It may have one of two forms:
143 @itemize
144
145 @item
146 A ':'-separated list of @var{key=value} pairs.
147
148 @item
149 A ':'-separated list of @var{value}. In this case, the keys are assumed to be
150 the option names in the order they are declared. E.g. the @code{fade} filter
151 declares three options in this order -- @option{type}, @option{start_frame} and
152 @option{nb_frames}. Then the parameter list @var{in:0:30} means that the value
153 @var{in} is assigned to the option @option{type}, @var{0} to
154 @option{start_frame} and @var{30} to @option{nb_frames}.
155
156 @item
157 A ':'-separated list of mixed direct @var{value} and long @var{key=value}
158 pairs. The direct @var{value} must precede the @var{key=value} pairs, and
159 follow the same constraints order of the previous point. The following
160 @var{key=value} pairs can be set in any preferred order.
161
162 @end itemize
163
164 If the option value itself is a list of items (e.g. the @code{format} filter
165 takes a list of pixel formats), the items in the list are usually separated by
166 @samp{|}.
167
168 The list of arguments can be quoted using the character @samp{'} as initial
169 and ending mark, and the character @samp{\} for escaping the characters
170 within the quoted text; otherwise the argument string is considered
171 terminated when the next special character (belonging to the set
172 @samp{[]=;,}) is encountered.
173
174 The name and arguments of the filter are optionally preceded and
175 followed by a list of link labels.
176 A link label allows one to name a link and associate it to a filter output
177 or input pad. The preceding labels @var{in_link_1}
178 ... @var{in_link_N}, are associated to the filter input pads,
179 the following labels @var{out_link_1} ... @var{out_link_M}, are
180 associated to the output pads.
181
182 When two link labels with the same name are found in the
183 filtergraph, a link between the corresponding input and output pad is
184 created.
185
186 If an output pad is not labelled, it is linked by default to the first
187 unlabelled input pad of the next filter in the filterchain.
188 For example in the filterchain
189 @example
190 nullsrc, split[L1], [L2]overlay, nullsink
191 @end example
192 the split filter instance has two output pads, and the overlay filter
193 instance two input pads. The first output pad of split is labelled
194 "L1", the first input pad of overlay is labelled "L2", and the second
195 output pad of split is linked to the second input pad of overlay,
196 which are both unlabelled.
197
198 In a filter description, if the input label of the first filter is not
199 specified, "in" is assumed; if the output label of the last filter is not
200 specified, "out" is assumed.
201
202 In a complete filterchain all the unlabelled filter input and output
203 pads must be connected. A filtergraph is considered valid if all the
204 filter input and output pads of all the filterchains are connected.
205
206 Libavfilter will automatically insert @ref{scale} filters where format
207 conversion is required. It is possible to specify swscale flags
208 for those automatically inserted scalers by prepending
209 @code{sws_flags=@var{flags};}
210 to the filtergraph description.
211
212 Here is a BNF description of the filtergraph syntax:
213 @example
214 @var{NAME}             ::= sequence of alphanumeric characters and '_'
215 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
216 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
217 @var{FILTER_ARGUMENTS} ::= sequence of chars (possibly quoted)
218 @var{FILTER}           ::= [@var{LINKLABELS}] @var{NAME} ["=" @var{FILTER_ARGUMENTS}] [@var{LINKLABELS}]
219 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
220 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
221 @end example
222
223 @section Notes on filtergraph escaping
224
225 Filtergraph description composition entails several levels of
226 escaping. See @ref{quoting_and_escaping,,the "Quoting and escaping"
227 section in the ffmpeg-utils(1) manual,ffmpeg-utils} for more
228 information about the employed escaping procedure.
229
230 A first level escaping affects the content of each filter option
231 value, which may contain the special character @code{:} used to
232 separate values, or one of the escaping characters @code{\'}.
233
234 A second level escaping affects the whole filter description, which
235 may contain the escaping characters @code{\'} or the special
236 characters @code{[],;} used by the filtergraph description.
237
238 Finally, when you specify a filtergraph on a shell commandline, you
239 need to perform a third level escaping for the shell special
240 characters contained within it.
241
242 For example, consider the following string to be embedded in
243 the @ref{drawtext} filter description @option{text} value:
244 @example
245 this is a 'string': may contain one, or more, special characters
246 @end example
247
248 This string contains the @code{'} special escaping character, and the
249 @code{:} special character, so it needs to be escaped in this way:
250 @example
251 text=this is a \'string\'\: may contain one, or more, special characters
252 @end example
253
254 A second level of escaping is required when embedding the filter
255 description in a filtergraph description, in order to escape all the
256 filtergraph special characters. Thus the example above becomes:
257 @example
258 drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
259 @end example
260 (note that in addition to the @code{\'} escaping special characters,
261 also @code{,} needs to be escaped).
262
263 Finally an additional level of escaping is needed when writing the
264 filtergraph description in a shell command, which depends on the
265 escaping rules of the adopted shell. For example, assuming that
266 @code{\} is special and needs to be escaped with another @code{\}, the
267 previous string will finally result in:
268 @example
269 -vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
270 @end example
271
272 @chapter Timeline editing
273
274 Some filters support a generic @option{enable} option. For the filters
275 supporting timeline editing, this option can be set to an expression which is
276 evaluated before sending a frame to the filter. If the evaluation is non-zero,
277 the filter will be enabled, otherwise the frame will be sent unchanged to the
278 next filter in the filtergraph.
279
280 The expression accepts the following values:
281 @table @samp
282 @item t
283 timestamp expressed in seconds, NAN if the input timestamp is unknown
284
285 @item n
286 sequential number of the input frame, starting from 0
287
288 @item pos
289 the position in the file of the input frame, NAN if unknown
290
291 @item w
292 @item h
293 width and height of the input frame if video
294 @end table
295
296 Additionally, these filters support an @option{enable} command that can be used
297 to re-define the expression.
298
299 Like any other filtering option, the @option{enable} option follows the same
300 rules.
301
302 For example, to enable a blur filter (@ref{smartblur}) from 10 seconds to 3
303 minutes, and a @ref{curves} filter starting at 3 seconds:
304 @example
305 smartblur = enable='between(t,10,3*60)',
306 curves    = enable='gte(t,3)' : preset=cross_process
307 @end example
308
309 @c man end FILTERGRAPH DESCRIPTION
310
311 @chapter Audio Filters
312 @c man begin AUDIO FILTERS
313
314 When you configure your FFmpeg build, you can disable any of the
315 existing filters using @code{--disable-filters}.
316 The configure output will show the audio filters included in your
317 build.
318
319 Below is a description of the currently available audio filters.
320
321 @section acompressor
322
323 A compressor is mainly used to reduce the dynamic range of a signal.
324 Especially modern music is mostly compressed at a high ratio to
325 improve the overall loudness. It's done to get the highest attention
326 of a listener, "fatten" the sound and bring more "power" to the track.
327 If a signal is compressed too much it may sound dull or "dead"
328 afterwards or it may start to "pump" (which could be a powerful effect
329 but can also destroy a track completely).
330 The right compression is the key to reach a professional sound and is
331 the high art of mixing and mastering. Because of its complex settings
332 it may take a long time to get the right feeling for this kind of effect.
333
334 Compression is done by detecting the volume above a chosen level
335 @code{threshold} and dividing it by the factor set with @code{ratio}.
336 So if you set the threshold to -12dB and your signal reaches -6dB a ratio
337 of 2:1 will result in a signal at -9dB. Because an exact manipulation of
338 the signal would cause distortion of the waveform the reduction can be
339 levelled over the time. This is done by setting "Attack" and "Release".
340 @code{attack} determines how long the signal has to rise above the threshold
341 before any reduction will occur and @code{release} sets the time the signal
342 has to fall below the threshold to reduce the reduction again. Shorter signals
343 than the chosen attack time will be left untouched.
344 The overall reduction of the signal can be made up afterwards with the
345 @code{makeup} setting. So compressing the peaks of a signal about 6dB and
346 raising the makeup to this level results in a signal twice as loud than the
347 source. To gain a softer entry in the compression the @code{knee} flattens the
348 hard edge at the threshold in the range of the chosen decibels.
349
350 The filter accepts the following options:
351
352 @table @option
353 @item threshold
354 If a signal of second stream rises above this level it will affect the gain
355 reduction of the first stream.
356 By default it is 0.125. Range is between 0.00097563 and 1.
357
358 @item ratio
359 Set a ratio by which the signal is reduced. 1:2 means that if the level
360 rose 4dB above the threshold, it will be only 2dB above after the reduction.
361 Default is 2. Range is between 1 and 20.
362
363 @item attack
364 Amount of milliseconds the signal has to rise above the threshold before gain
365 reduction starts. Default is 20. Range is between 0.01 and 2000.
366
367 @item release
368 Amount of milliseconds the signal has to fall below the threshold before
369 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
370
371 @item makeup
372 Set the amount by how much signal will be amplified after processing.
373 Default is 2. Range is from 1 and 64.
374
375 @item knee
376 Curve the sharp knee around the threshold to enter gain reduction more softly.
377 Default is 2.82843. Range is between 1 and 8.
378
379 @item link
380 Choose if the @code{average} level between all channels of input stream
381 or the louder(@code{maximum}) channel of input stream affects the
382 reduction. Default is @code{average}.
383
384 @item detection
385 Should the exact signal be taken in case of @code{peak} or an RMS one in case
386 of @code{rms}. Default is @code{rms} which is mostly smoother.
387
388 @item mix
389 How much to use compressed signal in output. Default is 1.
390 Range is between 0 and 1.
391 @end table
392
393 @section acrossfade
394
395 Apply cross fade from one input audio stream to another input audio stream.
396 The cross fade is applied for specified duration near the end of first stream.
397
398 The filter accepts the following options:
399
400 @table @option
401 @item nb_samples, ns
402 Specify the number of samples for which the cross fade effect has to last.
403 At the end of the cross fade effect the first input audio will be completely
404 silent. Default is 44100.
405
406 @item duration, d
407 Specify the duration of the cross fade effect. See
408 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
409 for the accepted syntax.
410 By default the duration is determined by @var{nb_samples}.
411 If set this option is used instead of @var{nb_samples}.
412
413 @item overlap, o
414 Should first stream end overlap with second stream start. Default is enabled.
415
416 @item curve1
417 Set curve for cross fade transition for first stream.
418
419 @item curve2
420 Set curve for cross fade transition for second stream.
421
422 For description of available curve types see @ref{afade} filter description.
423 @end table
424
425 @subsection Examples
426
427 @itemize
428 @item
429 Cross fade from one input to another:
430 @example
431 ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
432 @end example
433
434 @item
435 Cross fade from one input to another but without overlapping:
436 @example
437 ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
438 @end example
439 @end itemize
440
441 @section adelay
442
443 Delay one or more audio channels.
444
445 Samples in delayed channel are filled with silence.
446
447 The filter accepts the following option:
448
449 @table @option
450 @item delays
451 Set list of delays in milliseconds for each channel separated by '|'.
452 At least one delay greater than 0 should be provided.
453 Unused delays will be silently ignored. If number of given delays is
454 smaller than number of channels all remaining channels will not be delayed.
455 @end table
456
457 @subsection Examples
458
459 @itemize
460 @item
461 Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave
462 the second channel (and any other channels that may be present) unchanged.
463 @example
464 adelay=1500|0|500
465 @end example
466 @end itemize
467
468 @section aecho
469
470 Apply echoing to the input audio.
471
472 Echoes are reflected sound and can occur naturally amongst mountains
473 (and sometimes large buildings) when talking or shouting; digital echo
474 effects emulate this behaviour and are often used to help fill out the
475 sound of a single instrument or vocal. The time difference between the
476 original signal and the reflection is the @code{delay}, and the
477 loudness of the reflected signal is the @code{decay}.
478 Multiple echoes can have different delays and decays.
479
480 A description of the accepted parameters follows.
481
482 @table @option
483 @item in_gain
484 Set input gain of reflected signal. Default is @code{0.6}.
485
486 @item out_gain
487 Set output gain of reflected signal. Default is @code{0.3}.
488
489 @item delays
490 Set list of time intervals in milliseconds between original signal and reflections
491 separated by '|'. Allowed range for each @code{delay} is @code{(0 - 90000.0]}.
492 Default is @code{1000}.
493
494 @item decays
495 Set list of loudnesses of reflected signals separated by '|'.
496 Allowed range for each @code{decay} is @code{(0 - 1.0]}.
497 Default is @code{0.5}.
498 @end table
499
500 @subsection Examples
501
502 @itemize
503 @item
504 Make it sound as if there are twice as many instruments as are actually playing:
505 @example
506 aecho=0.8:0.88:60:0.4
507 @end example
508
509 @item
510 If delay is very short, then it sound like a (metallic) robot playing music:
511 @example
512 aecho=0.8:0.88:6:0.4
513 @end example
514
515 @item
516 A longer delay will sound like an open air concert in the mountains:
517 @example
518 aecho=0.8:0.9:1000:0.3
519 @end example
520
521 @item
522 Same as above but with one more mountain:
523 @example
524 aecho=0.8:0.9:1000|1800:0.3|0.25
525 @end example
526 @end itemize
527
528 @section aeval
529
530 Modify an audio signal according to the specified expressions.
531
532 This filter accepts one or more expressions (one for each channel),
533 which are evaluated and used to modify a corresponding audio signal.
534
535 It accepts the following parameters:
536
537 @table @option
538 @item exprs
539 Set the '|'-separated expressions list for each separate channel. If
540 the number of input channels is greater than the number of
541 expressions, the last specified expression is used for the remaining
542 output channels.
543
544 @item channel_layout, c
545 Set output channel layout. If not specified, the channel layout is
546 specified by the number of expressions. If set to @samp{same}, it will
547 use by default the same input channel layout.
548 @end table
549
550 Each expression in @var{exprs} can contain the following constants and functions:
551
552 @table @option
553 @item ch
554 channel number of the current expression
555
556 @item n
557 number of the evaluated sample, starting from 0
558
559 @item s
560 sample rate
561
562 @item t
563 time of the evaluated sample expressed in seconds
564
565 @item nb_in_channels
566 @item nb_out_channels
567 input and output number of channels
568
569 @item val(CH)
570 the value of input channel with number @var{CH}
571 @end table
572
573 Note: this filter is slow. For faster processing you should use a
574 dedicated filter.
575
576 @subsection Examples
577
578 @itemize
579 @item
580 Half volume:
581 @example
582 aeval=val(ch)/2:c=same
583 @end example
584
585 @item
586 Invert phase of the second channel:
587 @example
588 aeval=val(0)|-val(1)
589 @end example
590 @end itemize
591
592 @anchor{afade}
593 @section afade
594
595 Apply fade-in/out effect to input audio.
596
597 A description of the accepted parameters follows.
598
599 @table @option
600 @item type, t
601 Specify the effect type, can be either @code{in} for fade-in, or
602 @code{out} for a fade-out effect. Default is @code{in}.
603
604 @item start_sample, ss
605 Specify the number of the start sample for starting to apply the fade
606 effect. Default is 0.
607
608 @item nb_samples, ns
609 Specify the number of samples for which the fade effect has to last. At
610 the end of the fade-in effect the output audio will have the same
611 volume as the input audio, at the end of the fade-out transition
612 the output audio will be silence. Default is 44100.
613
614 @item start_time, st
615 Specify the start time of the fade effect. Default is 0.
616 The value must be specified as a time duration; see
617 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
618 for the accepted syntax.
619 If set this option is used instead of @var{start_sample}.
620
621 @item duration, d
622 Specify the duration of the fade effect. See
623 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
624 for the accepted syntax.
625 At the end of the fade-in effect the output audio will have the same
626 volume as the input audio, at the end of the fade-out transition
627 the output audio will be silence.
628 By default the duration is determined by @var{nb_samples}.
629 If set this option is used instead of @var{nb_samples}.
630
631 @item curve
632 Set curve for fade transition.
633
634 It accepts the following values:
635 @table @option
636 @item tri
637 select triangular, linear slope (default)
638 @item qsin
639 select quarter of sine wave
640 @item hsin
641 select half of sine wave
642 @item esin
643 select exponential sine wave
644 @item log
645 select logarithmic
646 @item ipar
647 select inverted parabola
648 @item qua
649 select quadratic
650 @item cub
651 select cubic
652 @item squ
653 select square root
654 @item cbr
655 select cubic root
656 @item par
657 select parabola
658 @item exp
659 select exponential
660 @item iqsin
661 select inverted quarter of sine wave
662 @item ihsin
663 select inverted half of sine wave
664 @item dese
665 select double-exponential seat
666 @item desi
667 select double-exponential sigmoid
668 @end table
669 @end table
670
671 @subsection Examples
672
673 @itemize
674 @item
675 Fade in first 15 seconds of audio:
676 @example
677 afade=t=in:ss=0:d=15
678 @end example
679
680 @item
681 Fade out last 25 seconds of a 900 seconds audio:
682 @example
683 afade=t=out:st=875:d=25
684 @end example
685 @end itemize
686
687 @anchor{aformat}
688 @section aformat
689
690 Set output format constraints for the input audio. The framework will
691 negotiate the most appropriate format to minimize conversions.
692
693 It accepts the following parameters:
694 @table @option
695
696 @item sample_fmts
697 A '|'-separated list of requested sample formats.
698
699 @item sample_rates
700 A '|'-separated list of requested sample rates.
701
702 @item channel_layouts
703 A '|'-separated list of requested channel layouts.
704
705 See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
706 for the required syntax.
707 @end table
708
709 If a parameter is omitted, all values are allowed.
710
711 Force the output to either unsigned 8-bit or signed 16-bit stereo
712 @example
713 aformat=sample_fmts=u8|s16:channel_layouts=stereo
714 @end example
715
716 @section agate
717
718 A gate is mainly used to reduce lower parts of a signal. This kind of signal
719 processing reduces disturbing noise between useful signals.
720
721 Gating is done by detecting the volume below a chosen level @var{threshold}
722 and divide it by the factor set with @var{ratio}. The bottom of the noise
723 floor is set via @var{range}. Because an exact manipulation of the signal
724 would cause distortion of the waveform the reduction can be levelled over
725 time. This is done by setting @var{attack} and @var{release}.
726
727 @var{attack} determines how long the signal has to fall below the threshold
728 before any reduction will occur and @var{release} sets the time the signal
729 has to raise above the threshold to reduce the reduction again.
730 Shorter signals than the chosen attack time will be left untouched.
731
732 @table @option
733 @item level_in
734 Set input level before filtering.
735 Default is 1. Allowed range is from 0.015625 to 64.
736
737 @item range
738 Set the level of gain reduction when the signal is below the threshold.
739 Default is 0.06125. Allowed range is from 0 to 1.
740
741 @item threshold
742 If a signal rises above this level the gain reduction is released.
743 Default is 0.125. Allowed range is from 0 to 1.
744
745 @item ratio
746 Set a ratio about which the signal is reduced.
747 Default is 2. Allowed range is from 1 to 9000.
748
749 @item attack
750 Amount of milliseconds the signal has to rise above the threshold before gain
751 reduction stops.
752 Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
753
754 @item release
755 Amount of milliseconds the signal has to fall below the threshold before the
756 reduction is increased again. Default is 250 milliseconds.
757 Allowed range is from 0.01 to 9000.
758
759 @item makeup
760 Set amount of amplification of signal after processing.
761 Default is 1. Allowed range is from 1 to 64.
762
763 @item knee
764 Curve the sharp knee around the threshold to enter gain reduction more softly.
765 Default is 2.828427125. Allowed range is from 1 to 8.
766
767 @item detection
768 Choose if exact signal should be taken for detection or an RMS like one.
769 Default is peak. Can be peak or rms.
770
771 @item link
772 Choose if the average level between all channels or the louder channel affects
773 the reduction.
774 Default is average. Can be average or maximum.
775 @end table
776
777 @section alimiter
778
779 The limiter prevents input signal from raising over a desired threshold.
780 This limiter uses lookahead technology to prevent your signal from distorting.
781 It means that there is a small delay after signal is processed. Keep in mind
782 that the delay it produces is the attack time you set.
783
784 The filter accepts the following options:
785
786 @table @option
787 @item limit
788 Don't let signals above this level pass the limiter. The removed amplitude is
789 added automatically. Default is 1.
790
791 @item attack
792 The limiter will reach its attenuation level in this amount of time in
793 milliseconds. Default is 5 milliseconds.
794
795 @item release
796 Come back from limiting to attenuation 1.0 in this amount of milliseconds.
797 Default is 50 milliseconds.
798
799 @item asc
800 When gain reduction is always needed ASC takes care of releasing to an
801 average reduction level rather than reaching a reduction of 0 in the release
802 time.
803
804 @item asc_level
805 Select how much the release time is affected by ASC, 0 means nearly no changes
806 in release time while 1 produces higher release times.
807 @end table
808
809 Depending on picked setting it is recommended to upsample input 2x or 4x times
810 with @ref{aresample} before applying this filter.
811
812 @section allpass
813
814 Apply a two-pole all-pass filter with central frequency (in Hz)
815 @var{frequency}, and filter-width @var{width}.
816 An all-pass filter changes the audio's frequency to phase relationship
817 without changing its frequency to amplitude relationship.
818
819 The filter accepts the following options:
820
821 @table @option
822 @item frequency, f
823 Set frequency in Hz.
824
825 @item width_type
826 Set method to specify band-width of filter.
827 @table @option
828 @item h
829 Hz
830 @item q
831 Q-Factor
832 @item o
833 octave
834 @item s
835 slope
836 @end table
837
838 @item width, w
839 Specify the band-width of a filter in width_type units.
840 @end table
841
842 @anchor{amerge}
843 @section amerge
844
845 Merge two or more audio streams into a single multi-channel stream.
846
847 The filter accepts the following options:
848
849 @table @option
850
851 @item inputs
852 Set the number of inputs. Default is 2.
853
854 @end table
855
856 If the channel layouts of the inputs are disjoint, and therefore compatible,
857 the channel layout of the output will be set accordingly and the channels
858 will be reordered as necessary. If the channel layouts of the inputs are not
859 disjoint, the output will have all the channels of the first input then all
860 the channels of the second input, in that order, and the channel layout of
861 the output will be the default value corresponding to the total number of
862 channels.
863
864 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
865 is FC+BL+BR, then the output will be in 5.1, with the channels in the
866 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
867 first input, b1 is the first channel of the second input).
868
869 On the other hand, if both input are in stereo, the output channels will be
870 in the default order: a1, a2, b1, b2, and the channel layout will be
871 arbitrarily set to 4.0, which may or may not be the expected value.
872
873 All inputs must have the same sample rate, and format.
874
875 If inputs do not have the same duration, the output will stop with the
876 shortest.
877
878 @subsection Examples
879
880 @itemize
881 @item
882 Merge two mono files into a stereo stream:
883 @example
884 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
885 @end example
886
887 @item
888 Multiple merges assuming 1 video stream and 6 audio streams in @file{input.mkv}:
889 @example
890 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
891 @end example
892 @end itemize
893
894 @section amix
895
896 Mixes multiple audio inputs into a single output.
897
898 Note that this filter only supports float samples (the @var{amerge}
899 and @var{pan} audio filters support many formats). If the @var{amix}
900 input has integer samples then @ref{aresample} will be automatically
901 inserted to perform the conversion to float samples.
902
903 For example
904 @example
905 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
906 @end example
907 will mix 3 input audio streams to a single output with the same duration as the
908 first input and a dropout transition time of 3 seconds.
909
910 It accepts the following parameters:
911 @table @option
912
913 @item inputs
914 The number of inputs. If unspecified, it defaults to 2.
915
916 @item duration
917 How to determine the end-of-stream.
918 @table @option
919
920 @item longest
921 The duration of the longest input. (default)
922
923 @item shortest
924 The duration of the shortest input.
925
926 @item first
927 The duration of the first input.
928
929 @end table
930
931 @item dropout_transition
932 The transition time, in seconds, for volume renormalization when an input
933 stream ends. The default value is 2 seconds.
934
935 @end table
936
937 @section anull
938
939 Pass the audio source unchanged to the output.
940
941 @section apad
942
943 Pad the end of an audio stream with silence.
944
945 This can be used together with @command{ffmpeg} @option{-shortest} to
946 extend audio streams to the same length as the video stream.
947
948 A description of the accepted options follows.
949
950 @table @option
951 @item packet_size
952 Set silence packet size. Default value is 4096.
953
954 @item pad_len
955 Set the number of samples of silence to add to the end. After the
956 value is reached, the stream is terminated. This option is mutually
957 exclusive with @option{whole_len}.
958
959 @item whole_len
960 Set the minimum total number of samples in the output audio stream. If
961 the value is longer than the input audio length, silence is added to
962 the end, until the value is reached. This option is mutually exclusive
963 with @option{pad_len}.
964 @end table
965
966 If neither the @option{pad_len} nor the @option{whole_len} option is
967 set, the filter will add silence to the end of the input stream
968 indefinitely.
969
970 @subsection Examples
971
972 @itemize
973 @item
974 Add 1024 samples of silence to the end of the input:
975 @example
976 apad=pad_len=1024
977 @end example
978
979 @item
980 Make sure the audio output will contain at least 10000 samples, pad
981 the input with silence if required:
982 @example
983 apad=whole_len=10000
984 @end example
985
986 @item
987 Use @command{ffmpeg} to pad the audio input with silence, so that the
988 video stream will always result the shortest and will be converted
989 until the end in the output file when using the @option{shortest}
990 option:
991 @example
992 ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
993 @end example
994 @end itemize
995
996 @section aphaser
997 Add a phasing effect to the input audio.
998
999 A phaser filter creates series of peaks and troughs in the frequency spectrum.
1000 The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
1001
1002 A description of the accepted parameters follows.
1003
1004 @table @option
1005 @item in_gain
1006 Set input gain. Default is 0.4.
1007
1008 @item out_gain
1009 Set output gain. Default is 0.74
1010
1011 @item delay
1012 Set delay in milliseconds. Default is 3.0.
1013
1014 @item decay
1015 Set decay. Default is 0.4.
1016
1017 @item speed
1018 Set modulation speed in Hz. Default is 0.5.
1019
1020 @item type
1021 Set modulation type. Default is triangular.
1022
1023 It accepts the following values:
1024 @table @samp
1025 @item triangular, t
1026 @item sinusoidal, s
1027 @end table
1028 @end table
1029
1030 @anchor{aresample}
1031 @section aresample
1032
1033 Resample the input audio to the specified parameters, using the
1034 libswresample library. If none are specified then the filter will
1035 automatically convert between its input and output.
1036
1037 This filter is also able to stretch/squeeze the audio data to make it match
1038 the timestamps or to inject silence / cut out audio to make it match the
1039 timestamps, do a combination of both or do neither.
1040
1041 The filter accepts the syntax
1042 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
1043 expresses a sample rate and @var{resampler_options} is a list of
1044 @var{key}=@var{value} pairs, separated by ":". See the
1045 ffmpeg-resampler manual for the complete list of supported options.
1046
1047 @subsection Examples
1048
1049 @itemize
1050 @item
1051 Resample the input audio to 44100Hz:
1052 @example
1053 aresample=44100
1054 @end example
1055
1056 @item
1057 Stretch/squeeze samples to the given timestamps, with a maximum of 1000
1058 samples per second compensation:
1059 @example
1060 aresample=async=1000
1061 @end example
1062 @end itemize
1063
1064 @section asetnsamples
1065
1066 Set the number of samples per each output audio frame.
1067
1068 The last output packet may contain a different number of samples, as
1069 the filter will flush all the remaining samples when the input audio
1070 signal its end.
1071
1072 The filter accepts the following options:
1073
1074 @table @option
1075
1076 @item nb_out_samples, n
1077 Set the number of frames per each output audio frame. The number is
1078 intended as the number of samples @emph{per each channel}.
1079 Default value is 1024.
1080
1081 @item pad, p
1082 If set to 1, the filter will pad the last audio frame with zeroes, so
1083 that the last frame will contain the same number of samples as the
1084 previous ones. Default value is 1.
1085 @end table
1086
1087 For example, to set the number of per-frame samples to 1234 and
1088 disable padding for the last frame, use:
1089 @example
1090 asetnsamples=n=1234:p=0
1091 @end example
1092
1093 @section asetrate
1094
1095 Set the sample rate without altering the PCM data.
1096 This will result in a change of speed and pitch.
1097
1098 The filter accepts the following options:
1099
1100 @table @option
1101 @item sample_rate, r
1102 Set the output sample rate. Default is 44100 Hz.
1103 @end table
1104
1105 @section ashowinfo
1106
1107 Show a line containing various information for each input audio frame.
1108 The input audio is not modified.
1109
1110 The shown line contains a sequence of key/value pairs of the form
1111 @var{key}:@var{value}.
1112
1113 The following values are shown in the output:
1114
1115 @table @option
1116 @item n
1117 The (sequential) number of the input frame, starting from 0.
1118
1119 @item pts
1120 The presentation timestamp of the input frame, in time base units; the time base
1121 depends on the filter input pad, and is usually 1/@var{sample_rate}.
1122
1123 @item pts_time
1124 The presentation timestamp of the input frame in seconds.
1125
1126 @item pos
1127 position of the frame in the input stream, -1 if this information in
1128 unavailable and/or meaningless (for example in case of synthetic audio)
1129
1130 @item fmt
1131 The sample format.
1132
1133 @item chlayout
1134 The channel layout.
1135
1136 @item rate
1137 The sample rate for the audio frame.
1138
1139 @item nb_samples
1140 The number of samples (per channel) in the frame.
1141
1142 @item checksum
1143 The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
1144 audio, the data is treated as if all the planes were concatenated.
1145
1146 @item plane_checksums
1147 A list of Adler-32 checksums for each data plane.
1148 @end table
1149
1150 @anchor{astats}
1151 @section astats
1152
1153 Display time domain statistical information about the audio channels.
1154 Statistics are calculated and displayed for each audio channel and,
1155 where applicable, an overall figure is also given.
1156
1157 It accepts the following option:
1158 @table @option
1159 @item length
1160 Short window length in seconds, used for peak and trough RMS measurement.
1161 Default is @code{0.05} (50 milliseconds). Allowed range is @code{[0.1 - 10]}.
1162
1163 @item metadata
1164
1165 Set metadata injection. All the metadata keys are prefixed with @code{lavfi.astats.X},
1166 where @code{X} is channel number starting from 1 or string @code{Overall}. Default is
1167 disabled.
1168
1169 Available keys for each channel are:
1170 DC_offset
1171 Min_level
1172 Max_level
1173 Min_difference
1174 Max_difference
1175 Mean_difference
1176 Peak_level
1177 RMS_peak
1178 RMS_trough
1179 Crest_factor
1180 Flat_factor
1181 Peak_count
1182 Bit_depth
1183
1184 and for Overall:
1185 DC_offset
1186 Min_level
1187 Max_level
1188 Min_difference
1189 Max_difference
1190 Mean_difference
1191 Peak_level
1192 RMS_level
1193 RMS_peak
1194 RMS_trough
1195 Flat_factor
1196 Peak_count
1197 Bit_depth
1198 Number_of_samples
1199
1200 For example full key look like this @code{lavfi.astats.1.DC_offset} or
1201 this @code{lavfi.astats.Overall.Peak_count}.
1202
1203 For description what each key means read below.
1204
1205 @item reset
1206 Set number of frame after which stats are going to be recalculated.
1207 Default is disabled.
1208 @end table
1209
1210 A description of each shown parameter follows:
1211
1212 @table @option
1213 @item DC offset
1214 Mean amplitude displacement from zero.
1215
1216 @item Min level
1217 Minimal sample level.
1218
1219 @item Max level
1220 Maximal sample level.
1221
1222 @item Min difference
1223 Minimal difference between two consecutive samples.
1224
1225 @item Max difference
1226 Maximal difference between two consecutive samples.
1227
1228 @item Mean difference
1229 Mean difference between two consecutive samples.
1230 The average of each difference between two consecutive samples.
1231
1232 @item Peak level dB
1233 @item RMS level dB
1234 Standard peak and RMS level measured in dBFS.
1235
1236 @item RMS peak dB
1237 @item RMS trough dB
1238 Peak and trough values for RMS level measured over a short window.
1239
1240 @item Crest factor
1241 Standard ratio of peak to RMS level (note: not in dB).
1242
1243 @item Flat factor
1244 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
1245 (i.e. either @var{Min level} or @var{Max level}).
1246
1247 @item Peak count
1248 Number of occasions (not the number of samples) that the signal attained either
1249 @var{Min level} or @var{Max level}.
1250
1251 @item Bit depth
1252 Overall bit depth of audio. Number of bits used for each sample.
1253 @end table
1254
1255 @section asyncts
1256
1257 Synchronize audio data with timestamps by squeezing/stretching it and/or
1258 dropping samples/adding silence when needed.
1259
1260 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
1261
1262 It accepts the following parameters:
1263 @table @option
1264
1265 @item compensate
1266 Enable stretching/squeezing the data to make it match the timestamps. Disabled
1267 by default. When disabled, time gaps are covered with silence.
1268
1269 @item min_delta
1270 The minimum difference between timestamps and audio data (in seconds) to trigger
1271 adding/dropping samples. The default value is 0.1. If you get an imperfect
1272 sync with this filter, try setting this parameter to 0.
1273
1274 @item max_comp
1275 The maximum compensation in samples per second. Only relevant with compensate=1.
1276 The default value is 500.
1277
1278 @item first_pts
1279 Assume that the first PTS should be this value. The time base is 1 / sample
1280 rate. This allows for padding/trimming at the start of the stream. By default,
1281 no assumption is made about the first frame's expected PTS, so no padding or
1282 trimming is done. For example, this could be set to 0 to pad the beginning with
1283 silence if an audio stream starts after the video stream or to trim any samples
1284 with a negative PTS due to encoder delay.
1285
1286 @end table
1287
1288 @section atempo
1289
1290 Adjust audio tempo.
1291
1292 The filter accepts exactly one parameter, the audio tempo. If not
1293 specified then the filter will assume nominal 1.0 tempo. Tempo must
1294 be in the [0.5, 2.0] range.
1295
1296 @subsection Examples
1297
1298 @itemize
1299 @item
1300 Slow down audio to 80% tempo:
1301 @example
1302 atempo=0.8
1303 @end example
1304
1305 @item
1306 To speed up audio to 125% tempo:
1307 @example
1308 atempo=1.25
1309 @end example
1310 @end itemize
1311
1312 @section atrim
1313
1314 Trim the input so that the output contains one continuous subpart of the input.
1315
1316 It accepts the following parameters:
1317 @table @option
1318 @item start
1319 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
1320 sample with the timestamp @var{start} will be the first sample in the output.
1321
1322 @item end
1323 Specify time of the first audio sample that will be dropped, i.e. the
1324 audio sample immediately preceding the one with the timestamp @var{end} will be
1325 the last sample in the output.
1326
1327 @item start_pts
1328 Same as @var{start}, except this option sets the start timestamp in samples
1329 instead of seconds.
1330
1331 @item end_pts
1332 Same as @var{end}, except this option sets the end timestamp in samples instead
1333 of seconds.
1334
1335 @item duration
1336 The maximum duration of the output in seconds.
1337
1338 @item start_sample
1339 The number of the first sample that should be output.
1340
1341 @item end_sample
1342 The number of the first sample that should be dropped.
1343 @end table
1344
1345 @option{start}, @option{end}, and @option{duration} are expressed as time
1346 duration specifications; see
1347 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
1348
1349 Note that the first two sets of the start/end options and the @option{duration}
1350 option look at the frame timestamp, while the _sample options simply count the
1351 samples that pass through the filter. So start/end_pts and start/end_sample will
1352 give different results when the timestamps are wrong, inexact or do not start at
1353 zero. Also note that this filter does not modify the timestamps. If you wish
1354 to have the output timestamps start at zero, insert the asetpts filter after the
1355 atrim filter.
1356
1357 If multiple start or end options are set, this filter tries to be greedy and
1358 keep all samples that match at least one of the specified constraints. To keep
1359 only the part that matches all the constraints at once, chain multiple atrim
1360 filters.
1361
1362 The defaults are such that all the input is kept. So it is possible to set e.g.
1363 just the end values to keep everything before the specified time.
1364
1365 Examples:
1366 @itemize
1367 @item
1368 Drop everything except the second minute of input:
1369 @example
1370 ffmpeg -i INPUT -af atrim=60:120
1371 @end example
1372
1373 @item
1374 Keep only the first 1000 samples:
1375 @example
1376 ffmpeg -i INPUT -af atrim=end_sample=1000
1377 @end example
1378
1379 @end itemize
1380
1381 @section bandpass
1382
1383 Apply a two-pole Butterworth band-pass filter with central
1384 frequency @var{frequency}, and (3dB-point) band-width width.
1385 The @var{csg} option selects a constant skirt gain (peak gain = Q)
1386 instead of the default: constant 0dB peak gain.
1387 The filter roll off at 6dB per octave (20dB per decade).
1388
1389 The filter accepts the following options:
1390
1391 @table @option
1392 @item frequency, f
1393 Set the filter's central frequency. Default is @code{3000}.
1394
1395 @item csg
1396 Constant skirt gain if set to 1. Defaults to 0.
1397
1398 @item width_type
1399 Set method to specify band-width of filter.
1400 @table @option
1401 @item h
1402 Hz
1403 @item q
1404 Q-Factor
1405 @item o
1406 octave
1407 @item s
1408 slope
1409 @end table
1410
1411 @item width, w
1412 Specify the band-width of a filter in width_type units.
1413 @end table
1414
1415 @section bandreject
1416
1417 Apply a two-pole Butterworth band-reject filter with central
1418 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
1419 The filter roll off at 6dB per octave (20dB per decade).
1420
1421 The filter accepts the following options:
1422
1423 @table @option
1424 @item frequency, f
1425 Set the filter's central frequency. Default is @code{3000}.
1426
1427 @item width_type
1428 Set method to specify band-width of filter.
1429 @table @option
1430 @item h
1431 Hz
1432 @item q
1433 Q-Factor
1434 @item o
1435 octave
1436 @item s
1437 slope
1438 @end table
1439
1440 @item width, w
1441 Specify the band-width of a filter in width_type units.
1442 @end table
1443
1444 @section bass
1445
1446 Boost or cut the bass (lower) frequencies of the audio using a two-pole
1447 shelving filter with a response similar to that of a standard
1448 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1449
1450 The filter accepts the following options:
1451
1452 @table @option
1453 @item gain, g
1454 Give the gain at 0 Hz. Its useful range is about -20
1455 (for a large cut) to +20 (for a large boost).
1456 Beware of clipping when using a positive gain.
1457
1458 @item frequency, f
1459 Set the filter's central frequency and so can be used
1460 to extend or reduce the frequency range to be boosted or cut.
1461 The default value is @code{100} Hz.
1462
1463 @item width_type
1464 Set method to specify band-width of filter.
1465 @table @option
1466 @item h
1467 Hz
1468 @item q
1469 Q-Factor
1470 @item o
1471 octave
1472 @item s
1473 slope
1474 @end table
1475
1476 @item width, w
1477 Determine how steep is the filter's shelf transition.
1478 @end table
1479
1480 @section biquad
1481
1482 Apply a biquad IIR filter with the given coefficients.
1483 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
1484 are the numerator and denominator coefficients respectively.
1485
1486 @section bs2b
1487 Bauer stereo to binaural transformation, which improves headphone listening of
1488 stereo audio records.
1489
1490 It accepts the following parameters:
1491 @table @option
1492
1493 @item profile
1494 Pre-defined crossfeed level.
1495 @table @option
1496
1497 @item default
1498 Default level (fcut=700, feed=50).
1499
1500 @item cmoy
1501 Chu Moy circuit (fcut=700, feed=60).
1502
1503 @item jmeier
1504 Jan Meier circuit (fcut=650, feed=95).
1505
1506 @end table
1507
1508 @item fcut
1509 Cut frequency (in Hz).
1510
1511 @item feed
1512 Feed level (in Hz).
1513
1514 @end table
1515
1516 @section channelmap
1517
1518 Remap input channels to new locations.
1519
1520 It accepts the following parameters:
1521 @table @option
1522 @item channel_layout
1523 The channel layout of the output stream.
1524
1525 @item map
1526 Map channels from input to output. The argument is a '|'-separated list of
1527 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1528 @var{in_channel} form. @var{in_channel} can be either the name of the input
1529 channel (e.g. FL for front left) or its index in the input channel layout.
1530 @var{out_channel} is the name of the output channel or its index in the output
1531 channel layout. If @var{out_channel} is not given then it is implicitly an
1532 index, starting with zero and increasing by one for each mapping.
1533 @end table
1534
1535 If no mapping is present, the filter will implicitly map input channels to
1536 output channels, preserving indices.
1537
1538 For example, assuming a 5.1+downmix input MOV file,
1539 @example
1540 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
1541 @end example
1542 will create an output WAV file tagged as stereo from the downmix channels of
1543 the input.
1544
1545 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1546 @example
1547 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
1548 @end example
1549
1550 @section channelsplit
1551
1552 Split each channel from an input audio stream into a separate output stream.
1553
1554 It accepts the following parameters:
1555 @table @option
1556 @item channel_layout
1557 The channel layout of the input stream. The default is "stereo".
1558 @end table
1559
1560 For example, assuming a stereo input MP3 file,
1561 @example
1562 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1563 @end example
1564 will create an output Matroska file with two audio streams, one containing only
1565 the left channel and the other the right channel.
1566
1567 Split a 5.1 WAV file into per-channel files:
1568 @example
1569 ffmpeg -i in.wav -filter_complex
1570 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1571 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1572 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1573 side_right.wav
1574 @end example
1575
1576 @section chorus
1577 Add a chorus effect to the audio.
1578
1579 Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
1580
1581 Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
1582 constant, with chorus, it is varied using using sinusoidal or triangular modulation.
1583 The modulation depth defines the range the modulated delay is played before or after
1584 the delay. Hence the delayed sound will sound slower or faster, that is the delayed
1585 sound tuned around the original one, like in a chorus where some vocals are slightly
1586 off key.
1587
1588 It accepts the following parameters:
1589 @table @option
1590 @item in_gain
1591 Set input gain. Default is 0.4.
1592
1593 @item out_gain
1594 Set output gain. Default is 0.4.
1595
1596 @item delays
1597 Set delays. A typical delay is around 40ms to 60ms.
1598
1599 @item decays
1600 Set decays.
1601
1602 @item speeds
1603 Set speeds.
1604
1605 @item depths
1606 Set depths.
1607 @end table
1608
1609 @subsection Examples
1610
1611 @itemize
1612 @item
1613 A single delay:
1614 @example
1615 chorus=0.7:0.9:55:0.4:0.25:2
1616 @end example
1617
1618 @item
1619 Two delays:
1620 @example
1621 chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
1622 @end example
1623
1624 @item
1625 Fuller sounding chorus with three delays:
1626 @example
1627 chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3
1628 @end example
1629 @end itemize
1630
1631 @section compand
1632 Compress or expand the audio's dynamic range.
1633
1634 It accepts the following parameters:
1635
1636 @table @option
1637
1638 @item attacks
1639 @item decays
1640 A list of times in seconds for each channel over which the instantaneous level
1641 of the input signal is averaged to determine its volume. @var{attacks} refers to
1642 increase of volume and @var{decays} refers to decrease of volume. For most
1643 situations, the attack time (response to the audio getting louder) should be
1644 shorter than the decay time, because the human ear is more sensitive to sudden
1645 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
1646 a typical value for decay is 0.8 seconds.
1647 If specified number of attacks & decays is lower than number of channels, the last
1648 set attack/decay will be used for all remaining channels.
1649
1650 @item points
1651 A list of points for the transfer function, specified in dB relative to the
1652 maximum possible signal amplitude. Each key points list must be defined using
1653 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
1654 @code{x0/y0 x1/y1 x2/y2 ....}
1655
1656 The input values must be in strictly increasing order but the transfer function
1657 does not have to be monotonically rising. The point @code{0/0} is assumed but
1658 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
1659 function are @code{-70/-70|-60/-20}.
1660
1661 @item soft-knee
1662 Set the curve radius in dB for all joints. It defaults to 0.01.
1663
1664 @item gain
1665 Set the additional gain in dB to be applied at all points on the transfer
1666 function. This allows for easy adjustment of the overall gain.
1667 It defaults to 0.
1668
1669 @item volume
1670 Set an initial volume, in dB, to be assumed for each channel when filtering
1671 starts. This permits the user to supply a nominal level initially, so that, for
1672 example, a very large gain is not applied to initial signal levels before the
1673 companding has begun to operate. A typical value for audio which is initially
1674 quiet is -90 dB. It defaults to 0.
1675
1676 @item delay
1677 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
1678 delayed before being fed to the volume adjuster. Specifying a delay
1679 approximately equal to the attack/decay times allows the filter to effectively
1680 operate in predictive rather than reactive mode. It defaults to 0.
1681
1682 @end table
1683
1684 @subsection Examples
1685
1686 @itemize
1687 @item
1688 Make music with both quiet and loud passages suitable for listening to in a
1689 noisy environment:
1690 @example
1691 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
1692 @end example
1693
1694 Another example for audio with whisper and explosion parts:
1695 @example
1696 compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
1697 @end example
1698
1699 @item
1700 A noise gate for when the noise is at a lower level than the signal:
1701 @example
1702 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
1703 @end example
1704
1705 @item
1706 Here is another noise gate, this time for when the noise is at a higher level
1707 than the signal (making it, in some ways, similar to squelch):
1708 @example
1709 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
1710 @end example
1711 @end itemize
1712
1713 @section compensationdelay
1714
1715 Compensation Delay Line is a metric based delay to compensate differing
1716 positions of microphones or speakers.
1717
1718 For example, you have recorded guitar with two microphones placed in
1719 different location. Because the front of sound wave has fixed speed in
1720 normal conditions, the phasing of microphones can vary and depends on
1721 their location and interposition. The best sound mix can be achieved when
1722 these microphones are in phase (synchronized). Note that distance of
1723 ~30 cm between microphones makes one microphone to capture signal in
1724 antiphase to another microphone. That makes the final mix sounding moody.
1725 This filter helps to solve phasing problems by adding different delays
1726 to each microphone track and make them synchronized.
1727
1728 The best result can be reached when you take one track as base and
1729 synchronize other tracks one by one with it.
1730 Remember that synchronization/delay tolerance depends on sample rate, too.
1731 Higher sample rates will give more tolerance.
1732
1733 It accepts the following parameters:
1734
1735 @table @option
1736 @item mm
1737 Set millimeters distance. This is compensation distance for fine tuning.
1738 Default is 0.
1739
1740 @item cm
1741 Set cm distance. This is compensation distance for tightening distance setup.
1742 Default is 0.
1743
1744 @item m
1745 Set meters distance. This is compensation distance for hard distance setup.
1746 Default is 0.
1747
1748 @item dry
1749 Set dry amount. Amount of unprocessed (dry) signal.
1750 Default is 0.
1751
1752 @item wet
1753 Set wet amount. Amount of processed (wet) signal.
1754 Default is 1.
1755
1756 @item temp
1757 Set temperature degree in Celsius. This is the temperature of the environment.
1758 Default is 20.
1759 @end table
1760
1761 @section dcshift
1762 Apply a DC shift to the audio.
1763
1764 This can be useful to remove a DC offset (caused perhaps by a hardware problem
1765 in the recording chain) from the audio. The effect of a DC offset is reduced
1766 headroom and hence volume. The @ref{astats} filter can be used to determine if
1767 a signal has a DC offset.
1768
1769 @table @option
1770 @item shift
1771 Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
1772 the audio.
1773
1774 @item limitergain
1775 Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
1776 used to prevent clipping.
1777 @end table
1778
1779 @section dynaudnorm
1780 Dynamic Audio Normalizer.
1781
1782 This filter applies a certain amount of gain to the input audio in order
1783 to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
1784 contrast to more "simple" normalization algorithms, the Dynamic Audio
1785 Normalizer *dynamically* re-adjusts the gain factor to the input audio.
1786 This allows for applying extra gain to the "quiet" sections of the audio
1787 while avoiding distortions or clipping the "loud" sections. In other words:
1788 The Dynamic Audio Normalizer will "even out" the volume of quiet and loud
1789 sections, in the sense that the volume of each section is brought to the
1790 same target level. Note, however, that the Dynamic Audio Normalizer achieves
1791 this goal *without* applying "dynamic range compressing". It will retain 100%
1792 of the dynamic range *within* each section of the audio file.
1793
1794 @table @option
1795 @item f
1796 Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
1797 Default is 500 milliseconds.
1798 The Dynamic Audio Normalizer processes the input audio in small chunks,
1799 referred to as frames. This is required, because a peak magnitude has no
1800 meaning for just a single sample value. Instead, we need to determine the
1801 peak magnitude for a contiguous sequence of sample values. While a "standard"
1802 normalizer would simply use the peak magnitude of the complete file, the
1803 Dynamic Audio Normalizer determines the peak magnitude individually for each
1804 frame. The length of a frame is specified in milliseconds. By default, the
1805 Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
1806 been found to give good results with most files.
1807 Note that the exact frame length, in number of samples, will be determined
1808 automatically, based on the sampling rate of the individual input audio file.
1809
1810 @item g
1811 Set the Gaussian filter window size. In range from 3 to 301, must be odd
1812 number. Default is 31.
1813 Probably the most important parameter of the Dynamic Audio Normalizer is the
1814 @code{window size} of the Gaussian smoothing filter. The filter's window size
1815 is specified in frames, centered around the current frame. For the sake of
1816 simplicity, this must be an odd number. Consequently, the default value of 31
1817 takes into account the current frame, as well as the 15 preceding frames and
1818 the 15 subsequent frames. Using a larger window results in a stronger
1819 smoothing effect and thus in less gain variation, i.e. slower gain
1820 adaptation. Conversely, using a smaller window results in a weaker smoothing
1821 effect and thus in more gain variation, i.e. faster gain adaptation.
1822 In other words, the more you increase this value, the more the Dynamic Audio
1823 Normalizer will behave like a "traditional" normalization filter. On the
1824 contrary, the more you decrease this value, the more the Dynamic Audio
1825 Normalizer will behave like a dynamic range compressor.
1826
1827 @item p
1828 Set the target peak value. This specifies the highest permissible magnitude
1829 level for the normalized audio input. This filter will try to approach the
1830 target peak magnitude as closely as possible, but at the same time it also
1831 makes sure that the normalized signal will never exceed the peak magnitude.
1832 A frame's maximum local gain factor is imposed directly by the target peak
1833 magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
1834 It is not recommended to go above this value.
1835
1836 @item m
1837 Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
1838 The Dynamic Audio Normalizer determines the maximum possible (local) gain
1839 factor for each input frame, i.e. the maximum gain factor that does not
1840 result in clipping or distortion. The maximum gain factor is determined by
1841 the frame's highest magnitude sample. However, the Dynamic Audio Normalizer
1842 additionally bounds the frame's maximum gain factor by a predetermined
1843 (global) maximum gain factor. This is done in order to avoid excessive gain
1844 factors in "silent" or almost silent frames. By default, the maximum gain
1845 factor is 10.0, For most inputs the default value should be sufficient and
1846 it usually is not recommended to increase this value. Though, for input
1847 with an extremely low overall volume level, it may be necessary to allow even
1848 higher gain factors. Note, however, that the Dynamic Audio Normalizer does
1849 not simply apply a "hard" threshold (i.e. cut off values above the threshold).
1850 Instead, a "sigmoid" threshold function will be applied. This way, the
1851 gain factors will smoothly approach the threshold value, but never exceed that
1852 value.
1853
1854 @item r
1855 Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
1856 By default, the Dynamic Audio Normalizer performs "peak" normalization.
1857 This means that the maximum local gain factor for each frame is defined
1858 (only) by the frame's highest magnitude sample. This way, the samples can
1859 be amplified as much as possible without exceeding the maximum signal
1860 level, i.e. without clipping. Optionally, however, the Dynamic Audio
1861 Normalizer can also take into account the frame's root mean square,
1862 abbreviated RMS. In electrical engineering, the RMS is commonly used to
1863 determine the power of a time-varying signal. It is therefore considered
1864 that the RMS is a better approximation of the "perceived loudness" than
1865 just looking at the signal's peak magnitude. Consequently, by adjusting all
1866 frames to a constant RMS value, a uniform "perceived loudness" can be
1867 established. If a target RMS value has been specified, a frame's local gain
1868 factor is defined as the factor that would result in exactly that RMS value.
1869 Note, however, that the maximum local gain factor is still restricted by the
1870 frame's highest magnitude sample, in order to prevent clipping.
1871
1872 @item n
1873 Enable channels coupling. By default is enabled.
1874 By default, the Dynamic Audio Normalizer will amplify all channels by the same
1875 amount. This means the same gain factor will be applied to all channels, i.e.
1876 the maximum possible gain factor is determined by the "loudest" channel.
1877 However, in some recordings, it may happen that the volume of the different
1878 channels is uneven, e.g. one channel may be "quieter" than the other one(s).
1879 In this case, this option can be used to disable the channel coupling. This way,
1880 the gain factor will be determined independently for each channel, depending
1881 only on the individual channel's highest magnitude sample. This allows for
1882 harmonizing the volume of the different channels.
1883
1884 @item c
1885 Enable DC bias correction. By default is disabled.
1886 An audio signal (in the time domain) is a sequence of sample values.
1887 In the Dynamic Audio Normalizer these sample values are represented in the
1888 -1.0 to 1.0 range, regardless of the original input format. Normally, the
1889 audio signal, or "waveform", should be centered around the zero point.
1890 That means if we calculate the mean value of all samples in a file, or in a
1891 single frame, then the result should be 0.0 or at least very close to that
1892 value. If, however, there is a significant deviation of the mean value from
1893 0.0, in either positive or negative direction, this is referred to as a
1894 DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
1895 Audio Normalizer provides optional DC bias correction.
1896 With DC bias correction enabled, the Dynamic Audio Normalizer will determine
1897 the mean value, or "DC correction" offset, of each input frame and subtract
1898 that value from all of the frame's sample values which ensures those samples
1899 are centered around 0.0 again. Also, in order to avoid "gaps" at the frame
1900 boundaries, the DC correction offset values will be interpolated smoothly
1901 between neighbouring frames.
1902
1903 @item b
1904 Enable alternative boundary mode. By default is disabled.
1905 The Dynamic Audio Normalizer takes into account a certain neighbourhood
1906 around each frame. This includes the preceding frames as well as the
1907 subsequent frames. However, for the "boundary" frames, located at the very
1908 beginning and at the very end of the audio file, not all neighbouring
1909 frames are available. In particular, for the first few frames in the audio
1910 file, the preceding frames are not known. And, similarly, for the last few
1911 frames in the audio file, the subsequent frames are not known. Thus, the
1912 question arises which gain factors should be assumed for the missing frames
1913 in the "boundary" region. The Dynamic Audio Normalizer implements two modes
1914 to deal with this situation. The default boundary mode assumes a gain factor
1915 of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and
1916 "fade out" at the beginning and at the end of the input, respectively.
1917
1918 @item s
1919 Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
1920 By default, the Dynamic Audio Normalizer does not apply "traditional"
1921 compression. This means that signal peaks will not be pruned and thus the
1922 full dynamic range will be retained within each local neighbourhood. However,
1923 in some cases it may be desirable to combine the Dynamic Audio Normalizer's
1924 normalization algorithm with a more "traditional" compression.
1925 For this purpose, the Dynamic Audio Normalizer provides an optional compression
1926 (thresholding) function. If (and only if) the compression feature is enabled,
1927 all input frames will be processed by a soft knee thresholding function prior
1928 to the actual normalization process. Put simply, the thresholding function is
1929 going to prune all samples whose magnitude exceeds a certain threshold value.
1930 However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
1931 value. Instead, the threshold value will be adjusted for each individual
1932 frame.
1933 In general, smaller parameters result in stronger compression, and vice versa.
1934 Values below 3.0 are not recommended, because audible distortion may appear.
1935 @end table
1936
1937 @section earwax
1938
1939 Make audio easier to listen to on headphones.
1940
1941 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
1942 so that when listened to on headphones the stereo image is moved from
1943 inside your head (standard for headphones) to outside and in front of
1944 the listener (standard for speakers).
1945
1946 Ported from SoX.
1947
1948 @section equalizer
1949
1950 Apply a two-pole peaking equalisation (EQ) filter. With this
1951 filter, the signal-level at and around a selected frequency can
1952 be increased or decreased, whilst (unlike bandpass and bandreject
1953 filters) that at all other frequencies is unchanged.
1954
1955 In order to produce complex equalisation curves, this filter can
1956 be given several times, each with a different central frequency.
1957
1958 The filter accepts the following options:
1959
1960 @table @option
1961 @item frequency, f
1962 Set the filter's central frequency in Hz.
1963
1964 @item width_type
1965 Set method to specify band-width of filter.
1966 @table @option
1967 @item h
1968 Hz
1969 @item q
1970 Q-Factor
1971 @item o
1972 octave
1973 @item s
1974 slope
1975 @end table
1976
1977 @item width, w
1978 Specify the band-width of a filter in width_type units.
1979
1980 @item gain, g
1981 Set the required gain or attenuation in dB.
1982 Beware of clipping when using a positive gain.
1983 @end table
1984
1985 @subsection Examples
1986 @itemize
1987 @item
1988 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
1989 @example
1990 equalizer=f=1000:width_type=h:width=200:g=-10
1991 @end example
1992
1993 @item
1994 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
1995 @example
1996 equalizer=f=1000:width_type=q:width=1:g=2,equalizer=f=100:width_type=q:width=2:g=-5
1997 @end example
1998 @end itemize
1999
2000 @section extrastereo
2001
2002 Linearly increases the difference between left and right channels which
2003 adds some sort of "live" effect to playback.
2004
2005 The filter accepts the following option:
2006
2007 @table @option
2008 @item m
2009 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
2010 (average of both channels), with 1.0 sound will be unchanged, with
2011 -1.0 left and right channels will be swapped.
2012
2013 @item c
2014 Enable clipping. By default is enabled.
2015 @end table
2016
2017 @section flanger
2018 Apply a flanging effect to the audio.
2019
2020 The filter accepts the following options:
2021
2022 @table @option
2023 @item delay
2024 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
2025
2026 @item depth
2027 Set added swep delay in milliseconds. Range from 0 to 10. Default value is 2.
2028
2029 @item regen
2030 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
2031 Default value is 0.
2032
2033 @item width
2034 Set percentage of delayed signal mixed with original. Range from 0 to 100.
2035 Default value is 71.
2036
2037 @item speed
2038 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
2039
2040 @item shape
2041 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
2042 Default value is @var{sinusoidal}.
2043
2044 @item phase
2045 Set swept wave percentage-shift for multi channel. Range from 0 to 100.
2046 Default value is 25.
2047
2048 @item interp
2049 Set delay-line interpolation, @var{linear} or @var{quadratic}.
2050 Default is @var{linear}.
2051 @end table
2052
2053 @section highpass
2054
2055 Apply a high-pass filter with 3dB point frequency.
2056 The filter can be either single-pole, or double-pole (the default).
2057 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
2058
2059 The filter accepts the following options:
2060
2061 @table @option
2062 @item frequency, f
2063 Set frequency in Hz. Default is 3000.
2064
2065 @item poles, p
2066 Set number of poles. Default is 2.
2067
2068 @item width_type
2069 Set method to specify band-width of filter.
2070 @table @option
2071 @item h
2072 Hz
2073 @item q
2074 Q-Factor
2075 @item o
2076 octave
2077 @item s
2078 slope
2079 @end table
2080
2081 @item width, w
2082 Specify the band-width of a filter in width_type units.
2083 Applies only to double-pole filter.
2084 The default is 0.707q and gives a Butterworth response.
2085 @end table
2086
2087 @section join
2088
2089 Join multiple input streams into one multi-channel stream.
2090
2091 It accepts the following parameters:
2092 @table @option
2093
2094 @item inputs
2095 The number of input streams. It defaults to 2.
2096
2097 @item channel_layout
2098 The desired output channel layout. It defaults to stereo.
2099
2100 @item map
2101 Map channels from inputs to output. The argument is a '|'-separated list of
2102 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
2103 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
2104 can be either the name of the input channel (e.g. FL for front left) or its
2105 index in the specified input stream. @var{out_channel} is the name of the output
2106 channel.
2107 @end table
2108
2109 The filter will attempt to guess the mappings when they are not specified
2110 explicitly. It does so by first trying to find an unused matching input channel
2111 and if that fails it picks the first unused input channel.
2112
2113 Join 3 inputs (with properly set channel layouts):
2114 @example
2115 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
2116 @end example
2117
2118 Build a 5.1 output from 6 single-channel streams:
2119 @example
2120 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
2121 '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'
2122 out
2123 @end example
2124
2125 @section ladspa
2126
2127 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
2128
2129 To enable compilation of this filter you need to configure FFmpeg with
2130 @code{--enable-ladspa}.
2131
2132 @table @option
2133 @item file, f
2134 Specifies the name of LADSPA plugin library to load. If the environment
2135 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
2136 each one of the directories specified by the colon separated list in
2137 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
2138 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
2139 @file{/usr/lib/ladspa/}.
2140
2141 @item plugin, p
2142 Specifies the plugin within the library. Some libraries contain only
2143 one plugin, but others contain many of them. If this is not set filter
2144 will list all available plugins within the specified library.
2145
2146 @item controls, c
2147 Set the '|' separated list of controls which are zero or more floating point
2148 values that determine the behavior of the loaded plugin (for example delay,
2149 threshold or gain).
2150 Controls need to be defined using the following syntax:
2151 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
2152 @var{valuei} is the value set on the @var{i}-th control.
2153 Alternatively they can be also defined using the following syntax:
2154 @var{value0}|@var{value1}|@var{value2}|..., where
2155 @var{valuei} is the value set on the @var{i}-th control.
2156 If @option{controls} is set to @code{help}, all available controls and
2157 their valid ranges are printed.
2158
2159 @item sample_rate, s
2160 Specify the sample rate, default to 44100. Only used if plugin have
2161 zero inputs.
2162
2163 @item nb_samples, n
2164 Set the number of samples per channel per each output frame, default
2165 is 1024. Only used if plugin have zero inputs.
2166
2167 @item duration, d
2168 Set the minimum duration of the sourced audio. See
2169 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
2170 for the accepted syntax.
2171 Note that the resulting duration may be greater than the specified duration,
2172 as the generated audio is always cut at the end of a complete frame.
2173 If not specified, or the expressed duration is negative, the audio is
2174 supposed to be generated forever.
2175 Only used if plugin have zero inputs.
2176
2177 @end table
2178
2179 @subsection Examples
2180
2181 @itemize
2182 @item
2183 List all available plugins within amp (LADSPA example plugin) library:
2184 @example
2185 ladspa=file=amp
2186 @end example
2187
2188 @item
2189 List all available controls and their valid ranges for @code{vcf_notch}
2190 plugin from @code{VCF} library:
2191 @example
2192 ladspa=f=vcf:p=vcf_notch:c=help
2193 @end example
2194
2195 @item
2196 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
2197 plugin library:
2198 @example
2199 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
2200 @end example
2201
2202 @item
2203 Add reverberation to the audio using TAP-plugins
2204 (Tom's Audio Processing plugins):
2205 @example
2206 ladspa=file=tap_reverb:tap_reverb
2207 @end example
2208
2209 @item
2210 Generate white noise, with 0.2 amplitude:
2211 @example
2212 ladspa=file=cmt:noise_source_white:c=c0=.2
2213 @end example
2214
2215 @item
2216 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
2217 @code{C* Audio Plugin Suite} (CAPS) library:
2218 @example
2219 ladspa=file=caps:Click:c=c1=20'
2220 @end example
2221
2222 @item
2223 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
2224 @example
2225 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
2226 @end example
2227
2228 @item
2229 Increase volume by 20dB using fast lookahead limiter from Steve Harris
2230 @code{SWH Plugins} collection:
2231 @example
2232 ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
2233 @end example
2234
2235 @item
2236 Attenuate low frequencies using Multiband EQ from Steve Harris
2237 @code{SWH Plugins} collection:
2238 @example
2239 ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
2240 @end example
2241 @end itemize
2242
2243 @subsection Commands
2244
2245 This filter supports the following commands:
2246 @table @option
2247 @item cN
2248 Modify the @var{N}-th control value.
2249
2250 If the specified value is not valid, it is ignored and prior one is kept.
2251 @end table
2252
2253 @section lowpass
2254
2255 Apply a low-pass filter with 3dB point frequency.
2256 The filter can be either single-pole or double-pole (the default).
2257 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
2258
2259 The filter accepts the following options:
2260
2261 @table @option
2262 @item frequency, f
2263 Set frequency in Hz. Default is 500.
2264
2265 @item poles, p
2266 Set number of poles. Default is 2.
2267
2268 @item width_type
2269 Set method to specify band-width of filter.
2270 @table @option
2271 @item h
2272 Hz
2273 @item q
2274 Q-Factor
2275 @item o
2276 octave
2277 @item s
2278 slope
2279 @end table
2280
2281 @item width, w
2282 Specify the band-width of a filter in width_type units.
2283 Applies only to double-pole filter.
2284 The default is 0.707q and gives a Butterworth response.
2285 @end table
2286
2287 @anchor{pan}
2288 @section pan
2289
2290 Mix channels with specific gain levels. The filter accepts the output
2291 channel layout followed by a set of channels definitions.
2292
2293 This filter is also designed to efficiently remap the channels of an audio
2294 stream.
2295
2296 The filter accepts parameters of the form:
2297 "@var{l}|@var{outdef}|@var{outdef}|..."
2298
2299 @table @option
2300 @item l
2301 output channel layout or number of channels
2302
2303 @item outdef
2304 output channel specification, of the form:
2305 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
2306
2307 @item out_name
2308 output channel to define, either a channel name (FL, FR, etc.) or a channel
2309 number (c0, c1, etc.)
2310
2311 @item gain
2312 multiplicative coefficient for the channel, 1 leaving the volume unchanged
2313
2314 @item in_name
2315 input channel to use, see out_name for details; it is not possible to mix
2316 named and numbered input channels
2317 @end table
2318
2319 If the `=' in a channel specification is replaced by `<', then the gains for
2320 that specification will be renormalized so that the total is 1, thus
2321 avoiding clipping noise.
2322
2323 @subsection Mixing examples
2324
2325 For example, if you want to down-mix from stereo to mono, but with a bigger
2326 factor for the left channel:
2327 @example
2328 pan=1c|c0=0.9*c0+0.1*c1
2329 @end example
2330
2331 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
2332 7-channels surround:
2333 @example
2334 pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
2335 @end example
2336
2337 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
2338 that should be preferred (see "-ac" option) unless you have very specific
2339 needs.
2340
2341 @subsection Remapping examples
2342
2343 The channel remapping will be effective if, and only if:
2344
2345 @itemize
2346 @item gain coefficients are zeroes or ones,
2347 @item only one input per channel output,
2348 @end itemize
2349
2350 If all these conditions are satisfied, the filter will notify the user ("Pure
2351 channel mapping detected"), and use an optimized and lossless method to do the
2352 remapping.
2353
2354 For example, if you have a 5.1 source and want a stereo audio stream by
2355 dropping the extra channels:
2356 @example
2357 pan="stereo| c0=FL | c1=FR"
2358 @end example
2359
2360 Given the same source, you can also switch front left and front right channels
2361 and keep the input channel layout:
2362 @example
2363 pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
2364 @end example
2365
2366 If the input is a stereo audio stream, you can mute the front left channel (and
2367 still keep the stereo channel layout) with:
2368 @example
2369 pan="stereo|c1=c1"
2370 @end example
2371
2372 Still with a stereo audio stream input, you can copy the right channel in both
2373 front left and right:
2374 @example
2375 pan="stereo| c0=FR | c1=FR"
2376 @end example
2377
2378 @section replaygain
2379
2380 ReplayGain scanner filter. This filter takes an audio stream as an input and
2381 outputs it unchanged.
2382 At end of filtering it displays @code{track_gain} and @code{track_peak}.
2383
2384 @section resample
2385
2386 Convert the audio sample format, sample rate and channel layout. It is
2387 not meant to be used directly.
2388
2389 @section rubberband
2390 Apply time-stretching and pitch-shifting with librubberband.
2391
2392 The filter accepts the following options:
2393
2394 @table @option
2395 @item tempo
2396 Set tempo scale factor.
2397
2398 @item pitch
2399 Set pitch scale factor.
2400
2401 @item transients
2402 Set transients detector.
2403 Possible values are:
2404 @table @var
2405 @item crisp
2406 @item mixed
2407 @item smooth
2408 @end table
2409
2410 @item detector
2411 Set detector.
2412 Possible values are:
2413 @table @var
2414 @item compound
2415 @item percussive
2416 @item soft
2417 @end table
2418
2419 @item phase
2420 Set phase.
2421 Possible values are:
2422 @table @var
2423 @item laminar
2424 @item independent
2425 @end table
2426
2427 @item window
2428 Set processing window size.
2429 Possible values are:
2430 @table @var
2431 @item standard
2432 @item short
2433 @item long
2434 @end table
2435
2436 @item smoothing
2437 Set smoothing.
2438 Possible values are:
2439 @table @var
2440 @item off
2441 @item on
2442 @end table
2443
2444 @item formant
2445 Enable formant preservation when shift pitching.
2446 Possible values are:
2447 @table @var
2448 @item shifted
2449 @item preserved
2450 @end table
2451
2452 @item pitchq
2453 Set pitch quality.
2454 Possible values are:
2455 @table @var
2456 @item quality
2457 @item speed
2458 @item consistency
2459 @end table
2460
2461 @item channels
2462 Set channels.
2463 Possible values are:
2464 @table @var
2465 @item apart
2466 @item together
2467 @end table
2468 @end table
2469
2470 @section sidechaincompress
2471
2472 This filter acts like normal compressor but has the ability to compress
2473 detected signal using second input signal.
2474 It needs two input streams and returns one output stream.
2475 First input stream will be processed depending on second stream signal.
2476 The filtered signal then can be filtered with other filters in later stages of
2477 processing. See @ref{pan} and @ref{amerge} filter.
2478
2479 The filter accepts the following options:
2480
2481 @table @option
2482 @item threshold
2483 If a signal of second stream raises above this level it will affect the gain
2484 reduction of first stream.
2485 By default is 0.125. Range is between 0.00097563 and 1.
2486
2487 @item ratio
2488 Set a ratio about which the signal is reduced. 1:2 means that if the level
2489 raised 4dB above the threshold, it will be only 2dB above after the reduction.
2490 Default is 2. Range is between 1 and 20.
2491
2492 @item attack
2493 Amount of milliseconds the signal has to rise above the threshold before gain
2494 reduction starts. Default is 20. Range is between 0.01 and 2000.
2495
2496 @item release
2497 Amount of milliseconds the signal has to fall below the threshold before
2498 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
2499
2500 @item makeup
2501 Set the amount by how much signal will be amplified after processing.
2502 Default is 2. Range is from 1 and 64.
2503
2504 @item knee
2505 Curve the sharp knee around the threshold to enter gain reduction more softly.
2506 Default is 2.82843. Range is between 1 and 8.
2507
2508 @item link
2509 Choose if the @code{average} level between all channels of side-chain stream
2510 or the louder(@code{maximum}) channel of side-chain stream affects the
2511 reduction. Default is @code{average}.
2512
2513 @item detection
2514 Should the exact signal be taken in case of @code{peak} or an RMS one in case
2515 of @code{rms}. Default is @code{rms} which is mainly smoother.
2516
2517 @item mix
2518 How much to use compressed signal in output. Default is 1.
2519 Range is between 0 and 1.
2520 @end table
2521
2522 @subsection Examples
2523
2524 @itemize
2525 @item
2526 Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
2527 depending on the signal of 2nd input and later compressed signal to be
2528 merged with 2nd input:
2529 @example
2530 ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
2531 @end example
2532 @end itemize
2533
2534 @section silencedetect
2535
2536 Detect silence in an audio stream.
2537
2538 This filter logs a message when it detects that the input audio volume is less
2539 or equal to a noise tolerance value for a duration greater or equal to the
2540 minimum detected noise duration.
2541
2542 The printed times and duration are expressed in seconds.
2543
2544 The filter accepts the following options:
2545
2546 @table @option
2547 @item duration, d
2548 Set silence duration until notification (default is 2 seconds).
2549
2550 @item noise, n
2551 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
2552 specified value) or amplitude ratio. Default is -60dB, or 0.001.
2553 @end table
2554
2555 @subsection Examples
2556
2557 @itemize
2558 @item
2559 Detect 5 seconds of silence with -50dB noise tolerance:
2560 @example
2561 silencedetect=n=-50dB:d=5
2562 @end example
2563
2564 @item
2565 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
2566 tolerance in @file{silence.mp3}:
2567 @example
2568 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
2569 @end example
2570 @end itemize
2571
2572 @section silenceremove
2573
2574 Remove silence from the beginning, middle or end of the audio.
2575
2576 The filter accepts the following options:
2577
2578 @table @option
2579 @item start_periods
2580 This value is used to indicate if audio should be trimmed at beginning of
2581 the audio. A value of zero indicates no silence should be trimmed from the
2582 beginning. When specifying a non-zero value, it trims audio up until it
2583 finds non-silence. Normally, when trimming silence from beginning of audio
2584 the @var{start_periods} will be @code{1} but it can be increased to higher
2585 values to trim all audio up to specific count of non-silence periods.
2586 Default value is @code{0}.
2587
2588 @item start_duration
2589 Specify the amount of time that non-silence must be detected before it stops
2590 trimming audio. By increasing the duration, bursts of noises can be treated
2591 as silence and trimmed off. Default value is @code{0}.
2592
2593 @item start_threshold
2594 This indicates what sample value should be treated as silence. For digital
2595 audio, a value of @code{0} may be fine but for audio recorded from analog,
2596 you may wish to increase the value to account for background noise.
2597 Can be specified in dB (in case "dB" is appended to the specified value)
2598 or amplitude ratio. Default value is @code{0}.
2599
2600 @item stop_periods
2601 Set the count for trimming silence from the end of audio.
2602 To remove silence from the middle of a file, specify a @var{stop_periods}
2603 that is negative. This value is then treated as a positive value and is
2604 used to indicate the effect should restart processing as specified by
2605 @var{start_periods}, making it suitable for removing periods of silence
2606 in the middle of the audio.
2607 Default value is @code{0}.
2608
2609 @item stop_duration
2610 Specify a duration of silence that must exist before audio is not copied any
2611 more. By specifying a higher duration, silence that is wanted can be left in
2612 the audio.
2613 Default value is @code{0}.
2614
2615 @item stop_threshold
2616 This is the same as @option{start_threshold} but for trimming silence from
2617 the end of audio.
2618 Can be specified in dB (in case "dB" is appended to the specified value)
2619 or amplitude ratio. Default value is @code{0}.
2620
2621 @item leave_silence
2622 This indicate that @var{stop_duration} length of audio should be left intact
2623 at the beginning of each period of silence.
2624 For example, if you want to remove long pauses between words but do not want
2625 to remove the pauses completely. Default value is @code{0}.
2626
2627 @end table
2628
2629 @subsection Examples
2630
2631 @itemize
2632 @item
2633 The following example shows how this filter can be used to start a recording
2634 that does not contain the delay at the start which usually occurs between
2635 pressing the record button and the start of the performance:
2636 @example
2637 silenceremove=1:5:0.02
2638 @end example
2639 @end itemize
2640
2641 @section stereotools
2642
2643 This filter has some handy utilities to manage stereo signals, for converting
2644 M/S stereo recordings to L/R signal while having control over the parameters
2645 or spreading the stereo image of master track.
2646
2647 The filter accepts the following options:
2648
2649 @table @option
2650 @item level_in
2651 Set input level before filtering for both channels. Defaults is 1.
2652 Allowed range is from 0.015625 to 64.
2653
2654 @item level_out
2655 Set output level after filtering for both channels. Defaults is 1.
2656 Allowed range is from 0.015625 to 64.
2657
2658 @item balance_in
2659 Set input balance between both channels. Default is 0.
2660 Allowed range is from -1 to 1.
2661
2662 @item balance_out
2663 Set output balance between both channels. Default is 0.
2664 Allowed range is from -1 to 1.
2665
2666 @item softclip
2667 Enable softclipping. Results in analog distortion instead of harsh digital 0dB
2668 clipping. Disabled by default.
2669
2670 @item mutel
2671 Mute the left channel. Disabled by default.
2672
2673 @item muter
2674 Mute the right channel. Disabled by default.
2675
2676 @item phasel
2677 Change the phase of the left channel. Disabled by default.
2678
2679 @item phaser
2680 Change the phase of the right channel. Disabled by default.
2681
2682 @item mode
2683 Set stereo mode. Available values are:
2684
2685 @table @samp
2686 @item lr>lr
2687 Left/Right to Left/Right, this is default.
2688
2689 @item lr>ms
2690 Left/Right to Mid/Side.
2691
2692 @item ms>lr
2693 Mid/Side to Left/Right.
2694
2695 @item lr>ll
2696 Left/Right to Left/Left.
2697
2698 @item lr>rr
2699 Left/Right to Right/Right.
2700
2701 @item lr>l+r
2702 Left/Right to Left + Right.
2703
2704 @item lr>rl
2705 Left/Right to Right/Left.
2706 @end table
2707
2708 @item slev
2709 Set level of side signal. Default is 1.
2710 Allowed range is from 0.015625 to 64.
2711
2712 @item sbal
2713 Set balance of side signal. Default is 0.
2714 Allowed range is from -1 to 1.
2715
2716 @item mlev
2717 Set level of the middle signal. Default is 1.
2718 Allowed range is from 0.015625 to 64.
2719
2720 @item mpan
2721 Set middle signal pan. Default is 0. Allowed range is from -1 to 1.
2722
2723 @item base
2724 Set stereo base between mono and inversed channels. Default is 0.
2725 Allowed range is from -1 to 1.
2726
2727 @item delay
2728 Set delay in milliseconds how much to delay left from right channel and
2729 vice versa. Default is 0. Allowed range is from -20 to 20.
2730
2731 @item sclevel
2732 Set S/C level. Default is 1. Allowed range is from 1 to 100.
2733
2734 @item phase
2735 Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360.
2736 @end table
2737
2738 @section stereowiden
2739
2740 This filter enhance the stereo effect by suppressing signal common to both
2741 channels and by delaying the signal of left into right and vice versa,
2742 thereby widening the stereo effect.
2743
2744 The filter accepts the following options:
2745
2746 @table @option
2747 @item delay
2748 Time in milliseconds of the delay of left signal into right and vice versa.
2749 Default is 20 milliseconds.
2750
2751 @item feedback
2752 Amount of gain in delayed signal into right and vice versa. Gives a delay
2753 effect of left signal in right output and vice versa which gives widening
2754 effect. Default is 0.3.
2755
2756 @item crossfeed
2757 Cross feed of left into right with inverted phase. This helps in suppressing
2758 the mono. If the value is 1 it will cancel all the signal common to both
2759 channels. Default is 0.3.
2760
2761 @item drymix
2762 Set level of input signal of original channel. Default is 0.8.
2763 @end table
2764
2765 @section treble
2766
2767 Boost or cut treble (upper) frequencies of the audio using a two-pole
2768 shelving filter with a response similar to that of a standard
2769 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
2770
2771 The filter accepts the following options:
2772
2773 @table @option
2774 @item gain, g
2775 Give the gain at whichever is the lower of ~22 kHz and the
2776 Nyquist frequency. Its useful range is about -20 (for a large cut)
2777 to +20 (for a large boost). Beware of clipping when using a positive gain.
2778
2779 @item frequency, f
2780 Set the filter's central frequency and so can be used
2781 to extend or reduce the frequency range to be boosted or cut.
2782 The default value is @code{3000} Hz.
2783
2784 @item width_type
2785 Set method to specify band-width of filter.
2786 @table @option
2787 @item h
2788 Hz
2789 @item q
2790 Q-Factor
2791 @item o
2792 octave
2793 @item s
2794 slope
2795 @end table
2796
2797 @item width, w
2798 Determine how steep is the filter's shelf transition.
2799 @end table
2800
2801 @section tremolo
2802
2803 Sinusoidal amplitude modulation.
2804
2805 The filter accepts the following options:
2806
2807 @table @option
2808 @item f
2809 Modulation frequency in Hertz. Modulation frequencies in the subharmonic range
2810 (20 Hz or lower) will result in a tremolo effect.
2811 This filter may also be used as a ring modulator by specifying
2812 a modulation frequency higher than 20 Hz.
2813 Range is 0.1 - 20000.0. Default value is 5.0 Hz.
2814
2815 @item d
2816 Depth of modulation as a percentage. Range is 0.0 - 1.0.
2817 Default value is 0.5.
2818 @end table
2819
2820 @section vibrato
2821
2822 Sinusoidal phase modulation.
2823
2824 The filter accepts the following options:
2825
2826 @table @option
2827 @item f
2828 Modulation frequency in Hertz.
2829 Range is 0.1 - 20000.0. Default value is 5.0 Hz.
2830
2831 @item d
2832 Depth of modulation as a percentage. Range is 0.0 - 1.0.
2833 Default value is 0.5.
2834 @end table
2835
2836 @section volume
2837
2838 Adjust the input audio volume.
2839
2840 It accepts the following parameters:
2841 @table @option
2842
2843 @item volume
2844 Set audio volume expression.
2845
2846 Output values are clipped to the maximum value.
2847
2848 The output audio volume is given by the relation:
2849 @example
2850 @var{output_volume} = @var{volume} * @var{input_volume}
2851 @end example
2852
2853 The default value for @var{volume} is "1.0".
2854
2855 @item precision
2856 This parameter represents the mathematical precision.
2857
2858 It determines which input sample formats will be allowed, which affects the
2859 precision of the volume scaling.
2860
2861 @table @option
2862 @item fixed
2863 8-bit fixed-point; this limits input sample format to U8, S16, and S32.
2864 @item float
2865 32-bit floating-point; this limits input sample format to FLT. (default)
2866 @item double
2867 64-bit floating-point; this limits input sample format to DBL.
2868 @end table
2869
2870 @item replaygain
2871 Choose the behaviour on encountering ReplayGain side data in input frames.
2872
2873 @table @option
2874 @item drop
2875 Remove ReplayGain side data, ignoring its contents (the default).
2876
2877 @item ignore
2878 Ignore ReplayGain side data, but leave it in the frame.
2879
2880 @item track
2881 Prefer the track gain, if present.
2882
2883 @item album
2884 Prefer the album gain, if present.
2885 @end table
2886
2887 @item replaygain_preamp
2888 Pre-amplification gain in dB to apply to the selected replaygain gain.
2889
2890 Default value for @var{replaygain_preamp} is 0.0.
2891
2892 @item eval
2893 Set when the volume expression is evaluated.
2894
2895 It accepts the following values:
2896 @table @samp
2897 @item once
2898 only evaluate expression once during the filter initialization, or
2899 when the @samp{volume} command is sent
2900
2901 @item frame
2902 evaluate expression for each incoming frame
2903 @end table
2904
2905 Default value is @samp{once}.
2906 @end table
2907
2908 The volume expression can contain the following parameters.
2909
2910 @table @option
2911 @item n
2912 frame number (starting at zero)
2913 @item nb_channels
2914 number of channels
2915 @item nb_consumed_samples
2916 number of samples consumed by the filter
2917 @item nb_samples
2918 number of samples in the current frame
2919 @item pos
2920 original frame position in the file
2921 @item pts
2922 frame PTS
2923 @item sample_rate
2924 sample rate
2925 @item startpts
2926 PTS at start of stream
2927 @item startt
2928 time at start of stream
2929 @item t
2930 frame time
2931 @item tb
2932 timestamp timebase
2933 @item volume
2934 last set volume value
2935 @end table
2936
2937 Note that when @option{eval} is set to @samp{once} only the
2938 @var{sample_rate} and @var{tb} variables are available, all other
2939 variables will evaluate to NAN.
2940
2941 @subsection Commands
2942
2943 This filter supports the following commands:
2944 @table @option
2945 @item volume
2946 Modify the volume expression.
2947 The command accepts the same syntax of the corresponding option.
2948
2949 If the specified expression is not valid, it is kept at its current
2950 value.
2951 @item replaygain_noclip
2952 Prevent clipping by limiting the gain applied.
2953
2954 Default value for @var{replaygain_noclip} is 1.
2955
2956 @end table
2957
2958 @subsection Examples
2959
2960 @itemize
2961 @item
2962 Halve the input audio volume:
2963 @example
2964 volume=volume=0.5
2965 volume=volume=1/2
2966 volume=volume=-6.0206dB
2967 @end example
2968
2969 In all the above example the named key for @option{volume} can be
2970 omitted, for example like in:
2971 @example
2972 volume=0.5
2973 @end example
2974
2975 @item
2976 Increase input audio power by 6 decibels using fixed-point precision:
2977 @example
2978 volume=volume=6dB:precision=fixed
2979 @end example
2980
2981 @item
2982 Fade volume after time 10 with an annihilation period of 5 seconds:
2983 @example
2984 volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
2985 @end example
2986 @end itemize
2987
2988 @section volumedetect
2989
2990 Detect the volume of the input video.
2991
2992 The filter has no parameters. The input is not modified. Statistics about
2993 the volume will be printed in the log when the input stream end is reached.
2994
2995 In particular it will show the mean volume (root mean square), maximum
2996 volume (on a per-sample basis), and the beginning of a histogram of the
2997 registered volume values (from the maximum value to a cumulated 1/1000 of
2998 the samples).
2999
3000 All volumes are in decibels relative to the maximum PCM value.
3001
3002 @subsection Examples
3003
3004 Here is an excerpt of the output:
3005 @example
3006 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
3007 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
3008 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
3009 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
3010 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
3011 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
3012 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
3013 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
3014 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
3015 @end example
3016
3017 It means that:
3018 @itemize
3019 @item
3020 The mean square energy is approximately -27 dB, or 10^-2.7.
3021 @item
3022 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
3023 @item
3024 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
3025 @end itemize
3026
3027 In other words, raising the volume by +4 dB does not cause any clipping,
3028 raising it by +5 dB causes clipping for 6 samples, etc.
3029
3030 @c man end AUDIO FILTERS
3031
3032 @chapter Audio Sources
3033 @c man begin AUDIO SOURCES
3034
3035 Below is a description of the currently available audio sources.
3036
3037 @section abuffer
3038
3039 Buffer audio frames, and make them available to the filter chain.
3040
3041 This source is mainly intended for a programmatic use, in particular
3042 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
3043
3044 It accepts the following parameters:
3045 @table @option
3046
3047 @item time_base
3048 The timebase which will be used for timestamps of submitted frames. It must be
3049 either a floating-point number or in @var{numerator}/@var{denominator} form.
3050
3051 @item sample_rate
3052 The sample rate of the incoming audio buffers.
3053
3054 @item sample_fmt
3055 The sample format of the incoming audio buffers.
3056 Either a sample format name or its corresponding integer representation from
3057 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
3058
3059 @item channel_layout
3060 The channel layout of the incoming audio buffers.
3061 Either a channel layout name from channel_layout_map in
3062 @file{libavutil/channel_layout.c} or its corresponding integer representation
3063 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
3064
3065 @item channels
3066 The number of channels of the incoming audio buffers.
3067 If both @var{channels} and @var{channel_layout} are specified, then they
3068 must be consistent.
3069
3070 @end table
3071
3072 @subsection Examples
3073
3074 @example
3075 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
3076 @end example
3077
3078 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
3079 Since the sample format with name "s16p" corresponds to the number
3080 6 and the "stereo" channel layout corresponds to the value 0x3, this is
3081 equivalent to:
3082 @example
3083 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
3084 @end example
3085
3086 @section aevalsrc
3087
3088 Generate an audio signal specified by an expression.
3089
3090 This source accepts in input one or more expressions (one for each
3091 channel), which are evaluated and used to generate a corresponding
3092 audio signal.
3093
3094 This source accepts the following options:
3095
3096 @table @option
3097 @item exprs
3098 Set the '|'-separated expressions list for each separate channel. In case the
3099 @option{channel_layout} option is not specified, the selected channel layout
3100 depends on the number of provided expressions. Otherwise the last
3101 specified expression is applied to the remaining output channels.
3102
3103 @item channel_layout, c
3104 Set the channel layout. The number of channels in the specified layout
3105 must be equal to the number of specified expressions.
3106
3107 @item duration, d
3108 Set the minimum duration of the sourced audio. See
3109 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
3110 for the accepted syntax.
3111 Note that the resulting duration may be greater than the specified
3112 duration, as the generated audio is always cut at the end of a
3113 complete frame.
3114
3115 If not specified, or the expressed duration is negative, the audio is
3116 supposed to be generated forever.
3117
3118 @item nb_samples, n
3119 Set the number of samples per channel per each output frame,
3120 default to 1024.
3121
3122 @item sample_rate, s
3123 Specify the sample rate, default to 44100.
3124 @end table
3125
3126 Each expression in @var{exprs} can contain the following constants:
3127
3128 @table @option
3129 @item n
3130 number of the evaluated sample, starting from 0
3131
3132 @item t
3133 time of the evaluated sample expressed in seconds, starting from 0
3134
3135 @item s
3136 sample rate
3137
3138 @end table
3139
3140 @subsection Examples
3141
3142 @itemize
3143 @item
3144 Generate silence:
3145 @example
3146 aevalsrc=0
3147 @end example
3148
3149 @item
3150 Generate a sin signal with frequency of 440 Hz, set sample rate to
3151 8000 Hz:
3152 @example
3153 aevalsrc="sin(440*2*PI*t):s=8000"
3154 @end example
3155
3156 @item
3157 Generate a two channels signal, specify the channel layout (Front
3158 Center + Back Center) explicitly:
3159 @example
3160 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
3161 @end example
3162
3163 @item
3164 Generate white noise:
3165 @example
3166 aevalsrc="-2+random(0)"
3167 @end example
3168
3169 @item
3170 Generate an amplitude modulated signal:
3171 @example
3172 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
3173 @end example
3174
3175 @item
3176 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
3177 @example
3178 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
3179 @end example
3180
3181 @end itemize
3182
3183 @section anullsrc
3184
3185 The null audio source, return unprocessed audio frames. It is mainly useful
3186 as a template and to be employed in analysis / debugging tools, or as
3187 the source for filters which ignore the input data (for example the sox
3188 synth filter).
3189
3190 This source accepts the following options:
3191
3192 @table @option
3193
3194 @item channel_layout, cl
3195
3196 Specifies the channel layout, and can be either an integer or a string
3197 representing a channel layout. The default value of @var{channel_layout}
3198 is "stereo".
3199
3200 Check the channel_layout_map definition in
3201 @file{libavutil/channel_layout.c} for the mapping between strings and
3202 channel layout values.
3203
3204 @item sample_rate, r
3205 Specifies the sample rate, and defaults to 44100.
3206
3207 @item nb_samples, n
3208 Set the number of samples per requested frames.
3209
3210 @end table
3211
3212 @subsection Examples
3213
3214 @itemize
3215 @item
3216 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
3217 @example
3218 anullsrc=r=48000:cl=4
3219 @end example
3220
3221 @item
3222 Do the same operation with a more obvious syntax:
3223 @example
3224 anullsrc=r=48000:cl=mono
3225 @end example
3226 @end itemize
3227
3228 All the parameters need to be explicitly defined.
3229
3230 @section flite
3231
3232 Synthesize a voice utterance using the libflite library.
3233
3234 To enable compilation of this filter you need to configure FFmpeg with
3235 @code{--enable-libflite}.
3236
3237 Note that the flite library is not thread-safe.
3238
3239 The filter accepts the following options:
3240
3241 @table @option
3242
3243 @item list_voices
3244 If set to 1, list the names of the available voices and exit
3245 immediately. Default value is 0.
3246
3247 @item nb_samples, n
3248 Set the maximum number of samples per frame. Default value is 512.
3249
3250 @item textfile
3251 Set the filename containing the text to speak.
3252
3253 @item text
3254 Set the text to speak.
3255
3256 @item voice, v
3257 Set the voice to use for the speech synthesis. Default value is
3258 @code{kal}. See also the @var{list_voices} option.
3259 @end table
3260
3261 @subsection Examples
3262
3263 @itemize
3264 @item
3265 Read from file @file{speech.txt}, and synthesize the text using the
3266 standard flite voice:
3267 @example
3268 flite=textfile=speech.txt
3269 @end example
3270
3271 @item
3272 Read the specified text selecting the @code{slt} voice:
3273 @example
3274 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
3275 @end example
3276
3277 @item
3278 Input text to ffmpeg:
3279 @example
3280 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
3281 @end example
3282
3283 @item
3284 Make @file{ffplay} speak the specified text, using @code{flite} and
3285 the @code{lavfi} device:
3286 @example
3287 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
3288 @end example
3289 @end itemize
3290
3291 For more information about libflite, check:
3292 @url{http://www.speech.cs.cmu.edu/flite/}
3293
3294 @section anoisesrc
3295
3296 Generate a noise audio signal.
3297
3298 The filter accepts the following options:
3299
3300 @table @option
3301 @item sample_rate, r
3302 Specify the sample rate. Default value is 48000 Hz.
3303
3304 @item amplitude, a
3305 Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value
3306 is 1.0.
3307
3308 @item duration, d
3309 Specify the duration of the generated audio stream. Not specifying this option
3310 results in noise with an infinite length.
3311
3312 @item color, colour, c
3313 Specify the color of noise. Available noise colors are white, pink, and brown.
3314 Default color is white.
3315
3316 @item seed, s
3317 Specify a value used to seed the PRNG.
3318
3319 @item nb_samples, n
3320 Set the number of samples per each output frame, default is 1024.
3321 @end table
3322
3323 @subsection Examples
3324
3325 @itemize
3326
3327 @item
3328 Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5:
3329 @example
3330 anoisesrc=d=60:c=pink:r=44100:a=0.5
3331 @end example
3332 @end itemize
3333
3334 @section sine
3335
3336 Generate an audio signal made of a sine wave with amplitude 1/8.
3337
3338 The audio signal is bit-exact.
3339
3340 The filter accepts the following options:
3341
3342 @table @option
3343
3344 @item frequency, f
3345 Set the carrier frequency. Default is 440 Hz.
3346
3347 @item beep_factor, b
3348 Enable a periodic beep every second with frequency @var{beep_factor} times
3349 the carrier frequency. Default is 0, meaning the beep is disabled.
3350
3351 @item sample_rate, r
3352 Specify the sample rate, default is 44100.
3353
3354 @item duration, d
3355 Specify the duration of the generated audio stream.
3356
3357 @item samples_per_frame
3358 Set the number of samples per output frame.
3359
3360 The expression can contain the following constants:
3361
3362 @table @option
3363 @item n
3364 The (sequential) number of the output audio frame, starting from 0.
3365
3366 @item pts
3367 The PTS (Presentation TimeStamp) of the output audio frame,
3368 expressed in @var{TB} units.
3369
3370 @item t
3371 The PTS of the output audio frame, expressed in seconds.
3372
3373 @item TB
3374 The timebase of the output audio frames.
3375 @end table
3376
3377 Default is @code{1024}.
3378 @end table
3379
3380 @subsection Examples
3381
3382 @itemize
3383
3384 @item
3385 Generate a simple 440 Hz sine wave:
3386 @example
3387 sine
3388 @end example
3389
3390 @item
3391 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
3392 @example
3393 sine=220:4:d=5
3394 sine=f=220:b=4:d=5
3395 sine=frequency=220:beep_factor=4:duration=5
3396 @end example
3397
3398 @item
3399 Generate a 1 kHz sine wave following @code{1602,1601,1602,1601,1602} NTSC
3400 pattern:
3401 @example
3402 sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
3403 @end example
3404 @end itemize
3405
3406 @c man end AUDIO SOURCES
3407
3408 @chapter Audio Sinks
3409 @c man begin AUDIO SINKS
3410
3411 Below is a description of the currently available audio sinks.
3412
3413 @section abuffersink
3414
3415 Buffer audio frames, and make them available to the end of filter chain.
3416
3417 This sink is mainly intended for programmatic use, in particular
3418 through the interface defined in @file{libavfilter/buffersink.h}
3419 or the options system.
3420
3421 It accepts a pointer to an AVABufferSinkContext structure, which
3422 defines the incoming buffers' formats, to be passed as the opaque
3423 parameter to @code{avfilter_init_filter} for initialization.
3424 @section anullsink
3425
3426 Null audio sink; do absolutely nothing with the input audio. It is
3427 mainly useful as a template and for use in analysis / debugging
3428 tools.
3429
3430 @c man end AUDIO SINKS
3431
3432 @chapter Video Filters
3433 @c man begin VIDEO FILTERS
3434
3435 When you configure your FFmpeg build, you can disable any of the
3436 existing filters using @code{--disable-filters}.
3437 The configure output will show the video filters included in your
3438 build.
3439
3440 Below is a description of the currently available video filters.
3441
3442 @section alphaextract
3443
3444 Extract the alpha component from the input as a grayscale video. This
3445 is especially useful with the @var{alphamerge} filter.
3446
3447 @section alphamerge
3448
3449 Add or replace the alpha component of the primary input with the
3450 grayscale value of a second input. This is intended for use with
3451 @var{alphaextract} to allow the transmission or storage of frame
3452 sequences that have alpha in a format that doesn't support an alpha
3453 channel.
3454
3455 For example, to reconstruct full frames from a normal YUV-encoded video
3456 and a separate video created with @var{alphaextract}, you might use:
3457 @example
3458 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
3459 @end example
3460
3461 Since this filter is designed for reconstruction, it operates on frame
3462 sequences without considering timestamps, and terminates when either
3463 input reaches end of stream. This will cause problems if your encoding
3464 pipeline drops frames. If you're trying to apply an image as an
3465 overlay to a video stream, consider the @var{overlay} filter instead.
3466
3467 @section ass
3468
3469 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
3470 and libavformat to work. On the other hand, it is limited to ASS (Advanced
3471 Substation Alpha) subtitles files.
3472
3473 This filter accepts the following option in addition to the common options from
3474 the @ref{subtitles} filter:
3475
3476 @table @option
3477 @item shaping
3478 Set the shaping engine
3479
3480 Available values are:
3481 @table @samp
3482 @item auto
3483 The default libass shaping engine, which is the best available.
3484 @item simple
3485 Fast, font-agnostic shaper that can do only substitutions
3486 @item complex
3487 Slower shaper using OpenType for substitutions and positioning
3488 @end table
3489
3490 The default is @code{auto}.
3491 @end table
3492
3493 @section atadenoise
3494 Apply an Adaptive Temporal Averaging Denoiser to the video input.
3495
3496 The filter accepts the following options:
3497
3498 @table @option
3499 @item 0a
3500 Set threshold A for 1st plane. Default is 0.02.
3501 Valid range is 0 to 0.3.
3502
3503 @item 0b
3504 Set threshold B for 1st plane. Default is 0.04.
3505 Valid range is 0 to 5.
3506
3507 @item 1a
3508 Set threshold A for 2nd plane. Default is 0.02.
3509 Valid range is 0 to 0.3.
3510
3511 @item 1b
3512 Set threshold B for 2nd plane. Default is 0.04.
3513 Valid range is 0 to 5.
3514
3515 @item 2a
3516 Set threshold A for 3rd plane. Default is 0.02.
3517 Valid range is 0 to 0.3.
3518
3519 @item 2b
3520 Set threshold B for 3rd plane. Default is 0.04.
3521 Valid range is 0 to 5.
3522
3523 Threshold A is designed to react on abrupt changes in the input signal and
3524 threshold B is designed to react on continuous changes in the input signal.
3525
3526 @item s
3527 Set number of frames filter will use for averaging. Default is 33. Must be odd
3528 number in range [5, 129].
3529 @end table
3530
3531 @section bbox
3532
3533 Compute the bounding box for the non-black pixels in the input frame
3534 luminance plane.
3535
3536 This filter computes the bounding box containing all the pixels with a
3537 luminance value greater than the minimum allowed value.
3538 The parameters describing the bounding box are printed on the filter
3539 log.
3540
3541 The filter accepts the following option:
3542
3543 @table @option
3544 @item min_val
3545 Set the minimal luminance value. Default is @code{16}.
3546 @end table
3547
3548 @section blackdetect
3549
3550 Detect video intervals that are (almost) completely black. Can be
3551 useful to detect chapter transitions, commercials, or invalid
3552 recordings. Output lines contains the time for the start, end and
3553 duration of the detected black interval expressed in seconds.
3554
3555 In order to display the output lines, you need to set the loglevel at
3556 least to the AV_LOG_INFO value.
3557
3558 The filter accepts the following options:
3559
3560 @table @option
3561 @item black_min_duration, d
3562 Set the minimum detected black duration expressed in seconds. It must
3563 be a non-negative floating point number.
3564
3565 Default value is 2.0.
3566
3567 @item picture_black_ratio_th, pic_th
3568 Set the threshold for considering a picture "black".
3569 Express the minimum value for the ratio:
3570 @example
3571 @var{nb_black_pixels} / @var{nb_pixels}
3572 @end example
3573
3574 for which a picture is considered black.
3575 Default value is 0.98.
3576
3577 @item pixel_black_th, pix_th
3578 Set the threshold for considering a pixel "black".
3579
3580 The threshold expresses the maximum pixel luminance value for which a
3581 pixel is considered "black". The provided value is scaled according to
3582 the following equation:
3583 @example
3584 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
3585 @end example
3586
3587 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
3588 the input video format, the range is [0-255] for YUV full-range
3589 formats and [16-235] for YUV non full-range formats.
3590
3591 Default value is 0.10.
3592 @end table
3593
3594 The following example sets the maximum pixel threshold to the minimum
3595 value, and detects only black intervals of 2 or more seconds:
3596 @example
3597 blackdetect=d=2:pix_th=0.00
3598 @end example
3599
3600 @section blackframe
3601
3602 Detect frames that are (almost) completely black. Can be useful to
3603 detect chapter transitions or commercials. Output lines consist of
3604 the frame number of the detected frame, the percentage of blackness,
3605 the position in the file if known or -1 and the timestamp in seconds.
3606
3607 In order to display the output lines, you need to set the loglevel at
3608 least to the AV_LOG_INFO value.
3609
3610 It accepts the following parameters:
3611
3612 @table @option
3613
3614 @item amount
3615 The percentage of the pixels that have to be below the threshold; it defaults to
3616 @code{98}.
3617
3618 @item threshold, thresh
3619 The threshold below which a pixel value is considered black; it defaults to
3620 @code{32}.
3621
3622 @end table
3623
3624 @section blend, tblend
3625
3626 Blend two video frames into each other.
3627
3628 The @code{blend} filter takes two input streams and outputs one
3629 stream, the first input is the "top" layer and second input is
3630 "bottom" layer.  Output terminates when shortest input terminates.
3631
3632 The @code{tblend} (time blend) filter takes two consecutive frames
3633 from one single stream, and outputs the result obtained by blending
3634 the new frame on top of the old frame.
3635
3636 A description of the accepted options follows.
3637
3638 @table @option
3639 @item c0_mode
3640 @item c1_mode
3641 @item c2_mode
3642 @item c3_mode
3643 @item all_mode
3644 Set blend mode for specific pixel component or all pixel components in case
3645 of @var{all_mode}. Default value is @code{normal}.
3646
3647 Available values for component modes are:
3648 @table @samp
3649 @item addition
3650 @item addition128
3651 @item and
3652 @item average
3653 @item burn
3654 @item darken
3655 @item difference
3656 @item difference128
3657 @item divide
3658 @item dodge
3659 @item exclusion
3660 @item glow
3661 @item hardlight
3662 @item hardmix
3663 @item lighten
3664 @item linearlight
3665 @item multiply
3666 @item negation
3667 @item normal
3668 @item or
3669 @item overlay
3670 @item phoenix
3671 @item pinlight
3672 @item reflect
3673 @item screen
3674 @item softlight
3675 @item subtract
3676 @item vividlight
3677 @item xor
3678 @end table
3679
3680 @item c0_opacity
3681 @item c1_opacity
3682 @item c2_opacity
3683 @item c3_opacity
3684 @item all_opacity
3685 Set blend opacity for specific pixel component or all pixel components in case
3686 of @var{all_opacity}. Only used in combination with pixel component blend modes.
3687
3688 @item c0_expr
3689 @item c1_expr
3690 @item c2_expr
3691 @item c3_expr
3692 @item all_expr
3693 Set blend expression for specific pixel component or all pixel components in case
3694 of @var{all_expr}. Note that related mode options will be ignored if those are set.
3695
3696 The expressions can use the following variables:
3697
3698 @table @option
3699 @item N
3700 The sequential number of the filtered frame, starting from @code{0}.
3701
3702 @item X
3703 @item Y
3704 the coordinates of the current sample
3705
3706 @item W
3707 @item H
3708 the width and height of currently filtered plane
3709
3710 @item SW
3711 @item SH
3712 Width and height scale depending on the currently filtered plane. It is the
3713 ratio between the corresponding luma plane number of pixels and the current
3714 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
3715 @code{0.5,0.5} for chroma planes.
3716
3717 @item T
3718 Time of the current frame, expressed in seconds.
3719
3720 @item TOP, A
3721 Value of pixel component at current location for first video frame (top layer).
3722
3723 @item BOTTOM, B
3724 Value of pixel component at current location for second video frame (bottom layer).
3725 @end table
3726
3727 @item shortest
3728 Force termination when the shortest input terminates. Default is
3729 @code{0}. This option is only defined for the @code{blend} filter.
3730
3731 @item repeatlast
3732 Continue applying the last bottom frame after the end of the stream. A value of
3733 @code{0} disable the filter after the last frame of the bottom layer is reached.
3734 Default is @code{1}. This option is only defined for the @code{blend} filter.
3735 @end table
3736
3737 @subsection Examples
3738
3739 @itemize
3740 @item
3741 Apply transition from bottom layer to top layer in first 10 seconds:
3742 @example
3743 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
3744 @end example
3745
3746 @item
3747 Apply 1x1 checkerboard effect:
3748 @example
3749 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
3750 @end example
3751
3752 @item
3753 Apply uncover left effect:
3754 @example
3755 blend=all_expr='if(gte(N*SW+X,W),A,B)'
3756 @end example
3757
3758 @item
3759 Apply uncover down effect:
3760 @example
3761 blend=all_expr='if(gte(Y-N*SH,0),A,B)'
3762 @end example
3763
3764 @item
3765 Apply uncover up-left effect:
3766 @example
3767 blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
3768 @end example
3769
3770 @item
3771 Display differences between the current and the previous frame:
3772 @example
3773 tblend=all_mode=difference128
3774 @end example
3775 @end itemize
3776
3777 @section boxblur
3778
3779 Apply a boxblur algorithm to the input video.
3780
3781 It accepts the following parameters:
3782
3783 @table @option
3784
3785 @item luma_radius, lr
3786 @item luma_power, lp
3787 @item chroma_radius, cr
3788 @item chroma_power, cp
3789 @item alpha_radius, ar
3790 @item alpha_power, ap
3791
3792 @end table
3793
3794 A description of the accepted options follows.
3795
3796 @table @option
3797 @item luma_radius, lr
3798 @item chroma_radius, cr
3799 @item alpha_radius, ar
3800 Set an expression for the box radius in pixels used for blurring the
3801 corresponding input plane.
3802
3803 The radius value must be a non-negative number, and must not be
3804 greater than the value of the expression @code{min(w,h)/2} for the
3805 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
3806 planes.
3807
3808 Default value for @option{luma_radius} is "2". If not specified,
3809 @option{chroma_radius} and @option{alpha_radius} default to the
3810 corresponding value set for @option{luma_radius}.
3811
3812 The expressions can contain the following constants:
3813 @table @option
3814 @item w
3815 @item h
3816 The input width and height in pixels.
3817
3818 @item cw
3819 @item ch
3820 The input chroma image width and height in pixels.
3821
3822 @item hsub
3823 @item vsub
3824 The horizontal and vertical chroma subsample values. For example, for the
3825 pixel format "yuv422p", @var{hsub} is 2 and @var{vsub} is 1.
3826 @end table
3827
3828 @item luma_power, lp
3829 @item chroma_power, cp
3830 @item alpha_power, ap
3831 Specify how many times the boxblur filter is applied to the
3832 corresponding plane.
3833
3834 Default value for @option{luma_power} is 2. If not specified,
3835 @option{chroma_power} and @option{alpha_power} default to the
3836 corresponding value set for @option{luma_power}.
3837
3838 A value of 0 will disable the effect.
3839 @end table
3840
3841 @subsection Examples
3842
3843 @itemize
3844 @item
3845 Apply a boxblur filter with the luma, chroma, and alpha radii
3846 set to 2:
3847 @example
3848 boxblur=luma_radius=2:luma_power=1
3849 boxblur=2:1
3850 @end example
3851
3852 @item
3853 Set the luma radius to 2, and alpha and chroma radius to 0:
3854 @example
3855 boxblur=2:1:cr=0:ar=0
3856 @end example
3857
3858 @item
3859 Set the luma and chroma radii to a fraction of the video dimension:
3860 @example
3861 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
3862 @end example
3863 @end itemize
3864
3865 @section chromakey
3866 YUV colorspace color/chroma keying.
3867
3868 The filter accepts the following options:
3869
3870 @table @option
3871 @item color
3872 The color which will be replaced with transparency.
3873
3874 @item similarity
3875 Similarity percentage with the key color.
3876
3877 0.01 matches only the exact key color, while 1.0 matches everything.
3878
3879 @item blend
3880 Blend percentage.
3881
3882 0.0 makes pixels either fully transparent, or not transparent at all.
3883
3884 Higher values result in semi-transparent pixels, with a higher transparency
3885 the more similar the pixels color is to the key color.
3886
3887 @item yuv
3888 Signals that the color passed is already in YUV instead of RGB.
3889
3890 Litteral colors like "green" or "red" don't make sense with this enabled anymore.
3891 This can be used to pass exact YUV values as hexadecimal numbers.
3892 @end table
3893
3894 @subsection Examples
3895
3896 @itemize
3897 @item
3898 Make every green pixel in the input image transparent:
3899 @example
3900 ffmpeg -i input.png -vf chromakey=green out.png
3901 @end example
3902
3903 @item
3904 Overlay a greenscreen-video on top of a static black background.
3905 @example
3906 ffmpeg -f lavfi -i color=c=black:s=1280x720 -i video.mp4 -shortest -filter_complex "[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.mkv
3907 @end example
3908 @end itemize
3909
3910 @section codecview
3911
3912 Visualize information exported by some codecs.
3913
3914 Some codecs can export information through frames using side-data or other
3915 means. For example, some MPEG based codecs export motion vectors through the
3916 @var{export_mvs} flag in the codec @option{flags2} option.
3917
3918 The filter accepts the following option:
3919
3920 @table @option
3921 @item mv
3922 Set motion vectors to visualize.
3923
3924 Available flags for @var{mv} are:
3925
3926 @table @samp
3927 @item pf
3928 forward predicted MVs of P-frames
3929 @item bf
3930 forward predicted MVs of B-frames
3931 @item bb
3932 backward predicted MVs of B-frames
3933 @end table
3934 @end table
3935
3936 @subsection Examples
3937
3938 @itemize
3939 @item
3940 Visualizes multi-directionals MVs from P and B-Frames using @command{ffplay}:
3941 @example
3942 ffplay -flags2 +export_mvs input.mpg -vf codecview=mv=pf+bf+bb
3943 @end example
3944 @end itemize
3945
3946 @section colorbalance
3947 Modify intensity of primary colors (red, green and blue) of input frames.
3948
3949 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
3950 regions for the red-cyan, green-magenta or blue-yellow balance.
3951
3952 A positive adjustment value shifts the balance towards the primary color, a negative
3953 value towards the complementary color.
3954
3955 The filter accepts the following options:
3956
3957 @table @option
3958 @item rs
3959 @item gs
3960 @item bs
3961 Adjust red, green and blue shadows (darkest pixels).
3962
3963 @item rm
3964 @item gm
3965 @item bm
3966 Adjust red, green and blue midtones (medium pixels).
3967
3968 @item rh
3969 @item gh
3970 @item bh
3971 Adjust red, green and blue highlights (brightest pixels).
3972
3973 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3974 @end table
3975
3976 @subsection Examples
3977
3978 @itemize
3979 @item
3980 Add red color cast to shadows:
3981 @example
3982 colorbalance=rs=.3
3983 @end example
3984 @end itemize
3985
3986 @section colorkey
3987 RGB colorspace color keying.
3988
3989 The filter accepts the following options:
3990
3991 @table @option
3992 @item color
3993 The color which will be replaced with transparency.
3994
3995 @item similarity
3996 Similarity percentage with the key color.
3997
3998 0.01 matches only the exact key color, while 1.0 matches everything.
3999
4000 @item blend
4001 Blend percentage.
4002
4003 0.0 makes pixels either fully transparent, or not transparent at all.
4004
4005 Higher values result in semi-transparent pixels, with a higher transparency
4006 the more similar the pixels color is to the key color.
4007 @end table
4008
4009 @subsection Examples
4010
4011 @itemize
4012 @item
4013 Make every green pixel in the input image transparent:
4014 @example
4015 ffmpeg -i input.png -vf colorkey=green out.png
4016 @end example
4017
4018 @item
4019 Overlay a greenscreen-video on top of a static background image.
4020 @example
4021 ffmpeg -i background.png -i video.mp4 -filter_complex "[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.flv
4022 @end example
4023 @end itemize
4024
4025 @section colorlevels
4026
4027 Adjust video input frames using levels.
4028
4029 The filter accepts the following options:
4030
4031 @table @option
4032 @item rimin
4033 @item gimin
4034 @item bimin
4035 @item aimin
4036 Adjust red, green, blue and alpha input black point.
4037 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
4038
4039 @item rimax
4040 @item gimax
4041 @item bimax
4042 @item aimax
4043 Adjust red, green, blue and alpha input white point.
4044 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{1}.
4045
4046 Input levels are used to lighten highlights (bright tones), darken shadows
4047 (dark tones), change the balance of bright and dark tones.
4048
4049 @item romin
4050 @item gomin
4051 @item bomin
4052 @item aomin
4053 Adjust red, green, blue and alpha output black point.
4054 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{0}.
4055
4056 @item romax
4057 @item gomax
4058 @item bomax
4059 @item aomax
4060 Adjust red, green, blue and alpha output white point.
4061 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{1}.
4062
4063 Output levels allows manual selection of a constrained output level range.
4064 @end table
4065
4066 @subsection Examples
4067
4068 @itemize
4069 @item
4070 Make video output darker:
4071 @example
4072 colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
4073 @end example
4074
4075 @item
4076 Increase contrast:
4077 @example
4078 colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
4079 @end example
4080
4081 @item
4082 Make video output lighter:
4083 @example
4084 colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
4085 @end example
4086
4087 @item
4088 Increase brightness:
4089 @example
4090 colorlevels=romin=0.5:gomin=0.5:bomin=0.5
4091 @end example
4092 @end itemize
4093
4094 @section colorchannelmixer
4095
4096 Adjust video input frames by re-mixing color channels.
4097
4098 This filter modifies a color channel by adding the values associated to
4099 the other channels of the same pixels. For example if the value to
4100 modify is red, the output value will be:
4101 @example
4102 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
4103 @end example
4104
4105 The filter accepts the following options:
4106
4107 @table @option
4108 @item rr
4109 @item rg
4110 @item rb
4111 @item ra
4112 Adjust contribution of input red, green, blue and alpha channels for output red channel.
4113 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
4114
4115 @item gr
4116 @item gg
4117 @item gb
4118 @item ga
4119 Adjust contribution of input red, green, blue and alpha channels for output green channel.
4120 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
4121
4122 @item br
4123 @item bg
4124 @item bb
4125 @item ba
4126 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
4127 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
4128
4129 @item ar
4130 @item ag
4131 @item ab
4132 @item aa
4133 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
4134 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
4135
4136 Allowed ranges for options are @code{[-2.0, 2.0]}.
4137 @end table
4138
4139 @subsection Examples
4140
4141 @itemize
4142 @item
4143 Convert source to grayscale:
4144 @example
4145 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
4146 @end example
4147 @item
4148 Simulate sepia tones:
4149 @example
4150 colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
4151 @end example
4152 @end itemize
4153
4154 @section colormatrix
4155
4156 Convert color matrix.
4157
4158 The filter accepts the following options:
4159
4160 @table @option
4161 @item src
4162 @item dst
4163 Specify the source and destination color matrix. Both values must be
4164 specified.
4165
4166 The accepted values are:
4167 @table @samp
4168 @item bt709
4169 BT.709
4170
4171 @item bt601
4172 BT.601
4173
4174 @item smpte240m
4175 SMPTE-240M
4176
4177 @item fcc
4178 FCC
4179 @end table
4180 @end table
4181
4182 For example to convert from BT.601 to SMPTE-240M, use the command:
4183 @example
4184 colormatrix=bt601:smpte240m
4185 @end example
4186
4187 @section copy
4188
4189 Copy the input source unchanged to the output. This is mainly useful for
4190 testing purposes.
4191
4192 @section crop
4193
4194 Crop the input video to given dimensions.
4195
4196 It accepts the following parameters:
4197
4198 @table @option
4199 @item w, out_w
4200 The width of the output video. It defaults to @code{iw}.
4201 This expression is evaluated only once during the filter
4202 configuration, or when the @samp{w} or @samp{out_w} command is sent.
4203
4204 @item h, out_h
4205 The height of the output video. It defaults to @code{ih}.
4206 This expression is evaluated only once during the filter
4207 configuration, or when the @samp{h} or @samp{out_h} command is sent.
4208
4209 @item x
4210 The horizontal position, in the input video, of the left edge of the output
4211 video. It defaults to @code{(in_w-out_w)/2}.
4212 This expression is evaluated per-frame.
4213
4214 @item y
4215 The vertical position, in the input video, of the top edge of the output video.
4216 It defaults to @code{(in_h-out_h)/2}.
4217 This expression is evaluated per-frame.
4218
4219 @item keep_aspect
4220 If set to 1 will force the output display aspect ratio
4221 to be the same of the input, by changing the output sample aspect
4222 ratio. It defaults to 0.
4223 @end table
4224
4225 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
4226 expressions containing the following constants:
4227
4228 @table @option
4229 @item x
4230 @item y
4231 The computed values for @var{x} and @var{y}. They are evaluated for
4232 each new frame.
4233
4234 @item in_w
4235 @item in_h
4236 The input width and height.
4237
4238 @item iw
4239 @item ih
4240 These are the same as @var{in_w} and @var{in_h}.
4241
4242 @item out_w
4243 @item out_h
4244 The output (cropped) width and height.
4245
4246 @item ow
4247 @item oh
4248 These are the same as @var{out_w} and @var{out_h}.
4249
4250 @item a
4251 same as @var{iw} / @var{ih}
4252
4253 @item sar
4254 input sample aspect ratio
4255
4256 @item dar
4257 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
4258
4259 @item hsub
4260 @item vsub
4261 horizontal and vertical chroma subsample values. For example for the
4262 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4263
4264 @item n
4265 The number of the input frame, starting from 0.
4266
4267 @item pos
4268 the position in the file of the input frame, NAN if unknown
4269
4270 @item t
4271 The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
4272
4273 @end table
4274
4275 The expression for @var{out_w} may depend on the value of @var{out_h},
4276 and the expression for @var{out_h} may depend on @var{out_w}, but they
4277 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
4278 evaluated after @var{out_w} and @var{out_h}.
4279
4280 The @var{x} and @var{y} parameters specify the expressions for the
4281 position of the top-left corner of the output (non-cropped) area. They
4282 are evaluated for each frame. If the evaluated value is not valid, it
4283 is approximated to the nearest valid value.
4284
4285 The expression for @var{x} may depend on @var{y}, and the expression
4286 for @var{y} may depend on @var{x}.
4287
4288 @subsection Examples
4289
4290 @itemize
4291 @item
4292 Crop area with size 100x100 at position (12,34).
4293 @example
4294 crop=100:100:12:34
4295 @end example
4296
4297 Using named options, the example above becomes:
4298 @example
4299 crop=w=100:h=100:x=12:y=34
4300 @end example
4301
4302 @item
4303 Crop the central input area with size 100x100:
4304 @example
4305 crop=100:100
4306 @end example
4307
4308 @item
4309 Crop the central input area with size 2/3 of the input video:
4310 @example
4311 crop=2/3*in_w:2/3*in_h
4312 @end example
4313
4314 @item
4315 Crop the input video central square:
4316 @example
4317 crop=out_w=in_h
4318 crop=in_h
4319 @end example
4320
4321 @item
4322 Delimit the rectangle with the top-left corner placed at position
4323 100:100 and the right-bottom corner corresponding to the right-bottom
4324 corner of the input image.
4325 @example
4326 crop=in_w-100:in_h-100:100:100
4327 @end example
4328
4329 @item
4330 Crop 10 pixels from the left and right borders, and 20 pixels from
4331 the top and bottom borders
4332 @example
4333 crop=in_w-2*10:in_h-2*20
4334 @end example
4335
4336 @item
4337 Keep only the bottom right quarter of the input image:
4338 @example
4339 crop=in_w/2:in_h/2:in_w/2:in_h/2
4340 @end example
4341
4342 @item
4343 Crop height for getting Greek harmony:
4344 @example
4345 crop=in_w:1/PHI*in_w
4346 @end example
4347
4348 @item
4349 Apply trembling effect:
4350 @example
4351 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)
4352 @end example
4353
4354 @item
4355 Apply erratic camera effect depending on timestamp:
4356 @example
4357 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)"
4358 @end example
4359
4360 @item
4361 Set x depending on the value of y:
4362 @example
4363 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
4364 @end example
4365 @end itemize
4366
4367 @subsection Commands
4368
4369 This filter supports the following commands:
4370 @table @option
4371 @item w, out_w
4372 @item h, out_h
4373 @item x
4374 @item y
4375 Set width/height of the output video and the horizontal/vertical position
4376 in the input video.
4377 The command accepts the same syntax of the corresponding option.
4378
4379 If the specified expression is not valid, it is kept at its current
4380 value.
4381 @end table
4382
4383 @section cropdetect
4384
4385 Auto-detect the crop size.
4386
4387 It calculates the necessary cropping parameters and prints the
4388 recommended parameters via the logging system. The detected dimensions
4389 correspond to the non-black area of the input video.
4390
4391 It accepts the following parameters:
4392
4393 @table @option
4394
4395 @item limit
4396 Set higher black value threshold, which can be optionally specified
4397 from nothing (0) to everything (255 for 8bit based formats). An intensity
4398 value greater to the set value is considered non-black. It defaults to 24.
4399 You can also specify a value between 0.0 and 1.0 which will be scaled depending
4400 on the bitdepth of the pixel format.
4401
4402 @item round
4403 The value which the width/height should be divisible by. It defaults to
4404 16. The offset is automatically adjusted to center the video. Use 2 to
4405 get only even dimensions (needed for 4:2:2 video). 16 is best when
4406 encoding to most video codecs.
4407
4408 @item reset_count, reset
4409 Set the counter that determines after how many frames cropdetect will
4410 reset the previously detected largest video area and start over to
4411 detect the current optimal crop area. Default value is 0.
4412
4413 This can be useful when channel logos distort the video area. 0
4414 indicates 'never reset', and returns the largest area encountered during
4415 playback.
4416 @end table
4417
4418 @anchor{curves}
4419 @section curves
4420
4421 Apply color adjustments using curves.
4422
4423 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
4424 component (red, green and blue) has its values defined by @var{N} key points
4425 tied from each other using a smooth curve. The x-axis represents the pixel
4426 values from the input frame, and the y-axis the new pixel values to be set for
4427 the output frame.
4428
4429 By default, a component curve is defined by the two points @var{(0;0)} and
4430 @var{(1;1)}. This creates a straight line where each original pixel value is
4431 "adjusted" to its own value, which means no change to the image.
4432
4433 The filter allows you to redefine these two points and add some more. A new
4434 curve (using a natural cubic spline interpolation) will be define to pass
4435 smoothly through all these new coordinates. The new defined points needs to be
4436 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
4437 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
4438 the vector spaces, the values will be clipped accordingly.
4439
4440 If there is no key point defined in @code{x=0}, the filter will automatically
4441 insert a @var{(0;0)} point. In the same way, if there is no key point defined
4442 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
4443
4444 The filter accepts the following options:
4445
4446 @table @option
4447 @item preset
4448 Select one of the available color presets. This option can be used in addition
4449 to the @option{r}, @option{g}, @option{b} parameters; in this case, the later
4450 options takes priority on the preset values.
4451 Available presets are:
4452 @table @samp
4453 @item none
4454 @item color_negative
4455 @item cross_process
4456 @item darker
4457 @item increase_contrast
4458 @item lighter
4459 @item linear_contrast
4460 @item medium_contrast
4461 @item negative
4462 @item strong_contrast
4463 @item vintage
4464 @end table
4465 Default is @code{none}.
4466 @item master, m
4467 Set the master key points. These points will define a second pass mapping. It
4468 is sometimes called a "luminance" or "value" mapping. It can be used with
4469 @option{r}, @option{g}, @option{b} or @option{all} since it acts like a
4470 post-processing LUT.
4471 @item red, r
4472 Set the key points for the red component.
4473 @item green, g
4474 Set the key points for the green component.
4475 @item blue, b
4476 Set the key points for the blue component.
4477 @item all
4478 Set the key points for all components (not including master).
4479 Can be used in addition to the other key points component
4480 options. In this case, the unset component(s) will fallback on this
4481 @option{all} setting.
4482 @item psfile
4483 Specify a Photoshop curves file (@code{.acv}) to import the settings from.
4484 @end table
4485
4486 To avoid some filtergraph syntax conflicts, each key points list need to be
4487 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
4488
4489 @subsection Examples
4490
4491 @itemize
4492 @item
4493 Increase slightly the middle level of blue:
4494 @example
4495 curves=blue='0.5/0.58'
4496 @end example
4497
4498 @item
4499 Vintage effect:
4500 @example
4501 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
4502 @end example
4503 Here we obtain the following coordinates for each components:
4504 @table @var
4505 @item red
4506 @code{(0;0.11) (0.42;0.51) (1;0.95)}
4507 @item green
4508 @code{(0;0) (0.50;0.48) (1;1)}
4509 @item blue
4510 @code{(0;0.22) (0.49;0.44) (1;0.80)}
4511 @end table
4512
4513 @item
4514 The previous example can also be achieved with the associated built-in preset:
4515 @example
4516 curves=preset=vintage
4517 @end example
4518
4519 @item
4520 Or simply:
4521 @example
4522 curves=vintage
4523 @end example
4524
4525 @item
4526 Use a Photoshop preset and redefine the points of the green component:
4527 @example
4528 curves=psfile='MyCurvesPresets/purple.acv':green='0.45/0.53'
4529 @end example
4530 @end itemize
4531
4532 @section dctdnoiz
4533
4534 Denoise frames using 2D DCT (frequency domain filtering).
4535
4536 This filter is not designed for real time.
4537
4538 The filter accepts the following options:
4539
4540 @table @option
4541 @item sigma, s
4542 Set the noise sigma constant.
4543
4544 This @var{sigma} defines a hard threshold of @code{3 * sigma}; every DCT
4545 coefficient (absolute value) below this threshold with be dropped.
4546
4547 If you need a more advanced filtering, see @option{expr}.
4548
4549 Default is @code{0}.
4550
4551 @item overlap
4552 Set number overlapping pixels for each block. Since the filter can be slow, you
4553 may want to reduce this value, at the cost of a less effective filter and the
4554 risk of various artefacts.
4555
4556 If the overlapping value doesn't permit processing the whole input width or
4557 height, a warning will be displayed and according borders won't be denoised.
4558
4559 Default value is @var{blocksize}-1, which is the best possible setting.
4560
4561 @item expr, e
4562 Set the coefficient factor expression.
4563
4564 For each coefficient of a DCT block, this expression will be evaluated as a
4565 multiplier value for the coefficient.
4566
4567 If this is option is set, the @option{sigma} option will be ignored.
4568
4569 The absolute value of the coefficient can be accessed through the @var{c}
4570 variable.
4571
4572 @item n
4573 Set the @var{blocksize} using the number of bits. @code{1<<@var{n}} defines the
4574 @var{blocksize}, which is the width and height of the processed blocks.
4575
4576 The default value is @var{3} (8x8) and can be raised to @var{4} for a
4577 @var{blocksize} of 16x16. Note that changing this setting has huge consequences
4578 on the speed processing. Also, a larger block size does not necessarily means a
4579 better de-noising.
4580 @end table
4581
4582 @subsection Examples
4583
4584 Apply a denoise with a @option{sigma} of @code{4.5}:
4585 @example
4586 dctdnoiz=4.5
4587 @end example
4588
4589 The same operation can be achieved using the expression system:
4590 @example
4591 dctdnoiz=e='gte(c, 4.5*3)'
4592 @end example
4593
4594 Violent denoise using a block size of @code{16x16}:
4595 @example
4596 dctdnoiz=15:n=4
4597 @end example
4598
4599 @section deband
4600
4601 Remove banding artifacts from input video.
4602 It works by replacing banded pixels with average value of referenced pixels.
4603
4604 The filter accepts the following options:
4605
4606 @table @option
4607 @item 1thr
4608 @item 2thr
4609 @item 3thr
4610 @item 4thr
4611 Set banding detection threshold for each plane. Default is 0.02.
4612 Valid range is 0.00003 to 0.5.
4613 If difference between current pixel and reference pixel is less than threshold,
4614 it will be considered as banded.
4615
4616 @item range, r
4617 Banding detection range in pixels. Default is 16. If positive, random number
4618 in range 0 to set value will be used. If negative, exact absolute value
4619 will be used.
4620 The range defines square of four pixels around current pixel.
4621
4622 @item direction, d
4623 Set direction in radians from which four pixel will be compared. If positive,
4624 random direction from 0 to set direction will be picked. If negative, exact of
4625 absolute value will be picked. For example direction 0, -PI or -2*PI radians
4626 will pick only pixels on same row and -PI/2 will pick only pixels on same
4627 column.
4628
4629 @item blur
4630 If enabled, current pixel is compared with average value of all four
4631 surrounding pixels. The default is enabled. If disabled current pixel is
4632 compared with all four surrounding pixels. The pixel is considered banded
4633 if only all four differences with surrounding pixels are less than threshold.
4634 @end table
4635
4636 @anchor{decimate}
4637 @section decimate
4638
4639 Drop duplicated frames at regular intervals.
4640
4641 The filter accepts the following options:
4642
4643 @table @option
4644 @item cycle
4645 Set the number of frames from which one will be dropped. Setting this to
4646 @var{N} means one frame in every batch of @var{N} frames will be dropped.
4647 Default is @code{5}.
4648
4649 @item dupthresh
4650 Set the threshold for duplicate detection. If the difference metric for a frame
4651 is less than or equal to this value, then it is declared as duplicate. Default
4652 is @code{1.1}
4653
4654 @item scthresh
4655 Set scene change threshold. Default is @code{15}.
4656
4657 @item blockx
4658 @item blocky
4659 Set the size of the x and y-axis blocks used during metric calculations.
4660 Larger blocks give better noise suppression, but also give worse detection of
4661 small movements. Must be a power of two. Default is @code{32}.
4662
4663 @item ppsrc
4664 Mark main input as a pre-processed input and activate clean source input
4665 stream. This allows the input to be pre-processed with various filters to help
4666 the metrics calculation while keeping the frame selection lossless. When set to
4667 @code{1}, the first stream is for the pre-processed input, and the second
4668 stream is the clean source from where the kept frames are chosen. Default is
4669 @code{0}.
4670
4671 @item chroma
4672 Set whether or not chroma is considered in the metric calculations. Default is
4673 @code{1}.
4674 @end table
4675
4676 @section deflate
4677
4678 Apply deflate effect to the video.
4679
4680 This filter replaces the pixel by the local(3x3) average by taking into account
4681 only values lower than the pixel.
4682
4683 It accepts the following options:
4684
4685 @table @option
4686 @item threshold0
4687 @item threshold1
4688 @item threshold2
4689 @item threshold3
4690 Limit the maximum change for each plane, default is 65535.
4691 If 0, plane will remain unchanged.
4692 @end table
4693
4694 @section dejudder
4695
4696 Remove judder produced by partially interlaced telecined content.
4697
4698 Judder can be introduced, for instance, by @ref{pullup} filter. If the original
4699 source was partially telecined content then the output of @code{pullup,dejudder}
4700 will have a variable frame rate. May change the recorded frame rate of the
4701 container. Aside from that change, this filter will not affect constant frame
4702 rate video.
4703
4704 The option available in this filter is:
4705 @table @option
4706
4707 @item cycle
4708 Specify the length of the window over which the judder repeats.
4709
4710 Accepts any integer greater than 1. Useful values are:
4711 @table @samp
4712
4713 @item 4
4714 If the original was telecined from 24 to 30 fps (Film to NTSC).
4715
4716 @item 5
4717 If the original was telecined from 25 to 30 fps (PAL to NTSC).
4718
4719 @item 20
4720 If a mixture of the two.
4721 @end table
4722
4723 The default is @samp{4}.
4724 @end table
4725
4726 @section delogo
4727
4728 Suppress a TV station logo by a simple interpolation of the surrounding
4729 pixels. Just set a rectangle covering the logo and watch it disappear
4730 (and sometimes something even uglier appear - your mileage may vary).
4731
4732 It accepts the following parameters:
4733 @table @option
4734
4735 @item x
4736 @item y
4737 Specify the top left corner coordinates of the logo. They must be
4738 specified.
4739
4740 @item w
4741 @item h
4742 Specify the width and height of the logo to clear. They must be
4743 specified.
4744
4745 @item band, t
4746 Specify the thickness of the fuzzy edge of the rectangle (added to
4747 @var{w} and @var{h}). The default value is 1. This option is
4748 deprecated, setting higher values should no longer be necessary and
4749 is not recommended.
4750
4751 @item show
4752 When set to 1, a green rectangle is drawn on the screen to simplify
4753 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.
4754 The default value is 0.
4755
4756 The rectangle is drawn on the outermost pixels which will be (partly)
4757 replaced with interpolated values. The values of the next pixels
4758 immediately outside this rectangle in each direction will be used to
4759 compute the interpolated pixel values inside the rectangle.
4760
4761 @end table
4762
4763 @subsection Examples
4764
4765 @itemize
4766 @item
4767 Set a rectangle covering the area with top left corner coordinates 0,0
4768 and size 100x77, and a band of size 10:
4769 @example
4770 delogo=x=0:y=0:w=100:h=77:band=10
4771 @end example
4772
4773 @end itemize
4774
4775 @section deshake
4776
4777 Attempt to fix small changes in horizontal and/or vertical shift. This
4778 filter helps remove camera shake from hand-holding a camera, bumping a
4779 tripod, moving on a vehicle, etc.
4780
4781 The filter accepts the following options:
4782
4783 @table @option
4784
4785 @item x
4786 @item y
4787 @item w
4788 @item h
4789 Specify a rectangular area where to limit the search for motion
4790 vectors.
4791 If desired the search for motion vectors can be limited to a
4792 rectangular area of the frame defined by its top left corner, width
4793 and height. These parameters have the same meaning as the drawbox
4794 filter which can be used to visualise the position of the bounding
4795 box.
4796
4797 This is useful when simultaneous movement of subjects within the frame
4798 might be confused for camera motion by the motion vector search.
4799
4800 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
4801 then the full frame is used. This allows later options to be set
4802 without specifying the bounding box for the motion vector search.
4803
4804 Default - search the whole frame.
4805
4806 @item rx
4807 @item ry
4808 Specify the maximum extent of movement in x and y directions in the
4809 range 0-64 pixels. Default 16.
4810
4811 @item edge
4812 Specify how to generate pixels to fill blanks at the edge of the
4813 frame. Available values are:
4814 @table @samp
4815 @item blank, 0
4816 Fill zeroes at blank locations
4817 @item original, 1
4818 Original image at blank locations
4819 @item clamp, 2
4820 Extruded edge value at blank locations
4821 @item mirror, 3
4822 Mirrored edge at blank locations
4823 @end table
4824 Default value is @samp{mirror}.
4825
4826 @item blocksize
4827 Specify the blocksize to use for motion search. Range 4-128 pixels,
4828 default 8.
4829
4830 @item contrast
4831 Specify the contrast threshold for blocks. Only blocks with more than
4832 the specified contrast (difference between darkest and lightest
4833 pixels) will be considered. Range 1-255, default 125.
4834
4835 @item search
4836 Specify the search strategy. Available values are:
4837 @table @samp
4838 @item exhaustive, 0
4839 Set exhaustive search
4840 @item less, 1
4841 Set less exhaustive search.
4842 @end table
4843 Default value is @samp{exhaustive}.
4844
4845 @item filename
4846 If set then a detailed log of the motion search is written to the
4847 specified file.
4848
4849 @item opencl
4850 If set to 1, specify using OpenCL capabilities, only available if
4851 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
4852
4853 @end table
4854
4855 @section detelecine
4856
4857 Apply an exact inverse of the telecine operation. It requires a predefined
4858 pattern specified using the pattern option which must be the same as that passed
4859 to the telecine filter.
4860
4861 This filter accepts the following options:
4862
4863 @table @option
4864 @item first_field
4865 @table @samp
4866 @item top, t
4867 top field first
4868 @item bottom, b
4869 bottom field first
4870 The default value is @code{top}.
4871 @end table
4872
4873 @item pattern
4874 A string of numbers representing the pulldown pattern you wish to apply.
4875 The default value is @code{23}.
4876
4877 @item start_frame
4878 A number representing position of the first frame with respect to the telecine
4879 pattern. This is to be used if the stream is cut. The default value is @code{0}.
4880 @end table
4881
4882 @section dilation
4883
4884 Apply dilation effect to the video.
4885
4886 This filter replaces the pixel by the local(3x3) maximum.
4887
4888 It accepts the following options:
4889
4890 @table @option
4891 @item threshold0
4892 @item threshold1
4893 @item threshold2
4894 @item threshold3
4895 Limit the maximum change for each plane, default is 65535.
4896 If 0, plane will remain unchanged.
4897
4898 @item coordinates
4899 Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
4900 pixels are used.
4901
4902 Flags to local 3x3 coordinates maps like this:
4903
4904     1 2 3
4905     4   5
4906     6 7 8
4907 @end table
4908
4909 @section displace
4910
4911 Displace pixels as indicated by second and third input stream.
4912
4913 It takes three input streams and outputs one stream, the first input is the
4914 source, and second and third input are displacement maps.
4915
4916 The second input specifies how much to displace pixels along the
4917 x-axis, while the third input specifies how much to displace pixels
4918 along the y-axis.
4919 If one of displacement map streams terminates, last frame from that
4920 displacement map will be used.
4921
4922 Note that once generated, displacements maps can be reused over and over again.
4923
4924 A description of the accepted options follows.
4925
4926 @table @option
4927 @item edge
4928 Set displace behavior for pixels that are out of range.
4929
4930 Available values are:
4931 @table @samp
4932 @item blank
4933 Missing pixels are replaced by black pixels.
4934
4935 @item smear
4936 Adjacent pixels will spread out to replace missing pixels.
4937
4938 @item wrap
4939 Out of range pixels are wrapped so they point to pixels of other side.
4940 @end table
4941 Default is @samp{smear}.
4942
4943 @end table
4944
4945 @subsection Examples
4946
4947 @itemize
4948 @item
4949 Add ripple effect to rgb input of video size hd720:
4950 @example
4951 ffmpeg -i INPUT -f lavfi -i nullsrc=s=hd720,lutrgb=128:128:128 -f lavfi -i nullsrc=s=hd720,geq='r=128+30*sin(2*PI*X/400+T):g=128+30*sin(2*PI*X/400+T):b=128+30*sin(2*PI*X/400+T)' -lavfi '[0][1][2]displace' OUTPUT
4952 @end example
4953
4954 @item
4955 Add wave effect to rgb input of video size hd720:
4956 @example
4957 ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):g=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):b=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T))' -lavfi '[1]split[x][y],[0][x][y]displace' OUTPUT
4958 @end example
4959 @end itemize
4960
4961 @section drawbox
4962
4963 Draw a colored box on the input image.
4964
4965 It accepts the following parameters:
4966
4967 @table @option
4968 @item x
4969 @item y
4970 The expressions which specify the top left corner coordinates of the box. It defaults to 0.
4971
4972 @item width, w
4973 @item height, h
4974 The expressions which specify the width and height of the box; if 0 they are interpreted as
4975 the input width and height. It defaults to 0.
4976
4977 @item color, c
4978 Specify the color of the box to write. For the general syntax of this option,
4979 check the "Color" section in the ffmpeg-utils manual. If the special
4980 value @code{invert} is used, the box edge color is the same as the
4981 video with inverted luma.
4982
4983 @item thickness, t
4984 The expression which sets the thickness of the box edge. Default value is @code{3}.
4985
4986 See below for the list of accepted constants.
4987 @end table
4988
4989 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
4990 following constants:
4991
4992 @table @option
4993 @item dar
4994 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
4995
4996 @item hsub
4997 @item vsub
4998 horizontal and vertical chroma subsample values. For example for the
4999 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
5000
5001 @item in_h, ih
5002 @item in_w, iw
5003 The input width and height.
5004
5005 @item sar
5006 The input sample aspect ratio.
5007
5008 @item x
5009 @item y
5010 The x and y offset coordinates where the box is drawn.
5011
5012 @item w
5013 @item h
5014 The width and height of the drawn box.
5015
5016 @item t
5017 The thickness of the drawn box.
5018
5019 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
5020 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
5021
5022 @end table
5023
5024 @subsection Examples
5025
5026 @itemize
5027 @item
5028 Draw a black box around the edge of the input image:
5029 @example
5030 drawbox
5031 @end example
5032
5033 @item
5034 Draw a box with color red and an opacity of 50%:
5035 @example
5036 drawbox=10:20:200:60:red@@0.5
5037 @end example
5038
5039 The previous example can be specified as:
5040 @example
5041 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
5042 @end example
5043
5044 @item
5045 Fill the box with pink color:
5046 @example
5047 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
5048 @end example
5049
5050 @item
5051 Draw a 2-pixel red 2.40:1 mask:
5052 @example
5053 drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
5054 @end example
5055 @end itemize
5056
5057 @section drawgraph, adrawgraph
5058
5059 Draw a graph using input video or audio metadata.
5060
5061 It accepts the following parameters:
5062
5063 @table @option
5064 @item m1
5065 Set 1st frame metadata key from which metadata values will be used to draw a graph.
5066
5067 @item fg1
5068 Set 1st foreground color expression.
5069
5070 @item m2
5071 Set 2nd frame metadata key from which metadata values will be used to draw a graph.
5072
5073 @item fg2