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