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