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