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