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