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