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