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