1e872e4cf91c0a21233f30a3faa6dba9a8d7b021
[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 @section asoftclip
2108 Apply audio soft clipping.
2109
2110 Soft clipping is a type of distortion effect where the amplitude of a signal is saturated
2111 along a smooth curve, rather than the abrupt shape of hard-clipping.
2112
2113 This filter accepts the following options:
2114
2115 @table @option
2116 @item type
2117 Set type of soft-clipping.
2118
2119 It accepts the following values:
2120 @table @option
2121 @item tanh
2122 @item atan
2123 @item cubic
2124 @item exp
2125 @item alg
2126 @item quintic
2127 @item sin
2128 @end table
2129
2130 @item param
2131 Set additional parameter which controls sigmoid function.
2132 @end table
2133
2134 @section asr
2135 Automatic Speech Recognition
2136
2137 This filter uses PocketSphinx for speech recognition. To enable
2138 compilation of this filter, you need to configure FFmpeg with
2139 @code{--enable-pocketsphinx}.
2140
2141 It accepts the following options:
2142
2143 @table @option
2144 @item rate
2145 Set sampling rate of input audio. Defaults is @code{16000}.
2146 This need to match speech models, otherwise one will get poor results.
2147
2148 @item hmm
2149 Set dictionary containing acoustic model files.
2150
2151 @item dict
2152 Set pronunciation dictionary.
2153
2154 @item lm
2155 Set language model file.
2156
2157 @item lmctl
2158 Set language model set.
2159
2160 @item lmname
2161 Set which language model to use.
2162
2163 @item logfn
2164 Set output for log messages.
2165 @end table
2166
2167 The filter exports recognized speech as the frame metadata @code{lavfi.asr.text}.
2168
2169 @anchor{astats}
2170 @section astats
2171
2172 Display time domain statistical information about the audio channels.
2173 Statistics are calculated and displayed for each audio channel and,
2174 where applicable, an overall figure is also given.
2175
2176 It accepts the following option:
2177 @table @option
2178 @item length
2179 Short window length in seconds, used for peak and trough RMS measurement.
2180 Default is @code{0.05} (50 milliseconds). Allowed range is @code{[0.01 - 10]}.
2181
2182 @item metadata
2183
2184 Set metadata injection. All the metadata keys are prefixed with @code{lavfi.astats.X},
2185 where @code{X} is channel number starting from 1 or string @code{Overall}. Default is
2186 disabled.
2187
2188 Available keys for each channel are:
2189 DC_offset
2190 Min_level
2191 Max_level
2192 Min_difference
2193 Max_difference
2194 Mean_difference
2195 RMS_difference
2196 Peak_level
2197 RMS_peak
2198 RMS_trough
2199 Crest_factor
2200 Flat_factor
2201 Peak_count
2202 Bit_depth
2203 Dynamic_range
2204 Zero_crossings
2205 Zero_crossings_rate
2206 Number_of_NaNs
2207 Number_of_Infs
2208 Number_of_denormals
2209
2210 and for Overall:
2211 DC_offset
2212 Min_level
2213 Max_level
2214 Min_difference
2215 Max_difference
2216 Mean_difference
2217 RMS_difference
2218 Peak_level
2219 RMS_level
2220 RMS_peak
2221 RMS_trough
2222 Flat_factor
2223 Peak_count
2224 Bit_depth
2225 Number_of_samples
2226 Number_of_NaNs
2227 Number_of_Infs
2228 Number_of_denormals
2229
2230 For example full key look like this @code{lavfi.astats.1.DC_offset} or
2231 this @code{lavfi.astats.Overall.Peak_count}.
2232
2233 For description what each key means read below.
2234
2235 @item reset
2236 Set number of frame after which stats are going to be recalculated.
2237 Default is disabled.
2238
2239 @item measure_perchannel
2240 Select the entries which need to be measured per channel. The metadata keys can
2241 be used as flags, default is @option{all} which measures everything.
2242 @option{none} disables all per channel measurement.
2243
2244 @item measure_overall
2245 Select the entries which need to be measured overall. The metadata keys can
2246 be used as flags, default is @option{all} which measures everything.
2247 @option{none} disables all overall measurement.
2248
2249 @end table
2250
2251 A description of each shown parameter follows:
2252
2253 @table @option
2254 @item DC offset
2255 Mean amplitude displacement from zero.
2256
2257 @item Min level
2258 Minimal sample level.
2259
2260 @item Max level
2261 Maximal sample level.
2262
2263 @item Min difference
2264 Minimal difference between two consecutive samples.
2265
2266 @item Max difference
2267 Maximal difference between two consecutive samples.
2268
2269 @item Mean difference
2270 Mean difference between two consecutive samples.
2271 The average of each difference between two consecutive samples.
2272
2273 @item RMS difference
2274 Root Mean Square difference between two consecutive samples.
2275
2276 @item Peak level dB
2277 @item RMS level dB
2278 Standard peak and RMS level measured in dBFS.
2279
2280 @item RMS peak dB
2281 @item RMS trough dB
2282 Peak and trough values for RMS level measured over a short window.
2283
2284 @item Crest factor
2285 Standard ratio of peak to RMS level (note: not in dB).
2286
2287 @item Flat factor
2288 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
2289 (i.e. either @var{Min level} or @var{Max level}).
2290
2291 @item Peak count
2292 Number of occasions (not the number of samples) that the signal attained either
2293 @var{Min level} or @var{Max level}.
2294
2295 @item Bit depth
2296 Overall bit depth of audio. Number of bits used for each sample.
2297
2298 @item Dynamic range
2299 Measured dynamic range of audio in dB.
2300
2301 @item Zero crossings
2302 Number of points where the waveform crosses the zero level axis.
2303
2304 @item Zero crossings rate
2305 Rate of Zero crossings and number of audio samples.
2306 @end table
2307
2308 @section atempo
2309
2310 Adjust audio tempo.
2311
2312 The filter accepts exactly one parameter, the audio tempo. If not
2313 specified then the filter will assume nominal 1.0 tempo. Tempo must
2314 be in the [0.5, 100.0] range.
2315
2316 Note that tempo greater than 2 will skip some samples rather than
2317 blend them in.  If for any reason this is a concern it is always
2318 possible to daisy-chain several instances of atempo to achieve the
2319 desired product tempo.
2320
2321 @subsection Examples
2322
2323 @itemize
2324 @item
2325 Slow down audio to 80% tempo:
2326 @example
2327 atempo=0.8
2328 @end example
2329
2330 @item
2331 To speed up audio to 300% tempo:
2332 @example
2333 atempo=3
2334 @end example
2335
2336 @item
2337 To speed up audio to 300% tempo by daisy-chaining two atempo instances:
2338 @example
2339 atempo=sqrt(3),atempo=sqrt(3)
2340 @end example
2341 @end itemize
2342
2343 @section atrim
2344
2345 Trim the input so that the output contains one continuous subpart of the input.
2346
2347 It accepts the following parameters:
2348 @table @option
2349 @item start
2350 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
2351 sample with the timestamp @var{start} will be the first sample in the output.
2352
2353 @item end
2354 Specify time of the first audio sample that will be dropped, i.e. the
2355 audio sample immediately preceding the one with the timestamp @var{end} will be
2356 the last sample in the output.
2357
2358 @item start_pts
2359 Same as @var{start}, except this option sets the start timestamp in samples
2360 instead of seconds.
2361
2362 @item end_pts
2363 Same as @var{end}, except this option sets the end timestamp in samples instead
2364 of seconds.
2365
2366 @item duration
2367 The maximum duration of the output in seconds.
2368
2369 @item start_sample
2370 The number of the first sample that should be output.
2371
2372 @item end_sample
2373 The number of the first sample that should be dropped.
2374 @end table
2375
2376 @option{start}, @option{end}, and @option{duration} are expressed as time
2377 duration specifications; see
2378 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
2379
2380 Note that the first two sets of the start/end options and the @option{duration}
2381 option look at the frame timestamp, while the _sample options simply count the
2382 samples that pass through the filter. So start/end_pts and start/end_sample will
2383 give different results when the timestamps are wrong, inexact or do not start at
2384 zero. Also note that this filter does not modify the timestamps. If you wish
2385 to have the output timestamps start at zero, insert the asetpts filter after the
2386 atrim filter.
2387
2388 If multiple start or end options are set, this filter tries to be greedy and
2389 keep all samples that match at least one of the specified constraints. To keep
2390 only the part that matches all the constraints at once, chain multiple atrim
2391 filters.
2392
2393 The defaults are such that all the input is kept. So it is possible to set e.g.
2394 just the end values to keep everything before the specified time.
2395
2396 Examples:
2397 @itemize
2398 @item
2399 Drop everything except the second minute of input:
2400 @example
2401 ffmpeg -i INPUT -af atrim=60:120
2402 @end example
2403
2404 @item
2405 Keep only the first 1000 samples:
2406 @example
2407 ffmpeg -i INPUT -af atrim=end_sample=1000
2408 @end example
2409
2410 @end itemize
2411
2412 @section bandpass
2413
2414 Apply a two-pole Butterworth band-pass filter with central
2415 frequency @var{frequency}, and (3dB-point) band-width width.
2416 The @var{csg} option selects a constant skirt gain (peak gain = Q)
2417 instead of the default: constant 0dB peak gain.
2418 The filter roll off at 6dB per octave (20dB per decade).
2419
2420 The filter accepts the following options:
2421
2422 @table @option
2423 @item frequency, f
2424 Set the filter's central frequency. Default is @code{3000}.
2425
2426 @item csg
2427 Constant skirt gain if set to 1. Defaults to 0.
2428
2429 @item width_type, t
2430 Set method to specify band-width of filter.
2431 @table @option
2432 @item h
2433 Hz
2434 @item q
2435 Q-Factor
2436 @item o
2437 octave
2438 @item s
2439 slope
2440 @item k
2441 kHz
2442 @end table
2443
2444 @item width, w
2445 Specify the band-width of a filter in width_type units.
2446
2447 @item channels, c
2448 Specify which channels to filter, by default all available are filtered.
2449 @end table
2450
2451 @subsection Commands
2452
2453 This filter supports the following commands:
2454 @table @option
2455 @item frequency, f
2456 Change bandpass frequency.
2457 Syntax for the command is : "@var{frequency}"
2458
2459 @item width_type, t
2460 Change bandpass width_type.
2461 Syntax for the command is : "@var{width_type}"
2462
2463 @item width, w
2464 Change bandpass width.
2465 Syntax for the command is : "@var{width}"
2466 @end table
2467
2468 @section bandreject
2469
2470 Apply a two-pole Butterworth band-reject filter with central
2471 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
2472 The filter roll off at 6dB per octave (20dB per decade).
2473
2474 The filter accepts the following options:
2475
2476 @table @option
2477 @item frequency, f
2478 Set the filter's central frequency. Default is @code{3000}.
2479
2480 @item width_type, t
2481 Set method to specify band-width of filter.
2482 @table @option
2483 @item h
2484 Hz
2485 @item q
2486 Q-Factor
2487 @item o
2488 octave
2489 @item s
2490 slope
2491 @item k
2492 kHz
2493 @end table
2494
2495 @item width, w
2496 Specify the band-width of a filter in width_type units.
2497
2498 @item channels, c
2499 Specify which channels to filter, by default all available are filtered.
2500 @end table
2501
2502 @subsection Commands
2503
2504 This filter supports the following commands:
2505 @table @option
2506 @item frequency, f
2507 Change bandreject frequency.
2508 Syntax for the command is : "@var{frequency}"
2509
2510 @item width_type, t
2511 Change bandreject width_type.
2512 Syntax for the command is : "@var{width_type}"
2513
2514 @item width, w
2515 Change bandreject width.
2516 Syntax for the command is : "@var{width}"
2517 @end table
2518
2519 @section bass, lowshelf
2520
2521 Boost or cut the bass (lower) frequencies of the audio using a two-pole
2522 shelving filter with a response similar to that of a standard
2523 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
2524
2525 The filter accepts the following options:
2526
2527 @table @option
2528 @item gain, g
2529 Give the gain at 0 Hz. Its useful range is about -20
2530 (for a large cut) to +20 (for a large boost).
2531 Beware of clipping when using a positive gain.
2532
2533 @item frequency, f
2534 Set the filter's central frequency and so can be used
2535 to extend or reduce the frequency range to be boosted or cut.
2536 The default value is @code{100} Hz.
2537
2538 @item width_type, t
2539 Set method to specify band-width of filter.
2540 @table @option
2541 @item h
2542 Hz
2543 @item q
2544 Q-Factor
2545 @item o
2546 octave
2547 @item s
2548 slope
2549 @item k
2550 kHz
2551 @end table
2552
2553 @item width, w
2554 Determine how steep is the filter's shelf transition.
2555
2556 @item channels, c
2557 Specify which channels to filter, by default all available are filtered.
2558 @end table
2559
2560 @subsection Commands
2561
2562 This filter supports the following commands:
2563 @table @option
2564 @item frequency, f
2565 Change bass frequency.
2566 Syntax for the command is : "@var{frequency}"
2567
2568 @item width_type, t
2569 Change bass width_type.
2570 Syntax for the command is : "@var{width_type}"
2571
2572 @item width, w
2573 Change bass width.
2574 Syntax for the command is : "@var{width}"
2575
2576 @item gain, g
2577 Change bass gain.
2578 Syntax for the command is : "@var{gain}"
2579 @end table
2580
2581 @section biquad
2582
2583 Apply a biquad IIR filter with the given coefficients.
2584 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
2585 are the numerator and denominator coefficients respectively.
2586 and @var{channels}, @var{c} specify which channels to filter, by default all
2587 available are filtered.
2588
2589 @subsection Commands
2590
2591 This filter supports the following commands:
2592 @table @option
2593 @item a0
2594 @item a1
2595 @item a2
2596 @item b0
2597 @item b1
2598 @item b2
2599 Change biquad parameter.
2600 Syntax for the command is : "@var{value}"
2601 @end table
2602
2603 @section bs2b
2604 Bauer stereo to binaural transformation, which improves headphone listening of
2605 stereo audio records.
2606
2607 To enable compilation of this filter you need to configure FFmpeg with
2608 @code{--enable-libbs2b}.
2609
2610 It accepts the following parameters:
2611 @table @option
2612
2613 @item profile
2614 Pre-defined crossfeed level.
2615 @table @option
2616
2617 @item default
2618 Default level (fcut=700, feed=50).
2619
2620 @item cmoy
2621 Chu Moy circuit (fcut=700, feed=60).
2622
2623 @item jmeier
2624 Jan Meier circuit (fcut=650, feed=95).
2625
2626 @end table
2627
2628 @item fcut
2629 Cut frequency (in Hz).
2630
2631 @item feed
2632 Feed level (in Hz).
2633
2634 @end table
2635
2636 @section channelmap
2637
2638 Remap input channels to new locations.
2639
2640 It accepts the following parameters:
2641 @table @option
2642 @item map
2643 Map channels from input to output. The argument is a '|'-separated list of
2644 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
2645 @var{in_channel} form. @var{in_channel} can be either the name of the input
2646 channel (e.g. FL for front left) or its index in the input channel layout.
2647 @var{out_channel} is the name of the output channel or its index in the output
2648 channel layout. If @var{out_channel} is not given then it is implicitly an
2649 index, starting with zero and increasing by one for each mapping.
2650
2651 @item channel_layout
2652 The channel layout of the output stream.
2653 @end table
2654
2655 If no mapping is present, the filter will implicitly map input channels to
2656 output channels, preserving indices.
2657
2658 @subsection Examples
2659
2660 @itemize
2661 @item
2662 For example, assuming a 5.1+downmix input MOV file,
2663 @example
2664 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
2665 @end example
2666 will create an output WAV file tagged as stereo from the downmix channels of
2667 the input.
2668
2669 @item
2670 To fix a 5.1 WAV improperly encoded in AAC's native channel order
2671 @example
2672 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
2673 @end example
2674 @end itemize
2675
2676 @section channelsplit
2677
2678 Split each channel from an input audio stream into a separate output stream.
2679
2680 It accepts the following parameters:
2681 @table @option
2682 @item channel_layout
2683 The channel layout of the input stream. The default is "stereo".
2684 @item channels
2685 A channel layout describing the channels to be extracted as separate output streams
2686 or "all" to extract each input channel as a separate stream. The default is "all".
2687
2688 Choosing channels not present in channel layout in the input will result in an error.
2689 @end table
2690
2691 @subsection Examples
2692
2693 @itemize
2694 @item
2695 For example, assuming a stereo input MP3 file,
2696 @example
2697 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
2698 @end example
2699 will create an output Matroska file with two audio streams, one containing only
2700 the left channel and the other the right channel.
2701
2702 @item
2703 Split a 5.1 WAV file into per-channel files:
2704 @example
2705 ffmpeg -i in.wav -filter_complex
2706 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
2707 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
2708 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
2709 side_right.wav
2710 @end example
2711
2712 @item
2713 Extract only LFE from a 5.1 WAV file:
2714 @example
2715 ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
2716 -map '[LFE]' lfe.wav
2717 @end example
2718 @end itemize
2719
2720 @section chorus
2721 Add a chorus effect to the audio.
2722
2723 Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
2724
2725 Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
2726 constant, with chorus, it is varied using using sinusoidal or triangular modulation.
2727 The modulation depth defines the range the modulated delay is played before or after
2728 the delay. Hence the delayed sound will sound slower or faster, that is the delayed
2729 sound tuned around the original one, like in a chorus where some vocals are slightly
2730 off key.
2731
2732 It accepts the following parameters:
2733 @table @option
2734 @item in_gain
2735 Set input gain. Default is 0.4.
2736
2737 @item out_gain
2738 Set output gain. Default is 0.4.
2739
2740 @item delays
2741 Set delays. A typical delay is around 40ms to 60ms.
2742
2743 @item decays
2744 Set decays.
2745
2746 @item speeds
2747 Set speeds.
2748
2749 @item depths
2750 Set depths.
2751 @end table
2752
2753 @subsection Examples
2754
2755 @itemize
2756 @item
2757 A single delay:
2758 @example
2759 chorus=0.7:0.9:55:0.4:0.25:2
2760 @end example
2761
2762 @item
2763 Two delays:
2764 @example
2765 chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
2766 @end example
2767
2768 @item
2769 Fuller sounding chorus with three delays:
2770 @example
2771 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
2772 @end example
2773 @end itemize
2774
2775 @section compand
2776 Compress or expand the audio's dynamic range.
2777
2778 It accepts the following parameters:
2779
2780 @table @option
2781
2782 @item attacks
2783 @item decays
2784 A list of times in seconds for each channel over which the instantaneous level
2785 of the input signal is averaged to determine its volume. @var{attacks} refers to
2786 increase of volume and @var{decays} refers to decrease of volume. For most
2787 situations, the attack time (response to the audio getting louder) should be
2788 shorter than the decay time, because the human ear is more sensitive to sudden
2789 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
2790 a typical value for decay is 0.8 seconds.
2791 If specified number of attacks & decays is lower than number of channels, the last
2792 set attack/decay will be used for all remaining channels.
2793
2794 @item points
2795 A list of points for the transfer function, specified in dB relative to the
2796 maximum possible signal amplitude. Each key points list must be defined using
2797 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
2798 @code{x0/y0 x1/y1 x2/y2 ....}
2799
2800 The input values must be in strictly increasing order but the transfer function
2801 does not have to be monotonically rising. The point @code{0/0} is assumed but
2802 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
2803 function are @code{-70/-70|-60/-20|1/0}.
2804
2805 @item soft-knee
2806 Set the curve radius in dB for all joints. It defaults to 0.01.
2807
2808 @item gain
2809 Set the additional gain in dB to be applied at all points on the transfer
2810 function. This allows for easy adjustment of the overall gain.
2811 It defaults to 0.
2812
2813 @item volume
2814 Set an initial volume, in dB, to be assumed for each channel when filtering
2815 starts. This permits the user to supply a nominal level initially, so that, for
2816 example, a very large gain is not applied to initial signal levels before the
2817 companding has begun to operate. A typical value for audio which is initially
2818 quiet is -90 dB. It defaults to 0.
2819
2820 @item delay
2821 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
2822 delayed before being fed to the volume adjuster. Specifying a delay
2823 approximately equal to the attack/decay times allows the filter to effectively
2824 operate in predictive rather than reactive mode. It defaults to 0.
2825
2826 @end table
2827
2828 @subsection Examples
2829
2830 @itemize
2831 @item
2832 Make music with both quiet and loud passages suitable for listening to in a
2833 noisy environment:
2834 @example
2835 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
2836 @end example
2837
2838 Another example for audio with whisper and explosion parts:
2839 @example
2840 compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
2841 @end example
2842
2843 @item
2844 A noise gate for when the noise is at a lower level than the signal:
2845 @example
2846 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
2847 @end example
2848
2849 @item
2850 Here is another noise gate, this time for when the noise is at a higher level
2851 than the signal (making it, in some ways, similar to squelch):
2852 @example
2853 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
2854 @end example
2855
2856 @item
2857 2:1 compression starting at -6dB:
2858 @example
2859 compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
2860 @end example
2861
2862 @item
2863 2:1 compression starting at -9dB:
2864 @example
2865 compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
2866 @end example
2867
2868 @item
2869 2:1 compression starting at -12dB:
2870 @example
2871 compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
2872 @end example
2873
2874 @item
2875 2:1 compression starting at -18dB:
2876 @example
2877 compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
2878 @end example
2879
2880 @item
2881 3:1 compression starting at -15dB:
2882 @example
2883 compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
2884 @end example
2885
2886 @item
2887 Compressor/Gate:
2888 @example
2889 compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
2890 @end example
2891
2892 @item
2893 Expander:
2894 @example
2895 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
2896 @end example
2897
2898 @item
2899 Hard limiter at -6dB:
2900 @example
2901 compand=attacks=0:points=-80/-80|-6/-6|20/-6
2902 @end example
2903
2904 @item
2905 Hard limiter at -12dB:
2906 @example
2907 compand=attacks=0:points=-80/-80|-12/-12|20/-12
2908 @end example
2909
2910 @item
2911 Hard noise gate at -35 dB:
2912 @example
2913 compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
2914 @end example
2915
2916 @item
2917 Soft limiter:
2918 @example
2919 compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
2920 @end example
2921 @end itemize
2922
2923 @section compensationdelay
2924
2925 Compensation Delay Line is a metric based delay to compensate differing
2926 positions of microphones or speakers.
2927
2928 For example, you have recorded guitar with two microphones placed in
2929 different location. Because the front of sound wave has fixed speed in
2930 normal conditions, the phasing of microphones can vary and depends on
2931 their location and interposition. The best sound mix can be achieved when
2932 these microphones are in phase (synchronized). Note that distance of
2933 ~30 cm between microphones makes one microphone to capture signal in
2934 antiphase to another microphone. That makes the final mix sounding moody.
2935 This filter helps to solve phasing problems by adding different delays
2936 to each microphone track and make them synchronized.
2937
2938 The best result can be reached when you take one track as base and
2939 synchronize other tracks one by one with it.
2940 Remember that synchronization/delay tolerance depends on sample rate, too.
2941 Higher sample rates will give more tolerance.
2942
2943 It accepts the following parameters:
2944
2945 @table @option
2946 @item mm
2947 Set millimeters distance. This is compensation distance for fine tuning.
2948 Default is 0.
2949
2950 @item cm
2951 Set cm distance. This is compensation distance for tightening distance setup.
2952 Default is 0.
2953
2954 @item m
2955 Set meters distance. This is compensation distance for hard distance setup.
2956 Default is 0.
2957
2958 @item dry
2959 Set dry amount. Amount of unprocessed (dry) signal.
2960 Default is 0.
2961
2962 @item wet
2963 Set wet amount. Amount of processed (wet) signal.
2964 Default is 1.
2965
2966 @item temp
2967 Set temperature degree in Celsius. This is the temperature of the environment.
2968 Default is 20.
2969 @end table
2970
2971 @section crossfeed
2972 Apply headphone crossfeed filter.
2973
2974 Crossfeed is the process of blending the left and right channels of stereo
2975 audio recording.
2976 It is mainly used to reduce extreme stereo separation of low frequencies.
2977
2978 The intent is to produce more speaker like sound to the listener.
2979
2980 The filter accepts the following options:
2981
2982 @table @option
2983 @item strength
2984 Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1.
2985 This sets gain of low shelf filter for side part of stereo image.
2986 Default is -6dB. Max allowed is -30db when strength is set to 1.
2987
2988 @item range
2989 Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1.
2990 This sets cut off frequency of low shelf filter. Default is cut off near
2991 1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz.
2992
2993 @item level_in
2994 Set input gain. Default is 0.9.
2995
2996 @item level_out
2997 Set output gain. Default is 1.
2998 @end table
2999
3000 @section crystalizer
3001 Simple algorithm to expand audio dynamic range.
3002
3003 The filter accepts the following options:
3004
3005 @table @option
3006 @item i
3007 Sets the intensity of effect (default: 2.0). Must be in range between 0.0
3008 (unchanged sound) to 10.0 (maximum effect).
3009
3010 @item c
3011 Enable clipping. By default is enabled.
3012 @end table
3013
3014 @section dcshift
3015 Apply a DC shift to the audio.
3016
3017 This can be useful to remove a DC offset (caused perhaps by a hardware problem
3018 in the recording chain) from the audio. The effect of a DC offset is reduced
3019 headroom and hence volume. The @ref{astats} filter can be used to determine if
3020 a signal has a DC offset.
3021
3022 @table @option
3023 @item shift
3024 Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
3025 the audio.
3026
3027 @item limitergain
3028 Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
3029 used to prevent clipping.
3030 @end table
3031
3032 @section drmeter
3033 Measure audio dynamic range.
3034
3035 DR values of 14 and higher is found in very dynamic material. DR of 8 to 13
3036 is found in transition material. And anything less that 8 have very poor dynamics
3037 and is very compressed.
3038
3039 The filter accepts the following options:
3040
3041 @table @option
3042 @item length
3043 Set window length in seconds used to split audio into segments of equal length.
3044 Default is 3 seconds.
3045 @end table
3046
3047 @section dynaudnorm
3048 Dynamic Audio Normalizer.
3049
3050 This filter applies a certain amount of gain to the input audio in order
3051 to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
3052 contrast to more "simple" normalization algorithms, the Dynamic Audio
3053 Normalizer *dynamically* re-adjusts the gain factor to the input audio.
3054 This allows for applying extra gain to the "quiet" sections of the audio
3055 while avoiding distortions or clipping the "loud" sections. In other words:
3056 The Dynamic Audio Normalizer will "even out" the volume of quiet and loud
3057 sections, in the sense that the volume of each section is brought to the
3058 same target level. Note, however, that the Dynamic Audio Normalizer achieves
3059 this goal *without* applying "dynamic range compressing". It will retain 100%
3060 of the dynamic range *within* each section of the audio file.
3061
3062 @table @option
3063 @item f
3064 Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
3065 Default is 500 milliseconds.
3066 The Dynamic Audio Normalizer processes the input audio in small chunks,
3067 referred to as frames. This is required, because a peak magnitude has no
3068 meaning for just a single sample value. Instead, we need to determine the
3069 peak magnitude for a contiguous sequence of sample values. While a "standard"
3070 normalizer would simply use the peak magnitude of the complete file, the
3071 Dynamic Audio Normalizer determines the peak magnitude individually for each
3072 frame. The length of a frame is specified in milliseconds. By default, the
3073 Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
3074 been found to give good results with most files.
3075 Note that the exact frame length, in number of samples, will be determined
3076 automatically, based on the sampling rate of the individual input audio file.
3077
3078 @item g
3079 Set the Gaussian filter window size. In range from 3 to 301, must be odd
3080 number. Default is 31.
3081 Probably the most important parameter of the Dynamic Audio Normalizer is the
3082 @code{window size} of the Gaussian smoothing filter. The filter's window size
3083 is specified in frames, centered around the current frame. For the sake of
3084 simplicity, this must be an odd number. Consequently, the default value of 31
3085 takes into account the current frame, as well as the 15 preceding frames and
3086 the 15 subsequent frames. Using a larger window results in a stronger
3087 smoothing effect and thus in less gain variation, i.e. slower gain
3088 adaptation. Conversely, using a smaller window results in a weaker smoothing
3089 effect and thus in more gain variation, i.e. faster gain adaptation.
3090 In other words, the more you increase this value, the more the Dynamic Audio
3091 Normalizer will behave like a "traditional" normalization filter. On the
3092 contrary, the more you decrease this value, the more the Dynamic Audio
3093 Normalizer will behave like a dynamic range compressor.
3094
3095 @item p
3096 Set the target peak value. This specifies the highest permissible magnitude
3097 level for the normalized audio input. This filter will try to approach the
3098 target peak magnitude as closely as possible, but at the same time it also
3099 makes sure that the normalized signal will never exceed the peak magnitude.
3100 A frame's maximum local gain factor is imposed directly by the target peak
3101 magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
3102 It is not recommended to go above this value.
3103
3104 @item m
3105 Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
3106 The Dynamic Audio Normalizer determines the maximum possible (local) gain
3107 factor for each input frame, i.e. the maximum gain factor that does not
3108 result in clipping or distortion. The maximum gain factor is determined by
3109 the frame's highest magnitude sample. However, the Dynamic Audio Normalizer
3110 additionally bounds the frame's maximum gain factor by a predetermined
3111 (global) maximum gain factor. This is done in order to avoid excessive gain
3112 factors in "silent" or almost silent frames. By default, the maximum gain
3113 factor is 10.0, For most inputs the default value should be sufficient and
3114 it usually is not recommended to increase this value. Though, for input
3115 with an extremely low overall volume level, it may be necessary to allow even
3116 higher gain factors. Note, however, that the Dynamic Audio Normalizer does
3117 not simply apply a "hard" threshold (i.e. cut off values above the threshold).
3118 Instead, a "sigmoid" threshold function will be applied. This way, the
3119 gain factors will smoothly approach the threshold value, but never exceed that
3120 value.
3121
3122 @item r
3123 Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
3124 By default, the Dynamic Audio Normalizer performs "peak" normalization.
3125 This means that the maximum local gain factor for each frame is defined
3126 (only) by the frame's highest magnitude sample. This way, the samples can
3127 be amplified as much as possible without exceeding the maximum signal
3128 level, i.e. without clipping. Optionally, however, the Dynamic Audio
3129 Normalizer can also take into account the frame's root mean square,
3130 abbreviated RMS. In electrical engineering, the RMS is commonly used to
3131 determine the power of a time-varying signal. It is therefore considered
3132 that the RMS is a better approximation of the "perceived loudness" than
3133 just looking at the signal's peak magnitude. Consequently, by adjusting all
3134 frames to a constant RMS value, a uniform "perceived loudness" can be
3135 established. If a target RMS value has been specified, a frame's local gain
3136 factor is defined as the factor that would result in exactly that RMS value.
3137 Note, however, that the maximum local gain factor is still restricted by the
3138 frame's highest magnitude sample, in order to prevent clipping.
3139
3140 @item n
3141 Enable channels coupling. By default is enabled.
3142 By default, the Dynamic Audio Normalizer will amplify all channels by the same
3143 amount. This means the same gain factor will be applied to all channels, i.e.
3144 the maximum possible gain factor is determined by the "loudest" channel.
3145 However, in some recordings, it may happen that the volume of the different
3146 channels is uneven, e.g. one channel may be "quieter" than the other one(s).
3147 In this case, this option can be used to disable the channel coupling. This way,
3148 the gain factor will be determined independently for each channel, depending
3149 only on the individual channel's highest magnitude sample. This allows for
3150 harmonizing the volume of the different channels.
3151
3152 @item c
3153 Enable DC bias correction. By default is disabled.
3154 An audio signal (in the time domain) is a sequence of sample values.
3155 In the Dynamic Audio Normalizer these sample values are represented in the
3156 -1.0 to 1.0 range, regardless of the original input format. Normally, the
3157 audio signal, or "waveform", should be centered around the zero point.
3158 That means if we calculate the mean value of all samples in a file, or in a
3159 single frame, then the result should be 0.0 or at least very close to that
3160 value. If, however, there is a significant deviation of the mean value from
3161 0.0, in either positive or negative direction, this is referred to as a
3162 DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
3163 Audio Normalizer provides optional DC bias correction.
3164 With DC bias correction enabled, the Dynamic Audio Normalizer will determine
3165 the mean value, or "DC correction" offset, of each input frame and subtract
3166 that value from all of the frame's sample values which ensures those samples
3167 are centered around 0.0 again. Also, in order to avoid "gaps" at the frame
3168 boundaries, the DC correction offset values will be interpolated smoothly
3169 between neighbouring frames.
3170
3171 @item b
3172 Enable alternative boundary mode. By default is disabled.
3173 The Dynamic Audio Normalizer takes into account a certain neighbourhood
3174 around each frame. This includes the preceding frames as well as the
3175 subsequent frames. However, for the "boundary" frames, located at the very
3176 beginning and at the very end of the audio file, not all neighbouring
3177 frames are available. In particular, for the first few frames in the audio
3178 file, the preceding frames are not known. And, similarly, for the last few
3179 frames in the audio file, the subsequent frames are not known. Thus, the
3180 question arises which gain factors should be assumed for the missing frames
3181 in the "boundary" region. The Dynamic Audio Normalizer implements two modes
3182 to deal with this situation. The default boundary mode assumes a gain factor
3183 of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and
3184 "fade out" at the beginning and at the end of the input, respectively.
3185
3186 @item s
3187 Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
3188 By default, the Dynamic Audio Normalizer does not apply "traditional"
3189 compression. This means that signal peaks will not be pruned and thus the
3190 full dynamic range will be retained within each local neighbourhood. However,
3191 in some cases it may be desirable to combine the Dynamic Audio Normalizer's
3192 normalization algorithm with a more "traditional" compression.
3193 For this purpose, the Dynamic Audio Normalizer provides an optional compression
3194 (thresholding) function. If (and only if) the compression feature is enabled,
3195 all input frames will be processed by a soft knee thresholding function prior
3196 to the actual normalization process. Put simply, the thresholding function is
3197 going to prune all samples whose magnitude exceeds a certain threshold value.
3198 However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
3199 value. Instead, the threshold value will be adjusted for each individual
3200 frame.
3201 In general, smaller parameters result in stronger compression, and vice versa.
3202 Values below 3.0 are not recommended, because audible distortion may appear.
3203 @end table
3204
3205 @section earwax
3206
3207 Make audio easier to listen to on headphones.
3208
3209 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
3210 so that when listened to on headphones the stereo image is moved from
3211 inside your head (standard for headphones) to outside and in front of
3212 the listener (standard for speakers).
3213
3214 Ported from SoX.
3215
3216 @section equalizer
3217
3218 Apply a two-pole peaking equalisation (EQ) filter. With this
3219 filter, the signal-level at and around a selected frequency can
3220 be increased or decreased, whilst (unlike bandpass and bandreject
3221 filters) that at all other frequencies is unchanged.
3222
3223 In order to produce complex equalisation curves, this filter can
3224 be given several times, each with a different central frequency.
3225
3226 The filter accepts the following options:
3227
3228 @table @option
3229 @item frequency, f
3230 Set the filter's central frequency in Hz.
3231
3232 @item width_type, t
3233 Set method to specify band-width of filter.
3234 @table @option
3235 @item h
3236 Hz
3237 @item q
3238 Q-Factor
3239 @item o
3240 octave
3241 @item s
3242 slope
3243 @item k
3244 kHz
3245 @end table
3246
3247 @item width, w
3248 Specify the band-width of a filter in width_type units.
3249
3250 @item gain, g
3251 Set the required gain or attenuation in dB.
3252 Beware of clipping when using a positive gain.
3253
3254 @item channels, c
3255 Specify which channels to filter, by default all available are filtered.
3256 @end table
3257
3258 @subsection Examples
3259 @itemize
3260 @item
3261 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
3262 @example
3263 equalizer=f=1000:t=h:width=200:g=-10
3264 @end example
3265
3266 @item
3267 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
3268 @example
3269 equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
3270 @end example
3271 @end itemize
3272
3273 @subsection Commands
3274
3275 This filter supports the following commands:
3276 @table @option
3277 @item frequency, f
3278 Change equalizer frequency.
3279 Syntax for the command is : "@var{frequency}"
3280
3281 @item width_type, t
3282 Change equalizer width_type.
3283 Syntax for the command is : "@var{width_type}"
3284
3285 @item width, w
3286 Change equalizer width.
3287 Syntax for the command is : "@var{width}"
3288
3289 @item gain, g
3290 Change equalizer gain.
3291 Syntax for the command is : "@var{gain}"
3292 @end table
3293
3294 @section extrastereo
3295
3296 Linearly increases the difference between left and right channels which
3297 adds some sort of "live" effect to playback.
3298
3299 The filter accepts the following options:
3300
3301 @table @option
3302 @item m
3303 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
3304 (average of both channels), with 1.0 sound will be unchanged, with
3305 -1.0 left and right channels will be swapped.
3306
3307 @item c
3308 Enable clipping. By default is enabled.
3309 @end table
3310
3311 @section firequalizer
3312 Apply FIR Equalization using arbitrary frequency response.
3313
3314 The filter accepts the following option:
3315
3316 @table @option
3317 @item gain
3318 Set gain curve equation (in dB). The expression can contain variables:
3319 @table @option
3320 @item f
3321 the evaluated frequency
3322 @item sr
3323 sample rate
3324 @item ch
3325 channel number, set to 0 when multichannels evaluation is disabled
3326 @item chid
3327 channel id, see libavutil/channel_layout.h, set to the first channel id when
3328 multichannels evaluation is disabled
3329 @item chs
3330 number of channels
3331 @item chlayout
3332 channel_layout, see libavutil/channel_layout.h
3333
3334 @end table
3335 and functions:
3336 @table @option
3337 @item gain_interpolate(f)
3338 interpolate gain on frequency f based on gain_entry
3339 @item cubic_interpolate(f)
3340 same as gain_interpolate, but smoother
3341 @end table
3342 This option is also available as command. Default is @code{gain_interpolate(f)}.
3343
3344 @item gain_entry
3345 Set gain entry for gain_interpolate function. The expression can
3346 contain functions:
3347 @table @option
3348 @item entry(f, g)
3349 store gain entry at frequency f with value g
3350 @end table
3351 This option is also available as command.
3352
3353 @item delay
3354 Set filter delay in seconds. Higher value means more accurate.
3355 Default is @code{0.01}.
3356
3357 @item accuracy
3358 Set filter accuracy in Hz. Lower value means more accurate.
3359 Default is @code{5}.
3360
3361 @item wfunc
3362 Set window function. Acceptable values are:
3363 @table @option
3364 @item rectangular
3365 rectangular window, useful when gain curve is already smooth
3366 @item hann
3367 hann window (default)
3368 @item hamming
3369 hamming window
3370 @item blackman
3371 blackman window
3372 @item nuttall3
3373 3-terms continuous 1st derivative nuttall window
3374 @item mnuttall3
3375 minimum 3-terms discontinuous nuttall window
3376 @item nuttall
3377 4-terms continuous 1st derivative nuttall window
3378 @item bnuttall
3379 minimum 4-terms discontinuous nuttall (blackman-nuttall) window
3380 @item bharris
3381 blackman-harris window
3382 @item tukey
3383 tukey window
3384 @end table
3385
3386 @item fixed
3387 If enabled, use fixed number of audio samples. This improves speed when
3388 filtering with large delay. Default is disabled.
3389
3390 @item multi
3391 Enable multichannels evaluation on gain. Default is disabled.
3392
3393 @item zero_phase
3394 Enable zero phase mode by subtracting timestamp to compensate delay.
3395 Default is disabled.
3396
3397 @item scale
3398 Set scale used by gain. Acceptable values are:
3399 @table @option
3400 @item linlin
3401 linear frequency, linear gain
3402 @item linlog
3403 linear frequency, logarithmic (in dB) gain (default)
3404 @item loglin
3405 logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain
3406 @item loglog
3407 logarithmic frequency, logarithmic gain
3408 @end table
3409
3410 @item dumpfile
3411 Set file for dumping, suitable for gnuplot.
3412
3413 @item dumpscale
3414 Set scale for dumpfile. Acceptable values are same with scale option.
3415 Default is linlog.
3416
3417 @item fft2
3418 Enable 2-channel convolution using complex FFT. This improves speed significantly.
3419 Default is disabled.
3420
3421 @item min_phase
3422 Enable minimum phase impulse response. Default is disabled.
3423 @end table
3424
3425 @subsection Examples
3426 @itemize
3427 @item
3428 lowpass at 1000 Hz:
3429 @example
3430 firequalizer=gain='if(lt(f,1000), 0, -INF)'
3431 @end example
3432 @item
3433 lowpass at 1000 Hz with gain_entry:
3434 @example
3435 firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
3436 @end example
3437 @item
3438 custom equalization:
3439 @example
3440 firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
3441 @end example
3442 @item
3443 higher delay with zero phase to compensate delay:
3444 @example
3445 firequalizer=delay=0.1:fixed=on:zero_phase=on
3446 @end example
3447 @item
3448 lowpass on left channel, highpass on right channel:
3449 @example
3450 firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
3451 :gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
3452 @end example
3453 @end itemize
3454
3455 @section flanger
3456 Apply a flanging effect to the audio.
3457
3458 The filter accepts the following options:
3459
3460 @table @option
3461 @item delay
3462 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
3463
3464 @item depth
3465 Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2.
3466
3467 @item regen
3468 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
3469 Default value is 0.
3470
3471 @item width
3472 Set percentage of delayed signal mixed with original. Range from 0 to 100.
3473 Default value is 71.
3474
3475 @item speed
3476 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
3477
3478 @item shape
3479 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
3480 Default value is @var{sinusoidal}.
3481
3482 @item phase
3483 Set swept wave percentage-shift for multi channel. Range from 0 to 100.
3484 Default value is 25.
3485
3486 @item interp
3487 Set delay-line interpolation, @var{linear} or @var{quadratic}.
3488 Default is @var{linear}.
3489 @end table
3490
3491 @section haas
3492 Apply Haas effect to audio.
3493
3494 Note that this makes most sense to apply on mono signals.
3495 With this filter applied to mono signals it give some directionality and
3496 stretches its stereo image.
3497
3498 The filter accepts the following options:
3499
3500 @table @option
3501 @item level_in
3502 Set input level. By default is @var{1}, or 0dB
3503
3504 @item level_out
3505 Set output level. By default is @var{1}, or 0dB.
3506
3507 @item side_gain
3508 Set gain applied to side part of signal. By default is @var{1}.
3509
3510 @item middle_source
3511 Set kind of middle source. Can be one of the following:
3512
3513 @table @samp
3514 @item left
3515 Pick left channel.
3516
3517 @item right
3518 Pick right channel.
3519
3520 @item mid
3521 Pick middle part signal of stereo image.
3522
3523 @item side
3524 Pick side part signal of stereo image.
3525 @end table
3526
3527 @item middle_phase
3528 Change middle phase. By default is disabled.
3529
3530 @item left_delay
3531 Set left channel delay. By default is @var{2.05} milliseconds.
3532
3533 @item left_balance
3534 Set left channel balance. By default is @var{-1}.
3535
3536 @item left_gain
3537 Set left channel gain. By default is @var{1}.
3538
3539 @item left_phase
3540 Change left phase. By default is disabled.
3541
3542 @item right_delay
3543 Set right channel delay. By defaults is @var{2.12} milliseconds.
3544
3545 @item right_balance
3546 Set right channel balance. By default is @var{1}.
3547
3548 @item right_gain
3549 Set right channel gain. By default is @var{1}.
3550
3551 @item right_phase
3552 Change right phase. By default is enabled.
3553 @end table
3554
3555 @section hdcd
3556
3557 Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with
3558 embedded HDCD codes is expanded into a 20-bit PCM stream.
3559
3560 The filter supports the Peak Extend and Low-level Gain Adjustment features
3561 of HDCD, and detects the Transient Filter flag.
3562
3563 @example
3564 ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
3565 @end example
3566
3567 When using the filter with wav, note the default encoding for wav is 16-bit,
3568 so the resulting 20-bit stream will be truncated back to 16-bit. Use something
3569 like @command{-acodec pcm_s24le} after the filter to get 24-bit PCM output.
3570 @example
3571 ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
3572 ffmpeg -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
3573 @end example
3574
3575 The filter accepts the following options:
3576
3577 @table @option
3578 @item disable_autoconvert
3579 Disable any automatic format conversion or resampling in the filter graph.
3580
3581 @item process_stereo
3582 Process the stereo channels together. If target_gain does not match between
3583 channels, consider it invalid and use the last valid target_gain.
3584
3585 @item cdt_ms
3586 Set the code detect timer period in ms.
3587
3588 @item force_pe
3589 Always extend peaks above -3dBFS even if PE isn't signaled.
3590
3591 @item analyze_mode
3592 Replace audio with a solid tone and adjust the amplitude to signal some
3593 specific aspect of the decoding process. The output file can be loaded in
3594 an audio editor alongside the original to aid analysis.
3595
3596 @code{analyze_mode=pe:force_pe=true} can be used to see all samples above the PE level.
3597
3598 Modes are:
3599 @table @samp
3600 @item 0, off
3601 Disabled
3602 @item 1, lle
3603 Gain adjustment level at each sample
3604 @item 2, pe
3605 Samples where peak extend occurs
3606 @item 3, cdt
3607 Samples where the code detect timer is active
3608 @item 4, tgm
3609 Samples where the target gain does not match between channels
3610 @end table
3611 @end table
3612
3613 @section headphone
3614
3615 Apply head-related transfer functions (HRTFs) to create virtual
3616 loudspeakers around the user for binaural listening via headphones.
3617 The HRIRs are provided via additional streams, for each channel
3618 one stereo input stream is needed.
3619
3620 The filter accepts the following options:
3621
3622 @table @option
3623 @item map
3624 Set mapping of input streams for convolution.
3625 The argument is a '|'-separated list of channel names in order as they
3626 are given as additional stream inputs for filter.
3627 This also specify number of input streams. Number of input streams
3628 must be not less than number of channels in first stream plus one.
3629
3630 @item gain
3631 Set gain applied to audio. Value is in dB. Default is 0.
3632
3633 @item type
3634 Set processing type. Can be @var{time} or @var{freq}. @var{time} is
3635 processing audio in time domain which is slow.
3636 @var{freq} is processing audio in frequency domain which is fast.
3637 Default is @var{freq}.
3638
3639 @item lfe
3640 Set custom gain for LFE channels. Value is in dB. Default is 0.
3641
3642 @item size
3643 Set size of frame in number of samples which will be processed at once.
3644 Default value is @var{1024}. Allowed range is from 1024 to 96000.
3645
3646 @item hrir
3647 Set format of hrir stream.
3648 Default value is @var{stereo}. Alternative value is @var{multich}.
3649 If value is set to @var{stereo}, number of additional streams should
3650 be greater or equal to number of input channels in first input stream.
3651 Also each additional stream should have stereo number of channels.
3652 If value is set to @var{multich}, number of additional streams should
3653 be exactly one. Also number of input channels of additional stream
3654 should be equal or greater than twice number of channels of first input
3655 stream.
3656 @end table
3657
3658 @subsection Examples
3659
3660 @itemize
3661 @item
3662 Full example using wav files as coefficients with amovie filters for 7.1 downmix,
3663 each amovie filter use stereo file with IR coefficients as input.
3664 The files give coefficients for each position of virtual loudspeaker:
3665 @example
3666 ffmpeg -i input.wav
3667 -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"
3668 output.wav
3669 @end example
3670
3671 @item
3672 Full example using wav files as coefficients with amovie filters for 7.1 downmix,
3673 but now in @var{multich} @var{hrir} format.
3674 @example
3675 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"
3676 output.wav
3677 @end example
3678 @end itemize
3679
3680 @section highpass
3681
3682 Apply a high-pass filter with 3dB point frequency.
3683 The filter can be either single-pole, or double-pole (the default).
3684 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
3685
3686 The filter accepts the following options:
3687
3688 @table @option
3689 @item frequency, f
3690 Set frequency in Hz. Default is 3000.
3691
3692 @item poles, p
3693 Set number of poles. Default is 2.
3694
3695 @item width_type, t
3696 Set method to specify band-width of filter.
3697 @table @option
3698 @item h
3699 Hz
3700 @item q
3701 Q-Factor
3702 @item o
3703 octave
3704 @item s
3705 slope
3706 @item k
3707 kHz
3708 @end table
3709
3710 @item width, w
3711 Specify the band-width of a filter in width_type units.
3712 Applies only to double-pole filter.
3713 The default is 0.707q and gives a Butterworth response.
3714
3715 @item channels, c
3716 Specify which channels to filter, by default all available are filtered.
3717 @end table
3718
3719 @subsection Commands
3720
3721 This filter supports the following commands:
3722 @table @option
3723 @item frequency, f
3724 Change highpass frequency.
3725 Syntax for the command is : "@var{frequency}"
3726
3727 @item width_type, t
3728 Change highpass width_type.
3729 Syntax for the command is : "@var{width_type}"
3730
3731 @item width, w
3732 Change highpass width.
3733 Syntax for the command is : "@var{width}"
3734 @end table
3735
3736 @section join
3737
3738 Join multiple input streams into one multi-channel stream.
3739
3740 It accepts the following parameters:
3741 @table @option
3742
3743 @item inputs
3744 The number of input streams. It defaults to 2.
3745
3746 @item channel_layout
3747 The desired output channel layout. It defaults to stereo.
3748
3749 @item map
3750 Map channels from inputs to output. The argument is a '|'-separated list of
3751 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
3752 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
3753 can be either the name of the input channel (e.g. FL for front left) or its
3754 index in the specified input stream. @var{out_channel} is the name of the output
3755 channel.
3756 @end table
3757
3758 The filter will attempt to guess the mappings when they are not specified
3759 explicitly. It does so by first trying to find an unused matching input channel
3760 and if that fails it picks the first unused input channel.
3761
3762 Join 3 inputs (with properly set channel layouts):
3763 @example
3764 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
3765 @end example
3766
3767 Build a 5.1 output from 6 single-channel streams:
3768 @example
3769 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
3770 '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'
3771 out
3772 @end example
3773
3774 @section ladspa
3775
3776 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
3777
3778 To enable compilation of this filter you need to configure FFmpeg with
3779 @code{--enable-ladspa}.
3780
3781 @table @option
3782 @item file, f
3783 Specifies the name of LADSPA plugin library to load. If the environment
3784 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
3785 each one of the directories specified by the colon separated list in
3786 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
3787 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
3788 @file{/usr/lib/ladspa/}.
3789
3790 @item plugin, p
3791 Specifies the plugin within the library. Some libraries contain only
3792 one plugin, but others contain many of them. If this is not set filter
3793 will list all available plugins within the specified library.
3794
3795 @item controls, c
3796 Set the '|' separated list of controls which are zero or more floating point
3797 values that determine the behavior of the loaded plugin (for example delay,
3798 threshold or gain).
3799 Controls need to be defined using the following syntax:
3800 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
3801 @var{valuei} is the value set on the @var{i}-th control.
3802 Alternatively they can be also defined using the following syntax:
3803 @var{value0}|@var{value1}|@var{value2}|..., where
3804 @var{valuei} is the value set on the @var{i}-th control.
3805 If @option{controls} is set to @code{help}, all available controls and
3806 their valid ranges are printed.
3807
3808 @item sample_rate, s
3809 Specify the sample rate, default to 44100. Only used if plugin have
3810 zero inputs.
3811
3812 @item nb_samples, n
3813 Set the number of samples per channel per each output frame, default
3814 is 1024. Only used if plugin have zero inputs.
3815
3816 @item duration, d
3817 Set the minimum duration of the sourced audio. See
3818 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
3819 for the accepted syntax.
3820 Note that the resulting duration may be greater than the specified duration,
3821 as the generated audio is always cut at the end of a complete frame.
3822 If not specified, or the expressed duration is negative, the audio is
3823 supposed to be generated forever.
3824 Only used if plugin have zero inputs.
3825
3826 @end table
3827
3828 @subsection Examples
3829
3830 @itemize
3831 @item
3832 List all available plugins within amp (LADSPA example plugin) library:
3833 @example
3834 ladspa=file=amp
3835 @end example
3836
3837 @item
3838 List all available controls and their valid ranges for @code{vcf_notch}
3839 plugin from @code{VCF} library:
3840 @example
3841 ladspa=f=vcf:p=vcf_notch:c=help
3842 @end example
3843
3844 @item
3845 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
3846 plugin library:
3847 @example
3848 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
3849 @end example
3850
3851 @item
3852 Add reverberation to the audio using TAP-plugins
3853 (Tom's Audio Processing plugins):
3854 @example
3855 ladspa=file=tap_reverb:tap_reverb
3856 @end example
3857
3858 @item
3859 Generate white noise, with 0.2 amplitude:
3860 @example
3861 ladspa=file=cmt:noise_source_white:c=c0=.2
3862 @end example
3863
3864 @item
3865 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
3866 @code{C* Audio Plugin Suite} (CAPS) library:
3867 @example
3868 ladspa=file=caps:Click:c=c1=20'
3869 @end example
3870
3871 @item
3872 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
3873 @example
3874 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
3875 @end example
3876
3877 @item
3878 Increase volume by 20dB using fast lookahead limiter from Steve Harris
3879 @code{SWH Plugins} collection:
3880 @example
3881 ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
3882 @end example
3883
3884 @item
3885 Attenuate low frequencies using Multiband EQ from Steve Harris
3886 @code{SWH Plugins} collection:
3887 @example
3888 ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
3889 @end example
3890
3891 @item
3892 Reduce stereo image using @code{Narrower} from the @code{C* Audio Plugin Suite}
3893 (CAPS) library:
3894 @example
3895 ladspa=caps:Narrower
3896 @end example
3897
3898 @item
3899 Another white noise, now using @code{C* Audio Plugin Suite} (CAPS) library:
3900 @example
3901 ladspa=caps:White:.2
3902 @end example
3903
3904 @item
3905 Some fractal noise, using @code{C* Audio Plugin Suite} (CAPS) library:
3906 @example
3907 ladspa=caps:Fractal:c=c1=1
3908 @end example
3909
3910 @item
3911 Dynamic volume normalization using @code{VLevel} plugin:
3912 @example
3913 ladspa=vlevel-ladspa:vlevel_mono
3914 @end example
3915 @end itemize
3916
3917 @subsection Commands
3918
3919 This filter supports the following commands:
3920 @table @option
3921 @item cN
3922 Modify the @var{N}-th control value.
3923
3924 If the specified value is not valid, it is ignored and prior one is kept.
3925 @end table
3926
3927 @section loudnorm
3928
3929 EBU R128 loudness normalization. Includes both dynamic and linear normalization modes.
3930 Support for both single pass (livestreams, files) and double pass (files) modes.
3931 This algorithm can target IL, LRA, and maximum true peak. To accurately detect true peaks,
3932 the audio stream will be upsampled to 192 kHz unless the normalization mode is linear.
3933 Use the @code{-ar} option or @code{aresample} filter to explicitly set an output sample rate.
3934
3935 The filter accepts the following options:
3936
3937 @table @option
3938 @item I, i
3939 Set integrated loudness target.
3940 Range is -70.0 - -5.0. Default value is -24.0.
3941
3942 @item LRA, lra
3943 Set loudness range target.
3944 Range is 1.0 - 20.0. Default value is 7.0.
3945
3946 @item TP, tp
3947 Set maximum true peak.
3948 Range is -9.0 - +0.0. Default value is -2.0.
3949
3950 @item measured_I, measured_i
3951 Measured IL of input file.
3952 Range is -99.0 - +0.0.
3953
3954 @item measured_LRA, measured_lra
3955 Measured LRA of input file.
3956 Range is  0.0 - 99.0.
3957
3958 @item measured_TP, measured_tp
3959 Measured true peak of input file.
3960 Range is  -99.0 - +99.0.
3961
3962 @item measured_thresh
3963 Measured threshold of input file.
3964 Range is -99.0 - +0.0.
3965
3966 @item offset
3967 Set offset gain. Gain is applied before the true-peak limiter.
3968 Range is  -99.0 - +99.0. Default is +0.0.
3969
3970 @item linear
3971 Normalize linearly if possible.
3972 measured_I, measured_LRA, measured_TP, and measured_thresh must also
3973 to be specified in order to use this mode.
3974 Options are true or false. Default is true.
3975
3976 @item dual_mono
3977 Treat mono input files as "dual-mono". If a mono file is intended for playback
3978 on a stereo system, its EBU R128 measurement will be perceptually incorrect.
3979 If set to @code{true}, this option will compensate for this effect.
3980 Multi-channel input files are not affected by this option.
3981 Options are true or false. Default is false.
3982
3983 @item print_format
3984 Set print format for stats. Options are summary, json, or none.
3985 Default value is none.
3986 @end table
3987
3988 @section lowpass
3989
3990 Apply a low-pass filter with 3dB point frequency.
3991 The filter can be either single-pole or double-pole (the default).
3992 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
3993
3994 The filter accepts the following options:
3995
3996 @table @option
3997 @item frequency, f
3998 Set frequency in Hz. Default is 500.
3999
4000 @item poles, p
4001 Set number of poles. Default is 2.
4002
4003 @item width_type, t
4004 Set method to specify band-width of filter.
4005 @table @option
4006 @item h
4007 Hz
4008 @item q
4009 Q-Factor
4010 @item o
4011 octave
4012 @item s
4013 slope
4014 @item k
4015 kHz
4016 @end table
4017
4018 @item width, w
4019 Specify the band-width of a filter in width_type units.
4020 Applies only to double-pole filter.
4021 The default is 0.707q and gives a Butterworth response.
4022
4023 @item channels, c
4024 Specify which channels to filter, by default all available are filtered.
4025 @end table
4026
4027 @subsection Examples
4028 @itemize
4029 @item
4030 Lowpass only LFE channel, it LFE is not present it does nothing:
4031 @example
4032 lowpass=c=LFE
4033 @end example
4034 @end itemize
4035
4036 @subsection Commands
4037
4038 This filter supports the following commands:
4039 @table @option
4040 @item frequency, f
4041 Change lowpass frequency.
4042 Syntax for the command is : "@var{frequency}"
4043
4044 @item width_type, t
4045 Change lowpass width_type.
4046 Syntax for the command is : "@var{width_type}"
4047
4048 @item width, w
4049 Change lowpass width.
4050 Syntax for the command is : "@var{width}"
4051 @end table
4052
4053 @section lv2
4054
4055 Load a LV2 (LADSPA Version 2) plugin.
4056
4057 To enable compilation of this filter you need to configure FFmpeg with
4058 @code{--enable-lv2}.
4059
4060 @table @option
4061 @item plugin, p
4062 Specifies the plugin URI. You may need to escape ':'.
4063
4064 @item controls, c
4065 Set the '|' separated list of controls which are zero or more floating point
4066 values that determine the behavior of the loaded plugin (for example delay,
4067 threshold or gain).
4068 If @option{controls} is set to @code{help}, all available controls and
4069 their valid ranges are printed.
4070
4071 @item sample_rate, s
4072 Specify the sample rate, default to 44100. Only used if plugin have
4073 zero inputs.
4074
4075 @item nb_samples, n
4076 Set the number of samples per channel per each output frame, default
4077 is 1024. Only used if plugin have zero inputs.
4078
4079 @item duration, d
4080 Set the minimum duration of the sourced audio. See
4081 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
4082 for the accepted syntax.
4083 Note that the resulting duration may be greater than the specified duration,
4084 as the generated audio is always cut at the end of a complete frame.
4085 If not specified, or the expressed duration is negative, the audio is
4086 supposed to be generated forever.
4087 Only used if plugin have zero inputs.
4088 @end table
4089
4090 @subsection Examples
4091
4092 @itemize
4093 @item
4094 Apply bass enhancer plugin from Calf:
4095 @example
4096 lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2
4097 @end example
4098
4099 @item
4100 Apply vinyl plugin from Calf:
4101 @example
4102 lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5
4103 @end example
4104
4105 @item
4106 Apply bit crusher plugin from ArtyFX:
4107 @example
4108 lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
4109 @end example
4110 @end itemize
4111
4112 @section mcompand
4113 Multiband Compress or expand the audio's dynamic range.
4114
4115 The input audio is divided into bands using 4th order Linkwitz-Riley IIRs.
4116 This is akin to the crossover of a loudspeaker, and results in flat frequency
4117 response when absent compander action.
4118
4119 It accepts the following parameters:
4120
4121 @table @option
4122 @item args
4123 This option syntax is:
4124 attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ...
4125 For explanation of each item refer to compand filter documentation.
4126 @end table
4127
4128 @anchor{pan}
4129 @section pan
4130
4131 Mix channels with specific gain levels. The filter accepts the output
4132 channel layout followed by a set of channels definitions.
4133
4134 This filter is also designed to efficiently remap the channels of an audio
4135 stream.
4136
4137 The filter accepts parameters of the form:
4138 "@var{l}|@var{outdef}|@var{outdef}|..."
4139
4140 @table @option
4141 @item l
4142 output channel layout or number of channels
4143
4144 @item outdef
4145 output channel specification, of the form:
4146 "@var{out_name}=[@var{gain}*]@var{in_name}[(+-)[@var{gain}*]@var{in_name}...]"
4147
4148 @item out_name
4149 output channel to define, either a channel name (FL, FR, etc.) or a channel
4150 number (c0, c1, etc.)
4151
4152 @item gain
4153 multiplicative coefficient for the channel, 1 leaving the volume unchanged
4154
4155 @item in_name
4156 input channel to use, see out_name for details; it is not possible to mix
4157 named and numbered input channels
4158 @end table
4159
4160 If the `=' in a channel specification is replaced by `<', then the gains for
4161 that specification will be renormalized so that the total is 1, thus
4162 avoiding clipping noise.
4163
4164 @subsection Mixing examples
4165
4166 For example, if you want to down-mix from stereo to mono, but with a bigger
4167 factor for the left channel:
4168 @example
4169 pan=1c|c0=0.9*c0+0.1*c1
4170 @end example
4171
4172 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
4173 7-channels surround:
4174 @example
4175 pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
4176 @end example
4177
4178 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
4179 that should be preferred (see "-ac" option) unless you have very specific
4180 needs.
4181
4182 @subsection Remapping examples
4183
4184 The channel remapping will be effective if, and only if:
4185
4186 @itemize
4187 @item gain coefficients are zeroes or ones,
4188 @item only one input per channel output,
4189 @end itemize
4190
4191 If all these conditions are satisfied, the filter will notify the user ("Pure
4192 channel mapping detected"), and use an optimized and lossless method to do the
4193 remapping.
4194
4195 For example, if you have a 5.1 source and want a stereo audio stream by
4196 dropping the extra channels:
4197 @example
4198 pan="stereo| c0=FL | c1=FR"
4199 @end example
4200
4201 Given the same source, you can also switch front left and front right channels
4202 and keep the input channel layout:
4203 @example
4204 pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
4205 @end example
4206
4207 If the input is a stereo audio stream, you can mute the front left channel (and
4208 still keep the stereo channel layout) with:
4209 @example
4210 pan="stereo|c1=c1"
4211 @end example
4212
4213 Still with a stereo audio stream input, you can copy the right channel in both
4214 front left and right:
4215 @example
4216 pan="stereo| c0=FR | c1=FR"
4217 @end example
4218
4219 @section replaygain
4220
4221 ReplayGain scanner filter. This filter takes an audio stream as an input and
4222 outputs it unchanged.
4223 At end of filtering it displays @code{track_gain} and @code{track_peak}.
4224
4225 @section resample
4226
4227 Convert the audio sample format, sample rate and channel layout. It is
4228 not meant to be used directly.
4229
4230 @section rubberband
4231 Apply time-stretching and pitch-shifting with librubberband.
4232
4233 To enable compilation of this filter, you need to configure FFmpeg with
4234 @code{--enable-librubberband}.
4235
4236 The filter accepts the following options:
4237
4238 @table @option
4239 @item tempo
4240 Set tempo scale factor.
4241
4242 @item pitch
4243 Set pitch scale factor.
4244
4245 @item transients
4246 Set transients detector.
4247 Possible values are:
4248 @table @var
4249 @item crisp
4250 @item mixed
4251 @item smooth
4252 @end table
4253
4254 @item detector
4255 Set detector.
4256 Possible values are:
4257 @table @var
4258 @item compound
4259 @item percussive
4260 @item soft
4261 @end table
4262
4263 @item phase
4264 Set phase.
4265 Possible values are:
4266 @table @var
4267 @item laminar
4268 @item independent
4269 @end table
4270
4271 @item window
4272 Set processing window size.
4273 Possible values are:
4274 @table @var
4275 @item standard
4276 @item short
4277 @item long
4278 @end table
4279
4280 @item smoothing
4281 Set smoothing.
4282 Possible values are:
4283 @table @var
4284 @item off
4285 @item on
4286 @end table
4287
4288 @item formant
4289 Enable formant preservation when shift pitching.
4290 Possible values are:
4291 @table @var
4292 @item shifted
4293 @item preserved
4294 @end table
4295
4296 @item pitchq
4297 Set pitch quality.
4298 Possible values are:
4299 @table @var
4300 @item quality
4301 @item speed
4302 @item consistency
4303 @end table
4304
4305 @item channels
4306 Set channels.
4307 Possible values are:
4308 @table @var
4309 @item apart
4310 @item together
4311 @end table
4312 @end table
4313
4314 @section sidechaincompress
4315
4316 This filter acts like normal compressor but has the ability to compress
4317 detected signal using second input signal.
4318 It needs two input streams and returns one output stream.
4319 First input stream will be processed depending on second stream signal.
4320 The filtered signal then can be filtered with other filters in later stages of
4321 processing. See @ref{pan} and @ref{amerge} filter.
4322
4323 The filter accepts the following options:
4324
4325 @table @option
4326 @item level_in
4327 Set input gain. Default is 1. Range is between 0.015625 and 64.
4328
4329 @item mode
4330 Set mode of compressor operation. Can be @code{upward} or @code{downward}.
4331 Default is @code{downward}.
4332
4333 @item threshold
4334 If a signal of second stream raises above this level it will affect the gain
4335 reduction of first stream.
4336 By default is 0.125. Range is between 0.00097563 and 1.
4337
4338 @item ratio
4339 Set a ratio about which the signal is reduced. 1:2 means that if the level
4340 raised 4dB above the threshold, it will be only 2dB above after the reduction.
4341 Default is 2. Range is between 1 and 20.
4342
4343 @item attack
4344 Amount of milliseconds the signal has to rise above the threshold before gain
4345 reduction starts. Default is 20. Range is between 0.01 and 2000.
4346
4347 @item release
4348 Amount of milliseconds the signal has to fall below the threshold before
4349 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
4350
4351 @item makeup
4352 Set the amount by how much signal will be amplified after processing.
4353 Default is 1. Range is from 1 to 64.
4354
4355 @item knee
4356 Curve the sharp knee around the threshold to enter gain reduction more softly.
4357 Default is 2.82843. Range is between 1 and 8.
4358
4359 @item link
4360 Choose if the @code{average} level between all channels of side-chain stream
4361 or the louder(@code{maximum}) channel of side-chain stream affects the
4362 reduction. Default is @code{average}.
4363
4364 @item detection
4365 Should the exact signal be taken in case of @code{peak} or an RMS one in case
4366 of @code{rms}. Default is @code{rms} which is mainly smoother.
4367
4368 @item level_sc
4369 Set sidechain gain. Default is 1. Range is between 0.015625 and 64.
4370
4371 @item mix
4372 How much to use compressed signal in output. Default is 1.
4373 Range is between 0 and 1.
4374 @end table
4375
4376 @subsection Examples
4377
4378 @itemize
4379 @item
4380 Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
4381 depending on the signal of 2nd input and later compressed signal to be
4382 merged with 2nd input:
4383 @example
4384 ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
4385 @end example
4386 @end itemize
4387
4388 @section sidechaingate
4389
4390 A sidechain gate acts like a normal (wideband) gate but has the ability to
4391 filter the detected signal before sending it to the gain reduction stage.
4392 Normally a gate uses the full range signal to detect a level above the
4393 threshold.
4394 For example: If you cut all lower frequencies from your sidechain signal
4395 the gate will decrease the volume of your track only if not enough highs
4396 appear. With this technique you are able to reduce the resonation of a
4397 natural drum or remove "rumbling" of muted strokes from a heavily distorted
4398 guitar.
4399 It needs two input streams and returns one output stream.
4400 First input stream will be processed depending on second stream signal.
4401
4402 The filter accepts the following options:
4403
4404 @table @option
4405 @item level_in
4406 Set input level before filtering.
4407 Default is 1. Allowed range is from 0.015625 to 64.
4408
4409 @item mode
4410 Set the mode of operation. Can be @code{upward} or @code{downward}.
4411 Default is @code{downward}. If set to @code{upward} mode, higher parts of signal
4412 will be amplified, expanding dynamic range in upward direction.
4413 Otherwise, in case of @code{downward} lower parts of signal will be reduced.
4414
4415 @item range
4416 Set the level of gain reduction when the signal is below the threshold.
4417 Default is 0.06125. Allowed range is from 0 to 1.
4418 Setting this to 0 disables reduction and then filter behaves like expander.
4419
4420 @item threshold
4421 If a signal rises above this level the gain reduction is released.
4422 Default is 0.125. Allowed range is from 0 to 1.
4423
4424 @item ratio
4425 Set a ratio about which the signal is reduced.
4426 Default is 2. Allowed range is from 1 to 9000.
4427
4428 @item attack
4429 Amount of milliseconds the signal has to rise above the threshold before gain
4430 reduction stops.
4431 Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
4432
4433 @item release
4434 Amount of milliseconds the signal has to fall below the threshold before the
4435 reduction is increased again. Default is 250 milliseconds.
4436 Allowed range is from 0.01 to 9000.
4437
4438 @item makeup
4439 Set amount of amplification of signal after processing.
4440 Default is 1. Allowed range is from 1 to 64.
4441
4442 @item knee
4443 Curve the sharp knee around the threshold to enter gain reduction more softly.
4444 Default is 2.828427125. Allowed range is from 1 to 8.
4445
4446 @item detection
4447 Choose if exact signal should be taken for detection or an RMS like one.
4448 Default is rms. Can be peak or rms.
4449
4450 @item link
4451 Choose if the average level between all channels or the louder channel affects
4452 the reduction.
4453 Default is average. Can be average or maximum.
4454
4455 @item level_sc
4456 Set sidechain gain. Default is 1. Range is from 0.015625 to 64.
4457 @end table
4458
4459 @section silencedetect
4460
4461 Detect silence in an audio stream.
4462
4463 This filter logs a message when it detects that the input audio volume is less
4464 or equal to a noise tolerance value for a duration greater or equal to the
4465 minimum detected noise duration.
4466
4467 The printed times and duration are expressed in seconds.
4468
4469 The filter accepts the following options:
4470
4471 @table @option
4472 @item noise, n
4473 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
4474 specified value) or amplitude ratio. Default is -60dB, or 0.001.
4475
4476 @item duration, d
4477 Set silence duration until notification (default is 2 seconds).
4478
4479 @item mono, m
4480 Process each channel separately, instead of combined. By default is disabled.
4481 @end table
4482
4483 @subsection Examples
4484
4485 @itemize
4486 @item
4487 Detect 5 seconds of silence with -50dB noise tolerance:
4488 @example
4489 silencedetect=n=-50dB:d=5
4490 @end example
4491
4492 @item
4493 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
4494 tolerance in @file{silence.mp3}:
4495 @example
4496 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
4497 @end example
4498 @end itemize
4499
4500 @section silenceremove
4501
4502 Remove silence from the beginning, middle or end of the audio.
4503
4504 The filter accepts the following options:
4505
4506 @table @option
4507 @item start_periods
4508 This value is used to indicate if audio should be trimmed at beginning of
4509 the audio. A value of zero indicates no silence should be trimmed from the
4510 beginning. When specifying a non-zero value, it trims audio up until it
4511 finds non-silence. Normally, when trimming silence from beginning of audio
4512 the @var{start_periods} will be @code{1} but it can be increased to higher
4513 values to trim all audio up to specific count of non-silence periods.
4514 Default value is @code{0}.
4515
4516 @item start_duration
4517 Specify the amount of time that non-silence must be detected before it stops
4518 trimming audio. By increasing the duration, bursts of noises can be treated
4519 as silence and trimmed off. Default value is @code{0}.
4520
4521 @item start_threshold
4522 This indicates what sample value should be treated as silence. For digital
4523 audio, a value of @code{0} may be fine but for audio recorded from analog,
4524 you may wish to increase the value to account for background noise.
4525 Can be specified in dB (in case "dB" is appended to the specified value)
4526 or amplitude ratio. Default value is @code{0}.
4527
4528 @item start_silence
4529 Specify max duration of silence at beginning that will be kept after
4530 trimming. Default is 0, which is equal to trimming all samples detected
4531 as silence.
4532
4533 @item start_mode
4534 Specify mode of detection of silence end in start of multi-channel audio.
4535 Can be @var{any} or @var{all}. Default is @var{any}.
4536 With @var{any}, any sample that is detected as non-silence will cause
4537 stopped trimming of silence.
4538 With @var{all}, only if all channels are detected as non-silence will cause
4539 stopped trimming of silence.
4540
4541 @item stop_periods
4542 Set the count for trimming silence from the end of audio.
4543 To remove silence from the middle of a file, specify a @var{stop_periods}
4544 that is negative. This value is then treated as a positive value and is
4545 used to indicate the effect should restart processing as specified by
4546 @var{start_periods}, making it suitable for removing periods of silence
4547 in the middle of the audio.
4548 Default value is @code{0}.
4549
4550 @item stop_duration
4551 Specify a duration of silence that must exist before audio is not copied any
4552 more. By specifying a higher duration, silence that is wanted can be left in
4553 the audio.
4554 Default value is @code{0}.
4555
4556 @item stop_threshold
4557 This is the same as @option{start_threshold} but for trimming silence from
4558 the end of audio.
4559 Can be specified in dB (in case "dB" is appended to the specified value)
4560 or amplitude ratio. Default value is @code{0}.
4561
4562 @item stop_silence
4563 Specify max duration of silence at end that will be kept after
4564 trimming. Default is 0, which is equal to trimming all samples detected
4565 as silence.
4566
4567 @item stop_mode
4568 Specify mode of detection of silence start in end of multi-channel audio.
4569 Can be @var{any} or @var{all}. Default is @var{any}.
4570 With @var{any}, any sample that is detected as non-silence will cause
4571 stopped trimming of silence.
4572 With @var{all}, only if all channels are detected as non-silence will cause
4573 stopped trimming of silence.
4574
4575 @item detection
4576 Set how is silence detected. Can be @code{rms} or @code{peak}. Second is faster
4577 and works better with digital silence which is exactly 0.
4578 Default value is @code{rms}.
4579
4580 @item window
4581 Set duration in number of seconds used to calculate size of window in number
4582 of samples for detecting silence.
4583 Default value is @code{0.02}. Allowed range is from @code{0} to @code{10}.
4584 @end table
4585
4586 @subsection Examples
4587
4588 @itemize
4589 @item