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