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