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