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