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