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