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