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