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