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