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