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