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