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