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