avfilter/zoompan: add in_time variable
[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 @end table
1577
1578 @subsection Commands
1579
1580 This filter supports the following commands:
1581 @table @option
1582 @item frequency, f
1583 Change allpass frequency.
1584 Syntax for the command is : "@var{frequency}"
1585
1586 @item width_type, t
1587 Change allpass width_type.
1588 Syntax for the command is : "@var{width_type}"
1589
1590 @item width, w
1591 Change allpass width.
1592 Syntax for the command is : "@var{width}"
1593
1594 @item mix, m
1595 Change allpass mix.
1596 Syntax for the command is : "@var{mix}"
1597 @end table
1598
1599 @section aloop
1600
1601 Loop audio samples.
1602
1603 The filter accepts the following options:
1604
1605 @table @option
1606 @item loop
1607 Set the number of loops. Setting this value to -1 will result in infinite loops.
1608 Default is 0.
1609
1610 @item size
1611 Set maximal number of samples. Default is 0.
1612
1613 @item start
1614 Set first sample of loop. Default is 0.
1615 @end table
1616
1617 @anchor{amerge}
1618 @section amerge
1619
1620 Merge two or more audio streams into a single multi-channel stream.
1621
1622 The filter accepts the following options:
1623
1624 @table @option
1625
1626 @item inputs
1627 Set the number of inputs. Default is 2.
1628
1629 @end table
1630
1631 If the channel layouts of the inputs are disjoint, and therefore compatible,
1632 the channel layout of the output will be set accordingly and the channels
1633 will be reordered as necessary. If the channel layouts of the inputs are not
1634 disjoint, the output will have all the channels of the first input then all
1635 the channels of the second input, in that order, and the channel layout of
1636 the output will be the default value corresponding to the total number of
1637 channels.
1638
1639 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
1640 is FC+BL+BR, then the output will be in 5.1, with the channels in the
1641 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
1642 first input, b1 is the first channel of the second input).
1643
1644 On the other hand, if both input are in stereo, the output channels will be
1645 in the default order: a1, a2, b1, b2, and the channel layout will be
1646 arbitrarily set to 4.0, which may or may not be the expected value.
1647
1648 All inputs must have the same sample rate, and format.
1649
1650 If inputs do not have the same duration, the output will stop with the
1651 shortest.
1652
1653 @subsection Examples
1654
1655 @itemize
1656 @item
1657 Merge two mono files into a stereo stream:
1658 @example
1659 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
1660 @end example
1661
1662 @item
1663 Multiple merges assuming 1 video stream and 6 audio streams in @file{input.mkv}:
1664 @example
1665 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
1666 @end example
1667 @end itemize
1668
1669 @section amix
1670
1671 Mixes multiple audio inputs into a single output.
1672
1673 Note that this filter only supports float samples (the @var{amerge}
1674 and @var{pan} audio filters support many formats). If the @var{amix}
1675 input has integer samples then @ref{aresample} will be automatically
1676 inserted to perform the conversion to float samples.
1677
1678 For example
1679 @example
1680 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
1681 @end example
1682 will mix 3 input audio streams to a single output with the same duration as the
1683 first input and a dropout transition time of 3 seconds.
1684
1685 It accepts the following parameters:
1686 @table @option
1687
1688 @item inputs
1689 The number of inputs. If unspecified, it defaults to 2.
1690
1691 @item duration
1692 How to determine the end-of-stream.
1693 @table @option
1694
1695 @item longest
1696 The duration of the longest input. (default)
1697
1698 @item shortest
1699 The duration of the shortest input.
1700
1701 @item first
1702 The duration of the first input.
1703
1704 @end table
1705
1706 @item dropout_transition
1707 The transition time, in seconds, for volume renormalization when an input
1708 stream ends. The default value is 2 seconds.
1709
1710 @item weights
1711 Specify weight of each input audio stream as sequence.
1712 Each weight is separated by space. By default all inputs have same weight.
1713 @end table
1714
1715 @subsection Commands
1716
1717 This filter supports the following commands:
1718 @table @option
1719 @item weights
1720 Syntax is same as option with same name.
1721 @end table
1722
1723 @section amultiply
1724
1725 Multiply first audio stream with second audio stream and store result
1726 in output audio stream. Multiplication is done by multiplying each
1727 sample from first stream with sample at same position from second stream.
1728
1729 With this element-wise multiplication one can create amplitude fades and
1730 amplitude modulations.
1731
1732 @section anequalizer
1733
1734 High-order parametric multiband equalizer for each channel.
1735
1736 It accepts the following parameters:
1737 @table @option
1738 @item params
1739
1740 This option string is in format:
1741 "c@var{chn} f=@var{cf} w=@var{w} g=@var{g} t=@var{f} | ..."
1742 Each equalizer band is separated by '|'.
1743
1744 @table @option
1745 @item chn
1746 Set channel number to which equalization will be applied.
1747 If input doesn't have that channel the entry is ignored.
1748
1749 @item f
1750 Set central frequency for band.
1751 If input doesn't have that frequency the entry is ignored.
1752
1753 @item w
1754 Set band width in hertz.
1755
1756 @item g
1757 Set band gain in dB.
1758
1759 @item t
1760 Set filter type for band, optional, can be:
1761
1762 @table @samp
1763 @item 0
1764 Butterworth, this is default.
1765
1766 @item 1
1767 Chebyshev type 1.
1768
1769 @item 2
1770 Chebyshev type 2.
1771 @end table
1772 @end table
1773
1774 @item curves
1775 With this option activated frequency response of anequalizer is displayed
1776 in video stream.
1777
1778 @item size
1779 Set video stream size. Only useful if curves option is activated.
1780
1781 @item mgain
1782 Set max gain that will be displayed. Only useful if curves option is activated.
1783 Setting this to a reasonable value makes it possible to display gain which is derived from
1784 neighbour bands which are too close to each other and thus produce higher gain
1785 when both are activated.
1786
1787 @item fscale
1788 Set frequency scale used to draw frequency response in video output.
1789 Can be linear or logarithmic. Default is logarithmic.
1790
1791 @item colors
1792 Set color for each channel curve which is going to be displayed in video stream.
1793 This is list of color names separated by space or by '|'.
1794 Unrecognised or missing colors will be replaced by white color.
1795 @end table
1796
1797 @subsection Examples
1798
1799 @itemize
1800 @item
1801 Lower gain by 10 of central frequency 200Hz and width 100 Hz
1802 for first 2 channels using Chebyshev type 1 filter:
1803 @example
1804 anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
1805 @end example
1806 @end itemize
1807
1808 @subsection Commands
1809
1810 This filter supports the following commands:
1811 @table @option
1812 @item change
1813 Alter existing filter parameters.
1814 Syntax for the commands is : "@var{fN}|f=@var{freq}|w=@var{width}|g=@var{gain}"
1815
1816 @var{fN} is existing filter number, starting from 0, if no such filter is available
1817 error is returned.
1818 @var{freq} set new frequency parameter.
1819 @var{width} set new width parameter in herz.
1820 @var{gain} set new gain parameter in dB.
1821
1822 Full filter invocation with asendcmd may look like this:
1823 asendcmd=c='4.0 anequalizer change 0|f=200|w=50|g=1',anequalizer=...
1824 @end table
1825
1826 @section anlmdn
1827
1828 Reduce broadband noise in audio samples using Non-Local Means algorithm.
1829
1830 Each sample is adjusted by looking for other samples with similar contexts. This
1831 context similarity is defined by comparing their surrounding patches of size
1832 @option{p}. Patches are searched in an area of @option{r} around the sample.
1833
1834 The filter accepts the following options:
1835
1836 @table @option
1837 @item s
1838 Set denoising strength. Allowed range is from 0.00001 to 10. Default value is 0.00001.
1839
1840 @item p
1841 Set patch radius duration. Allowed range is from 1 to 100 milliseconds.
1842 Default value is 2 milliseconds.
1843
1844 @item r
1845 Set research radius duration. Allowed range is from 2 to 300 milliseconds.
1846 Default value is 6 milliseconds.
1847
1848 @item o
1849 Set the output mode.
1850
1851 It accepts the following values:
1852 @table @option
1853 @item i
1854 Pass input unchanged.
1855
1856 @item o
1857 Pass noise filtered out.
1858
1859 @item n
1860 Pass only noise.
1861
1862 Default value is @var{o}.
1863 @end table
1864
1865 @item m
1866 Set smooth factor. Default value is @var{11}. Allowed range is from @var{1} to @var{15}.
1867 @end table
1868
1869 @subsection Commands
1870
1871 This filter supports the following commands:
1872 @table @option
1873 @item s
1874 Change denoise strength. Argument is single float number.
1875 Syntax for the command is : "@var{s}"
1876
1877 @item o
1878 Change output mode.
1879 Syntax for the command is : "i", "o" or "n" string.
1880 @end table
1881
1882 @section anlms
1883 Apply Normalized Least-Mean-Squares algorithm to the first audio stream using the second audio stream.
1884
1885 This adaptive filter is used to mimic a desired filter by finding the filter coefficients that
1886 relate to producing the least mean square of the error signal (difference between the desired,
1887 2nd input audio stream and the actual signal, the 1st input audio stream).
1888
1889 A description of the accepted options follows.
1890
1891 @table @option
1892 @item order
1893 Set filter order.
1894
1895 @item mu
1896 Set filter mu.
1897
1898 @item eps
1899 Set the filter eps.
1900
1901 @item leakage
1902 Set the filter leakage.
1903
1904 @item out_mode
1905 It accepts the following values:
1906 @table @option
1907 @item i
1908 Pass the 1st input.
1909
1910 @item d
1911 Pass the 2nd input.
1912
1913 @item o
1914 Pass filtered samples.
1915
1916 @item n
1917 Pass difference between desired and filtered samples.
1918
1919 Default value is @var{o}.
1920 @end table
1921 @end table
1922
1923 @subsection Examples
1924
1925 @itemize
1926 @item
1927 One of many usages of this filter is noise reduction, input audio is filtered
1928 with same samples that are delayed by fixed amount, one such example for stereo audio is:
1929 @example
1930 asplit[a][b],[a]adelay=32S|32S[a],[b][a]anlms=order=128:leakage=0.0005:mu=.5:out_mode=o
1931 @end example
1932 @end itemize
1933
1934 @subsection Commands
1935
1936 This filter supports the same commands as options, excluding option @code{order}.
1937
1938 @section anull
1939
1940 Pass the audio source unchanged to the output.
1941
1942 @section apad
1943
1944 Pad the end of an audio stream with silence.
1945
1946 This can be used together with @command{ffmpeg} @option{-shortest} to
1947 extend audio streams to the same length as the video stream.
1948
1949 A description of the accepted options follows.
1950
1951 @table @option
1952 @item packet_size
1953 Set silence packet size. Default value is 4096.
1954
1955 @item pad_len
1956 Set the number of samples of silence to add to the end. After the
1957 value is reached, the stream is terminated. This option is mutually
1958 exclusive with @option{whole_len}.
1959
1960 @item whole_len
1961 Set the minimum total number of samples in the output audio stream. If
1962 the value is longer than the input audio length, silence is added to
1963 the end, until the value is reached. This option is mutually exclusive
1964 with @option{pad_len}.
1965
1966 @item pad_dur
1967 Specify the duration of samples of silence to add. See
1968 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
1969 for the accepted syntax. Used only if set to non-zero value.
1970
1971 @item whole_dur
1972 Specify the minimum total duration in the output audio stream. See
1973 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
1974 for the accepted syntax. Used only if set to non-zero value. If the value is longer than
1975 the input audio length, silence is added to the end, until the value is reached.
1976 This option is mutually exclusive with @option{pad_dur}
1977 @end table
1978
1979 If neither the @option{pad_len} nor the @option{whole_len} nor @option{pad_dur}
1980 nor @option{whole_dur} option is set, the filter will add silence to the end of
1981 the input stream indefinitely.
1982
1983 @subsection Examples
1984
1985 @itemize
1986 @item
1987 Add 1024 samples of silence to the end of the input:
1988 @example
1989 apad=pad_len=1024
1990 @end example
1991
1992 @item
1993 Make sure the audio output will contain at least 10000 samples, pad
1994 the input with silence if required:
1995 @example
1996 apad=whole_len=10000
1997 @end example
1998
1999 @item
2000 Use @command{ffmpeg} to pad the audio input with silence, so that the
2001 video stream will always result the shortest and will be converted
2002 until the end in the output file when using the @option{shortest}
2003 option:
2004 @example
2005 ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
2006 @end example
2007 @end itemize
2008
2009 @section aphaser
2010 Add a phasing effect to the input audio.
2011
2012 A phaser filter creates series of peaks and troughs in the frequency spectrum.
2013 The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
2014
2015 A description of the accepted parameters follows.
2016
2017 @table @option
2018 @item in_gain
2019 Set input gain. Default is 0.4.
2020
2021 @item out_gain
2022 Set output gain. Default is 0.74
2023
2024 @item delay
2025 Set delay in milliseconds. Default is 3.0.
2026
2027 @item decay
2028 Set decay. Default is 0.4.
2029
2030 @item speed
2031 Set modulation speed in Hz. Default is 0.5.
2032
2033 @item type
2034 Set modulation type. Default is triangular.
2035
2036 It accepts the following values:
2037 @table @samp
2038 @item triangular, t
2039 @item sinusoidal, s
2040 @end table
2041 @end table
2042
2043 @section apulsator
2044
2045 Audio pulsator is something between an autopanner and a tremolo.
2046 But it can produce funny stereo effects as well. Pulsator changes the volume
2047 of the left and right channel based on a LFO (low frequency oscillator) with
2048 different waveforms and shifted phases.
2049 This filter have the ability to define an offset between left and right
2050 channel. An offset of 0 means that both LFO shapes match each other.
2051 The left and right channel are altered equally - a conventional tremolo.
2052 An offset of 50% means that the shape of the right channel is exactly shifted
2053 in phase (or moved backwards about half of the frequency) - pulsator acts as
2054 an autopanner. At 1 both curves match again. Every setting in between moves the
2055 phase shift gapless between all stages and produces some "bypassing" sounds with
2056 sine and triangle waveforms. The more you set the offset near 1 (starting from
2057 the 0.5) the faster the signal passes from the left to the right speaker.
2058
2059 The filter accepts the following options:
2060
2061 @table @option
2062 @item level_in
2063 Set input gain. By default it is 1. Range is [0.015625 - 64].
2064
2065 @item level_out
2066 Set output gain. By default it is 1. Range is [0.015625 - 64].
2067
2068 @item mode
2069 Set waveform shape the LFO will use. Can be one of: sine, triangle, square,
2070 sawup or sawdown. Default is sine.
2071
2072 @item amount
2073 Set modulation. Define how much of original signal is affected by the LFO.
2074
2075 @item offset_l
2076 Set left channel offset. Default is 0. Allowed range is [0 - 1].
2077
2078 @item offset_r
2079 Set right channel offset. Default is 0.5. Allowed range is [0 - 1].
2080
2081 @item width
2082 Set pulse width. Default is 1. Allowed range is [0 - 2].
2083
2084 @item timing
2085 Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz.
2086
2087 @item bpm
2088 Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing
2089 is set to bpm.
2090
2091 @item ms
2092 Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing
2093 is set to ms.
2094
2095 @item hz
2096 Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used
2097 if timing is set to hz.
2098 @end table
2099
2100 @anchor{aresample}
2101 @section aresample
2102
2103 Resample the input audio to the specified parameters, using the
2104 libswresample library. If none are specified then the filter will
2105 automatically convert between its input and output.
2106
2107 This filter is also able to stretch/squeeze the audio data to make it match
2108 the timestamps or to inject silence / cut out audio to make it match the
2109 timestamps, do a combination of both or do neither.
2110
2111 The filter accepts the syntax
2112 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
2113 expresses a sample rate and @var{resampler_options} is a list of
2114 @var{key}=@var{value} pairs, separated by ":". See the
2115 @ref{Resampler Options,,"Resampler Options" section in the
2116 ffmpeg-resampler(1) manual,ffmpeg-resampler}
2117 for the complete list of supported options.
2118
2119 @subsection Examples
2120
2121 @itemize
2122 @item
2123 Resample the input audio to 44100Hz:
2124 @example
2125 aresample=44100
2126 @end example
2127
2128 @item
2129 Stretch/squeeze samples to the given timestamps, with a maximum of 1000
2130 samples per second compensation:
2131 @example
2132 aresample=async=1000
2133 @end example
2134 @end itemize
2135
2136 @section areverse
2137
2138 Reverse an audio clip.
2139
2140 Warning: This filter requires memory to buffer the entire clip, so trimming
2141 is suggested.
2142
2143 @subsection Examples
2144
2145 @itemize
2146 @item
2147 Take the first 5 seconds of a clip, and reverse it.
2148 @example
2149 atrim=end=5,areverse
2150 @end example
2151 @end itemize
2152
2153 @section arnndn
2154
2155 Reduce noise from speech using Recurrent Neural Networks.
2156
2157 This filter accepts the following options:
2158
2159 @table @option
2160 @item model, m
2161 Set train model file to load. This option is always required.
2162 @end table
2163
2164 @section asetnsamples
2165
2166 Set the number of samples per each output audio frame.
2167
2168 The last output packet may contain a different number of samples, as
2169 the filter will flush all the remaining samples when the input audio
2170 signals its end.
2171
2172 The filter accepts the following options:
2173
2174 @table @option
2175
2176 @item nb_out_samples, n
2177 Set the number of frames per each output audio frame. The number is
2178 intended as the number of samples @emph{per each channel}.
2179 Default value is 1024.
2180
2181 @item pad, p
2182 If set to 1, the filter will pad the last audio frame with zeroes, so
2183 that the last frame will contain the same number of samples as the
2184 previous ones. Default value is 1.
2185 @end table
2186
2187 For example, to set the number of per-frame samples to 1234 and
2188 disable padding for the last frame, use:
2189 @example
2190 asetnsamples=n=1234:p=0
2191 @end example
2192
2193 @section asetrate
2194
2195 Set the sample rate without altering the PCM data.
2196 This will result in a change of speed and pitch.
2197
2198 The filter accepts the following options:
2199
2200 @table @option
2201 @item sample_rate, r
2202 Set the output sample rate. Default is 44100 Hz.
2203 @end table
2204
2205 @section ashowinfo
2206
2207 Show a line containing various information for each input audio frame.
2208 The input audio is not modified.
2209
2210 The shown line contains a sequence of key/value pairs of the form
2211 @var{key}:@var{value}.
2212
2213 The following values are shown in the output:
2214
2215 @table @option
2216 @item n
2217 The (sequential) number of the input frame, starting from 0.
2218
2219 @item pts
2220 The presentation timestamp of the input frame, in time base units; the time base
2221 depends on the filter input pad, and is usually 1/@var{sample_rate}.
2222
2223 @item pts_time
2224 The presentation timestamp of the input frame in seconds.
2225
2226 @item pos
2227 position of the frame in the input stream, -1 if this information in
2228 unavailable and/or meaningless (for example in case of synthetic audio)
2229
2230 @item fmt
2231 The sample format.
2232
2233 @item chlayout
2234 The channel layout.
2235
2236 @item rate
2237 The sample rate for the audio frame.
2238
2239 @item nb_samples
2240 The number of samples (per channel) in the frame.
2241
2242 @item checksum
2243 The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
2244 audio, the data is treated as if all the planes were concatenated.
2245
2246 @item plane_checksums
2247 A list of Adler-32 checksums for each data plane.
2248 @end table
2249
2250 @section asoftclip
2251 Apply audio soft clipping.
2252
2253 Soft clipping is a type of distortion effect where the amplitude of a signal is saturated
2254 along a smooth curve, rather than the abrupt shape of hard-clipping.
2255
2256 This filter accepts the following options:
2257
2258 @table @option
2259 @item type
2260 Set type of soft-clipping.
2261
2262 It accepts the following values:
2263 @table @option
2264 @item tanh
2265 @item atan
2266 @item cubic
2267 @item exp
2268 @item alg
2269 @item quintic
2270 @item sin
2271 @end table
2272
2273 @item param
2274 Set additional parameter which controls sigmoid function.
2275 @end table
2276
2277 @subsection Commands
2278
2279 This filter supports the all above options as @ref{commands}.
2280
2281 @section asr
2282 Automatic Speech Recognition
2283
2284 This filter uses PocketSphinx for speech recognition. To enable
2285 compilation of this filter, you need to configure FFmpeg with
2286 @code{--enable-pocketsphinx}.
2287
2288 It accepts the following options:
2289
2290 @table @option
2291 @item rate
2292 Set sampling rate of input audio. Defaults is @code{16000}.
2293 This need to match speech models, otherwise one will get poor results.
2294
2295 @item hmm
2296 Set dictionary containing acoustic model files.
2297
2298 @item dict
2299 Set pronunciation dictionary.
2300
2301 @item lm
2302 Set language model file.
2303
2304 @item lmctl
2305 Set language model set.
2306
2307 @item lmname
2308 Set which language model to use.
2309
2310 @item logfn
2311 Set output for log messages.
2312 @end table
2313
2314 The filter exports recognized speech as the frame metadata @code{lavfi.asr.text}.
2315
2316 @anchor{astats}
2317 @section astats
2318
2319 Display time domain statistical information about the audio channels.
2320 Statistics are calculated and displayed for each audio channel and,
2321 where applicable, an overall figure is also given.
2322
2323 It accepts the following option:
2324 @table @option
2325 @item length
2326 Short window length in seconds, used for peak and trough RMS measurement.
2327 Default is @code{0.05} (50 milliseconds). Allowed range is @code{[0.01 - 10]}.
2328
2329 @item metadata
2330
2331 Set metadata injection. All the metadata keys are prefixed with @code{lavfi.astats.X},
2332 where @code{X} is channel number starting from 1 or string @code{Overall}. Default is
2333 disabled.
2334
2335 Available keys for each channel are:
2336 DC_offset
2337 Min_level
2338 Max_level
2339 Min_difference
2340 Max_difference
2341 Mean_difference
2342 RMS_difference
2343 Peak_level
2344 RMS_peak
2345 RMS_trough
2346 Crest_factor
2347 Flat_factor
2348 Peak_count
2349 Noise_floor
2350 Noise_floor_count
2351 Bit_depth
2352 Dynamic_range
2353 Zero_crossings
2354 Zero_crossings_rate
2355 Number_of_NaNs
2356 Number_of_Infs
2357 Number_of_denormals
2358
2359 and for Overall:
2360 DC_offset
2361 Min_level
2362 Max_level
2363 Min_difference
2364 Max_difference
2365 Mean_difference
2366 RMS_difference
2367 Peak_level
2368 RMS_level
2369 RMS_peak
2370 RMS_trough
2371 Flat_factor
2372 Peak_count
2373 Noise_floor
2374 Noise_floor_count
2375 Bit_depth
2376 Number_of_samples
2377 Number_of_NaNs
2378 Number_of_Infs
2379 Number_of_denormals
2380
2381 For example full key look like this @code{lavfi.astats.1.DC_offset} or
2382 this @code{lavfi.astats.Overall.Peak_count}.
2383
2384 For description what each key means read below.
2385
2386 @item reset
2387 Set number of frame after which stats are going to be recalculated.
2388 Default is disabled.
2389
2390 @item measure_perchannel
2391 Select the entries which need to be measured per channel. The metadata keys can
2392 be used as flags, default is @option{all} which measures everything.
2393 @option{none} disables all per channel measurement.
2394
2395 @item measure_overall
2396 Select the entries which need to be measured overall. The metadata keys can
2397 be used as flags, default is @option{all} which measures everything.
2398 @option{none} disables all overall measurement.
2399
2400 @end table
2401
2402 A description of each shown parameter follows:
2403
2404 @table @option
2405 @item DC offset
2406 Mean amplitude displacement from zero.
2407
2408 @item Min level
2409 Minimal sample level.
2410
2411 @item Max level
2412 Maximal sample level.
2413
2414 @item Min difference
2415 Minimal difference between two consecutive samples.
2416
2417 @item Max difference
2418 Maximal difference between two consecutive samples.
2419
2420 @item Mean difference
2421 Mean difference between two consecutive samples.
2422 The average of each difference between two consecutive samples.
2423
2424 @item RMS difference
2425 Root Mean Square difference between two consecutive samples.
2426
2427 @item Peak level dB
2428 @item RMS level dB
2429 Standard peak and RMS level measured in dBFS.
2430
2431 @item RMS peak dB
2432 @item RMS trough dB
2433 Peak and trough values for RMS level measured over a short window.
2434
2435 @item Crest factor
2436 Standard ratio of peak to RMS level (note: not in dB).
2437
2438 @item Flat factor
2439 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
2440 (i.e. either @var{Min level} or @var{Max level}).
2441
2442 @item Peak count
2443 Number of occasions (not the number of samples) that the signal attained either
2444 @var{Min level} or @var{Max level}.
2445
2446 @item Noise floor dB
2447 Minimum local peak measured in dBFS over a short window.
2448
2449 @item Noise floor count
2450 Number of occasions (not the number of samples) that the signal attained
2451 @var{Noise floor}.
2452
2453 @item Bit depth
2454 Overall bit depth of audio. Number of bits used for each sample.
2455
2456 @item Dynamic range
2457 Measured dynamic range of audio in dB.
2458
2459 @item Zero crossings
2460 Number of points where the waveform crosses the zero level axis.
2461
2462 @item Zero crossings rate
2463 Rate of Zero crossings and number of audio samples.
2464 @end table
2465
2466 @section asubboost
2467 Boost subwoofer frequencies.
2468
2469 The filter accepts the following options:
2470
2471 @table @option
2472 @item dry
2473 Set dry gain, how much of original signal is kept. Allowed range is from 0 to 1.
2474 Default value is 0.5.
2475
2476 @item wet
2477 Set wet gain, how much of filtered signal is kept. Allowed range is from 0 to 1.
2478 Default value is 0.8.
2479
2480 @item decay
2481 Set delay line decay gain value. Allowed range is from 0 to 1.
2482 Default value is 0.7.
2483
2484 @item feedback
2485 Set delay line feedback gain value. Allowed range is from 0 to 1.
2486 Default value is 0.5.
2487
2488 @item cutoff
2489 Set cutoff frequency in herz. Allowed range is 50 to 900.
2490 Default value is 100.
2491
2492 @item slope
2493 Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1.
2494 Default value is 0.5.
2495
2496 @item delay
2497 Set delay. Allowed range is from 1 to 100.
2498 Default value is 20.
2499 @end table
2500
2501 @subsection Commands
2502
2503 This filter supports the all above options as @ref{commands}.
2504
2505 @section atempo
2506
2507 Adjust audio tempo.
2508
2509 The filter accepts exactly one parameter, the audio tempo. If not
2510 specified then the filter will assume nominal 1.0 tempo. Tempo must
2511 be in the [0.5, 100.0] range.
2512
2513 Note that tempo greater than 2 will skip some samples rather than
2514 blend them in.  If for any reason this is a concern it is always
2515 possible to daisy-chain several instances of atempo to achieve the
2516 desired product tempo.
2517
2518 @subsection Examples
2519
2520 @itemize
2521 @item
2522 Slow down audio to 80% tempo:
2523 @example
2524 atempo=0.8
2525 @end example
2526
2527 @item
2528 To speed up audio to 300% tempo:
2529 @example
2530 atempo=3
2531 @end example
2532
2533 @item
2534 To speed up audio to 300% tempo by daisy-chaining two atempo instances:
2535 @example
2536 atempo=sqrt(3),atempo=sqrt(3)
2537 @end example
2538 @end itemize
2539
2540 @subsection Commands
2541
2542 This filter supports the following commands:
2543 @table @option
2544 @item tempo
2545 Change filter tempo scale factor.
2546 Syntax for the command is : "@var{tempo}"
2547 @end table
2548
2549 @section atrim
2550
2551 Trim the input so that the output contains one continuous subpart of the input.
2552
2553 It accepts the following parameters:
2554 @table @option
2555 @item start
2556 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
2557 sample with the timestamp @var{start} will be the first sample in the output.
2558
2559 @item end
2560 Specify time of the first audio sample that will be dropped, i.e. the
2561 audio sample immediately preceding the one with the timestamp @var{end} will be
2562 the last sample in the output.
2563
2564 @item start_pts
2565 Same as @var{start}, except this option sets the start timestamp in samples
2566 instead of seconds.
2567
2568 @item end_pts
2569 Same as @var{end}, except this option sets the end timestamp in samples instead
2570 of seconds.
2571
2572 @item duration
2573 The maximum duration of the output in seconds.
2574
2575 @item start_sample
2576 The number of the first sample that should be output.
2577
2578 @item end_sample
2579 The number of the first sample that should be dropped.
2580 @end table
2581
2582 @option{start}, @option{end}, and @option{duration} are expressed as time
2583 duration specifications; see
2584 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
2585
2586 Note that the first two sets of the start/end options and the @option{duration}
2587 option look at the frame timestamp, while the _sample options simply count the
2588 samples that pass through the filter. So start/end_pts and start/end_sample will
2589 give different results when the timestamps are wrong, inexact or do not start at
2590 zero. Also note that this filter does not modify the timestamps. If you wish
2591 to have the output timestamps start at zero, insert the asetpts filter after the
2592 atrim filter.
2593
2594 If multiple start or end options are set, this filter tries to be greedy and
2595 keep all samples that match at least one of the specified constraints. To keep
2596 only the part that matches all the constraints at once, chain multiple atrim
2597 filters.
2598
2599 The defaults are such that all the input is kept. So it is possible to set e.g.
2600 just the end values to keep everything before the specified time.
2601
2602 Examples:
2603 @itemize
2604 @item
2605 Drop everything except the second minute of input:
2606 @example
2607 ffmpeg -i INPUT -af atrim=60:120
2608 @end example
2609
2610 @item
2611 Keep only the first 1000 samples:
2612 @example
2613 ffmpeg -i INPUT -af atrim=end_sample=1000
2614 @end example
2615
2616 @end itemize
2617
2618 @section axcorrelate
2619 Calculate normalized cross-correlation between two input audio streams.
2620
2621 Resulted samples are always between -1 and 1 inclusive.
2622 If result is 1 it means two input samples are highly correlated in that selected segment.
2623 Result 0 means they are not correlated at all.
2624 If result is -1 it means two input samples are out of phase, which means they cancel each
2625 other.
2626
2627 The filter accepts the following options:
2628
2629 @table @option
2630 @item size
2631 Set size of segment over which cross-correlation is calculated.
2632 Default is 256. Allowed range is from 2 to 131072.
2633
2634 @item algo
2635 Set algorithm for cross-correlation. Can be @code{slow} or @code{fast}.
2636 Default is @code{slow}. Fast algorithm assumes mean values over any given segment
2637 are always zero and thus need much less calculations to make.
2638 This is generally not true, but is valid for typical audio streams.
2639 @end table
2640
2641 @subsection Examples
2642
2643 @itemize
2644 @item
2645 Calculate correlation between channels in stereo audio stream:
2646 @example
2647 ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav
2648 @end example
2649 @end itemize
2650
2651 @section bandpass
2652
2653 Apply a two-pole Butterworth band-pass filter with central
2654 frequency @var{frequency}, and (3dB-point) band-width width.
2655 The @var{csg} option selects a constant skirt gain (peak gain = Q)
2656 instead of the default: constant 0dB peak gain.
2657 The filter roll off at 6dB per octave (20dB per decade).
2658
2659 The filter accepts the following options:
2660
2661 @table @option
2662 @item frequency, f
2663 Set the filter's central frequency. Default is @code{3000}.
2664
2665 @item csg
2666 Constant skirt gain if set to 1. Defaults to 0.
2667
2668 @item width_type, t
2669 Set method to specify band-width of filter.
2670 @table @option
2671 @item h
2672 Hz
2673 @item q
2674 Q-Factor
2675 @item o
2676 octave
2677 @item s
2678 slope
2679 @item k
2680 kHz
2681 @end table
2682
2683 @item width, w
2684 Specify the band-width of a filter in width_type units.
2685
2686 @item mix, m
2687 How much to use filtered signal in output. Default is 1.
2688 Range is between 0 and 1.
2689
2690 @item channels, c
2691 Specify which channels to filter, by default all available are filtered.
2692
2693 @item normalize, n
2694 Normalize biquad coefficients, by default is disabled.
2695 Enabling it will normalize magnitude response at DC to 0dB.
2696 @end table
2697
2698 @subsection Commands
2699
2700 This filter supports the following commands:
2701 @table @option
2702 @item frequency, f
2703 Change bandpass frequency.
2704 Syntax for the command is : "@var{frequency}"
2705
2706 @item width_type, t
2707 Change bandpass width_type.
2708 Syntax for the command is : "@var{width_type}"
2709
2710 @item width, w
2711 Change bandpass width.
2712 Syntax for the command is : "@var{width}"
2713
2714 @item mix, m
2715 Change bandpass mix.
2716 Syntax for the command is : "@var{mix}"
2717 @end table
2718
2719 @section bandreject
2720
2721 Apply a two-pole Butterworth band-reject filter with central
2722 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
2723 The filter roll off at 6dB per octave (20dB per decade).
2724
2725 The filter accepts the following options:
2726
2727 @table @option
2728 @item frequency, f
2729 Set the filter's central frequency. Default is @code{3000}.
2730
2731 @item width_type, t
2732 Set method to specify band-width of filter.
2733 @table @option
2734 @item h
2735 Hz
2736 @item q
2737 Q-Factor
2738 @item o
2739 octave
2740 @item s
2741 slope
2742 @item k
2743 kHz
2744 @end table
2745
2746 @item width, w
2747 Specify the band-width of a filter in width_type units.
2748
2749 @item mix, m
2750 How much to use filtered signal in output. Default is 1.
2751 Range is between 0 and 1.
2752
2753 @item channels, c
2754 Specify which channels to filter, by default all available are filtered.
2755
2756 @item normalize, n
2757 Normalize biquad coefficients, by default is disabled.
2758 Enabling it will normalize magnitude response at DC to 0dB.
2759 @end table
2760
2761 @subsection Commands
2762
2763 This filter supports the following commands:
2764 @table @option
2765 @item frequency, f
2766 Change bandreject frequency.
2767 Syntax for the command is : "@var{frequency}"
2768
2769 @item width_type, t
2770 Change bandreject width_type.
2771 Syntax for the command is : "@var{width_type}"
2772
2773 @item width, w
2774 Change bandreject width.
2775 Syntax for the command is : "@var{width}"
2776
2777 @item mix, m
2778 Change bandreject mix.
2779 Syntax for the command is : "@var{mix}"
2780 @end table
2781
2782 @section bass, lowshelf
2783
2784 Boost or cut the bass (lower) frequencies of the audio using a two-pole
2785 shelving filter with a response similar to that of a standard
2786 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
2787
2788 The filter accepts the following options:
2789
2790 @table @option
2791 @item gain, g
2792 Give the gain at 0 Hz. Its useful range is about -20
2793 (for a large cut) to +20 (for a large boost).
2794 Beware of clipping when using a positive gain.
2795
2796 @item frequency, f
2797 Set the filter's central frequency and so can be used
2798 to extend or reduce the frequency range to be boosted or cut.
2799 The default value is @code{100} Hz.
2800
2801 @item width_type, t
2802 Set method to specify band-width of filter.
2803 @table @option
2804 @item h
2805 Hz
2806 @item q
2807 Q-Factor
2808 @item o
2809 octave
2810 @item s
2811 slope
2812 @item k
2813 kHz
2814 @end table
2815
2816 @item width, w
2817 Determine how steep is the filter's shelf transition.
2818
2819 @item mix, m
2820 How much to use filtered signal in output. Default is 1.
2821 Range is between 0 and 1.
2822
2823 @item channels, c
2824 Specify which channels to filter, by default all available are filtered.
2825
2826 @item normalize, n
2827 Normalize biquad coefficients, by default is disabled.
2828 Enabling it will normalize magnitude response at DC to 0dB.
2829 @end table
2830
2831 @subsection Commands
2832
2833 This filter supports the following commands:
2834 @table @option
2835 @item frequency, f
2836 Change bass frequency.
2837 Syntax for the command is : "@var{frequency}"
2838
2839 @item width_type, t
2840 Change bass width_type.
2841 Syntax for the command is : "@var{width_type}"
2842
2843 @item width, w
2844 Change bass width.
2845 Syntax for the command is : "@var{width}"
2846
2847 @item gain, g
2848 Change bass gain.
2849 Syntax for the command is : "@var{gain}"
2850
2851 @item mix, m
2852 Change bass mix.
2853 Syntax for the command is : "@var{mix}"
2854 @end table
2855
2856 @section biquad
2857
2858 Apply a biquad IIR filter with the given coefficients.
2859 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
2860 are the numerator and denominator coefficients respectively.
2861 and @var{channels}, @var{c} specify which channels to filter, by default all
2862 available are filtered.
2863
2864 @subsection Commands
2865
2866 This filter supports the following commands:
2867 @table @option
2868 @item a0
2869 @item a1
2870 @item a2
2871 @item b0
2872 @item b1
2873 @item b2
2874 Change biquad parameter.
2875 Syntax for the command is : "@var{value}"
2876
2877 @item mix, m
2878 How much to use filtered signal in output. Default is 1.
2879 Range is between 0 and 1.
2880
2881 @item channels, c
2882 Specify which channels to filter, by default all available are filtered.
2883
2884 @item normalize, n
2885 Normalize biquad coefficients, by default is disabled.
2886 Enabling it will normalize magnitude response at DC to 0dB.
2887 @end table
2888
2889 @section bs2b
2890 Bauer stereo to binaural transformation, which improves headphone listening of
2891 stereo audio records.
2892
2893 To enable compilation of this filter you need to configure FFmpeg with
2894 @code{--enable-libbs2b}.
2895
2896 It accepts the following parameters:
2897 @table @option
2898
2899 @item profile
2900 Pre-defined crossfeed level.
2901 @table @option
2902
2903 @item default
2904 Default level (fcut=700, feed=50).
2905
2906 @item cmoy
2907 Chu Moy circuit (fcut=700, feed=60).
2908
2909 @item jmeier
2910 Jan Meier circuit (fcut=650, feed=95).
2911
2912 @end table
2913
2914 @item fcut
2915 Cut frequency (in Hz).
2916
2917 @item feed
2918 Feed level (in Hz).
2919
2920 @end table
2921
2922 @section channelmap
2923
2924 Remap input channels to new locations.
2925
2926 It accepts the following parameters:
2927 @table @option
2928 @item map
2929 Map channels from input to output. The argument is a '|'-separated list of
2930 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
2931 @var{in_channel} form. @var{in_channel} can be either the name of the input
2932 channel (e.g. FL for front left) or its index in the input channel layout.
2933 @var{out_channel} is the name of the output channel or its index in the output
2934 channel layout. If @var{out_channel} is not given then it is implicitly an
2935 index, starting with zero and increasing by one for each mapping.
2936
2937 @item channel_layout
2938 The channel layout of the output stream.
2939 @end table
2940
2941 If no mapping is present, the filter will implicitly map input channels to
2942 output channels, preserving indices.
2943
2944 @subsection Examples
2945
2946 @itemize
2947 @item
2948 For example, assuming a 5.1+downmix input MOV file,
2949 @example
2950 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
2951 @end example
2952 will create an output WAV file tagged as stereo from the downmix channels of
2953 the input.
2954
2955 @item
2956 To fix a 5.1 WAV improperly encoded in AAC's native channel order
2957 @example
2958 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
2959 @end example
2960 @end itemize
2961
2962 @section channelsplit
2963
2964 Split each channel from an input audio stream into a separate output stream.
2965
2966 It accepts the following parameters:
2967 @table @option
2968 @item channel_layout
2969 The channel layout of the input stream. The default is "stereo".
2970 @item channels
2971 A channel layout describing the channels to be extracted as separate output streams
2972 or "all" to extract each input channel as a separate stream. The default is "all".
2973
2974 Choosing channels not present in channel layout in the input will result in an error.
2975 @end table
2976
2977 @subsection Examples
2978
2979 @itemize
2980 @item
2981 For example, assuming a stereo input MP3 file,
2982 @example
2983 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
2984 @end example
2985 will create an output Matroska file with two audio streams, one containing only
2986 the left channel and the other the right channel.
2987
2988 @item
2989 Split a 5.1 WAV file into per-channel files:
2990 @example
2991 ffmpeg -i in.wav -filter_complex
2992 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
2993 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
2994 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
2995 side_right.wav
2996 @end example
2997
2998 @item
2999 Extract only LFE from a 5.1 WAV file:
3000 @example
3001 ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
3002 -map '[LFE]' lfe.wav
3003 @end example
3004 @end itemize
3005
3006 @section chorus
3007 Add a chorus effect to the audio.
3008
3009 Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
3010
3011 Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
3012 constant, with chorus, it is varied using using sinusoidal or triangular modulation.
3013 The modulation depth defines the range the modulated delay is played before or after
3014 the delay. Hence the delayed sound will sound slower or faster, that is the delayed
3015 sound tuned around the original one, like in a chorus where some vocals are slightly
3016 off key.
3017
3018 It accepts the following parameters:
3019 @table @option
3020 @item in_gain
3021 Set input gain. Default is 0.4.
3022
3023 @item out_gain
3024 Set output gain. Default is 0.4.
3025
3026 @item delays
3027 Set delays. A typical delay is around 40ms to 60ms.
3028
3029 @item decays
3030 Set decays.
3031
3032 @item speeds
3033 Set speeds.
3034
3035 @item depths
3036 Set depths.
3037 @end table
3038
3039 @subsection Examples
3040
3041 @itemize
3042 @item
3043 A single delay:
3044 @example
3045 chorus=0.7:0.9:55:0.4:0.25:2
3046 @end example
3047
3048 @item
3049 Two delays:
3050 @example
3051 chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
3052 @end example
3053
3054 @item
3055 Fuller sounding chorus with three delays:
3056 @example
3057 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
3058 @end example
3059 @end itemize
3060
3061 @section compand
3062 Compress or expand the audio's dynamic range.
3063
3064 It accepts the following parameters:
3065
3066 @table @option
3067
3068 @item attacks
3069 @item decays
3070 A list of times in seconds for each channel over which the instantaneous level
3071 of the input signal is averaged to determine its volume. @var{attacks} refers to
3072 increase of volume and @var{decays} refers to decrease of volume. For most
3073 situations, the attack time (response to the audio getting louder) should be
3074 shorter than the decay time, because the human ear is more sensitive to sudden
3075 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
3076 a typical value for decay is 0.8 seconds.
3077 If specified number of attacks & decays is lower than number of channels, the last
3078 set attack/decay will be used for all remaining channels.
3079
3080 @item points
3081 A list of points for the transfer function, specified in dB relative to the
3082 maximum possible signal amplitude. Each key points list must be defined using
3083 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
3084 @code{x0/y0 x1/y1 x2/y2 ....}
3085
3086 The input values must be in strictly increasing order but the transfer function
3087 does not have to be monotonically rising. The point @code{0/0} is assumed but
3088 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
3089 function are @code{-70/-70|-60/-20|1/0}.
3090
3091 @item soft-knee
3092 Set the curve radius in dB for all joints. It defaults to 0.01.
3093
3094 @item gain
3095 Set the additional gain in dB to be applied at all points on the transfer
3096 function. This allows for easy adjustment of the overall gain.
3097 It defaults to 0.
3098
3099 @item volume
3100 Set an initial volume, in dB, to be assumed for each channel when filtering
3101 starts. This permits the user to supply a nominal level initially, so that, for
3102 example, a very large gain is not applied to initial signal levels before the
3103 companding has begun to operate. A typical value for audio which is initially
3104 quiet is -90 dB. It defaults to 0.
3105
3106 @item delay
3107 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
3108 delayed before being fed to the volume adjuster. Specifying a delay
3109 approximately equal to the attack/decay times allows the filter to effectively
3110 operate in predictive rather than reactive mode. It defaults to 0.
3111
3112 @end table
3113
3114 @subsection Examples
3115
3116 @itemize
3117 @item
3118 Make music with both quiet and loud passages suitable for listening to in a
3119 noisy environment:
3120 @example
3121 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
3122 @end example
3123
3124 Another example for audio with whisper and explosion parts:
3125 @example
3126 compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
3127 @end example
3128
3129 @item
3130 A noise gate for when the noise is at a lower level than the signal:
3131 @example
3132 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
3133 @end example
3134
3135 @item
3136 Here is another noise gate, this time for when the noise is at a higher level
3137 than the signal (making it, in some ways, similar to squelch):
3138 @example
3139 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
3140 @end example
3141
3142 @item
3143 2:1 compression starting at -6dB:
3144 @example
3145 compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
3146 @end example
3147
3148 @item
3149 2:1 compression starting at -9dB:
3150 @example
3151 compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
3152 @end example
3153
3154 @item
3155 2:1 compression starting at -12dB:
3156 @example
3157 compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
3158 @end example
3159
3160 @item
3161 2:1 compression starting at -18dB:
3162 @example
3163 compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
3164 @end example
3165
3166 @item
3167 3:1 compression starting at -15dB:
3168 @example
3169 compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
3170 @end example
3171
3172 @item
3173 Compressor/Gate:
3174 @example
3175 compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
3176 @end example
3177
3178 @item
3179 Expander:
3180 @example
3181 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
3182 @end example
3183
3184 @item
3185 Hard limiter at -6dB:
3186 @example
3187 compand=attacks=0:points=-80/-80|-6/-6|20/-6
3188 @end example
3189
3190 @item
3191 Hard limiter at -12dB:
3192 @example
3193 compand=attacks=0:points=-80/-80|-12/-12|20/-12
3194 @end example
3195
3196 @item
3197 Hard noise gate at -35 dB:
3198 @example
3199 compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
3200 @end example
3201
3202 @item
3203 Soft limiter:
3204 @example
3205 compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
3206 @end example
3207 @end itemize
3208
3209 @section compensationdelay
3210
3211 Compensation Delay Line is a metric based delay to compensate differing
3212 positions of microphones or speakers.
3213
3214 For example, you have recorded guitar with two microphones placed in
3215 different locations. Because the front of sound wave has fixed speed in
3216 normal conditions, the phasing of microphones can vary and depends on
3217 their location and interposition. The best sound mix can be achieved when
3218 these microphones are in phase (synchronized). Note that a distance of
3219 ~30 cm between microphones makes one microphone capture the signal in
3220 antiphase to the other microphone. That makes the final mix sound moody.
3221 This filter helps to solve phasing problems by adding different delays
3222 to each microphone track and make them synchronized.
3223
3224 The best result can be reached when you take one track as base and
3225 synchronize other tracks one by one with it.
3226 Remember that synchronization/delay tolerance depends on sample rate, too.
3227 Higher sample rates will give more tolerance.
3228
3229 The filter accepts the following parameters:
3230
3231 @table @option
3232 @item mm
3233 Set millimeters distance. This is compensation distance for fine tuning.
3234 Default is 0.
3235
3236 @item cm
3237 Set cm distance. This is compensation distance for tightening distance setup.
3238 Default is 0.
3239
3240 @item m
3241 Set meters distance. This is compensation distance for hard distance setup.
3242 Default is 0.
3243
3244 @item dry
3245 Set dry amount. Amount of unprocessed (dry) signal.
3246 Default is 0.
3247
3248 @item wet
3249 Set wet amount. Amount of processed (wet) signal.
3250 Default is 1.
3251
3252 @item temp
3253 Set temperature in degrees Celsius. This is the temperature of the environment.
3254 Default is 20.
3255 @end table
3256
3257 @section crossfeed
3258 Apply headphone crossfeed filter.
3259
3260 Crossfeed is the process of blending the left and right channels of stereo
3261 audio recording.
3262 It is mainly used to reduce extreme stereo separation of low frequencies.
3263
3264 The intent is to produce more speaker like sound to the listener.
3265
3266 The filter accepts the following options:
3267
3268 @table @option
3269 @item strength
3270 Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1.
3271 This sets gain of low shelf filter for side part of stereo image.
3272 Default is -6dB. Max allowed is -30db when strength is set to 1.
3273
3274 @item range
3275 Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1.
3276 This sets cut off frequency of low shelf filter. Default is cut off near
3277 1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz.
3278
3279 @item slope
3280 Set curve slope of low shelf filter. Default is 0.5.
3281 Allowed range is from 0.01 to 1.
3282
3283 @item level_in
3284 Set input gain. Default is 0.9.
3285
3286 @item level_out
3287 Set output gain. Default is 1.
3288 @end table
3289
3290 @subsection Commands
3291
3292 This filter supports the all above options as @ref{commands}.
3293
3294 @section crystalizer
3295 Simple algorithm to expand audio dynamic range.
3296
3297 The filter accepts the following options:
3298
3299 @table @option
3300 @item i
3301 Sets the intensity of effect (default: 2.0). Must be in range between 0.0
3302 (unchanged sound) to 10.0 (maximum effect).
3303
3304 @item c
3305 Enable clipping. By default is enabled.
3306 @end table
3307
3308 @subsection Commands
3309
3310 This filter supports the all above options as @ref{commands}.
3311
3312 @section dcshift
3313 Apply a DC shift to the audio.
3314
3315 This can be useful to remove a DC offset (caused perhaps by a hardware problem
3316 in the recording chain) from the audio. The effect of a DC offset is reduced
3317 headroom and hence volume. The @ref{astats} filter can be used to determine if
3318 a signal has a DC offset.
3319
3320 @table @option
3321 @item shift
3322 Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
3323 the audio.
3324
3325 @item limitergain
3326 Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
3327 used to prevent clipping.
3328 @end table
3329
3330 @section deesser
3331
3332 Apply de-essing to the audio samples.
3333
3334 @table @option
3335 @item i
3336 Set intensity for triggering de-essing. Allowed range is from 0 to 1.
3337 Default is 0.
3338
3339 @item m
3340 Set amount of ducking on treble part of sound. Allowed range is from 0 to 1.
3341 Default is 0.5.
3342
3343 @item f
3344 How much of original frequency content to keep when de-essing. Allowed range is from 0 to 1.
3345 Default is 0.5.
3346
3347 @item s
3348 Set the output mode.
3349
3350 It accepts the following values:
3351 @table @option
3352 @item i
3353 Pass input unchanged.
3354
3355 @item o
3356 Pass ess filtered out.
3357
3358 @item e
3359 Pass only ess.
3360
3361 Default value is @var{o}.
3362 @end table
3363
3364 @end table
3365
3366 @section drmeter
3367 Measure audio dynamic range.
3368
3369 DR values of 14 and higher is found in very dynamic material. DR of 8 to 13
3370 is found in transition material. And anything less that 8 have very poor dynamics
3371 and is very compressed.
3372
3373 The filter accepts the following options:
3374
3375 @table @option
3376 @item length
3377 Set window length in seconds used to split audio into segments of equal length.
3378 Default is 3 seconds.
3379 @end table
3380
3381 @section dynaudnorm
3382 Dynamic Audio Normalizer.
3383
3384 This filter applies a certain amount of gain to the input audio in order
3385 to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
3386 contrast to more "simple" normalization algorithms, the Dynamic Audio
3387 Normalizer *dynamically* re-adjusts the gain factor to the input audio.
3388 This allows for applying extra gain to the "quiet" sections of the audio
3389 while avoiding distortions or clipping the "loud" sections. In other words:
3390 The Dynamic Audio Normalizer will "even out" the volume of quiet and loud
3391 sections, in the sense that the volume of each section is brought to the
3392 same target level. Note, however, that the Dynamic Audio Normalizer achieves
3393 this goal *without* applying "dynamic range compressing". It will retain 100%
3394 of the dynamic range *within* each section of the audio file.
3395
3396 @table @option
3397 @item framelen, f
3398 Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
3399 Default is 500 milliseconds.
3400 The Dynamic Audio Normalizer processes the input audio in small chunks,
3401 referred to as frames. This is required, because a peak magnitude has no
3402 meaning for just a single sample value. Instead, we need to determine the
3403 peak magnitude for a contiguous sequence of sample values. While a "standard"
3404 normalizer would simply use the peak magnitude of the complete file, the
3405 Dynamic Audio Normalizer determines the peak magnitude individually for each
3406 frame. The length of a frame is specified in milliseconds. By default, the
3407 Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
3408 been found to give good results with most files.
3409 Note that the exact frame length, in number of samples, will be determined
3410 automatically, based on the sampling rate of the individual input audio file.
3411
3412 @item gausssize, g
3413 Set the Gaussian filter window size. In range from 3 to 301, must be odd
3414 number. Default is 31.
3415 Probably the most important parameter of the Dynamic Audio Normalizer is the
3416 @code{window size} of the Gaussian smoothing filter. The filter's window size
3417 is specified in frames, centered around the current frame. For the sake of
3418 simplicity, this must be an odd number. Consequently, the default value of 31
3419 takes into account the current frame, as well as the 15 preceding frames and
3420 the 15 subsequent frames. Using a larger window results in a stronger
3421 smoothing effect and thus in less gain variation, i.e. slower gain
3422 adaptation. Conversely, using a smaller window results in a weaker smoothing
3423 effect and thus in more gain variation, i.e. faster gain adaptation.
3424 In other words, the more you increase this value, the more the Dynamic Audio
3425 Normalizer will behave like a "traditional" normalization filter. On the
3426 contrary, the more you decrease this value, the more the Dynamic Audio
3427 Normalizer will behave like a dynamic range compressor.
3428
3429 @item peak, p
3430 Set the target peak value. This specifies the highest permissible magnitude
3431 level for the normalized audio input. This filter will try to approach the
3432 target peak magnitude as closely as possible, but at the same time it also
3433 makes sure that the normalized signal will never exceed the peak magnitude.
3434 A frame's maximum local gain factor is imposed directly by the target peak
3435 magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
3436 It is not recommended to go above this value.
3437
3438 @item maxgain, m
3439 Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
3440 The Dynamic Audio Normalizer determines the maximum possible (local) gain
3441 factor for each input frame, i.e. the maximum gain factor that does not
3442 result in clipping or distortion. The maximum gain factor is determined by
3443 the frame's highest magnitude sample. However, the Dynamic Audio Normalizer
3444 additionally bounds the frame's maximum gain factor by a predetermined
3445 (global) maximum gain factor. This is done in order to avoid excessive gain
3446 factors in "silent" or almost silent frames. By default, the maximum gain
3447 factor is 10.0, For most inputs the default value should be sufficient and
3448 it usually is not recommended to increase this value. Though, for input
3449 with an extremely low overall volume level, it may be necessary to allow even
3450 higher gain factors. Note, however, that the Dynamic Audio Normalizer does
3451 not simply apply a "hard" threshold (i.e. cut off values above the threshold).
3452 Instead, a "sigmoid" threshold function will be applied. This way, the
3453 gain factors will smoothly approach the threshold value, but never exceed that
3454 value.
3455
3456 @item targetrms, r
3457 Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
3458 By default, the Dynamic Audio Normalizer performs "peak" normalization.
3459 This means that the maximum local gain factor for each frame is defined
3460 (only) by the frame's highest magnitude sample. This way, the samples can
3461 be amplified as much as possible without exceeding the maximum signal
3462 level, i.e. without clipping. Optionally, however, the Dynamic Audio
3463 Normalizer can also take into account the frame's root mean square,
3464 abbreviated RMS. In electrical engineering, the RMS is commonly used to
3465 determine the power of a time-varying signal. It is therefore considered
3466 that the RMS is a better approximation of the "perceived loudness" than
3467 just looking at the signal's peak magnitude. Consequently, by adjusting all
3468 frames to a constant RMS value, a uniform "perceived loudness" can be
3469 established. If a target RMS value has been specified, a frame's local gain
3470 factor is defined as the factor that would result in exactly that RMS value.
3471 Note, however, that the maximum local gain factor is still restricted by the
3472 frame's highest magnitude sample, in order to prevent clipping.
3473
3474 @item coupling, n
3475 Enable channels coupling. By default is enabled.
3476 By default, the Dynamic Audio Normalizer will amplify all channels by the same
3477 amount. This means the same gain factor will be applied to all channels, i.e.
3478 the maximum possible gain factor is determined by the "loudest" channel.
3479 However, in some recordings, it may happen that the volume of the different
3480 channels is uneven, e.g. one channel may be "quieter" than the other one(s).
3481 In this case, this option can be used to disable the channel coupling. This way,
3482 the gain factor will be determined independently for each channel, depending
3483 only on the individual channel's highest magnitude sample. This allows for
3484 harmonizing the volume of the different channels.
3485
3486 @item correctdc, c
3487 Enable DC bias correction. By default is disabled.
3488 An audio signal (in the time domain) is a sequence of sample values.
3489 In the Dynamic Audio Normalizer these sample values are represented in the
3490 -1.0 to 1.0 range, regardless of the original input format. Normally, the
3491 audio signal, or "waveform", should be centered around the zero point.
3492 That means if we calculate the mean value of all samples in a file, or in a
3493 single frame, then the result should be 0.0 or at least very close to that
3494 value. If, however, there is a significant deviation of the mean value from
3495 0.0, in either positive or negative direction, this is referred to as a
3496 DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
3497 Audio Normalizer provides optional DC bias correction.
3498 With DC bias correction enabled, the Dynamic Audio Normalizer will determine
3499 the mean value, or "DC correction" offset, of each input frame and subtract
3500 that value from all of the frame's sample values which ensures those samples
3501 are centered around 0.0 again. Also, in order to avoid "gaps" at the frame
3502 boundaries, the DC correction offset values will be interpolated smoothly
3503 between neighbouring frames.
3504
3505 @item altboundary, b
3506 Enable alternative boundary mode. By default is disabled.
3507 The Dynamic Audio Normalizer takes into account a certain neighbourhood
3508 around each frame. This includes the preceding frames as well as the
3509 subsequent frames. However, for the "boundary" frames, located at the very
3510 beginning and at the very end of the audio file, not all neighbouring
3511 frames are available. In particular, for the first few frames in the audio
3512 file, the preceding frames are not known. And, similarly, for the last few
3513 frames in the audio file, the subsequent frames are not known. Thus, the
3514 question arises which gain factors should be assumed for the missing frames
3515 in the "boundary" region. The Dynamic Audio Normalizer implements two modes
3516 to deal with this situation. The default boundary mode assumes a gain factor
3517 of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and
3518 "fade out" at the beginning and at the end of the input, respectively.
3519
3520 @item compress, s
3521 Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
3522 By default, the Dynamic Audio Normalizer does not apply "traditional"
3523 compression. This means that signal peaks will not be pruned and thus the
3524 full dynamic range will be retained within each local neighbourhood. However,
3525 in some cases it may be desirable to combine the Dynamic Audio Normalizer's
3526 normalization algorithm with a more "traditional" compression.
3527 For this purpose, the Dynamic Audio Normalizer provides an optional compression
3528 (thresholding) function. If (and only if) the compression feature is enabled,
3529 all input frames will be processed by a soft knee thresholding function prior
3530 to the actual normalization process. Put simply, the thresholding function is
3531 going to prune all samples whose magnitude exceeds a certain threshold value.
3532 However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
3533 value. Instead, the threshold value will be adjusted for each individual
3534 frame.
3535 In general, smaller parameters result in stronger compression, and vice versa.
3536 Values below 3.0 are not recommended, because audible distortion may appear.
3537
3538 @item threshold, t
3539 Set the target threshold value. This specifies the lowest permissible
3540 magnitude level for the audio input which will be normalized.
3541 If input frame volume is above this value frame will be normalized.
3542 Otherwise frame may not be normalized at all. The default value is set
3543 to 0, which means all input frames will be normalized.
3544 This option is mostly useful if digital noise is not wanted to be amplified.
3545 @end table
3546
3547 @subsection Commands
3548
3549 This filter supports the all above options as @ref{commands}.
3550
3551 @section earwax
3552
3553 Make audio easier to listen to on headphones.
3554
3555 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
3556 so that when listened to on headphones the stereo image is moved from
3557 inside your head (standard for headphones) to outside and in front of
3558 the listener (standard for speakers).
3559
3560 Ported from SoX.
3561
3562 @section equalizer
3563
3564 Apply a two-pole peaking equalisation (EQ) filter. With this
3565 filter, the signal-level at and around a selected frequency can
3566 be increased or decreased, whilst (unlike bandpass and bandreject
3567 filters) that at all other frequencies is unchanged.
3568
3569 In order to produce complex equalisation curves, this filter can
3570 be given several times, each with a different central frequency.
3571
3572 The filter accepts the following options:
3573
3574 @table @option
3575 @item frequency, f
3576 Set the filter's central frequency in Hz.
3577
3578 @item width_type, t
3579 Set method to specify band-width of filter.
3580 @table @option
3581 @item h
3582 Hz
3583 @item q
3584 Q-Factor
3585 @item o
3586 octave
3587 @item s
3588 slope
3589 @item k
3590 kHz
3591 @end table
3592
3593 @item width, w
3594 Specify the band-width of a filter in width_type units.
3595
3596 @item gain, g
3597 Set the required gain or attenuation in dB.
3598 Beware of clipping when using a positive gain.
3599
3600 @item mix, m
3601 How much to use filtered signal in output. Default is 1.
3602 Range is between 0 and 1.
3603
3604 @item channels, c
3605 Specify which channels to filter, by default all available are filtered.
3606
3607 @item normalize, n
3608 Normalize biquad coefficients, by default is disabled.
3609 Enabling it will normalize magnitude response at DC to 0dB.
3610 @end table
3611
3612 @subsection Examples
3613 @itemize
3614 @item
3615 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
3616 @example
3617 equalizer=f=1000:t=h:width=200:g=-10
3618 @end example
3619
3620 @item
3621 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
3622 @example
3623 equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
3624 @end example
3625 @end itemize
3626
3627 @subsection Commands
3628
3629 This filter supports the following commands:
3630 @table @option
3631 @item frequency, f
3632 Change equalizer frequency.
3633 Syntax for the command is : "@var{frequency}"
3634
3635 @item width_type, t
3636 Change equalizer width_type.
3637 Syntax for the command is : "@var{width_type}"
3638
3639 @item width, w
3640 Change equalizer width.
3641 Syntax for the command is : "@var{width}"
3642
3643 @item gain, g
3644 Change equalizer gain.
3645 Syntax for the command is : "@var{gain}"
3646
3647 @item mix, m
3648 Change equalizer mix.
3649 Syntax for the command is : "@var{mix}"
3650 @end table
3651
3652 @section extrastereo
3653
3654 Linearly increases the difference between left and right channels which
3655 adds some sort of "live" effect to playback.
3656
3657 The filter accepts the following options:
3658
3659 @table @option
3660 @item m
3661 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
3662 (average of both channels), with 1.0 sound will be unchanged, with
3663 -1.0 left and right channels will be swapped.
3664
3665 @item c
3666 Enable clipping. By default is enabled.
3667 @end table
3668
3669 @subsection Commands
3670
3671 This filter supports the all above options as @ref{commands}.
3672
3673 @section firequalizer
3674 Apply FIR Equalization using arbitrary frequency response.
3675
3676 The filter accepts the following option:
3677
3678 @table @option
3679 @item gain
3680 Set gain curve equation (in dB). The expression can contain variables:
3681 @table @option
3682 @item f
3683 the evaluated frequency
3684 @item sr
3685 sample rate
3686 @item ch
3687 channel number, set to 0 when multichannels evaluation is disabled
3688 @item chid
3689 channel id, see libavutil/channel_layout.h, set to the first channel id when
3690 multichannels evaluation is disabled
3691 @item chs
3692 number of channels
3693 @item chlayout
3694 channel_layout, see libavutil/channel_layout.h
3695
3696 @end table
3697 and functions:
3698 @table @option
3699 @item gain_interpolate(f)
3700 interpolate gain on frequency f based on gain_entry
3701 @item cubic_interpolate(f)
3702 same as gain_interpolate, but smoother
3703 @end table
3704 This option is also available as command. Default is @code{gain_interpolate(f)}.
3705
3706 @item gain_entry
3707 Set gain entry for gain_interpolate function. The expression can
3708 contain functions:
3709 @table @option
3710 @item entry(f, g)
3711 store gain entry at frequency f with value g
3712 @end table
3713 This option is also available as command.
3714
3715 @item delay
3716 Set filter delay in seconds. Higher value means more accurate.
3717 Default is @code{0.01}.
3718
3719 @item accuracy
3720 Set filter accuracy in Hz. Lower value means more accurate.
3721 Default is @code{5}.
3722
3723 @item wfunc
3724 Set window function. Acceptable values are:
3725 @table @option
3726 @item rectangular
3727 rectangular window, useful when gain curve is already smooth
3728 @item hann
3729 hann window (default)
3730 @item hamming
3731 hamming window
3732 @item blackman
3733 blackman window
3734 @item nuttall3
3735 3-terms continuous 1st derivative nuttall window
3736 @item mnuttall3
3737 minimum 3-terms discontinuous nuttall window
3738 @item nuttall
3739 4-terms continuous 1st derivative nuttall window
3740 @item bnuttall
3741 minimum 4-terms discontinuous nuttall (blackman-nuttall) window
3742 @item bharris
3743 blackman-harris window
3744 @item tukey
3745 tukey window
3746 @end table
3747
3748 @item fixed
3749 If enabled, use fixed number of audio samples. This improves speed when
3750 filtering with large delay. Default is disabled.
3751
3752 @item multi
3753 Enable multichannels evaluation on gain. Default is disabled.
3754
3755 @item zero_phase
3756 Enable zero phase mode by subtracting timestamp to compensate delay.
3757 Default is disabled.
3758
3759 @item scale
3760 Set scale used by gain. Acceptable values are:
3761 @table @option
3762 @item linlin
3763 linear frequency, linear gain
3764 @item linlog
3765 linear frequency, logarithmic (in dB) gain (default)
3766 @item loglin
3767 logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain
3768 @item loglog
3769 logarithmic frequency, logarithmic gain
3770 @end table
3771
3772 @item dumpfile
3773 Set file for dumping, suitable for gnuplot.
3774
3775 @item dumpscale
3776 Set scale for dumpfile. Acceptable values are same with scale option.
3777 Default is linlog.
3778
3779 @item fft2
3780 Enable 2-channel convolution using complex FFT. This improves speed significantly.
3781 Default is disabled.
3782
3783 @item min_phase
3784 Enable minimum phase impulse response. Default is disabled.
3785 @end table
3786
3787 @subsection Examples
3788 @itemize
3789 @item
3790 lowpass at 1000 Hz:
3791 @example
3792 firequalizer=gain='if(lt(f,1000), 0, -INF)'
3793 @end example
3794 @item
3795 lowpass at 1000 Hz with gain_entry:
3796 @example
3797 firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
3798 @end example
3799 @item
3800 custom equalization:
3801 @example
3802 firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
3803 @end example
3804 @item
3805 higher delay with zero phase to compensate delay:
3806 @example
3807 firequalizer=delay=0.1:fixed=on:zero_phase=on
3808 @end example
3809 @item
3810 lowpass on left channel, highpass on right channel:
3811 @example
3812 firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
3813 :gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
3814 @end example
3815 @end itemize
3816
3817 @section flanger
3818 Apply a flanging effect to the audio.
3819
3820 The filter accepts the following options:
3821
3822 @table @option
3823 @item delay
3824 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
3825
3826 @item depth
3827 Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2.
3828
3829 @item regen
3830 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
3831 Default value is 0.
3832
3833 @item width
3834 Set percentage of delayed signal mixed with original. Range from 0 to 100.
3835 Default value is 71.
3836
3837 @item speed
3838 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
3839
3840 @item shape
3841 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
3842 Default value is @var{sinusoidal}.
3843
3844 @item phase