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