avfilter/af_ladspa: support simpler syntax for controls
[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 extrastereo
1821
1822 Linearly increases the difference between left and right channels which
1823 adds some sort of "live" effect to playback.
1824
1825 The filter accepts the following option:
1826
1827 @table @option
1828 @item m
1829 Sets the difference coefficient (default: 2.5). 0.0 means mono sound
1830 (average of both channels), with 1.0 sound will be unchanged, with
1831 -1.0 left and right channels will be swapped.
1832
1833 @item c
1834 Enable clipping. By default is enabled.
1835 @end table
1836
1837 @section flanger
1838 Apply a flanging effect to the audio.
1839
1840 The filter accepts the following options:
1841
1842 @table @option
1843 @item delay
1844 Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
1845
1846 @item depth
1847 Set added swep delay in milliseconds. Range from 0 to 10. Default value is 2.
1848
1849 @item regen
1850 Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
1851 Default value is 0.
1852
1853 @item width
1854 Set percentage of delayed signal mixed with original. Range from 0 to 100.
1855 Default value is 71.
1856
1857 @item speed
1858 Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
1859
1860 @item shape
1861 Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
1862 Default value is @var{sinusoidal}.
1863
1864 @item phase
1865 Set swept wave percentage-shift for multi channel. Range from 0 to 100.
1866 Default value is 25.
1867
1868 @item interp
1869 Set delay-line interpolation, @var{linear} or @var{quadratic}.
1870 Default is @var{linear}.
1871 @end table
1872
1873 @section highpass
1874
1875 Apply a high-pass filter with 3dB point frequency.
1876 The filter can be either single-pole, or double-pole (the default).
1877 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1878
1879 The filter accepts the following options:
1880
1881 @table @option
1882 @item frequency, f
1883 Set frequency in Hz. Default is 3000.
1884
1885 @item poles, p
1886 Set number of poles. Default is 2.
1887
1888 @item width_type
1889 Set method to specify band-width of filter.
1890 @table @option
1891 @item h
1892 Hz
1893 @item q
1894 Q-Factor
1895 @item o
1896 octave
1897 @item s
1898 slope
1899 @end table
1900
1901 @item width, w
1902 Specify the band-width of a filter in width_type units.
1903 Applies only to double-pole filter.
1904 The default is 0.707q and gives a Butterworth response.
1905 @end table
1906
1907 @section join
1908
1909 Join multiple input streams into one multi-channel stream.
1910
1911 It accepts the following parameters:
1912 @table @option
1913
1914 @item inputs
1915 The number of input streams. It defaults to 2.
1916
1917 @item channel_layout
1918 The desired output channel layout. It defaults to stereo.
1919
1920 @item map
1921 Map channels from inputs to output. The argument is a '|'-separated list of
1922 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1923 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1924 can be either the name of the input channel (e.g. FL for front left) or its
1925 index in the specified input stream. @var{out_channel} is the name of the output
1926 channel.
1927 @end table
1928
1929 The filter will attempt to guess the mappings when they are not specified
1930 explicitly. It does so by first trying to find an unused matching input channel
1931 and if that fails it picks the first unused input channel.
1932
1933 Join 3 inputs (with properly set channel layouts):
1934 @example
1935 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1936 @end example
1937
1938 Build a 5.1 output from 6 single-channel streams:
1939 @example
1940 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1941 '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'
1942 out
1943 @end example
1944
1945 @section ladspa
1946
1947 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
1948
1949 To enable compilation of this filter you need to configure FFmpeg with
1950 @code{--enable-ladspa}.
1951
1952 @table @option
1953 @item file, f
1954 Specifies the name of LADSPA plugin library to load. If the environment
1955 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
1956 each one of the directories specified by the colon separated list in
1957 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
1958 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
1959 @file{/usr/lib/ladspa/}.
1960
1961 @item plugin, p
1962 Specifies the plugin within the library. Some libraries contain only
1963 one plugin, but others contain many of them. If this is not set filter
1964 will list all available plugins within the specified library.
1965
1966 @item controls, c
1967 Set the '|' separated list of controls which are zero or more floating point
1968 values that determine the behavior of the loaded plugin (for example delay,
1969 threshold or gain).
1970 Controls need to be defined using the following syntax:
1971 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
1972 @var{valuei} is the value set on the @var{i}-th control.
1973 Alternatively they can be also defined using the following syntax:
1974 @var{value0}|@var{value1}|@var{value2}|..., where
1975 @var{valuei} is the value set on the @var{i}-th control.
1976 If @option{controls} is set to @code{help}, all available controls and
1977 their valid ranges are printed.
1978
1979 @item sample_rate, s
1980 Specify the sample rate, default to 44100. Only used if plugin have
1981 zero inputs.
1982
1983 @item nb_samples, n
1984 Set the number of samples per channel per each output frame, default
1985 is 1024. Only used if plugin have zero inputs.
1986
1987 @item duration, d
1988 Set the minimum duration of the sourced audio. See
1989 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
1990 for the accepted syntax.
1991 Note that the resulting duration may be greater than the specified duration,
1992 as the generated audio is always cut at the end of a complete frame.
1993 If not specified, or the expressed duration is negative, the audio is
1994 supposed to be generated forever.
1995 Only used if plugin have zero inputs.
1996
1997 @end table
1998
1999 @subsection Examples
2000
2001 @itemize
2002 @item
2003 List all available plugins within amp (LADSPA example plugin) library:
2004 @example
2005 ladspa=file=amp
2006 @end example
2007
2008 @item
2009 List all available controls and their valid ranges for @code{vcf_notch}
2010 plugin from @code{VCF} library:
2011 @example
2012 ladspa=f=vcf:p=vcf_notch:c=help
2013 @end example
2014
2015 @item
2016 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
2017 plugin library:
2018 @example
2019 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
2020 @end example
2021
2022 @item
2023 Add reverberation to the audio using TAP-plugins
2024 (Tom's Audio Processing plugins):
2025 @example
2026 ladspa=file=tap_reverb:tap_reverb
2027 @end example
2028
2029 @item
2030 Generate white noise, with 0.2 amplitude:
2031 @example
2032 ladspa=file=cmt:noise_source_white:c=c0=.2
2033 @end example
2034
2035 @item
2036 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
2037 @code{C* Audio Plugin Suite} (CAPS) library:
2038 @example
2039 ladspa=file=caps:Click:c=c1=20'
2040 @end example
2041
2042 @item
2043 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
2044 @example
2045 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
2046 @end example
2047 @end itemize
2048
2049 @subsection Commands
2050
2051 This filter supports the following commands:
2052 @table @option
2053 @item cN
2054 Modify the @var{N}-th control value.
2055
2056 If the specified value is not valid, it is ignored and prior one is kept.
2057 @end table
2058
2059 @section lowpass
2060
2061 Apply a low-pass filter with 3dB point frequency.
2062 The filter can be either single-pole or double-pole (the default).
2063 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
2064
2065 The filter accepts the following options:
2066
2067 @table @option
2068 @item frequency, f
2069 Set frequency in Hz. Default is 500.
2070
2071 @item poles, p
2072 Set number of poles. Default is 2.
2073
2074 @item width_type
2075 Set method to specify band-width of filter.
2076 @table @option
2077 @item h
2078 Hz
2079 @item q
2080 Q-Factor
2081 @item o
2082 octave
2083 @item s
2084 slope
2085 @end table
2086
2087 @item width, w
2088 Specify the band-width of a filter in width_type units.
2089 Applies only to double-pole filter.
2090 The default is 0.707q and gives a Butterworth response.
2091 @end table
2092
2093 @anchor{pan}
2094 @section pan
2095
2096 Mix channels with specific gain levels. The filter accepts the output
2097 channel layout followed by a set of channels definitions.
2098
2099 This filter is also designed to efficiently remap the channels of an audio
2100 stream.
2101
2102 The filter accepts parameters of the form:
2103 "@var{l}|@var{outdef}|@var{outdef}|..."
2104
2105 @table @option
2106 @item l
2107 output channel layout or number of channels
2108
2109 @item outdef
2110 output channel specification, of the form:
2111 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
2112
2113 @item out_name
2114 output channel to define, either a channel name (FL, FR, etc.) or a channel
2115 number (c0, c1, etc.)
2116
2117 @item gain
2118 multiplicative coefficient for the channel, 1 leaving the volume unchanged
2119
2120 @item in_name
2121 input channel to use, see out_name for details; it is not possible to mix
2122 named and numbered input channels
2123 @end table
2124
2125 If the `=' in a channel specification is replaced by `<', then the gains for
2126 that specification will be renormalized so that the total is 1, thus
2127 avoiding clipping noise.
2128
2129 @subsection Mixing examples
2130
2131 For example, if you want to down-mix from stereo to mono, but with a bigger
2132 factor for the left channel:
2133 @example
2134 pan=1c|c0=0.9*c0+0.1*c1
2135 @end example
2136
2137 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
2138 7-channels surround:
2139 @example
2140 pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
2141 @end example
2142
2143 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
2144 that should be preferred (see "-ac" option) unless you have very specific
2145 needs.
2146
2147 @subsection Remapping examples
2148
2149 The channel remapping will be effective if, and only if:
2150
2151 @itemize
2152 @item gain coefficients are zeroes or ones,
2153 @item only one input per channel output,
2154 @end itemize
2155
2156 If all these conditions are satisfied, the filter will notify the user ("Pure
2157 channel mapping detected"), and use an optimized and lossless method to do the
2158 remapping.
2159
2160 For example, if you have a 5.1 source and want a stereo audio stream by
2161 dropping the extra channels:
2162 @example
2163 pan="stereo| c0=FL | c1=FR"
2164 @end example
2165
2166 Given the same source, you can also switch front left and front right channels
2167 and keep the input channel layout:
2168 @example
2169 pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
2170 @end example
2171
2172 If the input is a stereo audio stream, you can mute the front left channel (and
2173 still keep the stereo channel layout) with:
2174 @example
2175 pan="stereo|c1=c1"
2176 @end example
2177
2178 Still with a stereo audio stream input, you can copy the right channel in both
2179 front left and right:
2180 @example
2181 pan="stereo| c0=FR | c1=FR"
2182 @end example
2183
2184 @section replaygain
2185
2186 ReplayGain scanner filter. This filter takes an audio stream as an input and
2187 outputs it unchanged.
2188 At end of filtering it displays @code{track_gain} and @code{track_peak}.
2189
2190 @section resample
2191
2192 Convert the audio sample format, sample rate and channel layout. It is
2193 not meant to be used directly.
2194
2195 @section sidechaincompress
2196
2197 This filter acts like normal compressor but has the ability to compress
2198 detected signal using second input signal.
2199 It needs two input streams and returns one output stream.
2200 First input stream will be processed depending on second stream signal.
2201 The filtered signal then can be filtered with other filters in later stages of
2202 processing. See @ref{pan} and @ref{amerge} filter.
2203
2204 The filter accepts the following options:
2205
2206 @table @option
2207 @item threshold
2208 If a signal of second stream raises above this level it will affect the gain
2209 reduction of first stream.
2210 By default is 0.125. Range is between 0.00097563 and 1.
2211
2212 @item ratio
2213 Set a ratio about which the signal is reduced. 1:2 means that if the level
2214 raised 4dB above the threshold, it will be only 2dB above after the reduction.
2215 Default is 2. Range is between 1 and 20.
2216
2217 @item attack
2218 Amount of milliseconds the signal has to rise above the threshold before gain
2219 reduction starts. Default is 20. Range is between 0.01 and 2000.
2220
2221 @item release
2222 Amount of milliseconds the signal has to fall bellow the threshold before
2223 reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
2224
2225 @item makeup
2226 Set the amount by how much signal will be amplified after processing.
2227 Default is 2. Range is from 1 and 64.
2228
2229 @item knee
2230 Curve the sharp knee around the threshold to enter gain reduction more softly.
2231 Default is 2.82843. Range is between 1 and 8.
2232
2233 @item link
2234 Choose if the @code{average} level between all channels of side-chain stream
2235 or the louder(@code{maximum}) channel of side-chain stream affects the
2236 reduction. Default is @code{average}.
2237
2238 @item detection
2239 Should the exact signal be taken in case of @code{peak} or an RMS one in case
2240 of @code{rms}. Default is @code{rms} which is mainly smoother.
2241 @end table
2242
2243 @subsection Examples
2244
2245 @itemize
2246 @item
2247 Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
2248 depending on the signal of 2nd input and later compressed signal to be
2249 merged with 2nd input:
2250 @example
2251 ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
2252 @end example
2253 @end itemize
2254
2255 @section silencedetect
2256
2257 Detect silence in an audio stream.
2258
2259 This filter logs a message when it detects that the input audio volume is less
2260 or equal to a noise tolerance value for a duration greater or equal to the
2261 minimum detected noise duration.
2262
2263 The printed times and duration are expressed in seconds.
2264
2265 The filter accepts the following options:
2266
2267 @table @option
2268 @item duration, d
2269 Set silence duration until notification (default is 2 seconds).
2270
2271 @item noise, n
2272 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
2273 specified value) or amplitude ratio. Default is -60dB, or 0.001.
2274 @end table
2275
2276 @subsection Examples
2277
2278 @itemize
2279 @item
2280 Detect 5 seconds of silence with -50dB noise tolerance:
2281 @example
2282 silencedetect=n=-50dB:d=5
2283 @end example
2284
2285 @item
2286 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
2287 tolerance in @file{silence.mp3}:
2288 @example
2289 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
2290 @end example
2291 @end itemize
2292
2293 @section silenceremove
2294
2295 Remove silence from the beginning, middle or end of the audio.
2296
2297 The filter accepts the following options:
2298
2299 @table @option
2300 @item start_periods
2301 This value is used to indicate if audio should be trimmed at beginning of
2302 the audio. A value of zero indicates no silence should be trimmed from the
2303 beginning. When specifying a non-zero value, it trims audio up until it
2304 finds non-silence. Normally, when trimming silence from beginning of audio
2305 the @var{start_periods} will be @code{1} but it can be increased to higher
2306 values to trim all audio up to specific count of non-silence periods.
2307 Default value is @code{0}.
2308
2309 @item start_duration
2310 Specify the amount of time that non-silence must be detected before it stops
2311 trimming audio. By increasing the duration, bursts of noises can be treated
2312 as silence and trimmed off. Default value is @code{0}.
2313
2314 @item start_threshold
2315 This indicates what sample value should be treated as silence. For digital
2316 audio, a value of @code{0} may be fine but for audio recorded from analog,
2317 you may wish to increase the value to account for background noise.
2318 Can be specified in dB (in case "dB" is appended to the specified value)
2319 or amplitude ratio. Default value is @code{0}.
2320
2321 @item stop_periods
2322 Set the count for trimming silence from the end of audio.
2323 To remove silence from the middle of a file, specify a @var{stop_periods}
2324 that is negative. This value is then treated as a positive value and is
2325 used to indicate the effect should restart processing as specified by
2326 @var{start_periods}, making it suitable for removing periods of silence
2327 in the middle of the audio.
2328 Default value is @code{0}.
2329
2330 @item stop_duration
2331 Specify a duration of silence that must exist before audio is not copied any
2332 more. By specifying a higher duration, silence that is wanted can be left in
2333 the audio.
2334 Default value is @code{0}.
2335
2336 @item stop_threshold
2337 This is the same as @option{start_threshold} but for trimming silence from
2338 the end of audio.
2339 Can be specified in dB (in case "dB" is appended to the specified value)
2340 or amplitude ratio. Default value is @code{0}.
2341
2342 @item leave_silence
2343 This indicate that @var{stop_duration} length of audio should be left intact
2344 at the beginning of each period of silence.
2345 For example, if you want to remove long pauses between words but do not want
2346 to remove the pauses completely. Default value is @code{0}.
2347
2348 @end table
2349
2350 @subsection Examples
2351
2352 @itemize
2353 @item
2354 The following example shows how this filter can be used to start a recording
2355 that does not contain the delay at the start which usually occurs between
2356 pressing the record button and the start of the performance:
2357 @example
2358 silenceremove=1:5:0.02
2359 @end example
2360 @end itemize
2361
2362 @section treble
2363
2364 Boost or cut treble (upper) frequencies of the audio using a two-pole
2365 shelving filter with a response similar to that of a standard
2366 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
2367
2368 The filter accepts the following options:
2369
2370 @table @option
2371 @item gain, g
2372 Give the gain at whichever is the lower of ~22 kHz and the
2373 Nyquist frequency. Its useful range is about -20 (for a large cut)
2374 to +20 (for a large boost). Beware of clipping when using a positive gain.
2375
2376 @item frequency, f
2377 Set the filter's central frequency and so can be used
2378 to extend or reduce the frequency range to be boosted or cut.
2379 The default value is @code{3000} Hz.
2380
2381 @item width_type
2382 Set method to specify band-width of filter.
2383 @table @option
2384 @item h
2385 Hz
2386 @item q
2387 Q-Factor
2388 @item o
2389 octave
2390 @item s
2391 slope
2392 @end table
2393
2394 @item width, w
2395 Determine how steep is the filter's shelf transition.
2396 @end table
2397
2398 @section volume
2399
2400 Adjust the input audio volume.
2401
2402 It accepts the following parameters:
2403 @table @option
2404
2405 @item volume
2406 Set audio volume expression.
2407
2408 Output values are clipped to the maximum value.
2409
2410 The output audio volume is given by the relation:
2411 @example
2412 @var{output_volume} = @var{volume} * @var{input_volume}
2413 @end example
2414
2415 The default value for @var{volume} is "1.0".
2416
2417 @item precision
2418 This parameter represents the mathematical precision.
2419
2420 It determines which input sample formats will be allowed, which affects the
2421 precision of the volume scaling.
2422
2423 @table @option
2424 @item fixed
2425 8-bit fixed-point; this limits input sample format to U8, S16, and S32.
2426 @item float
2427 32-bit floating-point; this limits input sample format to FLT. (default)
2428 @item double
2429 64-bit floating-point; this limits input sample format to DBL.
2430 @end table
2431
2432 @item replaygain
2433 Choose the behaviour on encountering ReplayGain side data in input frames.
2434
2435 @table @option
2436 @item drop
2437 Remove ReplayGain side data, ignoring its contents (the default).
2438
2439 @item ignore
2440 Ignore ReplayGain side data, but leave it in the frame.
2441
2442 @item track
2443 Prefer the track gain, if present.
2444
2445 @item album
2446 Prefer the album gain, if present.
2447 @end table
2448
2449 @item replaygain_preamp
2450 Pre-amplification gain in dB to apply to the selected replaygain gain.
2451
2452 Default value for @var{replaygain_preamp} is 0.0.
2453
2454 @item eval
2455 Set when the volume expression is evaluated.
2456
2457 It accepts the following values:
2458 @table @samp
2459 @item once
2460 only evaluate expression once during the filter initialization, or
2461 when the @samp{volume} command is sent
2462
2463 @item frame
2464 evaluate expression for each incoming frame
2465 @end table
2466
2467 Default value is @samp{once}.
2468 @end table
2469
2470 The volume expression can contain the following parameters.
2471
2472 @table @option
2473 @item n
2474 frame number (starting at zero)
2475 @item nb_channels
2476 number of channels
2477 @item nb_consumed_samples
2478 number of samples consumed by the filter
2479 @item nb_samples
2480 number of samples in the current frame
2481 @item pos
2482 original frame position in the file
2483 @item pts
2484 frame PTS
2485 @item sample_rate
2486 sample rate
2487 @item startpts
2488 PTS at start of stream
2489 @item startt
2490 time at start of stream
2491 @item t
2492 frame time
2493 @item tb
2494 timestamp timebase
2495 @item volume
2496 last set volume value
2497 @end table
2498
2499 Note that when @option{eval} is set to @samp{once} only the
2500 @var{sample_rate} and @var{tb} variables are available, all other
2501 variables will evaluate to NAN.
2502
2503 @subsection Commands
2504
2505 This filter supports the following commands:
2506 @table @option
2507 @item volume
2508 Modify the volume expression.
2509 The command accepts the same syntax of the corresponding option.
2510
2511 If the specified expression is not valid, it is kept at its current
2512 value.
2513 @item replaygain_noclip
2514 Prevent clipping by limiting the gain applied.
2515
2516 Default value for @var{replaygain_noclip} is 1.
2517
2518 @end table
2519
2520 @subsection Examples
2521
2522 @itemize
2523 @item
2524 Halve the input audio volume:
2525 @example
2526 volume=volume=0.5
2527 volume=volume=1/2
2528 volume=volume=-6.0206dB
2529 @end example
2530
2531 In all the above example the named key for @option{volume} can be
2532 omitted, for example like in:
2533 @example
2534 volume=0.5
2535 @end example
2536
2537 @item
2538 Increase input audio power by 6 decibels using fixed-point precision:
2539 @example
2540 volume=volume=6dB:precision=fixed
2541 @end example
2542
2543 @item
2544 Fade volume after time 10 with an annihilation period of 5 seconds:
2545 @example
2546 volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
2547 @end example
2548 @end itemize
2549
2550 @section volumedetect
2551
2552 Detect the volume of the input video.
2553
2554 The filter has no parameters. The input is not modified. Statistics about
2555 the volume will be printed in the log when the input stream end is reached.
2556
2557 In particular it will show the mean volume (root mean square), maximum
2558 volume (on a per-sample basis), and the beginning of a histogram of the
2559 registered volume values (from the maximum value to a cumulated 1/1000 of
2560 the samples).
2561
2562 All volumes are in decibels relative to the maximum PCM value.
2563
2564 @subsection Examples
2565
2566 Here is an excerpt of the output:
2567 @example
2568 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
2569 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
2570 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
2571 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
2572 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
2573 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
2574 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
2575 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
2576 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
2577 @end example
2578
2579 It means that:
2580 @itemize
2581 @item
2582 The mean square energy is approximately -27 dB, or 10^-2.7.
2583 @item
2584 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
2585 @item
2586 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
2587 @end itemize
2588
2589 In other words, raising the volume by +4 dB does not cause any clipping,
2590 raising it by +5 dB causes clipping for 6 samples, etc.
2591
2592 @c man end AUDIO FILTERS
2593
2594 @chapter Audio Sources
2595 @c man begin AUDIO SOURCES
2596
2597 Below is a description of the currently available audio sources.
2598
2599 @section abuffer
2600
2601 Buffer audio frames, and make them available to the filter chain.
2602
2603 This source is mainly intended for a programmatic use, in particular
2604 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
2605
2606 It accepts the following parameters:
2607 @table @option
2608
2609 @item time_base
2610 The timebase which will be used for timestamps of submitted frames. It must be
2611 either a floating-point number or in @var{numerator}/@var{denominator} form.
2612
2613 @item sample_rate
2614 The sample rate of the incoming audio buffers.
2615
2616 @item sample_fmt
2617 The sample format of the incoming audio buffers.
2618 Either a sample format name or its corresponding integer representation from
2619 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
2620
2621 @item channel_layout
2622 The channel layout of the incoming audio buffers.
2623 Either a channel layout name from channel_layout_map in
2624 @file{libavutil/channel_layout.c} or its corresponding integer representation
2625 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
2626
2627 @item channels
2628 The number of channels of the incoming audio buffers.
2629 If both @var{channels} and @var{channel_layout} are specified, then they
2630 must be consistent.
2631
2632 @end table
2633
2634 @subsection Examples
2635
2636 @example
2637 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
2638 @end example
2639
2640 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
2641 Since the sample format with name "s16p" corresponds to the number
2642 6 and the "stereo" channel layout corresponds to the value 0x3, this is
2643 equivalent to:
2644 @example
2645 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
2646 @end example
2647
2648 @section aevalsrc
2649
2650 Generate an audio signal specified by an expression.
2651
2652 This source accepts in input one or more expressions (one for each
2653 channel), which are evaluated and used to generate a corresponding
2654 audio signal.
2655
2656 This source accepts the following options:
2657
2658 @table @option
2659 @item exprs
2660 Set the '|'-separated expressions list for each separate channel. In case the
2661 @option{channel_layout} option is not specified, the selected channel layout
2662 depends on the number of provided expressions. Otherwise the last
2663 specified expression is applied to the remaining output channels.
2664
2665 @item channel_layout, c
2666 Set the channel layout. The number of channels in the specified layout
2667 must be equal to the number of specified expressions.
2668
2669 @item duration, d
2670 Set the minimum duration of the sourced audio. See
2671 @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
2672 for the accepted syntax.
2673 Note that the resulting duration may be greater than the specified
2674 duration, as the generated audio is always cut at the end of a
2675 complete frame.
2676
2677 If not specified, or the expressed duration is negative, the audio is
2678 supposed to be generated forever.
2679
2680 @item nb_samples, n
2681 Set the number of samples per channel per each output frame,
2682 default to 1024.
2683
2684 @item sample_rate, s
2685 Specify the sample rate, default to 44100.
2686 @end table
2687
2688 Each expression in @var{exprs} can contain the following constants:
2689
2690 @table @option
2691 @item n
2692 number of the evaluated sample, starting from 0
2693
2694 @item t
2695 time of the evaluated sample expressed in seconds, starting from 0
2696
2697 @item s
2698 sample rate
2699
2700 @end table
2701
2702 @subsection Examples
2703
2704 @itemize
2705 @item
2706 Generate silence:
2707 @example
2708 aevalsrc=0
2709 @end example
2710
2711 @item
2712 Generate a sin signal with frequency of 440 Hz, set sample rate to
2713 8000 Hz:
2714 @example
2715 aevalsrc="sin(440*2*PI*t):s=8000"
2716 @end example
2717
2718 @item
2719 Generate a two channels signal, specify the channel layout (Front
2720 Center + Back Center) explicitly:
2721 @example
2722 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
2723 @end example
2724
2725 @item
2726 Generate white noise:
2727 @example
2728 aevalsrc="-2+random(0)"
2729 @end example
2730
2731 @item
2732 Generate an amplitude modulated signal:
2733 @example
2734 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
2735 @end example
2736
2737 @item
2738 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
2739 @example
2740 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
2741 @end example
2742
2743 @end itemize
2744
2745 @section anullsrc
2746
2747 The null audio source, return unprocessed audio frames. It is mainly useful
2748 as a template and to be employed in analysis / debugging tools, or as
2749 the source for filters which ignore the input data (for example the sox
2750 synth filter).
2751
2752 This source accepts the following options:
2753
2754 @table @option
2755
2756 @item channel_layout, cl
2757
2758 Specifies the channel layout, and can be either an integer or a string
2759 representing a channel layout. The default value of @var{channel_layout}
2760 is "stereo".
2761
2762 Check the channel_layout_map definition in
2763 @file{libavutil/channel_layout.c} for the mapping between strings and
2764 channel layout values.
2765
2766 @item sample_rate, r
2767 Specifies the sample rate, and defaults to 44100.
2768
2769 @item nb_samples, n
2770 Set the number of samples per requested frames.
2771
2772 @end table
2773
2774 @subsection Examples
2775
2776 @itemize
2777 @item
2778 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
2779 @example
2780 anullsrc=r=48000:cl=4
2781 @end example
2782
2783 @item
2784 Do the same operation with a more obvious syntax:
2785 @example
2786 anullsrc=r=48000:cl=mono
2787 @end example
2788 @end itemize
2789
2790 All the parameters need to be explicitly defined.
2791
2792 @section flite
2793
2794 Synthesize a voice utterance using the libflite library.
2795
2796 To enable compilation of this filter you need to configure FFmpeg with
2797 @code{--enable-libflite}.
2798
2799 Note that the flite library is not thread-safe.
2800
2801 The filter accepts the following options:
2802
2803 @table @option
2804
2805 @item list_voices
2806 If set to 1, list the names of the available voices and exit
2807 immediately. Default value is 0.
2808
2809 @item nb_samples, n
2810 Set the maximum number of samples per frame. Default value is 512.
2811
2812 @item textfile
2813 Set the filename containing the text to speak.
2814
2815 @item text
2816 Set the text to speak.
2817
2818 @item voice, v
2819 Set the voice to use for the speech synthesis. Default value is
2820 @code{kal}. See also the @var{list_voices} option.
2821 @end table
2822
2823 @subsection Examples
2824
2825 @itemize
2826 @item
2827 Read from file @file{speech.txt}, and synthesize the text using the
2828 standard flite voice:
2829 @example
2830 flite=textfile=speech.txt
2831 @end example
2832
2833 @item
2834 Read the specified text selecting the @code{slt} voice:
2835 @example
2836 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
2837 @end example
2838
2839 @item
2840 Input text to ffmpeg:
2841 @example
2842 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
2843 @end example
2844
2845 @item
2846 Make @file{ffplay} speak the specified text, using @code{flite} and
2847 the @code{lavfi} device:
2848 @example
2849 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
2850 @end example
2851 @end itemize
2852
2853 For more information about libflite, check:
2854 @url{http://www.speech.cs.cmu.edu/flite/}
2855
2856 @section sine
2857
2858 Generate an audio signal made of a sine wave with amplitude 1/8.
2859
2860 The audio signal is bit-exact.
2861
2862 The filter accepts the following options:
2863
2864 @table @option
2865
2866 @item frequency, f
2867 Set the carrier frequency. Default is 440 Hz.
2868
2869 @item beep_factor, b
2870 Enable a periodic beep every second with frequency @var{beep_factor} times
2871 the carrier frequency. Default is 0, meaning the beep is disabled.
2872
2873 @item sample_rate, r
2874 Specify the sample rate, default is 44100.
2875
2876 @item duration, d
2877 Specify the duration of the generated audio stream.
2878
2879 @item samples_per_frame
2880 Set the number of samples per output frame.
2881
2882 The expression can contain the following constants:
2883
2884 @table @option
2885 @item n
2886 The (sequential) number of the output audio frame, starting from 0.
2887
2888 @item pts
2889 The PTS (Presentation TimeStamp) of the output audio frame,
2890 expressed in @var{TB} units.
2891
2892 @item t
2893 The PTS of the output audio frame, expressed in seconds.
2894
2895 @item TB
2896 The timebase of the output audio frames.
2897 @end table
2898
2899 Default is @code{1024}.
2900 @end table
2901
2902 @subsection Examples
2903
2904 @itemize
2905
2906 @item
2907 Generate a simple 440 Hz sine wave:
2908 @example
2909 sine
2910 @end example
2911
2912 @item
2913 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
2914 @example
2915 sine=220:4:d=5
2916 sine=f=220:b=4:d=5
2917 sine=frequency=220:beep_factor=4:duration=5
2918 @end example
2919
2920 @item
2921 Generate a 1 kHz sine wave following @code{1602,1601,1602,1601,1602} NTSC
2922 pattern:
2923 @example
2924 sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
2925 @end example
2926 @end itemize
2927
2928 @c man end AUDIO SOURCES
2929
2930 @chapter Audio Sinks
2931 @c man begin AUDIO SINKS
2932
2933 Below is a description of the currently available audio sinks.
2934
2935 @section abuffersink
2936
2937 Buffer audio frames, and make them available to the end of filter chain.
2938
2939 This sink is mainly intended for programmatic use, in particular
2940 through the interface defined in @file{libavfilter/buffersink.h}
2941 or the options system.
2942
2943 It accepts a pointer to an AVABufferSinkContext structure, which
2944 defines the incoming buffers' formats, to be passed as the opaque
2945 parameter to @code{avfilter_init_filter} for initialization.
2946 @section anullsink
2947
2948 Null audio sink; do absolutely nothing with the input audio. It is
2949 mainly useful as a template and for use in analysis / debugging
2950 tools.
2951
2952 @c man end AUDIO SINKS
2953
2954 @chapter Video Filters
2955 @c man begin VIDEO FILTERS
2956
2957 When you configure your FFmpeg build, you can disable any of the
2958 existing filters using @code{--disable-filters}.
2959 The configure output will show the video filters included in your
2960 build.
2961
2962 Below is a description of the currently available video filters.
2963
2964 @section alphaextract
2965
2966 Extract the alpha component from the input as a grayscale video. This
2967 is especially useful with the @var{alphamerge} filter.
2968
2969 @section alphamerge
2970
2971 Add or replace the alpha component of the primary input with the
2972 grayscale value of a second input. This is intended for use with
2973 @var{alphaextract} to allow the transmission or storage of frame
2974 sequences that have alpha in a format that doesn't support an alpha
2975 channel.
2976
2977 For example, to reconstruct full frames from a normal YUV-encoded video
2978 and a separate video created with @var{alphaextract}, you might use:
2979 @example
2980 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
2981 @end example
2982
2983 Since this filter is designed for reconstruction, it operates on frame
2984 sequences without considering timestamps, and terminates when either
2985 input reaches end of stream. This will cause problems if your encoding
2986 pipeline drops frames. If you're trying to apply an image as an
2987 overlay to a video stream, consider the @var{overlay} filter instead.
2988
2989 @section ass
2990
2991 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
2992 and libavformat to work. On the other hand, it is limited to ASS (Advanced
2993 Substation Alpha) subtitles files.
2994
2995 This filter accepts the following option in addition to the common options from
2996 the @ref{subtitles} filter:
2997
2998 @table @option
2999 @item shaping
3000 Set the shaping engine
3001
3002 Available values are:
3003 @table @samp
3004 @item auto
3005 The default libass shaping engine, which is the best available.
3006 @item simple
3007 Fast, font-agnostic shaper that can do only substitutions
3008 @item complex
3009 Slower shaper using OpenType for substitutions and positioning
3010 @end table
3011
3012 The default is @code{auto}.
3013 @end table
3014
3015 @section atadenoise
3016 Apply an Adaptive Temporal Averaging Denoiser to the video input.
3017
3018 The filter accepts the following options:
3019
3020 @table @option
3021 @item 0a
3022 Set threshold A for 1st plane. Default is 0.02.
3023 Valid range is 0 to 0.3.
3024
3025 @item 0b
3026 Set threshold B for 1st plane. Default is 0.04.
3027 Valid range is 0 to 5.
3028
3029 @item 1a
3030 Set threshold A for 2nd plane. Default is 0.02.
3031 Valid range is 0 to 0.3.
3032
3033 @item 1b
3034 Set threshold B for 2nd plane. Default is 0.04.
3035 Valid range is 0 to 5.
3036
3037 @item 2a
3038 Set threshold A for 3rd plane. Default is 0.02.
3039 Valid range is 0 to 0.3.
3040
3041 @item 2b
3042 Set threshold B for 3rd plane. Default is 0.04.
3043 Valid range is 0 to 5.
3044
3045 Threshold A is designed to react on abrupt changes in the input signal and
3046 threshold B is designed to react on continuous changes in the input signal.
3047
3048 @item s
3049 Set number of frames filter will use for averaging. Default is 33. Must be odd
3050 number in range [5, 129].
3051 @end table
3052
3053 @section bbox
3054
3055 Compute the bounding box for the non-black pixels in the input frame
3056 luminance plane.
3057
3058 This filter computes the bounding box containing all the pixels with a
3059 luminance value greater than the minimum allowed value.
3060 The parameters describing the bounding box are printed on the filter
3061 log.
3062
3063 The filter accepts the following option:
3064
3065 @table @option
3066 @item min_val
3067 Set the minimal luminance value. Default is @code{16}.
3068 @end table
3069
3070 @section blackdetect
3071
3072 Detect video intervals that are (almost) completely black. Can be
3073 useful to detect chapter transitions, commercials, or invalid
3074 recordings. Output lines contains the time for the start, end and
3075 duration of the detected black interval expressed in seconds.
3076
3077 In order to display the output lines, you need to set the loglevel at
3078 least to the AV_LOG_INFO value.
3079
3080 The filter accepts the following options:
3081
3082 @table @option
3083 @item black_min_duration, d
3084 Set the minimum detected black duration expressed in seconds. It must
3085 be a non-negative floating point number.
3086
3087 Default value is 2.0.
3088
3089 @item picture_black_ratio_th, pic_th
3090 Set the threshold for considering a picture "black".
3091 Express the minimum value for the ratio:
3092 @example
3093 @var{nb_black_pixels} / @var{nb_pixels}
3094 @end example
3095
3096 for which a picture is considered black.
3097 Default value is 0.98.
3098
3099 @item pixel_black_th, pix_th
3100 Set the threshold for considering a pixel "black".
3101
3102 The threshold expresses the maximum pixel luminance value for which a
3103 pixel is considered "black". The provided value is scaled according to
3104 the following equation:
3105 @example
3106 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
3107 @end example
3108
3109 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
3110 the input video format, the range is [0-255] for YUV full-range
3111 formats and [16-235] for YUV non full-range formats.
3112
3113 Default value is 0.10.
3114 @end table
3115
3116 The following example sets the maximum pixel threshold to the minimum
3117 value, and detects only black intervals of 2 or more seconds:
3118 @example
3119 blackdetect=d=2:pix_th=0.00
3120 @end example
3121
3122 @section blackframe
3123
3124 Detect frames that are (almost) completely black. Can be useful to
3125 detect chapter transitions or commercials. Output lines consist of
3126 the frame number of the detected frame, the percentage of blackness,
3127 the position in the file if known or -1 and the timestamp in seconds.
3128
3129 In order to display the output lines, you need to set the loglevel at
3130 least to the AV_LOG_INFO value.
3131
3132 It accepts the following parameters:
3133
3134 @table @option
3135
3136 @item amount
3137 The percentage of the pixels that have to be below the threshold; it defaults to
3138 @code{98}.
3139
3140 @item threshold, thresh
3141 The threshold below which a pixel value is considered black; it defaults to
3142 @code{32}.
3143
3144 @end table
3145
3146 @section blend, tblend
3147
3148 Blend two video frames into each other.
3149
3150 The @code{blend} filter takes two input streams and outputs one
3151 stream, the first input is the "top" layer and second input is
3152 "bottom" layer.  Output terminates when shortest input terminates.
3153
3154 The @code{tblend} (time blend) filter takes two consecutive frames
3155 from one single stream, and outputs the result obtained by blending
3156 the new frame on top of the old frame.
3157
3158 A description of the accepted options follows.
3159
3160 @table @option
3161 @item c0_mode
3162 @item c1_mode
3163 @item c2_mode
3164 @item c3_mode
3165 @item all_mode
3166 Set blend mode for specific pixel component or all pixel components in case
3167 of @var{all_mode}. Default value is @code{normal}.
3168
3169 Available values for component modes are:
3170 @table @samp
3171 @item addition
3172 @item and
3173 @item average
3174 @item burn
3175 @item darken
3176 @item difference
3177 @item difference128
3178 @item divide
3179 @item dodge
3180 @item exclusion
3181 @item glow
3182 @item hardlight
3183 @item hardmix
3184 @item lighten
3185 @item linearlight
3186 @item multiply
3187 @item negation
3188 @item normal
3189 @item or
3190 @item overlay
3191 @item phoenix
3192 @item pinlight
3193 @item reflect
3194 @item screen
3195 @item softlight
3196 @item subtract
3197 @item vividlight
3198 @item xor
3199 @end table
3200
3201 @item c0_opacity
3202 @item c1_opacity
3203 @item c2_opacity
3204 @item c3_opacity
3205 @item all_opacity
3206 Set blend opacity for specific pixel component or all pixel components in case
3207 of @var{all_opacity}. Only used in combination with pixel component blend modes.
3208
3209 @item c0_expr
3210 @item c1_expr
3211 @item c2_expr
3212 @item c3_expr
3213 @item all_expr
3214 Set blend expression for specific pixel component or all pixel components in case
3215 of @var{all_expr}. Note that related mode options will be ignored if those are set.
3216
3217 The expressions can use the following variables:
3218
3219 @table @option
3220 @item N
3221 The sequential number of the filtered frame, starting from @code{0}.
3222
3223 @item X
3224 @item Y
3225 the coordinates of the current sample
3226
3227 @item W
3228 @item H
3229 the width and height of currently filtered plane
3230
3231 @item SW
3232 @item SH
3233 Width and height scale depending on the currently filtered plane. It is the
3234 ratio between the corresponding luma plane number of pixels and the current
3235 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
3236 @code{0.5,0.5} for chroma planes.
3237
3238 @item T
3239 Time of the current frame, expressed in seconds.
3240
3241 @item TOP, A
3242 Value of pixel component at current location for first video frame (top layer).
3243
3244 @item BOTTOM, B
3245 Value of pixel component at current location for second video frame (bottom layer).
3246 @end table
3247
3248 @item shortest
3249 Force termination when the shortest input terminates. Default is
3250 @code{0}. This option is only defined for the @code{blend} filter.
3251
3252 @item repeatlast
3253 Continue applying the last bottom frame after the end of the stream. A value of
3254 @code{0} disable the filter after the last frame of the bottom layer is reached.
3255 Default is @code{1}. This option is only defined for the @code{blend} filter.
3256 @end table
3257
3258 @subsection Examples
3259
3260 @itemize
3261 @item
3262 Apply transition from bottom layer to top layer in first 10 seconds:
3263 @example
3264 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
3265 @end example
3266
3267 @item
3268 Apply 1x1 checkerboard effect:
3269 @example
3270 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
3271 @end example
3272
3273 @item
3274 Apply uncover left effect:
3275 @example
3276 blend=all_expr='if(gte(N*SW+X,W),A,B)'
3277 @end example
3278
3279 @item
3280 Apply uncover down effect:
3281 @example
3282 blend=all_expr='if(gte(Y-N*SH,0),A,B)'
3283 @end example
3284
3285 @item
3286 Apply uncover up-left effect:
3287 @example
3288 blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
3289 @end example
3290
3291 @item
3292 Display differences between the current and the previous frame:
3293 @example
3294 tblend=all_mode=difference128
3295 @end example
3296 @end itemize
3297
3298 @section boxblur
3299
3300 Apply a boxblur algorithm to the input video.
3301
3302 It accepts the following parameters:
3303
3304 @table @option
3305
3306 @item luma_radius, lr
3307 @item luma_power, lp
3308 @item chroma_radius, cr
3309 @item chroma_power, cp
3310 @item alpha_radius, ar
3311 @item alpha_power, ap
3312
3313 @end table
3314
3315 A description of the accepted options follows.
3316
3317 @table @option
3318 @item luma_radius, lr
3319 @item chroma_radius, cr
3320 @item alpha_radius, ar
3321 Set an expression for the box radius in pixels used for blurring the
3322 corresponding input plane.
3323
3324 The radius value must be a non-negative number, and must not be
3325 greater than the value of the expression @code{min(w,h)/2} for the
3326 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
3327 planes.
3328
3329 Default value for @option{luma_radius} is "2". If not specified,
3330 @option{chroma_radius} and @option{alpha_radius} default to the
3331 corresponding value set for @option{luma_radius}.
3332
3333 The expressions can contain the following constants:
3334 @table @option
3335 @item w
3336 @item h
3337 The input width and height in pixels.
3338
3339 @item cw
3340 @item ch
3341 The input chroma image width and height in pixels.
3342
3343 @item hsub
3344 @item vsub
3345 The horizontal and vertical chroma subsample values. For example, for the
3346 pixel format "yuv422p", @var{hsub} is 2 and @var{vsub} is 1.
3347 @end table
3348
3349 @item luma_power, lp
3350 @item chroma_power, cp
3351 @item alpha_power, ap
3352 Specify how many times the boxblur filter is applied to the
3353 corresponding plane.
3354
3355 Default value for @option{luma_power} is 2. If not specified,
3356 @option{chroma_power} and @option{alpha_power} default to the
3357 corresponding value set for @option{luma_power}.
3358
3359 A value of 0 will disable the effect.
3360 @end table
3361
3362 @subsection Examples
3363
3364 @itemize
3365 @item
3366 Apply a boxblur filter with the luma, chroma, and alpha radii
3367 set to 2:
3368 @example
3369 boxblur=luma_radius=2:luma_power=1
3370 boxblur=2:1
3371 @end example
3372
3373 @item
3374 Set the luma radius to 2, and alpha and chroma radius to 0:
3375 @example
3376 boxblur=2:1:cr=0:ar=0
3377 @end example
3378
3379 @item
3380 Set the luma and chroma radii to a fraction of the video dimension:
3381 @example
3382 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
3383 @end example
3384 @end itemize
3385
3386 @section codecview
3387
3388 Visualize information exported by some codecs.
3389
3390 Some codecs can export information through frames using side-data or other
3391 means. For example, some MPEG based codecs export motion vectors through the
3392 @var{export_mvs} flag in the codec @option{flags2} option.
3393
3394 The filter accepts the following option:
3395
3396 @table @option
3397 @item mv
3398 Set motion vectors to visualize.
3399
3400 Available flags for @var{mv} are:
3401
3402 @table @samp
3403 @item pf
3404 forward predicted MVs of P-frames
3405 @item bf
3406 forward predicted MVs of B-frames
3407 @item bb
3408 backward predicted MVs of B-frames
3409 @end table
3410 @end table
3411
3412 @subsection Examples
3413
3414 @itemize
3415 @item
3416 Visualizes multi-directionals MVs from P and B-Frames using @command{ffplay}:
3417 @example
3418 ffplay -flags2 +export_mvs input.mpg -vf codecview=mv=pf+bf+bb
3419 @end example
3420 @end itemize
3421
3422 @section colorbalance
3423 Modify intensity of primary colors (red, green and blue) of input frames.
3424
3425 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
3426 regions for the red-cyan, green-magenta or blue-yellow balance.
3427
3428 A positive adjustment value shifts the balance towards the primary color, a negative
3429 value towards the complementary color.
3430
3431 The filter accepts the following options:
3432
3433 @table @option
3434 @item rs
3435 @item gs
3436 @item bs
3437 Adjust red, green and blue shadows (darkest pixels).
3438
3439 @item rm
3440 @item gm
3441 @item bm
3442 Adjust red, green and blue midtones (medium pixels).
3443
3444 @item rh
3445 @item gh
3446 @item bh
3447 Adjust red, green and blue highlights (brightest pixels).
3448
3449 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3450 @end table
3451
3452 @subsection Examples
3453
3454 @itemize
3455 @item
3456 Add red color cast to shadows:
3457 @example
3458 colorbalance=rs=.3
3459 @end example
3460 @end itemize
3461
3462 @section colorkey
3463 RGB colorspace color keying.
3464
3465 The filter accepts the following options:
3466
3467 @table @option
3468 @item color
3469 The color which will be replaced with transparency.
3470
3471 @item similarity
3472 Similarity percentage with the key color.
3473
3474 0.01 matches only the exact key color, while 1.0 matches everything.
3475
3476 @item blend
3477 Blend percentage.
3478
3479 0.0 makes pixels either fully transparent, or not transparent at all.
3480
3481 Higher values result in semi-transparent pixels, with a higher transparency
3482 the more similar the pixels color is to the key color.
3483 @end table
3484
3485 @subsection Examples
3486
3487 @itemize
3488 @item
3489 Make every green pixel in the input image transparent:
3490 @example
3491 ffmpeg -i input.png -vf colorkey=green out.png
3492 @end example
3493
3494 @item
3495 Overlay a greenscreen-video on top of a static background image.
3496 @example
3497 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
3498 @end example
3499 @end itemize
3500
3501 @section colorlevels
3502
3503 Adjust video input frames using levels.
3504
3505 The filter accepts the following options:
3506
3507 @table @option
3508 @item rimin
3509 @item gimin
3510 @item bimin
3511 @item aimin
3512 Adjust red, green, blue and alpha input black point.
3513 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
3514
3515 @item rimax
3516 @item gimax
3517 @item bimax
3518 @item aimax
3519 Adjust red, green, blue and alpha input white point.
3520 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{1}.
3521
3522 Input levels are used to lighten highlights (bright tones), darken shadows
3523 (dark tones), change the balance of bright and dark tones.
3524
3525 @item romin
3526 @item gomin
3527 @item bomin
3528 @item aomin
3529 Adjust red, green, blue and alpha output black point.
3530 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{0}.
3531
3532 @item romax
3533 @item gomax
3534 @item bomax
3535 @item aomax
3536 Adjust red, green, blue and alpha output white point.
3537 Allowed ranges for options are @code{[0, 1.0]}. Defaults are @code{1}.
3538
3539 Output levels allows manual selection of a constrained output level range.
3540 @end table
3541
3542 @subsection Examples
3543
3544 @itemize
3545 @item
3546 Make video output darker:
3547 @example
3548 colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
3549 @end example
3550
3551 @item
3552 Increase contrast:
3553 @example
3554 colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
3555 @end example
3556
3557 @item
3558 Make video output lighter:
3559 @example
3560 colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
3561 @end example
3562
3563 @item
3564 Increase brightness:
3565 @example
3566 colorlevels=romin=0.5:gomin=0.5:bomin=0.5
3567 @end example
3568 @end itemize
3569
3570 @section colorchannelmixer
3571
3572 Adjust video input frames by re-mixing color channels.
3573
3574 This filter modifies a color channel by adding the values associated to
3575 the other channels of the same pixels. For example if the value to
3576 modify is red, the output value will be:
3577 @example
3578 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
3579 @end example
3580
3581 The filter accepts the following options:
3582
3583 @table @option
3584 @item rr
3585 @item rg
3586 @item rb
3587 @item ra
3588 Adjust contribution of input red, green, blue and alpha channels for output red channel.
3589 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
3590
3591 @item gr
3592 @item gg
3593 @item gb
3594 @item ga
3595 Adjust contribution of input red, green, blue and alpha channels for output green channel.
3596 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
3597
3598 @item br
3599 @item bg
3600 @item bb
3601 @item ba
3602 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
3603 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
3604
3605 @item ar
3606 @item ag
3607 @item ab
3608 @item aa
3609 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
3610 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
3611
3612 Allowed ranges for options are @code{[-2.0, 2.0]}.
3613 @end table
3614
3615 @subsection Examples
3616
3617 @itemize
3618 @item
3619 Convert source to grayscale:
3620 @example
3621 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
3622 @end example
3623 @item
3624 Simulate sepia tones:
3625 @example
3626 colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
3627 @end example
3628 @end itemize
3629
3630 @section colormatrix
3631
3632 Convert color matrix.
3633
3634 The filter accepts the following options:
3635
3636 @table @option
3637 @item src
3638 @item dst
3639 Specify the source and destination color matrix. Both values must be
3640 specified.
3641
3642 The accepted values are:
3643 @table @samp
3644 @item bt709
3645 BT.709
3646
3647 @item bt601
3648 BT.601
3649
3650 @item smpte240m
3651 SMPTE-240M
3652
3653 @item fcc
3654 FCC
3655 @end table
3656 @end table
3657
3658 For example to convert from BT.601 to SMPTE-240M, use the command:
3659 @example
3660 colormatrix=bt601:smpte240m
3661 @end example
3662
3663 @section copy
3664
3665 Copy the input source unchanged to the output. This is mainly useful for
3666 testing purposes.
3667
3668 @section crop
3669
3670 Crop the input video to given dimensions.
3671
3672 It accepts the following parameters:
3673
3674 @table @option
3675 @item w, out_w
3676 The width of the output video. It defaults to @code{iw}.
3677 This expression is evaluated only once during the filter
3678 configuration, or when the @samp{w} or @samp{out_w} command is sent.
3679
3680 @item h, out_h
3681 The height of the output video. It defaults to @code{ih}.
3682 This expression is evaluated only once during the filter
3683 configuration, or when the @samp{h} or @samp{out_h} command is sent.
3684
3685 @item x
3686 The horizontal position, in the input video, of the left edge of the output
3687 video. It defaults to @code{(in_w-out_w)/2}.
3688 This expression is evaluated per-frame.
3689
3690 @item y
3691 The vertical position, in the input video, of the top edge of the output video.
3692 It defaults to @code{(in_h-out_h)/2}.
3693 This expression is evaluated per-frame.
3694
3695 @item keep_aspect
3696 If set to 1 will force the output display aspect ratio
3697 to be the same of the input, by changing the output sample aspect
3698 ratio. It defaults to 0.
3699 @end table
3700
3701 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
3702 expressions containing the following constants:
3703
3704 @table @option
3705 @item x
3706 @item y
3707 The computed values for @var{x} and @var{y}. They are evaluated for
3708 each new frame.
3709
3710 @item in_w
3711 @item in_h
3712 The input width and height.
3713
3714 @item iw
3715 @item ih
3716 These are the same as @var{in_w} and @var{in_h}.
3717
3718 @item out_w
3719 @item out_h
3720 The output (cropped) width and height.
3721
3722 @item ow
3723 @item oh
3724 These are the same as @var{out_w} and @var{out_h}.
3725
3726 @item a
3727 same as @var{iw} / @var{ih}
3728
3729 @item sar
3730 input sample aspect ratio
3731
3732 @item dar
3733 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
3734
3735 @item hsub
3736 @item vsub
3737 horizontal and vertical chroma subsample values. For example for the
3738 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3739
3740 @item n
3741 The number of the input frame, starting from 0.
3742
3743 @item pos
3744 the position in the file of the input frame, NAN if unknown
3745
3746 @item t
3747 The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
3748
3749 @end table
3750
3751 The expression for @var{out_w} may depend on the value of @var{out_h},
3752 and the expression for @var{out_h} may depend on @var{out_w}, but they
3753 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
3754 evaluated after @var{out_w} and @var{out_h}.
3755
3756 The @var{x} and @var{y} parameters specify the expressions for the
3757 position of the top-left corner of the output (non-cropped) area. They
3758 are evaluated for each frame. If the evaluated value is not valid, it
3759 is approximated to the nearest valid value.
3760
3761 The expression for @var{x} may depend on @var{y}, and the expression
3762 for @var{y} may depend on @var{x}.
3763
3764 @subsection Examples
3765
3766 @itemize
3767 @item
3768 Crop area with size 100x100 at position (12,34).
3769 @example
3770 crop=100:100:12:34
3771 @end example
3772
3773 Using named options, the example above becomes:
3774 @example
3775 crop=w=100:h=100:x=12:y=34
3776 @end example
3777
3778 @item
3779 Crop the central input area with size 100x100:
3780 @example
3781 crop=100:100
3782 @end example
3783
3784 @item
3785 Crop the central input area with size 2/3 of the input video:
3786 @example
3787 crop=2/3*in_w:2/3*in_h
3788 @end example
3789
3790 @item
3791 Crop the input video central square:
3792 @example
3793 crop=out_w=in_h
3794 crop=in_h
3795 @end example
3796
3797 @item
3798 Delimit the rectangle with the top-left corner placed at position
3799 100:100 and the right-bottom corner corresponding to the right-bottom
3800 corner of the input image.
3801 @example
3802 crop=in_w-100:in_h-100:100:100
3803 @end example
3804
3805 @item
3806 Crop 10 pixels from the left and right borders, and 20 pixels from
3807 the top and bottom borders
3808 @example
3809 crop=in_w-2*10:in_h-2*20
3810 @end example
3811
3812 @item
3813 Keep only the bottom right quarter of the input image:
3814 @example
3815 crop=in_w/2:in_h/2:in_w/2:in_h/2
3816 @end example
3817
3818 @item
3819 Crop height for getting Greek harmony:
3820 @example
3821 crop=in_w:1/PHI*in_w
3822 @end example
3823
3824 @item
3825 Apply trembling effect:
3826 @example
3827 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)
3828 @end example
3829
3830 @item
3831 Apply erratic camera effect depending on timestamp:
3832 @example
3833 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)"
3834 @end example
3835
3836 @item
3837 Set x depending on the value of y:
3838 @example
3839 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
3840 @end example
3841 @end itemize
3842
3843 @subsection Commands
3844
3845 This filter supports the following commands:
3846 @table @option
3847 @item w, out_w
3848 @item h, out_h
3849 @item x
3850 @item y
3851 Set width/height of the output video and the horizontal/vertical position
3852 in the input video.
3853 The command accepts the same syntax of the corresponding option.
3854
3855 If the specified expression is not valid, it is kept at its current
3856 value.
3857 @end table
3858
3859 @section cropdetect
3860
3861 Auto-detect the crop size.
3862
3863 It calculates the necessary cropping parameters and prints the
3864 recommended parameters via the logging system. The detected dimensions
3865 correspond to the non-black area of the input video.
3866
3867 It accepts the following parameters:
3868
3869 @table @option
3870
3871 @item limit
3872 Set higher black value threshold, which can be optionally specified
3873 from nothing (0) to everything (255 for 8bit based formats). An intensity
3874 value greater to the set value is considered non-black. It defaults to 24.
3875 You can also specify a value between 0.0 and 1.0 which will be scaled depending
3876 on the bitdepth of the pixel format.
3877
3878 @item round
3879 The value which the width/height should be divisible by. It defaults to
3880 16. The offset is automatically adjusted to center the video. Use 2 to
3881 get only even dimensions (needed for 4:2:2 video). 16 is best when
3882 encoding to most video codecs.
3883
3884 @item reset_count, reset
3885 Set the counter that determines after how many frames cropdetect will
3886 reset the previously detected largest video area and start over to
3887 detect the current optimal crop area. Default value is 0.
3888
3889 This can be useful when channel logos distort the video area. 0
3890 indicates 'never reset', and returns the largest area encountered during
3891 playback.
3892 @end table
3893
3894 @anchor{curves}
3895 @section curves
3896
3897 Apply color adjustments using curves.
3898
3899 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
3900 component (red, green and blue) has its values defined by @var{N} key points
3901 tied from each other using a smooth curve. The x-axis represents the pixel
3902 values from the input frame, and the y-axis the new pixel values to be set for
3903 the output frame.
3904
3905 By default, a component curve is defined by the two points @var{(0;0)} and
3906 @var{(1;1)}. This creates a straight line where each original pixel value is
3907 "adjusted" to its own value, which means no change to the image.
3908
3909 The filter allows you to redefine these two points and add some more. A new
3910 curve (using a natural cubic spline interpolation) will be define to pass
3911 smoothly through all these new coordinates. The new defined points needs to be
3912 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
3913 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
3914 the vector spaces, the values will be clipped accordingly.
3915
3916 If there is no key point defined in @code{x=0}, the filter will automatically
3917 insert a @var{(0;0)} point. In the same way, if there is no key point defined
3918 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
3919
3920 The filter accepts the following options:
3921
3922 @table @option
3923 @item preset
3924 Select one of the available color presets. This option can be used in addition
3925 to the @option{r}, @option{g}, @option{b} parameters; in this case, the later
3926 options takes priority on the preset values.
3927 Available presets are:
3928 @table @samp
3929 @item none
3930 @item color_negative
3931 @item cross_process
3932 @item darker
3933 @item increase_contrast
3934 @item lighter
3935 @item linear_contrast
3936 @item medium_contrast
3937 @item negative
3938 @item strong_contrast
3939 @item vintage
3940 @end table
3941 Default is @code{none}.
3942 @item master, m
3943 Set the master key points. These points will define a second pass mapping. It
3944 is sometimes called a "luminance" or "value" mapping. It can be used with
3945 @option{r}, @option{g}, @option{b} or @option{all} since it acts like a
3946 post-processing LUT.
3947 @item red, r
3948 Set the key points for the red component.
3949 @item green, g
3950 Set the key points for the green component.
3951 @item blue, b
3952 Set the key points for the blue component.
3953 @item all
3954 Set the key points for all components (not including master).
3955 Can be used in addition to the other key points component
3956 options. In this case, the unset component(s) will fallback on this
3957 @option{all} setting.
3958 @item psfile
3959 Specify a Photoshop curves file (@code{.acv}) to import the settings from.
3960 @end table
3961
3962 To avoid some filtergraph syntax conflicts, each key points list need to be
3963 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
3964
3965 @subsection Examples
3966
3967 @itemize
3968 @item
3969 Increase slightly the middle level of blue:
3970 @example
3971 curves=blue='0.5/0.58'
3972 @end example
3973
3974 @item
3975 Vintage effect:
3976 @example
3977 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
3978 @end example
3979 Here we obtain the following coordinates for each components:
3980 @table @var
3981 @item red
3982 @code{(0;0.11) (0.42;0.51) (1;0.95)}
3983 @item green
3984 @code{(0;0) (0.50;0.48) (1;1)}
3985 @item blue
3986 @code{(0;0.22) (0.49;0.44) (1;0.80)}
3987 @end table
3988
3989 @item
3990 The previous example can also be achieved with the associated built-in preset:
3991 @example
3992 curves=preset=vintage
3993 @end example
3994
3995 @item
3996 Or simply:
3997 @example
3998 curves=vintage
3999 @end example
4000
4001 @item
4002 Use a Photoshop preset and redefine the points of the green component:
4003 @example
4004 curves=psfile='MyCurvesPresets/purple.acv':green='0.45/0.53'
4005 @end example
4006 @end itemize
4007
4008 @section dctdnoiz
4009
4010 Denoise frames using 2D DCT (frequency domain filtering).
4011
4012 This filter is not designed for real time.
4013
4014 The filter accepts the following options:
4015
4016 @table @option
4017 @item sigma, s
4018 Set the noise sigma constant.
4019
4020 This @var{sigma} defines a hard threshold of @code{3 * sigma}; every DCT
4021 coefficient (absolute value) below this threshold with be dropped.
4022
4023 If you need a more advanced filtering, see @option{expr}.
4024
4025 Default is @code{0}.
4026
4027 @item overlap
4028 Set number overlapping pixels for each block. Since the filter can be slow, you
4029 may want to reduce this value, at the cost of a less effective filter and the
4030 risk of various artefacts.
4031
4032 If the overlapping value doesn't permit processing the whole input width or
4033 height, a warning will be displayed and according borders won't be denoised.
4034
4035 Default value is @var{blocksize}-1, which is the best possible setting.
4036
4037 @item expr, e
4038 Set the coefficient factor expression.
4039
4040 For each coefficient of a DCT block, this expression will be evaluated as a
4041 multiplier value for the coefficient.
4042
4043 If this is option is set, the @option{sigma} option will be ignored.
4044
4045 The absolute value of the coefficient can be accessed through the @var{c}
4046 variable.
4047
4048 @item n
4049 Set the @var{blocksize} using the number of bits. @code{1<<@var{n}} defines the
4050 @var{blocksize}, which is the width and height of the processed blocks.
4051
4052 The default value is @var{3} (8x8) and can be raised to @var{4} for a
4053 @var{blocksize} of 16x16. Note that changing this setting has huge consequences
4054 on the speed processing. Also, a larger block size does not necessarily means a
4055 better de-noising.
4056 @end table
4057
4058 @subsection Examples
4059
4060 Apply a denoise with a @option{sigma} of @code{4.5}:
4061 @example
4062 dctdnoiz=4.5
4063 @end example
4064
4065 The same operation can be achieved using the expression system:
4066 @example
4067 dctdnoiz=e='gte(c, 4.5*3)'
4068 @end example
4069
4070 Violent denoise using a block size of @code{16x16}:
4071 @example
4072 dctdnoiz=15:n=4
4073 @end example
4074
4075 @section deband
4076
4077 Remove banding artifacts from input video.
4078 It works by replacing banded pixels with average value of referenced pixels.
4079
4080 The filter accepts the following options:
4081
4082 @table @option
4083 @item 1thr
4084 @item 2thr
4085 @item 3thr
4086 @item 4thr
4087 Set banding detection threshold for each plane. Default is 0.02.
4088 Valid range is 0.00003 to 0.5.
4089 If difference between current pixel and reference pixel is less than threshold,
4090 it will be considered as banded.
4091
4092 @item range, r
4093 Banding detection range in pixels. Default is 16. If positive, random number
4094 in range 0 to set value will be used. If negative, exact absolute value
4095 will be used.
4096 The range defines square of four pixels around current pixel.
4097
4098 @item direction, d
4099 Set direction in radians from which four pixel will be compared. If positive,
4100 random direction from 0 to set direction will be picked. If negative, exact of
4101 absolute value will be picked. For example direction 0, -PI or -2*PI radians
4102 will pick only pixels on same row and -PI/2 will pick only pixels on same
4103 column.
4104
4105 @item blur
4106 If enabled, current pixel is compared with average value of all four
4107 surrounding pixels. The default is enabled. If disabled current pixel is
4108 compared with all four surrounding pixels. The pixel is considered banded
4109 if only all four differences with surrounding pixels are less than threshold.
4110 @end table
4111
4112 @anchor{decimate}
4113 @section decimate
4114
4115 Drop duplicated frames at regular intervals.
4116
4117 The filter accepts the following options:
4118
4119 @table @option
4120 @item cycle
4121 Set the number of frames from which one will be dropped. Setting this to
4122 @var{N} means one frame in every batch of @var{N} frames will be dropped.
4123 Default is @code{5}.
4124
4125 @item dupthresh
4126 Set the threshold for duplicate detection. If the difference metric for a frame
4127 is less than or equal to this value, then it is declared as duplicate. Default
4128 is @code{1.1}
4129
4130 @item scthresh
4131 Set scene change threshold. Default is @code{15}.
4132
4133 @item blockx
4134 @item blocky
4135 Set the size of the x and y-axis blocks used during metric calculations.
4136 Larger blocks give better noise suppression, but also give worse detection of
4137 small movements. Must be a power of two. Default is @code{32}.
4138
4139 @item ppsrc
4140 Mark main input as a pre-processed input and activate clean source input
4141 stream. This allows the input to be pre-processed with various filters to help
4142 the metrics calculation while keeping the frame selection lossless. When set to
4143 @code{1}, the first stream is for the pre-processed input, and the second
4144 stream is the clean source from where the kept frames are chosen. Default is
4145 @code{0}.
4146
4147 @item chroma
4148 Set whether or not chroma is considered in the metric calculations. Default is
4149 @code{1}.
4150 @end table
4151
4152 @section deflate
4153
4154 Apply deflate effect to the video.
4155
4156 This filter replaces the pixel by the local(3x3) average by taking into account
4157 only values lower than the pixel.
4158
4159 It accepts the following options:
4160
4161 @table @option
4162 @item threshold0
4163 @item threshold1
4164 @item threshold2
4165 @item threshold3
4166 Allows to limit the maximum change for each plane, default is 65535.
4167 If 0, plane will remain unchanged.
4168 @end table
4169
4170 @section dejudder
4171
4172 Remove judder produced by partially interlaced telecined content.
4173
4174 Judder can be introduced, for instance, by @ref{pullup} filter. If the original
4175 source was partially telecined content then the output of @code{pullup,dejudder}
4176 will have a variable frame rate. May change the recorded frame rate of the
4177 container. Aside from that change, this filter will not affect constant frame
4178 rate video.
4179
4180 The option available in this filter is:
4181 @table @option
4182
4183 @item cycle
4184 Specify the length of the window over which the judder repeats.
4185
4186 Accepts any integer greater than 1. Useful values are:
4187 @table @samp
4188
4189 @item 4
4190 If the original was telecined from 24 to 30 fps (Film to NTSC).
4191
4192 @item 5
4193 If the original was telecined from 25 to 30 fps (PAL to NTSC).
4194
4195 @item 20
4196 If a mixture of the two.
4197 @end table
4198
4199 The default is @samp{4}.
4200 @end table
4201
4202 @section delogo
4203
4204 Suppress a TV station logo by a simple interpolation of the surrounding
4205 pixels. Just set a rectangle covering the logo and watch it disappear
4206 (and sometimes something even uglier appear - your mileage may vary).
4207
4208 It accepts the following parameters:
4209 @table @option
4210
4211 @item x
4212 @item y
4213 Specify the top left corner coordinates of the logo. They must be
4214 specified.
4215
4216 @item w
4217 @item h
4218 Specify the width and height of the logo to clear. They must be
4219 specified.
4220
4221 @item band, t
4222 Specify the thickness of the fuzzy edge of the rectangle (added to
4223 @var{w} and @var{h}). The default value is 4.
4224
4225 @item show
4226 When set to 1, a green rectangle is drawn on the screen to simplify
4227 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.
4228 The default value is 0.
4229
4230 The rectangle is drawn on the outermost pixels which will be (partly)
4231 replaced with interpolated values. The values of the next pixels
4232 immediately outside this rectangle in each direction will be used to
4233 compute the interpolated pixel values inside the rectangle.
4234
4235 @end table
4236
4237 @subsection Examples
4238
4239 @itemize
4240 @item
4241 Set a rectangle covering the area with top left corner coordinates 0,0
4242 and size 100x77, and a band of size 10:
4243 @example
4244 delogo=x=0:y=0:w=100:h=77:band=10
4245 @end example
4246
4247 @end itemize
4248
4249 @section deshake
4250
4251 Attempt to fix small changes in horizontal and/or vertical shift. This
4252 filter helps remove camera shake from hand-holding a camera, bumping a
4253 tripod, moving on a vehicle, etc.
4254
4255 The filter accepts the following options:
4256
4257 @table @option
4258
4259 @item x
4260 @item y
4261 @item w
4262 @item h
4263 Specify a rectangular area where to limit the search for motion
4264 vectors.
4265 If desired the search for motion vectors can be limited to a
4266 rectangular area of the frame defined by its top left corner, width
4267 and height. These parameters have the same meaning as the drawbox
4268 filter which can be used to visualise the position of the bounding
4269 box.
4270
4271 This is useful when simultaneous movement of subjects within the frame
4272 might be confused for camera motion by the motion vector search.
4273
4274 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
4275 then the full frame is used. This allows later options to be set
4276 without specifying the bounding box for the motion vector search.
4277
4278 Default - search the whole frame.
4279
4280 @item rx
4281 @item ry
4282 Specify the maximum extent of movement in x and y directions in the
4283 range 0-64 pixels. Default 16.
4284
4285 @item edge
4286 Specify how to generate pixels to fill blanks at the edge of the
4287 frame. Available values are:
4288 @table @samp
4289 @item blank, 0
4290 Fill zeroes at blank locations
4291 @item original, 1
4292 Original image at blank locations
4293 @item clamp, 2
4294 Extruded edge value at blank locations
4295 @item mirror, 3
4296 Mirrored edge at blank locations
4297 @end table
4298 Default value is @samp{mirror}.
4299
4300 @item blocksize
4301 Specify the blocksize to use for motion search. Range 4-128 pixels,
4302 default 8.
4303
4304 @item contrast
4305 Specify the contrast threshold for blocks. Only blocks with more than
4306 the specified contrast (difference between darkest and lightest
4307 pixels) will be considered. Range 1-255, default 125.
4308
4309 @item search
4310 Specify the search strategy. Available values are:
4311 @table @samp
4312 @item exhaustive, 0
4313 Set exhaustive search
4314 @item less, 1
4315 Set less exhaustive search.
4316 @end table
4317 Default value is @samp{exhaustive}.
4318
4319 @item filename
4320 If set then a detailed log of the motion search is written to the
4321 specified file.
4322
4323 @item opencl
4324 If set to 1, specify using OpenCL capabilities, only available if
4325 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
4326
4327 @end table
4328
4329 @section detelecine
4330
4331 Apply an exact inverse of the telecine operation. It requires a predefined
4332 pattern specified using the pattern option which must be the same as that passed
4333 to the telecine filter.
4334
4335 This filter accepts the following options:
4336
4337 @table @option
4338 @item first_field
4339 @table @samp
4340 @item top, t
4341 top field first
4342 @item bottom, b
4343 bottom field first
4344 The default value is @code{top}.
4345 @end table
4346
4347 @item pattern
4348 A string of numbers representing the pulldown pattern you wish to apply.
4349 The default value is @code{23}.
4350
4351 @item start_frame
4352 A number representing position of the first frame with respect to the telecine
4353 pattern. This is to be used if the stream is cut. The default value is @code{0}.
4354 @end table
4355
4356 @section dilation
4357
4358 Apply dilation effect to the video.
4359
4360 This filter replaces the pixel by the local(3x3) maximum.
4361
4362 It accepts the following options:
4363
4364 @table @option
4365 @item threshold0
4366 @item threshold1
4367 @item threshold2
4368 @item threshold3
4369 Allows to limit the maximum change for each plane, default is 65535.
4370 If 0, plane will remain unchanged.
4371
4372 @item coordinates
4373 Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
4374 pixels are used.
4375
4376 Flags to local 3x3 coordinates maps like this:
4377
4378     1 2 3
4379     4   5
4380     6 7 8
4381 @end table
4382
4383 @section drawbox
4384
4385 Draw a colored box on the input image.
4386
4387 It accepts the following parameters:
4388
4389 @table @option
4390 @item x
4391 @item y
4392 The expressions which specify the top left corner coordinates of the box. It defaults to 0.
4393
4394 @item width, w
4395 @item height, h
4396 The expressions which specify the width and height of the box; if 0 they are interpreted as
4397 the input width and height. It defaults to 0.
4398
4399 @item color, c
4400 Specify the color of the box to write. For the general syntax of this option,
4401 check the "Color" section in the ffmpeg-utils manual. If the special
4402 value @code{invert} is used, the box edge color is the same as the
4403 video with inverted luma.
4404
4405 @item thickness, t
4406 The expression which sets the thickness of the box edge. Default value is @code{3}.
4407
4408 See below for the list of accepted constants.
4409 @end table
4410
4411 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
4412 following constants:
4413
4414 @table @option
4415 @item dar
4416 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
4417
4418 @item hsub
4419 @item vsub
4420 horizontal and vertical chroma subsample values. For example for the
4421 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4422
4423 @item in_h, ih
4424 @item in_w, iw
4425 The input width and height.
4426
4427 @item sar
4428 The input sample aspect ratio.
4429
4430 @item x
4431 @item y
4432 The x and y offset coordinates where the box is drawn.
4433
4434 @item w
4435 @item h
4436 The width and height of the drawn box.
4437
4438 @item t
4439 The thickness of the drawn box.
4440
4441 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
4442 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
4443
4444 @end table
4445
4446 @subsection Examples
4447
4448 @itemize
4449 @item
4450 Draw a black box around the edge of the input image:
4451 @example
4452 drawbox
4453 @end example
4454
4455 @item
4456 Draw a box with color red and an opacity of 50%:
4457 @example
4458 drawbox=10:20:200:60:red@@0.5
4459 @end example
4460
4461 The previous example can be specified as:
4462 @example
4463 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
4464 @end example
4465
4466 @item
4467 Fill the box with pink color:
4468 @example
4469 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
4470 @end example
4471
4472 @item
4473 Draw a 2-pixel red 2.40:1 mask:
4474 @example
4475 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
4476 @end example
4477 @end itemize
4478
4479 @section drawgraph, adrawgraph
4480
4481 Draw a graph using input video or audio metadata.
4482
4483 It accepts the following parameters:
4484
4485 @table @option
4486 @item m1
4487 Set 1st frame metadata key from which metadata values will be used to draw a graph.
4488
4489 @item fg1
4490 Set 1st foreground color expression.
4491
4492 @item m2
4493 Set 2nd frame metadata key from which metadata values will be used to draw a graph.
4494
4495 @item fg2
4496 Set 2nd foreground color expression.
4497
4498 @item m3
4499 Set 3rd frame metadata key from which metadata values will be used to draw a graph.
4500
4501 @item fg3
4502 Set 3rd foreground color expression.
4503
4504 @item m4
4505 Set 4th frame metadata key from which metadata values will be used to draw a graph.
4506
4507 @item fg4
4508 Set 4th foreground color expression.
4509
4510 @item min
4511 Set minimal value of metadata value.
4512
4513 @item max
4514 Set maximal value of metadata value.
4515
4516 @item bg
4517 Set graph background color. Default is white.
4518
4519 @item mode
4520 Set graph mode.
4521
4522 Available values for mode is:
4523 @table @samp
4524 @item bar
4525 @item dot
4526 @item line
4527 @end table
4528
4529 Default is @code{line}.
4530
4531 @item slide
4532 Set slide mode.
4533
4534 Available values for slide is:
4535 @table @samp
4536 @item frame
4537 Draw new frame when right border is reached.
4538
4539 @item replace
4540 Replace old columns with new ones.
4541
4542 @item scroll
4543 Scroll from right to left.
4544
4545 @item rscroll
4546 Scroll from left to right.
4547 @end table
4548
4549 Default is @code{frame}.
4550
4551 @item size
4552 Set size of graph video. For the syntax of this option, check the
4553 @ref{video size syntax,,"Video size" section in the ffmpeg-utils manual,ffmpeg-utils}.
4554 The default value is @code{900x256}.
4555
4556 The foreground color expressions can use the following variables:
4557 @table @option
4558 @item MIN
4559 Minimal value of metadata value.
4560
4561 @item MAX
4562 Maximal value of metadata value.
4563
4564 @item VAL
4565 Current metadata key value.
4566 @end table
4567
4568 The color is defined as 0xAABBGGRR.
4569 @end table
4570
4571 Example using metadata from @ref{signalstats} filter:
4572 @example
4573 signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
4574 @end example
4575
4576 Example using metadata from @ref{ebur128} filter:
4577 @example
4578 ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
4579 @end example
4580
4581 @section drawgrid
4582
4583 Draw a grid on the input image.
4584
4585 It accepts the following parameters:
4586
4587 @table @option
4588 @item x
4589 @item y
4590 The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0.
4591
4592 @item width, w
4593 @item height, h
4594 The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the
4595 input width and height, respectively, minus @code{thickness}, so image gets
4596 framed. Default to 0.
4597
4598 @item color, c
4599 Specify the color of the grid. For the general syntax of this option,
4600 check the "Color" section in the ffmpeg-utils manual. If the special
4601 value @code{invert} is used, the grid color is the same as the
4602 video with inverted luma.
4603
4604 @item thickness, t
4605 The expression which sets the thickness of the grid line. Default value is @code{1}.
4606
4607 See below for the list of accepted constants.
4608 @end table
4609
4610 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
4611 following constants:
4612
4613 @table @option
4614 @item dar
4615 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
4616
4617 @item hsub
4618 @item vsub
4619 horizontal and vertical chroma subsample values. For example for the
4620 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4621
4622 @item in_h, ih
4623 @item in_w, iw
4624 The input grid cell width and height.
4625
4626 @item sar
4627 The input sample aspect ratio.
4628
4629 @item x
4630 @item y
4631 The x and y coordinates of some point of grid intersection (meant to configure offset).
4632
4633 @item w
4634 @item h
4635 The width and height of the drawn cell.
4636
4637 @item t
4638 The thickness of the drawn cell.
4639
4640 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
4641 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
4642
4643 @end table
4644
4645 @subsection Examples
4646
4647 @itemize
4648 @item
4649 Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%:
4650 @example
4651 drawgrid=width=100:height=100:thickness=2:color=red@@0.5
4652 @end example
4653
4654 @item
4655 Draw a white 3x3 grid with an opacity of 50%:
4656 @example
4657 drawgrid=w=iw/3:h=ih/3:t=2:c=white@@0.5
4658 @end example
4659 @end itemize
4660
4661 @anchor{drawtext}
4662 @section drawtext
4663
4664 Draw a text string or text from a specified file on top of a video, using the
4665 libfreetype library.
4666
4667 To enable compilation of this filter, you need to configure FFmpeg with
4668 @code{--enable-libfreetype}.
4669 To enable default font fallback and the @var{font} option you need to
4670 configure FFmpeg with @code{--enable-libfontconfig}.
4671 To enable the @var{text_shaping} option, you need to configure FFmpeg with
4672 @code{--enable-libfribidi}.
4673
4674 @subsection Syntax
4675
4676 It accepts the following parameters:
4677
4678 @table @option
4679
4680 @item box
4681 Used to draw a box around text using the background color.
4682 The value must be either 1 (enable) or 0 (disable).
4683 The default value of @var{box} is 0.
4684
4685 @item boxborderw
4686 Set the width of the border to be drawn around the box using @var{boxcolor}.
4687 The default value of @var{boxborderw} is 0.
4688
4689 @item boxcolor
4690 The color to be used for drawing box around text. For the syntax of this
4691 option, check the "Color" section in the ffmpeg-utils manual.
4692
4693 The default value of @var{boxcolor} is "white".
4694
4695 @item borderw
4696 Set the width of the border to be drawn around the text using @var{bordercolor}.
4697 The default value of @var{borderw} is 0.
4698
4699 @item bordercolor
4700 Set the color to be used for drawing border around text. For the syntax of this
4701 option, check the "Color" section in the ffmpeg-utils manual.
4702
4703 The default value of @var{bordercolor} is "black".
4704
4705 @item expansion
4706 Select how the @var{text} is expanded. Can be either @code{none},
4707 @code{strftime} (deprecated) or
4708 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
4709 below for details.
4710
4711 @item fix_bounds
4712 If true, check and fix text coords to avoid clipping.
4713
4714 @item fontcolor
4715 The color to be used for drawing fonts. For the syntax of this option, check
4716 the "Color" section in the ffmpeg-utils manual.
4717
4718 The default value of @var{fontcolor} is "black".
4719
4720 @item fontcolor_expr
4721 String which is expanded the same way as @var{text} to obtain dynamic
4722 @var{fontcolor} value. By default this option has empty value and is not
4723 processed. When this option is set, it overrides @var{fontcolor} option.
4724
4725 @item font
4726 The font family to be used for drawing text. By default Sans.
4727
4728 @item fontfile
4729 The font file to be used for drawing text. The path must be included.
4730 This parameter is mandatory if the fontconfig support is disabled.
4731
4732 @item draw
4733 This option does not exist, please see the timeline system
4734
4735 @item alpha
4736 Draw the text applying alpha blending. The value can
4737 be either a number between 0.0 and 1.0
4738 The expression accepts the same variables @var{x, y} do.
4739 The default value is 1.
4740 Please see fontcolor_expr
4741
4742 @item fontsize
4743 The font size to be used for drawing text.
4744 The default value of @var{fontsize} is 16.
4745
4746 @item text_shaping
4747 If set to 1, attempt to shape the text (for example, reverse the order of
4748 right-to-left text and join Arabic characters) before drawing it.
4749 Otherwise, just draw the text exactly as given.
4750 By default 1 (if supported).
4751
4752 @item ft_load_flags
4753 The flags to be used for loading the fonts.
4754
4755 The flags map the corresponding flags supported by libfreetype, and are
4756 a combination of the following values:
4757 @table @var
4758 @item default
4759 @item no_scale
4760 @item no_hinting
4761 @item render
4762 @item no_bitmap
4763 @item vertical_layout
4764 @item force_autohint
4765 @item crop_bitmap
4766 @item pedantic
4767 @item ignore_global_advance_width
4768 @item no_recurse
4769 @item ignore_transform
4770 @item monochrome
4771 @item linear_design
4772 @item no_autohint
4773 @end table
4774
4775 Default value is "default".
4776
4777 For more information consult the documentation for the FT_LOAD_*
4778 libfreetype flags.
4779
4780 @item shadowcolor
4781 The color to be used for drawing a shadow behind the drawn text. For the
4782 syntax of this option, check the "Color" section in the ffmpeg-utils manual.
4783
4784 The default value of @var{shadowcolor} is "black".
4785
4786 @item shadowx
4787 @item shadowy
4788 The x and y offsets for the text shadow position with respect to the
4789 position of the text. They can be either positive or negative
4790 values. The default value for both is "0".
4791
4792 @item start_number
4793 The starting frame number for the n/frame_num variable. The default value
4794 is "0".
4795
4796 @item tabsize
4797 The size in number of spaces to use for rendering the tab.
4798 Default value is 4.
4799
4800 @item timecode
4801 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
4802 format. It can be used with or without text parameter. @var{timecode_rate}
4803 option must be specified.
4804
4805 @item timecode_rate, rate, r
4806 Set the timecode frame rate (timecode only).
4807
4808 @item text
4809 The text string to be drawn. The text must be a sequence of UTF-8
4810 encoded characters.
4811 This parameter is mandatory if no file is specified with the parameter
4812 @var{textfile}.
4813
4814 @item textfile
4815 A text file containing text to be drawn. The text must be a sequence
4816 of UTF-8 encoded characters.
4817
4818 This parameter is mandatory if no text string is specified with the
4819 parameter @var{text}.
4820
4821 If both @var{text} and @var{textfile} are specified, an error is thrown.
4822
4823 @item reload
4824 If set to 1, the @var{textfile} will be reloaded before each frame.
4825 Be sure to update it atomically, or it may be read partially, or even fail.
4826
4827 @item x
4828 @item y
4829 The expressions which specify the offsets where text will be drawn
4830 within the video frame. They are relative to the top/left border of the
4831 output image.
4832
4833 The default value of @var{x} and @var{y} is "0".
4834
4835 See below for the list of accepted constants and functions.
4836 @end table
4837
4838 The parameters for @var{x} and @var{y} are expressions containing the
4839 following constants and functions:
4840
4841 @table @option
4842 @item dar
4843 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
4844
4845 @item hsub
4846 @item vsub
4847 horizontal and vertical chroma subsample values. For example for the
4848 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4849
4850 @item line_h, lh
4851 the height of each text line
4852
4853 @item main_h, h, H
4854 the input height
4855
4856 @item main_w, w, W
4857 the input width
4858
4859 @item max_glyph_a, ascent
4860 the maximum distance from the baseline to the highest/upper grid
4861 coordinate used to place a glyph outline point, for all the rendered
4862 glyphs.
4863 It is a positive value, due to the grid's orientation with the Y axis
4864 upwards.
4865
4866 @item max_glyph_d, descent
4867 the maximum distance from the baseline to the lowest grid coordinate
4868 used to place a glyph outline point, for all the rendered glyphs.
4869 This is a negative value, due to the grid's orientation, with the Y axis
4870 upwards.
4871
4872 @item max_glyph_h
4873 maximum glyph height, that is the maximum height for all the glyphs
4874 contained in the rendered text, it is equivalent to @var{ascent} -
4875 @var{descent}.
4876
4877 @item max_glyph_w
4878 maximum glyph width, that is the maximum width for all the glyphs
4879 contained in the rendered text
4880
4881 @item n
4882 the number of input frame, starting from 0
4883
4884 @item rand(min, max)
4885 return a random number included between @var{min} and @var{max}
4886
4887 @item sar
4888 The input sample aspect ratio.
4889
4890 @item t
4891 timestamp expressed in seconds, NAN if the input timestamp is unknown
4892
4893 @item text_h, th
4894 the height of the rendered text
4895
4896 @item text_w, tw
4897 the width of the rendered text
4898
4899 @item x
4900 @item y
4901 the x and y offset coordinates where the text is drawn.
4902
4903 These parameters allow the @var{x} and @var{y} expressions to refer
4904 each other, so you can for example specify @code{y=x/dar}.
4905 @end table
4906
4907 @anchor{drawtext_expansion}
4908 @subsection Text expansion
4909
4910 If @option{expansion} is set to @code{strftime},
4911 the filter recognizes strftime() sequences in the provided text and
4912 expands them accordingly. Check the documentation of strftime(). This
4913 feature is deprecated.
4914
4915 If @option{expansion} is set to @code{none}, the text is printed verbatim.
4916
4917 If @option{expansion} is set to @code{normal} (which is the default),
4918 the following expansion mechanism is used.
4919
4920 The backslash character @samp{\}, followed by any character, always expands to
4921 the second character.
4922
4923 Sequence of the form @code{%@{...@}} are expanded. The text between the
4924 braces is a function name, possibly followed by arguments separated by ':'.
4925 If the arguments contain special characters or delimiters (':' or '@}'),
4926 they should be escaped.
4927
4928 Note that they probably must also be escaped as the value for the
4929 @option{text} option in the filter argument string and as the filter
4930 argument in the filtergraph description, and possibly also for the shell,
4931 that makes up to four levels of escaping; using a text file avoids these
4932 problems.
4933
4934 The following functions are available:
4935
4936 @table @command
4937
4938 @item expr, e
4939 The expression evaluation result.
4940
4941 It must take one argument specifying the expression to be evaluated,
4942 which accepts the same constants and functions as the @var{x} and
4943 @var{y} values. Note that not all constants should be used, for
4944 example the text size is not known when evaluating the expression, so
4945 the constants @var{text_w} and @var{text_h} will have an undefined
4946 value.
4947
4948 @item expr_int_format, eif
4949 Evaluate the expression's value and output as formatted integer.
4950
4951 The first argument is the expression to be evaluated, just as for the @var{expr} function.
4952 The second argument specifies the output format. Allowed values are @samp{x},
4953 @samp{X}, @samp{d} and @samp{u}. They are treated exactly as in the
4954 @code{printf} function.
4955 The third parameter is optional and sets the number of positions taken by the output.
4956 It can be used to add padding with zeros from the left.
4957
4958 @item gmtime
4959 The time at which the filter is running, expressed in UTC.
4960 It can accept an argument: a strftime() format string.
4961
4962 @item localtime
4963 The time at which the filter is running, expressed in the local time zone.
4964 It can accept an argument: a strftime() format string.
4965
4966 @item metadata
4967 Frame metadata. It must take one argument specifying metadata key.
4968
4969 @item n, frame_num
4970 The frame number, starting from 0.
4971
4972 @item pict_type
4973 A 1 character description of the current picture type.
4974
4975 @item pts
4976 The timestamp of the current frame.
4977 It can take up to two arguments.
4978
4979 The first argument is the format of the timestamp; it defaults to @code{flt}
4980 for seconds as a decimal number with microsecond accuracy; @code{hms} stands
4981 for a formatted @var{[-]HH:MM:SS.mmm} timestamp with millisecond accuracy.
4982
4983 The second argument is an offset added to the timestamp.
4984
4985 @end table
4986
4987 @subsection Examples
4988
4989 @itemize
4990 @item
4991 Draw "Test Text" with font FreeSerif, using the default values for the
4992 optional parameters.
4993
4994 @example
4995 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
4996 @end example
4997
4998 @item
4999 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
5000 and y=50 (counting from the top-left corner of the screen), text is
5001 yellow with a red box around it. Both the text and the box have an
5002 opacity of 20%.
5003
5004 @example
5005 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
5006           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
5007 @end example
5008
5009 Note that the double quotes are not necessary if spaces are not used
5010 within the parameter list.
5011
5012 @item
5013 Show the text at the center of the video frame:
5014 @example
5015 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
5016 @end example
5017
5018 @item
5019 Show a text line sliding from right to left in the last row of the video
5020 frame. The file @file{LONG_LINE} is assumed to contain a single line
5021 with no newlines.
5022 @example
5023 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
5024 @end example
5025
5026 @item
5027 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
5028 @example
5029 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
5030 @end example
5031
5032 @item
5033 Draw a single green letter "g", at the center of the input video.
5034 The glyph baseline is placed at half screen height.
5035 @example
5036 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
5037 @end example
5038
5039 @item
5040 Show text for 1 second every 3 seconds:
5041 @example
5042 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'"
5043 @end example
5044
5045 @item
5046 Use fontconfig to set the font. Note that the colons need to be escaped.
5047 @example
5048 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
5049 @end example
5050
5051 @item
5052 Print the date of a real-time encoding (see strftime(3)):
5053 @example
5054 drawtext='fontfile=FreeSans.ttf:text=%@{localtime\:%a %b %d %Y@}'
5055 @end example
5056
5057 @item
5058 Show text fading in and out (appearing/disappearing):
5059 @example
5060 #!/bin/sh
5061 DS=1.0 # display start
5062 DE=10.0 # display end
5063 FID=1.5 # fade in duration
5064 FOD=5 # fade out duration
5065 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 @}"
5066 @end example
5067
5068 @end itemize
5069
5070 For more information about libfreetype, check:
5071 @url{http://www.freetype.org/}.
5072
5073 For more information about fontconfig, check:
5074 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
5075
5076 For more information about libfribidi,