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