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