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