doc/filters: ladspa: add two more examples, this time using SWH plugins
[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 alimiter
645
646 The limiter prevents input signal from raising over a desired threshold.
647 This limiter uses lookahead technology to prevent your signal from distorting.
648 It means that there is a small delay after signal is processed. Keep in mind
649 that the delay it produces is the attack time you set.
650
651 The filter accepts the following options:
652
653 @table @option
654 @item limit
655 Don't let signals above this level pass the limiter. The removed amplitude is
656 added automatically. Default is 1.
657
658 @item attack
659 The limiter will reach its attenuation level in this amount of time in
660 milliseconds. Default is 5 milliseconds.
661
662 @item release
663 Come back from limiting to attenuation 1.0 in this amount of milliseconds.
664 Default is 50 milliseconds.
665
666 @item asc
667 When gain reduction is always needed ASC takes care of releasing to an
668 average reduction level rather than reaching a reduction of 0 in the release
669 time.
670
671 @item asc_level
672 Select how much the release time is affected by ASC, 0 means nearly no changes
673 in release time while 1 produces higher release times.
674 @end table
675
676 Depending on picked setting it is recommended to upsample input 2x or 4x times
677 with @ref{aresample} before applying this filter.
678
679 @section allpass
680
681 Apply a two-pole all-pass filter with central frequency (in Hz)
682 @var{frequency}, and filter-width @var{width}.
683 An all-pass filter changes the audio's frequency to phase relationship
684 without changing its frequency to amplitude relationship.
685
686 The filter accepts the following options:
687
688 @table @option
689 @item frequency, f
690 Set frequency in Hz.
691
692 @item width_type
693 Set method to specify band-width of filter.
694 @table @option
695 @item h
696 Hz
697 @item q
698 Q-Factor
699 @item o
700 octave
701 @item s
702 slope
703 @end table
704
705 @item width, w
706 Specify the band-width of a filter in width_type units.
707 @end table
708
709 @anchor{amerge}
710 @section amerge
711
712 Merge two or more audio streams into a single multi-channel stream.
713
714 The filter accepts the following options:
715
716 @table @option
717
718 @item inputs
719 Set the number of inputs. Default is 2.
720
721 @end table
722
723 If the channel layouts of the inputs are disjoint, and therefore compatible,
724 the channel layout of the output will be set accordingly and the channels
725 will be reordered as necessary. If the channel layouts of the inputs are not
726 disjoint, the output will have all the channels of the first input then all
727 the channels of the second input, in that order, and the channel layout of
728 the output will be the default value corresponding to the total number of
729 channels.
730
731 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
732 is FC+BL+BR, then the output will be in 5.1, with the channels in the
733 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
734 first input, b1 is the first channel of the second input).
735
736 On the other hand, if both input are in stereo, the output channels will be
737 in the default order: a1, a2, b1, b2, and the channel layout will be
738 arbitrarily set to 4.0, which may or may not be the expected value.
739
740 All inputs must have the same sample rate, and format.
741
742 If inputs do not have the same duration, the output will stop with the
743 shortest.
744
745 @subsection Examples
746
747 @itemize
748 @item
749 Merge two mono files into a stereo stream:
750 @example
751 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
752 @end example
753
754 @item
755 Multiple merges assuming 1 video stream and 6 audio streams in @file{input.mkv}:
756 @example
757 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
758 @end example
759 @end itemize
760
761 @section amix
762
763 Mixes multiple audio inputs into a single output.
764
765 Note that this filter only supports float samples (the @var{amerge}
766 and @var{pan} audio filters support many formats). If the @var{amix}
767 input has integer samples then @ref{aresample} will be automatically
768 inserted to perform the conversion to float samples.
769
770 For example
771 @example
772 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
773 @end example
774 will mix 3 input audio streams to a single output with the same duration as the
775 first input and a dropout transition time of 3 seconds.
776
777 It accepts the following parameters:
778 @table @option
779
780 @item inputs
781 The number of inputs. If unspecified, it defaults to 2.
782
783 @item duration
784 How to determine the end-of-stream.
785 @table @option
786
787 @item longest
788 The duration of the longest input. (default)
789
790 @item shortest
791 The duration of the shortest input.
792
793 @item first
794 The duration of the first input.
795
796 @end table
797
798 @item dropout_transition
799 The transition time, in seconds, for volume renormalization when an input
800 stream ends. The default value is 2 seconds.
801
802 @end table
803
804 @section anull
805
806 Pass the audio source unchanged to the output.
807
808 @section apad
809
810 Pad the end of an audio stream with silence.
811
812 This can be used together with @command{ffmpeg} @option{-shortest} to
813 extend audio streams to the same length as the video stream.
814
815 A description of the accepted options follows.
816
817 @table @option
818 @item packet_size
819 Set silence packet size. Default value is 4096.
820
821 @item pad_len
822 Set the number of samples of silence to add to the end. After the
823 value is reached, the stream is terminated. This option is mutually
824 exclusive with @option{whole_len}.
825
826 @item whole_len
827 Set the minimum total number of samples in the output audio stream. If
828 the value is longer than the input audio length, silence is added to
829 the end, until the value is reached. This option is mutually exclusive
830 with @option{pad_len}.
831 @end table
832
833 If neither the @option{pad_len} nor the @option{whole_len} option is
834 set, the filter will add silence to the end of the input stream
835 indefinitely.
836
837 @subsection Examples
838
839 @itemize
840 @item
841 Add 1024 samples of silence to the end of the input:
842 @example
843 apad=pad_len=1024
844 @end example
845
846 @item
847 Make sure the audio output will contain at least 10000 samples, pad
848 the input with silence if required:
849 @example
850 apad=whole_len=10000
851 @end example
852
853 @item
854 Use @command{ffmpeg} to pad the audio input with silence, so that the
855 video stream will always result the shortest and will be converted
856 until the end in the output file when using the @option{shortest}
857 option:
858 @example
859 ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
860 @end example
861 @end itemize
862
863 @section aphaser
864 Add a phasing effect to the input audio.
865
866 A phaser filter creates series of peaks and troughs in the frequency spectrum.
867 The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
868
869 A description of the accepted parameters follows.
870
871 @table @option
872 @item in_gain
873 Set input gain. Default is 0.4.
874
875 @item out_gain
876 Set output gain. Default is 0.74
877
878 @item delay
879 Set delay in milliseconds. Default is 3.0.
880
881 @item decay
882 Set decay. Default is 0.4.
883
884 @item speed
885 Set modulation speed in Hz. Default is 0.5.
886
887 @item type
888 Set modulation type. Default is triangular.
889
890 It accepts the following values:
891 @table @samp
892 @item triangular, t
893 @item sinusoidal, s
894 @end table
895 @end table
896
897 @anchor{aresample}
898 @section aresample
899
900 Resample the input audio to the specified parameters, using the
901 libswresample library. If none are specified then the filter will
902 automatically convert between its input and output.
903
904 This filter is also able to stretch/squeeze the audio data to make it match
905 the timestamps or to inject silence / cut out audio to make it match the
906 timestamps, do a combination of both or do neither.
907
908 The filter accepts the syntax
909 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
910 expresses a sample rate and @var{resampler_options} is a list of
911 @var{key}=@var{value} pairs, separated by ":". See the
912 ffmpeg-resampler manual for the complete list of supported options.
913
914 @subsection Examples
915
916 @itemize
917 @item
918 Resample the input audio to 44100Hz:
919 @example
920 aresample=44100
921 @end example
922
923 @item
924 Stretch/squeeze samples to the given timestamps, with a maximum of 1000
925 samples per second compensation:
926 @example
927 aresample=async=1000
928 @end example
929 @end itemize
930
931 @section asetnsamples
932
933 Set the number of samples per each output audio frame.
934
935 The last output packet may contain a different number of samples, as
936 the filter will flush all the remaining samples when the input audio
937 signal its end.
938
939 The filter accepts the following options:
940
941 @table @option
942
943 @item nb_out_samples, n
944 Set the number of frames per each output audio frame. The number is
945 intended as the number of samples @emph{per each channel}.
946 Default value is 1024.
947
948 @item pad, p
949 If set to 1, the filter will pad the last audio frame with zeroes, so
950 that the last frame will contain the same number of samples as the
951 previous ones. Default value is 1.
952 @end table
953
954 For example, to set the number of per-frame samples to 1234 and
955 disable padding for the last frame, use:
956 @example
957 asetnsamples=n=1234:p=0
958 @end example
959
960 @section asetrate
961
962 Set the sample rate without altering the PCM data.
963 This will result in a change of speed and pitch.
964
965 The filter accepts the following options:
966
967 @table @option
968 @item sample_rate, r
969 Set the output sample rate. Default is 44100 Hz.
970 @end table
971
972 @section ashowinfo
973
974 Show a line containing various information for each input audio frame.
975 The input audio is not modified.
976
977 The shown line contains a sequence of key/value pairs of the form
978 @var{key}:@var{value}.
979
980 The following values are shown in the output:
981
982 @table @option
983 @item n
984 The (sequential) number of the input frame, starting from 0.
985
986 @item pts
987 The presentation timestamp of the input frame, in time base units; the time base
988 depends on the filter input pad, and is usually 1/@var{sample_rate}.
989
990 @item pts_time
991 The presentation timestamp of the input frame in seconds.
992
993 @item pos
994 position of the frame in the input stream, -1 if this information in
995 unavailable and/or meaningless (for example in case of synthetic audio)
996
997 @item fmt
998 The sample format.
999
1000 @item chlayout
1001 The channel layout.
1002
1003 @item rate
1004 The sample rate for the audio frame.
1005
1006 @item nb_samples
1007 The number of samples (per channel) in the frame.
1008
1009 @item checksum
1010 The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
1011 audio, the data is treated as if all the planes were concatenated.
1012
1013 @item plane_checksums
1014 A list of Adler-32 checksums for each data plane.
1015 @end table
1016
1017 @anchor{astats}
1018 @section astats
1019
1020 Display time domain statistical information about the audio channels.
1021 Statistics are calculated and displayed for each audio channel and,
1022 where applicable, an overall figure is also given.
1023
1024 It accepts the following option:
1025 @table @option
1026 @item length
1027 Short window length in seconds, used for peak and trough RMS measurement.
1028 Default is @code{0.05} (50 milliseconds). Allowed range is @code{[0.1 - 10]}.
1029
1030 @item metadata
1031
1032 Set metadata injection. All the metadata keys are prefixed with @code{lavfi.astats.X},
1033 where @code{X} is channel number starting from 1 or string @code{Overall}. Default is
1034 disabled.
1035
1036 Available keys for each channel are:
1037 DC_offset
1038 Min_level
1039 Max_level
1040 Min_difference
1041 Max_difference
1042 Mean_difference
1043 Peak_level
1044 RMS_peak
1045 RMS_trough
1046 Crest_factor
1047 Flat_factor
1048 Peak_count
1049 Bit_depth
1050
1051 and for Overall:
1052 DC_offset
1053 Min_level
1054 Max_level
1055 Min_difference
1056 Max_difference
1057 Mean_difference
1058 Peak_level
1059 RMS_level
1060 RMS_peak
1061 RMS_trough
1062 Flat_factor
1063 Peak_count
1064 Bit_depth
1065 Number_of_samples
1066
1067 For example full key look like this @code{lavfi.astats.1.DC_offset} or
1068 this @code{lavfi.astats.Overall.Peak_count}.
1069
1070 For description what each key means read bellow.
1071
1072 @item reset
1073 Set number of frame after which stats are going to be recalculated.
1074 Default is disabled.
1075 @end table
1076
1077 A description of each shown parameter follows:
1078
1079 @table @option
1080 @item DC offset
1081 Mean amplitude displacement from zero.
1082
1083 @item Min level
1084 Minimal sample level.
1085
1086 @item Max level
1087 Maximal sample level.
1088
1089 @item Min difference
1090 Minimal difference between two consecutive samples.
1091
1092 @item Max difference
1093 Maximal difference between two consecutive samples.
1094
1095 @item Mean difference
1096 Mean difference between two consecutive samples.
1097 The average of each difference between two consecutive samples.
1098
1099 @item Peak level dB
1100 @item RMS level dB
1101 Standard peak and RMS level measured in dBFS.
1102
1103 @item RMS peak dB
1104 @item RMS trough dB
1105 Peak and trough values for RMS level measured over a short window.
1106
1107 @item Crest factor
1108 Standard ratio of peak to RMS level (note: not in dB).
1109
1110 @item Flat factor
1111 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
1112 (i.e. either @var{Min level} or @var{Max level}).
1113
1114 @item Peak count
1115 Number of occasions (not the number of samples) that the signal attained either
1116 @var{Min level} or @var{Max level}.
1117
1118 @item Bit depth
1119 Overall bit depth of audio. Number of bits used for each sample.
1120 @end table
1121
1122 @section astreamsync
1123
1124 Forward two audio streams and control the order the buffers are forwarded.
1125
1126 The filter accepts the following options:
1127
1128 @table @option
1129 @item expr, e
1130 Set the expression deciding which stream should be
1131 forwarded next: if the result is negative, the first stream is forwarded; if
1132 the result is positive or zero, the second stream is forwarded. It can use
1133 the following variables:
1134
1135 @table @var
1136 @item b1 b2
1137 number of buffers forwarded so far on each stream
1138 @item s1 s2
1139 number of samples forwarded so far on each stream
1140 @item t1 t2
1141 current timestamp of each stream
1142 @end table
1143
1144 The default value is @code{t1-t2}, which means to always forward the stream
1145 that has a smaller timestamp.
1146 @end table
1147
1148 @subsection Examples
1149
1150 Stress-test @code{amerge} by randomly sending buffers on the wrong
1151 input, while avoiding too much of a desynchronization:
1152 @example
1153 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
1154 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
1155 [a2] [b2] amerge
1156 @end example
1157
1158 @section asyncts
1159
1160 Synchronize audio data with timestamps by squeezing/stretching it and/or
1161 dropping samples/adding silence when needed.
1162
1163 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
1164
1165 It accepts the following parameters:
1166 @table @option
1167
1168 @item compensate
1169 Enable stretching/squeezing the data to make it match the timestamps. Disabled
1170 by default. When disabled, time gaps are covered with silence.
1171
1172 @item min_delta
1173 The minimum difference between timestamps and audio data (in seconds) to trigger
1174 adding/dropping samples. The default value is 0.1. If you get an imperfect
1175 sync with this filter, try setting this parameter to 0.
1176
1177 @item max_comp
1178 The maximum compensation in samples per second. Only relevant with compensate=1.
1179 The default value is 500.
1180
1181 @item first_pts
1182 Assume that the first PTS should be this value. The time base is 1 / sample
1183 rate. This allows for padding/trimming at the start of the stream. By default,
1184 no assumption is made about the first frame's expected PTS, so no padding or
1185 trimming is done. For example, this could be set to 0 to pad the beginning with
1186 silence if an audio stream starts after the video stream or to trim any samples
1187 with a negative PTS due to encoder delay.
1188
1189 @end table
1190
1191 @section atempo
1192
1193 Adjust audio tempo.
1194
1195 The filter accepts exactly one parameter, the audio tempo. If not
1196 specified then the filter will assume nominal 1.0 tempo. Tempo must
1197 be in the [0.5, 2.0] range.
1198
1199 @subsection Examples
1200
1201 @itemize
1202 @item
1203 Slow down audio to 80% tempo:
1204 @example
1205 atempo=0.8
1206 @end example
1207
1208 @item
1209 To speed up audio to 125% tempo:
1210 @example
1211 atempo=1.25
1212 @end example
1213 @end itemize
1214
1215 @section atrim
1216
1217 Trim the input so that the output contains one continuous subpart of the input.
1218
1219 It accepts the following parameters:
1220 @table @option
1221 @item start
1222 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
1223 sample with the timestamp @var{start} will be the first sample in the output.
1224
1225 @item end
1226 Specify time of the first audio sample that will be dropped, i.e. the
1227 audio sample immediately preceding the one with the timestamp @var{end} will be
1228 the last sample in the output.
1229
1230 @item start_pts
1231 Same as @var{start}, except this option sets the start timestamp in samples
1232 instead of seconds.
1233
1234 @item end_pts
1235 Same as @var{end}, except this option sets the end timestamp in samples instead
1236 of seconds.
1237
1238 @item duration
1239 The maximum duration of the output in seconds.
1240
1241 @item start_sample
1242 The number of the first sample that should be output.
1243
1244 @item end_sample
1245 The number of the first sample that should be dropped.
1246 @end table
1247
1248 @option{start}, @option{end}, and @option{duration} are expressed as time
1249 duration specifications; see
1250 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
1251
1252 Note that the first two sets of the start/end options and the @option{duration}
1253 option look at the frame timestamp, while the _sample options simply count the
1254 samples that pass through the filter. So start/end_pts and start/end_sample will
1255 give different results when the timestamps are wrong, inexact or do not start at
1256 zero. Also note that this filter does not modify the timestamps. If you wish
1257 to have the output timestamps start at zero, insert the asetpts filter after the
1258 atrim filter.
1259
1260 If multiple start or end options are set, this filter tries to be greedy and
1261 keep all samples that match at least one of the specified constraints. To keep
1262 only the part that matches all the constraints at once, chain multiple atrim
1263 filters.
1264
1265 The defaults are such that all the input is kept. So it is possible to set e.g.
1266 just the end values to keep everything before the specified time.
1267
1268 Examples:
1269 @itemize
1270 @item
1271 Drop everything except the second minute of input:
1272 @example
1273 ffmpeg -i INPUT -af atrim=60:120
1274 @end example
1275
1276 @item
1277 Keep only the first 1000 samples:
1278 @example
1279 ffmpeg -i INPUT -af atrim=end_sample=1000
1280 @end example
1281
1282 @end itemize
1283
1284 @section bandpass
1285
1286 Apply a two-pole Butterworth band-pass filter with central
1287 frequency @var{frequency}, and (3dB-point) band-width width.
1288 The @var{csg} option selects a constant skirt gain (peak gain = Q)
1289 instead of the default: constant 0dB peak gain.
1290 The filter roll off at 6dB per octave (20dB per decade).
1291
1292 The filter accepts the following options:
1293
1294 @table @option
1295 @item frequency, f
1296 Set the filter's central frequency. Default is @code{3000}.
1297
1298 @item csg
1299 Constant skirt gain if set to 1. Defaults to 0.
1300
1301 @item width_type
1302 Set method to specify band-width of filter.
1303 @table @option
1304 @item h
1305 Hz
1306 @item q
1307 Q-Factor
1308 @item o
1309 octave
1310 @item s
1311 slope
1312 @end table
1313
1314 @item width, w
1315 Specify the band-width of a filter in width_type units.
1316 @end table
1317
1318 @section bandreject
1319
1320 Apply a two-pole Butterworth band-reject filter with central
1321 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
1322 The filter roll off at 6dB per octave (20dB per decade).
1323
1324 The filter accepts the following options:
1325
1326 @table @option
1327 @item frequency, f
1328 Set the filter's central frequency. Default is @code{3000}.
1329
1330 @item width_type
1331 Set method to specify band-width of filter.
1332 @table @option
1333 @item h
1334 Hz
1335 @item q
1336 Q-Factor
1337 @item o
1338 octave
1339 @item s
1340 slope
1341 @end table
1342
1343 @item width, w
1344 Specify the band-width of a filter in width_type units.
1345 @end table
1346
1347 @section bass
1348
1349 Boost or cut the bass (lower) frequencies of the audio using a two-pole
1350 shelving filter with a response similar to that of a standard
1351 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1352
1353 The filter accepts the following options:
1354
1355 @table @option
1356 @item gain, g
1357 Give the gain at 0 Hz. Its useful range is about -20
1358 (for a large cut) to +20 (for a large boost).
1359 Beware of clipping when using a positive gain.
1360
1361 @item frequency, f
1362 Set the filter's central frequency and so can be used
1363 to extend or reduce the frequency range to be boosted or cut.
1364 The default value is @code{100} Hz.
1365
1366 @item width_type
1367 Set method to specify band-width of filter.
1368 @table @option
1369 @item h
1370 Hz
1371 @item q
1372 Q-Factor
1373 @item o
1374 octave
1375 @item s
1376 slope
1377 @end table
1378
1379 @item width, w
1380 Determine how steep is the filter's shelf transition.
1381 @end table
1382
1383 @section biquad
1384
1385 Apply a biquad IIR filter with the given coefficients.
1386 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
1387 are the numerator and denominator coefficients respectively.
1388
1389 @section bs2b
1390 Bauer stereo to binaural transformation, which improves headphone listening of
1391 stereo audio records.
1392
1393 It accepts the following parameters:
1394 @table @option
1395
1396 @item profile
1397 Pre-defined crossfeed level.
1398 @table @option
1399
1400 @item default
1401 Default level (fcut=700, feed=50).
1402
1403 @item cmoy
1404 Chu Moy circuit (fcut=700, feed=60).
1405
1406 @item jmeier
1407 Jan Meier circuit (fcut=650, feed=95).
1408
1409 @end table
1410
1411 @item fcut
1412 Cut frequency (in Hz).
1413
1414 @item feed
1415 Feed level (in Hz).
1416
1417 @end table
1418
1419 @section channelmap
1420
1421 Remap input channels to new locations.
1422
1423 It accepts the following parameters:
1424 @table @option
1425 @item channel_layout
1426 The channel layout of the output stream.
1427
1428 @item map
1429 Map channels from input to output. The argument is a '|'-separated list of
1430 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1431 @var{in_channel} form. @var{in_channel} can be either the name of the input
1432 channel (e.g. FL for front left) or its index in the input channel layout.
1433 @var{out_channel} is the name of the output channel or its index in the output
1434 channel layout. If @var{out_channel} is not given then it is implicitly an
1435 index, starting with zero and increasing by one for each mapping.
1436 @end table
1437
1438 If no mapping is present, the filter will implicitly map input channels to
1439 output channels, preserving indices.
1440
1441 For example, assuming a 5.1+downmix input MOV file,
1442 @example
1443 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
1444 @end example
1445 will create an output WAV file tagged as stereo from the downmix channels of
1446 the input.
1447
1448 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1449 @example
1450 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
1451 @end example
1452
1453 @section channelsplit
1454
1455 Split each channel from an input audio stream into a separate output stream.
1456
1457 It accepts the following parameters:
1458 @table @option
1459 @item channel_layout
1460 The channel layout of the input stream. The default is "stereo".
1461 @end table
1462
1463 For example, assuming a stereo input MP3 file,
1464 @example
1465 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1466 @end example
1467 will create an output Matroska file with two audio streams, one containing only
1468 the left channel and the other the right channel.
1469
1470 Split a 5.1 WAV file into per-channel files:
1471 @example
1472 ffmpeg -i in.wav -filter_complex
1473 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1474 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1475 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1476 side_right.wav
1477 @end example
1478
1479 @section chorus
1480 Add a chorus effect to the audio.
1481
1482 Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
1483
1484 Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
1485 constant, with chorus, it is varied using using sinusoidal or triangular modulation.
1486 The modulation depth defines the range the modulated delay is played before or after
1487 the delay. Hence the delayed sound will sound slower or faster, that is the delayed
1488 sound tuned around the original one, like in a chorus where some vocals are slightly
1489 off key.
1490
1491 It accepts the following parameters:
1492 @table @option
1493 @item in_gain
1494 Set input gain. Default is 0.4.
1495
1496 @item out_gain
1497 Set output gain. Default is 0.4.
1498
1499 @item delays
1500 Set delays. A typical delay is around 40ms to 60ms.
1501
1502 @item decays
1503 Set decays.
1504
1505 @item speeds
1506 Set speeds.
1507
1508 @item depths
1509 Set depths.
1510 @end table
1511
1512 @subsection Examples
1513
1514 @itemize
1515 @item
1516 A single delay:
1517 @example
1518 chorus=0.7:0.9:55:0.4:0.25:2
1519 @end example
1520
1521 @item
1522 Two delays:
1523 @example
1524 chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
1525 @end example
1526
1527 @item
1528 Fuller sounding chorus with three delays:
1529 @example
1530 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
1531 @end example
1532 @end itemize
1533
1534 @section compand
1535 Compress or expand the audio's dynamic range.
1536
1537 It accepts the following parameters:
1538
1539 @table @option
1540
1541 @item attacks
1542 @item decays
1543 A list of times in seconds for each channel over which the instantaneous level
1544 of the input signal is averaged to determine its volume. @var{attacks} refers to
1545 increase of volume and @var{decays} refers to decrease of volume. For most
1546 situations, the attack time (response to the audio getting louder) should be
1547 shorter than the decay time, because the human ear is more sensitive to sudden
1548 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
1549 a typical value for decay is 0.8 seconds.
1550 If specified number of attacks & decays is lower than number of channels, the last
1551 set attack/decay will be used for all remaining channels.
1552
1553 @item points
1554 A list of points for the transfer function, specified in dB relative to the
1555 maximum possible signal amplitude. Each key points list must be defined using
1556 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
1557 @code{x0/y0 x1/y1 x2/y2 ....}
1558
1559 The input values must be in strictly increasing order but the transfer function
1560 does not have to be monotonically rising. The point @code{0/0} is assumed but
1561 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
1562 function are @code{-70/-70|-60/-20}.
1563
1564 @item soft-knee
1565 Set the curve radius in dB for all joints. It defaults to 0.01.
1566
1567 @item gain
1568 Set the additional gain in dB to be applied at all points on the transfer
1569 function. This allows for easy adjustment of the overall gain.
1570 It defaults to 0.
1571
1572 @item volume
1573 Set an initial volume, in dB, to be assumed for each channel when filtering
1574 starts. This permits the user to supply a nominal level initially, so that, for
1575 example, a very large gain is not applied to initial signal levels before the
1576 companding has begun to operate. A typical value for audio which is initially
1577 quiet is -90 dB. It defaults to 0.
1578
1579 @item delay
1580 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
1581 delayed before being fed to the volume adjuster. Specifying a delay
1582 approximately equal to the attack/decay times allows the filter to effectively
1583 operate in predictive rather than reactive mode. It defaults to 0.
1584
1585 @end table
1586
1587 @subsection Examples
1588
1589 @itemize
1590 @item
1591 Make music with both quiet and loud passages suitable for listening to in a
1592 noisy environment:
1593 @example
1594 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
1595 @end example
1596
1597 Another example for audio with whisper and explosion parts:
1598 @example
1599 compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
1600 @end example
1601
1602 @item
1603 A noise gate for when the noise is at a lower level than the signal:
1604 @example
1605 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
1606 @end example
1607
1608 @item
1609 Here is another noise gate, this time for when the noise is at a higher level
1610 than the signal (making it, in some ways, similar to squelch):
1611 @example
1612 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
1613 @end example
1614 @end itemize
1615
1616 @section dcshift
1617 Apply a DC shift to the audio.
1618
1619 This can be useful to remove a DC offset (caused perhaps by a hardware problem
1620 in the recording chain) from the audio. The effect of a DC offset is reduced
1621 headroom and hence volume. The @ref{astats} filter can be used to determine if
1622 a signal has a DC offset.
1623
1624 @table @option
1625 @item shift
1626 Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
1627 the audio.
1628
1629 @item limitergain
1630 Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
1631 used to prevent clipping.
1632 @end table
1633
1634 @section dynaudnorm
1635 Dynamic Audio Normalizer.
1636
1637 This filter applies a certain amount of gain to the input audio in order
1638 to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
1639 contrast to more "simple" normalization algorithms, the Dynamic Audio
1640 Normalizer *dynamically* re-adjusts the gain factor to the input audio.
1641 This allows for applying extra gain to the "quiet" sections of the audio
1642 while avoiding distortions or clipping the "loud" sections. In other words:
1643 The Dynamic Audio Normalizer will "even out" the volume of quiet and loud
1644 sections, in the sense that the volume of each section is brought to the
1645 same target level. Note, however, that the Dynamic Audio Normalizer achieves
1646 this goal *without* applying "dynamic range compressing". It will retain 100%
1647 of the dynamic range *within* each section of the audio file.
1648
1649 @table @option
1650 @item f
1651 Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
1652 Default is 500 milliseconds.
1653 The Dynamic Audio Normalizer processes the input audio in small chunks,
1654 referred to as frames. This is required, because a peak magnitude has no
1655 meaning for just a single sample value. Instead, we need to determine the
1656 peak magnitude for a contiguous sequence of sample values. While a "standard"
1657 normalizer would simply use the peak magnitude of the complete file, the
1658 Dynamic Audio Normalizer determines the peak magnitude individually for each
1659 frame. The length of a frame is specified in milliseconds. By default, the
1660 Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
1661 been found to give good results with most files.
1662 Note that the exact frame length, in number of samples, will be determined
1663 automatically, based on the sampling rate of the individual input audio file.
1664
1665 @item g
1666 Set the Gaussian filter window size. In range from 3 to 301, must be odd
1667 number. Default is 31.
1668 Probably the most important parameter of the Dynamic Audio Normalizer is the
1669 @code{window size} of the Gaussian smoothing filter. The filter's window size
1670 is specified in frames, centered around the current frame. For the sake of
1671 simplicity, this must be an odd number. Consequently, the default value of 31
1672 takes into account the current frame, as well as the 15 preceding frames and
1673 the 15 subsequent frames. Using a larger window results in a stronger
1674 smoothing effect and thus in less gain variation, i.e. slower gain
1675 adaptation. Conversely, using a smaller window results in a weaker smoothing
1676 effect and thus in more gain variation, i.e. faster gain adaptation.
1677 In other words, the more you increase this value, the more the Dynamic Audio
1678 Normalizer will behave like a "traditional" normalization filter. On the
1679 contrary, the more you decrease this value, the more the Dynamic Audio
1680 Normalizer will behave like a dynamic range compressor.
1681
1682 @item p
1683 Set the target peak value. This specifies the highest permissible magnitude
1684 level for the normalized audio input. This filter will try to approach the
1685 target peak magnitude as closely as possible, but at the same time it also
1686 makes sure that the normalized signal will never exceed the peak magnitude.
1687 A frame's maximum local gain factor is imposed directly by the target peak
1688 magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
1689 It is not recommended to go above this value.
1690
1691 @item m
1692 Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
1693 The Dynamic Audio Normalizer determines the maximum possible (local) gain
1694 factor for each input frame, i.e. the maximum gain factor that does not
1695 result in clipping or distortion. The maximum gain factor is determined by
1696 the frame's highest magnitude sample. However, the Dynamic Audio Normalizer
1697 additionally bounds the frame's maximum gain factor by a predetermined
1698 (global) maximum gain factor. This is done in order to avoid excessive gain
1699 factors in "silent" or almost silent frames. By default, the maximum gain
1700 factor is 10.0, For most inputs the default value should be sufficient and
1701 it usually is not recommended to increase this value. Though, for input
1702 with an extremely low overall volume level, it may be necessary to allow even
1703 higher gain factors. Note, however, that the Dynamic Audio Normalizer does
1704 not simply apply a "hard" threshold (i.e. cut off values above the threshold).
1705 Instead, a "sigmoid" threshold function will be applied. This way, the
1706 gain factors will smoothly approach the threshold value, but never exceed that
1707 value.
1708
1709 @item r
1710 Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
1711 By default, the Dynamic Audio Normalizer performs "peak" normalization.
1712 This means that the maximum local gain factor for each frame is defined
1713 (only) by the frame's highest magnitude sample. This way, the samples can
1714 be amplified as much as possible without exceeding the maximum signal
1715 level, i.e. without clipping. Optionally, however, the Dynamic Audio
1716 Normalizer can also take into account the frame's root mean square,
1717 abbreviated RMS. In electrical engineering, the RMS is commonly used to
1718 determine the power of a time-varying signal. It is therefore considered
1719 that the RMS is a better approximation of the "perceived loudness" than
1720 just looking at the signal's peak magnitude. Consequently, by adjusting all
1721 frames to a constant RMS value, a uniform "perceived loudness" can be
1722 established. If a target RMS value has been specified, a frame's local gain
1723 factor is defined as the factor that would result in exactly that RMS value.
1724 Note, however, that the maximum local gain factor is still restricted by the
1725 frame's highest magnitude sample, in order to prevent clipping.
1726
1727 @item n
1728 Enable channels coupling. By default is enabled.
1729 By default, the Dynamic Audio Normalizer will amplify all channels by the same
1730 amount. This means the same gain factor will be applied to all channels, i.e.
1731 the maximum possible gain factor is determined by the "loudest" channel.
1732 However, in some recordings, it may happen that the volume of the different
1733 channels is uneven, e.g. one channel may be "quieter" than the other one(s).
1734 In this case, this option can be used to disable the channel coupling. This way,
1735 the gain factor will be determined independently for each channel, depending
1736 only on the individual channel's highest magnitude sample. This allows for
1737 harmonizing the volume of the different channels.
1738
1739 @item c
1740 Enable DC bias correction. By default is disabled.
1741 An audio signal (in the time domain) is a sequence of sample values.
1742 In the Dynamic Audio Normalizer these sample values are represented in the
1743 -1.0 to 1.0 range, regardless of the original input format. Normally, the
1744 audio signal, or "waveform", should be centered around the zero point.
1745 That means if we calculate the mean value of all samples in a file, or in a
1746 single frame, then the result should be 0.0 or at least very close to that
1747 value. If, however, there is a significant deviation of the mean value from
1748 0.0, in either positive or negative direction, this is referred to as a
1749 DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
1750 Audio Normalizer provides optional DC bias correction.
1751 With DC bias correction enabled, the Dynamic Audio Normalizer will determine
1752 the mean value, or "DC correction" offset, of each input frame and subtract
1753 that value from all of the frame's sample values which ensures those samples
1754 are centered around 0.0 again. Also, in order to avoid "gaps" at the frame
1755 boundaries, the DC correction offset values will be interpolated smoothly
1756 between neighbouring frames.
1757
1758 @item b
1759 Enable alternative boundary mode. By default is disabled.
1760 The Dynamic Audio Normalizer takes into account a certain neighbourhood
1761 around each frame. This includes the preceding frames as well as the
1762 subsequent frames. However, for the "boundary" frames, located at the very
1763 beginning and at the very end of the audio file, not all neighbouring
1764 frames are available. In particular, for the first few frames in the audio
1765 file, the preceding frames are not known. And, similarly, for the last few
1766 frames in the audio file, the subsequent frames are not known. Thus, the
1767 question arises which gain factors should be assumed for the missing frames
1768 in the "boundary" region. The Dynamic Audio Normalizer implements two modes
1769 to deal with this situation. The default boundary mode assumes a gain factor
1770 of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and
1771 "fade out" at the beginning and at the end of the input, respectively.
1772
1773 @item s
1774 Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
1775 By default, the Dynamic Audio Normalizer does not apply "traditional"
1776 compression. This means that signal peaks will not be pruned and thus the
1777 full dynamic range will be retained within each local neighbourhood. However,
1778 in some cases it may be desirable to combine the Dynamic Audio Normalizer's
1779 normalization algorithm with a more "traditional" compression.
1780 For this purpose, the Dynamic Audio Normalizer provides an optional compression
1781 (thresholding) function. If (and only if) the compression feature is enabled,
1782 all input frames will be processed by a soft knee thresholding function prior
1783 to the actual normalization process. Put simply, the thresholding function is
1784 going to prune all samples whose magnitude exceeds a certain threshold value.
1785 However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
1786 value. Instead, the threshold value will be adjusted for each individual
1787 frame.
1788 In general, smaller parameters result in stronger compression, and vice versa.
1789 Values below 3.0 are not recommended, because audible distortion may appear.
1790 @end table
1791
1792 @section earwax
1793
1794 Make audio easier to listen to on headphones.
1795
1796 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
1797 so that when listened to on headphones the stereo image is moved from
1798 inside your head (standard for headphones) to outside and in front of
1799 the listener (standard for speakers).
1800
1801 Ported from SoX.
1802
1803 @section equalizer
1804
1805 Apply a two-pole peaking equalisation (EQ) filter. With this
1806 filter, the signal-level at and around a selected frequency can
1807 be increased or decreased, whilst (unlike bandpass and bandreject
1808 filters) that at all other frequencies is unchanged.
1809
1810 In order to produce complex equalisation curves, this filter can
1811 be given several times, each with a different central frequency.
1812
1813 The filter accepts the following options:
1814
1815 @table @option
1816 @item frequency, f
1817 Set the filter's central frequency in Hz.
1818
1819 @item width_type
1820 Set method to specify band-width of filter.
1821 @table @option
1822 @item h
1823 Hz
1824 @item q
1825 Q-Factor
1826 @item o
1827 octave
1828 @item s
1829 slope
1830 @end table
1831
1832 @item width, w
1833 Specify the band-width of a filter in width_type units.
1834
1835 @item gain, g
1836 Set the required gain or attenuation in dB.
1837 Beware of clipping when using a positive gain.
1838 @end table
1839
1840 @subsection Examples
1841 @itemize
1842 @item
1843 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
1844 @example
1845 equalizer=f=1000:width_type=h:width=200:g=-10
1846 @end example
1847
1848 @item
1849 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
1850 @example
1851 equalizer=f=1000:width_type=q:width=1:g=2,equalizer=f=100:width_type=q:width=2:g=-5
1852 @end example
1853 @end itemize
1854
1855 @section extrastereo
1856
1857 Linearly increases the difference between left and right channels which
1858 adds some sort of "live" effect to playback.
1859
1860 The filter accepts the following option:
1861
1862 @table @option
1863 @item m
1864 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
1865 (average of both channels), with 1.0 sound will be unchanged, with
1866 -1.0 left and right channels will be swapped.
1867
1868 @item c
1869 Enable clipping. By default is enabled.
1870 @end table
1871
1872 @section flanger
1873 Apply a flanging effect to the audio.
1874
1875 The filter accepts the following options:
1876
1877 @table @option
1878 @item delay
1879 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
1880
1881 @item depth
1882 Set added swep delay in milliseconds. Range from 0 to 10. Default value is 2.
1883
1884 @item regen
1885 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
1886 Default value is 0.
1887
1888 @item width
1889 Set percentage of delayed signal mixed with original. Range from 0 to 100.
1890 Default value is 71.
1891
1892 @item speed
1893 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
1894
1895 @item shape
1896 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
1897 Default value is @var{sinusoidal}.
1898
1899 @item phase
1900 Set swept wave percentage-shift for multi channel. Range from 0 to 100.
1901 Default value is 25.
1902
1903 @item interp
1904 Set delay-line interpolation, @var{linear} or @var{quadratic}.
1905 Default is @var{linear}.
1906 @end table
1907
1908 @section highpass
1909
1910 Apply a high-pass filter with 3dB point frequency.
1911 The filter can be either single-pole, or double-pole (the default).
1912 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1913
1914 The filter accepts the following options:
1915
1916 @table @option
1917 @item frequency, f
1918 Set frequency in Hz. Default is 3000.
1919
1920 @item poles, p
1921 Set number of poles. Default is 2.
1922
1923 @item width_type
1924 Set method to specify band-width of filter.
1925 @table @option
1926 @item h
1927 Hz
1928 @item q
1929 Q-Factor
1930 @item o
1931 octave
1932 @item s
1933 slope
1934 @end table
1935
1936 @item width, w
1937 Specify the band-width of a filter in width_type units.
1938 Applies only to double-pole filter.
1939 The default is 0.707q and gives a Butterworth response.
1940 @end table
1941
1942 @section join
1943
1944 Join multiple input streams into one multi-channel stream.
1945
1946 It accepts the following parameters:
1947 @table @option
1948
1949 @item inputs
1950 The number of input streams. It defaults to 2.
1951
1952 @item channel_layout
1953 The desired output channel layout. It defaults to stereo.
1954
1955 @item map
1956 Map channels from inputs to output. The argument is a '|'-separated list of
1957 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1958 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1959 can be either the name of the input channel (e.g. FL for front left) or its
1960 index in the specified input stream. @var{out_channel} is the name of the output
1961 channel.
1962 @end table
1963
1964 The filter will attempt to guess the mappings when they are not specified
1965 explicitly. It does so by first trying to find an unused matching input channel
1966 and if that fails it picks the first unused input channel.
1967
1968 Join 3 inputs (with properly set channel layouts):
1969 @example
1970 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1971 @end example
1972
1973 Build a 5.1 output from 6 single-channel streams:
1974 @example
1975 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1976 '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'
1977 out
1978 @end example
1979
1980 @section ladspa
1981
1982 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
1983
1984 To enable compilation of this filter you need to configure FFmpeg with
1985 @code{--enable-ladspa}.
1986
1987 @table @option
1988 @item file, f
1989 Specifies the name of LADSPA plugin library to load. If the environment
1990 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
1991 each one of the directories specified by the colon separated list in
1992 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
1993 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
1994 @file{/usr/lib/ladspa/}.
1995
1996 @item plugin, p
1997 Specifies the plugin within the library. Some libraries contain only
1998 one plugin, but others contain many of them. If this is not set filter
1999 will list all available plugins within the specified library.
2000
2001 @item controls, c
2002 Set the '|' separated list of controls which are zero or more floating point
2003 values that determine the behavior of the loaded plugin (for example delay,
2004 threshold or gain).
2005 Controls need to be defined using the following syntax:
2006 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
2007 @var{valuei} is the value set on the @var{i}-th control.
2008 Alternatively they can be also defined using the following syntax:
2009 @var{value0}|@var{value1}|@var{value2}|..., where
2010 @var{valuei} is the value set on the @var{i}-th control.
2011 If @option{controls} is set to @code{help}, all available controls and
2012 their valid ranges are printed.
2013
2014 @item sample_rate, s
2015 Specify the sample rate, default to 44100. Only used if plugin have
2016 zero inputs.
2017
2018 @item nb_samples, n
2019 Set the number of samples per channel per each output frame, default
2020 is 1024. Only used if plugin have zero inputs.
2021
2022 @item duration, d
2023 Set the minimum duration of the sourced audio. See
2024 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
2025 for the accepted syntax.
2026 Note that the resulting duration may be greater than the specified duration,
2027 as the generated audio is always cut at the end of a complete frame.
2028 If not specified, or the expressed duration is negative, the audio is
2029 supposed to be generated forever.
2030 Only used if plugin have zero inputs.
2031
2032 @end table
2033
2034 @subsection Examples
2035
2036 @itemize
2037 @item
2038 List all available plugins within amp (LADSPA example plugin) library:
2039 @example
2040 ladspa=file=amp
2041 @end example
2042
2043 @item
2044 List all available controls and their valid ranges for @code{vcf_notch}
2045 plugin from @code{VCF} library:
2046 @example
2047 ladspa=f=vcf:p=vcf_notch:c=help
2048 @end example
2049
2050 @item
2051 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
2052 plugin library:
2053 @example
2054 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
2055 @end example
2056
2057 @item
2058 Add reverberation to the audio using TAP-plugins
2059 (Tom's Audio Processing plugins):
2060 @example
2061 ladspa=file=tap_reverb:tap_reverb
2062 @end example
2063
2064 @item
2065 Generate white noise, with 0.2 amplitude:
2066 @example
2067 ladspa=file=cmt:noise_source_white:c=c0=.2
2068 @end example
2069
2070 @item
2071 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
2072 @code{C* Audio Plugin Suite} (CAPS) library:
2073 @example
2074 ladspa=file=caps:Click:c=c1=20'
2075 @end example
2076
2077 @item
2078 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
2079 @example
2080 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
2081 @end example
2082
2083 @item
2084 Increase volume by 20dB using fast lookahead limiter from Steve Harris
2085 @code{SWH Plugins} collection:
2086 @example
2087 ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
2088 @end example
2089
2090 @item
2091 Attenuate low frequencies using Multiband EQ from Steve Harris
2092 @code{SWH Plugins} collection:
2093 @example
2094 ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
2095 @end example
2096 @end itemize
2097
2098 @subsection Commands
2099
2100 This filter supports the following commands:
2101 @table @option
2102 @item cN
2103 Modify the @var{N}-th control value.
2104
2105 If the specified value is not valid, it is ignored and prior one is kept.
2106 @end table
2107
2108 @section lowpass
2109
2110 Apply a low-pass filter with 3dB point frequency.
2111 The filter can be either single-pole or double-pole (the default).
2112 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
2113
2114 The filter accepts the following options:
2115
2116 @table @option
2117 @item frequency, f
2118 Set frequency in Hz. Default is 500.
2119
2120 @item poles, p
2121 Set number of poles. Default is 2.
2122
2123 @item width_type
2124 Set method to specify band-width of filter.
2125 @table @option
2126 @item h
2127 Hz
2128 @item q
2129 Q-Factor
2130 @item o
2131 octave
2132 @item s
2133 slope
2134 @end table
2135
2136 @item width, w
2137 Specify the band-width of a filter in width_type units.
2138 Applies only to double-pole filter.
2139 The default is 0.707q and gives a Butterworth response.
2140 @end table
2141
2142 @anchor{pan}
2143 @section pan
2144
2145 Mix channels with specific gain levels. The filter accepts the output
2146 channel layout followed by a set of channels definitions.
2147
2148 This filter is also designed to efficiently remap the channels of an audio
2149 stream.
2150
2151 The filter accepts parameters of the form:
2152 "@var{l}|@var{outdef}|@var{outdef}|..."
2153
2154 @table @option
2155 @item l
2156 output channel layout or number of channels
2157
2158 @item outdef
2159 output channel specification, of the form:
2160 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
2161
2162 @item out_name
2163 output channel to define, either a channel name (FL, FR, etc.) or a channel
2164 number (c0, c1, etc.)
2165
2166 @item gain
2167 multiplicative coefficient for the channel, 1 leaving the volume unchanged
2168
2169 @item in_name
2170 input channel to use, see out_name for details; it is not possible to mix
2171 named and numbered input channels
2172 @end table
2173
2174 If the `=' in a channel specification is replaced by `<', then the gains for
2175 that specification will be renormalized so that the total is 1, thus
2176 avoiding clipping noise.
2177
2178 @subsection Mixing examples
2179
2180 For example, if you want to down-mix from stereo to mono, but with a bigger
2181 factor for the left channel:
2182 @example
2183 pan=1c|c0=0.9*c0+0.1*c1
2184 @end example
2185
2186 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
2187 7-channels surround:
2188 @example
2189 pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
2190 @end example
2191
2192 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
2193 that should be preferred (see "-ac" option) unless you have very specific
2194 needs.
2195
2196 @subsection Remapping examples
2197
2198 The channel remapping will be effective if, and only if:
2199
2200 @itemize
2201 @item gain coefficients are zeroes or ones,
2202 @item only one input per channel output,
2203 @end itemize
2204
2205 If all these conditions are satisfied, the filter will notify the user ("Pure
2206 channel mapping detected"), and use an optimized and lossless method to do the
2207 remapping.
2208
2209 For example, if you have a 5.1 source and want a stereo audio stream by
2210 dropping the extra channels:
2211 @example
2212 pan="stereo| c0=FL | c1=FR"
2213 @end example
2214
2215 Given the same source, you can also switch front left and front right channels
2216 and keep the input channel layout:
2217 @example
2218 pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
2219 @end example
2220
2221 If the input is a stereo audio stream, you can mute the front left channel (and
2222 still keep the stereo channel layout) with:
2223 @example
2224 pan="stereo|c1=c1"
2225 @end example
2226
2227 Still with a stereo audio stream input, you can copy the right channel in both
2228 front left and right:
2229 @example
2230 pan="stereo| c0=FR | c1=FR"
2231 @end example
2232
2233 @section replaygain
2234
2235 ReplayGain scanner filter. This filter takes an audio stream as an input and
2236 outputs it unchanged.
2237 At end of filtering it displays @code{track_gain} and @code{track_peak}.
2238
2239 @section resample
2240
2241 Convert the audio sample format, sample rate and channel layout. It is
2242 not meant to be used directly.
2243
2244 @section sidechaincompress
2245
2246 This filter acts like normal compressor but has the ability to compress
2247 detected signal using second input signal.
2248 It needs two input streams and returns one output stream.
2249 First input stream will be processed depending on second stream signal.
2250 The filtered signal then can be filtered with other filters in later stages of
2251 processing. See @ref{pan} and @ref{amerge} filter.
2252
2253 The filter accepts the following options:
2254
2255 @table @option
2256 @item threshold
2257 If a signal of second stream raises above this level it will affect the gain
2258 reduction of first stream.
2259 By default is 0.125. Range is between 0.00097563 and 1.
2260
2261 @item ratio
2262 Set a ratio about which the signal is reduced. 1:2 means that if the level
2263 raised 4dB above the threshold, it will be only 2dB above after the reduction.
2264 Default is 2. Range is between 1 and 20.
2265
2266 @item attack
2267 Amount of milliseconds the signal has to rise above the threshold before gain
2268 reduction starts. Default is 20. Range is between 0.01 and 2000.
2269
2270 @item release
2271 Amount of milliseconds the signal has to fall bellow the threshold before
2272 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
2273
2274 @item makeup
2275 Set the amount by how much signal will be amplified after processing.
2276 Default is 2. Range is from 1 and 64.
2277
2278 @item knee
2279 Curve the sharp knee around the threshold to enter gain reduction more softly.
2280 Default is 2.82843. Range is between 1 and 8.
2281
2282 @item link
2283 Choose if the @code{average} level between all channels of side-chain stream
2284 or the louder(@code{maximum}) channel of side-chain stream affects the
2285 reduction. Default is @code{average}.
2286
2287 @item detection
2288 Should the exact signal be taken in case of @code{peak} or an RMS one in case
2289 of @code{rms}. Default is @code{rms} which is mainly smoother.
2290 @end table
2291
2292 @subsection Examples
2293
2294 @itemize
2295 @item
2296 Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
2297 depending on the signal of 2nd input and later compressed signal to be
2298 merged with 2nd input:
2299 @example
2300 ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
2301 @end example
2302 @end itemize
2303
2304 @section silencedetect
2305
2306 Detect silence in an audio stream.
2307
2308 This filter logs a message when it detects that the input audio volume is less
2309 or equal to a noise tolerance value for a duration greater or equal to the
2310 minimum detected noise duration.
2311
2312 The printed times and duration are expressed in seconds.
2313
2314 The filter accepts the following options:
2315
2316 @table @option
2317 @item duration, d
2318 Set silence duration until notification (default is 2 seconds).
2319
2320 @item noise, n
2321 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
2322 specified value) or amplitude ratio. Default is -60dB, or 0.001.
2323 @end table
2324
2325 @subsection Examples
2326
2327 @itemize
2328 @item
2329 Detect 5 seconds of silence with -50dB noise tolerance:
2330 @example
2331 silencedetect=n=-50dB:d=5
2332 @end example
2333
2334 @item
2335 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
2336 tolerance in @file{silence.mp3}:
2337 @example
2338 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
2339 @end example
2340 @end itemize
2341
2342 @section silenceremove
2343
2344 Remove silence from the beginning, middle or end of the audio.
2345
2346 The filter accepts the following options:
2347
2348 @table @option
2349 @item start_periods
2350 This value is used to indicate if audio should be trimmed at beginning of
2351 the audio. A value of zero indicates no silence should be trimmed from the
2352 beginning. When specifying a non-zero value, it trims audio up until it
2353 finds non-silence. Normally, when trimming silence from beginning of audio
2354 the @var{start_periods} will be @code{1} but it can be increased to higher
2355 values to trim all audio up to specific count of non-silence periods.
2356 Default value is @code{0}.
2357
2358 @item start_duration
2359 Specify the amount of time that non-silence must be detected before it stops
2360 trimming audio. By increasing the duration, bursts of noises can be treated
2361 as silence and trimmed off. Default value is @code{0}.
2362
2363 @item start_threshold
2364 This indicates what sample value should be treated as silence. For digital
2365 audio, a value of @code{0} may be fine but for audio recorded from analog,
2366 you may wish to increase the value to account for background noise.
2367 Can be specified in dB (in case "dB" is appended to the specified value)
2368 or amplitude ratio. Default value is @code{0}.
2369
2370 @item stop_periods
2371 Set the count for trimming silence from the end of audio.
2372 To remove silence from the middle of a file, specify a @var{stop_periods}
2373 that is negative. This value is then treated as a positive value and is
2374 used to indicate the effect should restart processing as specified by
2375 @var{start_periods}, making it suitable for removing periods of silence
2376 in the middle of the audio.
2377 Default value is @code{0}.
2378
2379 @item stop_duration
2380 Specify a duration of silence that must exist before audio is not copied any
2381 more. By specifying a higher duration, silence that is wanted can be left in
2382 the audio.
2383 Default value is @code{0}.
2384
2385 @item stop_threshold
2386 This is the same as @option{start_threshold} but for trimming silence from
2387 the end of audio.
2388 Can be specified in dB (in case "dB" is appended to the specified value)
2389 or amplitude ratio. Default value is @code{0}.
2390
2391 @item leave_silence
2392 This indicate that @var{stop_duration} length of audio should be left intact
2393 at the beginning of each period of silence.
2394 For example, if you want to remove long pauses between words but do not want
2395 to remove the pauses completely. Default value is @code{0}.
2396
2397 @end table
2398
2399 @subsection Examples
2400
2401 @itemize
2402 @item
2403 The following example shows how this filter can be used to start a recording
2404 that does not contain the delay at the start which usually occurs between
2405 pressing the record button and the start of the performance:
2406 @example
2407 silenceremove=1:5:0.02
2408 @end example
2409 @end itemize
2410
2411 @section stereowiden
2412
2413 This filter enhance the stereo effect by suppressing signal common to both
2414 channels and by delaying the signal of left into right and vice versa,
2415 thereby widening the stereo effect.
2416
2417 The filter accepts the following options:
2418
2419 @table @option
2420 @item delay
2421 Time in milliseconds of the delay of left signal into right and vice versa.
2422 Default is 20 milliseconds.
2423
2424 @item feedback
2425 Amount of gain in delayed signal into right and vice versa. Gives a delay
2426 effect of left signal in right output and vice versa which gives widening
2427 effect. Default is 0.3.
2428
2429 @item crossfeed
2430 Cross feed of left into right with inverted phase. This helps in suppressing
2431 the mono. If the value is 1 it will cancel all the signal common to both
2432 channels. Default is 0.3.
2433
2434 @item drymix
2435 Set level of input signal of original channel. Default is 0.8.
2436 @end table
2437
2438 @section treble
2439
2440 Boost or cut treble (upper) frequencies of the audio using a two-pole
2441 shelving filter with a response similar to that of a standard
2442 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
2443
2444 The filter accepts the following options:
2445
2446 @table @option
2447 @item gain, g
2448 Give the gain at whichever is the lower of ~22 kHz and the
2449 Nyquist frequency. Its useful range is about -20 (for a large cut)
2450 to +20 (for a large boost). Beware of clipping when using a positive gain.
2451
2452 @item frequency, f
2453 Set the filter's central frequency and so can be used
2454 to extend or reduce the frequency range to be boosted or cut.
2455 The default value is @code{3000} Hz.
2456
2457 @item width_type
2458 Set method to specify band-width of filter.
2459 @table @option
2460 @item h
2461 Hz
2462 @item q
2463 Q-Factor
2464 @item o
2465 octave
2466 @item s
2467 slope
2468 @end table
2469
2470 @item width, w
2471 Determine how steep is the filter's shelf transition.
2472 @end table
2473
2474 @section volume
2475
2476 Adjust the input audio volume.
2477
2478 It accepts the following parameters:
2479 @table @option
2480
2481 @item volume
2482 Set audio volume expression.
2483
2484 Output values are clipped to the maximum value.
2485
2486 The output audio volume is given by the relation:
2487 @example
2488 @var{output_volume} = @var{volume} * @var{input_volume}
2489 @end example
2490
2491 The default value for @var{volume} is "1.0".
2492
2493 @item precision
2494 This parameter represents the mathematical precision.
2495
2496 It determines which input sample formats will be allowed, which affects the
2497 precision of the volume scaling.
2498
2499 @table @option
2500 @item fixed
2501 8-bit fixed-point; this limits input sample format to U8, S16, and S32.
2502 @item float
2503 32-bit floating-point; this limits input sample format to FLT. (default)
2504 @item double
2505 64-bit floating-point; this limits input sample format to DBL.
2506 @end table
2507
2508 @item replaygain
2509 Choose the behaviour on encountering ReplayGain side data in input frames.
2510
2511 @table @option
2512 @item drop
2513 Remove ReplayGain side data, ignoring its contents (the default).
2514
2515 @item ignore
2516 Ignore ReplayGain side data, but leave it in the frame.
2517
2518 @item track
2519 Prefer the track gain, if present.
2520
2521 @item album
2522 Prefer the album gain, if present.
2523 @end table
2524
2525 @item replaygain_preamp
2526 Pre-amplification gain in dB to apply to the selected replaygain gain.
2527
2528 Default value for @var{replaygain_preamp} is 0.0.
2529
2530 @item eval
2531 Set when the volume expression is evaluated.
2532
2533 It accepts the following values:
2534 @table @samp
2535 @item once
2536 only evaluate expression once during the filter initialization, or
2537 when the @samp{volume} command is sent
2538
2539 @item frame
2540 evaluate expression for each incoming frame
2541 @end table
2542
2543 Default value is @samp{once}.
2544 @end table
2545
2546 The volume expression can contain the following parameters.
2547
2548 @table @option
2549 @item n
2550 frame number (starting at zero)
2551 @item nb_channels
2552 number of channels
2553 @item nb_consumed_samples
2554 number of samples consumed by the filter
2555 @item nb_samples
2556 number of samples in the current frame
2557 @item pos
2558 original frame position in the file
2559 @item pts
2560 frame PTS
2561 @item sample_rate
2562 sample rate
2563 @item startpts
2564 PTS at start of stream
2565 @item startt
2566 time at start of stream
2567 @item t
2568 frame time
2569 @item tb
2570 timestamp timebase
2571 @item volume
2572 last set volume value
2573 @end table
2574
2575 Note that when @option{eval} is set to @samp{once} only the
2576 @var{sample_rate} and @var{tb} variables are available, all other
2577 variables will evaluate to NAN.
2578
2579 @subsection Commands
2580
2581 This filter supports the following commands:
2582 @table @option
2583 @item volume
2584 Modify the volume expression.
2585 The command accepts the same syntax of the corresponding option.
2586
2587 If the specified expression is not valid, it is kept at its current
2588 value.
2589 @item replaygain_noclip
2590 Prevent clipping by limiting the gain applied.
2591
2592 Default value for @var{replaygain_noclip} is 1.
2593
2594 @end table
2595
2596 @subsection Examples
2597
2598 @itemize
2599 @item
2600 Halve the input audio volume:
2601 @example
2602 volume=volume=0.5
2603 volume=volume=1/2
2604 volume=volume=-6.0206dB
2605 @end example
2606
2607 In all the above example the named key for @option{volume} can be
2608 omitted, for example like in:
2609 @example
2610 volume=0.5
2611 @end example
2612
2613 @item
2614 Increase input audio power by 6 decibels using fixed-point precision:
2615 @example
2616 volume=volume=6dB:precision=fixed
2617 @end example
2618
2619 @item
2620 Fade volume after time 10 with an annihilation period of 5 seconds:
2621 @example
2622 volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
2623 @end example
2624 @end itemize
2625
2626 @section volumedetect
2627
2628 Detect the volume of the input video.
2629
2630 The filter has no parameters. The input is not modified. Statistics about
2631 the volume will be printed in the log when the input stream end is reached.
2632
2633 In particular it will show the mean volume (root mean square), maximum
2634 volume (on a per-sample basis), and the beginning of a histogram of the
2635 registered volume values (from the maximum value to a cumulated 1/1000 of
2636 the samples).
2637
2638 All volumes are in decibels relative to the maximum PCM value.
2639
2640 @subsection Examples
2641
2642 Here is an excerpt of the output:
2643 @example
2644 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
2645 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
2646 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
2647 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
2648 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
2649 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
2650 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
2651 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
2652 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
2653 @end example
2654
2655 It means that:
2656 @itemize
2657 @item
2658 The mean square energy is approximately -27 dB, or 10^-2.7.
2659 @item
2660 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
2661 @item
2662 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
2663 @end itemize
2664
2665 In other words, raising the volume by +4 dB does not cause any clipping,
2666 raising it by +5 dB causes clipping for 6 samples, etc.
2667
2668 @c man end AUDIO FILTERS
2669
2670 @chapter Audio Sources
2671 @c man begin AUDIO SOURCES
2672
2673 Below is a description of the currently available audio sources.
2674
2675 @section abuffer
2676
2677 Buffer audio frames, and make them available to the filter chain.
2678
2679 This source is mainly intended for a programmatic use, in particular
2680 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
2681
2682 It accepts the following parameters:
2683 @table @option
2684
2685 @item time_base
2686 The timebase which will be used for timestamps of submitted frames. It must be
2687 either a floating-point number or in @var{numerator}/@var{denominator} form.
2688
2689 @item sample_rate
2690 The sample rate of the incoming audio buffers.
2691
2692 @item sample_fmt
2693 The sample format of the incoming audio buffers.
2694 Either a sample format name or its corresponding integer representation from
2695 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
2696
2697 @item channel_layout
2698 The channel layout of the incoming audio buffers.
2699 Either a channel layout name from channel_layout_map in
2700 @file{libavutil/channel_layout.c} or its corresponding integer representation
2701 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
2702
2703 @item channels
2704 The number of channels of the incoming audio buffers.
2705 If both @var{channels} and @var{channel_layout} are specified, then they
2706 must be consistent.
2707
2708 @end table
2709
2710 @subsection Examples
2711
2712 @example
2713 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
2714 @end example
2715
2716 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
2717 Since the sample format with name "s16p" corresponds to the number
2718 6 and the "stereo" channel layout corresponds to the value 0x3, this is
2719 equivalent to:
2720 @example
2721 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
2722 @end example
2723
2724 @section aevalsrc
2725
2726 Generate an audio signal specified by an expression.
2727
2728 This source accepts in input one or more expressions (one for each
2729 channel), which are evaluated and used to generate a corresponding
2730 audio signal.
2731
2732 This source accepts the following options:
2733
2734 @table @option
2735 @item exprs
2736 Set the '|'-separated expressions list for each separate channel. In case the
2737 @option{channel_layout} option is not specified, the selected channel layout
2738 depends on the number of provided expressions. Otherwise the last
2739 specified expression is applied to the remaining output channels.
2740
2741 @item channel_layout, c
2742 Set the channel layout. The number of channels in the specified layout
2743 must be equal to the number of specified expressions.
2744
2745 @item duration, d
2746 Set the minimum duration of the sourced audio. See
2747 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
2748 for the accepted syntax.
2749 Note that the resulting duration may be greater than the specified
2750 duration, as the generated audio is always cut at the end of a
2751 complete frame.
2752
2753 If not specified, or the expressed duration is negative, the audio is
2754 supposed to be generated forever.
2755
2756 @item nb_samples, n
2757 Set the number of samples per channel per each output frame,
2758 default to 1024.
2759
2760 @item sample_rate, s
2761 Specify the sample rate, default to 44100.
2762 @end table
2763
2764 Each expression in @var{exprs} can contain the following constants:
2765
2766 @table @option
2767 @item n
2768 number of the evaluated sample, starting from 0
2769
2770 @item t
2771 time of the evaluated sample expressed in seconds, starting from 0
2772
2773 @item s
2774 sample rate
2775
2776 @end table
2777
2778 @subsection Examples
2779
2780 @itemize
2781 @item
2782 Generate silence:
2783 @example
2784 aevalsrc=0
2785 @end example
2786
2787 @item
2788 Generate a sin signal with frequency of 440 Hz, set sample rate to
2789 8000 Hz:
2790 @example
2791 aevalsrc="sin(440*2*PI*t):s=8000"
2792 @end example
2793
2794 @item
2795 Generate a two channels signal, specify the channel layout (Front
2796 Center + Back Center) explicitly:
2797 @example
2798 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
2799 @end example
2800
2801 @item
2802 Generate white noise:
2803 @example
2804 aevalsrc="-2+random(0)"
2805 @end example
2806
2807 @item
2808 Generate an amplitude modulated signal:
2809 @example
2810 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
2811 @end example
2812
2813 @item
2814 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
2815 @example
2816 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
2817 @end example
2818
2819 @end itemize
2820
2821 @section anullsrc
2822
2823 The null audio source, return unprocessed audio frames. It is mainly useful
2824 as a template and to be employed in analysis / debugging tools, or as
2825 the source for filters which ignore the input data (for example the sox
2826 synth filter).
2827
2828 This source accepts the following options:
2829
2830 @table @option
2831
2832 @item channel_layout, cl
2833
2834 Specifies the channel layout, and can be either an integer or a string
2835 representing a channel layout. The default value of @var{channel_layout}
2836 is "stereo".
2837
2838 Check the channel_layout_map definition in
2839 @file{libavutil/channel_layout.c} for the mapping between strings and
2840 channel layout values.
2841
2842 @item sample_rate, r
2843 Specifies the sample rate, and defaults to 44100.
2844
2845 @item nb_samples, n
2846 Set the number of samples per requested frames.
2847
2848 @end table
2849
2850 @subsection Examples
2851
2852 @itemize
2853 @item
2854 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
2855 @example
2856 anullsrc=r=48000:cl=4
2857 @end example
2858
2859 @item
2860 Do the same operation with a more obvious syntax:
2861 @example
2862 anullsrc=r=48000:cl=mono
2863 @end example
2864 @end itemize
2865
2866 All the parameters need to be explicitly defined.
2867
2868 @section flite
2869
2870 Synthesize a voice utterance using the libflite library.
2871
2872 To enable compilation of this filter you need to configure FFmpeg with
2873 @code{--enable-libflite}.
2874
2875 Note that the flite library is not thread-safe.
2876
2877 The filter accepts the following options:
2878
2879 @table @option
2880
2881 @item list_voices
2882 If set to 1, list the names of the available voices and exit
2883 immediately. Default value is 0.
2884
2885 @item nb_samples, n
2886 Set the maximum number of samples per frame. Default value is 512.
2887
2888 @item textfile
2889 Set the filename containing the text to speak.
2890
2891 @item text
2892 Set the text to speak.
2893
2894 @item voice, v
2895 Set the voice to use for the speech synthesis. Default value is
2896 @code{kal}. See also the @var{list_voices} option.
2897 @end table
2898
2899 @subsection Examples
2900
2901 @itemize
2902 @item
2903 Read from file @file{speech.txt}, and synthesize the text using the
2904 standard flite voice:
2905 @example
2906 flite=textfile=speech.txt
2907 @end example
2908
2909 @item
2910 Read the specified text selecting the @code{slt} voice:
2911 @example
2912 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
2913 @end example
2914
2915 @item
2916 Input text to ffmpeg:
2917 @example
2918 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
2919 @end example
2920
2921 @item
2922 Make @file{ffplay} speak the specified text, using @code{flite} and
2923 the @code{lavfi} device:
2924 @example
2925 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
2926 @end example
2927 @end itemize
2928
2929 For more information about libflite, check:
2930 @url{http://www.speech.cs.cmu.edu/flite/}
2931
2932 @section sine
2933
2934 Generate an audio signal made of a sine wave with amplitude 1/8.
2935
2936 The audio signal is bit-exact.
2937
2938 The filter accepts the following options:
2939
2940 @table @option
2941
2942 @item frequency, f
2943 Set the carrier frequency. Default is 440 Hz.
2944
2945 @item beep_factor, b
2946 Enable a periodic beep every second with frequency @var{beep_factor} times
2947 the carrier frequency. Default is 0, meaning the beep is disabled.
2948
2949 @item sample_rate, r
2950 Specify the sample rate, default is 44100.
2951
2952 @item duration, d
2953 Specify the duration of the generated audio stream.
2954
2955 @item samples_per_frame
2956 Set the number of samples per output frame.
2957
2958 The expression can contain the following constants:
2959
2960 @table @option
2961 @item n
2962 The (sequential) number of the output audio frame, starting from 0.
2963
2964 @item pts
2965 The PTS (Presentation TimeStamp) of the output audio frame,
2966 expressed in @var{TB} units.
2967
2968 @item t
2969 The PTS of the output audio frame, expressed in seconds.
2970
2971 @item TB
2972 The timebase of the output audio frames.
2973 @end table
2974
2975 Default is @code{1024}.
2976 @end table
2977
2978 @subsection Examples
2979
2980 @itemize
2981
2982 @item
2983 Generate a simple 440 Hz sine wave:
2984 @example
2985 sine
2986 @end example
2987
2988 @item
2989 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
2990 @example
2991 sine=220:4:d=5
2992 sine=f=220:b=4:d=5
2993 sine=frequency=220:beep_factor=4:duration=5
2994 @end example
2995
2996 @item
2997 Generate a 1 kHz sine wave following @code{1602,1601,1602,1601,1602} NTSC
2998 pattern:
2999 @example
3000 sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
3001 @end example
3002 @end itemize
3003
3004 @c man end AUDIO SOURCES
3005
3006 @chapter Audio Sinks
3007 @c man begin AUDIO SINKS
3008
3009 Below is a description of the currently available audio sinks.
3010
3011 @section abuffersink
3012
3013 Buffer audio frames, and make them available to the end of filter chain.
3014
3015 This sink is mainly intended for programmatic use, in particular
3016 through the interface defined in @file{libavfilter/buffersink.h}
3017 or the options system.
3018
3019 It accepts a pointer to an AVABufferSinkContext structure, which
3020 defines the incoming buffers' formats, to be passed as the opaque
3021 parameter to @code{avfilter_init_filter} for initialization.
3022 @section anullsink
3023
3024 Null audio sink; do absolutely nothing with the input audio. It is
3025 mainly useful as a template and for use in analysis / debugging
3026 tools.
3027
3028 @c man end AUDIO SINKS
3029
3030 @chapter Video Filters
3031 @c man begin VIDEO FILTERS
3032
3033 When you configure your FFmpeg build, you can disable any of the
3034 existing filters using @code{--disable-filters}.
3035 The configure output will show the video filters included in your
3036 build.
3037
3038 Below is a description of the currently available video filters.
3039
3040 @section alphaextract
3041
3042 Extract the alpha component from the input as a grayscale video. This
3043 is especially useful with the @var{alphamerge} filter.
3044
3045 @section alphamerge
3046
3047 Add or replace the alpha component of the primary input with the
3048 grayscale value of a second input. This is intended for use with
3049 @var{alphaextract} to allow the transmission or storage of frame
3050 sequences that have alpha in a format that doesn't support an alpha
3051 channel.
3052
3053 For example, to reconstruct full frames from a normal YUV-encoded video
3054 and a separate video created with @var{alphaextract}, you might use:
3055 @example
3056 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
3057 @end example
3058
3059 Since this filter is designed for reconstruction, it operates on frame
3060 sequences without considering timestamps, and terminates when either
3061 input reaches end of stream. This will cause problems if your encoding
3062 pipeline drops frames. If you're trying to apply an image as an
3063 overlay to a video stream, consider the @var{overlay} filter instead.
3064
3065 @section ass
3066
3067 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
3068 and libavformat to work. On the other hand, it is limited to ASS (Advanced
3069 Substation Alpha) subtitles files.
3070
3071 This filter accepts the following option in addition to the common options from
3072 the @ref{subtitles} filter:
3073
3074 @table @option
3075 @item shaping
3076 Set the shaping engine
3077
3078 Available values are:
3079 @table @samp
3080 @item auto
3081 The default libass shaping engine, which is the best available.
3082 @item simple
3083 Fast, font-agnostic shaper that can do only substitutions
3084 @item complex
3085 Slower shaper using OpenType for substitutions and positioning
3086 @end table
3087
3088 The default is @code{auto}.
3089 @end table
3090
3091 @section atadenoise
3092 Apply an Adaptive Temporal Averaging Denoiser to the video input.
3093
3094 The filter accepts the following options:
3095
3096 @table @option
3097 @item 0a
3098 Set threshold A for 1st plane. Default is 0.02.
3099 Valid range is 0 to 0.3.
3100
3101 @item 0b
3102 Set threshold B for 1st plane. Default is 0.04.
3103 Valid range is 0 to 5.
3104
3105 @item 1a
3106 Set threshold A for 2nd plane. Default is 0.02.
3107 Valid range is 0 to 0.3.
3108
3109 @item 1b
3110 Set threshold B for 2nd plane. Default is 0.04.
3111 Valid range is 0 to 5.
3112
3113 @item 2a
3114 Set threshold A for 3rd plane. Default is 0.02.
3115 Valid range is 0 to 0.3.
3116
3117 @item 2b
3118 Set threshold B for 3rd plane. Default is 0.04.
3119 Valid range is 0 to 5.
3120
3121 Threshold A is designed to react on abrupt changes in the input signal and
3122 threshold B is designed to react on continuous changes in the input signal.
3123
3124 @item s
3125 Set number of frames filter will use for averaging. Default is 33. Must be odd
3126 number in range [5, 129].
3127 @end table
3128
3129 @section bbox
3130
3131 Compute the bounding box for the non-black pixels in the input frame
3132 luminance plane.
3133
3134 This filter computes the bounding box containing all the pixels with a
3135 luminance value greater than the minimum allowed value.
3136 The parameters describing the bounding box are printed on the filter
3137 log.
3138
3139 The filter accepts the following option:
3140
3141 @table @option
3142 @item min_val
3143 Set the minimal luminance value. Default is @code{16}.
3144 @end table
3145
3146 @section blackdetect
3147
3148 Detect video intervals that are (almost) completely black. Can be
3149 useful to detect chapter transitions, commercials, or invalid
3150 recordings. Output lines contains the time for the start, end and
3151 duration of the detected black interval expressed in seconds.
3152
3153 In order to display the output lines, you need to set the loglevel at
3154 least to the AV_LOG_INFO value.
3155
3156 The filter accepts the following options:
3157
3158 @table @option
3159 @item black_min_duration, d
3160 Set the minimum detected black duration expressed in seconds. It must
3161 be a non-negative floating point number.
3162
3163 Default value is 2.0.
3164
3165 @item picture_black_ratio_th, pic_th
3166 Set the threshold for considering a picture "black".
3167 Express the minimum value for the ratio:
3168 @example
3169 @var{nb_black_pixels} / @var{nb_pixels}
3170 @end example
3171
3172 for which a picture is considered black.
3173 Default value is 0.98.
3174
3175 @item pixel_black_th, pix_th
3176 Set the threshold for considering a pixel "black".
3177
3178 The threshold expresses the maximum pixel luminance value for which a
3179 pixel is considered "black". The provided value is scaled according to
3180 the following equation:
3181 @example
3182 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
3183 @end example
3184
3185 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
3186 the input video format, the range is [0-255] for YUV full-range
3187 formats and [16-235] for YUV non full-range formats.
3188
3189 Default value is 0.10.
3190 @end table
3191
3192 The following example sets the maximum pixel threshold to the minimum
3193 value, and detects only black intervals of 2 or more seconds:
3194 @example
3195 blackdetect=d=2:pix_th=0.00
3196 @end example
3197
3198 @section blackframe
3199
3200 Detect frames that are (almost) completely black. Can be useful to
3201 detect chapter transitions or commercials. Output lines consist of
3202 the frame number of the detected frame, the percentage of blackness,
3203 the position in the file if known or -1 and the timestamp in seconds.
3204
3205 In order to display the output lines, you need to set the loglevel at
3206 least to the AV_LOG_INFO value.
3207
3208 It accepts the following parameters:
3209
3210 @table @option
3211
3212 @item amount
3213 The percentage of the pixels that have to be below the threshold; it defaults to
3214 @code{98}.
3215
3216 @item threshold, thresh
3217 The threshold below which a pixel value is considered black; it defaults to
3218 @code{32}.
3219
3220 @end table
3221
3222 @section blend, tblend
3223
3224 Blend two video frames into each other.
3225
3226 The @code{blend} filter takes two input streams and outputs one
3227 stream, the first input is the "top" layer and second input is
3228 "bottom" layer.  Output terminates when shortest input terminates.
3229
3230 The @code{tblend} (time blend) filter takes two consecutive frames
3231 from one single stream, and outputs the result obtained by blending
3232 the new frame on top of the old frame.
3233
3234 A description of the accepted options follows.
3235
3236 @table @option
3237 @item c0_mode
3238 @item c1_mode
3239 @item c2_mode
3240 @item c3_mode
3241 @item all_mode
3242 Set blend mode for specific pixel component or all pixel components in case
3243 of @var{all_mode}. Default value is @code{normal}.
3244
3245 Available values for component modes are:
3246 @table @samp
3247 @item addition
3248 @item and
3249 @item average
3250 @item burn
3251 @item darken
3252 @item difference
3253 @item difference128
3254 @item divide
3255 @item dodge
3256 @item exclusion
3257 @item glow
3258 @item hardlight
3259 @item hardmix
3260 @item lighten
3261 @item linearlight
3262 @item multiply
3263 @item negation
3264 @item normal
3265 @item or
3266 @item overlay
3267 @item phoenix
3268 @item pinlight
3269 @item reflect
3270 @item screen
3271 @item softlight
3272 @item subtract
3273 @item vividlight
3274 @item xor
3275 @end table
3276
3277 @item c0_opacity
3278 @item c1_opacity
3279 @item c2_opacity
3280 @item c3_opacity
3281 @item all_opacity
3282 Set blend opacity for specific pixel component or all pixel components in case
3283 of @var{all_opacity}. Only used in combination with pixel component blend modes.
3284
3285 @item c0_expr
3286 @item c1_expr
3287 @item c2_expr
3288 @item c3_expr
3289 @item all_expr
3290 Set blend expression for specific pixel component or all pixel components in case
3291 of @var{all_expr}. Note that related mode options will be ignored if those are set.
3292
3293 The expressions can use the following variables:
3294
3295 @table @option
3296 @item N
3297 The sequential number of the filtered frame, starting from @code{0}.
3298
3299 @item X
3300 @item Y
3301 the coordinates of the current sample
3302
3303 @item W
3304 @item H
3305 the width and height of currently filtered plane
3306
3307 @item SW
3308 @item SH
3309 Width and height scale depending on the currently filtered plane. It is the
3310 ratio between the corresponding luma plane number of pixels and the current
3311 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
3312 @code{0.5,0.5} for chroma planes.
3313
3314 @item T
3315 Time of the current frame, expressed in seconds.
3316
3317 @item TOP, A
3318 Value of pixel component at current location for first video frame (top layer).
3319
3320 @item BOTTOM, B
3321 Value of pixel component at current location for second video frame (bottom layer).
3322 @end table
3323
3324 @item shortest
3325 Force termination when the shortest input terminates. Default is
3326 @code{0}. This option is only defined for the @code{blend} filter.
3327
3328 @item repeatlast
3329 Continue applying the last bottom frame after the end of the stream. A value of
3330 @code{0} disable the filter after the last frame of the bottom layer is reached.
3331 Default is @code{1}. This option is only defined for the @code{blend} filter.
3332 @end table
3333
3334 @subsection Examples
3335
3336 @itemize
3337 @item
3338 Apply transition from bottom layer to top layer in first 10 seconds:
3339 @example
3340 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
3341 @end example
3342
3343 @item
3344 Apply 1x1 checkerboard effect:
3345 @example
3346 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
3347 @end example
3348
3349 @item
3350 Apply uncover left effect:
3351 @example
3352 blend=all_expr='if(gte(N*SW+X,W),A,B)'
3353 @end example
3354
3355 @item
3356 Apply uncover down effect:
3357 @example
3358 blend=all_expr='if(gte(Y-N*SH,0),A,B)'
3359 @end example
3360
3361 @item
3362 Apply uncover up-left effect:
3363 @example
3364 blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
3365 @end example
3366
3367 @item
3368 Display differences between the current and the previous frame:
3369 @example
3370 tblend=all_mode=difference128
3371 @end example
3372 @end itemize
3373
3374 @section boxblur
3375
3376 Apply a boxblur algorithm to the input video.
3377
3378 It accepts the following parameters:
3379
3380 @table @option
3381
3382 @item luma_radius, lr
3383 @item luma_power, lp
3384 @item chroma_radius, cr
3385 @item chroma_power, cp
3386 @item alpha_radius, ar
3387 @item alpha_power, ap
3388
3389 @end table
3390
3391 A description of the accepted options follows.
3392
3393 @table @option
3394 @item luma_radius, lr
3395 @item chroma_radius, cr
3396 @item alpha_radius, ar
3397 Set an expression for the box radius in pixels used for blurring the
3398 corresponding input plane.
3399
3400 The radius value must be a non-negative number, and must not be
3401 greater than the value of the expression @code{min(w,h)/2} for the
3402 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
3403 planes.
3404
3405 Default value for @option{luma_radius} is "2". If not specified,
3406 @option{chroma_radius} and @option{alpha_radius} default to the
3407 corresponding value set for @option{luma_radius}.
3408
3409 The expressions can contain the following constants:
3410 @table @option
3411 @item w
3412 @item h
3413 The input width and height in pixels.
3414
3415 @item cw
3416 @item ch
3417 The input chroma image width and height in pixels.
3418
3419 @item hsub
3420 @item vsub
3421 The horizontal and vertical chroma subsample values. For example, for the
3422 pixel format "yuv422p", @var{hsub} is 2 and @var{vsub} is 1.
3423 @end table
3424
3425 @item luma_power, lp
3426 @item chroma_power, cp
3427 @item alpha_power, ap
3428 Specify how many times the boxblur filter is applied to the
3429 corresponding plane.
3430
3431 Default value for @option{luma_power} is 2. If not specified,
3432 @option{chroma_power} and @option{alpha_power} default to the
3433 corresponding value set for @option{luma_power}.
3434
3435 A value of 0 will disable the effect.
3436 @end table
3437
3438 @subsection Examples
3439
3440 @itemize
3441 @item
3442 Apply a boxblur filter with the luma, chroma, and alpha radii
3443 set to 2:
3444 @example
3445 boxblur=luma_radius=2:luma_power=1
3446 boxblur=2:1
3447 @end example
3448
3449 @item
3450 Set the luma radius to 2, and alpha and chroma radius to 0:
3451 @example
3452 boxblur=2:1:cr=0:ar=0
3453 @end example
3454
3455 @item
3456 Set the luma and chroma radii to a fraction of the video dimension:
3457 @example
3458 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
3459 @end example
3460 @end itemize
3461
3462 @section codecview
3463
3464 Visualize information exported by some codecs.
3465
3466 Some codecs can export information through frames using side-data or other
3467 means. For example, some MPEG based codecs export motion vectors through the
3468 @var{export_mvs} flag in the codec @option{flags2} option.
3469
3470 The filter accepts the following option:
3471
3472 @table @option
3473 @item mv
3474 Set motion vectors to visualize.
3475
3476 Available flags for @var{mv} are:
3477
3478 @table @samp
3479 @item pf
3480 forward predicted MVs of P-frames
3481 @item bf
3482 forward predicted MVs of B-frames
3483 @item bb
3484 backward predicted MVs of B-frames
3485 @end table
3486 @end table
3487
3488 @subsection Examples
3489
3490 @itemize
3491 @item
3492 Visualizes multi-directionals MVs from P and B-Frames using @command{ffplay}:
3493 @example
3494 ffplay -flags2 +export_mvs input.mpg -vf codecview=mv=pf+bf+bb
3495 @end example
3496 @end itemize
3497
3498 @section colorbalance
3499 Modify intensity of primary colors (red, green and blue) of input frames.
3500
3501 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
3502 regions for the red-cyan, green-magenta or blue-yellow balance.
3503
3504 A positive adjustment value shifts the balance towards the primary color, a negative
3505 value towards the complementary color.
3506
3507 The filter accepts the following options:
3508
3509 @table @option
3510 @item rs
3511 @item gs
3512 @item bs
3513 Adjust red, green and blue shadows (darkest pixels).
3514
3515 @item rm
3516 @item gm
3517 @item bm
3518 Adjust red, green and blue midtones (medium pixels).
3519
3520 @item rh
3521 @item gh
3522 @item bh
3523 Adjust red, green and blue highlights (brightest pixels).
3524
3525 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3526 @end table
3527
3528 @subsection Examples
3529
3530 @itemize
3531 @item
3532 Add red color cast to shadows:
3533 @example
3534 colorbalance=rs=.3
3535 @end example
3536 @end itemize
3537
3538 @section colorkey
3539 RGB colorspace color keying.
3540
3541 The filter accepts the following options:
3542
3543 @table @option
3544 @item color
3545 The color which will be replaced with transparency.
3546
3547 @item similarity
3548 Similarity percentage with the key color.
3549
3550 0.01 matches only the exact key color, while 1.0 matches everything.
3551
3552 @item blend
3553 Blend percentage.
3554
3555 0.0 makes pixels either fully transparent, or not transparent at all.
3556
3557 Higher values result in semi-transparent pixels, with a higher transparency
3558 the more similar the pixels color is to the key color.
3559 @end table
3560
3561 @subsection Examples
3562
3563 @itemize
3564 @item
3565 Make every green pixel in the input image transparent:
3566 @example
3567 ffmpeg -i input.png -vf colorkey=green out.png
3568 @end example
3569
3570 @item
3571 Overlay a greenscreen-video on top of a static background image.
3572 @example
3573 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
3574 @end example
3575 @end itemize
3576
3577 @section colorlevels
3578
3579 Adjust video input frames using levels.
3580
3581 The filter accepts the following options:
3582
3583 @table @option
3584 @item rimin
3585 @item gimin
3586 @item bimin
3587 @item aimin
3588 Adjust red, green, blue and alpha input black point.
3589 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3590
3591 @item rimax
3592 @item gimax
3593 @item bimax
3594 @item aimax
3595 Adjust red, green, blue and alpha input white point.
3596 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{1}.
3597
3598 Input levels are used to lighten highlights (bright tones), darken shadows
3599 (dark tones), change the balance of bright and dark tones.
3600
3601 @item romin
3602 @item gomin
3603 @item bomin
3604 @item aomin
3605 Adjust red, green, blue and alpha output black point.
3606 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{0}.
3607
3608 @item romax
3609 @item gomax
3610 @item bomax
3611 @item aomax
3612 Adjust red, green, blue and alpha output white point.
3613 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{1}.
3614
3615 Output levels allows manual selection of a constrained output level range.
3616 @end table
3617
3618 @subsection Examples
3619
3620 @itemize
3621 @item
3622 Make video output darker:
3623 @example
3624 colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
3625 @end example
3626
3627 @item
3628 Increase contrast:
3629 @example
3630 colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
3631 @end example
3632
3633 @item
3634 Make video output lighter:
3635 @example
3636 colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
3637 @end example
3638
3639 @item
3640 Increase brightness:
3641 @example
3642 colorlevels=romin=0.5:gomin=0.5:bomin=0.5
3643 @end example
3644 @end itemize
3645
3646 @section colorchannelmixer
3647
3648 Adjust video input frames by re-mixing color channels.
3649
3650 This filter modifies a color channel by adding the values associated to
3651 the other channels of the same pixels. For example if the value to
3652 modify is red, the output value will be:
3653 @example
3654 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
3655 @end example
3656
3657 The filter accepts the following options:
3658
3659 @table @option
3660 @item rr
3661 @item rg
3662 @item rb
3663 @item ra
3664 Adjust contribution of input red, green, blue and alpha channels for output red channel.
3665 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
3666
3667 @item gr
3668 @item gg
3669 @item gb
3670 @item ga
3671 Adjust contribution of input red, green, blue and alpha channels for output green channel.
3672 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
3673
3674 @item br
3675 @item bg
3676 @item bb
3677 @item ba
3678 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
3679 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
3680
3681 @item ar
3682 @item ag
3683 @item ab
3684 @item aa
3685 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
3686 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
3687
3688 Allowed ranges for options are @code{[-2.0, 2.0]}.
3689 @end table
3690
3691 @subsection Examples
3692
3693 @itemize
3694 @item
3695 Convert source to grayscale:
3696 @example
3697 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
3698 @end example
3699 @item
3700 Simulate sepia tones:
3701 @example
3702 colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
3703 @end example
3704 @end itemize
3705
3706 @section colormatrix
3707
3708 Convert color matrix.
3709
3710 The filter accepts the following options:
3711
3712 @table @option
3713 @item src
3714 @item dst
3715 Specify the source and destination color matrix. Both values must be
3716 specified.
3717
3718 The accepted values are:
3719 @table @samp
3720 @item bt709
3721 BT.709
3722
3723 @item bt601
3724 BT.601
3725
3726 @item smpte240m
3727 SMPTE-240M
3728
3729 @item fcc
3730 FCC
3731 @end table
3732 @end table
3733
3734 For example to convert from BT.601 to SMPTE-240M, use the command:
3735 @example
3736 colormatrix=bt601:smpte240m
3737 @end example
3738
3739 @section copy
3740
3741 Copy the input source unchanged to the output. This is mainly useful for
3742 testing purposes.
3743
3744 @section crop
3745
3746 Crop the input video to given dimensions.
3747
3748 It accepts the following parameters:
3749
3750 @table @option
3751 @item w, out_w
3752 The width of the output video. It defaults to @code{iw}.
3753 This expression is evaluated only once during the filter
3754 configuration, or when the @samp{w} or @samp{out_w} command is sent.
3755
3756 @item h, out_h
3757 The height of the output video. It defaults to @code{ih}.
3758 This expression is evaluated only once during the filter
3759 configuration, or when the @samp{h} or @samp{out_h} command is sent.
3760
3761 @item x
3762 The horizontal position, in the input video, of the left edge of the output
3763 video. It defaults to @code{(in_w-out_w)/2}.
3764 This expression is evaluated per-frame.
3765
3766 @item y
3767 The vertical position, in the input video, of the top edge of the output video.
3768 It defaults to @code{(in_h-out_h)/2}.
3769 This expression is evaluated per-frame.
3770
3771 @item keep_aspect
3772 If set to 1 will force the output display aspect ratio
3773 to be the same of the input, by changing the output sample aspect
3774 ratio. It defaults to 0.
3775 @end table
3776
3777 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
3778 expressions containing the following constants:
3779
3780 @table @option
3781 @item x
3782 @item y
3783 The computed values for @var{x} and @var{y}. They are evaluated for
3784 each new frame.
3785
3786 @item in_w
3787 @item in_h
3788 The input width and height.
3789
3790 @item iw
3791 @item ih
3792 These are the same as @var{in_w} and @var{in_h}.
3793
3794 @item out_w
3795 @item out_h
3796 The output (cropped) width and height.
3797
3798 @item ow
3799 @item oh
3800 These are the same as @var{out_w} and @var{out_h}.
3801
3802 @item a
3803 same as @var{iw} / @var{ih}
3804
3805 @item sar
3806 input sample aspect ratio
3807
3808 @item dar
3809 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
3810
3811 @item hsub
3812 @item vsub
3813 horizontal and vertical chroma subsample values. For example for the
3814 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3815
3816 @item n
3817 The number of the input frame, starting from 0.
3818
3819 @item pos
3820 the position in the file of the input frame, NAN if unknown
3821
3822 @item t
3823 The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
3824
3825 @end table
3826
3827 The expression for @var{out_w} may depend on the value of @var{out_h},
3828 and the expression for @var{out_h} may depend on @var{out_w}, but they
3829 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
3830 evaluated after @var{out_w} and @var{out_h}.
3831
3832 The @var{x} and @var{y} parameters specify the expressions for the
3833 position of the top-left corner of the output (non-cropped) area. They
3834 are evaluated for each frame. If the evaluated value is not valid, it
3835 is approximated to the nearest valid value.
3836
3837 The expression for @var{x} may depend on @var{y}, and the expression
3838 for @var{y} may depend on @var{x}.
3839
3840 @subsection Examples
3841
3842 @itemize
3843 @item
3844 Crop area with size 100x100 at position (12,34).
3845 @example
3846 crop=100:100:12:34
3847 @end example
3848
3849 Using named options, the example above becomes:
3850 @example
3851 crop=w=100:h=100:x=12:y=34
3852 @end example
3853
3854 @item
3855 Crop the central input area with size 100x100:
3856 @example
3857 crop=100:100
3858 @end example
3859
3860 @item
3861 Crop the central input area with size 2/3 of the input video:
3862 @example
3863 crop=2/3*in_w:2/3*in_h
3864 @end example
3865
3866 @item
3867 Crop the input video central square:
3868 @example
3869 crop=out_w=in_h
3870 crop=in_h
3871 @end example
3872
3873 @item
3874 Delimit the rectangle with the top-left corner placed at position
3875 100:100 and the right-bottom corner corresponding to the right-bottom
3876 corner of the input image.
3877 @example
3878 crop=in_w-100:in_h-100:100:100
3879 @end example
3880
3881 @item
3882 Crop 10 pixels from the left and right borders, and 20 pixels from
3883 the top and bottom borders
3884 @example
3885 crop=in_w-2*10:in_h-2*20
3886 @end example
3887
3888 @item
3889 Keep only the bottom right quarter of the input image:
3890 @example
3891 crop=in_w/2:in_h/2:in_w/2:in_h/2
3892 @end example
3893
3894 @item
3895 Crop height for getting Greek harmony:
3896 @example
3897 crop=in_w:1/PHI*in_w
3898 @end example
3899
3900 @item
3901 Apply trembling effect:
3902 @example
3903 crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)
3904 @end example
3905
3906 @item
3907 Apply erratic camera effect depending on timestamp:
3908 @example
3909 crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
3910 @end example
3911
3912 @item
3913 Set x depending on the value of y:
3914 @example
3915 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
3916 @end example
3917 @end itemize
3918
3919 @subsection Commands
3920
3921 This filter supports the following commands:
3922 @table @option
3923 @item w, out_w
3924 @item h, out_h
3925 @item x
3926 @item y
3927 Set width/height of the output video and the horizontal/vertical position
3928 in the input video.
3929 The command accepts the same syntax of the corresponding option.
3930
3931 If the specified expression is not valid, it is kept at its current
3932 value.
3933 @end table
3934
3935 @section cropdetect
3936
3937 Auto-detect the crop size.
3938
3939 It calculates the necessary cropping parameters and prints the
3940 recommended parameters via the logging system. The detected dimensions
3941 correspond to the non-black area of the input video.
3942
3943 It accepts the following parameters:
3944
3945 @table @option
3946
3947 @item limit
3948 Set higher black value threshold, which can be optionally specified
3949 from nothing (0) to everything (255 for 8bit based formats). An intensity
3950 value greater to the set value is considered non-black. It defaults to 24.
3951 You can also specify a value between 0.0 and 1.0 which will be scaled depending
3952 on the bitdepth of the pixel format.
3953
3954 @item round
3955 The value which the width/height should be divisible by. It defaults to
3956 16. The offset is automatically adjusted to center the video. Use 2 to
3957 get only even dimensions (needed for 4:2:2 video). 16 is best when
3958 encoding to most video codecs.
3959
3960 @item reset_count, reset
3961 Set the counter that determines after how many frames cropdetect will
3962 reset the previously detected largest video area and start over to
3963 detect the current optimal crop area. Default value is 0.
3964
3965 This can be useful when channel logos distort the video area. 0
3966 indicates 'never reset', and returns the largest area encountered during
3967 playback.
3968 @end table
3969
3970 @anchor{curves}
3971 @section curves
3972
3973 Apply color adjustments using curves.
3974
3975 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
3976 component (red, green and blue) has its values defined by @var{N} key points
3977 tied from each other using a smooth curve. The x-axis represents the pixel
3978 values from the input frame, and the y-axis the new pixel values to be set for
3979 the output frame.
3980
3981 By default, a component curve is defined by the two points @var{(0;0)} and
3982 @var{(1;1)}. This creates a straight line where each original pixel value is
3983 "adjusted" to its own value, which means no change to the image.
3984
3985 The filter allows you to redefine these two points and add some more. A new
3986 curve (using a natural cubic spline interpolation) will be define to pass
3987 smoothly through all these new coordinates. The new defined points needs to be
3988 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
3989 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
3990 the vector spaces, the values will be clipped accordingly.
3991
3992 If there is no key point defined in @code{x=0}, the filter will automatically
3993 insert a @var{(0;0)} point. In the same way, if there is no key point defined
3994 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
3995
3996 The filter accepts the following options:
3997
3998 @table @option
3999 @item preset
4000 Select one of the available color presets. This option can be used in addition
4001 to the @option{r}, @option{g}, @option{b} parameters; in this case, the later
4002 options takes priority on the preset values.
4003 Available presets are:
4004 @table @samp
4005 @item none
4006 @item color_negative
4007 @item cross_process
4008 @item darker
4009 @item increase_contrast
4010 @item lighter
4011 @item linear_contrast
4012 @item medium_contrast
4013 @item negative
4014 @item strong_contrast
4015 @item vintage
4016 @end table
4017 Default is @code{none}.
4018 @item master, m
4019 Set the master key points. These points will define a second pass mapping. It
4020 is sometimes called a "luminance" or "value" mapping. It can be used with
4021 @option{r}, @option{g}, @option{b} or @option{all} since it acts like a
4022 post-processing LUT.
4023 @item red, r
4024 Set the key points for the red component.
4025 @item green, g
4026 Set the key points for the green component.
4027 @item blue, b
4028 Set the key points for the blue component.
4029 @item all
4030 Set the key points for all components (not including master).
4031 Can be used in addition to the other key points component
4032 options. In this case, the unset component(s) will fallback on this
4033 @option{all} setting.
4034 @item psfile
4035 Specify a Photoshop curves file (@code{.acv}) to import the settings from.
4036 @end table
4037
4038 To avoid some filtergraph syntax conflicts, each key points list need to be
4039 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
4040
4041 @subsection Examples
4042
4043 @itemize
4044 @item
4045 Increase slightly the middle level of blue:
4046 @example
4047 curves=blue='0.5/0.58'
4048 @end example
4049
4050 @item
4051 Vintage effect:
4052 @example
4053 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
4054 @end example
4055 Here we obtain the following coordinates for each components:
4056 @table @var
4057 @item red
4058 @code{(0;0.11) (0.42;0.51) (1;0.95)}
4059 @item green
4060 @code{(0;0) (0.50;0.48) (1;1)}
4061 @item blue
4062 @code{(0;0.22) (0.49;0.44) (1;0.80)}
4063 @end table
4064
4065 @item
4066 The previous example can also be achieved with the associated built-in preset:
4067 @example
4068 curves=preset=vintage
4069 @end example
4070
4071 @item
4072 Or simply:
4073 @example
4074 curves=vintage
4075 @end example
4076
4077 @item
4078 Use a Photoshop preset and redefine the points of the green component:
4079 @example
4080 curves=psfile='MyCurvesPresets/purple.acv':green='0.45/0.53'
4081 @end example
4082 @end itemize
4083
4084 @section dctdnoiz
4085
4086 Denoise frames using 2D DCT (frequency domain filtering).
4087
4088 This filter is not designed for real time.
4089
4090 The filter accepts the following options:
4091
4092 @table @option
4093 @item sigma, s
4094 Set the noise sigma constant.
4095
4096 This @var{sigma} defines a hard threshold of @code{3 * sigma}; every DCT
4097 coefficient (absolute value) below this threshold with be dropped.
4098
4099 If you need a more advanced filtering, see @option{expr}.
4100
4101 Default is @code{0}.
4102
4103 @item overlap
4104 Set number overlapping pixels for each block. Since the filter can be slow, you
4105 may want to reduce this value, at the cost of a less effective filter and the
4106 risk of various artefacts.
4107
4108 If the overlapping value doesn't permit processing the whole input width or
4109 height, a warning will be displayed and according borders won't be denoised.
4110
4111 Default value is @var{blocksize}-1, which is the best possible setting.
4112
4113 @item expr, e
4114 Set the coefficient factor expression.
4115
4116 For each coefficient of a DCT block, this expression will be evaluated as a
4117 multiplier value for the coefficient.
4118
4119 If this is option is set, the @option{sigma} option will be ignored.
4120
4121 The absolute value of the coefficient can be accessed through the @var{c}
4122 variable.
4123
4124 @item n
4125 Set the @var{blocksize} using the number of bits. @code{1<<@var{n}} defines the
4126 @var{blocksize}, which is the width and height of the processed blocks.
4127
4128 The default value is @var{3} (8x8) and can be raised to @var{4} for a
4129 @var{blocksize} of 16x16. Note that changing this setting has huge consequences
4130 on the speed processing. Also, a larger block size does not necessarily means a
4131 better de-noising.
4132 @end table
4133
4134 @subsection Examples
4135
4136 Apply a denoise with a @option{sigma} of @code{4.5}:
4137 @example
4138 dctdnoiz=4.5
4139 @end example
4140
4141 The same operation can be achieved using the expression system:
4142 @example
4143 dctdnoiz=e='gte(c, 4.5*3)'
4144 @end example
4145
4146 Violent denoise using a block size of @code{16x16}:
4147 @example
4148 dctdnoiz=15:n=4
4149 @end example
4150
4151 @section deband
4152
4153 Remove banding artifacts from input video.
4154 It works by replacing banded pixels with average value of referenced pixels.
4155
4156 The filter accepts the following options:
4157
4158 @table @option
4159 @item 1thr
4160 @item 2thr
4161 @item 3thr
4162 @item 4thr
4163 Set banding detection threshold for each plane. Default is 0.02.
4164 Valid range is 0.00003 to 0.5.
4165 If difference between current pixel and reference pixel is less than threshold,
4166 it will be considered as banded.
4167
4168 @item range, r
4169 Banding detection range in pixels. Default is 16. If positive, random number
4170 in range 0 to set value will be used. If negative, exact absolute value
4171 will be used.
4172 The range defines square of four pixels around current pixel.
4173
4174 @item direction, d
4175 Set direction in radians from which four pixel will be compared. If positive,
4176 random direction from 0 to set direction will be picked. If negative, exact of
4177 absolute value will be picked. For example direction 0, -PI or -2*PI radians
4178 will pick only pixels on same row and -PI/2 will pick only pixels on same
4179 column.
4180
4181 @item blur
4182 If enabled, current pixel is compared with average value of all four
4183 surrounding pixels. The default is enabled. If disabled current pixel is
4184 compared with all four surrounding pixels. The pixel is considered banded
4185 if only all four differences with surrounding pixels are less than threshold.
4186 @end table
4187
4188 @anchor{decimate}
4189 @section decimate
4190
4191 Drop duplicated frames at regular intervals.
4192
4193 The filter accepts the following options:
4194
4195 @table @option
4196 @item cycle
4197 Set the number of frames from which one will be dropped. Setting this to
4198 @var{N} means one frame in every batch of @var{N} frames will be dropped.
4199 Default is @code{5}.
4200
4201 @item dupthresh
4202 Set the threshold for duplicate detection. If the difference metric for a frame
4203 is less than or equal to this value, then it is declared as duplicate. Default
4204 is @code{1.1}
4205
4206 @item scthresh
4207 Set scene change threshold. Default is @code{15}.
4208
4209 @item blockx
4210 @item blocky
4211 Set the size of the x and y-axis blocks used during metric calculations.
4212 Larger blocks give better noise suppression, but also give worse detection of
4213 small movements. Must be a power of two. Default is @code{32}.
4214
4215 @item ppsrc
4216 Mark main input as a pre-processed input and activate clean source input
4217 stream. This allows the input to be pre-processed with various filters to help
4218 the metrics calculation while keeping the frame selection lossless. When set to
4219 @code{1}, the first stream is for the pre-processed input, and the second
4220 stream is the clean source from where the kept frames are chosen. Default is
4221 @code{0}.
4222
4223 @item chroma
4224 Set whether or not chroma is considered in the metric calculations. Default is
4225 @code{1}.
4226 @end table
4227
4228 @section deflate
4229
4230 Apply deflate effect to the video.
4231
4232 This filter replaces the pixel by the local(3x3) average by taking into account
4233 only values lower than the pixel.
4234
4235 It accepts the following options:
4236
4237 @table @option
4238 @item threshold0
4239 @item threshold1
4240 @item threshold2
4241 @item threshold3
4242 Allows to limit the maximum change for each plane, default is 65535.
4243 If 0, plane will remain unchanged.
4244 @end table
4245
4246 @section dejudder
4247
4248 Remove judder produced by partially interlaced telecined content.
4249
4250 Judder can be introduced, for instance, by @ref{pullup} filter. If the original
4251 source was partially telecined content then the output of @code{pullup,dejudder}
4252 will have a variable frame rate. May change the recorded frame rate of the
4253 container. Aside from that change, this filter will not affect constant frame
4254 rate video.
4255
4256 The option available in this filter is:
4257 @table @option
4258
4259 @item cycle
4260 Specify the length of the window over which the judder repeats.
4261
4262 Accepts any integer greater than 1. Useful values are:
4263 @table @samp
4264
4265 @item 4
4266 If the original was telecined from 24 to 30 fps (Film to NTSC).
4267
4268 @item 5
4269 If the original was telecined from 25 to 30 fps (PAL to NTSC).
4270
4271 @item 20
4272 If a mixture of the two.
4273 @end table
4274
4275 The default is @samp{4}.
4276 @end table
4277
4278 @section delogo
4279
4280 Suppress a TV station logo by a simple interpolation of the surrounding
4281 pixels. Just set a rectangle covering the logo and watch it disappear
4282 (and sometimes something even uglier appear - your mileage may vary).
4283
4284 It accepts the following parameters:
4285 @table @option
4286
4287 @item x
4288 @item y
4289 Specify the top left corner coordinates of the logo. They must be
4290 specified.
4291
4292 @item w
4293 @item h
4294 Specify the width and height of the logo to clear. They must be
4295 specified.
4296
4297 @item band, t
4298 Specify the thickness of the fuzzy edge of the rectangle (added to
4299 @var{w} and @var{h}). The default value is 4.
4300
4301 @item show
4302 When set to 1, a green rectangle is drawn on the screen to simplify
4303 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.
4304 The default value is 0.
4305
4306 The rectangle is drawn on the outermost pixels which will be (partly)
4307 replaced with interpolated values. The values of the next pixels
4308 immediately outside this rectangle in each direction will be used to
4309 compute the interpolated pixel values inside the rectangle.
4310
4311 @end table
4312
4313 @subsection Examples
4314
4315 @itemize
4316 @item
4317 Set a rectangle covering the area with top left corner coordinates 0,0
4318 and size 100x77, and a band of size 10:
4319 @example
4320 delogo=x=0:y=0:w=100:h=77:band=10
4321 @end example
4322
4323 @end itemize
4324
4325 @section deshake
4326
4327 Attempt to fix small changes in horizontal and/or vertical shift. This
4328 filter helps remove camera shake from hand-holding a camera, bumping a
4329 tripod, moving on a vehicle, etc.
4330
4331 The filter accepts the following options:
4332
4333 @table @option
4334
4335 @item x
4336 @item y
4337 @item w
4338 @item h
4339 Specify a rectangular area where to limit the search for motion
4340 vectors.
4341 If desired the search for motion vectors can be limited to a
4342 rectangular area of the frame defined by its top left corner, width
4343 and height. These parameters have the same meaning as the drawbox
4344 filter which can be used to visualise the position of the bounding
4345 box.
4346
4347 This is useful when simultaneous movement of subjects within the frame
4348 might be confused for camera motion by the motion vector search.
4349
4350 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
4351 then the full frame is used. This allows later options to be set
4352 without specifying the bounding box for the motion vector search.
4353
4354 Default - search the whole frame.
4355
4356 @item rx
4357 @item ry
4358 Specify the maximum extent of movement in x and y directions in the
4359 range 0-64 pixels. Default 16.
4360
4361 @item edge
4362 Specify how to generate pixels to fill blanks at the edge of the
4363 frame. Available values are:
4364 @table @samp
4365 @item blank, 0
4366 Fill zeroes at blank locations
4367 @item original, 1
4368 Original image at blank locations
4369 @item clamp, 2
4370 Extruded edge value at blank locations
4371 @item mirror, 3
4372 Mirrored edge at blank locations
4373 @end table
4374 Default value is @samp{mirror}.
4375
4376 @item blocksize
4377 Specify the blocksize to use for motion search. Range 4-128 pixels,
4378 default 8.
4379
4380 @item contrast
4381 Specify the contrast threshold for blocks. Only blocks with more than
4382 the specified contrast (difference between darkest and lightest
4383 pixels) will be considered. Range 1-255, default 125.
4384
4385 @item search
4386 Specify the search strategy. Available values are:
4387 @table @samp
4388 @item exhaustive, 0
4389 Set exhaustive search
4390 @item less, 1
4391 Set less exhaustive search.
4392 @end table
4393 Default value is @samp{exhaustive}.
4394
4395 @item filename
4396 If set then a detailed log of the motion search is written to the
4397 specified file.
4398
4399 @item opencl
4400 If set to 1, specify using OpenCL capabilities, only available if
4401 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
4402
4403 @end table
4404
4405 @section detelecine
4406
4407 Apply an exact inverse of the telecine operation. It requires a predefined
4408 pattern specified using the pattern option which must be the same as that passed
4409 to the telecine filter.
4410
4411 This filter accepts the following options:
4412
4413 @table @option
4414 @item first_field
4415 @table @samp
4416 @item top, t
4417 top field first
4418 @item bottom, b
4419 bottom field first
4420 The default value is @code{top}.
4421 @end table
4422
4423 @item pattern
4424 A string of numbers representing the pulldown pattern you wish to apply.
4425 The default value is @code{23}.
4426
4427 @item start_frame
4428 A number representing position of the first frame with respect to the telecine
4429 pattern. This is to be used if the stream is cut. The default value is @code{0}.
4430 @end table
4431
4432 @section dilation
4433
4434 Apply dilation effect to the video.
4435
4436 This filter replaces the pixel by the local(3x3) maximum.
4437
4438 It accepts the following options:
4439
4440 @table @option
4441 @item threshold0
4442 @item threshold1
4443 @item threshold2
4444 @item threshold3
4445 Allows to limit the maximum change for each plane, default is 65535.
4446 If 0, plane will remain unchanged.
4447
4448 @item coordinates
4449 Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
4450 pixels are used.
4451
4452 Flags to local 3x3 coordinates maps like this:
4453
4454     1 2 3
4455     4   5
4456     6 7 8
4457 @end table
4458
4459 @section drawbox
4460
4461 Draw a colored box on the input image.
4462
4463 It accepts the following parameters:
4464
4465 @table @option
4466 @item x
4467 @item y
4468 The expressions which specify the top left corner coordinates of the box. It defaults to 0.
4469
4470 @item width, w
4471 @item height, h
4472 The expressions which specify the width and height of the box; if 0 they are interpreted as
4473 the input width and height. It defaults to 0.
4474
4475 @item color, c
4476 Specify the color of the box to write. For the general syntax of this option,
4477 check the "Color" section in the ffmpeg-utils manual. If the special
4478 value @code{invert} is used, the box edge color is the same as the
4479 video with inverted luma.
4480
4481 @item thickness, t
4482 The expression which sets the thickness of the box edge. Default value is @code{3}.
4483
4484 See below for the list of accepted constants.
4485 @end table
4486
4487 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
4488 following constants:
4489
4490 @table @option
4491 @item dar
4492 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
4493
4494 @item hsub
4495 @item vsub
4496 horizontal and vertical chroma subsample values. For example for the
4497 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4498
4499 @item in_h, ih
4500 @item in_w, iw
4501 The input width and height.
4502
4503 @item sar
4504 The input sample aspect ratio.
4505
4506 @item x
4507 @item y
4508 The x and y offset coordinates where the box is drawn.
4509
4510 @item w
4511 @item h
4512 The width and height of the drawn box.
4513
4514 @item t
4515 The thickness of the drawn box.
4516
4517 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
4518 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
4519
4520 @end table
4521
4522 @subsection Examples
4523
4524 @itemize
4525 @item
4526 Draw a black box around the edge of the input image:
4527 @example
4528 drawbox
4529 @end example
4530
4531 @item
4532 Draw a box with color red and an opacity of 50%:
4533 @example
4534 drawbox=10:20:200:60:red@@0.5
4535 @end example
4536
4537 The previous example can be specified as:
4538 @example
4539 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
4540 @end example
4541
4542 @item
4543 Fill the box with pink color:
4544 @example
4545 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
4546 @end example
4547
4548 @item
4549 Draw a 2-pixel red 2.40:1 mask:
4550 @example
4551 drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
4552 @end example
4553 @end itemize
4554
4555 @section drawgraph, adrawgraph
4556
4557 Draw a graph using input video or audio metadata.
4558
4559 It accepts the following parameters:
4560
4561 @table @option
4562 @item m1
4563 Set 1st frame metadata key from which metadata values will be used to draw a graph.
4564
4565 @item fg1
4566 Set 1st foreground color expression.
4567
4568 @item m2
4569 Set 2nd frame metadata key from which metadata values will be used to draw a graph.
4570
4571 @item fg2
4572 Set 2nd foreground color expression.
4573
4574 @item m3
4575 Set 3rd frame metadata key from which metadata values will be used to draw a graph.
4576
4577 @item fg3
4578 Set 3rd foreground color expression.
4579
4580 @item m4
4581 Set 4th frame metadata key from which metadata values will be used to draw a graph.
4582
4583 @item fg4
4584 Set 4th foreground color expression.
4585
4586 @item min
4587 Set minimal value of metadata value.
4588
4589 @item max
4590 Set maximal value of metadata value.
4591
4592 @item bg
4593 Set graph background color. Default is white.
4594
4595 @item mode
4596 Set graph mode.
4597
4598 Available values for mode is:
4599 @table @samp
4600 @item bar
4601 @item dot
4602 @item line
4603 @end table
4604
4605 Default is @code{line}.
4606
4607 @item slide
4608 Set slide mode.
4609
4610 Available values for slide is:
4611 @table @samp
4612 @item frame
4613 Draw new frame when right border is reached.
4614
4615 @item replace
4616 Replace old columns with new ones.
4617
4618 @item scroll
4619 Scroll from right to left.
4620
4621 @item rscroll
4622 Scroll from left to right.
4623 @end table
4624
4625 Default is @code{frame}.
4626
4627 @item size
4628 Set size of graph video. For the syntax of this option, check the
4629 @ref{video size syntax,,"Video size" section in the ffmpeg-utils manual,ffmpeg-utils}.
4630 The default value is @code{900x256}.
4631
4632 The foreground color expressions can use the following variables:
4633 @table @option
4634 @item MIN
4635 Minimal value of metadata value.
4636
4637 @item MAX
4638 Maximal value of metadata value.
4639
4640 @item VAL
4641 Current metadata key value.
4642 @end table
4643
4644 The color is defined as 0xAABBGGRR.
4645 @end table
4646
4647 Example using metadata from @ref{signalstats} filter:
4648 @example
4649 signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
4650 @end example
4651
4652 Example using metadata from @ref{ebur128} filter:
4653 @example
4654 ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
4655 @end example
4656
4657 @section drawgrid
4658
4659 Draw a grid on the input image.
4660
4661 It accepts the following parameters:
4662
4663 @table @option
4664 @item x
4665 @item y
4666 The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0.
4667
4668 @item width, w
4669 @item height, h
4670 The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the
4671 input width and height, respectively, minus @code{thickness}, so image gets
4672 framed. Default to 0.
4673
4674 @item color, c
4675 Specify the color of the grid. For the general syntax of this option,
4676 check the "Color" section in the ffmpeg-utils manual. If the special
4677 value @code{invert} is used, the grid color is the same as the
4678 video with inverted luma.
4679
4680 @item thickness, t
4681 The expression which sets the thickness of the grid line. Default value is @code{1}.
4682
4683 See below for the list of accepted constants.
4684 @end table
4685
4686 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
4687 following constants:
4688
4689 @table @option
4690 @item dar
4691 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
4692
4693 @item hsub
4694 @item vsub
4695 horizontal and vertical chroma subsample values. For example for the
4696 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4697
4698 @item in_h, ih
4699 @item in_w, iw
4700 The input grid cell width and height.
4701
4702 @item sar
4703 The input sample aspect ratio.
4704
4705 @item x
4706 @item y
4707 The x and y coordinates of some point of grid intersection (meant to configure offset).
4708
4709 @item w
4710 @item h
4711 The width and height of the drawn cell.
4712
4713 @item t
4714 The thickness of the drawn cell.
4715
4716 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
4717 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
4718
4719 @end table
4720
4721 @subsection Examples
4722
4723 @itemize
4724 @item
4725 Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%:
4726 @example
4727 drawgrid=width=100:height=100:thickness=2:color=red@@0.5
4728 @end example
4729
4730 @item
4731 Draw a white 3x3 grid with an opacity of 50%:
4732 @example
4733 drawgrid=w=iw/3:h=ih/3:t=2:c=white@@0.5
4734 @end example
4735 @end itemize
4736
4737 @anchor{drawtext}
4738 @section drawtext
4739
4740 Draw a text string or text from a specified file on top of a video, using the
4741 libfreetype library.
4742
4743 To enable compilation of this filter, you need to configure FFmpeg with
4744 @code{--enable-libfreetype}.
4745 To enable default font fallback and the @var{font} option you need to
4746 configure FFmpeg with @code{--enable-libfontconfig}.
4747 To enable the @var{text_shaping} option, you need to configure FFmpeg with
4748 @code{--enable-libfribidi}.
4749
4750 @subsection Syntax
4751
4752 It accepts the following parameters:
4753
4754 @table @option
4755
4756 @item box
4757 Used to draw a box around text using the background color.
4758 The value must be either 1 (enable) or 0 (disable).
4759 The default value of @var{box} is 0.
4760
4761 @item boxborderw
4762 Set the width of the border to be drawn around the box using @var{boxcolor}.
4763 The default value of @var{boxborderw} is 0.
4764
4765 @item boxcolor
4766 The color to be used for drawing box around text. For the syntax of this
4767 option, check the "Color" section in the ffmpeg-utils manual.
4768
4769 The default value of @var{boxcolor} is "white".
4770
4771 @item borderw
4772 Set the width of the border to be drawn around the text using @var{bordercolor}.
4773 The default value of @var{borderw} is 0.
4774
4775 @item bordercolor
4776 Set the color to be used for drawing border around text. For the syntax of this
4777 option, check the "Color" section in the ffmpeg-utils manual.
4778
4779 The default value of @var{bordercolor} is "black".
4780
4781 @item expansion
4782 Select how the @var{text} is expanded. Can be either @code{none},
4783 @code{strftime} (deprecated) or
4784 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
4785 below for details.
4786
4787 @item fix_bounds
4788 If true, check and fix text coords to avoid clipping.
4789
4790 @item fontcolor
4791 The color to be used for drawing fonts. For the syntax of this option, check
4792 the "Color" section in the ffmpeg-utils manual.
4793
4794 The default value of @var{fontcolor} is "black".
4795
4796 @item fontcolor_expr
4797 String which is expanded the same way as @var{text} to obtain dynamic
4798 @var{fontcolor} value. By default this option has empty value and is not
4799 processed. When this option is set, it overrides @var{fontcolor} option.
4800
4801 @item font
4802 The font family to be used for drawing text. By default Sans.
4803
4804 @item fontfile
4805 The font file to be used for drawing text. The path must be included.
4806 This parameter is mandatory if the fontconfig support is disabled.
4807
4808 @item draw
4809 This option does not exist, please see the timeline system
4810
4811 @item alpha
4812 Draw the text applying alpha blending. The value can
4813 be either a number between 0.0 and 1.0
4814 The expression accepts the same variables @var{x, y} do.
4815 The default value is 1.
4816 Please see fontcolor_expr
4817
4818 @item fontsize
4819 The font size to be used for drawing text.
4820 The default value of @var{fontsize} is 16.
4821
4822 @item text_shaping
4823 If set to 1, attempt to shape the text (for example, reverse the order of
4824 right-to-left text and join Arabic characters) before drawing it.
4825 Otherwise, just draw the text exactly as given.
4826 By default 1 (if supported).
4827
4828 @item ft_load_flags
4829 The flags to be used for loading the fonts.
4830
4831 The flags map the corresponding flags supported by libfreetype, and are
4832 a combination of the following values:
4833 @table @var
4834 @item default
4835 @item no_scale
4836 @item no_hinting
4837 @item render
4838 @item no_bitmap
4839 @item vertical_layout
4840 @item force_autohint
4841 @item crop_bitmap
4842 @item pedantic
4843 @item ignore_global_advance_width
4844 @item no_recurse
4845 @item ignore_transform
4846 @item monochrome
4847 @item linear_design
4848 @item no_autohint
4849 @end table
4850
4851 Default value is "default".
4852
4853 For more information consult the documentation for the FT_LOAD_*
4854 libfreetype flags.
4855
4856 @item shadowcolor
4857 The color to be used for drawing a shadow behind the drawn text. For the
4858 syntax of this option, check the "Color" section in the ffmpeg-utils manual.
4859
4860 The default value of @var{shadowcolor} is "black".
4861
4862 @item shadowx
4863 @item shadowy
4864 The x and y offsets for the text shadow position with respect to the
4865 position of the text. They can be either positive or negative
4866 values. The default value for both is "0".
4867
4868 @item start_number
4869 The starting frame number for the n/frame_num variable. The default value
4870 is "0".
4871
4872 @item tabsize
4873 The size in number of spaces to use for rendering the tab.
4874 Default value is 4.
4875
4876 @item timecode
4877 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
4878 format. It can be used with or without text parameter. @var{timecode_rate}
4879 option must be specified.
4880
4881 @item timecode_rate, rate, r
4882 Set the timecode frame rate (timecode only).
4883
4884 @item text
4885 The text string to be drawn. The text must be a sequence of UTF-8
4886 encoded characters.
4887 This parameter is mandatory if no file is specified with the parameter
4888 @var{textfile}.
4889
4890 @item textfile
4891 A text file containing text to be drawn. The text must be a sequence
4892 of UTF-8 encoded characters.
4893
4894 This parameter is mandatory if no text string is specified with the
4895 parameter @var{text}.
4896
4897 If both @var{text} and @var{textfile} are specified, an error is thrown.
4898
4899 @item reload
4900 If set to 1, the @var{textfile} will be reloaded before each frame.
4901 Be sure to update it atomically, or it may be read partially, or even fail.
4902
4903 @item x
4904 @item y
4905 The expressions which specify the offsets where text will be drawn
4906 within the video frame. They are relative to the top/left border of the
4907 output image.
4908
4909 The default value of @var{x} and @var{y} is "0".
4910
4911 See below for the list of accepted constants and functions.
4912 @end table
4913
4914 The parameters for @var{x} and @var{y} are expressions containing the
4915 following constants and functions:
4916
4917 @table @option
4918 @item dar
4919 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
4920
4921 @item hsub
4922 @item vsub
4923 horizontal and vertical chroma subsample values. For example for the
4924 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4925
4926 @item line_h, lh
4927 the height of each text line
4928
4929 @item main_h, h, H
4930 the input height
4931
4932 @item main_w, w, W
4933 the input width
4934
4935 @item max_glyph_a, ascent
4936 the maximum distance from the baseline to the highest/upper grid
4937 coordinate used to place a glyph outline point, for all the rendered
4938 glyphs.
4939 It is a positive value, due to the grid's orientation with the Y axis
4940 upwards.
4941
4942 @item max_glyph_d, descent
4943 the maximum distance from the baseline to the lowest grid coordinate
4944 used to place a glyph outline point, for all the rendered glyphs.
4945 This is a negative value, due to the grid's orientation, with the Y axis
4946 upwards.
4947
4948 @item max_glyph_h
4949 maximum glyph height, that is the maximum height for all the glyphs
4950 contained in the rendered text, it is equivalent to @var{ascent} -
4951 @var{descent}.
4952
4953 @item max_glyph_w
4954 maximum glyph width, that is the maximum width for all the glyphs
4955 contained in the rendered text
4956
4957 @item n
4958 the number of input frame, starting from 0
4959
4960 @item rand(min, max)
4961 return a random number included between @var{min} and @var{max}
4962
4963 @item sar
4964 The input sample aspect ratio.
4965
4966 @item t
4967 timestamp expressed in seconds, NAN if the input timestamp is unknown
4968
4969 @item text_h, th
4970 the height of the rendered text
4971
4972 @item text_w, tw
4973 the width of the rendered text
4974
4975 @item x
4976 @item y
4977 the x and y offset coordinates where the text is drawn.
4978
4979 These parameters allow the @var{x} and @var{y} expressions to refer
4980 each other, so you can for example specify @code{y=x/dar}.
4981 @end table
4982
4983 @anchor{drawtext_expansion}
4984 @subsection Text expansion
4985
4986 If @option{expansion} is set to @code{strftime},
4987 the filter recognizes strftime() sequences in the provided text and
4988 expands them accordingly. Check the documentation of strftime(). This
4989 feature is deprecated.
4990
4991 If @option{expansion} is set to @code{none}, the text is printed verbatim.
4992
4993 If @option{expansion} is set to @code{normal} (which is the default),
4994 the following expansion mechanism is used.
4995
4996 The backslash character @samp{\}, followed by any character, always expands to
4997 the second character.
4998
4999 Sequence of the form @code{%@{...@}} are expanded. The text between the
5000 braces is a function name, possibly followed by arguments separated by ':'.
5001 If the arguments contain special characters or delimiters (':' or '@}'),
5002 they should be escaped.
5003
5004 Note that they probably must also be escaped as the value for the
5005 @option{text} option in the filter argument string and as the filter
5006 argument in the filtergraph description, and possibly also for the shell,
5007 that makes up to four levels of escaping; using a text file avoids these
5008 problems.
5009
5010 The following functions are available:
5011
5012 @table @command
5013
5014 @item expr, e
5015 The expression evaluation result.
5016
5017 It must take one argument specifying the expression to be evaluated,
5018 which accepts the same constants and functions as the @var{x} and
5019 @var{y} values. Note that not all constants should be used, for
5020 example the text size is not known when evaluating the expression, so
5021 the constants @var{text_w} and @var{text_h} will have an undefined
5022 value.
5023
5024 @item expr_int_format, eif
5025 Evaluate the expression's value and output as formatted integer.
5026
5027 The first argument is the expression to be evaluated, just as for the @var{expr} function.
5028 The second argument specifies the output format. Allowed values are @samp{x},
5029 @samp{X}, @samp{d} and @samp{u}. They are treated exactly as in the
5030 @code{printf} function.
5031 The third parameter is optional and sets the number of positions taken by the output.
5032 It can be used to add padding with zeros from the left.
5033
5034 @item gmtime
5035 The time at which the filter is running, expressed in UTC.
5036 It can accept an argument: a strftime() format string.
5037
5038 @item localtime
5039 The time at which the filter is running, expressed in the local time zone.
5040 It can accept an argument: a strftime() format string.
5041
5042 @item metadata
5043 Frame metadata. It must take one argument specifying metadata key.
5044
5045 @item n, frame_num
5046 The frame number, starting from 0.
5047
5048 @item pict_type
5049 A 1 character description of the current picture type.
5050
5051 @item pts
5052 The timestamp of the current frame.
5053 It can take up to two arguments.
5054
5055 The first argument is the format of the timestamp; it defaults to @code{flt}
5056 for seconds as a decimal number with microsecond accuracy; @code{hms} stands
5057 for a formatted @var{[-]HH:MM:SS.mmm} timestamp with millisecond accuracy.
5058
5059 The second argument is an offset added to the timestamp.
5060
5061 @end table
5062
5063 @subsection Examples
5064
5065 @itemize
5066 @item
5067 Draw "Test Text" with font FreeSerif, using the default values for the
5068 optional parameters.
5069
5070 @example
5071 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
5072 @end example
5073
5074 @item
5075 Draw 'Test Text' with font FreeSerif of size 24 at position x=100