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