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