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