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