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