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