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