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