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