avfilter: add fillborders filter
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtering Introduction
2 @c man begin FILTERING INTRODUCTION
3
4 Filtering in FFmpeg is enabled through the libavfilter library.
5
6 In libavfilter, a filter can have multiple inputs and multiple
7 outputs.
8 To illustrate the sorts of things that are possible, we consider the
9 following filtergraph.
10
11 @verbatim
12                 [main]
13 input --> split ---------------------> overlay --> output
14             |                             ^
15             |[tmp]                  [flip]|
16             +-----> crop --> vflip -------+
17 @end verbatim
18
19 This filtergraph splits the input stream in two streams, then sends one
20 stream through the crop filter and the vflip filter, before merging it
21 back with the other stream by overlaying it on top. You can use the
22 following command to achieve this:
23
24 @example
25 ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
26 @end example
27
28 The result will be that the top half of the video is mirrored
29 onto the bottom half of the output video.
30
31 Filters in the same linear chain are separated by commas, and distinct
32 linear chains of filters are separated by semicolons. In our example,
33 @var{crop,vflip} are in one linear chain, @var{split} and
34 @var{overlay} are separately in another. The points where the linear
35 chains join are labelled by names enclosed in square brackets. In the
36 example, the split filter generates two outputs that are associated to
37 the labels @var{[main]} and @var{[tmp]}.
38
39 The stream sent to the second output of @var{split}, labelled as
40 @var{[tmp]}, is processed through the @var{crop} filter, which crops
41 away the lower half part of the video, and then vertically flipped. The
42 @var{overlay} filter takes in input the first unchanged output of the
43 split filter (which was labelled as @var{[main]}), and overlay on its
44 lower half the output generated by the @var{crop,vflip} filterchain.
45
46 Some filters take in input a list of parameters: they are specified
47 after the filter name and an equal sign, and are separated from each other
48 by a colon.
49
50 There exist so-called @var{source filters} that do not have an
51 audio/video input, and @var{sink filters} that will not have audio/video
52 output.
53
54 @c man end FILTERING INTRODUCTION
55
56 @chapter graph2dot
57 @c man begin GRAPH2DOT
58
59 The @file{graph2dot} program included in the FFmpeg @file{tools}
60 directory can be used to parse a filtergraph description and issue a
61 corresponding textual representation in the dot language.
62
63 Invoke the command:
64 @example
65 graph2dot -h
66 @end example
67
68 to see how to use @file{graph2dot}.
69
70 You can then pass the dot description to the @file{dot} program (from
71 the graphviz suite of programs) and obtain a graphical representation
72 of the filtergraph.
73
74 For example the sequence of commands:
75 @example
76 echo @var{GRAPH_DESCRIPTION} | \
77 tools/graph2dot -o graph.tmp && \
78 dot -Tpng graph.tmp -o graph.png && \
79 display graph.png
80 @end example
81
82 can be used to create and display an image representing the graph
83 described by the @var{GRAPH_DESCRIPTION} string. Note that this string must be
84 a complete self-contained graph, with its inputs and outputs explicitly defined.
85 For example if your command line is of the form:
86 @example
87 ffmpeg -i infile -vf scale=640:360 outfile
88 @end example
89 your @var{GRAPH_DESCRIPTION} string will need to be of the form:
90 @example
91 nullsrc,scale=640:360,nullsink
92 @end example
93 you may also need to set the @var{nullsrc} parameters and add a @var{format}
94 filter in order to simulate a specific input file.
95
96 @c man end GRAPH2DOT
97
98 @chapter Filtergraph description
99 @c man begin FILTERGRAPH DESCRIPTION
100
101 A filtergraph is a directed graph of connected filters. It can contain
102 cycles, and there can be multiple links between a pair of
103 filters. Each link has one input pad on one side connecting it to one
104 filter from which it takes its input, and one output pad on the other
105 side connecting it to one filter accepting its output.
106
107 Each filter in a filtergraph is an instance of a filter class
108 registered in the application, which defines the features and the
109 number of input and output pads of the filter.
110
111 A filter with no input pads is called a "source", and a filter with no
112 output pads is called a "sink".
113
114 @anchor{Filtergraph syntax}
115 @section Filtergraph syntax
116
117 A filtergraph has a textual representation, which is recognized by the
118 @option{-filter}/@option{-vf}/@option{-af} and
119 @option{-filter_complex} options in @command{ffmpeg} and
120 @option{-vf}/@option{-af} in @command{ffplay}, and by the
121 @code{avfilter_graph_parse_ptr()} function defined in
122 @file{libavfilter/avfilter.h}.
123
124 A filterchain consists of a sequence of connected filters, each one
125 connected to the previous one in the sequence. A filterchain is
126 represented by a list of ","-separated filter descriptions.
127
128 A filtergraph consists of a sequence of filterchains. A sequence of
129 filterchains is represented by a list of ";"-separated filterchain
130 descriptions.
131
132 A filter is represented by a string of the form:
133 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}@@@var{id}=@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 optionally followed by "@@@var{id}".
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{FILTER_NAME}      ::= @var{NAME}["@@"@var{NAME}]
216 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
217 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
218 @var{FILTER_ARGUMENTS} ::= sequence of chars (possibly quoted)
219 @var{FILTER}           ::= [@var{LINKLABELS}] @var{FILTER_NAME} ["=" @var{FILTER_ARGUMENTS}] [@var{LINKLABELS}]
220 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
221 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
222 @end example
223
224 @section Notes on filtergraph escaping
225
226 Filtergraph description composition entails several levels of
227 escaping. See @ref{quoting_and_escaping,,the "Quoting and escaping"
228 section in the ffmpeg-utils(1) manual,ffmpeg-utils} for more
229 information about the employed escaping procedure.
230
231 A first level escaping affects the content of each filter option
232 value, which may contain the special character @code{:} used to
233 separate values, or one of the escaping characters @code{\'}.
234
235 A second level escaping affects the whole filter description, which
236 may contain the escaping characters @code{\'} or the special
237 characters @code{[],;} used by the filtergraph description.
238
239 Finally, when you specify a filtergraph on a shell commandline, you
240 need to perform a third level escaping for the shell special
241 characters contained within it.
242
243 For example, consider the following string to be embedded in
244 the @ref{drawtext} filter description @option{text} value:
245 @example
246 this is a 'string': may contain one, or more, special characters
247 @end example
248
249 This string contains the @code{'} special escaping character, and the
250 @code{:} special character, so it needs to be escaped in this way:
251 @example
252 text=this is a \'string\'\: may contain one, or more, special characters
253 @end example
254
255 A second level of escaping is required when embedding the filter
256 description in a filtergraph description, in order to escape all the
257 filtergraph special characters. Thus the example above becomes:
258 @example
259 drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
260 @end example
261 (note that in addition to the @code{\'} escaping special characters,
262 also @code{,} needs to be escaped).
263
264 Finally an additional level of escaping is needed when writing the
265 filtergraph description in a shell command, which depends on the
266 escaping rules of the adopted shell. For example, assuming that
267 @code{\} is special and needs to be escaped with another @code{\}, the
268 previous string will finally result in:
269 @example
270 -vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
271 @end example
272
273 @chapter Timeline editing
274
275 Some filters support a generic @option{enable} option. For the filters
276 supporting timeline editing, this option can be set to an expression which is
277 evaluated before sending a frame to the filter. If the evaluation is non-zero,
278 the filter will be enabled, otherwise the frame will be sent unchanged to the
279 next filter in the filtergraph.
280
281 The expression accepts the following values:
282 @table @samp
283 @item t
284 timestamp expressed in seconds, NAN if the input timestamp is unknown
285
286 @item n
287 sequential number of the input frame, starting from 0
288
289 @item pos
290 the position in the file of the input frame, NAN if unknown
291
292 @item w
293 @item h
294 width and height of the input frame if video
295 @end table
296
297 Additionally, these filters support an @option{enable} command that can be used
298 to re-define the expression.
299
300 Like any other filtering option, the @option{enable} option follows the same
301 rules.
302
303 For example, to enable a blur filter (@ref{smartblur}) from 10 seconds to 3
304 minutes, and a @ref{curves} filter starting at 3 seconds:
305 @example
306 smartblur = enable='between(t,10,3*60)',
307 curves    = enable='gte(t,3)' : preset=cross_process
308 @end example
309
310 See @code{ffmpeg -filters} to view which filters have timeline support.
311
312 @c man end FILTERGRAPH DESCRIPTION
313
314 @anchor{framesync}
315 @chapter Options for filters with several inputs (framesync)
316 @c man begin OPTIONS FOR FILTERS WITH SEVERAL INPUTS
317
318 Some filters with several inputs support a common set of options.
319 These options can only be set by name, not with the short notation.
320
321 @table @option
322 @item eof_action
323 The action to take when EOF is encountered on the secondary input; it accepts
324 one of the following values:
325
326 @table @option
327 @item repeat
328 Repeat the last frame (the default).
329 @item endall
330 End both streams.
331 @item pass
332 Pass the main input through.
333 @end table
334
335 @item shortest
336 If set to 1, force the output to terminate when the shortest input
337 terminates. Default value is 0.
338
339 @item repeatlast
340 If set to 1, force the filter to extend the last frame of secondary streams
341 until the end of the primary stream. A value of 0 disables this behavior.
342 Default value is 1.
343 @end table
344
345 @c man end OPTIONS FOR FILTERS WITH SEVERAL INPUTS
346
347 @chapter Audio Filters
348 @c man begin AUDIO FILTERS
349
350 When you configure your FFmpeg build, you can disable any of the
351 existing filters using @code{--disable-filters}.
352 The configure output will show the audio filters included in your
353 build.
354
355 Below is a description of the currently available audio filters.
356
357 @section acompressor
358
359 A compressor is mainly used to reduce the dynamic range of a signal.
360 Especially modern music is mostly compressed at a high ratio to
361 improve the overall loudness. It's done to get the highest attention
362 of a listener, "fatten" the sound and bring more "power" to the track.
363 If a signal is compressed too much it may sound dull or "dead"
364 afterwards or it may start to "pump" (which could be a powerful effect
365 but can also destroy a track completely).
366 The right compression is the key to reach a professional sound and is
367 the high art of mixing and mastering. Because of its complex settings
368 it may take a long time to get the right feeling for this kind of effect.
369
370 Compression is done by detecting the volume above a chosen level
371 @code{threshold} and dividing it by the factor set with @code{ratio}.
372 So if you set the threshold to -12dB and your signal reaches -6dB a ratio
373 of 2:1 will result in a signal at -9dB. Because an exact manipulation of
374 the signal would cause distortion of the waveform the reduction can be
375 levelled over the time. This is done by setting "Attack" and "Release".
376 @code{attack} determines how long the signal has to rise above the threshold
377 before any reduction will occur and @code{release} sets the time the signal
378 has to fall below the threshold to reduce the reduction again. Shorter signals
379 than the chosen attack time will be left untouched.
380 The overall reduction of the signal can be made up afterwards with the
381 @code{makeup} setting. So compressing the peaks of a signal about 6dB and
382 raising the makeup to this level results in a signal twice as loud than the
383 source. To gain a softer entry in the compression the @code{knee} flattens the
384 hard edge at the threshold in the range of the chosen decibels.
385
386 The filter accepts the following options:
387
388 @table @option
389 @item level_in
390 Set input gain. Default is 1. Range is between 0.015625 and 64.
391
392 @item threshold
393 If a signal of stream rises above this level it will affect the gain
394 reduction.
395 By default it is 0.125. Range is between 0.00097563 and 1.
396
397 @item ratio
398 Set a ratio by which the signal is reduced. 1:2 means that if the level
399 rose 4dB above the threshold, it will be only 2dB above after the reduction.
400 Default is 2. Range is between 1 and 20.
401
402 @item attack
403 Amount of milliseconds the signal has to rise above the threshold before gain
404 reduction starts. Default is 20. Range is between 0.01 and 2000.
405
406 @item release
407 Amount of milliseconds the signal has to fall below the threshold before
408 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
409
410 @item makeup
411 Set the amount by how much signal will be amplified after processing.
412 Default is 1. Range is from 1 to 64.
413
414 @item knee
415 Curve the sharp knee around the threshold to enter gain reduction more softly.
416 Default is 2.82843. Range is between 1 and 8.
417
418 @item link
419 Choose if the @code{average} level between all channels of input stream
420 or the louder(@code{maximum}) channel of input stream affects the
421 reduction. Default is @code{average}.
422
423 @item detection
424 Should the exact signal be taken in case of @code{peak} or an RMS one in case
425 of @code{rms}. Default is @code{rms} which is mostly smoother.
426
427 @item mix
428 How much to use compressed signal in output. Default is 1.
429 Range is between 0 and 1.
430 @end table
431
432 @section acontrast
433 Simple audio dynamic range commpression/expansion filter.
434
435 The filter accepts the following options:
436
437 @table @option
438 @item contrast
439 Set contrast. Default is 33. Allowed range is between 0 and 100.
440 @end table
441
442 @section acopy
443
444 Copy the input audio source unchanged to the output. This is mainly useful for
445 testing purposes.
446
447 @section acrossfade
448
449 Apply cross fade from one input audio stream to another input audio stream.
450 The cross fade is applied for specified duration near the end of first stream.
451
452 The filter accepts the following options:
453
454 @table @option
455 @item nb_samples, ns
456 Specify the number of samples for which the cross fade effect has to last.
457 At the end of the cross fade effect the first input audio will be completely
458 silent. Default is 44100.
459
460 @item duration, d
461 Specify the duration of the cross fade effect. See
462 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
463 for the accepted syntax.
464 By default the duration is determined by @var{nb_samples}.
465 If set this option is used instead of @var{nb_samples}.
466
467 @item overlap, o
468 Should first stream end overlap with second stream start. Default is enabled.
469
470 @item curve1
471 Set curve for cross fade transition for first stream.
472
473 @item curve2
474 Set curve for cross fade transition for second stream.
475
476 For description of available curve types see @ref{afade} filter description.
477 @end table
478
479 @subsection Examples
480
481 @itemize
482 @item
483 Cross fade from one input to another:
484 @example
485 ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
486 @end example
487
488 @item
489 Cross fade from one input to another but without overlapping:
490 @example
491 ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
492 @end example
493 @end itemize
494
495 @section acrusher
496
497 Reduce audio bit resolution.
498
499 This filter is bit crusher with enhanced functionality. A bit crusher
500 is used to audibly reduce number of bits an audio signal is sampled
501 with. This doesn't change the bit depth at all, it just produces the
502 effect. Material reduced in bit depth sounds more harsh and "digital".
503 This filter is able to even round to continuous values instead of discrete
504 bit depths.
505 Additionally it has a D/C offset which results in different crushing of
506 the lower and the upper half of the signal.
507 An Anti-Aliasing setting is able to produce "softer" crushing sounds.
508
509 Another feature of this filter is the logarithmic mode.
510 This setting switches from linear distances between bits to logarithmic ones.
511 The result is a much more "natural" sounding crusher which doesn't gate low
512 signals for example. The human ear has a logarithmic perception, too
513 so this kind of crushing is much more pleasant.
514 Logarithmic crushing is also able to get anti-aliased.
515
516 The filter accepts the following options:
517
518 @table @option
519 @item level_in
520 Set level in.
521
522 @item level_out
523 Set level out.
524
525 @item bits
526 Set bit reduction.
527
528 @item mix
529 Set mixing amount.
530
531 @item mode
532 Can be linear: @code{lin} or logarithmic: @code{log}.
533
534 @item dc
535 Set DC.
536
537 @item aa
538 Set anti-aliasing.
539
540 @item samples
541 Set sample reduction.
542
543 @item lfo
544 Enable LFO. By default disabled.
545
546 @item lforange
547 Set LFO range.
548
549 @item lforate
550 Set LFO rate.
551 @end table
552
553 @section adelay
554
555 Delay one or more audio channels.
556
557 Samples in delayed channel are filled with silence.
558
559 The filter accepts the following option:
560
561 @table @option
562 @item delays
563 Set list of delays in milliseconds for each channel separated by '|'.
564 Unused delays will be silently ignored. If number of given delays is
565 smaller than number of channels all remaining channels will not be delayed.
566 If you want to delay exact number of samples, append 'S' to number.
567 @end table
568
569 @subsection Examples
570
571 @itemize
572 @item
573 Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave
574 the second channel (and any other channels that may be present) unchanged.
575 @example
576 adelay=1500|0|500
577 @end example
578
579 @item
580 Delay second channel by 500 samples, the third channel by 700 samples and leave
581 the first channel (and any other channels that may be present) unchanged.
582 @example
583 adelay=0|500S|700S
584 @end example
585 @end itemize
586
587 @section aecho
588
589 Apply echoing to the input audio.
590
591 Echoes are reflected sound and can occur naturally amongst mountains
592 (and sometimes large buildings) when talking or shouting; digital echo
593 effects emulate this behaviour and are often used to help fill out the
594 sound of a single instrument or vocal. The time difference between the
595 original signal and the reflection is the @code{delay}, and the
596 loudness of the reflected signal is the @code{decay}.
597 Multiple echoes can have different delays and decays.
598
599 A description of the accepted parameters follows.
600
601 @table @option
602 @item in_gain
603 Set input gain of reflected signal. Default is @code{0.6}.
604
605 @item out_gain
606 Set output gain of reflected signal. Default is @code{0.3}.
607
608 @item delays
609 Set list of time intervals in milliseconds between original signal and reflections
610 separated by '|'. Allowed range for each @code{delay} is @code{(0 - 90000.0]}.
611 Default is @code{1000}.
612
613 @item decays
614 Set list of loudness of reflected signals separated by '|'.
615 Allowed range for each @code{decay} is @code{(0 - 1.0]}.
616 Default is @code{0.5}.
617 @end table
618
619 @subsection Examples
620
621 @itemize
622 @item
623 Make it sound as if there are twice as many instruments as are actually playing:
624 @example
625 aecho=0.8:0.88:60:0.4
626 @end example
627
628 @item
629 If delay is very short, then it sound like a (metallic) robot playing music:
630 @example
631 aecho=0.8:0.88:6:0.4
632 @end example
633
634 @item
635 A longer delay will sound like an open air concert in the mountains:
636 @example
637 aecho=0.8:0.9:1000:0.3
638 @end example
639
640 @item
641 Same as above but with one more mountain:
642 @example
643 aecho=0.8:0.9:1000|1800:0.3|0.25
644 @end example
645 @end itemize
646
647 @section aemphasis
648 Audio emphasis filter creates or restores material directly taken from LPs or
649 emphased CDs with different filter curves. E.g. to store music on vinyl the
650 signal has to be altered by a filter first to even out the disadvantages of
651 this recording medium.
652 Once the material is played back the inverse filter has to be applied to
653 restore the distortion of the frequency response.
654
655 The filter accepts the following options:
656
657 @table @option
658 @item level_in
659 Set input gain.
660
661 @item level_out
662 Set output gain.
663
664 @item mode
665 Set filter mode. For restoring material use @code{reproduction} mode, otherwise
666 use @code{production} mode. Default is @code{reproduction} mode.
667
668 @item type
669 Set filter type. Selects medium. Can be one of the following:
670
671 @table @option
672 @item col
673 select Columbia.
674 @item emi
675 select EMI.
676 @item bsi
677 select BSI (78RPM).
678 @item riaa
679 select RIAA.
680 @item cd
681 select Compact Disc (CD).
682 @item 50fm
683 select 50µs (FM).
684 @item 75fm
685 select 75µs (FM).
686 @item 50kf
687 select 50µs (FM-KF).
688 @item 75kf
689 select 75µs (FM-KF).
690 @end table
691 @end table
692
693 @section aeval
694
695 Modify an audio signal according to the specified expressions.
696
697 This filter accepts one or more expressions (one for each channel),
698 which are evaluated and used to modify a corresponding audio signal.
699
700 It accepts the following parameters:
701
702 @table @option
703 @item exprs
704 Set the '|'-separated expressions list for each separate channel. If
705 the number of input channels is greater than the number of
706 expressions, the last specified expression is used for the remaining
707 output channels.
708
709 @item channel_layout, c
710 Set output channel layout. If not specified, the channel layout is
711 specified by the number of expressions. If set to @samp{same}, it will
712 use by default the same input channel layout.
713 @end table
714
715 Each expression in @var{exprs} can contain the following constants and functions:
716
717 @table @option
718 @item ch
719 channel number of the current expression
720
721 @item n
722 number of the evaluated sample, starting from 0
723
724 @item s
725 sample rate
726
727 @item t
728 time of the evaluated sample expressed in seconds
729
730 @item nb_in_channels
731 @item nb_out_channels
732 input and output number of channels
733
734 @item val(CH)
735 the value of input channel with number @var{CH}
736 @end table
737
738 Note: this filter is slow. For faster processing you should use a
739 dedicated filter.
740
741 @subsection Examples
742
743 @itemize
744 @item
745 Half volume:
746 @example
747 aeval=val(ch)/2:c=same
748 @end example
749
750 @item
751 Invert phase of the second channel:
752 @example
753 aeval=val(0)|-val(1)
754 @end example
755 @end itemize
756
757 @anchor{afade}
758 @section afade
759
760 Apply fade-in/out effect to input audio.
761
762 A description of the accepted parameters follows.
763
764 @table @option
765 @item type, t
766 Specify the effect type, can be either @code{in} for fade-in, or
767 @code{out} for a fade-out effect. Default is @code{in}.
768
769 @item start_sample, ss
770 Specify the number of the start sample for starting to apply the fade
771 effect. Default is 0.
772
773 @item nb_samples, ns
774 Specify the number of samples for which the fade effect has to last. At
775 the end of the fade-in effect the output audio will have the same
776 volume as the input audio, at the end of the fade-out transition
777 the output audio will be silence. Default is 44100.
778
779 @item start_time, st
780 Specify the start time of the fade effect. Default is 0.
781 The value must be specified as a time duration; see
782 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
783 for the accepted syntax.
784 If set this option is used instead of @var{start_sample}.
785
786 @item duration, d
787 Specify the duration of the fade effect. See
788 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
789 for the accepted syntax.
790 At the end of the fade-in effect the output audio will have the same
791 volume as the input audio, at the end of the fade-out transition
792 the output audio will be silence.
793 By default the duration is determined by @var{nb_samples}.
794 If set this option is used instead of @var{nb_samples}.
795
796 @item curve
797 Set curve for fade transition.
798
799 It accepts the following values:
800 @table @option
801 @item tri
802 select triangular, linear slope (default)
803 @item qsin
804 select quarter of sine wave
805 @item hsin
806 select half of sine wave
807 @item esin
808 select exponential sine wave
809 @item log
810 select logarithmic
811 @item ipar
812 select inverted parabola
813 @item qua
814 select quadratic
815 @item cub
816 select cubic
817 @item squ
818 select square root
819 @item cbr
820 select cubic root
821 @item par
822 select parabola
823 @item exp
824 select exponential
825 @item iqsin
826 select inverted quarter of sine wave
827 @item ihsin
828 select inverted half of sine wave
829 @item dese
830 select double-exponential seat
831 @item desi
832 select double-exponential sigmoid
833 @end table
834 @end table
835
836 @subsection Examples
837
838 @itemize
839 @item
840 Fade in first 15 seconds of audio:
841 @example
842 afade=t=in:ss=0:d=15
843 @end example
844
845 @item
846 Fade out last 25 seconds of a 900 seconds audio:
847 @example
848 afade=t=out:st=875:d=25
849 @end example
850 @end itemize
851
852 @section afftfilt
853 Apply arbitrary expressions to samples in frequency domain.
854
855 @table @option
856 @item real
857 Set frequency domain real expression for each separate channel separated
858 by '|'. Default is "1".
859 If the number of input channels is greater than the number of
860 expressions, the last specified expression is used for the remaining
861 output channels.
862
863 @item imag
864 Set frequency domain imaginary expression for each separate channel
865 separated by '|'. If not set, @var{real} option is used.
866
867 Each expression in @var{real} and @var{imag} can contain the following
868 constants:
869
870 @table @option
871 @item sr
872 sample rate
873
874 @item b
875 current frequency bin number
876
877 @item nb
878 number of available bins
879
880 @item ch
881 channel number of the current expression
882
883 @item chs
884 number of channels
885
886 @item pts
887 current frame pts
888 @end table
889
890 @item win_size
891 Set window size.
892
893 It accepts the following values:
894 @table @samp
895 @item w16
896 @item w32
897 @item w64
898 @item w128
899 @item w256
900 @item w512
901 @item w1024
902 @item w2048
903 @item w4096
904 @item w8192
905 @item w16384
906 @item w32768
907 @item w65536
908 @end table
909 Default is @code{w4096}
910
911 @item win_func
912 Set window function. Default is @code{hann}.
913
914 @item overlap
915 Set window overlap. If set to 1, the recommended overlap for selected
916 window function will be picked. Default is @code{0.75}.
917 @end table
918
919 @subsection Examples
920
921 @itemize
922 @item
923 Leave almost only low frequencies in audio:
924 @example
925 afftfilt="1-clip((b/nb)*b,0,1)"
926 @end example
927 @end itemize
928
929 @section afir
930
931 Apply an arbitrary Frequency Impulse Response filter.
932
933 This filter is designed for applying long FIR filters,
934 up to 30 seconds long.
935
936 It can be used as component for digital crossover filters,
937 room equalization, cross talk cancellation, wavefield synthesis,
938 auralization, ambiophonics and ambisonics.
939
940 This filter uses second stream as FIR coefficients.
941 If second stream holds single channel, it will be used
942 for all input channels in first stream, otherwise
943 number of channels in second stream must be same as
944 number of channels in first stream.
945
946 It accepts the following parameters:
947
948 @table @option
949 @item dry
950 Set dry gain. This sets input gain.
951
952 @item wet
953 Set wet gain. This sets final output gain.
954
955 @item length
956 Set Impulse Response filter length. Default is 1, which means whole IR is processed.
957
958 @item again
959 Enable applying gain measured from power of IR.
960 @end table
961
962 @subsection Examples
963
964 @itemize
965 @item
966 Apply reverb to stream using mono IR file as second input, complete command using ffmpeg:
967 @example
968 ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav
969 @end example
970 @end itemize
971
972 @anchor{aformat}
973 @section aformat
974
975 Set output format constraints for the input audio. The framework will
976 negotiate the most appropriate format to minimize conversions.
977
978 It accepts the following parameters:
979 @table @option
980
981 @item sample_fmts
982 A '|'-separated list of requested sample formats.
983
984 @item sample_rates
985 A '|'-separated list of requested sample rates.
986
987 @item channel_layouts
988 A '|'-separated list of requested channel layouts.
989
990 See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
991 for the required syntax.
992 @end table
993
994 If a parameter is omitted, all values are allowed.
995
996 Force the output to either unsigned 8-bit or signed 16-bit stereo
997 @example
998 aformat=sample_fmts=u8|s16:channel_layouts=stereo
999 @end example
1000
1001 @section agate
1002
1003 A gate is mainly used to reduce lower parts of a signal. This kind of signal
1004 processing reduces disturbing noise between useful signals.
1005
1006 Gating is done by detecting the volume below a chosen level @var{threshold}
1007 and dividing it by the factor set with @var{ratio}. The bottom of the noise
1008 floor is set via @var{range}. Because an exact manipulation of the signal
1009 would cause distortion of the waveform the reduction can be levelled over
1010 time. This is done by setting @var{attack} and @var{release}.
1011
1012 @var{attack} determines how long the signal has to fall below the threshold
1013 before any reduction will occur and @var{release} sets the time the signal
1014 has to rise above the threshold to reduce the reduction again.
1015 Shorter signals than the chosen attack time will be left untouched.
1016
1017 @table @option
1018 @item level_in
1019 Set input level before filtering.
1020 Default is 1. Allowed range is from 0.015625 to 64.
1021
1022 @item range
1023 Set the level of gain reduction when the signal is below the threshold.
1024 Default is 0.06125. Allowed range is from 0 to 1.
1025
1026 @item threshold
1027 If a signal rises above this level the gain reduction is released.
1028 Default is 0.125. Allowed range is from 0 to 1.
1029
1030 @item ratio
1031 Set a ratio by which the signal is reduced.
1032 Default is 2. Allowed range is from 1 to 9000.
1033
1034 @item attack
1035 Amount of milliseconds the signal has to rise above the threshold before gain
1036 reduction stops.
1037 Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
1038
1039 @item release
1040 Amount of milliseconds the signal has to fall below the threshold before the
1041 reduction is increased again. Default is 250 milliseconds.
1042 Allowed range is from 0.01 to 9000.
1043
1044 @item makeup
1045 Set amount of amplification of signal after processing.
1046 Default is 1. Allowed range is from 1 to 64.
1047
1048 @item knee
1049 Curve the sharp knee around the threshold to enter gain reduction more softly.
1050 Default is 2.828427125. Allowed range is from 1 to 8.
1051
1052 @item detection
1053 Choose if exact signal should be taken for detection or an RMS like one.
1054 Default is @code{rms}. Can be @code{peak} or @code{rms}.
1055
1056 @item link
1057 Choose if the average level between all channels or the louder channel affects
1058 the reduction.
1059 Default is @code{average}. Can be @code{average} or @code{maximum}.
1060 @end table
1061
1062 @section alimiter
1063
1064 The limiter prevents an input signal from rising over a desired threshold.
1065 This limiter uses lookahead technology to prevent your signal from distorting.
1066 It means that there is a small delay after the signal is processed. Keep in mind
1067 that the delay it produces is the attack time you set.
1068
1069 The filter accepts the following options:
1070
1071 @table @option
1072 @item level_in
1073 Set input gain. Default is 1.
1074
1075 @item level_out
1076 Set output gain. Default is 1.
1077
1078 @item limit
1079 Don't let signals above this level pass the limiter. Default is 1.
1080
1081 @item attack
1082 The limiter will reach its attenuation level in this amount of time in
1083 milliseconds. Default is 5 milliseconds.
1084
1085 @item release
1086 Come back from limiting to attenuation 1.0 in this amount of milliseconds.
1087 Default is 50 milliseconds.
1088
1089 @item asc
1090 When gain reduction is always needed ASC takes care of releasing to an
1091 average reduction level rather than reaching a reduction of 0 in the release
1092 time.
1093
1094 @item asc_level
1095 Select how much the release time is affected by ASC, 0 means nearly no changes
1096 in release time while 1 produces higher release times.
1097
1098 @item level
1099 Auto level output signal. Default is enabled.
1100 This normalizes audio back to 0dB if enabled.
1101 @end table
1102
1103 Depending on picked setting it is recommended to upsample input 2x or 4x times
1104 with @ref{aresample} before applying this filter.
1105
1106 @section allpass
1107
1108 Apply a two-pole all-pass filter with central frequency (in Hz)
1109 @var{frequency}, and filter-width @var{width}.
1110 An all-pass filter changes the audio's frequency to phase relationship
1111 without changing its frequency to amplitude relationship.
1112
1113 The filter accepts the following options:
1114
1115 @table @option
1116 @item frequency, f
1117 Set frequency in Hz.
1118
1119 @item width_type, t
1120 Set method to specify band-width of filter.
1121 @table @option
1122 @item h
1123 Hz
1124 @item q
1125 Q-Factor
1126 @item o
1127 octave
1128 @item s
1129 slope
1130 @end table
1131
1132 @item width, w
1133 Specify the band-width of a filter in width_type units.
1134
1135 @item channels, c
1136 Specify which channels to filter, by default all available are filtered.
1137 @end table
1138
1139 @section aloop
1140
1141 Loop audio samples.
1142
1143 The filter accepts the following options:
1144
1145 @table @option
1146 @item loop
1147 Set the number of loops. Setting this value to -1 will result in infinite loops.
1148 Default is 0.
1149
1150 @item size
1151 Set maximal number of samples. Default is 0.
1152
1153 @item start
1154 Set first sample of loop. Default is 0.
1155 @end table
1156
1157 @anchor{amerge}
1158 @section amerge
1159
1160 Merge two or more audio streams into a single multi-channel stream.
1161
1162 The filter accepts the following options:
1163
1164 @table @option
1165
1166 @item inputs
1167 Set the number of inputs. Default is 2.
1168
1169 @end table
1170
1171 If the channel layouts of the inputs are disjoint, and therefore compatible,
1172 the channel layout of the output will be set accordingly and the channels
1173 will be reordered as necessary. If the channel layouts of the inputs are not
1174 disjoint, the output will have all the channels of the first input then all
1175 the channels of the second input, in that order, and the channel layout of
1176 the output will be the default value corresponding to the total number of
1177 channels.
1178
1179 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
1180 is FC+BL+BR, then the output will be in 5.1, with the channels in the
1181 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
1182 first input, b1 is the first channel of the second input).
1183
1184 On the other hand, if both input are in stereo, the output channels will be
1185 in the default order: a1, a2, b1, b2, and the channel layout will be
1186 arbitrarily set to 4.0, which may or may not be the expected value.
1187
1188 All inputs must have the same sample rate, and format.
1189
1190 If inputs do not have the same duration, the output will stop with the
1191 shortest.
1192
1193 @subsection Examples
1194
1195 @itemize
1196 @item
1197 Merge two mono files into a stereo stream:
1198 @example
1199 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
1200 @end example
1201
1202 @item
1203 Multiple merges assuming 1 video stream and 6 audio streams in @file{input.mkv}:
1204 @example
1205 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
1206 @end example
1207 @end itemize
1208
1209 @section amix
1210
1211 Mixes multiple audio inputs into a single output.
1212
1213 Note that this filter only supports float samples (the @var{amerge}
1214 and @var{pan} audio filters support many formats). If the @var{amix}
1215 input has integer samples then @ref{aresample} will be automatically
1216 inserted to perform the conversion to float samples.
1217
1218 For example
1219 @example
1220 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
1221 @end example
1222 will mix 3 input audio streams to a single output with the same duration as the
1223 first input and a dropout transition time of 3 seconds.
1224
1225 It accepts the following parameters:
1226 @table @option
1227
1228 @item inputs
1229 The number of inputs. If unspecified, it defaults to 2.
1230
1231 @item duration
1232 How to determine the end-of-stream.
1233 @table @option
1234
1235 @item longest
1236 The duration of the longest input. (default)
1237
1238 @item shortest
1239 The duration of the shortest input.
1240
1241 @item first
1242 The duration of the first input.
1243
1244 @end table
1245
1246 @item dropout_transition
1247 The transition time, in seconds, for volume renormalization when an input
1248 stream ends. The default value is 2 seconds.
1249
1250 @end table
1251
1252 @section anequalizer
1253
1254 High-order parametric multiband equalizer for each channel.
1255
1256 It accepts the following parameters:
1257 @table @option
1258 @item params
1259
1260 This option string is in format:
1261 "c@var{chn} f=@var{cf} w=@var{w} g=@var{g} t=@var{f} | ..."
1262 Each equalizer band is separated by '|'.
1263
1264 @table @option
1265 @item chn
1266 Set channel number to which equalization will be applied.
1267 If input doesn't have that channel the entry is ignored.
1268
1269 @item f
1270 Set central frequency for band.
1271 If input doesn't have that frequency the entry is ignored.
1272
1273 @item w
1274 Set band width in hertz.
1275
1276 @item g
1277 Set band gain in dB.
1278
1279 @item t
1280 Set filter type for band, optional, can be:
1281
1282 @table @samp
1283 @item 0
1284 Butterworth, this is default.
1285
1286 @item 1
1287 Chebyshev type 1.
1288
1289 @item 2
1290 Chebyshev type 2.
1291 @end table
1292 @end table
1293
1294 @item curves
1295 With this option activated frequency response of anequalizer is displayed
1296 in video stream.
1297
1298 @item size
1299 Set video stream size. Only useful if curves option is activated.
1300
1301 @item mgain
1302 Set max gain that will be displayed. Only useful if curves option is activated.
1303 Setting this to a reasonable value makes it possible to display gain which is derived from
1304 neighbour bands which are too close to each other and thus produce higher gain
1305 when both are activated.
1306
1307 @item fscale
1308 Set frequency scale used to draw frequency response in video output.
1309 Can be linear or logarithmic. Default is logarithmic.
1310
1311 @item colors
1312 Set color for each channel curve which is going to be displayed in video stream.
1313 This is list of color names separated by space or by '|'.
1314 Unrecognised or missing colors will be replaced by white color.
1315 @end table
1316
1317 @subsection Examples
1318
1319 @itemize
1320 @item
1321 Lower gain by 10 of central frequency 200Hz and width 100 Hz
1322 for first 2 channels using Chebyshev type 1 filter:
1323 @example
1324 anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
1325 @end example
1326 @end itemize
1327
1328 @subsection Commands
1329
1330 This filter supports the following commands:
1331 @table @option
1332 @item change
1333 Alter existing filter parameters.
1334 Syntax for the commands is : "@var{fN}|f=@var{freq}|w=@var{width}|g=@var{gain}"
1335
1336 @var{fN} is existing filter number, starting from 0, if no such filter is available
1337 error is returned.
1338 @var{freq} set new frequency parameter.
1339 @var{width} set new width parameter in herz.
1340 @var{gain} set new gain parameter in dB.
1341
1342 Full filter invocation with asendcmd may look like this:
1343 asendcmd=c='4.0 anequalizer change 0|f=200|w=50|g=1',anequalizer=...
1344 @end table
1345
1346 @section anull
1347
1348 Pass the audio source unchanged to the output.
1349
1350 @section apad
1351
1352 Pad the end of an audio stream with silence.
1353
1354 This can be used together with @command{ffmpeg} @option{-shortest} to
1355 extend audio streams to the same length as the video stream.
1356
1357 A description of the accepted options follows.
1358
1359 @table @option
1360 @item packet_size
1361 Set silence packet size. Default value is 4096.
1362
1363 @item pad_len
1364 Set the number of samples of silence to add to the end. After the
1365 value is reached, the stream is terminated. This option is mutually
1366 exclusive with @option{whole_len}.
1367
1368 @item whole_len
1369 Set the minimum total number of samples in the output audio stream. If
1370 the value is longer than the input audio length, silence is added to
1371 the end, until the value is reached. This option is mutually exclusive
1372 with @option{pad_len}.
1373 @end table
1374
1375 If neither the @option{pad_len} nor the @option{whole_len} option is
1376 set, the filter will add silence to the end of the input stream
1377 indefinitely.
1378
1379 @subsection Examples
1380
1381 @itemize
1382 @item
1383 Add 1024 samples of silence to the end of the input:
1384 @example
1385 apad=pad_len=1024
1386 @end example
1387
1388 @item
1389 Make sure the audio output will contain at least 10000 samples, pad
1390 the input with silence if required:
1391 @example
1392 apad=whole_len=10000
1393 @end example
1394
1395 @item
1396 Use @command{ffmpeg} to pad the audio input with silence, so that the
1397 video stream will always result the shortest and will be converted
1398 until the end in the output file when using the @option{shortest}
1399 option:
1400 @example
1401 ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
1402 @end example
1403 @end itemize
1404
1405 @section aphaser
1406 Add a phasing effect to the input audio.
1407
1408 A phaser filter creates series of peaks and troughs in the frequency spectrum.
1409 The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
1410
1411 A description of the accepted parameters follows.
1412
1413 @table @option
1414 @item in_gain
1415 Set input gain. Default is 0.4.
1416
1417 @item out_gain
1418 Set output gain. Default is 0.74
1419
1420 @item delay
1421 Set delay in milliseconds. Default is 3.0.
1422
1423 @item decay
1424 Set decay. Default is 0.4.
1425
1426 @item speed
1427 Set modulation speed in Hz. Default is 0.5.
1428
1429 @item type
1430 Set modulation type. Default is triangular.
1431
1432 It accepts the following values:
1433 @table @samp
1434 @item triangular, t
1435 @item sinusoidal, s
1436 @end table
1437 @end table
1438
1439 @section apulsator
1440
1441 Audio pulsator is something between an autopanner and a tremolo.
1442 But it can produce funny stereo effects as well. Pulsator changes the volume
1443 of the left and right channel based on a LFO (low frequency oscillator) with
1444 different waveforms and shifted phases.
1445 This filter have the ability to define an offset between left and right
1446 channel. An offset of 0 means that both LFO shapes match each other.
1447 The left and right channel are altered equally - a conventional tremolo.
1448 An offset of 50% means that the shape of the right channel is exactly shifted
1449 in phase (or moved backwards about half of the frequency) - pulsator acts as
1450 an autopanner. At 1 both curves match again. Every setting in between moves the
1451 phase shift gapless between all stages and produces some "bypassing" sounds with
1452 sine and triangle waveforms. The more you set the offset near 1 (starting from
1453 the 0.5) the faster the signal passes from the left to the right speaker.
1454
1455 The filter accepts the following options:
1456
1457 @table @option
1458 @item level_in
1459 Set input gain. By default it is 1. Range is [0.015625 - 64].
1460
1461 @item level_out
1462 Set output gain. By default it is 1. Range is [0.015625 - 64].
1463
1464 @item mode
1465 Set waveform shape the LFO will use. Can be one of: sine, triangle, square,
1466 sawup or sawdown. Default is sine.
1467
1468 @item amount
1469 Set modulation. Define how much of original signal is affected by the LFO.
1470
1471 @item offset_l
1472 Set left channel offset. Default is 0. Allowed range is [0 - 1].
1473
1474 @item offset_r
1475 Set right channel offset. Default is 0.5. Allowed range is [0 - 1].
1476
1477 @item width
1478 Set pulse width. Default is 1. Allowed range is [0 - 2].
1479
1480 @item timing
1481 Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz.
1482
1483 @item bpm
1484 Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing
1485 is set to bpm.
1486
1487 @item ms
1488 Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing
1489 is set to ms.
1490
1491 @item hz
1492 Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used
1493 if timing is set to hz.
1494 @end table
1495
1496 @anchor{aresample}
1497 @section aresample
1498
1499 Resample the input audio to the specified parameters, using the
1500 libswresample library. If none are specified then the filter will
1501 automatically convert between its input and output.
1502
1503 This filter is also able to stretch/squeeze the audio data to make it match
1504 the timestamps or to inject silence / cut out audio to make it match the
1505 timestamps, do a combination of both or do neither.
1506
1507 The filter accepts the syntax
1508 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
1509 expresses a sample rate and @var{resampler_options} is a list of
1510 @var{key}=@var{value} pairs, separated by ":". See the
1511 @ref{Resampler Options,,the "Resampler Options" section in the
1512 ffmpeg-resampler(1) manual,ffmpeg-resampler}
1513 for the complete list of supported options.
1514
1515 @subsection Examples
1516
1517 @itemize
1518 @item
1519 Resample the input audio to 44100Hz:
1520 @example
1521 aresample=44100
1522 @end example
1523
1524 @item
1525 Stretch/squeeze samples to the given timestamps, with a maximum of 1000
1526 samples per second compensation:
1527 @example
1528 aresample=async=1000
1529 @end example
1530 @end itemize
1531
1532 @section areverse
1533
1534 Reverse an audio clip.
1535
1536 Warning: This filter requires memory to buffer the entire clip, so trimming
1537 is suggested.
1538
1539 @subsection Examples
1540
1541 @itemize
1542 @item
1543 Take the first 5 seconds of a clip, and reverse it.
1544 @example
1545 atrim=end=5,areverse
1546 @end example
1547 @end itemize
1548
1549 @section asetnsamples
1550
1551 Set the number of samples per each output audio frame.
1552
1553 The last output packet may contain a different number of samples, as
1554 the filter will flush all the remaining samples when the input audio
1555 signals its end.
1556
1557 The filter accepts the following options:
1558
1559 @table @option
1560
1561 @item nb_out_samples, n
1562 Set the number of frames per each output audio frame. The number is
1563 intended as the number of samples @emph{per each channel}.
1564 Default value is 1024.
1565
1566 @item pad, p
1567 If set to 1, the filter will pad the last audio frame with zeroes, so
1568 that the last frame will contain the same number of samples as the
1569 previous ones. Default value is 1.
1570 @end table
1571
1572 For example, to set the number of per-frame samples to 1234 and
1573 disable padding for the last frame, use:
1574 @example
1575 asetnsamples=n=1234:p=0
1576 @end example
1577
1578 @section asetrate
1579
1580 Set the sample rate without altering the PCM data.
1581 This will result in a change of speed and pitch.
1582
1583 The filter accepts the following options:
1584
1585 @table @option
1586 @item sample_rate, r
1587 Set the output sample rate. Default is 44100 Hz.
1588 @end table
1589
1590 @section ashowinfo
1591
1592 Show a line containing various information for each input audio frame.
1593 The input audio is not modified.
1594
1595 The shown line contains a sequence of key/value pairs of the form
1596 @var{key}:@var{value}.
1597
1598 The following values are shown in the output:
1599
1600 @table @option
1601 @item n
1602 The (sequential) number of the input frame, starting from 0.
1603
1604 @item pts
1605 The presentation timestamp of the input frame, in time base units; the time base
1606 depends on the filter input pad, and is usually 1/@var{sample_rate}.
1607
1608 @item pts_time
1609 The presentation timestamp of the input frame in seconds.
1610
1611 @item pos
1612 position of the frame in the input stream, -1 if this information in
1613 unavailable and/or meaningless (for example in case of synthetic audio)
1614
1615 @item fmt
1616 The sample format.
1617
1618 @item chlayout
1619 The channel layout.
1620
1621 @item rate
1622 The sample rate for the audio frame.
1623
1624 @item nb_samples
1625 The number of samples (per channel) in the frame.
1626
1627 @item checksum
1628 The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
1629 audio, the data is treated as if all the planes were concatenated.
1630
1631 @item plane_checksums
1632 A list of Adler-32 checksums for each data plane.
1633 @end table
1634
1635 @anchor{astats}
1636 @section astats
1637
1638 Display time domain statistical information about the audio channels.
1639 Statistics are calculated and displayed for each audio channel and,
1640 where applicable, an overall figure is also given.
1641
1642 It accepts the following option:
1643 @table @option
1644 @item length
1645 Short window length in seconds, used for peak and trough RMS measurement.
1646 Default is @code{0.05} (50 milliseconds). Allowed range is @code{[0.1 - 10]}.
1647
1648 @item metadata
1649
1650 Set metadata injection. All the metadata keys are prefixed with @code{lavfi.astats.X},
1651 where @code{X} is channel number starting from 1 or string @code{Overall}. Default is
1652 disabled.
1653
1654 Available keys for each channel are:
1655 DC_offset
1656 Min_level
1657 Max_level
1658 Min_difference
1659 Max_difference
1660 Mean_difference
1661 RMS_difference
1662 Peak_level
1663 RMS_peak
1664 RMS_trough
1665 Crest_factor
1666 Flat_factor
1667 Peak_count
1668 Bit_depth
1669 Dynamic_range
1670
1671 and for Overall:
1672 DC_offset
1673 Min_level
1674 Max_level
1675 Min_difference
1676 Max_difference
1677 Mean_difference
1678 RMS_difference
1679 Peak_level
1680 RMS_level
1681 RMS_peak
1682 RMS_trough
1683 Flat_factor
1684 Peak_count
1685 Bit_depth
1686 Number_of_samples
1687
1688 For example full key look like this @code{lavfi.astats.1.DC_offset} or
1689 this @code{lavfi.astats.Overall.Peak_count}.
1690
1691 For description what each key means read below.
1692
1693 @item reset
1694 Set number of frame after which stats are going to be recalculated.
1695 Default is disabled.
1696 @end table
1697
1698 A description of each shown parameter follows:
1699
1700 @table @option
1701 @item DC offset
1702 Mean amplitude displacement from zero.
1703
1704 @item Min level
1705 Minimal sample level.
1706
1707 @item Max level
1708 Maximal sample level.
1709
1710 @item Min difference
1711 Minimal difference between two consecutive samples.
1712
1713 @item Max difference
1714 Maximal difference between two consecutive samples.
1715
1716 @item Mean difference
1717 Mean difference between two consecutive samples.
1718 The average of each difference between two consecutive samples.
1719
1720 @item RMS difference
1721 Root Mean Square difference between two consecutive samples.
1722
1723 @item Peak level dB
1724 @item RMS level dB
1725 Standard peak and RMS level measured in dBFS.
1726
1727 @item RMS peak dB
1728 @item RMS trough dB
1729 Peak and trough values for RMS level measured over a short window.
1730
1731 @item Crest factor
1732 Standard ratio of peak to RMS level (note: not in dB).
1733
1734 @item Flat factor
1735 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
1736 (i.e. either @var{Min level} or @var{Max level}).
1737
1738 @item Peak count
1739 Number of occasions (not the number of samples) that the signal attained either
1740 @var{Min level} or @var{Max level}.
1741
1742 @item Bit depth
1743 Overall bit depth of audio. Number of bits used for each sample.
1744
1745 @item Dynamic range
1746 Measured dynamic range of audio in dB.
1747 @end table
1748
1749 @section atempo
1750
1751 Adjust audio tempo.
1752
1753 The filter accepts exactly one parameter, the audio tempo. If not
1754 specified then the filter will assume nominal 1.0 tempo. Tempo must
1755 be in the [0.5, 2.0] range.
1756
1757 @subsection Examples
1758
1759 @itemize
1760 @item
1761 Slow down audio to 80% tempo:
1762 @example
1763 atempo=0.8
1764 @end example
1765
1766 @item
1767 To speed up audio to 125% tempo:
1768 @example
1769 atempo=1.25
1770 @end example
1771 @end itemize
1772
1773 @section atrim
1774
1775 Trim the input so that the output contains one continuous subpart of the input.
1776
1777 It accepts the following parameters:
1778 @table @option
1779 @item start
1780 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
1781 sample with the timestamp @var{start} will be the first sample in the output.
1782
1783 @item end
1784 Specify time of the first audio sample that will be dropped, i.e. the
1785 audio sample immediately preceding the one with the timestamp @var{end} will be
1786 the last sample in the output.
1787
1788 @item start_pts
1789 Same as @var{start}, except this option sets the start timestamp in samples
1790 instead of seconds.
1791
1792 @item end_pts
1793 Same as @var{end}, except this option sets the end timestamp in samples instead
1794 of seconds.
1795
1796 @item duration
1797 The maximum duration of the output in seconds.
1798
1799 @item start_sample
1800 The number of the first sample that should be output.
1801
1802 @item end_sample
1803 The number of the first sample that should be dropped.
1804 @end table
1805
1806 @option{start}, @option{end}, and @option{duration} are expressed as time
1807 duration specifications; see
1808 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
1809
1810 Note that the first two sets of the start/end options and the @option{duration}
1811 option look at the frame timestamp, while the _sample options simply count the
1812 samples that pass through the filter. So start/end_pts and start/end_sample will
1813 give different results when the timestamps are wrong, inexact or do not start at
1814 zero. Also note that this filter does not modify the timestamps. If you wish
1815 to have the output timestamps start at zero, insert the asetpts filter after the
1816 atrim filter.
1817
1818 If multiple start or end options are set, this filter tries to be greedy and
1819 keep all samples that match at least one of the specified constraints. To keep
1820 only the part that matches all the constraints at once, chain multiple atrim
1821 filters.
1822
1823 The defaults are such that all the input is kept. So it is possible to set e.g.
1824 just the end values to keep everything before the specified time.
1825
1826 Examples:
1827 @itemize
1828 @item
1829 Drop everything except the second minute of input:
1830 @example
1831 ffmpeg -i INPUT -af atrim=60:120
1832 @end example
1833
1834 @item
1835 Keep only the first 1000 samples:
1836 @example
1837 ffmpeg -i INPUT -af atrim=end_sample=1000
1838 @end example
1839
1840 @end itemize
1841
1842 @section bandpass
1843
1844 Apply a two-pole Butterworth band-pass filter with central
1845 frequency @var{frequency}, and (3dB-point) band-width width.
1846 The @var{csg} option selects a constant skirt gain (peak gain = Q)
1847 instead of the default: constant 0dB peak gain.
1848 The filter roll off at 6dB per octave (20dB per decade).
1849
1850 The filter accepts the following options:
1851
1852 @table @option
1853 @item frequency, f
1854 Set the filter's central frequency. Default is @code{3000}.
1855
1856 @item csg
1857 Constant skirt gain if set to 1. Defaults to 0.
1858
1859 @item width_type, t
1860 Set method to specify band-width of filter.
1861 @table @option
1862 @item h
1863 Hz
1864 @item q
1865 Q-Factor
1866 @item o
1867 octave
1868 @item s
1869 slope
1870 @end table
1871
1872 @item width, w
1873 Specify the band-width of a filter in width_type units.
1874
1875 @item channels, c
1876 Specify which channels to filter, by default all available are filtered.
1877 @end table
1878
1879 @section bandreject
1880
1881 Apply a two-pole Butterworth band-reject filter with central
1882 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
1883 The filter roll off at 6dB per octave (20dB per decade).
1884
1885 The filter accepts the following options:
1886
1887 @table @option
1888 @item frequency, f
1889 Set the filter's central frequency. Default is @code{3000}.
1890
1891 @item width_type, t
1892 Set method to specify band-width of filter.
1893 @table @option
1894 @item h
1895 Hz
1896 @item q
1897 Q-Factor
1898 @item o
1899 octave
1900 @item s
1901 slope
1902 @end table
1903
1904 @item width, w
1905 Specify the band-width of a filter in width_type units.
1906
1907 @item channels, c
1908 Specify which channels to filter, by default all available are filtered.
1909 @end table
1910
1911 @section bass
1912
1913 Boost or cut the bass (lower) frequencies of the audio using a two-pole
1914 shelving filter with a response similar to that of a standard
1915 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1916
1917 The filter accepts the following options:
1918
1919 @table @option
1920 @item gain, g
1921 Give the gain at 0 Hz. Its useful range is about -20
1922 (for a large cut) to +20 (for a large boost).
1923 Beware of clipping when using a positive gain.
1924
1925 @item frequency, f
1926 Set the filter's central frequency and so can be used
1927 to extend or reduce the frequency range to be boosted or cut.
1928 The default value is @code{100} Hz.
1929
1930 @item width_type, t
1931 Set method to specify band-width of filter.
1932 @table @option
1933 @item h
1934 Hz
1935 @item q
1936 Q-Factor
1937 @item o
1938 octave
1939 @item s
1940 slope
1941 @end table
1942
1943 @item width, w
1944 Determine how steep is the filter's shelf transition.
1945
1946 @item channels, c
1947 Specify which channels to filter, by default all available are filtered.
1948 @end table
1949
1950 @section biquad
1951
1952 Apply a biquad IIR filter with the given coefficients.
1953 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
1954 are the numerator and denominator coefficients respectively.
1955 and @var{channels}, @var{c} specify which channels to filter, by default all
1956 available are filtered.
1957
1958 @section bs2b
1959 Bauer stereo to binaural transformation, which improves headphone listening of
1960 stereo audio records.
1961
1962 To enable compilation of this filter you need to configure FFmpeg with
1963 @code{--enable-libbs2b}.
1964
1965 It accepts the following parameters:
1966 @table @option
1967
1968 @item profile
1969 Pre-defined crossfeed level.
1970 @table @option
1971
1972 @item default
1973 Default level (fcut=700, feed=50).
1974
1975 @item cmoy
1976 Chu Moy circuit (fcut=700, feed=60).
1977
1978 @item jmeier
1979 Jan Meier circuit (fcut=650, feed=95).
1980
1981 @end table
1982
1983 @item fcut
1984 Cut frequency (in Hz).
1985
1986 @item feed
1987 Feed level (in Hz).
1988
1989 @end table
1990
1991 @section channelmap
1992
1993 Remap input channels to new locations.
1994
1995 It accepts the following parameters:
1996 @table @option
1997 @item map
1998 Map channels from input to output. The argument is a '|'-separated list of
1999 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
2000 @var{in_channel} form. @var{in_channel} can be either the name of the input
2001 channel (e.g. FL for front left) or its index in the input channel layout.
2002 @var{out_channel} is the name of the output channel or its index in the output
2003 channel layout. If @var{out_channel} is not given then it is implicitly an
2004 index, starting with zero and increasing by one for each mapping.
2005
2006 @item channel_layout
2007 The channel layout of the output stream.
2008 @end table
2009
2010 If no mapping is present, the filter will implicitly map input channels to
2011 output channels, preserving indices.
2012
2013 For example, assuming a 5.1+downmix input MOV file,
2014 @example
2015 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
2016 @end example
2017 will create an output WAV file tagged as stereo from the downmix channels of
2018 the input.
2019
2020 To fix a 5.1 WAV improperly encoded in AAC's native channel order
2021 @example
2022 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
2023 @end example
2024
2025 @section channelsplit
2026
2027 Split each channel from an input audio stream into a separate output stream.
2028
2029 It accepts the following parameters:
2030 @table @option
2031 @item channel_layout
2032 The channel layout of the input stream. The default is "stereo".
2033 @end table
2034
2035 For example, assuming a stereo input MP3 file,
2036 @example
2037 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
2038 @end example
2039 will create an output Matroska file with two audio streams, one containing only
2040 the left channel and the other the right channel.
2041
2042 Split a 5.1 WAV file into per-channel files:
2043 @example
2044 ffmpeg -i in.wav -filter_complex
2045 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
2046 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
2047 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
2048 side_right.wav
2049 @end example
2050
2051 @section chorus
2052 Add a chorus effect to the audio.
2053
2054 Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
2055
2056 Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
2057 constant, with chorus, it is varied using using sinusoidal or triangular modulation.
2058 The modulation depth defines the range the modulated delay is played before or after
2059 the delay. Hence the delayed sound will sound slower or faster, that is the delayed
2060 sound tuned around the original one, like in a chorus where some vocals are slightly
2061 off key.
2062
2063 It accepts the following parameters:
2064 @table @option
2065 @item in_gain
2066 Set input gain. Default is 0.4.
2067
2068 @item out_gain
2069 Set output gain. Default is 0.4.
2070
2071 @item delays
2072 Set delays. A typical delay is around 40ms to 60ms.
2073
2074 @item decays
2075 Set decays.
2076
2077 @item speeds
2078 Set speeds.
2079
2080 @item depths
2081 Set depths.
2082 @end table
2083
2084 @subsection Examples
2085
2086 @itemize
2087 @item
2088 A single delay:
2089 @example
2090 chorus=0.7:0.9:55:0.4:0.25:2
2091 @end example
2092
2093 @item
2094 Two delays:
2095 @example
2096 chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
2097 @end example
2098
2099 @item
2100 Fuller sounding chorus with three delays:
2101 @example
2102 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
2103 @end example
2104 @end itemize
2105
2106 @section compand
2107 Compress or expand the audio's dynamic range.
2108
2109 It accepts the following parameters:
2110
2111 @table @option
2112
2113 @item attacks
2114 @item decays
2115 A list of times in seconds for each channel over which the instantaneous level
2116 of the input signal is averaged to determine its volume. @var{attacks} refers to
2117 increase of volume and @var{decays} refers to decrease of volume. For most
2118 situations, the attack time (response to the audio getting louder) should be
2119 shorter than the decay time, because the human ear is more sensitive to sudden
2120 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
2121 a typical value for decay is 0.8 seconds.
2122 If specified number of attacks & decays is lower than number of channels, the last
2123 set attack/decay will be used for all remaining channels.
2124
2125 @item points
2126 A list of points for the transfer function, specified in dB relative to the
2127 maximum possible signal amplitude. Each key points list must be defined using
2128 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
2129 @code{x0/y0 x1/y1 x2/y2 ....}
2130
2131 The input values must be in strictly increasing order but the transfer function
2132 does not have to be monotonically rising. The point @code{0/0} is assumed but
2133 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
2134 function are @code{-70/-70|-60/-20|1/0}.
2135
2136 @item soft-knee
2137 Set the curve radius in dB for all joints. It defaults to 0.01.
2138
2139 @item gain
2140 Set the additional gain in dB to be applied at all points on the transfer
2141 function. This allows for easy adjustment of the overall gain.
2142 It defaults to 0.
2143
2144 @item volume
2145 Set an initial volume, in dB, to be assumed for each channel when filtering
2146 starts. This permits the user to supply a nominal level initially, so that, for
2147 example, a very large gain is not applied to initial signal levels before the
2148 companding has begun to operate. A typical value for audio which is initially
2149 quiet is -90 dB. It defaults to 0.
2150
2151 @item delay
2152 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
2153 delayed before being fed to the volume adjuster. Specifying a delay
2154 approximately equal to the attack/decay times allows the filter to effectively
2155 operate in predictive rather than reactive mode. It defaults to 0.
2156
2157 @end table
2158
2159 @subsection Examples
2160
2161 @itemize
2162 @item
2163 Make music with both quiet and loud passages suitable for listening to in a
2164 noisy environment:
2165 @example
2166 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
2167 @end example
2168
2169 Another example for audio with whisper and explosion parts:
2170 @example
2171 compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
2172 @end example
2173
2174 @item
2175 A noise gate for when the noise is at a lower level than the signal:
2176 @example
2177 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
2178 @end example
2179
2180 @item
2181 Here is another noise gate, this time for when the noise is at a higher level
2182 than the signal (making it, in some ways, similar to squelch):
2183 @example
2184 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
2185 @end example
2186
2187 @item
2188 2:1 compression starting at -6dB:
2189 @example
2190 compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
2191 @end example
2192
2193 @item
2194 2:1 compression starting at -9dB:
2195 @example
2196 compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
2197 @end example
2198
2199 @item
2200 2:1 compression starting at -12dB:
2201 @example
2202 compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
2203 @end example
2204
2205 @item
2206 2:1 compression starting at -18dB:
2207 @example
2208 compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
2209 @end example
2210
2211 @item
2212 3:1 compression starting at -15dB:
2213 @example
2214 compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
2215 @end example
2216
2217 @item
2218 Compressor/Gate:
2219 @example
2220 compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
2221 @end example
2222
2223 @item
2224 Expander:
2225 @example
2226 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
2227 @end example
2228
2229 @item
2230 Hard limiter at -6dB:
2231 @example
2232 compand=attacks=0:points=-80/-80|-6/-6|20/-6
2233 @end example
2234
2235 @item
2236 Hard limiter at -12dB:
2237 @example
2238 compand=attacks=0:points=-80/-80|-12/-12|20/-12
2239 @end example
2240
2241 @item
2242 Hard noise gate at -35 dB:
2243 @example
2244 compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
2245 @end example
2246
2247 @item
2248 Soft limiter:
2249 @example
2250 compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
2251 @end example
2252 @end itemize
2253
2254 @section compensationdelay
2255
2256 Compensation Delay Line is a metric based delay to compensate differing
2257 positions of microphones or speakers.
2258
2259 For example, you have recorded guitar with two microphones placed in
2260 different location. Because the front of sound wave has fixed speed in
2261 normal conditions, the phasing of microphones can vary and depends on
2262 their location and interposition. The best sound mix can be achieved when
2263 these microphones are in phase (synchronized). Note that distance of
2264 ~30 cm between microphones makes one microphone to capture signal in
2265 antiphase to another microphone. That makes the final mix sounding moody.
2266 This filter helps to solve phasing problems by adding different delays
2267 to each microphone track and make them synchronized.
2268
2269 The best result can be reached when you take one track as base and
2270 synchronize other tracks one by one with it.
2271 Remember that synchronization/delay tolerance depends on sample rate, too.
2272 Higher sample rates will give more tolerance.
2273
2274 It accepts the following parameters:
2275
2276 @table @option
2277 @item mm
2278 Set millimeters distance. This is compensation distance for fine tuning.
2279 Default is 0.
2280
2281 @item cm
2282 Set cm distance. This is compensation distance for tightening distance setup.
2283 Default is 0.
2284
2285 @item m
2286 Set meters distance. This is compensation distance for hard distance setup.
2287 Default is 0.
2288
2289 @item dry
2290 Set dry amount. Amount of unprocessed (dry) signal.
2291 Default is 0.
2292
2293 @item wet
2294 Set wet amount. Amount of processed (wet) signal.
2295 Default is 1.
2296
2297 @item temp
2298 Set temperature degree in Celsius. This is the temperature of the environment.
2299 Default is 20.
2300 @end table
2301
2302 @section crossfeed
2303 Apply headphone crossfeed filter.
2304
2305 Crossfeed is the process of blending the left and right channels of stereo
2306 audio recording.
2307 It is mainly used to reduce extreme stereo separation of low frequencies.
2308
2309 The intent is to produce more speaker like sound to the listener.
2310
2311 The filter accepts the following options:
2312
2313 @table @option
2314 @item strength
2315 Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1.
2316 This sets gain of low shelf filter for side part of stereo image.
2317 Default is -6dB. Max allowed is -30db when strength is set to 1.
2318
2319 @item range
2320 Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1.
2321 This sets cut off frequency of low shelf filter. Default is cut off near
2322 1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz.
2323
2324 @item level_in
2325 Set input gain. Default is 0.9.
2326
2327 @item level_out
2328 Set output gain. Default is 1.
2329 @end table
2330
2331 @section crystalizer
2332 Simple algorithm to expand audio dynamic range.
2333
2334 The filter accepts the following options:
2335
2336 @table @option
2337 @item i
2338 Sets the intensity of effect (default: 2.0). Must be in range between 0.0
2339 (unchanged sound) to 10.0 (maximum effect).
2340
2341 @item c
2342 Enable clipping. By default is enabled.
2343 @end table
2344
2345 @section dcshift
2346 Apply a DC shift to the audio.
2347
2348 This can be useful to remove a DC offset (caused perhaps by a hardware problem
2349 in the recording chain) from the audio. The effect of a DC offset is reduced
2350 headroom and hence volume. The @ref{astats} filter can be used to determine if
2351 a signal has a DC offset.
2352
2353 @table @option
2354 @item shift
2355 Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
2356 the audio.
2357
2358 @item limitergain
2359 Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
2360 used to prevent clipping.
2361 @end table
2362
2363 @section dynaudnorm
2364 Dynamic Audio Normalizer.
2365
2366 This filter applies a certain amount of gain to the input audio in order
2367 to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
2368 contrast to more "simple" normalization algorithms, the Dynamic Audio
2369 Normalizer *dynamically* re-adjusts the gain factor to the input audio.
2370 This allows for applying extra gain to the "quiet" sections of the audio
2371 while avoiding distortions or clipping the "loud" sections. In other words:
2372 The Dynamic Audio Normalizer will "even out" the volume of quiet and loud
2373 sections, in the sense that the volume of each section is brought to the
2374 same target level. Note, however, that the Dynamic Audio Normalizer achieves
2375 this goal *without* applying "dynamic range compressing". It will retain 100%
2376 of the dynamic range *within* each section of the audio file.
2377
2378 @table @option
2379 @item f
2380 Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
2381 Default is 500 milliseconds.
2382 The Dynamic Audio Normalizer processes the input audio in small chunks,
2383 referred to as frames. This is required, because a peak magnitude has no
2384 meaning for just a single sample value. Instead, we need to determine the
2385 peak magnitude for a contiguous sequence of sample values. While a "standard"
2386 normalizer would simply use the peak magnitude of the complete file, the
2387 Dynamic Audio Normalizer determines the peak magnitude individually for each
2388 frame. The length of a frame is specified in milliseconds. By default, the
2389 Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
2390 been found to give good results with most files.
2391 Note that the exact frame length, in number of samples, will be determined
2392 automatically, based on the sampling rate of the individual input audio file.
2393
2394 @item g
2395 Set the Gaussian filter window size. In range from 3 to 301, must be odd
2396 number. Default is 31.
2397 Probably the most important parameter of the Dynamic Audio Normalizer is the
2398 @code{window size} of the Gaussian smoothing filter. The filter's window size
2399 is specified in frames, centered around the current frame. For the sake of
2400 simplicity, this must be an odd number. Consequently, the default value of 31
2401 takes into account the current frame, as well as the 15 preceding frames and
2402 the 15 subsequent frames. Using a larger window results in a stronger
2403 smoothing effect and thus in less gain variation, i.e. slower gain
2404 adaptation. Conversely, using a smaller window results in a weaker smoothing
2405 effect and thus in more gain variation, i.e. faster gain adaptation.
2406 In other words, the more you increase this value, the more the Dynamic Audio
2407 Normalizer will behave like a "traditional" normalization filter. On the
2408 contrary, the more you decrease this value, the more the Dynamic Audio
2409 Normalizer will behave like a dynamic range compressor.
2410
2411 @item p
2412 Set the target peak value. This specifies the highest permissible magnitude
2413 level for the normalized audio input. This filter will try to approach the
2414 target peak magnitude as closely as possible, but at the same time it also
2415 makes sure that the normalized signal will never exceed the peak magnitude.
2416 A frame's maximum local gain factor is imposed directly by the target peak
2417 magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
2418 It is not recommended to go above this value.
2419
2420 @item m
2421 Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
2422 The Dynamic Audio Normalizer determines the maximum possible (local) gain
2423 factor for each input frame, i.e. the maximum gain factor that does not
2424 result in clipping or distortion. The maximum gain factor is determined by
2425 the frame's highest magnitude sample. However, the Dynamic Audio Normalizer
2426 additionally bounds the frame's maximum gain factor by a predetermined
2427 (global) maximum gain factor. This is done in order to avoid excessive gain
2428 factors in "silent" or almost silent frames. By default, the maximum gain
2429 factor is 10.0, For most inputs the default value should be sufficient and
2430 it usually is not recommended to increase this value. Though, for input
2431 with an extremely low overall volume level, it may be necessary to allow even
2432 higher gain factors. Note, however, that the Dynamic Audio Normalizer does
2433 not simply apply a "hard" threshold (i.e. cut off values above the threshold).
2434 Instead, a "sigmoid" threshold function will be applied. This way, the
2435 gain factors will smoothly approach the threshold value, but never exceed that
2436 value.
2437
2438 @item r
2439 Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
2440 By default, the Dynamic Audio Normalizer performs "peak" normalization.
2441 This means that the maximum local gain factor for each frame is defined
2442 (only) by the frame's highest magnitude sample. This way, the samples can
2443 be amplified as much as possible without exceeding the maximum signal
2444 level, i.e. without clipping. Optionally, however, the Dynamic Audio
2445 Normalizer can also take into account the frame's root mean square,
2446 abbreviated RMS. In electrical engineering, the RMS is commonly used to
2447 determine the power of a time-varying signal. It is therefore considered
2448 that the RMS is a better approximation of the "perceived loudness" than
2449 just looking at the signal's peak magnitude. Consequently, by adjusting all
2450 frames to a constant RMS value, a uniform "perceived loudness" can be
2451 established. If a target RMS value has been specified, a frame's local gain
2452 factor is defined as the factor that would result in exactly that RMS value.
2453 Note, however, that the maximum local gain factor is still restricted by the
2454 frame's highest magnitude sample, in order to prevent clipping.
2455
2456 @item n
2457 Enable channels coupling. By default is enabled.
2458 By default, the Dynamic Audio Normalizer will amplify all channels by the same
2459 amount. This means the same gain factor will be applied to all channels, i.e.
2460 the maximum possible gain factor is determined by the "loudest" channel.
2461 However, in some recordings, it may happen that the volume of the different
2462 channels is uneven, e.g. one channel may be "quieter" than the other one(s).
2463 In this case, this option can be used to disable the channel coupling. This way,
2464 the gain factor will be determined independently for each channel, depending
2465 only on the individual channel's highest magnitude sample. This allows for
2466 harmonizing the volume of the different channels.
2467
2468 @item c
2469 Enable DC bias correction. By default is disabled.
2470 An audio signal (in the time domain) is a sequence of sample values.
2471 In the Dynamic Audio Normalizer these sample values are represented in the
2472 -1.0 to 1.0 range, regardless of the original input format. Normally, the
2473 audio signal, or "waveform", should be centered around the zero point.
2474 That means if we calculate the mean value of all samples in a file, or in a
2475 single frame, then the result should be 0.0 or at least very close to that
2476 value. If, however, there is a significant deviation of the mean value from
2477 0.0, in either positive or negative direction, this is referred to as a
2478 DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
2479 Audio Normalizer provides optional DC bias correction.
2480 With DC bias correction enabled, the Dynamic Audio Normalizer will determine
2481 the mean value, or "DC correction" offset, of each input frame and subtract
2482 that value from all of the frame's sample values which ensures those samples
2483 are centered around 0.0 again. Also, in order to avoid "gaps" at the frame
2484 boundaries, the DC correction offset values will be interpolated smoothly
2485 between neighbouring frames.
2486
2487 @item b
2488 Enable alternative boundary mode. By default is disabled.
2489 The Dynamic Audio Normalizer takes into account a certain neighbourhood
2490 around each frame. This includes the preceding frames as well as the
2491 subsequent frames. However, for the "boundary" frames, located at the very
2492 beginning and at the very end of the audio file, not all neighbouring
2493 frames are available. In particular, for the first few frames in the audio
2494 file, the preceding frames are not known. And, similarly, for the last few
2495 frames in the audio file, the subsequent frames are not known. Thus, the
2496 question arises which gain factors should be assumed for the missing frames
2497 in the "boundary" region. The Dynamic Audio Normalizer implements two modes
2498 to deal with this situation. The default boundary mode assumes a gain factor
2499 of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and
2500 "fade out" at the beginning and at the end of the input, respectively.
2501
2502 @item s
2503 Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
2504 By default, the Dynamic Audio Normalizer does not apply "traditional"
2505 compression. This means that signal peaks will not be pruned and thus the
2506 full dynamic range will be retained within each local neighbourhood. However,
2507 in some cases it may be desirable to combine the Dynamic Audio Normalizer's
2508 normalization algorithm with a more "traditional" compression.
2509 For this purpose, the Dynamic Audio Normalizer provides an optional compression
2510 (thresholding) function. If (and only if) the compression feature is enabled,
2511 all input frames will be processed by a soft knee thresholding function prior
2512 to the actual normalization process. Put simply, the thresholding function is
2513 going to prune all samples whose magnitude exceeds a certain threshold value.
2514 However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
2515 value. Instead, the threshold value will be adjusted for each individual
2516 frame.
2517 In general, smaller parameters result in stronger compression, and vice versa.
2518 Values below 3.0 are not recommended, because audible distortion may appear.
2519 @end table
2520
2521 @section earwax
2522
2523 Make audio easier to listen to on headphones.
2524
2525 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
2526 so that when listened to on headphones the stereo image is moved from
2527 inside your head (standard for headphones) to outside and in front of
2528 the listener (standard for speakers).
2529
2530 Ported from SoX.
2531
2532 @section equalizer
2533
2534 Apply a two-pole peaking equalisation (EQ) filter. With this
2535 filter, the signal-level at and around a selected frequency can
2536 be increased or decreased, whilst (unlike bandpass and bandreject
2537 filters) that at all other frequencies is unchanged.
2538
2539 In order to produce complex equalisation curves, this filter can
2540 be given several times, each with a different central frequency.
2541
2542 The filter accepts the following options:
2543
2544 @table @option
2545 @item frequency, f
2546 Set the filter's central frequency in Hz.
2547
2548 @item width_type, t
2549 Set method to specify band-width of filter.
2550 @table @option
2551 @item h
2552 Hz
2553 @item q
2554 Q-Factor
2555 @item o
2556 octave
2557 @item s
2558 slope
2559 @end table
2560
2561 @item width, w
2562 Specify the band-width of a filter in width_type units.
2563
2564 @item gain, g
2565 Set the required gain or attenuation in dB.
2566 Beware of clipping when using a positive gain.
2567
2568 @item channels, c
2569 Specify which channels to filter, by default all available are filtered.
2570 @end table
2571
2572 @subsection Examples
2573 @itemize
2574 @item
2575 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
2576 @example
2577 equalizer=f=1000:t=h:width=200:g=-10
2578 @end example
2579
2580 @item
2581 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
2582 @example
2583 equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
2584 @end example
2585 @end itemize
2586
2587 @section extrastereo
2588
2589 Linearly increases the difference between left and right channels which
2590 adds some sort of "live" effect to playback.
2591
2592 The filter accepts the following options:
2593
2594 @table @option
2595 @item m
2596 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
2597 (average of both channels), with 1.0 sound will be unchanged, with
2598 -1.0 left and right channels will be swapped.
2599
2600 @item c
2601 Enable clipping. By default is enabled.
2602 @end table
2603
2604 @section firequalizer
2605 Apply FIR Equalization using arbitrary frequency response.
2606
2607 The filter accepts the following option:
2608
2609 @table @option
2610 @item gain
2611 Set gain curve equation (in dB). The expression can contain variables:
2612 @table @option
2613 @item f
2614 the evaluated frequency
2615 @item sr
2616 sample rate
2617 @item ch
2618 channel number, set to 0 when multichannels evaluation is disabled
2619 @item chid
2620 channel id, see libavutil/channel_layout.h, set to the first channel id when
2621 multichannels evaluation is disabled
2622 @item chs
2623 number of channels
2624 @item chlayout
2625 channel_layout, see libavutil/channel_layout.h
2626
2627 @end table
2628 and functions:
2629 @table @option
2630 @item gain_interpolate(f)
2631 interpolate gain on frequency f based on gain_entry
2632 @item cubic_interpolate(f)
2633 same as gain_interpolate, but smoother
2634 @end table
2635 This option is also available as command. Default is @code{gain_interpolate(f)}.
2636
2637 @item gain_entry
2638 Set gain entry for gain_interpolate function. The expression can
2639 contain functions:
2640 @table @option
2641 @item entry(f, g)
2642 store gain entry at frequency f with value g
2643 @end table
2644 This option is also available as command.
2645
2646 @item delay
2647 Set filter delay in seconds. Higher value means more accurate.
2648 Default is @code{0.01}.
2649
2650 @item accuracy
2651 Set filter accuracy in Hz. Lower value means more accurate.
2652 Default is @code{5}.
2653
2654 @item wfunc
2655 Set window function. Acceptable values are:
2656 @table @option
2657 @item rectangular
2658 rectangular window, useful when gain curve is already smooth
2659 @item hann
2660 hann window (default)
2661 @item hamming
2662 hamming window
2663 @item blackman
2664 blackman window
2665 @item nuttall3
2666 3-terms continuous 1st derivative nuttall window
2667 @item mnuttall3
2668 minimum 3-terms discontinuous nuttall window
2669 @item nuttall
2670 4-terms continuous 1st derivative nuttall window
2671 @item bnuttall
2672 minimum 4-terms discontinuous nuttall (blackman-nuttall) window
2673 @item bharris
2674 blackman-harris window
2675 @item tukey
2676 tukey window
2677 @end table
2678
2679 @item fixed
2680 If enabled, use fixed number of audio samples. This improves speed when
2681 filtering with large delay. Default is disabled.
2682
2683 @item multi
2684 Enable multichannels evaluation on gain. Default is disabled.
2685
2686 @item zero_phase
2687 Enable zero phase mode by subtracting timestamp to compensate delay.
2688 Default is disabled.
2689
2690 @item scale
2691 Set scale used by gain. Acceptable values are:
2692 @table @option
2693 @item linlin
2694 linear frequency, linear gain
2695 @item linlog
2696 linear frequency, logarithmic (in dB) gain (default)
2697 @item loglin
2698 logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain
2699 @item loglog
2700 logarithmic frequency, logarithmic gain
2701 @end table
2702
2703 @item dumpfile
2704 Set file for dumping, suitable for gnuplot.
2705
2706 @item dumpscale
2707 Set scale for dumpfile. Acceptable values are same with scale option.
2708 Default is linlog.
2709
2710 @item fft2
2711 Enable 2-channel convolution using complex FFT. This improves speed significantly.
2712 Default is disabled.
2713
2714 @item min_phase
2715 Enable minimum phase impulse response. Default is disabled.
2716 @end table
2717
2718 @subsection Examples
2719 @itemize
2720 @item
2721 lowpass at 1000 Hz:
2722 @example
2723 firequalizer=gain='if(lt(f,1000), 0, -INF)'
2724 @end example
2725 @item
2726 lowpass at 1000 Hz with gain_entry:
2727 @example
2728 firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
2729 @end example
2730 @item
2731 custom equalization:
2732 @example
2733 firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
2734 @end example
2735 @item
2736 higher delay with zero phase to compensate delay:
2737 @example
2738 firequalizer=delay=0.1:fixed=on:zero_phase=on
2739 @end example
2740 @item
2741 lowpass on left channel, highpass on right channel:
2742 @example
2743 firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
2744 :gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
2745 @end example
2746 @end itemize
2747
2748 @section flanger
2749 Apply a flanging effect to the audio.
2750
2751 The filter accepts the following options:
2752
2753 @table @option
2754 @item delay
2755 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
2756
2757 @item depth
2758 Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2.
2759
2760 @item regen
2761 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
2762 Default value is 0.
2763
2764 @item width
2765 Set percentage of delayed signal mixed with original. Range from 0 to 100.
2766 Default value is 71.
2767
2768 @item speed
2769 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
2770
2771 @item shape
2772 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
2773 Default value is @var{sinusoidal}.
2774
2775 @item phase
2776 Set swept wave percentage-shift for multi channel. Range from 0 to 100.
2777 Default value is 25.
2778
2779 @item interp
2780 Set delay-line interpolation, @var{linear} or @var{quadratic}.
2781 Default is @var{linear}.
2782 @end table
2783
2784 @section haas
2785 Apply Haas effect to audio.
2786
2787 Note that this makes most sense to apply on mono signals.
2788 With this filter applied to mono signals it give some directionality and
2789 stretches its stereo image.
2790
2791 The filter accepts the following options:
2792
2793 @table @option
2794 @item level_in
2795 Set input level. By default is @var{1}, or 0dB
2796
2797 @item level_out
2798 Set output level. By default is @var{1}, or 0dB.
2799
2800 @item side_gain
2801 Set gain applied to side part of signal. By default is @var{1}.
2802
2803 @item middle_source
2804 Set kind of middle source. Can be one of the following:
2805
2806 @table @samp
2807 @item left
2808 Pick left channel.
2809
2810 @item right
2811 Pick right channel.
2812
2813 @item mid
2814 Pick middle part signal of stereo image.
2815
2816 @item side
2817 Pick side part signal of stereo image.
2818 @end table
2819
2820 @item middle_phase
2821 Change middle phase. By default is disabled.
2822
2823 @item left_delay
2824 Set left channel delay. By default is @var{2.05} milliseconds.
2825
2826 @item left_balance
2827 Set left channel balance. By default is @var{-1}.
2828
2829 @item left_gain
2830 Set left channel gain. By default is @var{1}.
2831
2832 @item left_phase
2833 Change left phase. By default is disabled.
2834
2835 @item right_delay
2836 Set right channel delay. By defaults is @var{2.12} milliseconds.
2837
2838 @item right_balance
2839 Set right channel balance. By default is @var{1}.
2840
2841 @item right_gain
2842 Set right channel gain. By default is @var{1}.
2843
2844 @item right_phase
2845 Change right phase. By default is enabled.
2846 @end table
2847
2848 @section hdcd
2849
2850 Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with
2851 embedded HDCD codes is expanded into a 20-bit PCM stream.
2852
2853 The filter supports the Peak Extend and Low-level Gain Adjustment features
2854 of HDCD, and detects the Transient Filter flag.
2855
2856 @example
2857 ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
2858 @end example
2859
2860 When using the filter with wav, note the default encoding for wav is 16-bit,
2861 so the resulting 20-bit stream will be truncated back to 16-bit. Use something
2862 like @command{-acodec pcm_s24le} after the filter to get 24-bit PCM output.
2863 @example
2864 ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
2865 ffmpeg -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
2866 @end example
2867
2868 The filter accepts the following options:
2869
2870 @table @option
2871 @item disable_autoconvert
2872 Disable any automatic format conversion or resampling in the filter graph.
2873
2874 @item process_stereo
2875 Process the stereo channels together. If target_gain does not match between
2876 channels, consider it invalid and use the last valid target_gain.
2877
2878 @item cdt_ms
2879 Set the code detect timer period in ms.
2880
2881 @item force_pe
2882 Always extend peaks above -3dBFS even if PE isn't signaled.
2883
2884 @item analyze_mode
2885 Replace audio with a solid tone and adjust the amplitude to signal some
2886 specific aspect of the decoding process. The output file can be loaded in
2887 an audio editor alongside the original to aid analysis.
2888
2889 @code{analyze_mode=pe:force_pe=true} can be used to see all samples above the PE level.
2890
2891 Modes are:
2892 @table @samp
2893 @item 0, off
2894 Disabled
2895 @item 1, lle
2896 Gain adjustment level at each sample
2897 @item 2, pe
2898 Samples where peak extend occurs
2899 @item 3, cdt
2900 Samples where the code detect timer is active
2901 @item 4, tgm
2902 Samples where the target gain does not match between channels
2903 @end table
2904 @end table
2905
2906 @section headphone
2907
2908 Apply head-related transfer functions (HRTFs) to create virtual
2909 loudspeakers around the user for binaural listening via headphones.
2910 The HRIRs are provided via additional streams, for each channel
2911 one stereo input stream is needed.
2912
2913 The filter accepts the following options:
2914
2915 @table @option
2916 @item map
2917 Set mapping of input streams for convolution.
2918 The argument is a '|'-separated list of channel names in order as they
2919 are given as additional stream inputs for filter.
2920 This also specify number of input streams. Number of input streams
2921 must be not less than number of channels in first stream plus one.
2922
2923 @item gain
2924 Set gain applied to audio. Value is in dB. Default is 0.
2925
2926 @item type
2927 Set processing type. Can be @var{time} or @var{freq}. @var{time} is
2928 processing audio in time domain which is slow.
2929 @var{freq} is processing audio in frequency domain which is fast.
2930 Default is @var{freq}.
2931
2932 @item lfe
2933 Set custom gain for LFE channels. Value is in dB. Default is 0.
2934 @end table
2935
2936 @subsection Examples
2937
2938 @itemize
2939 @item
2940 Full example using wav files as coefficients with amovie filters for 7.1 downmix,
2941 each amovie filter use stereo file with IR coefficients as input.
2942 The files give coefficients for each position of virtual loudspeaker:
2943 @example
2944 ffmpeg -i input.wav -lavfi-complex "amovie=azi_270_ele_0_DFC.wav[sr],amovie=azi_90_ele_0_DFC.wav[sl],amovie=azi_225_ele_0_DFC.wav[br],amovie=azi_135_ele_0_DFC.wav[bl],amovie=azi_0_ele_0_DFC.wav,asplit[fc][lfe],amovie=azi_35_ele_0_DFC.wav[fl],amovie=azi_325_ele_0_DFC.wav[fr],[a:0][fl][fr][fc][lfe][bl][br][sl][sr]headphone=FL|FR|FC|LFE|BL|BR|SL|SR"
2945 output.wav
2946 @end example
2947 @end itemize
2948
2949 @section highpass
2950
2951 Apply a high-pass filter with 3dB point frequency.
2952 The filter can be either single-pole, or double-pole (the default).
2953 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
2954
2955 The filter accepts the following options:
2956
2957 @table @option
2958 @item frequency, f
2959 Set frequency in Hz. Default is 3000.
2960
2961 @item poles, p
2962 Set number of poles. Default is 2.
2963
2964 @item width_type, t
2965 Set method to specify band-width of filter.
2966 @table @option
2967 @item h
2968 Hz
2969 @item q
2970 Q-Factor
2971 @item o
2972 octave
2973 @item s
2974 slope
2975 @end table
2976
2977 @item width, w
2978 Specify the band-width of a filter in width_type units.
2979 Applies only to double-pole filter.
2980 The default is 0.707q and gives a Butterworth response.
2981
2982 @item channels, c
2983 Specify which channels to filter, by default all available are filtered.
2984 @end table
2985
2986 @section join
2987
2988 Join multiple input streams into one multi-channel stream.
2989
2990 It accepts the following parameters:
2991 @table @option
2992
2993 @item inputs
2994 The number of input streams. It defaults to 2.
2995
2996 @item channel_layout
2997 The desired output channel layout. It defaults to stereo.
2998
2999 @item map
3000 Map channels from inputs to output. The argument is a '|'-separated list of
3001 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
3002 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
3003 can be either the name of the input channel (e.g. FL for front left) or its
3004 index in the specified input stream. @var{out_channel} is the name of the output
3005 channel.
3006 @end table
3007
3008 The filter will attempt to guess the mappings when they are not specified
3009 explicitly. It does so by first trying to find an unused matching input channel
3010 and if that fails it picks the first unused input channel.
3011
3012 Join 3 inputs (with properly set channel layouts):
3013 @example
3014 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
3015 @end example
3016
3017 Build a 5.1 output from 6 single-channel streams:
3018 @example
3019 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
3020 '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'
3021 out
3022 @end example
3023
3024 @section ladspa
3025
3026 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
3027
3028 To enable compilation of this filter you need to configure FFmpeg with
3029 @code{--enable-ladspa}.
3030
3031 @table @option
3032 @item file, f
3033 Specifies the name of LADSPA plugin library to load. If the environment
3034 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
3035 each one of the directories specified by the colon separated list in
3036 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
3037 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
3038 @file{/usr/lib/ladspa/}.
3039
3040 @item plugin, p
3041 Specifies the plugin within the library. Some libraries contain only
3042 one plugin, but others contain many of them. If this is not set filter
3043 will list all available plugins within the specified library.
3044
3045 @item controls, c
3046 Set the '|' separated list of controls which are zero or more floating point
3047 values that determine the behavior of the loaded plugin (for example delay,
3048 threshold or gain).
3049 Controls need to be defined using the following syntax:
3050 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
3051 @var{valuei} is the value set on the @var{i}-th control.
3052 Alternatively they can be also defined using the following syntax:
3053 @var{value0}|@var{value1}|@var{value2}|..., where
3054 @var{valuei} is the value set on the @var{i}-th control.
3055 If @option{controls} is set to @code{help}, all available controls and
3056 their valid ranges are printed.
3057
3058 @item sample_rate, s
3059 Specify the sample rate, default to 44100. Only used if plugin have
3060 zero inputs.
3061
3062 @item nb_samples, n
3063 Set the number of samples per channel per each output frame, default
3064 is 1024. Only used if plugin have zero inputs.
3065
3066 @item duration, d
3067 Set the minimum duration of the sourced audio. See
3068 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
3069 for the accepted syntax.
3070 Note that the resulting duration may be greater than the specified duration,
3071 as the generated audio is always cut at the end of a complete frame.
3072 If not specified, or the expressed duration is negative, the audio is
3073 supposed to be generated forever.
3074 Only used if plugin have zero inputs.
3075
3076 @end table
3077
3078 @subsection Examples
3079
3080 @itemize
3081 @item
3082 List all available plugins within amp (LADSPA example plugin) library:
3083 @example
3084 ladspa=file=amp
3085 @end example
3086
3087 @item
3088 List all available controls and their valid ranges for @code{vcf_notch}
3089 plugin from @code{VCF} library:
3090 @example
3091 ladspa=f=vcf:p=vcf_notch:c=help
3092 @end example
3093
3094 @item
3095 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
3096 plugin library:
3097 @example
3098 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
3099 @end example
3100
3101 @item
3102 Add reverberation to the audio using TAP-plugins
3103 (Tom's Audio Processing plugins):
3104 @example
3105 ladspa=file=tap_reverb:tap_reverb
3106 @end example
3107
3108 @item
3109 Generate white noise, with 0.2 amplitude:
3110 @example
3111 ladspa=file=cmt:noise_source_white:c=c0=.2
3112 @end example
3113
3114 @item
3115 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
3116 @code{C* Audio Plugin Suite} (CAPS) library:
3117 @example
3118 ladspa=file=caps:Click:c=c1=20'
3119 @end example
3120
3121 @item
3122 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
3123 @example
3124 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
3125 @end example
3126
3127 @item
3128 Increase volume by 20dB using fast lookahead limiter from Steve Harris
3129 @code{SWH Plugins} collection:
3130 @example
3131 ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
3132 @end example
3133
3134 @item
3135 Attenuate low frequencies using Multiband EQ from Steve Harris
3136 @code{SWH Plugins} collection:
3137 @example
3138 ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
3139 @end example
3140
3141 @item
3142 Reduce stereo image using @code{Narrower} from the @code{C* Audio Plugin Suite}
3143 (CAPS) library:
3144 @example
3145 ladspa=caps:Narrower
3146 @end example
3147
3148 @item
3149 Another white noise, now using @code{C* Audio Plugin Suite} (CAPS) library:
3150 @example
3151 ladspa=caps:White:.2
3152 @end example
3153
3154 @item
3155 Some fractal noise, using @code{C* Audio Plugin Suite} (CAPS) library:
3156 @example
3157 ladspa=caps:Fractal:c=c1=1
3158 @end example
3159
3160 @item
3161 Dynamic volume normalization using @code{VLevel} plugin:
3162 @example
3163 ladspa=vlevel-ladspa:vlevel_mono
3164 @end example
3165 @end itemize
3166
3167 @subsection Commands
3168
3169 This filter supports the following commands:
3170 @table @option
3171 @item cN
3172 Modify the @var{N}-th control value.
3173
3174 If the specified value is not valid, it is ignored and prior one is kept.
3175 @end table
3176
3177 @section loudnorm
3178
3179 EBU R128 loudness normalization. Includes both dynamic and linear normalization modes.
3180 Support for both single pass (livestreams, files) and double pass (files) modes.
3181 This algorithm can target IL, LRA, and maximum true peak. To accurately detect true peaks,
3182 the audio stream will be upsampled to 192 kHz unless the normalization mode is linear.
3183 Use the @code{-ar} option or @code{aresample} filter to explicitly set an output sample rate.
3184
3185 The filter accepts the following options:
3186
3187 @table @option
3188 @item I, i
3189 Set integrated loudness target.
3190 Range is -70.0 - -5.0. Default value is -24.0.
3191
3192 @item LRA, lra
3193 Set loudness range target.
3194 Range is 1.0 - 20.0. Default value is 7.0.
3195
3196 @item TP, tp
3197 Set maximum true peak.
3198 Range is -9.0 - +0.0. Default value is -2.0.
3199
3200 @item measured_I, measured_i
3201 Measured IL of input file.
3202 Range is -99.0 - +0.0.
3203
3204 @item measured_LRA, measured_lra
3205 Measured LRA of input file.
3206 Range is  0.0 - 99.0.
3207
3208 @item measured_TP, measured_tp
3209 Measured true peak of input file.
3210 Range is  -99.0 - +99.0.
3211
3212 @item measured_thresh
3213 Measured threshold of input file.
3214 Range is -99.0 - +0.0.
3215
3216 @item offset
3217 Set offset gain. Gain is applied before the true-peak limiter.
3218 Range is  -99.0 - +99.0. Default is +0.0.
3219
3220 @item linear
3221 Normalize linearly if possible.
3222 measured_I, measured_LRA, measured_TP, and measured_thresh must also
3223 to be specified in order to use this mode.
3224 Options are true or false. Default is true.
3225
3226 @item dual_mono
3227 Treat mono input files as "dual-mono". If a mono file is intended for playback
3228 on a stereo system, its EBU R128 measurement will be perceptually incorrect.
3229 If set to @code{true}, this option will compensate for this effect.
3230 Multi-channel input files are not affected by this option.
3231 Options are true or false. Default is false.
3232
3233 @item print_format
3234 Set print format for stats. Options are summary, json, or none.
3235 Default value is none.
3236 @end table
3237
3238 @section lowpass
3239
3240 Apply a low-pass filter with 3dB point frequency.
3241 The filter can be either single-pole or double-pole (the default).
3242 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
3243
3244 The filter accepts the following options:
3245
3246 @table @option
3247 @item frequency, f
3248 Set frequency in Hz. Default is 500.
3249
3250 @item poles, p
3251 Set number of poles. Default is 2.
3252
3253 @item width_type, t
3254 Set method to specify band-width of filter.
3255 @table @option
3256 @item h
3257 Hz
3258 @item q
3259 Q-Factor
3260 @item o
3261 octave
3262 @item s
3263 slope
3264 @end table
3265
3266 @item width, w
3267 Specify the band-width of a filter in width_type units.
3268 Applies only to double-pole filter.
3269 The default is 0.707q and gives a Butterworth response.
3270
3271 @item channels, c
3272 Specify which channels to filter, by default all available are filtered.
3273 @end table
3274
3275 @subsection Examples
3276 @itemize
3277 @item
3278 Lowpass only LFE channel, it LFE is not present it does nothing:
3279 @example
3280 lowpass=c=LFE
3281 @end example
3282 @end itemize
3283
3284 @section lv2
3285
3286 Load a LV2 (LADSPA Version 2) plugin.
3287
3288 To enable compilation of this filter you need to configure FFmpeg with
3289 @code{--enable-lv2}.
3290
3291 @table @option
3292 @item plugin, p
3293 Specifies the plugin URI. You may need to escape ':'.
3294
3295 @item controls, c
3296 Set the '|' separated list of controls which are zero or more floating point
3297 values that determine the behavior of the loaded plugin (for example delay,
3298 threshold or gain).
3299 If @option{controls} is set to @code{help}, all available controls and
3300 their valid ranges are printed.
3301
3302 @item sample_rate, s
3303 Specify the sample rate, default to 44100. Only used if plugin have
3304 zero inputs.
3305
3306 @item nb_samples, n
3307 Set the number of samples per channel per each output frame, default
3308 is 1024. Only used if plugin have zero inputs.
3309
3310 @item duration, d
3311 Set the minimum duration of the sourced audio. See
3312 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
3313 for the accepted syntax.
3314 Note that the resulting duration may be greater than the specified duration,
3315 as the generated audio is always cut at the end of a complete frame.
3316 If not specified, or the expressed duration is negative, the audio is
3317 supposed to be generated forever.
3318 Only used if plugin have zero inputs.
3319 @end table
3320
3321 @subsection Examples
3322
3323 @itemize
3324 @item
3325 Apply bass enhancer plugin from Calf:
3326 @example
3327 lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2
3328 @end example
3329
3330 @item
3331 Apply bass vinyl plugin from Calf:
3332 @example
3333 lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5
3334 @end example
3335
3336 @item
3337 Apply bit crusher plugin from ArtyFX:
3338 @example
3339 lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
3340 @end example
3341 @end itemize
3342
3343 @section mcompand
3344 Multiband Compress or expand the audio's dynamic range.
3345
3346 The input audio is divided into bands using 4th order Linkwitz-Riley IIRs.
3347 This is akin to the crossover of a loudspeaker, and results in flat frequency
3348 response when absent compander action.
3349
3350 It accepts the following parameters:
3351
3352 @table @option
3353 @item args
3354 This option syntax is:
3355 attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ...
3356 For explanation of each item refer to compand filter documentation.
3357 @end table
3358
3359 @anchor{pan}
3360 @section pan
3361
3362 Mix channels with specific gain levels. The filter accepts the output
3363 channel layout followed by a set of channels definitions.
3364
3365 This filter is also designed to efficiently remap the channels of an audio
3366 stream.
3367
3368 The filter accepts parameters of the form:
3369 "@var{l}|@var{outdef}|@var{outdef}|..."
3370
3371 @table @option
3372 @item l
3373 output channel layout or number of channels
3374
3375 @item outdef
3376 output channel specification, of the form:
3377 "@var{out_name}=[@var{gain}*]@var{in_name}[(+-)[@var{gain}*]@var{in_name}...]"
3378
3379 @item out_name
3380 output channel to define, either a channel name (FL, FR, etc.) or a channel
3381 number (c0, c1, etc.)
3382
3383 @item gain
3384 multiplicative coefficient for the channel, 1 leaving the volume unchanged
3385
3386 @item in_name
3387 input channel to use, see out_name for details; it is not possible to mix
3388 named and numbered input channels
3389 @end table
3390
3391 If the `=' in a channel specification is replaced by `<', then the gains for
3392 that specification will be renormalized so that the total is 1, thus
3393 avoiding clipping noise.
3394
3395 @subsection Mixing examples
3396
3397 For example, if you want to down-mix from stereo to mono, but with a bigger
3398 factor for the left channel:
3399 @example
3400 pan=1c|c0=0.9*c0+0.1*c1
3401 @end example
3402
3403 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
3404 7-channels surround:
3405 @example
3406 pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
3407 @end example
3408
3409 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
3410 that should be preferred (see "-ac" option) unless you have very specific
3411 needs.
3412
3413 @subsection Remapping examples
3414
3415 The channel remapping will be effective if, and only if:
3416
3417 @itemize
3418 @item gain coefficients are zeroes or ones,
3419 @item only one input per channel output,
3420 @end itemize
3421
3422 If all these conditions are satisfied, the filter will notify the user ("Pure
3423 channel mapping detected"), and use an optimized and lossless method to do the
3424 remapping.
3425
3426 For example, if you have a 5.1 source and want a stereo audio stream by
3427 dropping the extra channels:
3428 @example
3429 pan="stereo| c0=FL | c1=FR"
3430 @end example
3431
3432 Given the same source, you can also switch front left and front right channels
3433 and keep the input channel layout:
3434 @example
3435 pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
3436 @end example
3437
3438 If the input is a stereo audio stream, you can mute the front left channel (and
3439 still keep the stereo channel layout) with:
3440 @example
3441 pan="stereo|c1=c1"
3442 @end example
3443
3444 Still with a stereo audio stream input, you can copy the right channel in both
3445 front left and right:
3446 @example
3447 pan="stereo| c0=FR | c1=FR"
3448 @end example
3449
3450 @section replaygain
3451
3452 ReplayGain scanner filter. This filter takes an audio stream as an input and
3453 outputs it unchanged.
3454 At end of filtering it displays @code{track_gain} and @code{track_peak}.
3455
3456 @section resample
3457
3458 Convert the audio sample format, sample rate and channel layout. It is
3459 not meant to be used directly.
3460
3461 @section rubberband
3462 Apply time-stretching and pitch-shifting with librubberband.
3463
3464 The filter accepts the following options:
3465
3466 @table @option
3467 @item tempo
3468 Set tempo scale factor.
3469
3470 @item pitch
3471 Set pitch scale factor.
3472
3473 @item transients
3474 Set transients detector.
3475 Possible values are:
3476 @table @var
3477 @item crisp
3478 @item mixed
3479 @item smooth
3480 @end table
3481
3482 @item detector
3483 Set detector.
3484 Possible values are:
3485 @table @var
3486 @item compound
3487 @item percussive
3488 @item soft
3489 @end table
3490
3491 @item phase
3492 Set phase.
3493 Possible values are:
3494 @table @var
3495 @item laminar
3496 @item independent
3497 @end table
3498
3499 @item window
3500 Set processing window size.
3501 Possible values are:
3502 @table @var
3503 @item standard
3504 @item short
3505 @item long
3506 @end table
3507
3508 @item smoothing
3509 Set smoothing.
3510 Possible values are:
3511 @table @var
3512 @item off
3513 @item on
3514 @end table
3515
3516 @item formant
3517 Enable formant preservation when shift pitching.
3518 Possible values are:
3519 @table @var
3520 @item shifted
3521 @item preserved
3522 @end table
3523
3524 @item pitchq
3525 Set pitch quality.
3526 Possible values are:
3527 @table @var
3528 @item quality
3529 @item speed
3530 @item consistency
3531 @end table
3532
3533 @item channels
3534 Set channels.
3535 Possible values are:
3536 @table @var
3537 @item apart
3538 @item together
3539 @end table
3540 @end table
3541
3542 @section sidechaincompress
3543
3544 This filter acts like normal compressor but has the ability to compress
3545 detected signal using second input signal.
3546 It needs two input streams and returns one output stream.
3547 First input stream will be processed depending on second stream signal.
3548 The filtered signal then can be filtered with other filters in later stages of
3549 processing. See @ref{pan} and @ref{amerge} filter.
3550
3551 The filter accepts the following options:
3552
3553 @table @option
3554 @item level_in
3555 Set input gain. Default is 1. Range is between 0.015625 and 64.
3556
3557 @item threshold
3558 If a signal of second stream raises above this level it will affect the gain
3559 reduction of first stream.
3560 By default is 0.125. Range is between 0.00097563 and 1.
3561
3562 @item ratio
3563 Set a ratio about which the signal is reduced. 1:2 means that if the level
3564 raised 4dB above the threshold, it will be only 2dB above after the reduction.
3565 Default is 2. Range is between 1 and 20.
3566
3567 @item attack
3568 Amount of milliseconds the signal has to rise above the threshold before gain
3569 reduction starts. Default is 20. Range is between 0.01 and 2000.
3570
3571 @item release
3572 Amount of milliseconds the signal has to fall below the threshold before
3573 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
3574
3575 @item makeup
3576 Set the amount by how much signal will be amplified after processing.
3577 Default is 1. Range is from 1 to 64.
3578
3579 @item knee
3580 Curve the sharp knee around the threshold to enter gain reduction more softly.
3581 Default is 2.82843. Range is between 1 and 8.
3582
3583 @item link
3584 Choose if the @code{average} level between all channels of side-chain stream
3585 or the louder(@code{maximum}) channel of side-chain stream affects the
3586 reduction. Default is @code{average}.
3587
3588 @item detection
3589 Should the exact signal be taken in case of @code{peak} or an RMS one in case
3590 of @code{rms}. Default is @code{rms} which is mainly smoother.
3591
3592 @item level_sc
3593 Set sidechain gain. Default is 1. Range is between 0.015625 and 64.
3594
3595 @item mix
3596 How much to use compressed signal in output. Default is 1.
3597 Range is between 0 and 1.
3598 @end table
3599
3600 @subsection Examples
3601
3602 @itemize
3603 @item
3604 Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
3605 depending on the signal of 2nd input and later compressed signal to be
3606 merged with 2nd input:
3607 @example
3608 ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
3609 @end example
3610 @end itemize
3611
3612 @section sidechaingate
3613
3614 A sidechain gate acts like a normal (wideband) gate but has the ability to
3615 filter the detected signal before sending it to the gain reduction stage.
3616 Normally a gate uses the full range signal to detect a level above the
3617 threshold.
3618 For example: If you cut all lower frequencies from your sidechain signal
3619 the gate will decrease the volume of your track only if not enough highs
3620 appear. With this technique you are able to reduce the resonation of a
3621 natural drum or remove "rumbling" of muted strokes from a heavily distorted
3622 guitar.
3623 It needs two input streams and returns one output stream.
3624 First input stream will be processed depending on second stream signal.
3625
3626 The filter accepts the following options:
3627
3628 @table @option
3629 @item level_in
3630 Set input level before filtering.
3631 Default is 1. Allowed range is from 0.015625 to 64.
3632
3633 @item range
3634 Set the level of gain reduction when the signal is below the threshold.
3635 Default is 0.06125. Allowed range is from 0 to 1.
3636
3637 @item threshold
3638 If a signal rises above this level the gain reduction is released.
3639 Default is 0.125. Allowed range is from 0 to 1.
3640
3641 @item ratio
3642 Set a ratio about which the signal is reduced.
3643 Default is 2. Allowed range is from 1 to 9000.
3644
3645 @item attack
3646 Amount of milliseconds the signal has to rise above the threshold before gain
3647 reduction stops.
3648 Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
3649
3650 @item release
3651 Amount of milliseconds the signal has to fall below the threshold before the
3652 reduction is increased again. Default is 250 milliseconds.
3653 Allowed range is from 0.01 to 9000.
3654
3655 @item makeup
3656 Set amount of amplification of signal after processing.
3657 Default is 1. Allowed range is from 1 to 64.
3658
3659 @item knee
3660 Curve the sharp knee around the threshold to enter gain reduction more softly.
3661 Default is 2.828427125. Allowed range is from 1 to 8.
3662
3663 @item detection
3664 Choose if exact signal should be taken for detection or an RMS like one.
3665 Default is rms. Can be peak or rms.
3666
3667 @item link
3668 Choose if the average level between all channels or the louder channel affects
3669 the reduction.
3670 Default is average. Can be average or maximum.
3671
3672 @item level_sc
3673 Set sidechain gain. Default is 1. Range is from 0.015625 to 64.
3674 @end table
3675
3676 @section silencedetect
3677
3678 Detect silence in an audio stream.
3679
3680 This filter logs a message when it detects that the input audio volume is less
3681 or equal to a noise tolerance value for a duration greater or equal to the
3682 minimum detected noise duration.
3683
3684 The printed times and duration are expressed in seconds.
3685
3686 The filter accepts the following options:
3687
3688 @table @option
3689 @item duration, d
3690 Set silence duration until notification (default is 2 seconds).
3691
3692 @item noise, n
3693 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
3694 specified value) or amplitude ratio. Default is -60dB, or 0.001.
3695 @end table
3696
3697 @subsection Examples
3698
3699 @itemize
3700 @item
3701 Detect 5 seconds of silence with -50dB noise tolerance:
3702 @example
3703 silencedetect=n=-50dB:d=5
3704 @end example
3705
3706 @item
3707 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
3708 tolerance in @file{silence.mp3}:
3709 @example
3710 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
3711 @end example
3712 @end itemize
3713
3714 @section silenceremove
3715
3716 Remove silence from the beginning, middle or end of the audio.
3717
3718 The filter accepts the following options:
3719
3720 @table @option
3721 @item start_periods
3722 This value is used to indicate if audio should be trimmed at beginning of
3723 the audio. A value of zero indicates no silence should be trimmed from the
3724 beginning. When specifying a non-zero value, it trims audio up until it
3725 finds non-silence. Normally, when trimming silence from beginning of audio
3726 the @var{start_periods} will be @code{1} but it can be increased to higher
3727 values to trim all audio up to specific count of non-silence periods.
3728 Default value is @code{0}.
3729
3730 @item start_duration
3731 Specify the amount of time that non-silence must be detected before it stops
3732 trimming audio. By increasing the duration, bursts of noises can be treated
3733 as silence and trimmed off. Default value is @code{0}.
3734
3735 @item start_threshold
3736 This indicates what sample value should be treated as silence. For digital
3737 audio, a value of @code{0} may be fine but for audio recorded from analog,
3738 you may wish to increase the value to account for background noise.
3739 Can be specified in dB (in case "dB" is appended to the specified value)
3740 or amplitude ratio. Default value is @code{0}.
3741
3742 @item stop_periods
3743 Set the count for trimming silence from the end of audio.
3744 To remove silence from the middle of a file, specify a @var{stop_periods}
3745 that is negative. This value is then treated as a positive value and is
3746 used to indicate the effect should restart processing as specified by
3747 @var{start_periods}, making it suitable for removing periods of silence
3748 in the middle of the audio.
3749 Default value is @code{0}.
3750
3751 @item stop_duration
3752 Specify a duration of silence that must exist before audio is not copied any
3753 more. By specifying a higher duration, silence that is wanted can be left in
3754 the audio.
3755 Default value is @code{0}.
3756
3757 @item stop_threshold
3758 This is the same as @option{start_threshold} but for trimming silence from
3759 the end of audio.
3760 Can be specified in dB (in case "dB" is appended to the specified value)
3761 or amplitude ratio. Default value is @code{0}.
3762
3763 @item leave_silence
3764 This indicates that @var{stop_duration} length of audio should be left intact
3765 at the beginning of each period of silence.
3766 For example, if you want to remove long pauses between words but do not want
3767 to remove the pauses completely. Default value is @code{0}.
3768
3769 @item detection
3770 Set how is silence detected. Can be @code{rms} or @code{peak}. Second is faster
3771 and works better with digital silence which is exactly 0.
3772 Default value is @code{rms}.
3773
3774 @item window
3775 Set ratio used to calculate size of window for detecting silence.
3776 Default value is @code{0.02}. Allowed range is from @code{0} to @code{10}.
3777 @end table
3778
3779 @subsection Examples
3780
3781 @itemize
3782 @item
3783 The following example shows how this filter can be used to start a recording
3784 that does not contain the delay at the start which usually occurs between
3785 pressing the record button and the start of the performance:
3786 @example
3787 silenceremove=1:5:0.02
3788 @end example
3789
3790 @item
3791 Trim all silence encountered from beginning to end where there is more than 1
3792 second of silence in audio:
3793 @example
3794 silenceremove=0:0:0:-1:1:-90dB
3795 @end example
3796 @end itemize
3797
3798 @section sofalizer
3799
3800 SOFAlizer uses head-related transfer functions (HRTFs) to create virtual
3801 loudspeakers around the user for binaural listening via headphones (audio
3802 formats up to 9 channels supported).
3803 The HRTFs are stored in SOFA files (see @url{http://www.sofacoustics.org/} for a database).
3804 SOFAlizer is developed at the Acoustics Research Institute (ARI) of the
3805 Austrian Academy of Sciences.
3806
3807 To enable compilation of this filter you need to configure FFmpeg with
3808 @code{--enable-libmysofa}.
3809
3810 The filter accepts the following options:
3811
3812 @table @option
3813 @item sofa
3814 Set the SOFA file used for rendering.
3815
3816 @item gain
3817 Set gain applied to audio. Value is in dB. Default is 0.
3818
3819 @item rotation
3820 Set rotation of virtual loudspeakers in deg. Default is 0.
3821
3822 @item elevation
3823 Set elevation of virtual speakers in deg. Default is 0.
3824
3825 @item radius
3826 Set distance in meters between loudspeakers and the listener with near-field
3827 HRTFs. Default is 1.
3828
3829 @item type
3830 Set processing type. Can be @var{time} or @var{freq}. @var{time} is
3831 processing audio in time domain which is slow.
3832 @var{freq} is processing audio in frequency domain which is fast.
3833 Default is @var{freq}.
3834
3835 @item speakers
3836 Set custom positions of virtual loudspeakers. Syntax for this option is:
3837 <CH> <AZIM> <ELEV>[|<CH> <AZIM> <ELEV>|...].
3838 Each virtual loudspeaker is described with short channel name following with
3839 azimuth and elevation in degrees.
3840 Each virtual loudspeaker description is separated by '|'.
3841 For example to override front left and front right channel positions use:
3842 'speakers=FL 45 15|FR 345 15'.
3843 Descriptions with unrecognised channel names are ignored.
3844
3845 @item lfegain
3846 Set custom gain for LFE channels. Value is in dB. Default is 0.
3847 @end table
3848
3849 @subsection Examples
3850
3851 @itemize
3852 @item
3853 Using ClubFritz6 sofa file:
3854 @example
3855 sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=1
3856 @end example
3857
3858 @item
3859 Using ClubFritz12 sofa file and bigger radius with small rotation:
3860 @example
3861 sofalizer=sofa=/path/to/ClubFritz12.sofa:type=freq:radius=2:rotation=5
3862 @end example
3863
3864 @item
3865 Similar as above but with custom speaker positions for front left, front right, back left and back right
3866 and also with custom gain:
3867 @example
3868 "sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|BL 135|BR 225:gain=28"
3869 @end example
3870 @end itemize
3871
3872 @section stereotools
3873
3874 This filter has some handy utilities to manage stereo signals, for converting
3875 M/S stereo recordings to L/R signal while having control over the parameters
3876 or spreading the stereo image of master track.
3877
3878 The filter accepts the following options:
3879
3880 @table @option
3881 @item level_in
3882 Set input level before filtering for both channels. Defaults is 1.
3883 Allowed range is from 0.015625 to 64.
3884
3885 @item level_out
3886 Set output level after filtering for both channels. Defaults is 1.
3887 Allowed range is from 0.015625 to 64.
3888
3889 @item balance_in
3890 Set input balance between both channels. Default is 0.
3891 Allowed range is from -1 to 1.
3892
3893 @item balance_out
3894 Set output balance between both channels. Default is 0.
3895 Allowed range is from -1 to 1.
3896
3897 @item softclip
3898 Enable softclipping. Results in analog distortion instead of harsh digital 0dB
3899 clipping. Disabled by default.
3900
3901 @item mutel
3902 Mute the left channel. Disabled by default.
3903
3904 @item muter
3905 Mute the right channel. Disabled by default.
3906
3907 @item phasel
3908 Change the phase of the left channel. Disabled by default.
3909
3910 @item phaser
3911 Change the phase of the right channel. Disabled by default.
3912
3913 @item mode
3914 Set stereo mode. Available values are:
3915
3916 @table @samp
3917 @item lr>lr
3918 Left/Right to Left/Right, this is default.
3919
3920 @item lr>ms
3921 Left/Right to Mid/Side.
3922
3923 @item ms>lr
3924 Mid/Side to Left/Right.
3925
3926 @item lr>ll
3927 Left/Right to Left/Left.
3928
3929 @item lr>rr
3930 Left/Right to Right/Right.
3931
3932 @item lr>l+r
3933 Left/Right to Left + Right.
3934
3935 @item lr>rl
3936 Left/Right to Right/Left.
3937
3938 @item ms>ll
3939 Mid/Side to Left/Left.
3940
3941 @item ms>rr
3942 Mid/Side to Right/Right.
3943 @end table
3944
3945 @item slev
3946 Set level of side signal. Default is 1.
3947 Allowed range is from 0.015625 to 64.
3948
3949 @item sbal
3950 Set balance of side signal. Default is 0.
3951 Allowed range is from -1 to 1.
3952
3953 @item mlev
3954 Set level of the middle signal. Default is 1.
3955 Allowed range is from 0.015625 to 64.
3956
3957 @item mpan
3958 Set middle signal pan. Default is 0. Allowed range is from -1 to 1.
3959
3960 @item base
3961 Set stereo base between mono and inversed channels. Default is 0.
3962 Allowed range is from -1 to 1.
3963
3964 @item delay
3965 Set delay in milliseconds how much to delay left from right channel and
3966 vice versa. Default is 0. Allowed range is from -20 to 20.
3967
3968 @item sclevel
3969 Set S/C level. Default is 1. Allowed range is from 1 to 100.
3970
3971 @item phase
3972 Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360.
3973
3974 @item bmode_in, bmode_out
3975 Set balance mode for balance_in/balance_out option.
3976
3977 Can be one of the following:
3978
3979 @table @samp
3980 @item balance
3981 Classic balance mode. Attenuate one channel at time.
3982 Gain is raised up to 1.
3983
3984 @item amplitude
3985 Similar as classic mode above but gain is raised up to 2.
3986
3987 @item power
3988 Equal power distribution, from -6dB to +6dB range.
3989 @end table
3990 @end table
3991
3992 @subsection Examples
3993
3994 @itemize
3995 @item
3996 Apply karaoke like effect:
3997 @example
3998 stereotools=mlev=0.015625
3999 @end example
4000
4001 @item
4002 Convert M/S signal to L/R:
4003 @example
4004 "stereotools=mode=ms>lr"
4005 @end example
4006 @end itemize
4007
4008 @section stereowiden
4009
4010 This filter enhance the stereo effect by suppressing signal common to both
4011 channels and by delaying the signal of left into right and vice versa,
4012 thereby widening the stereo effect.
4013
4014 The filter accepts the following options:
4015
4016 @table @option
4017 @item delay
4018 Time in milliseconds of the delay of left signal into right and vice versa.
4019 Default is 20 milliseconds.
4020
4021 @item feedback
4022 Amount of gain in delayed signal into right and vice versa. Gives a delay
4023 effect of left signal in right output and vice versa which gives widening
4024 effect. Default is 0.3.
4025
4026 @item crossfeed
4027 Cross feed of left into right with inverted phase. This helps in suppressing
4028 the mono. If the value is 1 it will cancel all the signal common to both
4029 channels. Default is 0.3.
4030
4031 @item drymix
4032 Set level of input signal of original channel. Default is 0.8.
4033 @end table
4034
4035 @section superequalizer
4036 Apply 18 band equalizer.
4037
4038 The filter accepts the following options:
4039 @table @option
4040 @item 1b
4041 Set 65Hz band gain.
4042 @item 2b
4043 Set 92Hz band gain.
4044 @item 3b
4045 Set 131Hz band gain.
4046 @item 4b
4047 Set 185Hz band gain.
4048 @item 5b
4049 Set 262Hz band gain.
4050 @item 6b
4051 Set 370Hz band gain.
4052 @item 7b
4053 Set 523Hz band gain.
4054 @item 8b
4055 Set 740Hz band gain.
4056 @item 9b
4057 Set 1047Hz band gain.
4058 @item 10b
4059 Set 1480Hz band gain.
4060 @item 11b
4061 Set 2093Hz band gain.
4062 @item 12b
4063 Set 2960Hz band gain.
4064 @item 13b
4065 Set 4186Hz band gain.
4066 @item 14b
4067 Set 5920Hz band gain.
4068 @item 15b
4069 Set 8372Hz band gain.
4070 @item 16b
4071 Set 11840Hz band gain.
4072 @item 17b
4073 Set 16744Hz band gain.
4074 @item 18b
4075 Set 20000Hz band gain.
4076 @end table
4077
4078 @section surround
4079 Apply audio surround upmix filter.
4080
4081 This filter allows to produce multichannel output from audio stream.
4082
4083 The filter accepts the following options:
4084
4085 @table @option
4086 @item chl_out
4087 Set output channel layout. By default, this is @var{5.1}.
4088
4089 See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
4090 for the required syntax.
4091
4092 @item chl_in
4093 Set input channel layout. By default, this is @var{stereo}.
4094
4095 See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
4096 for the required syntax.
4097
4098 @item level_in
4099 Set input volume level. By default, this is @var{1}.
4100
4101 @item level_out
4102 Set output volume level. By default, this is @var{1}.
4103
4104 @item lfe
4105 Enable LFE channel output if output channel layout has it. By default, this is enabled.
4106
4107 @item lfe_low
4108 Set LFE low cut off frequency. By default, this is @var{128} Hz.
4109
4110 @item lfe_high
4111 Set LFE high cut off frequency. By default, this is @var{256} Hz.
4112
4113 @item fc_in
4114 Set front center input volume. By default, this is @var{1}.
4115
4116 @item fc_out
4117 Set front center output volume. By default, this is @var{1}.
4118
4119 @item lfe_in
4120 Set LFE input volume. By default, this is @var{1}.
4121
4122 @item lfe_out
4123 Set LFE output volume. By default, this is @var{1}.
4124 @end table
4125
4126 @section treble
4127
4128 Boost or cut treble (upper) frequencies of the audio using a two-pole
4129 shelving filter with a response similar to that of a standard
4130 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
4131
4132 The filter accepts the following options:
4133
4134 @table @option
4135 @item gain, g
4136 Give the gain at whichever is the lower of ~22 kHz and the
4137 Nyquist frequency. Its useful range is about -20 (for a large cut)
4138 to +20 (for a large boost). Beware of clipping when using a positive gain.
4139
4140 @item frequency, f
4141 Set the filter's central frequency and so can be used
4142 to extend or reduce the frequency range to be boosted or cut.
4143 The default value is @code{3000} Hz.
4144
4145 @item width_type, t
4146 Set method to specify band-width of filter.
4147 @table @option
4148 @item h
4149 Hz
4150 @item q
4151 Q-Factor
4152 @item o
4153 octave
4154 @item s
4155 slope
4156 @end table
4157
4158 @item width, w
4159 Determine how steep is the filter's shelf transition.
4160
4161 @item channels, c
4162 Specify which channels to filter, by default all available are filtered.
4163 @end table
4164
4165 @section tremolo
4166
4167 Sinusoidal amplitude modulation.
4168
4169 The filter accepts the following options:
4170
4171 @table @option
4172 @item f
4173 Modulation frequency in Hertz. Modulation frequencies in the subharmonic range
4174 (20 Hz or lower) will result in a tremolo effect.
4175 This filter may also be used as a ring modulator by specifying
4176 a modulation frequency higher than 20 Hz.