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