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