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