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