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