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