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