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