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