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