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