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