471ec3ff37a18a989be6dc4d3b80f29a3dc2bfad
[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 asyncts
1174
1175 Synchronize audio data with timestamps by squeezing/stretching it and/or
1176 dropping samples/adding silence when needed.
1177
1178 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
1179
1180 It accepts the following parameters:
1181 @table @option
1182
1183 @item compensate
1184 Enable stretching/squeezing the data to make it match the timestamps. Disabled
1185 by default. When disabled, time gaps are covered with silence.
1186
1187 @item min_delta
1188 The minimum difference between timestamps and audio data (in seconds) to trigger
1189 adding/dropping samples. The default value is 0.1. If you get an imperfect
1190 sync with this filter, try setting this parameter to 0.
1191
1192 @item max_comp
1193 The maximum compensation in samples per second. Only relevant with compensate=1.
1194 The default value is 500.
1195
1196 @item first_pts
1197 Assume that the first PTS should be this value. The time base is 1 / sample
1198 rate. This allows for padding/trimming at the start of the stream. By default,
1199 no assumption is made about the first frame's expected PTS, so no padding or
1200 trimming is done. For example, this could be set to 0 to pad the beginning with
1201 silence if an audio stream starts after the video stream or to trim any samples
1202 with a negative PTS due to encoder delay.
1203
1204 @end table
1205
1206 @section atempo
1207
1208 Adjust audio tempo.
1209
1210 The filter accepts exactly one parameter, the audio tempo. If not
1211 specified then the filter will assume nominal 1.0 tempo. Tempo must
1212 be in the [0.5, 2.0] range.
1213
1214 @subsection Examples
1215
1216 @itemize
1217 @item
1218 Slow down audio to 80% tempo:
1219 @example
1220 atempo=0.8
1221 @end example
1222
1223 @item
1224 To speed up audio to 125% tempo:
1225 @example
1226 atempo=1.25
1227 @end example
1228 @end itemize
1229
1230 @section atrim
1231
1232 Trim the input so that the output contains one continuous subpart of the input.
1233
1234 It accepts the following parameters:
1235 @table @option
1236 @item start
1237 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
1238 sample with the timestamp @var{start} will be the first sample in the output.
1239
1240 @item end
1241 Specify time of the first audio sample that will be dropped, i.e. the
1242 audio sample immediately preceding the one with the timestamp @var{end} will be
1243 the last sample in the output.
1244
1245 @item start_pts
1246 Same as @var{start}, except this option sets the start timestamp in samples
1247 instead of seconds.
1248
1249 @item end_pts
1250 Same as @var{end}, except this option sets the end timestamp in samples instead
1251 of seconds.
1252
1253 @item duration
1254 The maximum duration of the output in seconds.
1255
1256 @item start_sample
1257 The number of the first sample that should be output.
1258
1259 @item end_sample
1260 The number of the first sample that should be dropped.
1261 @end table
1262
1263 @option{start}, @option{end}, and @option{duration} are expressed as time
1264 duration specifications; see
1265 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
1266
1267 Note that the first two sets of the start/end options and the @option{duration}
1268 option look at the frame timestamp, while the _sample options simply count the
1269 samples that pass through the filter. So start/end_pts and start/end_sample will
1270 give different results when the timestamps are wrong, inexact or do not start at
1271 zero. Also note that this filter does not modify the timestamps. If you wish
1272 to have the output timestamps start at zero, insert the asetpts filter after the
1273 atrim filter.
1274
1275 If multiple start or end options are set, this filter tries to be greedy and
1276 keep all samples that match at least one of the specified constraints. To keep
1277 only the part that matches all the constraints at once, chain multiple atrim
1278 filters.
1279
1280 The defaults are such that all the input is kept. So it is possible to set e.g.
1281 just the end values to keep everything before the specified time.
1282
1283 Examples:
1284 @itemize
1285 @item
1286 Drop everything except the second minute of input:
1287 @example
1288 ffmpeg -i INPUT -af atrim=60:120
1289 @end example
1290
1291 @item
1292 Keep only the first 1000 samples:
1293 @example
1294 ffmpeg -i INPUT -af atrim=end_sample=1000
1295 @end example
1296
1297 @end itemize
1298
1299 @section bandpass
1300
1301 Apply a two-pole Butterworth band-pass filter with central
1302 frequency @var{frequency}, and (3dB-point) band-width width.
1303 The @var{csg} option selects a constant skirt gain (peak gain = Q)
1304 instead of the default: constant 0dB peak gain.
1305 The filter roll off at 6dB per octave (20dB per decade).
1306
1307 The filter accepts the following options:
1308
1309 @table @option
1310 @item frequency, f
1311 Set the filter's central frequency. Default is @code{3000}.
1312
1313 @item csg
1314 Constant skirt gain if set to 1. Defaults to 0.
1315
1316 @item width_type
1317 Set method to specify band-width of filter.
1318 @table @option
1319 @item h
1320 Hz
1321 @item q
1322 Q-Factor
1323 @item o
1324 octave
1325 @item s
1326 slope
1327 @end table
1328
1329 @item width, w
1330 Specify the band-width of a filter in width_type units.
1331 @end table
1332
1333 @section bandreject
1334
1335 Apply a two-pole Butterworth band-reject filter with central
1336 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
1337 The filter roll off at 6dB per octave (20dB per decade).
1338
1339 The filter accepts the following options:
1340
1341 @table @option
1342 @item frequency, f
1343 Set the filter's central frequency. Default is @code{3000}.
1344
1345 @item width_type
1346 Set method to specify band-width of filter.
1347 @table @option
1348 @item h
1349 Hz
1350 @item q
1351 Q-Factor
1352 @item o
1353 octave
1354 @item s
1355 slope
1356 @end table
1357
1358 @item width, w
1359 Specify the band-width of a filter in width_type units.
1360 @end table
1361
1362 @section bass
1363
1364 Boost or cut the bass (lower) frequencies of the audio using a two-pole
1365 shelving filter with a response similar to that of a standard
1366 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1367
1368 The filter accepts the following options:
1369
1370 @table @option
1371 @item gain, g
1372 Give the gain at 0 Hz. Its useful range is about -20
1373 (for a large cut) to +20 (for a large boost).
1374 Beware of clipping when using a positive gain.
1375
1376 @item frequency, f
1377 Set the filter's central frequency and so can be used
1378 to extend or reduce the frequency range to be boosted or cut.
1379 The default value is @code{100} Hz.
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 Determine how steep is the filter's shelf transition.
1396 @end table
1397
1398 @section biquad
1399
1400 Apply a biquad IIR filter with the given coefficients.
1401 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
1402 are the numerator and denominator coefficients respectively.
1403
1404 @section bs2b
1405 Bauer stereo to binaural transformation, which improves headphone listening of
1406 stereo audio records.
1407
1408 It accepts the following parameters:
1409 @table @option
1410
1411 @item profile
1412 Pre-defined crossfeed level.
1413 @table @option
1414
1415 @item default
1416 Default level (fcut=700, feed=50).
1417
1418 @item cmoy
1419 Chu Moy circuit (fcut=700, feed=60).
1420
1421 @item jmeier
1422 Jan Meier circuit (fcut=650, feed=95).
1423
1424 @end table
1425
1426 @item fcut
1427 Cut frequency (in Hz).
1428
1429 @item feed
1430 Feed level (in Hz).
1431
1432 @end table
1433
1434 @section channelmap
1435
1436 Remap input channels to new locations.
1437
1438 It accepts the following parameters:
1439 @table @option
1440 @item channel_layout
1441 The channel layout of the output stream.
1442
1443 @item map
1444 Map channels from input to output. The argument is a '|'-separated list of
1445 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1446 @var{in_channel} form. @var{in_channel} can be either the name of the input
1447 channel (e.g. FL for front left) or its index in the input channel layout.
1448 @var{out_channel} is the name of the output channel or its index in the output
1449 channel layout. If @var{out_channel} is not given then it is implicitly an
1450 index, starting with zero and increasing by one for each mapping.
1451 @end table
1452
1453 If no mapping is present, the filter will implicitly map input channels to
1454 output channels, preserving indices.
1455
1456 For example, assuming a 5.1+downmix input MOV file,
1457 @example
1458 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
1459 @end example
1460 will create an output WAV file tagged as stereo from the downmix channels of
1461 the input.
1462
1463 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1464 @example
1465 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
1466 @end example
1467
1468 @section channelsplit
1469
1470 Split each channel from an input audio stream into a separate output stream.
1471
1472 It accepts the following parameters:
1473 @table @option
1474 @item channel_layout
1475 The channel layout of the input stream. The default is "stereo".
1476 @end table
1477
1478 For example, assuming a stereo input MP3 file,
1479 @example
1480 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1481 @end example
1482 will create an output Matroska file with two audio streams, one containing only
1483 the left channel and the other the right channel.
1484
1485 Split a 5.1 WAV file into per-channel files:
1486 @example
1487 ffmpeg -i in.wav -filter_complex
1488 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1489 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1490 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1491 side_right.wav
1492 @end example
1493
1494 @section chorus
1495 Add a chorus effect to the audio.
1496
1497 Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
1498
1499 Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
1500 constant, with chorus, it is varied using using sinusoidal or triangular modulation.
1501 The modulation depth defines the range the modulated delay is played before or after
1502 the delay. Hence the delayed sound will sound slower or faster, that is the delayed
1503 sound tuned around the original one, like in a chorus where some vocals are slightly
1504 off key.
1505
1506 It accepts the following parameters:
1507 @table @option
1508 @item in_gain
1509 Set input gain. Default is 0.4.
1510
1511 @item out_gain
1512 Set output gain. Default is 0.4.
1513
1514 @item delays
1515 Set delays. A typical delay is around 40ms to 60ms.
1516
1517 @item decays
1518 Set decays.
1519
1520 @item speeds
1521 Set speeds.
1522
1523 @item depths
1524 Set depths.
1525 @end table
1526
1527 @subsection Examples
1528
1529 @itemize
1530 @item
1531 A single delay:
1532 @example
1533 chorus=0.7:0.9:55:0.4:0.25:2
1534 @end example
1535
1536 @item
1537 Two delays:
1538 @example
1539 chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
1540 @end example
1541
1542 @item
1543 Fuller sounding chorus with three delays:
1544 @example
1545 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
1546 @end example
1547 @end itemize
1548
1549 @section compand
1550 Compress or expand the audio's dynamic range.
1551
1552 It accepts the following parameters:
1553
1554 @table @option
1555
1556 @item attacks
1557 @item decays
1558 A list of times in seconds for each channel over which the instantaneous level
1559 of the input signal is averaged to determine its volume. @var{attacks} refers to
1560 increase of volume and @var{decays} refers to decrease of volume. For most
1561 situations, the attack time (response to the audio getting louder) should be
1562 shorter than the decay time, because the human ear is more sensitive to sudden
1563 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
1564 a typical value for decay is 0.8 seconds.
1565 If specified number of attacks & decays is lower than number of channels, the last
1566 set attack/decay will be used for all remaining channels.
1567
1568 @item points
1569 A list of points for the transfer function, specified in dB relative to the
1570 maximum possible signal amplitude. Each key points list must be defined using
1571 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
1572 @code{x0/y0 x1/y1 x2/y2 ....}
1573
1574 The input values must be in strictly increasing order but the transfer function
1575 does not have to be monotonically rising. The point @code{0/0} is assumed but
1576 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
1577 function are @code{-70/-70|-60/-20}.
1578
1579 @item soft-knee
1580 Set the curve radius in dB for all joints. It defaults to 0.01.
1581
1582 @item gain
1583 Set the additional gain in dB to be applied at all points on the transfer
1584 function. This allows for easy adjustment of the overall gain.
1585 It defaults to 0.
1586
1587 @item volume
1588 Set an initial volume, in dB, to be assumed for each channel when filtering
1589 starts. This permits the user to supply a nominal level initially, so that, for
1590 example, a very large gain is not applied to initial signal levels before the
1591 companding has begun to operate. A typical value for audio which is initially
1592 quiet is -90 dB. It defaults to 0.
1593
1594 @item delay
1595 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
1596 delayed before being fed to the volume adjuster. Specifying a delay
1597 approximately equal to the attack/decay times allows the filter to effectively
1598 operate in predictive rather than reactive mode. It defaults to 0.
1599
1600 @end table
1601
1602 @subsection Examples
1603
1604 @itemize
1605 @item
1606 Make music with both quiet and loud passages suitable for listening to in a
1607 noisy environment:
1608 @example
1609 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
1610 @end example
1611
1612 Another example for audio with whisper and explosion parts:
1613 @example
1614 compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
1615 @end example
1616
1617 @item
1618 A noise gate for when the noise is at a lower level than the signal:
1619 @example
1620 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
1621 @end example
1622
1623 @item
1624 Here is another noise gate, this time for when the noise is at a higher level
1625 than the signal (making it, in some ways, similar to squelch):
1626 @example
1627 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
1628 @end example
1629 @end itemize
1630
1631 @section dcshift
1632 Apply a DC shift to the audio.
1633
1634 This can be useful to remove a DC offset (caused perhaps by a hardware problem
1635 in the recording chain) from the audio. The effect of a DC offset is reduced
1636 headroom and hence volume. The @ref{astats} filter can be used to determine if
1637 a signal has a DC offset.
1638
1639 @table @option
1640 @item shift
1641 Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
1642 the audio.
1643
1644 @item limitergain
1645 Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
1646 used to prevent clipping.
1647 @end table
1648
1649 @section dynaudnorm
1650 Dynamic Audio Normalizer.
1651
1652 This filter applies a certain amount of gain to the input audio in order
1653 to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
1654 contrast to more "simple" normalization algorithms, the Dynamic Audio
1655 Normalizer *dynamically* re-adjusts the gain factor to the input audio.
1656 This allows for applying extra gain to the "quiet" sections of the audio
1657 while avoiding distortions or clipping the "loud" sections. In other words:
1658 The Dynamic Audio Normalizer will "even out" the volume of quiet and loud
1659 sections, in the sense that the volume of each section is brought to the
1660 same target level. Note, however, that the Dynamic Audio Normalizer achieves
1661 this goal *without* applying "dynamic range compressing". It will retain 100%
1662 of the dynamic range *within* each section of the audio file.
1663
1664 @table @option
1665 @item f
1666 Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
1667 Default is 500 milliseconds.
1668 The Dynamic Audio Normalizer processes the input audio in small chunks,
1669 referred to as frames. This is required, because a peak magnitude has no
1670 meaning for just a single sample value. Instead, we need to determine the
1671 peak magnitude for a contiguous sequence of sample values. While a "standard"
1672 normalizer would simply use the peak magnitude of the complete file, the
1673 Dynamic Audio Normalizer determines the peak magnitude individually for each
1674 frame. The length of a frame is specified in milliseconds. By default, the
1675 Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
1676 been found to give good results with most files.
1677 Note that the exact frame length, in number of samples, will be determined
1678 automatically, based on the sampling rate of the individual input audio file.
1679
1680 @item g
1681 Set the Gaussian filter window size. In range from 3 to 301, must be odd
1682 number. Default is 31.
1683 Probably the most important parameter of the Dynamic Audio Normalizer is the
1684 @code{window size} of the Gaussian smoothing filter. The filter's window size
1685 is specified in frames, centered around the current frame. For the sake of
1686 simplicity, this must be an odd number. Consequently, the default value of 31
1687 takes into account the current frame, as well as the 15 preceding frames and
1688 the 15 subsequent frames. Using a larger window results in a stronger
1689 smoothing effect and thus in less gain variation, i.e. slower gain
1690 adaptation. Conversely, using a smaller window results in a weaker smoothing
1691 effect and thus in more gain variation, i.e. faster gain adaptation.
1692 In other words, the more you increase this value, the more the Dynamic Audio
1693 Normalizer will behave like a "traditional" normalization filter. On the
1694 contrary, the more you decrease this value, the more the Dynamic Audio
1695 Normalizer will behave like a dynamic range compressor.
1696
1697 @item p
1698 Set the target peak value. This specifies the highest permissible magnitude
1699 level for the normalized audio input. This filter will try to approach the
1700 target peak magnitude as closely as possible, but at the same time it also
1701 makes sure that the normalized signal will never exceed the peak magnitude.
1702 A frame's maximum local gain factor is imposed directly by the target peak
1703 magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
1704 It is not recommended to go above this value.
1705
1706 @item m
1707 Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
1708 The Dynamic Audio Normalizer determines the maximum possible (local) gain
1709 factor for each input frame, i.e. the maximum gain factor that does not
1710 result in clipping or distortion. The maximum gain factor is determined by
1711 the frame's highest magnitude sample. However, the Dynamic Audio Normalizer
1712 additionally bounds the frame's maximum gain factor by a predetermined
1713 (global) maximum gain factor. This is done in order to avoid excessive gain
1714 factors in "silent" or almost silent frames. By default, the maximum gain
1715 factor is 10.0, For most inputs the default value should be sufficient and
1716 it usually is not recommended to increase this value. Though, for input
1717 with an extremely low overall volume level, it may be necessary to allow even
1718 higher gain factors. Note, however, that the Dynamic Audio Normalizer does
1719 not simply apply a "hard" threshold (i.e. cut off values above the threshold).
1720 Instead, a "sigmoid" threshold function will be applied. This way, the
1721 gain factors will smoothly approach the threshold value, but never exceed that
1722 value.
1723
1724 @item r
1725 Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
1726 By default, the Dynamic Audio Normalizer performs "peak" normalization.
1727 This means that the maximum local gain factor for each frame is defined
1728 (only) by the frame's highest magnitude sample. This way, the samples can
1729 be amplified as much as possible without exceeding the maximum signal
1730 level, i.e. without clipping. Optionally, however, the Dynamic Audio
1731 Normalizer can also take into account the frame's root mean square,
1732 abbreviated RMS. In electrical engineering, the RMS is commonly used to
1733 determine the power of a time-varying signal. It is therefore considered
1734 that the RMS is a better approximation of the "perceived loudness" than
1735 just looking at the signal's peak magnitude. Consequently, by adjusting all
1736 frames to a constant RMS value, a uniform "perceived loudness" can be
1737 established. If a target RMS value has been specified, a frame's local gain
1738 factor is defined as the factor that would result in exactly that RMS value.
1739 Note, however, that the maximum local gain factor is still restricted by the
1740 frame's highest magnitude sample, in order to prevent clipping.
1741
1742 @item n
1743 Enable channels coupling. By default is enabled.
1744 By default, the Dynamic Audio Normalizer will amplify all channels by the same
1745 amount. This means the same gain factor will be applied to all channels, i.e.
1746 the maximum possible gain factor is determined by the "loudest" channel.
1747 However, in some recordings, it may happen that the volume of the different
1748 channels is uneven, e.g. one channel may be "quieter" than the other one(s).
1749 In this case, this option can be used to disable the channel coupling. This way,
1750 the gain factor will be determined independently for each channel, depending
1751 only on the individual channel's highest magnitude sample. This allows for
1752 harmonizing the volume of the different channels.
1753
1754 @item c
1755 Enable DC bias correction. By default is disabled.
1756 An audio signal (in the time domain) is a sequence of sample values.
1757 In the Dynamic Audio Normalizer these sample values are represented in the
1758 -1.0 to 1.0 range, regardless of the original input format. Normally, the
1759 audio signal, or "waveform", should be centered around the zero point.
1760 That means if we calculate the mean value of all samples in a file, or in a
1761 single frame, then the result should be 0.0 or at least very close to that
1762 value. If, however, there is a significant deviation of the mean value from
1763 0.0, in either positive or negative direction, this is referred to as a
1764 DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
1765 Audio Normalizer provides optional DC bias correction.
1766 With DC bias correction enabled, the Dynamic Audio Normalizer will determine
1767 the mean value, or "DC correction" offset, of each input frame and subtract
1768 that value from all of the frame's sample values which ensures those samples
1769 are centered around 0.0 again. Also, in order to avoid "gaps" at the frame
1770 boundaries, the DC correction offset values will be interpolated smoothly
1771 between neighbouring frames.
1772
1773 @item b
1774 Enable alternative boundary mode. By default is disabled.
1775 The Dynamic Audio Normalizer takes into account a certain neighbourhood
1776 around each frame. This includes the preceding frames as well as the
1777 subsequent frames. However, for the "boundary" frames, located at the very
1778 beginning and at the very end of the audio file, not all neighbouring
1779 frames are available. In particular, for the first few frames in the audio
1780 file, the preceding frames are not known. And, similarly, for the last few
1781 frames in the audio file, the subsequent frames are not known. Thus, the
1782 question arises which gain factors should be assumed for the missing frames
1783 in the "boundary" region. The Dynamic Audio Normalizer implements two modes
1784 to deal with this situation. The default boundary mode assumes a gain factor
1785 of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and
1786 "fade out" at the beginning and at the end of the input, respectively.
1787
1788 @item s
1789 Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
1790 By default, the Dynamic Audio Normalizer does not apply "traditional"
1791 compression. This means that signal peaks will not be pruned and thus the
1792 full dynamic range will be retained within each local neighbourhood. However,
1793 in some cases it may be desirable to combine the Dynamic Audio Normalizer's
1794 normalization algorithm with a more "traditional" compression.
1795 For this purpose, the Dynamic Audio Normalizer provides an optional compression
1796 (thresholding) function. If (and only if) the compression feature is enabled,
1797 all input frames will be processed by a soft knee thresholding function prior
1798 to the actual normalization process. Put simply, the thresholding function is
1799 going to prune all samples whose magnitude exceeds a certain threshold value.
1800 However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
1801 value. Instead, the threshold value will be adjusted for each individual
1802 frame.
1803 In general, smaller parameters result in stronger compression, and vice versa.
1804 Values below 3.0 are not recommended, because audible distortion may appear.
1805 @end table
1806
1807 @section earwax
1808
1809 Make audio easier to listen to on headphones.
1810
1811 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
1812 so that when listened to on headphones the stereo image is moved from
1813 inside your head (standard for headphones) to outside and in front of
1814 the listener (standard for speakers).
1815
1816 Ported from SoX.
1817
1818 @section equalizer
1819
1820 Apply a two-pole peaking equalisation (EQ) filter. With this
1821 filter, the signal-level at and around a selected frequency can
1822 be increased or decreased, whilst (unlike bandpass and bandreject
1823 filters) that at all other frequencies is unchanged.
1824
1825 In order to produce complex equalisation curves, this filter can
1826 be given several times, each with a different central frequency.
1827
1828 The filter accepts the following options:
1829
1830 @table @option
1831 @item frequency, f
1832 Set the filter's central frequency in Hz.
1833
1834 @item width_type
1835 Set method to specify band-width of filter.
1836 @table @option
1837 @item h
1838 Hz
1839 @item q
1840 Q-Factor
1841 @item o
1842 octave
1843 @item s
1844 slope
1845 @end table
1846
1847 @item width, w
1848 Specify the band-width of a filter in width_type units.
1849
1850 @item gain, g
1851 Set the required gain or attenuation in dB.
1852 Beware of clipping when using a positive gain.
1853 @end table
1854
1855 @subsection Examples
1856 @itemize
1857 @item
1858 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
1859 @example
1860 equalizer=f=1000:width_type=h:width=200:g=-10
1861 @end example
1862
1863 @item
1864 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
1865 @example
1866 equalizer=f=1000:width_type=q:width=1:g=2,equalizer=f=100:width_type=q:width=2:g=-5
1867 @end example
1868 @end itemize
1869
1870 @section extrastereo
1871
1872 Linearly increases the difference between left and right channels which
1873 adds some sort of "live" effect to playback.
1874
1875 The filter accepts the following option:
1876
1877 @table @option
1878 @item m
1879 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
1880 (average of both channels), with 1.0 sound will be unchanged, with
1881 -1.0 left and right channels will be swapped.
1882
1883 @item c
1884 Enable clipping. By default is enabled.
1885 @end table
1886
1887 @section flanger
1888 Apply a flanging effect to the audio.
1889
1890 The filter accepts the following options:
1891
1892 @table @option
1893 @item delay
1894 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
1895
1896 @item depth
1897 Set added swep delay in milliseconds. Range from 0 to 10. Default value is 2.
1898
1899 @item regen
1900 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
1901 Default value is 0.
1902
1903 @item width
1904 Set percentage of delayed signal mixed with original. Range from 0 to 100.
1905 Default value is 71.
1906
1907 @item speed
1908 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
1909
1910 @item shape
1911 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
1912 Default value is @var{sinusoidal}.
1913
1914 @item phase
1915 Set swept wave percentage-shift for multi channel. Range from 0 to 100.
1916 Default value is 25.
1917
1918 @item interp
1919 Set delay-line interpolation, @var{linear} or @var{quadratic}.
1920 Default is @var{linear}.
1921 @end table
1922
1923 @section highpass
1924
1925 Apply a high-pass filter with 3dB point frequency.
1926 The filter can be either single-pole, or double-pole (the default).
1927 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1928
1929 The filter accepts the following options:
1930
1931 @table @option
1932 @item frequency, f
1933 Set frequency in Hz. Default is 3000.
1934
1935 @item poles, p
1936 Set number of poles. Default is 2.
1937
1938 @item width_type
1939 Set method to specify band-width of filter.
1940 @table @option
1941 @item h
1942 Hz
1943 @item q
1944 Q-Factor
1945 @item o
1946 octave
1947 @item s
1948 slope
1949 @end table
1950
1951 @item width, w
1952 Specify the band-width of a filter in width_type units.
1953 Applies only to double-pole filter.
1954 The default is 0.707q and gives a Butterworth response.
1955 @end table
1956
1957 @section join
1958
1959 Join multiple input streams into one multi-channel stream.
1960
1961 It accepts the following parameters:
1962 @table @option
1963
1964 @item inputs
1965 The number of input streams. It defaults to 2.
1966
1967 @item channel_layout
1968 The desired output channel layout. It defaults to stereo.
1969
1970 @item map
1971 Map channels from inputs to output. The argument is a '|'-separated list of
1972 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1973 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1974 can be either the name of the input channel (e.g. FL for front left) or its
1975 index in the specified input stream. @var{out_channel} is the name of the output
1976 channel.
1977 @end table
1978
1979 The filter will attempt to guess the mappings when they are not specified
1980 explicitly. It does so by first trying to find an unused matching input channel
1981 and if that fails it picks the first unused input channel.
1982
1983 Join 3 inputs (with properly set channel layouts):
1984 @example
1985 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1986 @end example
1987
1988 Build a 5.1 output from 6 single-channel streams:
1989 @example
1990 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1991 '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'
1992 out
1993 @end example
1994
1995 @section ladspa
1996
1997 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
1998
1999 To enable compilation of this filter you need to configure FFmpeg with
2000 @code{--enable-ladspa}.
2001
2002 @table @option
2003 @item file, f
2004 Specifies the name of LADSPA plugin library to load. If the environment
2005 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
2006 each one of the directories specified by the colon separated list in
2007 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
2008 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
2009 @file{/usr/lib/ladspa/}.
2010
2011 @item plugin, p
2012 Specifies the plugin within the library. Some libraries contain only
2013 one plugin, but others contain many of them. If this is not set filter
2014 will list all available plugins within the specified library.
2015
2016 @item controls, c
2017 Set the '|' separated list of controls which are zero or more floating point
2018 values that determine the behavior of the loaded plugin (for example delay,
2019 threshold or gain).
2020 Controls need to be defined using the following syntax:
2021 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
2022 @var{valuei} is the value set on the @var{i}-th control.
2023 Alternatively they can be also defined using the following syntax:
2024 @var{value0}|@var{value1}|@var{value2}|..., where
2025 @var{valuei} is the value set on the @var{i}-th control.
2026 If @option{controls} is set to @code{help}, all available controls and
2027 their valid ranges are printed.
2028
2029 @item sample_rate, s
2030 Specify the sample rate, default to 44100. Only used if plugin have
2031 zero inputs.
2032
2033 @item nb_samples, n
2034 Set the number of samples per channel per each output frame, default
2035 is 1024. Only used if plugin have zero inputs.
2036
2037 @item duration, d
2038 Set the minimum duration of the sourced audio. See
2039 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
2040 for the accepted syntax.
2041 Note that the resulting duration may be greater than the specified duration,
2042 as the generated audio is always cut at the end of a complete frame.
2043 If not specified, or the expressed duration is negative, the audio is
2044 supposed to be generated forever.
2045 Only used if plugin have zero inputs.
2046
2047 @end table
2048
2049 @subsection Examples
2050
2051 @itemize
2052 @item
2053 List all available plugins within amp (LADSPA example plugin) library:
2054 @example
2055 ladspa=file=amp
2056 @end example
2057
2058 @item
2059 List all available controls and their valid ranges for @code{vcf_notch}
2060 plugin from @code{VCF} library:
2061 @example
2062 ladspa=f=vcf:p=vcf_notch:c=help
2063 @end example
2064
2065 @item
2066 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
2067 plugin library:
2068 @example
2069 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
2070 @end example
2071
2072 @item
2073 Add reverberation to the audio using TAP-plugins
2074 (Tom's Audio Processing plugins):
2075 @example
2076 ladspa=file=tap_reverb:tap_reverb
2077 @end example
2078
2079 @item
2080 Generate white noise, with 0.2 amplitude:
2081 @example
2082 ladspa=file=cmt:noise_source_white:c=c0=.2
2083 @end example
2084
2085 @item
2086 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
2087 @code{C* Audio Plugin Suite} (CAPS) library:
2088 @example
2089 ladspa=file=caps:Click:c=c1=20'
2090 @end example
2091
2092 @item
2093 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
2094 @example
2095 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
2096 @end example
2097
2098 @item
2099 Increase volume by 20dB using fast lookahead limiter from Steve Harris
2100 @code{SWH Plugins} collection:
2101 @example
2102 ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
2103 @end example
2104
2105 @item
2106 Attenuate low frequencies using Multiband EQ from Steve Harris
2107 @code{SWH Plugins} collection:
2108 @example
2109 ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
2110 @end example
2111 @end itemize
2112
2113 @subsection Commands
2114
2115 This filter supports the following commands:
2116 @table @option
2117 @item cN
2118 Modify the @var{N}-th control value.
2119
2120 If the specified value is not valid, it is ignored and prior one is kept.
2121 @end table
2122
2123 @section lowpass
2124
2125 Apply a low-pass filter with 3dB point frequency.
2126 The filter can be either single-pole or double-pole (the default).
2127 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
2128
2129 The filter accepts the following options:
2130
2131 @table @option
2132 @item frequency, f
2133 Set frequency in Hz. Default is 500.
2134
2135 @item poles, p
2136 Set number of poles. Default is 2.
2137
2138 @item width_type
2139 Set method to specify band-width of filter.
2140 @table @option
2141 @item h
2142 Hz
2143 @item q
2144 Q-Factor
2145 @item o
2146 octave
2147 @item s
2148 slope
2149 @end table
2150
2151 @item width, w
2152 Specify the band-width of a filter in width_type units.
2153 Applies only to double-pole filter.
2154 The default is 0.707q and gives a Butterworth response.
2155 @end table
2156
2157 @anchor{pan}
2158 @section pan
2159
2160 Mix channels with specific gain levels. The filter accepts the output
2161 channel layout followed by a set of channels definitions.
2162
2163 This filter is also designed to efficiently remap the channels of an audio
2164 stream.
2165
2166 The filter accepts parameters of the form:
2167 "@var{l}|@var{outdef}|@var{outdef}|..."
2168
2169 @table @option
2170 @item l
2171 output channel layout or number of channels
2172
2173 @item outdef
2174 output channel specification, of the form:
2175 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
2176
2177 @item out_name
2178 output channel to define, either a channel name (FL, FR, etc.) or a channel
2179 number (c0, c1, etc.)
2180
2181 @item gain
2182 multiplicative coefficient for the channel, 1 leaving the volume unchanged
2183
2184 @item in_name
2185 input channel to use, see out_name for details; it is not possible to mix
2186 named and numbered input channels
2187 @end table
2188
2189 If the `=' in a channel specification is replaced by `<', then the gains for
2190 that specification will be renormalized so that the total is 1, thus
2191 avoiding clipping noise.
2192
2193 @subsection Mixing examples
2194
2195 For example, if you want to down-mix from stereo to mono, but with a bigger
2196 factor for the left channel:
2197 @example
2198 pan=1c|c0=0.9*c0+0.1*c1
2199 @end example
2200
2201 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
2202 7-channels surround:
2203 @example
2204 pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
2205 @end example
2206
2207 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
2208 that should be preferred (see "-ac" option) unless you have very specific
2209 needs.
2210
2211 @subsection Remapping examples
2212
2213 The channel remapping will be effective if, and only if:
2214
2215 @itemize
2216 @item gain coefficients are zeroes or ones,
2217 @item only one input per channel output,
2218 @end itemize
2219
2220 If all these conditions are satisfied, the filter will notify the user ("Pure
2221 channel mapping detected"), and use an optimized and lossless method to do the
2222 remapping.
2223
2224 For example, if you have a 5.1 source and want a stereo audio stream by
2225 dropping the extra channels:
2226 @example
2227 pan="stereo| c0=FL | c1=FR"
2228 @end example
2229
2230 Given the same source, you can also switch front left and front right channels
2231 and keep the input channel layout:
2232 @example
2233 pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
2234 @end example
2235
2236 If the input is a stereo audio stream, you can mute the front left channel (and
2237 still keep the stereo channel layout) with:
2238 @example
2239 pan="stereo|c1=c1"
2240 @end example
2241
2242 Still with a stereo audio stream input, you can copy the right channel in both
2243 front left and right:
2244 @example
2245 pan="stereo| c0=FR | c1=FR"
2246 @end example
2247
2248 @section replaygain
2249
2250 ReplayGain scanner filter. This filter takes an audio stream as an input and
2251 outputs it unchanged.
2252 At end of filtering it displays @code{track_gain} and @code{track_peak}.
2253
2254 @section resample
2255
2256 Convert the audio sample format, sample rate and channel layout. It is
2257 not meant to be used directly.
2258
2259 @section rubberband
2260 Apply time-stretching and pitch-shifting with librubberband.
2261
2262 The filter accepts the following options:
2263
2264 @table @option
2265 @item tempo
2266 Set tempo scale factor.
2267
2268 @item pitch
2269 Set pitch scale factor.
2270
2271 @item transients
2272 Set transients detector.
2273 Possible values are:
2274 @table @var
2275 @item crisp
2276 @item mixed
2277 @item smooth
2278 @end table
2279
2280 @item detector
2281 Set detector.
2282 Possible values are:
2283 @table @var
2284 @item compound
2285 @item percussive
2286 @item soft
2287 @end table
2288
2289 @item phase
2290 Set phase.
2291 Possible values are:
2292 @table @var
2293 @item laminar
2294 @item independent
2295 @end table
2296
2297 @item window
2298 Set processing window size.
2299 Possible values are:
2300 @table @var
2301 @item standard
2302 @item short
2303 @item long
2304 @end table
2305
2306 @item smoothing
2307 Set smoothing.
2308 Possible values are:
2309 @table @var
2310 @item off
2311 @item on
2312 @end table
2313
2314 @item formant
2315 Enable formant preservation when shift pitching.
2316 Possible values are:
2317 @table @var
2318 @item shifted
2319 @item preserved
2320 @end table
2321
2322 @item pitchq
2323 Set pitch quality.
2324 Possible values are:
2325 @table @var
2326 @item quality
2327 @item speed
2328 @item consistency
2329 @end table
2330
2331 @item channels
2332 Set channels.
2333 Possible values are:
2334 @table @var
2335 @item apart
2336 @item together
2337 @end table
2338 @end table
2339
2340 @section sidechaincompress
2341
2342 This filter acts like normal compressor but has the ability to compress
2343 detected signal using second input signal.
2344 It needs two input streams and returns one output stream.
2345 First input stream will be processed depending on second stream signal.
2346 The filtered signal then can be filtered with other filters in later stages of
2347 processing. See @ref{pan} and @ref{amerge} filter.
2348
2349 The filter accepts the following options:
2350
2351 @table @option
2352 @item threshold
2353 If a signal of second stream raises above this level it will affect the gain
2354 reduction of first stream.
2355 By default is 0.125. Range is between 0.00097563 and 1.
2356
2357 @item ratio
2358 Set a ratio about which the signal is reduced. 1:2 means that if the level
2359 raised 4dB above the threshold, it will be only 2dB above after the reduction.
2360 Default is 2. Range is between 1 and 20.
2361
2362 @item attack
2363 Amount of milliseconds the signal has to rise above the threshold before gain
2364 reduction starts. Default is 20. Range is between 0.01 and 2000.
2365
2366 @item release
2367 Amount of milliseconds the signal has to fall below the threshold before
2368 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
2369
2370 @item makeup
2371 Set the amount by how much signal will be amplified after processing.
2372 Default is 2. Range is from 1 and 64.
2373
2374 @item knee
2375 Curve the sharp knee around the threshold to enter gain reduction more softly.
2376 Default is 2.82843. Range is between 1 and 8.
2377
2378 @item link
2379 Choose if the @code{average} level between all channels of side-chain stream
2380 or the louder(@code{maximum}) channel of side-chain stream affects the
2381 reduction. Default is @code{average}.
2382
2383 @item detection
2384 Should the exact signal be taken in case of @code{peak} or an RMS one in case
2385 of @code{rms}. Default is @code{rms} which is mainly smoother.
2386 @end table
2387
2388 @subsection Examples
2389
2390 @itemize
2391 @item
2392 Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
2393 depending on the signal of 2nd input and later compressed signal to be
2394 merged with 2nd input:
2395 @example
2396 ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
2397 @end example
2398 @end itemize
2399
2400 @section silencedetect
2401
2402 Detect silence in an audio stream.
2403
2404 This filter logs a message when it detects that the input audio volume is less
2405 or equal to a noise tolerance value for a duration greater or equal to the
2406 minimum detected noise duration.
2407
2408 The printed times and duration are expressed in seconds.
2409
2410 The filter accepts the following options:
2411
2412 @table @option
2413 @item duration, d
2414 Set silence duration until notification (default is 2 seconds).
2415
2416 @item noise, n
2417 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
2418 specified value) or amplitude ratio. Default is -60dB, or 0.001.
2419 @end table
2420
2421 @subsection Examples
2422
2423 @itemize
2424 @item
2425 Detect 5 seconds of silence with -50dB noise tolerance:
2426 @example
2427 silencedetect=n=-50dB:d=5
2428 @end example
2429
2430 @item
2431 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
2432 tolerance in @file{silence.mp3}:
2433 @example
2434 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
2435 @end example
2436 @end itemize
2437
2438 @section silenceremove
2439
2440 Remove silence from the beginning, middle or end of the audio.
2441
2442 The filter accepts the following options:
2443
2444 @table @option
2445 @item start_periods
2446 This value is used to indicate if audio should be trimmed at beginning of
2447 the audio. A value of zero indicates no silence should be trimmed from the
2448 beginning. When specifying a non-zero value, it trims audio up until it
2449 finds non-silence. Normally, when trimming silence from beginning of audio
2450 the @var{start_periods} will be @code{1} but it can be increased to higher
2451 values to trim all audio up to specific count of non-silence periods.
2452 Default value is @code{0}.
2453
2454 @item start_duration
2455 Specify the amount of time that non-silence must be detected before it stops
2456 trimming audio. By increasing the duration, bursts of noises can be treated
2457 as silence and trimmed off. Default value is @code{0}.
2458
2459 @item start_threshold
2460 This indicates what sample value should be treated as silence. For digital
2461 audio, a value of @code{0} may be fine but for audio recorded from analog,
2462 you may wish to increase the value to account for background noise.
2463 Can be specified in dB (in case "dB" is appended to the specified value)
2464 or amplitude ratio. Default value is @code{0}.
2465
2466 @item stop_periods
2467 Set the count for trimming silence from the end of audio.
2468 To remove silence from the middle of a file, specify a @var{stop_periods}
2469 that is negative. This value is then treated as a positive value and is
2470 used to indicate the effect should restart processing as specified by
2471 @var{start_periods}, making it suitable for removing periods of silence
2472 in the middle of the audio.
2473 Default value is @code{0}.
2474
2475 @item stop_duration
2476 Specify a duration of silence that must exist before audio is not copied any
2477 more. By specifying a higher duration, silence that is wanted can be left in
2478 the audio.
2479 Default value is @code{0}.
2480
2481 @item stop_threshold
2482 This is the same as @option{start_threshold} but for trimming silence from
2483 the end of audio.
2484 Can be specified in dB (in case "dB" is appended to the specified value)
2485 or amplitude ratio. Default value is @code{0}.
2486
2487 @item leave_silence
2488 This indicate that @var{stop_duration} length of audio should be left intact
2489 at the beginning of each period of silence.
2490 For example, if you want to remove long pauses between words but do not want
2491 to remove the pauses completely. Default value is @code{0}.
2492
2493 @end table
2494
2495 @subsection Examples
2496
2497 @itemize
2498 @item
2499 The following example shows how this filter can be used to start a recording
2500 that does not contain the delay at the start which usually occurs between
2501 pressing the record button and the start of the performance:
2502 @example
2503 silenceremove=1:5:0.02
2504 @end example
2505 @end itemize
2506
2507 @section stereotools
2508
2509 This filter has some handy utilities to manage stereo signals, for converting
2510 M/S stereo recordings to L/R signal while having control over the parameters
2511 or spreading the stereo image of master track.
2512
2513 The filter accepts the following options:
2514
2515 @table @option
2516 @item level_in
2517 Set input level before filtering for both channels. Defaults is 1.
2518 Allowed range is from 0.015625 to 64.
2519
2520 @item level_out
2521 Set output level after filtering for both channels. Defaults is 1.
2522 Allowed range is from 0.015625 to 64.
2523
2524 @item balance_in
2525 Set input balance between both channels. Default is 0.
2526 Allowed range is from -1 to 1.
2527
2528 @item balance_out
2529 Set output balance between both channels. Default is 0.
2530 Allowed range is from -1 to 1.
2531
2532 @item softclip
2533 Enable softclipping. Results in analog distortion instead of harsh digital 0dB
2534 clipping. Disabled by default.
2535
2536 @item mutel
2537 Mute the left channel. Disabled by default.
2538
2539 @item muter
2540 Mute the right channel. Disabled by default.
2541
2542 @item phasel
2543 Change the phase of the left channel. Disabled by default.
2544
2545 @item phaser
2546 Change the phase of the right channel. Disabled by default.
2547
2548 @item mode
2549 Set stereo mode. Available values are:
2550
2551 @table @samp
2552 @item lr>lr
2553 Left/Right to Left/Right, this is default.
2554
2555 @item lr>ms
2556 Left/Right to Mid/Side.
2557
2558 @item ms>lr
2559 Mid/Side to Left/Right.
2560
2561 @item lr>ll
2562 Left/Right to Left/Left.
2563
2564 @item lr>rr
2565 Left/Right to Right/Right.
2566
2567 @item lr>l+r
2568 Left/Right to Left + Right.
2569
2570 @item lr>rl
2571 Left/Right to Right/Left.
2572 @end table
2573
2574 @item slev
2575 Set level of side signal. Default is 1.
2576 Allowed range is from 0.015625 to 64.
2577
2578 @item sbal
2579 Set balance of side signal. Default is 0.
2580 Allowed range is from -1 to 1.
2581
2582 @item mlev
2583 Set level of the middle signal. Default is 1.
2584 Allowed range is from 0.015625 to 64.
2585
2586 @item mpan
2587 Set middle signal pan. Default is 0. Allowed range is from -1 to 1.
2588
2589 @item base
2590 Set stereo base between mono and inversed channels. Default is 0.
2591 Allowed range is from -1 to 1.
2592
2593 @item delay
2594 Set delay in milliseconds how much to delay left from right channel and
2595 vice versa. Default is 0. Allowed range is from -20 to 20.
2596
2597 @item sclevel
2598 Set S/C level. Default is 1. Allowed range is from 1 to 100.
2599
2600 @item phase
2601 Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360.
2602 @end table
2603
2604 @section stereowiden
2605
2606 This filter enhance the stereo effect by suppressing signal common to both
2607 channels and by delaying the signal of left into right and vice versa,
2608 thereby widening the stereo effect.
2609
2610 The filter accepts the following options:
2611
2612 @table @option
2613 @item delay
2614 Time in milliseconds of the delay of left signal into right and vice versa.
2615 Default is 20 milliseconds.
2616
2617 @item feedback
2618 Amount of gain in delayed signal into right and vice versa. Gives a delay
2619 effect of left signal in right output and vice versa which gives widening
2620 effect. Default is 0.3.
2621
2622 @item crossfeed
2623 Cross feed of left into right with inverted phase. This helps in suppressing
2624 the mono. If the value is 1 it will cancel all the signal common to both
2625 channels. Default is 0.3.
2626
2627 @item drymix
2628 Set level of input signal of original channel. Default is 0.8.
2629 @end table
2630
2631 @section treble
2632
2633 Boost or cut treble (upper) frequencies of the audio using a two-pole
2634 shelving filter with a response similar to that of a standard
2635 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
2636
2637 The filter accepts the following options:
2638
2639 @table @option
2640 @item gain, g
2641 Give the gain at whichever is the lower of ~22 kHz and the
2642 Nyquist frequency. Its useful range is about -20 (for a large cut)
2643 to +20 (for a large boost). Beware of clipping when using a positive gain.
2644
2645 @item frequency, f
2646 Set the filter's central frequency and so can be used
2647 to extend or reduce the frequency range to be boosted or cut.
2648 The default value is @code{3000} Hz.
2649
2650 @item width_type
2651 Set method to specify band-width of filter.
2652 @table @option
2653 @item h
2654 Hz
2655 @item q
2656 Q-Factor
2657 @item o
2658 octave
2659 @item s
2660 slope
2661 @end table
2662
2663 @item width, w
2664 Determine how steep is the filter's shelf transition.
2665 @end table
2666
2667 @section tremolo
2668
2669 Sinusoidal amplitude modulation.
2670
2671 The filter accepts the following options:
2672
2673 @table @option
2674 @item f
2675 Modulation frequency in Hertz. Modulation frequencies in the subharmonic range
2676 (20 Hz or lower) will result in a tremolo effect.
2677 This filter may also be used as a ring modulator by specifying
2678 a modulation frequency higher than 20 Hz.
2679 Range is 0.1 - 20000.0. Default value is 5.0 Hz.
2680
2681 @item d
2682 Depth of modulation as a percentage. Range is 0.0 - 1.0.
2683 Default value is 0.5.
2684 @end table
2685
2686 @section vibrato
2687
2688 Sinusoidal phase modulation.
2689
2690 The filter accepts the following options:
2691
2692 @table @option
2693 @item f
2694 Modulation frequency in Hertz.
2695 Range is 0.1 - 20000.0. Default value is 5.0 Hz.
2696
2697 @item d
2698 Depth of modulation as a percentage. Range is 0.0 - 1.0.
2699 Default value is 0.5.
2700 @end table
2701
2702 @section volume
2703
2704 Adjust the input audio volume.
2705
2706 It accepts the following parameters:
2707 @table @option
2708
2709 @item volume
2710 Set audio volume expression.
2711
2712 Output values are clipped to the maximum value.
2713
2714 The output audio volume is given by the relation:
2715 @example
2716 @var{output_volume} = @var{volume} * @var{input_volume}
2717 @end example
2718
2719 The default value for @var{volume} is "1.0".
2720
2721 @item precision
2722 This parameter represents the mathematical precision.
2723
2724 It determines which input sample formats will be allowed, which affects the
2725 precision of the volume scaling.
2726
2727 @table @option
2728 @item fixed
2729 8-bit fixed-point; this limits input sample format to U8, S16, and S32.
2730 @item float
2731 32-bit floating-point; this limits input sample format to FLT. (default)
2732 @item double
2733 64-bit floating-point; this limits input sample format to DBL.
2734 @end table
2735
2736 @item replaygain
2737 Choose the behaviour on encountering ReplayGain side data in input frames.
2738
2739 @table @option
2740 @item drop
2741 Remove ReplayGain side data, ignoring its contents (the default).
2742
2743 @item ignore
2744 Ignore ReplayGain side data, but leave it in the frame.
2745
2746 @item track
2747 Prefer the track gain, if present.
2748
2749 @item album
2750 Prefer the album gain, if present.
2751 @end table
2752
2753 @item replaygain_preamp
2754 Pre-amplification gain in dB to apply to the selected replaygain gain.
2755
2756 Default value for @var{replaygain_preamp} is 0.0.
2757
2758 @item eval
2759 Set when the volume expression is evaluated.
2760
2761 It accepts the following values:
2762 @table @samp
2763 @item once
2764 only evaluate expression once during the filter initialization, or
2765 when the @samp{volume} command is sent
2766
2767 @item frame
2768 evaluate expression for each incoming frame
2769 @end table
2770
2771 Default value is @samp{once}.
2772 @end table
2773
2774 The volume expression can contain the following parameters.
2775
2776 @table @option
2777 @item n
2778 frame number (starting at zero)
2779 @item nb_channels
2780 number of channels
2781 @item nb_consumed_samples
2782 number of samples consumed by the filter
2783 @item nb_samples
2784 number of samples in the current frame
2785 @item pos
2786 original frame position in the file
2787 @item pts
2788 frame PTS
2789 @item sample_rate
2790 sample rate
2791 @item startpts
2792 PTS at start of stream
2793 @item startt
2794 time at start of stream
2795 @item t
2796 frame time
2797 @item tb
2798 timestamp timebase
2799 @item volume
2800 last set volume value
2801 @end table
2802
2803 Note that when @option{eval} is set to @samp{once} only the
2804 @var{sample_rate} and @var{tb} variables are available, all other
2805 variables will evaluate to NAN.
2806
2807 @subsection Commands
2808
2809 This filter supports the following commands:
2810 @table @option
2811 @item volume
2812 Modify the volume expression.
2813 The command accepts the same syntax of the corresponding option.
2814
2815 If the specified expression is not valid, it is kept at its current
2816 value.
2817 @item replaygain_noclip
2818 Prevent clipping by limiting the gain applied.
2819
2820 Default value for @var{replaygain_noclip} is 1.
2821
2822 @end table
2823
2824 @subsection Examples
2825
2826 @itemize
2827 @item
2828 Halve the input audio volume:
2829 @example
2830 volume=volume=0.5
2831 volume=volume=1/2
2832 volume=volume=-6.0206dB
2833 @end example
2834
2835 In all the above example the named key for @option{volume} can be
2836 omitted, for example like in:
2837 @example
2838 volume=0.5
2839 @end example
2840
2841 @item
2842 Increase input audio power by 6 decibels using fixed-point precision:
2843 @example
2844 volume=volume=6dB:precision=fixed
2845 @end example
2846
2847 @item
2848 Fade volume after time 10 with an annihilation period of 5 seconds:
2849 @example
2850 volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
2851 @end example
2852 @end itemize
2853
2854 @section volumedetect
2855
2856 Detect the volume of the input video.
2857
2858 The filter has no parameters. The input is not modified. Statistics about
2859 the volume will be printed in the log when the input stream end is reached.
2860
2861 In particular it will show the mean volume (root mean square), maximum
2862 volume (on a per-sample basis), and the beginning of a histogram of the
2863 registered volume values (from the maximum value to a cumulated 1/1000 of
2864 the samples).
2865
2866 All volumes are in decibels relative to the maximum PCM value.
2867
2868 @subsection Examples
2869
2870 Here is an excerpt of the output:
2871 @example
2872 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
2873 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
2874 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
2875 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
2876 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
2877 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
2878 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
2879 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
2880 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
2881 @end example
2882
2883 It means that:
2884 @itemize
2885 @item
2886 The mean square energy is approximately -27 dB, or 10^-2.7.
2887 @item
2888 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
2889 @item
2890 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
2891 @end itemize
2892
2893 In other words, raising the volume by +4 dB does not cause any clipping,
2894 raising it by +5 dB causes clipping for 6 samples, etc.
2895
2896 @c man end AUDIO FILTERS
2897
2898 @chapter Audio Sources
2899 @c man begin AUDIO SOURCES
2900
2901 Below is a description of the currently available audio sources.
2902
2903 @section abuffer
2904
2905 Buffer audio frames, and make them available to the filter chain.
2906
2907 This source is mainly intended for a programmatic use, in particular
2908 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
2909
2910 It accepts the following parameters:
2911 @table @option
2912
2913 @item time_base
2914 The timebase which will be used for timestamps of submitted frames. It must be
2915 either a floating-point number or in @var{numerator}/@var{denominator} form.
2916
2917 @item sample_rate
2918 The sample rate of the incoming audio buffers.
2919
2920 @item sample_fmt
2921 The sample format of the incoming audio buffers.
2922 Either a sample format name or its corresponding integer representation from
2923 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
2924
2925 @item channel_layout
2926 The channel layout of the incoming audio buffers.
2927 Either a channel layout name from channel_layout_map in
2928 @file{libavutil/channel_layout.c} or its corresponding integer representation
2929 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
2930
2931 @item channels
2932 The number of channels of the incoming audio buffers.
2933 If both @var{channels} and @var{channel_layout} are specified, then they
2934 must be consistent.
2935
2936 @end table
2937
2938 @subsection Examples
2939
2940 @example
2941 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
2942 @end example
2943
2944 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
2945 Since the sample format with name "s16p" corresponds to the number
2946 6 and the "stereo" channel layout corresponds to the value 0x3, this is
2947 equivalent to:
2948 @example
2949 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
2950 @end example
2951
2952 @section aevalsrc
2953
2954 Generate an audio signal specified by an expression.
2955
2956 This source accepts in input one or more expressions (one for each
2957 channel), which are evaluated and used to generate a corresponding
2958 audio signal.
2959
2960 This source accepts the following options:
2961
2962 @table @option
2963 @item exprs
2964 Set the '|'-separated expressions list for each separate channel. In case the
2965 @option{channel_layout} option is not specified, the selected channel layout
2966 depends on the number of provided expressions. Otherwise the last
2967 specified expression is applied to the remaining output channels.
2968
2969 @item channel_layout, c
2970 Set the channel layout. The number of channels in the specified layout
2971 must be equal to the number of specified expressions.
2972
2973 @item duration, d
2974 Set the minimum duration of the sourced audio. See
2975 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
2976 for the accepted syntax.
2977 Note that the resulting duration may be greater than the specified
2978 duration, as the generated audio is always cut at the end of a
2979 complete frame.
2980
2981 If not specified, or the expressed duration is negative, the audio is
2982 supposed to be generated forever.
2983
2984 @item nb_samples, n
2985 Set the number of samples per channel per each output frame,
2986 default to 1024.
2987
2988 @item sample_rate, s
2989 Specify the sample rate, default to 44100.
2990 @end table
2991
2992 Each expression in @var{exprs} can contain the following constants:
2993
2994 @table @option
2995 @item n
2996 number of the evaluated sample, starting from 0
2997
2998 @item t
2999 time of the evaluated sample expressed in seconds, starting from 0
3000
3001 @item s
3002 sample rate
3003
3004 @end table
3005
3006 @subsection Examples
3007
3008 @itemize
3009 @item
3010 Generate silence:
3011 @example
3012 aevalsrc=0
3013 @end example
3014
3015 @item
3016 Generate a sin signal with frequency of 440 Hz, set sample rate to
3017 8000 Hz:
3018 @example
3019 aevalsrc="sin(440*2*PI*t):s=8000"
3020 @end example
3021
3022 @item
3023 Generate a two channels signal, specify the channel layout (Front
3024 Center + Back Center) explicitly:
3025 @example
3026 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
3027 @end example
3028
3029 @item
3030 Generate white noise:
3031 @example
3032 aevalsrc="-2+random(0)"
3033 @end example
3034
3035 @item
3036 Generate an amplitude modulated signal:
3037 @example
3038 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
3039 @end example
3040
3041 @item
3042 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
3043 @example
3044 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
3045 @end example
3046
3047 @end itemize
3048
3049 @section anullsrc
3050
3051 The null audio source, return unprocessed audio frames. It is mainly useful
3052 as a template and to be employed in analysis / debugging tools, or as
3053 the source for filters which ignore the input data (for example the sox
3054 synth filter).
3055
3056 This source accepts the following options:
3057
3058 @table @option
3059
3060 @item channel_layout, cl
3061
3062 Specifies the channel layout, and can be either an integer or a string
3063 representing a channel layout. The default value of @var{channel_layout}
3064 is "stereo".
3065
3066 Check the channel_layout_map definition in
3067 @file{libavutil/channel_layout.c} for the mapping between strings and
3068 channel layout values.
3069
3070 @item sample_rate, r
3071 Specifies the sample rate, and defaults to 44100.
3072
3073 @item nb_samples, n
3074 Set the number of samples per requested frames.
3075
3076 @end table
3077
3078 @subsection Examples
3079
3080 @itemize
3081 @item
3082 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
3083 @example
3084 anullsrc=r=48000:cl=4
3085 @end example
3086
3087 @item
3088 Do the same operation with a more obvious syntax:
3089 @example
3090 anullsrc=r=48000:cl=mono
3091 @end example
3092 @end itemize
3093
3094 All the parameters need to be explicitly defined.
3095
3096 @section flite
3097
3098 Synthesize a voice utterance using the libflite library.
3099
3100 To enable compilation of this filter you need to configure FFmpeg with
3101 @code{--enable-libflite}.
3102
3103 Note that the flite library is not thread-safe.
3104
3105 The filter accepts the following options:
3106
3107 @table @option
3108
3109 @item list_voices
3110 If set to 1, list the names of the available voices and exit
3111 immediately. Default value is 0.
3112
3113 @item nb_samples, n
3114 Set the maximum number of samples per frame. Default value is 512.
3115
3116 @item textfile
3117 Set the filename containing the text to speak.
3118
3119 @item text
3120 Set the text to speak.
3121
3122 @item voice, v
3123 Set the voice to use for the speech synthesis. Default value is
3124 @code{kal}. See also the @var{list_voices} option.
3125 @end table
3126
3127 @subsection Examples
3128
3129 @itemize
3130 @item
3131 Read from file @file{speech.txt}, and synthesize the text using the
3132 standard flite voice:
3133 @example
3134 flite=textfile=speech.txt
3135 @end example
3136
3137 @item
3138 Read the specified text selecting the @code{slt} voice:
3139 @example
3140 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
3141 @end example
3142
3143 @item
3144 Input text to ffmpeg:
3145 @example
3146 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
3147 @end example
3148
3149 @item
3150 Make @file{ffplay} speak the specified text, using @code{flite} and
3151 the @code{lavfi} device:
3152 @example
3153 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
3154 @end example
3155 @end itemize
3156
3157 For more information about libflite, check:
3158 @url{http://www.speech.cs.cmu.edu/flite/}
3159
3160 @section anoisesrc
3161
3162 Generate a noise audio signal.
3163
3164 The filter accepts the following options:
3165
3166 @table @option
3167 @item sample_rate, r
3168 Specify the sample rate. Default value is 48000 Hz.
3169
3170 @item amplitude, a
3171 Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value
3172 is 1.0.
3173
3174 @item duration, d
3175 Specify the duration of the generated audio stream. Not specifying this option
3176 results in noise with an infinite length.
3177
3178 @item color, colour, c
3179 Specify the color of noise. Available noise colors are white, pink, and brown.
3180 Default color is white.
3181
3182 @item seed, s
3183 Specify a value used to seed the PRNG.
3184
3185 @item nb_samples, n
3186 Set the number of samples per each output frame, default is 1024.
3187 @end table
3188
3189 @subsection Examples
3190
3191 @itemize
3192
3193 @item
3194 Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5:
3195 @example
3196 anoisesrc=d=60:c=pink:r=44100:a=0.5
3197 @end example
3198 @end itemize
3199
3200 @section sine
3201
3202 Generate an audio signal made of a sine wave with amplitude 1/8.
3203
3204 The audio signal is bit-exact.
3205
3206 The filter accepts the following options:
3207
3208 @table @option
3209
3210 @item frequency, f
3211 Set the carrier frequency. Default is 440 Hz.
3212
3213 @item beep_factor, b
3214 Enable a periodic beep every second with frequency @var{beep_factor} times
3215 the carrier frequency. Default is 0, meaning the beep is disabled.
3216
3217 @item sample_rate, r
3218 Specify the sample rate, default is 44100.
3219
3220 @item duration, d
3221 Specify the duration of the generated audio stream.
3222
3223 @item samples_per_frame
3224 Set the number of samples per output frame.
3225
3226 The expression can contain the following constants:
3227
3228 @table @option
3229 @item n
3230 The (sequential) number of the output audio frame, starting from 0.
3231
3232 @item pts
3233 The PTS (Presentation TimeStamp) of the output audio frame,
3234 expressed in @var{TB} units.
3235
3236 @item t
3237 The PTS of the output audio frame, expressed in seconds.
3238
3239 @item TB
3240 The timebase of the output audio frames.
3241 @end table
3242
3243 Default is @code{1024}.
3244 @end table
3245
3246 @subsection Examples
3247
3248 @itemize
3249
3250 @item
3251 Generate a simple 440 Hz sine wave:
3252 @example
3253 sine
3254 @end example
3255
3256 @item
3257 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
3258 @example
3259 sine=220:4:d=5
3260 sine=f=220:b=4:d=5
3261 sine=frequency=220:beep_factor=4:duration=5
3262 @end example
3263
3264 @item
3265 Generate a 1 kHz sine wave following @code{1602,1601,1602,1601,1602} NTSC
3266 pattern:
3267 @example
3268 sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
3269 @end example
3270 @end itemize
3271
3272 @c man end AUDIO SOURCES
3273
3274 @chapter Audio Sinks
3275 @c man begin AUDIO SINKS
3276
3277 Below is a description of the currently available audio sinks.
3278
3279 @section abuffersink
3280
3281 Buffer audio frames, and make them available to the end of filter chain.
3282
3283 This sink is mainly intended for programmatic use, in particular
3284 through the interface defined in @file{libavfilter/buffersink.h}
3285 or the options system.
3286
3287 It accepts a pointer to an AVABufferSinkContext structure, which
3288 defines the incoming buffers' formats, to be passed as the opaque
3289 parameter to @code{avfilter_init_filter} for initialization.
3290 @section anullsink
3291
3292 Null audio sink; do absolutely nothing with the input audio. It is
3293 mainly useful as a template and for use in analysis / debugging
3294 tools.
3295
3296 @c man end AUDIO SINKS
3297
3298 @chapter Video Filters
3299 @c man begin VIDEO FILTERS
3300
3301 When you configure your FFmpeg build, you can disable any of the
3302 existing filters using @code{--disable-filters}.
3303 The configure output will show the video filters included in your
3304 build.
3305
3306 Below is a description of the currently available video filters.
3307
3308 @section alphaextract
3309
3310 Extract the alpha component from the input as a grayscale video. This
3311 is especially useful with the @var{alphamerge} filter.
3312
3313 @section alphamerge
3314
3315 Add or replace the alpha component of the primary input with the
3316 grayscale value of a second input. This is intended for use with
3317 @var{alphaextract} to allow the transmission or storage of frame
3318 sequences that have alpha in a format that doesn't support an alpha
3319 channel.
3320
3321 For example, to reconstruct full frames from a normal YUV-encoded video
3322 and a separate video created with @var{alphaextract}, you might use:
3323 @example
3324 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
3325 @end example
3326
3327 Since this filter is designed for reconstruction, it operates on frame
3328 sequences without considering timestamps, and terminates when either
3329 input reaches end of stream. This will cause problems if your encoding
3330 pipeline drops frames. If you're trying to apply an image as an
3331 overlay to a video stream, consider the @var{overlay} filter instead.
3332
3333 @section ass
3334
3335 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
3336 and libavformat to work. On the other hand, it is limited to ASS (Advanced
3337 Substation Alpha) subtitles files.
3338
3339 This filter accepts the following option in addition to the common options from
3340 the @ref{subtitles} filter:
3341
3342 @table @option
3343 @item shaping
3344 Set the shaping engine
3345
3346 Available values are:
3347 @table @samp
3348 @item auto
3349 The default libass shaping engine, which is the best available.
3350 @item simple
3351 Fast, font-agnostic shaper that can do only substitutions
3352 @item complex
3353 Slower shaper using OpenType for substitutions and positioning
3354 @end table
3355
3356 The default is @code{auto}.
3357 @end table
3358
3359 @section atadenoise
3360 Apply an Adaptive Temporal Averaging Denoiser to the video input.
3361
3362 The filter accepts the following options:
3363
3364 @table @option
3365 @item 0a
3366 Set threshold A for 1st plane. Default is 0.02.
3367 Valid range is 0 to 0.3.
3368
3369 @item 0b
3370 Set threshold B for 1st plane. Default is 0.04.
3371 Valid range is 0 to 5.
3372
3373 @item 1a
3374 Set threshold A for 2nd plane. Default is 0.02.
3375 Valid range is 0 to 0.3.
3376
3377 @item 1b
3378 Set threshold B for 2nd plane. Default is 0.04.
3379 Valid range is 0 to 5.
3380
3381 @item 2a
3382 Set threshold A for 3rd plane. Default is 0.02.
3383 Valid range is 0 to 0.3.
3384
3385 @item 2b
3386 Set threshold B for 3rd plane. Default is 0.04.
3387 Valid range is 0 to 5.
3388
3389 Threshold A is designed to react on abrupt changes in the input signal and
3390 threshold B is designed to react on continuous changes in the input signal.
3391
3392 @item s
3393 Set number of frames filter will use for averaging. Default is 33. Must be odd
3394 number in range [5, 129].
3395 @end table
3396
3397 @section bbox
3398
3399 Compute the bounding box for the non-black pixels in the input frame
3400 luminance plane.
3401
3402 This filter computes the bounding box containing all the pixels with a
3403 luminance value greater than the minimum allowed value.
3404 The parameters describing the bounding box are printed on the filter
3405 log.
3406
3407 The filter accepts the following option:
3408
3409 @table @option
3410 @item min_val
3411 Set the minimal luminance value. Default is @code{16}.
3412 @end table
3413
3414 @section blackdetect
3415
3416 Detect video intervals that are (almost) completely black. Can be
3417 useful to detect chapter transitions, commercials, or invalid
3418 recordings. Output lines contains the time for the start, end and
3419 duration of the detected black interval expressed in seconds.
3420
3421 In order to display the output lines, you need to set the loglevel at
3422 least to the AV_LOG_INFO value.
3423
3424 The filter accepts the following options:
3425
3426 @table @option
3427 @item black_min_duration, d
3428 Set the minimum detected black duration expressed in seconds. It must
3429 be a non-negative floating point number.
3430
3431 Default value is 2.0.
3432
3433 @item picture_black_ratio_th, pic_th
3434 Set the threshold for considering a picture "black".
3435 Express the minimum value for the ratio:
3436 @example
3437 @var{nb_black_pixels} / @var{nb_pixels}
3438 @end example
3439
3440 for which a picture is considered black.
3441 Default value is 0.98.
3442
3443 @item pixel_black_th, pix_th
3444 Set the threshold for considering a pixel "black".
3445
3446 The threshold expresses the maximum pixel luminance value for which a
3447 pixel is considered "black". The provided value is scaled according to
3448 the following equation:
3449 @example
3450 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
3451 @end example
3452
3453 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
3454 the input video format, the range is [0-255] for YUV full-range
3455 formats and [16-235] for YUV non full-range formats.
3456
3457 Default value is 0.10.
3458 @end table
3459
3460 The following example sets the maximum pixel threshold to the minimum
3461 value, and detects only black intervals of 2 or more seconds:
3462 @example
3463 blackdetect=d=2:pix_th=0.00
3464 @end example
3465
3466 @section blackframe
3467
3468 Detect frames that are (almost) completely black. Can be useful to
3469 detect chapter transitions or commercials. Output lines consist of
3470 the frame number of the detected frame, the percentage of blackness,
3471 the position in the file if known or -1 and the timestamp in seconds.
3472
3473 In order to display the output lines, you need to set the loglevel at
3474 least to the AV_LOG_INFO value.
3475
3476 It accepts the following parameters:
3477
3478 @table @option
3479
3480 @item amount
3481 The percentage of the pixels that have to be below the threshold; it defaults to
3482 @code{98}.
3483
3484 @item threshold, thresh
3485 The threshold below which a pixel value is considered black; it defaults to
3486 @code{32}.
3487
3488 @end table
3489
3490 @section blend, tblend
3491
3492 Blend two video frames into each other.
3493
3494 The @code{blend} filter takes two input streams and outputs one
3495 stream, the first input is the "top" layer and second input is
3496 "bottom" layer.  Output terminates when shortest input terminates.
3497
3498 The @code{tblend} (time blend) filter takes two consecutive frames
3499 from one single stream, and outputs the result obtained by blending
3500 the new frame on top of the old frame.
3501
3502 A description of the accepted options follows.
3503
3504 @table @option
3505 @item c0_mode
3506 @item c1_mode
3507 @item c2_mode
3508 @item c3_mode
3509 @item all_mode
3510 Set blend mode for specific pixel component or all pixel components in case
3511 of @var{all_mode}. Default value is @code{normal}.
3512
3513 Available values for component modes are:
3514 @table @samp
3515 @item addition
3516 @item addition128
3517 @item and
3518 @item average
3519 @item burn
3520 @item darken
3521 @item difference
3522 @item difference128
3523 @item divide
3524 @item dodge
3525 @item exclusion
3526 @item glow
3527 @item hardlight
3528 @item hardmix
3529 @item lighten
3530 @item linearlight
3531 @item multiply
3532 @item negation
3533 @item normal
3534 @item or
3535 @item overlay
3536 @item phoenix
3537 @item pinlight
3538 @item reflect
3539 @item screen
3540 @item softlight
3541 @item subtract
3542 @item vividlight
3543 @item xor
3544 @end table
3545
3546 @item c0_opacity
3547 @item c1_opacity
3548 @item c2_opacity
3549 @item c3_opacity
3550 @item all_opacity
3551 Set blend opacity for specific pixel component or all pixel components in case
3552 of @var{all_opacity}. Only used in combination with pixel component blend modes.
3553
3554 @item c0_expr
3555 @item c1_expr
3556 @item c2_expr
3557 @item c3_expr
3558 @item all_expr
3559 Set blend expression for specific pixel component or all pixel components in case
3560 of @var{all_expr}. Note that related mode options will be ignored if those are set.
3561
3562 The expressions can use the following variables:
3563
3564 @table @option
3565 @item N
3566 The sequential number of the filtered frame, starting from @code{0}.
3567
3568 @item X
3569 @item Y
3570 the coordinates of the current sample
3571
3572 @item W
3573 @item H
3574 the width and height of currently filtered plane
3575
3576 @item SW
3577 @item SH
3578 Width and height scale depending on the currently filtered plane. It is the
3579 ratio between the corresponding luma plane number of pixels and the current
3580 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
3581 @code{0.5,0.5} for chroma planes.
3582
3583 @item T
3584 Time of the current frame, expressed in seconds.
3585
3586 @item TOP, A
3587 Value of pixel component at current location for first video frame (top layer).
3588
3589 @item BOTTOM, B
3590 Value of pixel component at current location for second video frame (bottom layer).
3591 @end table
3592
3593 @item shortest
3594 Force termination when the shortest input terminates. Default is
3595 @code{0}. This option is only defined for the @code{blend} filter.
3596
3597 @item repeatlast
3598 Continue applying the last bottom frame after the end of the stream. A value of
3599 @code{0} disable the filter after the last frame of the bottom layer is reached.
3600 Default is @code{1}. This option is only defined for the @code{blend} filter.
3601 @end table
3602
3603 @subsection Examples
3604
3605 @itemize
3606 @item
3607 Apply transition from bottom layer to top layer in first 10 seconds:
3608 @example
3609 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
3610 @end example
3611
3612 @item
3613 Apply 1x1 checkerboard effect:
3614 @example
3615 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
3616 @end example
3617
3618 @item
3619 Apply uncover left effect:
3620 @example
3621 blend=all_expr='if(gte(N*SW+X,W),A,B)'
3622 @end example
3623
3624 @item
3625 Apply uncover down effect:
3626 @example
3627 blend=all_expr='if(gte(Y-N*SH,0),A,B)'
3628 @end example
3629
3630 @item
3631 Apply uncover up-left effect:
3632 @example
3633 blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
3634 @end example
3635
3636 @item
3637 Display differences between the current and the previous frame:
3638 @example
3639 tblend=all_mode=difference128
3640 @end example
3641 @end itemize
3642
3643 @section boxblur
3644
3645 Apply a boxblur algorithm to the input video.
3646
3647 It accepts the following parameters:
3648
3649 @table @option
3650
3651 @item luma_radius, lr
3652 @item luma_power, lp
3653 @item chroma_radius, cr
3654 @item chroma_power, cp
3655 @item alpha_radius, ar
3656 @item alpha_power, ap
3657
3658 @end table
3659
3660 A description of the accepted options follows.
3661
3662 @table @option
3663 @item luma_radius, lr
3664 @item chroma_radius, cr
3665 @item alpha_radius, ar
3666 Set an expression for the box radius in pixels used for blurring the
3667 corresponding input plane.
3668
3669 The radius value must be a non-negative number, and must not be
3670 greater than the value of the expression @code{min(w,h)/2} for the
3671 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
3672 planes.
3673
3674 Default value for @option{luma_radius} is "2". If not specified,
3675 @option{chroma_radius} and @option{alpha_radius} default to the
3676 corresponding value set for @option{luma_radius}.
3677
3678 The expressions can contain the following constants:
3679 @table @option
3680 @item w
3681 @item h
3682 The input width and height in pixels.
3683
3684 @item cw
3685 @item ch
3686 The input chroma image width and height in pixels.
3687
3688 @item hsub
3689 @item vsub
3690 The horizontal and vertical chroma subsample values. For example, for the
3691 pixel format "yuv422p", @var{hsub} is 2 and @var{vsub} is 1.
3692 @end table
3693
3694 @item luma_power, lp
3695 @item chroma_power, cp
3696 @item alpha_power, ap
3697 Specify how many times the boxblur filter is applied to the
3698 corresponding plane.
3699
3700 Default value for @option{luma_power} is 2. If not specified,
3701 @option{chroma_power} and @option{alpha_power} default to the
3702 corresponding value set for @option{luma_power}.
3703
3704 A value of 0 will disable the effect.
3705 @end table
3706
3707 @subsection Examples
3708
3709 @itemize
3710 @item
3711 Apply a boxblur filter with the luma, chroma, and alpha radii
3712 set to 2:
3713 @example
3714 boxblur=luma_radius=2:luma_power=1
3715 boxblur=2:1
3716 @end example
3717
3718 @item
3719 Set the luma radius to 2, and alpha and chroma radius to 0:
3720 @example
3721 boxblur=2:1:cr=0:ar=0
3722 @end example
3723
3724 @item
3725 Set the luma and chroma radii to a fraction of the video dimension:
3726 @example
3727 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
3728 @end example
3729 @end itemize
3730
3731 @section chromakey
3732 YUV colorspace color/chroma keying.
3733
3734 The filter accepts the following options:
3735
3736 @table @option
3737 @item color
3738 The color which will be replaced with transparency.
3739
3740 @item similarity
3741 Similarity percentage with the key color.
3742
3743 0.01 matches only the exact key color, while 1.0 matches everything.
3744
3745 @item blend
3746 Blend percentage.
3747
3748 0.0 makes pixels either fully transparent, or not transparent at all.
3749
3750 Higher values result in semi-transparent pixels, with a higher transparency
3751 the more similar the pixels color is to the key color.
3752
3753 @item yuv
3754 Signals that the color passed is already in YUV instead of RGB.
3755
3756 Litteral colors like "green" or "red" don't make sense with this enabled anymore.
3757 This can be used to pass exact YUV values as hexadecimal numbers.
3758 @end table
3759
3760 @subsection Examples
3761
3762 @itemize
3763 @item
3764 Make every green pixel in the input image transparent:
3765 @example
3766 ffmpeg -i input.png -vf chromakey=green out.png
3767 @end example
3768
3769 @item
3770 Overlay a greenscreen-video on top of a static black background.
3771 @example
3772 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
3773 @end example
3774 @end itemize
3775
3776 @section codecview
3777
3778 Visualize information exported by some codecs.
3779
3780 Some codecs can export information through frames using side-data or other
3781 means. For example, some MPEG based codecs export motion vectors through the
3782 @var{export_mvs} flag in the codec @option{flags2} option.
3783
3784 The filter accepts the following option:
3785
3786 @table @option
3787 @item mv
3788 Set motion vectors to visualize.
3789
3790 Available flags for @var{mv} are:
3791
3792 @table @samp
3793 @item pf
3794 forward predicted MVs of P-frames
3795 @item bf
3796 forward predicted MVs of B-frames
3797 @item bb
3798 backward predicted MVs of B-frames
3799 @end table
3800 @end table
3801
3802 @subsection Examples
3803
3804 @itemize
3805 @item
3806 Visualizes multi-directionals MVs from P and B-Frames using @command{ffplay}:
3807 @example
3808 ffplay -flags2 +export_mvs input.mpg -vf codecview=mv=pf+bf+bb
3809 @end example
3810 @end itemize
3811
3812 @section colorbalance
3813 Modify intensity of primary colors (red, green and blue) of input frames.
3814
3815 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
3816 regions for the red-cyan, green-magenta or blue-yellow balance.
3817
3818 A positive adjustment value shifts the balance towards the primary color, a negative
3819 value towards the complementary color.
3820
3821 The filter accepts the following options:
3822
3823 @table @option
3824 @item rs
3825 @item gs
3826 @item bs
3827 Adjust red, green and blue shadows (darkest pixels).
3828
3829 @item rm
3830 @item gm
3831 @item bm
3832 Adjust red, green and blue midtones (medium pixels).
3833
3834 @item rh
3835 @item gh
3836 @item bh
3837 Adjust red, green and blue highlights (brightest pixels).
3838
3839 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3840 @end table
3841
3842 @subsection Examples
3843
3844 @itemize
3845 @item
3846 Add red color cast to shadows:
3847 @example
3848 colorbalance=rs=.3
3849 @end example
3850 @end itemize
3851
3852 @section colorkey
3853 RGB colorspace color keying.
3854
3855 The filter accepts the following options:
3856
3857 @table @option
3858 @item color
3859 The color which will be replaced with transparency.
3860
3861 @item similarity
3862 Similarity percentage with the key color.
3863
3864 0.01 matches only the exact key color, while 1.0 matches everything.
3865
3866 @item blend
3867 Blend percentage.
3868
3869 0.0 makes pixels either fully transparent, or not transparent at all.
3870
3871 Higher values result in semi-transparent pixels, with a higher transparency
3872 the more similar the pixels color is to the key color.
3873 @end table
3874
3875 @subsection Examples
3876
3877 @itemize
3878 @item
3879 Make every green pixel in the input image transparent:
3880 @example
3881 ffmpeg -i input.png -vf colorkey=green out.png
3882 @end example
3883
3884 @item
3885 Overlay a greenscreen-video on top of a static background image.
3886 @example
3887 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
3888 @end example
3889 @end itemize
3890
3891 @section colorlevels
3892
3893 Adjust video input frames using levels.
3894
3895 The filter accepts the following options:
3896
3897 @table @option
3898 @item rimin
3899 @item gimin
3900 @item bimin
3901 @item aimin
3902 Adjust red, green, blue and alpha input black point.
3903 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3904
3905 @item rimax
3906 @item gimax
3907 @item bimax
3908 @item aimax
3909 Adjust red, green, blue and alpha input white point.
3910 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{1}.
3911
3912 Input levels are used to lighten highlights (bright tones), darken shadows
3913 (dark tones), change the balance of bright and dark tones.
3914
3915 @item romin
3916 @item gomin
3917 @item bomin
3918 @item aomin
3919 Adjust red, green, blue and alpha output black point.
3920 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{0}.
3921
3922 @item romax
3923 @item gomax
3924 @item bomax
3925 @item aomax
3926 Adjust red, green, blue and alpha output white point.
3927 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{1}.
3928
3929 Output levels allows manual selection of a constrained output level range.
3930 @end table
3931
3932 @subsection Examples
3933
3934 @itemize
3935 @item
3936 Make video output darker:
3937 @example
3938 colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
3939 @end example
3940
3941 @item
3942 Increase contrast:
3943 @example
3944 colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
3945 @end example
3946
3947 @item
3948 Make video output lighter:
3949 @example
3950 colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
3951 @end example
3952
3953 @item
3954 Increase brightness:
3955 @example
3956 colorlevels=romin=0.5:gomin=0.5:bomin=0.5
3957 @end example
3958 @end itemize
3959
3960 @section colorchannelmixer
3961
3962 Adjust video input frames by re-mixing color channels.
3963
3964 This filter modifies a color channel by adding the values associated to
3965 the other channels of the same pixels. For example if the value to
3966 modify is red, the output value will be:
3967 @example
3968 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
3969 @end example
3970
3971 The filter accepts the following options:
3972
3973 @table @option
3974 @item rr
3975 @item rg
3976 @item rb
3977 @item ra
3978 Adjust contribution of input red, green, blue and alpha channels for output red channel.
3979 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
3980
3981 @item gr
3982 @item gg
3983 @item gb
3984 @item ga
3985 Adjust contribution of input red, green, blue and alpha channels for output green channel.
3986 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
3987
3988 @item br
3989 @item bg
3990 @item bb
3991 @item ba
3992 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
3993 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
3994
3995 @item ar
3996 @item ag
3997 @item ab
3998 @item aa
3999 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
4000 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
4001
4002 Allowed ranges for options are @code{[-2.0, 2.0]}.
4003 @end table
4004
4005 @subsection Examples
4006
4007 @itemize
4008 @item
4009 Convert source to grayscale:
4010 @example
4011 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
4012 @end example
4013 @item
4014 Simulate sepia tones:
4015 @example
4016 colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
4017 @end example
4018 @end itemize
4019
4020 @section colormatrix
4021
4022 Convert color matrix.
4023
4024 The filter accepts the following options:
4025
4026 @table @option
4027 @item src
4028 @item dst
4029 Specify the source and destination color matrix. Both values must be
4030 specified.
4031
4032 The accepted values are:
4033 @table @samp
4034 @item bt709
4035 BT.709
4036
4037 @item bt601
4038 BT.601
4039
4040 @item smpte240m
4041 SMPTE-240M
4042
4043 @item fcc
4044 FCC
4045 @end table
4046 @end table
4047
4048 For example to convert from BT.601 to SMPTE-240M, use the command:
4049 @example
4050 colormatrix=bt601:smpte240m
4051 @end example
4052
4053 @section copy
4054
4055 Copy the input source unchanged to the output. This is mainly useful for
4056 testing purposes.
4057
4058 @section crop
4059
4060 Crop the input video to given dimensions.
4061
4062 It accepts the following parameters:
4063
4064 @table @option
4065 @item w, out_w
4066 The width of the output video. It defaults to @code{iw}.
4067 This expression is evaluated only once during the filter
4068 configuration, or when the @samp{w} or @samp{out_w} command is sent.
4069
4070 @item h, out_h
4071 The height of the output video. It defaults to @code{ih}.
4072 This expression is evaluated only once during the filter
4073 configuration, or when the @samp{h} or @samp{out_h} command is sent.
4074
4075 @item x
4076 The horizontal position, in the input video, of the left edge of the output
4077 video. It defaults to @code{(in_w-out_w)/2}.
4078 This expression is evaluated per-frame.
4079
4080 @item y
4081 The vertical position, in the input video, of the top edge of the output video.
4082 It defaults to @code{(in_h-out_h)/2}.
4083 This expression is evaluated per-frame.
4084
4085 @item keep_aspect
4086 If set to 1 will force the output display aspect ratio
4087 to be the same of the input, by changing the output sample aspect
4088 ratio. It defaults to 0.
4089 @end table
4090
4091 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
4092 expressions containing the following constants:
4093
4094 @table @option
4095 @item x
4096 @item y
4097 The computed values for @var{x} and @var{y}. They are evaluated for
4098 each new frame.
4099
4100 @item in_w
4101 @item in_h
4102 The input width and height.
4103
4104 @item iw
4105 @item ih
4106 These are the same as @var{in_w} and @var{in_h}.
4107
4108 @item out_w
4109 @item out_h
4110 The output (cropped) width and height.
4111
4112 @item ow
4113 @item oh
4114 These are the same as @var{out_w} and @var{out_h}.
4115
4116 @item a
4117 same as @var{iw} / @var{ih}
4118
4119 @item sar
4120 input sample aspect ratio
4121
4122 @item dar
4123 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
4124
4125 @item hsub
4126 @item vsub
4127 horizontal and vertical chroma subsample values. For example for the
4128 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4129
4130 @item n
4131 The number of the input frame, starting from 0.
4132
4133 @item pos
4134 the position in the file of the input frame, NAN if unknown
4135
4136 @item t
4137 The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
4138
4139 @end table
4140
4141 The expression for @var{out_w} may depend on the value of @var{out_h},
4142 and the expression for @var{out_h} may depend on @var{out_w}, but they
4143 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
4144 evaluated after @var{out_w} and @var{out_h}.
4145
4146 The @var{x} and @var{y} parameters specify the expressions for the
4147 position of the top-left corner of the output (non-cropped) area. They
4148 are evaluated for each frame. If the evaluated value is not valid, it
4149 is approximated to the nearest valid value.
4150
4151 The expression for @var{x} may depend on @var{y}, and the expression
4152 for @var{y} may depend on @var{x}.
4153
4154 @subsection Examples
4155
4156 @itemize
4157 @item
4158 Crop area with size 100x100 at position (12,34).
4159 @example
4160 crop=100:100:12:34
4161 @end example
4162
4163 Using named options, the example above becomes:
4164 @example
4165 crop=w=100:h=100:x=12:y=34
4166 @end example
4167
4168 @item
4169 Crop the central input area with size 100x100:
4170 @example
4171 crop=100:100
4172 @end example
4173
4174 @item
4175 Crop the central input area with size 2/3 of the input video:
4176 @example
4177 crop=2/3*in_w:2/3*in_h
4178 @end example
4179
4180 @item
4181 Crop the input video central square:
4182 @example
4183 crop=out_w=in_h
4184 crop=in_h
4185 @end example
4186
4187 @item
4188 Delimit the rectangle with the top-left corner placed at position
4189 100:100 and the right-bottom corner corresponding to the right-bottom
4190 corner of the input image.
4191 @example
4192 crop=in_w-100:in_h-100:100:100
4193 @end example
4194
4195 @item
4196 Crop 10 pixels from the left and right borders, and 20 pixels from
4197 the top and bottom borders
4198 @example
4199 crop=in_w-2*10:in_h-2*20
4200 @end example
4201
4202 @item
4203 Keep only the bottom right quarter of the input image:
4204 @example
4205 crop=in_w/2:in_h/2:in_w/2:in_h/2
4206 @end example
4207
4208 @item
4209 Crop height for getting Greek harmony:
4210 @example
4211 crop=in_w:1/PHI*in_w
4212 @end example
4213