doc/filters: fix afade cuve types listing
[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, it is possible for filters to have multiple inputs and
7 multiple outputs.
8 To illustrate the sorts of things that are possible, we can
9 use a complex filter graph. For example, the following one:
10
11 @example
12 input --> split ---------------------> overlay --> output
13             |                             ^
14             |                             |
15             +-----> crop --> vflip -------+
16 @end example
17
18 splits the stream in two streams, sends one stream through the crop filter
19 and the vflip filter before merging it back with the other stream by
20 overlaying it on top. You can use the following command to achieve this:
21
22 @example
23 ffmpeg -i input -vf "[in] split [T1], [T2] overlay=0:H/2 [out]; [T1] crop=iw:ih/2:0:ih/2, vflip [T2]" output
24 @end example
25
26 The result will be that in output the top half of the video is mirrored
27 onto the bottom half.
28
29 Filters are loaded using the @var{-vf} or @var{-af} option passed to
30 @command{ffmpeg} or to @command{ffplay}. Filters in the same linear
31 chain are separated by commas. In our example, @var{split,
32 overlay} are in one linear chain, and @var{crop, vflip} are in
33 another. The points where the linear chains join are labeled by names
34 enclosed in square brackets. In our example, that is @var{[T1]} and
35 @var{[T2]}. The special labels @var{[in]} and @var{[out]} are the points
36 where video is input and output.
37
38 Some filters take in input a list of parameters: they are specified
39 after the filter name and an equal sign, and are separated from each other
40 by a colon.
41
42 There exist so-called @var{source filters} that do not have an
43 audio/video input, and @var{sink filters} that will not have audio/video
44 output.
45
46 @c man end FILTERING INTRODUCTION
47
48 @chapter graph2dot
49 @c man begin GRAPH2DOT
50
51 The @file{graph2dot} program included in the FFmpeg @file{tools}
52 directory can be used to parse a filter graph description and issue a
53 corresponding textual representation in the dot language.
54
55 Invoke the command:
56 @example
57 graph2dot -h
58 @end example
59
60 to see how to use @file{graph2dot}.
61
62 You can then pass the dot description to the @file{dot} program (from
63 the graphviz suite of programs) and obtain a graphical representation
64 of the filter graph.
65
66 For example the sequence of commands:
67 @example
68 echo @var{GRAPH_DESCRIPTION} | \
69 tools/graph2dot -o graph.tmp && \
70 dot -Tpng graph.tmp -o graph.png && \
71 display graph.png
72 @end example
73
74 can be used to create and display an image representing the graph
75 described by the @var{GRAPH_DESCRIPTION} string. Note that this string must be
76 a complete self-contained graph, with its inputs and outputs explicitly defined.
77 For example if your command line is of the form:
78 @example
79 ffmpeg -i infile -vf scale=640:360 outfile
80 @end example
81 your @var{GRAPH_DESCRIPTION} string will need to be of the form:
82 @example
83 nullsrc,scale=640:360,nullsink
84 @end example
85 you may also need to set the @var{nullsrc} parameters and add a @var{format}
86 filter in order to simulate a specific input file.
87
88 @c man end GRAPH2DOT
89
90 @chapter Filtergraph description
91 @c man begin FILTERGRAPH DESCRIPTION
92
93 A filtergraph is a directed graph of connected filters. It can contain
94 cycles, and there can be multiple links between a pair of
95 filters. Each link has one input pad on one side connecting it to one
96 filter from which it takes its input, and one output pad on the other
97 side connecting it to the one filter accepting its output.
98
99 Each filter in a filtergraph is an instance of a filter class
100 registered in the application, which defines the features and the
101 number of input and output pads of the filter.
102
103 A filter with no input pads is called a "source", a filter with no
104 output pads is called a "sink".
105
106 @anchor{Filtergraph syntax}
107 @section Filtergraph syntax
108
109 A filtergraph can be represented using a textual representation, which is
110 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
111 options in @command{ffmpeg} and @option{-vf} in @command{ffplay}, and by the
112 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
113 @file{libavfilter/avfiltergraph.h}.
114
115 A filterchain consists of a sequence of connected filters, each one
116 connected to the previous one in the sequence. A filterchain is
117 represented by a list of ","-separated filter descriptions.
118
119 A filtergraph consists of a sequence of filterchains. A sequence of
120 filterchains is represented by a list of ";"-separated filterchain
121 descriptions.
122
123 A filter is represented by a string of the form:
124 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
125
126 @var{filter_name} is the name of the filter class of which the
127 described filter is an instance of, and has to be the name of one of
128 the filter classes registered in the program.
129 The name of the filter class is optionally followed by a string
130 "=@var{arguments}".
131
132 @var{arguments} is a string which contains the parameters used to
133 initialize the filter instance, and are described in the filter
134 descriptions below.
135
136 The list of arguments can be quoted using the character "'" as initial
137 and ending mark, and the character '\' for escaping the characters
138 within the quoted text; otherwise the argument string is considered
139 terminated when the next special character (belonging to the set
140 "[]=;,") is encountered.
141
142 The name and arguments of the filter are optionally preceded and
143 followed by a list of link labels.
144 A link label allows to name a link and associate it to a filter output
145 or input pad. The preceding labels @var{in_link_1}
146 ... @var{in_link_N}, are associated to the filter input pads,
147 the following labels @var{out_link_1} ... @var{out_link_M}, are
148 associated to the output pads.
149
150 When two link labels with the same name are found in the
151 filtergraph, a link between the corresponding input and output pad is
152 created.
153
154 If an output pad is not labelled, it is linked by default to the first
155 unlabelled input pad of the next filter in the filterchain.
156 For example in the filterchain:
157 @example
158 nullsrc, split[L1], [L2]overlay, nullsink
159 @end example
160 the split filter instance has two output pads, and the overlay filter
161 instance two input pads. The first output pad of split is labelled
162 "L1", the first input pad of overlay is labelled "L2", and the second
163 output pad of split is linked to the second input pad of overlay,
164 which are both unlabelled.
165
166 In a complete filterchain all the unlabelled filter input and output
167 pads must be connected. A filtergraph is considered valid if all the
168 filter input and output pads of all the filterchains are connected.
169
170 Libavfilter will automatically insert scale filters where format
171 conversion is required. It is possible to specify swscale flags
172 for those automatically inserted scalers by prepending
173 @code{sws_flags=@var{flags};}
174 to the filtergraph description.
175
176 Follows a BNF description for the filtergraph syntax:
177 @example
178 @var{NAME}             ::= sequence of alphanumeric characters and '_'
179 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
180 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
181 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
182 @var{FILTER}           ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
183 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
184 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
185 @end example
186
187 @section Notes on filtergraph escaping
188
189 Some filter arguments require the use of special characters, typically
190 @code{:} to separate key=value pairs in a named options list. In this
191 case the user should perform a first level escaping when specifying
192 the filter arguments. For example, consider the following literal
193 string to be embedded in the @ref{drawtext} filter arguments:
194 @example
195 this is a 'string': may contain one, or more, special characters
196 @end example
197
198 Since @code{:} is special for the filter arguments syntax, it needs to
199 be escaped, so you get:
200 @example
201 text=this is a \'string\'\: may contain one, or more, special characters
202 @end example
203
204 A second level of escaping is required when embedding the filter
205 arguments in a filtergraph description, in order to escape all the
206 filtergraph special characters. Thus the example above becomes:
207 @example
208 drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
209 @end example
210
211 Finally an additional level of escaping may be needed when writing the
212 filtergraph description in a shell command, which depends on the
213 escaping rules of the adopted shell. For example, assuming that
214 @code{\} is special and needs to be escaped with another @code{\}, the
215 previous string will finally result in:
216 @example
217 -vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
218 @end example
219
220 Sometimes, it might be more convenient to employ quoting in place of
221 escaping. For example the string:
222 @example
223 Caesar: tu quoque, Brute, fili mi
224 @end example
225
226 Can be quoted in the filter arguments as:
227 @example
228 text='Caesar: tu quoque, Brute, fili mi'
229 @end example
230
231 And finally inserted in a filtergraph like:
232 @example
233 drawtext=text=\'Caesar: tu quoque\, Brute\, fili mi\'
234 @end example
235
236 See the ``Quoting and escaping'' section in the ffmpeg-utils manual
237 for more information about the escaping and quoting rules adopted by
238 FFmpeg.
239
240 @c man end FILTERGRAPH DESCRIPTION
241
242 @chapter Audio Filters
243 @c man begin AUDIO FILTERS
244
245 When you configure your FFmpeg build, you can disable any of the
246 existing filters using @code{--disable-filters}.
247 The configure output will show the audio filters included in your
248 build.
249
250 Below is a description of the currently available audio filters.
251
252 @section aconvert
253
254 Convert the input audio format to the specified formats.
255
256 The filter accepts a string of the form:
257 "@var{sample_format}:@var{channel_layout}".
258
259 @var{sample_format} specifies the sample format, and can be a string or the
260 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
261 suffix for a planar sample format.
262
263 @var{channel_layout} specifies the channel layout, and can be a string
264 or the corresponding number value defined in @file{libavutil/channel_layout.h}.
265
266 The special parameter "auto", signifies that the filter will
267 automatically select the output format depending on the output filter.
268
269 Some examples follow.
270
271 @itemize
272 @item
273 Convert input to float, planar, stereo:
274 @example
275 aconvert=fltp:stereo
276 @end example
277
278 @item
279 Convert input to unsigned 8-bit, automatically select out channel layout:
280 @example
281 aconvert=u8:auto
282 @end example
283 @end itemize
284
285 @section allpass
286
287 Apply a two-pole all-pass filter with central frequency (in Hz)
288 @var{frequency}, and filter-width @var{width}.
289 An all-pass filter changes the audio's frequency to phase relationship
290 without changing its frequency to amplitude relationship.
291
292 The filter accepts parameters as a list of @var{key}=@var{value}
293 pairs, separated by ":".
294
295 A description of the accepted parameters follows.
296
297 @table @option
298 @item frequency, f
299 Set frequency in Hz.
300
301 @item width_type
302 Set method to specify band-width of filter.
303 @table @option
304 @item @var{h} (Hz)
305 @item @var{q} (Q-Factor)
306 @item @var{o} (octave)
307 @item @var{s} (slope)
308 @end table
309
310 @item width, w
311 Specify the band-width of a filter in width_type units.
312 @end table
313
314 @section highpass
315
316 Apply a high-pass filter with 3dB point frequency.
317 The filter can be either single-pole, or double-pole (the default).
318 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
319
320 The filter accepts parameters as a list of @var{key}=@var{value}
321 pairs, separated by ":".
322
323 A description of the accepted parameters follows.
324
325 @table @option
326 @item frequency, f
327 Set frequency in Hz. Default is 3000.
328
329 @item poles, p
330 Set number of poles. Default is 2.
331
332 @item width_type
333 Set method to specify band-width of filter.
334 @table @option
335 @item @var{h} (Hz)
336 @item @var{q} (Q-Factor)
337 @item @var{o} (octave)
338 @item @var{s} (slope)
339 @end table
340
341 @item width, w
342 Specify the band-width of a filter in width_type units.
343 Applies only to double-pole filter.
344 The default is 0.707q and gives a Butterworth response.
345 @end table
346
347 @section lowpass
348
349 Apply a low-pass filter with 3dB point frequency.
350 The filter can be either single-pole or double-pole (the default).
351 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
352
353 The filter accepts parameters as a list of @var{key}=@var{value}
354 pairs, separated by ":".
355
356 A description of the accepted parameters follows.
357
358 @table @option
359 @item frequency, f
360 Set frequency in Hz. Default is 500.
361
362 @item poles, p
363 Set number of poles. Default is 2.
364
365 @item width_type
366 Set method to specify band-width of filter.
367 @table @option
368 @item @var{h} (Hz)
369 @item @var{q} (Q-Factor)
370 @item @var{o} (octave)
371 @item @var{s} (slope)
372 @end table
373
374 @item width, w
375 Specify the band-width of a filter in width_type units.
376 Applies only to double-pole filter.
377 The default is 0.707q and gives a Butterworth response.
378 @end table
379
380 @section bass
381
382 Boost or cut the bass (lower) frequencies of the audio using a two-pole
383 shelving filter with a response similar to that of a standard
384 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
385
386 The filter accepts parameters as a list of @var{key}=@var{value}
387 pairs, separated by ":".
388
389 A description of the accepted parameters follows.
390
391 @table @option
392 @item gain, g
393 Give the gain at 0 Hz. Its useful range is about -20
394 (for a large cut) to +20 (for a large boost).
395 Beware of clipping when using a positive gain.
396
397 @item frequency, f
398 Set the filter's central frequency and so can be used
399 to extend or reduce the frequency range to be boosted or cut.
400 The default value is @code{100} Hz.
401
402 @item width_type
403 Set method to specify band-width of filter.
404 @table @option
405 @item @var{h} (Hz)
406 @item @var{q} (Q-Factor)
407 @item @var{o} (octave)
408 @item @var{s} (slope)
409 @end table
410
411 @item width, w
412 Determine how steep is the filter's shelf transition.
413 @end table
414
415 @section treble
416
417 Boost or cut treble (upper) frequencies of the audio using a two-pole
418 shelving filter with a response similar to that of a standard
419 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
420
421 The filter accepts parameters as a list of @var{key}=@var{value}
422 pairs, separated by ":".
423
424 A description of the accepted parameters follows.
425
426 @table @option
427 @item gain, g
428 Give the gain at whichever is the lower of ~22 kHz and the
429 Nyquist frequency. Its useful range is about -20 (for a large cut)
430 to +20 (for a large boost). Beware of clipping when using a positive gain.
431
432 @item frequency, f
433 Set the filter's central frequency and so can be used
434 to extend or reduce the frequency range to be boosted or cut.
435 The default value is @code{3000} Hz.
436
437 @item width_type
438 Set method to specify band-width of filter.
439 @table @option
440 @item @var{h} (Hz)
441 @item @var{q} (Q-Factor)
442 @item @var{o} (octave)
443 @item @var{s} (slope)
444 @end table
445
446 @item width, w
447 Determine how steep is the filter's shelf transition.
448 @end table
449
450 @section bandpass
451
452 Apply a two-pole Butterworth band-pass filter with central
453 frequency @var{frequency}, and (3dB-point) band-width width.
454 The @var{csg} option selects a constant skirt gain (peak gain = Q)
455 instead of the default: constant 0dB peak gain.
456 The filter roll off at 6dB per octave (20dB per decade).
457
458 The filter accepts parameters as a list of @var{key}=@var{value}
459 pairs, separated by ":".
460
461 A description of the accepted parameters follows.
462
463 @table @option
464 @item frequency, f
465 Set the filter's central frequency. Default is @code{3000}.
466
467 @item csg
468 Constant skirt gain if set to 1. Defaults to 0.
469
470 @item width_type
471 Set method to specify band-width of filter.
472 @table @option
473 @item @var{h} (Hz)
474 @item @var{q} (Q-Factor)
475 @item @var{o} (octave)
476 @item @var{s} (slope)
477 @end table
478
479 @item width, w
480 Specify the band-width of a filter in width_type units.
481 @end table
482
483 @section bandreject
484
485 Apply a two-pole Butterworth band-reject filter with central
486 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
487 The filter roll off at 6dB per octave (20dB per decade).
488
489 The filter accepts parameters as a list of @var{key}=@var{value}
490 pairs, separated by ":".
491
492 A description of the accepted parameters follows.
493
494 @table @option
495 @item frequency, f
496 Set the filter's central frequency. Default is @code{3000}.
497
498 @item width_type
499 Set method to specify band-width of filter.
500 @table @option
501 @item @var{h} (Hz)
502 @item @var{q} (Q-Factor)
503 @item @var{o} (octave)
504 @item @var{s} (slope)
505 @end table
506
507 @item width, w
508 Specify the band-width of a filter in width_type units.
509 @end table
510
511 @section biquad
512
513 Apply a biquad IIR filter with the given coefficients.
514 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
515 are the numerator and denominator coefficients respectively.
516
517 @section equalizer
518
519 Apply a two-pole peaking equalisation (EQ) filter. With this
520 filter, the signal-level at and around a selected frequency can
521 be increased or decreased, whilst (unlike bandpass and bandreject
522 filters) that at all other frequencies is unchanged.
523
524 In order to produce complex equalisation curves, this filter can
525 be given several times, each with a different central frequency.
526
527 The filter accepts parameters as a list of @var{key}=@var{value}
528 pairs, separated by ":".
529
530 A description of the accepted parameters follows.
531
532 @table @option
533 @item frequency, f
534 Set the filter's central frequency in Hz.
535
536 @item width_type
537 Set method to specify band-width of filter.
538 @table @option
539 @item @var{h} (Hz)
540 @item @var{q} (Q-Factor)
541 @item @var{o} (octave)
542 @item @var{s} (slope)
543 @end table
544
545 @item width, w
546 Specify the band-width of a filter in width_type units.
547
548 @item gain, g
549 Set the required gain or attenuation in dB.
550 Beware of clipping when using a positive gain.
551 @end table
552
553 @section afade
554
555 Apply fade-in/out effect to input audio.
556
557 The filter accepts parameters as a list of @var{key}=@var{value}
558 pairs, separated by ":".
559
560 A description of the accepted parameters follows.
561
562 @table @option
563 @item type, t
564 Specify the effect type, can be either @code{in} for fade-in, or
565 @code{out} for a fade-out effect. Default is @code{in}.
566
567 @item start_sample, ss
568 Specify the number of the start sample for starting to apply the fade
569 effect. Default is 0.
570
571 @item nb_samples, ns
572 Specify the number of samples for which the fade effect has to last. At
573 the end of the fade-in effect the output audio will have the same
574 volume as the input audio, at the end of the fade-out transition
575 the output audio will be silence. Default is 44100.
576
577 @item start_time, st
578 Specify time in seconds for starting to apply the fade
579 effect. Default is 0.
580 If set this option is used instead of @var{start_sample} one.
581
582 @item duration, d
583 Specify the number of seconds for which the fade effect has to last. At
584 the end of the fade-in effect the output audio will have the same
585 volume as the input audio, at the end of the fade-out transition
586 the output audio will be silence. Default is 0.
587 If set this option is used instead of @var{nb_samples} one.
588
589 @item curve
590 Set cuve for fade transition.
591 @table @option
592 @item @var{tri}  (triangular, linear slope (default))
593 @item @var{qsin} (quarter of sine wave)
594 @item @var{hsin} (half of sine wave)
595 @item @var{esin} (exponential sine wave)
596 @item @var{log}  (logarithmic)
597 @item @var{par}  (inverted parabola)
598 @item @var{qua}  (quadratic)
599 @item @var{cub}  (cubic)
600 @item @var{squ}  (square root)
601 @item @var{cbr}  (cubic root)
602 @end table
603 @end table
604
605 @subsection Examples
606 @itemize
607 @item
608 Fade in first 15 seconds of audio:
609 @example
610 afade=t=in:ss=0:d=15
611 @end example
612
613 @item
614 Fade out last 25 seconds of a 900 seconds audio:
615 @example
616 afade=t=out:ss=875:d=25
617 @end example
618 @end itemize
619
620 @section aformat
621
622 Set output format constraints for the input audio. The framework will
623 negotiate the most appropriate format to minimize conversions.
624
625 The filter accepts the following named parameters:
626 @table @option
627
628 @item sample_fmts
629 A comma-separated list of requested sample formats.
630
631 @item sample_rates
632 A comma-separated list of requested sample rates.
633
634 @item channel_layouts
635 A comma-separated list of requested channel layouts.
636
637 @end table
638
639 If a parameter is omitted, all values are allowed.
640
641 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
642 @example
643 aformat='sample_fmts=u8,s16:channel_layouts=stereo'
644 @end example
645
646 @section amerge
647
648 Merge two or more audio streams into a single multi-channel stream.
649
650 The filter accepts the following named options:
651
652 @table @option
653
654 @item inputs
655 Set the number of inputs. Default is 2.
656
657 @end table
658
659 If the channel layouts of the inputs are disjoint, and therefore compatible,
660 the channel layout of the output will be set accordingly and the channels
661 will be reordered as necessary. If the channel layouts of the inputs are not
662 disjoint, the output will have all the channels of the first input then all
663 the channels of the second input, in that order, and the channel layout of
664 the output will be the default value corresponding to the total number of
665 channels.
666
667 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
668 is FC+BL+BR, then the output will be in 5.1, with the channels in the
669 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
670 first input, b1 is the first channel of the second input).
671
672 On the other hand, if both input are in stereo, the output channels will be
673 in the default order: a1, a2, b1, b2, and the channel layout will be
674 arbitrarily set to 4.0, which may or may not be the expected value.
675
676 All inputs must have the same sample rate, and format.
677
678 If inputs do not have the same duration, the output will stop with the
679 shortest.
680
681 Example: merge two mono files into a stereo stream:
682 @example
683 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
684 @end example
685
686 Example: multiple merges:
687 @example
688 ffmpeg -f lavfi -i "
689 amovie=input.mkv:si=0 [a0];
690 amovie=input.mkv:si=1 [a1];
691 amovie=input.mkv:si=2 [a2];
692 amovie=input.mkv:si=3 [a3];
693 amovie=input.mkv:si=4 [a4];
694 amovie=input.mkv:si=5 [a5];
695 [a0][a1][a2][a3][a4][a5] amerge=inputs=6" -c:a pcm_s16le output.mkv
696 @end example
697
698 @section amix
699
700 Mixes multiple audio inputs into a single output.
701
702 For example
703 @example
704 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
705 @end example
706 will mix 3 input audio streams to a single output with the same duration as the
707 first input and a dropout transition time of 3 seconds.
708
709 The filter accepts the following named parameters:
710 @table @option
711
712 @item inputs
713 Number of inputs. If unspecified, it defaults to 2.
714
715 @item duration
716 How to determine the end-of-stream.
717 @table @option
718
719 @item longest
720 Duration of longest input. (default)
721
722 @item shortest
723 Duration of shortest input.
724
725 @item first
726 Duration of first input.
727
728 @end table
729
730 @item dropout_transition
731 Transition time, in seconds, for volume renormalization when an input
732 stream ends. The default value is 2 seconds.
733
734 @end table
735
736 @section anull
737
738 Pass the audio source unchanged to the output.
739
740 @section apad
741
742 Pad the end of a audio stream with silence, this can be used together with
743 -shortest to extend audio streams to the same length as the video stream.
744
745 @anchor{aresample}
746 @section aresample
747
748 Resample the input audio to the specified parameters, using the
749 libswresample library. If none are specified then the filter will
750 automatically convert between its input and output.
751
752 This filter is also able to stretch/squeeze the audio data to make it match
753 the timestamps or to inject silence / cut out audio to make it match the
754 timestamps, do a combination of both or do neither.
755
756 The filter accepts the syntax
757 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
758 expresses a sample rate and @var{resampler_options} is a list of
759 @var{key}=@var{value} pairs, separated by ":". See the
760 ffmpeg-resampler manual for the complete list of supported options.
761
762 For example, to resample the input audio to 44100Hz:
763 @example
764 aresample=44100
765 @end example
766
767 To stretch/squeeze samples to the given timestamps, with a maximum of 1000
768 samples per second compensation:
769 @example
770 aresample=async=1000
771 @end example
772
773 @section asetnsamples
774
775 Set the number of samples per each output audio frame.
776
777 The last output packet may contain a different number of samples, as
778 the filter will flush all the remaining samples when the input audio
779 signal its end.
780
781 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
782 separated by ":".
783
784 @table @option
785
786 @item nb_out_samples, n
787 Set the number of frames per each output audio frame. The number is
788 intended as the number of samples @emph{per each channel}.
789 Default value is 1024.
790
791 @item pad, p
792 If set to 1, the filter will pad the last audio frame with zeroes, so
793 that the last frame will contain the same number of samples as the
794 previous ones. Default value is 1.
795 @end table
796
797 For example, to set the number of per-frame samples to 1234 and
798 disable padding for the last frame, use:
799 @example
800 asetnsamples=n=1234:p=0
801 @end example
802
803 @section ashowinfo
804
805 Show a line containing various information for each input audio frame.
806 The input audio is not modified.
807
808 The shown line contains a sequence of key/value pairs of the form
809 @var{key}:@var{value}.
810
811 A description of each shown parameter follows:
812
813 @table @option
814 @item n
815 sequential number of the input frame, starting from 0
816
817 @item pts
818 Presentation timestamp of the input frame, in time base units; the time base
819 depends on the filter input pad, and is usually 1/@var{sample_rate}.
820
821 @item pts_time
822 presentation timestamp of the input frame in seconds
823
824 @item pos
825 position of the frame in the input stream, -1 if this information in
826 unavailable and/or meaningless (for example in case of synthetic audio)
827
828 @item fmt
829 sample format
830
831 @item chlayout
832 channel layout
833
834 @item rate
835 sample rate for the audio frame
836
837 @item nb_samples
838 number of samples (per channel) in the frame
839
840 @item checksum
841 Adler-32 checksum (printed in hexadecimal) of the audio data. For planar audio
842 the data is treated as if all the planes were concatenated.
843
844 @item plane_checksums
845 A list of Adler-32 checksums for each data plane.
846 @end table
847
848 @section asplit
849
850 Split input audio into several identical outputs.
851
852 The filter accepts a single parameter which specifies the number of outputs. If
853 unspecified, it defaults to 2.
854
855 For example:
856 @example
857 [in] asplit [out0][out1]
858 @end example
859
860 will create two separate outputs from the same input.
861
862 To create 3 or more outputs, you need to specify the number of
863 outputs, like in:
864 @example
865 [in] asplit=3 [out0][out1][out2]
866 @end example
867
868 @example
869 ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
870 @end example
871 will create 5 copies of the input audio.
872
873
874 @section astreamsync
875
876 Forward two audio streams and control the order the buffers are forwarded.
877
878 The argument to the filter is an expression deciding which stream should be
879 forwarded next: if the result is negative, the first stream is forwarded; if
880 the result is positive or zero, the second stream is forwarded. It can use
881 the following variables:
882
883 @table @var
884 @item b1 b2
885 number of buffers forwarded so far on each stream
886 @item s1 s2
887 number of samples forwarded so far on each stream
888 @item t1 t2
889 current timestamp of each stream
890 @end table
891
892 The default value is @code{t1-t2}, which means to always forward the stream
893 that has a smaller timestamp.
894
895 Example: stress-test @code{amerge} by randomly sending buffers on the wrong
896 input, while avoiding too much of a desynchronization:
897 @example
898 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
899 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
900 [a2] [b2] amerge
901 @end example
902
903 @section atempo
904
905 Adjust audio tempo.
906
907 The filter accepts exactly one parameter, the audio tempo. If not
908 specified then the filter will assume nominal 1.0 tempo. Tempo must
909 be in the [0.5, 2.0] range.
910
911 For example, to slow down audio to 80% tempo:
912 @example
913 atempo=0.8
914 @end example
915
916 For example, to speed up audio to 125% tempo:
917 @example
918 atempo=1.25
919 @end example
920
921 @section earwax
922
923 Make audio easier to listen to on headphones.
924
925 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
926 so that when listened to on headphones the stereo image is moved from
927 inside your head (standard for headphones) to outside and in front of
928 the listener (standard for speakers).
929
930 Ported from SoX.
931
932 @section pan
933
934 Mix channels with specific gain levels. The filter accepts the output
935 channel layout followed by a set of channels definitions.
936
937 This filter is also designed to remap efficiently the channels of an audio
938 stream.
939
940 The filter accepts parameters of the form:
941 "@var{l}:@var{outdef}:@var{outdef}:..."
942
943 @table @option
944 @item l
945 output channel layout or number of channels
946
947 @item outdef
948 output channel specification, of the form:
949 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
950
951 @item out_name
952 output channel to define, either a channel name (FL, FR, etc.) or a channel
953 number (c0, c1, etc.)
954
955 @item gain
956 multiplicative coefficient for the channel, 1 leaving the volume unchanged
957
958 @item in_name
959 input channel to use, see out_name for details; it is not possible to mix
960 named and numbered input channels
961 @end table
962
963 If the `=' in a channel specification is replaced by `<', then the gains for
964 that specification will be renormalized so that the total is 1, thus
965 avoiding clipping noise.
966
967 @subsection Mixing examples
968
969 For example, if you want to down-mix from stereo to mono, but with a bigger
970 factor for the left channel:
971 @example
972 pan=1:c0=0.9*c0+0.1*c1
973 @end example
974
975 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
976 7-channels surround:
977 @example
978 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
979 @end example
980
981 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
982 that should be preferred (see "-ac" option) unless you have very specific
983 needs.
984
985 @subsection Remapping examples
986
987 The channel remapping will be effective if, and only if:
988
989 @itemize
990 @item gain coefficients are zeroes or ones,
991 @item only one input per channel output,
992 @end itemize
993
994 If all these conditions are satisfied, the filter will notify the user ("Pure
995 channel mapping detected"), and use an optimized and lossless method to do the
996 remapping.
997
998 For example, if you have a 5.1 source and want a stereo audio stream by
999 dropping the extra channels:
1000 @example
1001 pan="stereo: c0=FL : c1=FR"
1002 @end example
1003
1004 Given the same source, you can also switch front left and front right channels
1005 and keep the input channel layout:
1006 @example
1007 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
1008 @end example
1009
1010 If the input is a stereo audio stream, you can mute the front left channel (and
1011 still keep the stereo channel layout) with:
1012 @example
1013 pan="stereo:c1=c1"
1014 @end example
1015
1016 Still with a stereo audio stream input, you can copy the right channel in both
1017 front left and right:
1018 @example
1019 pan="stereo: c0=FR : c1=FR"
1020 @end example
1021
1022 @section silencedetect
1023
1024 Detect silence in an audio stream.
1025
1026 This filter logs a message when it detects that the input audio volume is less
1027 or equal to a noise tolerance value for a duration greater or equal to the
1028 minimum detected noise duration.
1029
1030 The printed times and duration are expressed in seconds.
1031
1032 @table @option
1033 @item duration, d
1034 Set silence duration until notification (default is 2 seconds).
1035
1036 @item noise, n
1037 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
1038 specified value) or amplitude ratio. Default is -60dB, or 0.001.
1039 @end table
1040
1041 Detect 5 seconds of silence with -50dB noise tolerance:
1042 @example
1043 silencedetect=n=-50dB:d=5
1044 @end example
1045
1046 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
1047 tolerance in @file{silence.mp3}:
1048 @example
1049 ffmpeg -f lavfi -i amovie=silence.mp3,silencedetect=noise=0.0001 -f null -
1050 @end example
1051
1052 @section asyncts
1053 Synchronize audio data with timestamps by squeezing/stretching it and/or
1054 dropping samples/adding silence when needed.
1055
1056 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
1057
1058 The filter accepts the following named parameters:
1059 @table @option
1060
1061 @item compensate
1062 Enable stretching/squeezing the data to make it match the timestamps. Disabled
1063 by default. When disabled, time gaps are covered with silence.
1064
1065 @item min_delta
1066 Minimum difference between timestamps and audio data (in seconds) to trigger
1067 adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
1068 this filter, try setting this parameter to 0.
1069
1070 @item max_comp
1071 Maximum compensation in samples per second. Relevant only with compensate=1.
1072 Default value 500.
1073
1074 @item first_pts
1075 Assume the first pts should be this value. The time base is 1 / sample rate.
1076 This allows for padding/trimming at the start of stream. By default, no
1077 assumption is made about the first frame's expected pts, so no padding or
1078 trimming is done. For example, this could be set to 0 to pad the beginning with
1079 silence if an audio stream starts after the video stream or to trim any samples
1080 with a negative pts due to encoder delay.
1081
1082 @end table
1083
1084 @section channelsplit
1085 Split each channel in input audio stream into a separate output stream.
1086
1087 This filter accepts the following named parameters:
1088 @table @option
1089 @item channel_layout
1090 Channel layout of the input stream. Default is "stereo".
1091 @end table
1092
1093 For example, assuming a stereo input MP3 file
1094 @example
1095 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1096 @end example
1097 will create an output Matroska file with two audio streams, one containing only
1098 the left channel and the other the right channel.
1099
1100 To split a 5.1 WAV file into per-channel files
1101 @example
1102 ffmpeg -i in.wav -filter_complex
1103 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1104 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1105 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1106 side_right.wav
1107 @end example
1108
1109 @section channelmap
1110 Remap input channels to new locations.
1111
1112 This filter accepts the following named parameters:
1113 @table @option
1114 @item channel_layout
1115 Channel layout of the output stream.
1116
1117 @item map
1118 Map channels from input to output. The argument is a comma-separated list of
1119 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1120 @var{in_channel} form. @var{in_channel} can be either the name of the input
1121 channel (e.g. FL for front left) or its index in the input channel layout.
1122 @var{out_channel} is the name of the output channel or its index in the output
1123 channel layout. If @var{out_channel} is not given then it is implicitly an
1124 index, starting with zero and increasing by one for each mapping.
1125 @end table
1126
1127 If no mapping is present, the filter will implicitly map input channels to
1128 output channels preserving index.
1129
1130 For example, assuming a 5.1+downmix input MOV file
1131 @example
1132 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL\,DR-FR' out.wav
1133 @end example
1134 will create an output WAV file tagged as stereo from the downmix channels of
1135 the input.
1136
1137 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1138 @example
1139 ffmpeg -i in.wav -filter 'channelmap=1\,2\,0\,5\,3\,4:channel_layout=5.1' out.wav
1140 @end example
1141
1142 @section join
1143 Join multiple input streams into one multi-channel stream.
1144
1145 The filter accepts the following named parameters:
1146 @table @option
1147
1148 @item inputs
1149 Number of input streams. Defaults to 2.
1150
1151 @item channel_layout
1152 Desired output channel layout. Defaults to stereo.
1153
1154 @item map
1155 Map channels from inputs to output. The argument is a comma-separated list of
1156 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1157 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1158 can be either the name of the input channel (e.g. FL for front left) or its
1159 index in the specified input stream. @var{out_channel} is the name of the output
1160 channel.
1161 @end table
1162
1163 The filter will attempt to guess the mappings when those are not specified
1164 explicitly. It does so by first trying to find an unused matching input channel
1165 and if that fails it picks the first unused input channel.
1166
1167 E.g. to join 3 inputs (with properly set channel layouts)
1168 @example
1169 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1170 @end example
1171
1172 To build a 5.1 output from 6 single-channel streams:
1173 @example
1174 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1175 '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'
1176 out
1177 @end example
1178
1179 @section resample
1180 Convert the audio sample format, sample rate and channel layout. This filter is
1181 not meant to be used directly.
1182
1183 @section volume
1184
1185 Adjust the input audio volume.
1186
1187 The filter accepts the following named parameters. If the key of the
1188 first options is omitted, the arguments are interpreted according to
1189 the following syntax:
1190 @example
1191 volume=@var{volume}:@var{precision}
1192 @end example
1193
1194 @table @option
1195
1196 @item volume
1197 Expresses how the audio volume will be increased or decreased.
1198
1199 Output values are clipped to the maximum value.
1200
1201 The output audio volume is given by the relation:
1202 @example
1203 @var{output_volume} = @var{volume} * @var{input_volume}
1204 @end example
1205
1206 Default value for @var{volume} is 1.0.
1207
1208 @item precision
1209 Set the mathematical precision.
1210
1211 This determines which input sample formats will be allowed, which affects the
1212 precision of the volume scaling.
1213
1214 @table @option
1215 @item fixed
1216 8-bit fixed-point; limits input sample format to U8, S16, and S32.
1217 @item float
1218 32-bit floating-point; limits input sample format to FLT. (default)
1219 @item double
1220 64-bit floating-point; limits input sample format to DBL.
1221 @end table
1222 @end table
1223
1224 @subsection Examples
1225
1226 @itemize
1227 @item
1228 Halve the input audio volume:
1229 @example
1230 volume=volume=0.5
1231 volume=volume=1/2
1232 volume=volume=-6.0206dB
1233 @end example
1234
1235 In all the above example the named key for @option{volume} can be
1236 omitted, for example like in:
1237 @example
1238 volume=0.5
1239 @end example
1240
1241 @item
1242 Increase input audio power by 6 decibels using fixed-point precision:
1243 @example
1244 volume=volume=6dB:precision=fixed
1245 @end example
1246 @end itemize
1247
1248 @section volumedetect
1249
1250 Detect the volume of the input video.
1251
1252 The filter has no parameters. The input is not modified. Statistics about
1253 the volume will be printed in the log when the input stream end is reached.
1254
1255 In particular it will show the mean volume (root mean square), maximum
1256 volume (on a per-sample basis), and the beginning of an histogram of the
1257 registered volume values (from the maximum value to a cumulated 1/1000 of
1258 the samples).
1259
1260 All volumes are in decibels relative to the maximum PCM value.
1261
1262 Here is an excerpt of the output:
1263 @example
1264 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
1265 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
1266 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
1267 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
1268 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
1269 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
1270 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
1271 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
1272 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
1273 @end example
1274
1275 It means that:
1276 @itemize
1277 @item
1278 The mean square energy is approximately -27 dB, or 10^-2.7.
1279 @item
1280 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
1281 @item
1282 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
1283 @end itemize
1284
1285 In other words, raising the volume by +4 dB does not cause any clipping,
1286 raising it by +5 dB causes clipping for 6 samples, etc.
1287
1288 @c man end AUDIO FILTERS
1289
1290 @chapter Audio Sources
1291 @c man begin AUDIO SOURCES
1292
1293 Below is a description of the currently available audio sources.
1294
1295 @section abuffer
1296
1297 Buffer audio frames, and make them available to the filter chain.
1298
1299 This source is mainly intended for a programmatic use, in particular
1300 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
1301
1302 It accepts the following mandatory parameters:
1303 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}
1304
1305 @table @option
1306
1307 @item sample_rate
1308 The sample rate of the incoming audio buffers.
1309
1310 @item sample_fmt
1311 The sample format of the incoming audio buffers.
1312 Either a sample format name or its corresponging integer representation from
1313 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
1314
1315 @item channel_layout
1316 The channel layout of the incoming audio buffers.
1317 Either a channel layout name from channel_layout_map in
1318 @file{libavutil/channel_layout.c} or its corresponding integer representation
1319 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
1320
1321 @item channels
1322 The number of channels of the incoming audio buffers.
1323 If both @var{channels} and @var{channel_layout} are specified, then they
1324 must be consistent.
1325
1326 @end table
1327
1328 For example:
1329 @example
1330 abuffer=44100:s16p:stereo
1331 @end example
1332
1333 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
1334 Since the sample format with name "s16p" corresponds to the number
1335 6 and the "stereo" channel layout corresponds to the value 0x3, this is
1336 equivalent to:
1337 @example
1338 abuffer=44100:6:0x3
1339 @end example
1340
1341 @section aevalsrc
1342
1343 Generate an audio signal specified by an expression.
1344
1345 This source accepts in input one or more expressions (one for each
1346 channel), which are evaluated and used to generate a corresponding
1347 audio signal.
1348
1349 It accepts the syntax: @var{exprs}[::@var{options}].
1350 @var{exprs} is a list of expressions separated by ":", one for each
1351 separate channel. In case the @var{channel_layout} is not
1352 specified, the selected channel layout depends on the number of
1353 provided expressions.
1354
1355 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
1356 separated by ":".
1357
1358 The description of the accepted options follows.
1359
1360 @table @option
1361
1362 @item channel_layout, c
1363 Set the channel layout. The number of channels in the specified layout
1364 must be equal to the number of specified expressions.
1365
1366 @item duration, d
1367 Set the minimum duration of the sourced audio. See the function
1368 @code{av_parse_time()} for the accepted format.
1369 Note that the resulting duration may be greater than the specified
1370 duration, as the generated audio is always cut at the end of a
1371 complete frame.
1372
1373 If not specified, or the expressed duration is negative, the audio is
1374 supposed to be generated forever.
1375
1376 @item nb_samples, n
1377 Set the number of samples per channel per each output frame,
1378 default to 1024.
1379
1380 @item sample_rate, s
1381 Specify the sample rate, default to 44100.
1382 @end table
1383
1384 Each expression in @var{exprs} can contain the following constants:
1385
1386 @table @option
1387 @item n
1388 number of the evaluated sample, starting from 0
1389
1390 @item t
1391 time of the evaluated sample expressed in seconds, starting from 0
1392
1393 @item s
1394 sample rate
1395
1396 @end table
1397
1398 @subsection Examples
1399
1400 @itemize
1401
1402 @item
1403 Generate silence:
1404 @example
1405 aevalsrc=0
1406 @end example
1407
1408 @item
1409
1410 Generate a sin signal with frequency of 440 Hz, set sample rate to
1411 8000 Hz:
1412 @example
1413 aevalsrc="sin(440*2*PI*t)::s=8000"
1414 @end example
1415
1416 @item
1417 Generate a two channels signal, specify the channel layout (Front
1418 Center + Back Center) explicitly:
1419 @example
1420 aevalsrc="sin(420*2*PI*t):cos(430*2*PI*t)::c=FC|BC"
1421 @end example
1422
1423 @item
1424 Generate white noise:
1425 @example
1426 aevalsrc="-2+random(0)"
1427 @end example
1428
1429 @item
1430 Generate an amplitude modulated signal:
1431 @example
1432 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
1433 @end example
1434
1435 @item
1436 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
1437 @example
1438 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"
1439 @end example
1440
1441 @end itemize
1442
1443 @section anullsrc
1444
1445 Null audio source, return unprocessed audio frames. It is mainly useful
1446 as a template and to be employed in analysis / debugging tools, or as
1447 the source for filters which ignore the input data (for example the sox
1448 synth filter).
1449
1450 It accepts an optional sequence of @var{key}=@var{value} pairs,
1451 separated by ":".
1452
1453 The description of the accepted options follows.
1454
1455 @table @option
1456
1457 @item sample_rate, s
1458 Specify the sample rate, and defaults to 44100.
1459
1460 @item channel_layout, cl
1461
1462 Specify the channel layout, and can be either an integer or a string
1463 representing a channel layout. The default value of @var{channel_layout}
1464 is "stereo".
1465
1466 Check the channel_layout_map definition in
1467 @file{libavutil/channel_layout.c} for the mapping between strings and
1468 channel layout values.
1469
1470 @item nb_samples, n
1471 Set the number of samples per requested frames.
1472
1473 @end table
1474
1475 Follow some examples:
1476 @example
1477 #  set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
1478 anullsrc=r=48000:cl=4
1479
1480 # same as
1481 anullsrc=r=48000:cl=mono
1482 @end example
1483
1484 @section abuffer
1485 Buffer audio frames, and make them available to the filter chain.
1486
1487 This source is not intended to be part of user-supplied graph descriptions but
1488 for insertion by calling programs through the interface defined in
1489 @file{libavfilter/buffersrc.h}.
1490
1491 It accepts the following named parameters:
1492 @table @option
1493
1494 @item time_base
1495 Timebase which will be used for timestamps of submitted frames. It must be
1496 either a floating-point number or in @var{numerator}/@var{denominator} form.
1497
1498 @item sample_rate
1499 Audio sample rate.
1500
1501 @item sample_fmt
1502 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
1503
1504 @item channel_layout
1505 Channel layout of the audio data, in the form that can be accepted by
1506 @code{av_get_channel_layout()}.
1507 @end table
1508
1509 All the parameters need to be explicitly defined.
1510
1511 @section flite
1512
1513 Synthesize a voice utterance using the libflite library.
1514
1515 To enable compilation of this filter you need to configure FFmpeg with
1516 @code{--enable-libflite}.
1517
1518 Note that the flite library is not thread-safe.
1519
1520 The source accepts parameters as a list of @var{key}=@var{value} pairs,
1521 separated by ":".
1522
1523 The description of the accepted parameters follows.
1524
1525 @table @option
1526
1527 @item list_voices
1528 If set to 1, list the names of the available voices and exit
1529 immediately. Default value is 0.
1530
1531 @item nb_samples, n
1532 Set the maximum number of samples per frame. Default value is 512.
1533
1534 @item textfile
1535 Set the filename containing the text to speak.
1536
1537 @item text
1538 Set the text to speak.
1539
1540 @item voice, v
1541 Set the voice to use for the speech synthesis. Default value is
1542 @code{kal}. See also the @var{list_voices} option.
1543 @end table
1544
1545 @subsection Examples
1546
1547 @itemize
1548 @item
1549 Read from file @file{speech.txt}, and synthetize the text using the
1550 standard flite voice:
1551 @example
1552 flite=textfile=speech.txt
1553 @end example
1554
1555 @item
1556 Read the specified text selecting the @code{slt} voice:
1557 @example
1558 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1559 @end example
1560
1561 @item
1562 Input text to ffmpeg:
1563 @example
1564 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1565 @end example
1566
1567 @item
1568 Make @file{ffplay} speak the specified text, using @code{flite} and
1569 the @code{lavfi} device:
1570 @example
1571 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
1572 @end example
1573 @end itemize
1574
1575 For more information about libflite, check:
1576 @url{http://www.speech.cs.cmu.edu/flite/}
1577
1578 @c man end AUDIO SOURCES
1579
1580 @chapter Audio Sinks
1581 @c man begin AUDIO SINKS
1582
1583 Below is a description of the currently available audio sinks.
1584
1585 @section abuffersink
1586
1587 Buffer audio frames, and make them available to the end of filter chain.
1588
1589 This sink is mainly intended for programmatic use, in particular
1590 through the interface defined in @file{libavfilter/buffersink.h}.
1591
1592 It requires a pointer to an AVABufferSinkContext structure, which
1593 defines the incoming buffers' formats, to be passed as the opaque
1594 parameter to @code{avfilter_init_filter} for initialization.
1595
1596 @section anullsink
1597
1598 Null audio sink, do absolutely nothing with the input audio. It is
1599 mainly useful as a template and to be employed in analysis / debugging
1600 tools.
1601
1602 @section abuffersink
1603 This sink is intended for programmatic use. Frames that arrive on this sink can
1604 be retrieved by the calling program using the interface defined in
1605 @file{libavfilter/buffersink.h}.
1606
1607 This filter accepts no parameters.
1608
1609 @c man end AUDIO SINKS
1610
1611 @chapter Video Filters
1612 @c man begin VIDEO FILTERS
1613
1614 When you configure your FFmpeg build, you can disable any of the
1615 existing filters using @code{--disable-filters}.
1616 The configure output will show the video filters included in your
1617 build.
1618
1619 Below is a description of the currently available video filters.
1620
1621 @section alphaextract
1622
1623 Extract the alpha component from the input as a grayscale video. This
1624 is especially useful with the @var{alphamerge} filter.
1625
1626 @section alphamerge
1627
1628 Add or replace the alpha component of the primary input with the
1629 grayscale value of a second input. This is intended for use with
1630 @var{alphaextract} to allow the transmission or storage of frame
1631 sequences that have alpha in a format that doesn't support an alpha
1632 channel.
1633
1634 For example, to reconstruct full frames from a normal YUV-encoded video
1635 and a separate video created with @var{alphaextract}, you might use:
1636 @example
1637 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
1638 @end example
1639
1640 Since this filter is designed for reconstruction, it operates on frame
1641 sequences without considering timestamps, and terminates when either
1642 input reaches end of stream. This will cause problems if your encoding
1643 pipeline drops frames. If you're trying to apply an image as an
1644 overlay to a video stream, consider the @var{overlay} filter instead.
1645
1646 @section ass
1647
1648 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
1649 and libavformat to work. On the other hand, it is limited to ASS (Advanced
1650 Substation Alpha) subtitles files.
1651
1652 @section bbox
1653
1654 Compute the bounding box for the non-black pixels in the input frame
1655 luminance plane.
1656
1657 This filter computes the bounding box containing all the pixels with a
1658 luminance value greater than the minimum allowed value.
1659 The parameters describing the bounding box are printed on the filter
1660 log.
1661
1662 @section blackdetect
1663
1664 Detect video intervals that are (almost) completely black. Can be
1665 useful to detect chapter transitions, commercials, or invalid
1666 recordings. Output lines contains the time for the start, end and
1667 duration of the detected black interval expressed in seconds.
1668
1669 In order to display the output lines, you need to set the loglevel at
1670 least to the AV_LOG_INFO value.
1671
1672 This filter accepts a list of options in the form of
1673 @var{key}=@var{value} pairs separated by ":". A description of the
1674 accepted options follows.
1675
1676 @table @option
1677 @item black_min_duration, d
1678 Set the minimum detected black duration expressed in seconds. It must
1679 be a non-negative floating point number.
1680
1681 Default value is 2.0.
1682
1683 @item picture_black_ratio_th, pic_th
1684 Set the threshold for considering a picture "black".
1685 Express the minimum value for the ratio:
1686 @example
1687 @var{nb_black_pixels} / @var{nb_pixels}
1688 @end example
1689
1690 for which a picture is considered black.
1691 Default value is 0.98.
1692
1693 @item pixel_black_th, pix_th
1694 Set the threshold for considering a pixel "black".
1695
1696 The threshold expresses the maximum pixel luminance value for which a
1697 pixel is considered "black". The provided value is scaled according to
1698 the following equation:
1699 @example
1700 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1701 @end example
1702
1703 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1704 the input video format, the range is [0-255] for YUV full-range
1705 formats and [16-235] for YUV non full-range formats.
1706
1707 Default value is 0.10.
1708 @end table
1709
1710 The following example sets the maximum pixel threshold to the minimum
1711 value, and detects only black intervals of 2 or more seconds:
1712 @example
1713 blackdetect=d=2:pix_th=0.00
1714 @end example
1715
1716 @section blackframe
1717
1718 Detect frames that are (almost) completely black. Can be useful to
1719 detect chapter transitions or commercials. Output lines consist of
1720 the frame number of the detected frame, the percentage of blackness,
1721 the position in the file if known or -1 and the timestamp in seconds.
1722
1723 In order to display the output lines, you need to set the loglevel at
1724 least to the AV_LOG_INFO value.
1725
1726 The filter accepts the syntax:
1727 @example
1728 blackframe[=@var{amount}:[@var{threshold}]]
1729 @end example
1730
1731 @var{amount} is the percentage of the pixels that have to be below the
1732 threshold, and defaults to 98.
1733
1734 @var{threshold} is the threshold below which a pixel value is
1735 considered black, and defaults to 32.
1736
1737 @section boxblur
1738
1739 Apply boxblur algorithm to the input video.
1740
1741 This filter accepts the parameters:
1742 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
1743
1744 Chroma and alpha parameters are optional, if not specified they default
1745 to the corresponding values set for @var{luma_radius} and
1746 @var{luma_power}.
1747
1748 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
1749 the radius in pixels of the box used for blurring the corresponding
1750 input plane. They are expressions, and can contain the following
1751 constants:
1752 @table @option
1753 @item w, h
1754 the input width and height in pixels
1755
1756 @item cw, ch
1757 the input chroma image width and height in pixels
1758
1759 @item hsub, vsub
1760 horizontal and vertical chroma subsample values. For example for the
1761 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1762 @end table
1763
1764 The radius must be a non-negative number, and must not be greater than
1765 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
1766 and of @code{min(cw,ch)/2} for the chroma planes.
1767
1768 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
1769 how many times the boxblur filter is applied to the corresponding
1770 plane.
1771
1772 Some examples follow:
1773
1774 @itemize
1775
1776 @item
1777 Apply a boxblur filter with luma, chroma, and alpha radius
1778 set to 2:
1779 @example
1780 boxblur=2:1
1781 @end example
1782
1783 @item
1784 Set luma radius to 2, alpha and chroma radius to 0
1785 @example
1786 boxblur=2:1:0:0:0:0
1787 @end example
1788
1789 @item
1790 Set luma and chroma radius to a fraction of the video dimension
1791 @example
1792 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
1793 @end example
1794
1795 @end itemize
1796
1797 @section colormatrix
1798
1799 The colormatrix filter allows conversion between any of the following color
1800 space: BT.709 (@var{bt709}), BT.601 (@var{bt601}), SMPTE-240M (@var{smpte240m})
1801 and FCC (@var{fcc}).
1802
1803 The syntax of the parameters is @var{source}:@var{destination}:
1804
1805 @example
1806 colormatrix=bt601:smpte240m
1807 @end example
1808
1809 @section copy
1810
1811 Copy the input source unchanged to the output. Mainly useful for
1812 testing purposes.
1813
1814 @section crop
1815
1816 Crop the input video.
1817
1818 This filter accepts a list of @var{key}=@var{value} pairs as argument,
1819 separated by ':'. If the key of the first options is omitted, the
1820 arguments are interpreted according to the syntax
1821 @var{out_w}:@var{out_h}:@var{x}:@var{y}:@var{keep_aspect}.
1822
1823 A description of the accepted options follows:
1824 @table @option
1825 @item w, out_w
1826 Set the crop area width. It defaults to @code{iw}.
1827 This expression is evaluated only once during the filter
1828 configuration.
1829
1830 @item h, out_h
1831 Set the crop area width. It defaults to @code{ih}.
1832 This expression is evaluated only once during the filter
1833 configuration.
1834
1835 @item x
1836 Set the expression for the x top-left coordinate of the cropped area.
1837 It defaults to @code{(in_w-out_w)/2}.
1838 This expression is evaluated per-frame.
1839
1840 @item y
1841 Set the expression for the y top-left coordinate of the cropped area.
1842 It defaults to @code{(in_h-out_h)/2}.
1843 This expression is evaluated per-frame.
1844
1845 @item keep_aspect
1846 If set to 1 will force the output display aspect ratio
1847 to be the same of the input, by changing the output sample aspect
1848 ratio. It defaults to 0.
1849 @end table
1850
1851 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
1852 expressions containing the following constants:
1853
1854 @table @option
1855 @item x, y
1856 the computed values for @var{x} and @var{y}. They are evaluated for
1857 each new frame.
1858
1859 @item in_w, in_h
1860 the input width and height
1861
1862 @item iw, ih
1863 same as @var{in_w} and @var{in_h}
1864
1865 @item out_w, out_h
1866 the output (cropped) width and height
1867
1868 @item ow, oh
1869 same as @var{out_w} and @var{out_h}
1870
1871 @item a
1872 same as @var{iw} / @var{ih}
1873
1874 @item sar
1875 input sample aspect ratio
1876
1877 @item dar
1878 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1879
1880 @item hsub, vsub
1881 horizontal and vertical chroma subsample values. For example for the
1882 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1883
1884 @item n
1885 the number of input frame, starting from 0
1886
1887 @item pos
1888 the position in the file of the input frame, NAN if unknown
1889
1890 @item t
1891 timestamp expressed in seconds, NAN if the input timestamp is unknown
1892
1893 @end table
1894
1895 The expression for @var{out_w} may depend on the value of @var{out_h},
1896 and the expression for @var{out_h} may depend on @var{out_w}, but they
1897 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
1898 evaluated after @var{out_w} and @var{out_h}.
1899
1900 The @var{x} and @var{y} parameters specify the expressions for the
1901 position of the top-left corner of the output (non-cropped) area. They
1902 are evaluated for each frame. If the evaluated value is not valid, it
1903 is approximated to the nearest valid value.
1904
1905 The expression for @var{x} may depend on @var{y}, and the expression
1906 for @var{y} may depend on @var{x}.
1907
1908 @subsection Examples
1909 @itemize
1910 @item
1911 Crop area with size 100x100 at position (12,34).
1912 @example
1913 crop=100:100:12:34
1914 @end example
1915
1916 Using named options, the example above becomes:
1917 @example
1918 crop=w=100:h=100:x=12:y=34
1919 @end example
1920
1921 @item
1922 Crop the central input area with size 100x100:
1923 @example
1924 crop=100:100
1925 @end example
1926
1927 @item
1928 Crop the central input area with size 2/3 of the input video:
1929 @example
1930 crop=2/3*in_w:2/3*in_h
1931 @end example
1932
1933 @item
1934 Crop the input video central square:
1935 @example
1936 crop=in_h
1937 @end example
1938
1939 @item
1940 Delimit the rectangle with the top-left corner placed at position
1941 100:100 and the right-bottom corner corresponding to the right-bottom
1942 corner of the input image:
1943 @example
1944 crop=in_w-100:in_h-100:100:100
1945 @end example
1946
1947 @item
1948 Crop 10 pixels from the left and right borders, and 20 pixels from
1949 the top and bottom borders
1950 @example
1951 crop=in_w-2*10:in_h-2*20
1952 @end example
1953
1954 @item
1955 Keep only the bottom right quarter of the input image:
1956 @example
1957 crop=in_w/2:in_h/2:in_w/2:in_h/2
1958 @end example
1959
1960 @item
1961 Crop height for getting Greek harmony:
1962 @example
1963 crop=in_w:1/PHI*in_w
1964 @end example
1965
1966 @item
1967 Appply trembling effect:
1968 @example
1969 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)
1970 @end example
1971
1972 @item
1973 Apply erratic camera effect depending on timestamp:
1974 @example
1975 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)"
1976 @end example
1977
1978 @item
1979 Set x depending on the value of y:
1980 @example
1981 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
1982 @end example
1983 @end itemize
1984
1985 @section cropdetect
1986
1987 Auto-detect crop size.
1988
1989 Calculate necessary cropping parameters and prints the recommended
1990 parameters through the logging system. The detected dimensions
1991 correspond to the non-black area of the input video.
1992
1993 It accepts the syntax:
1994 @example
1995 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
1996 @end example
1997
1998 @table @option
1999
2000 @item limit
2001 Threshold, which can be optionally specified from nothing (0) to
2002 everything (255), defaults to 24.
2003
2004 @item round
2005 Value which the width/height should be divisible by, defaults to
2006 16. The offset is automatically adjusted to center the video. Use 2 to
2007 get only even dimensions (needed for 4:2:2 video). 16 is best when
2008 encoding to most video codecs.
2009
2010 @item reset
2011 Counter that determines after how many frames cropdetect will reset
2012 the previously detected largest video area and start over to detect
2013 the current optimal crop area. Defaults to 0.
2014
2015 This can be useful when channel logos distort the video area. 0
2016 indicates never reset and return the largest area encountered during
2017 playback.
2018 @end table
2019
2020 @section decimate
2021
2022 This filter drops frames that do not differ greatly from the previous
2023 frame in order to reduce framerate.  The main use of this filter is
2024 for very-low-bitrate encoding (e.g. streaming over dialup modem), but
2025 it could in theory be used for fixing movies that were
2026 inverse-telecined incorrectly.
2027
2028 It accepts the following parameters:
2029 @var{max}:@var{hi}:@var{lo}:@var{frac}.
2030
2031 @table @option
2032
2033 @item max
2034 Set the maximum number of consecutive frames which can be dropped (if
2035 positive), or the minimum interval between dropped frames (if
2036 negative). If the value is 0, the frame is dropped unregarding the
2037 number of previous sequentially dropped frames.
2038
2039 Default value is 0.
2040
2041 @item hi, lo, frac
2042 Set the dropping threshold values.
2043
2044 Values for @var{hi} and @var{lo} are for 8x8 pixel blocks and
2045 represent actual pixel value differences, so a threshold of 64
2046 corresponds to 1 unit of difference for each pixel, or the same spread
2047 out differently over the block.
2048
2049 A frame is a candidate for dropping if no 8x8 blocks differ by more
2050 than a threshold of @var{hi}, and if no more than @var{frac} blocks (1
2051 meaning the whole image) differ by more than a threshold of @var{lo}.
2052
2053 Default value for @var{hi} is 64*12, default value for @var{lo} is
2054 64*5, and default value for @var{frac} is 0.33.
2055 @end table
2056
2057 @section delogo
2058
2059 Suppress a TV station logo by a simple interpolation of the surrounding
2060 pixels. Just set a rectangle covering the logo and watch it disappear
2061 (and sometimes something even uglier appear - your mileage may vary).
2062
2063 The filter accepts parameters as a string of the form
2064 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
2065 @var{key}=@var{value} pairs, separated by ":".
2066
2067 The description of the accepted parameters follows.
2068
2069 @table @option
2070
2071 @item x, y
2072 Specify the top left corner coordinates of the logo. They must be
2073 specified.
2074
2075 @item w, h
2076 Specify the width and height of the logo to clear. They must be
2077 specified.
2078
2079 @item band, t
2080 Specify the thickness of the fuzzy edge of the rectangle (added to
2081 @var{w} and @var{h}). The default value is 4.
2082
2083 @item show
2084 When set to 1, a green rectangle is drawn on the screen to simplify
2085 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
2086 @var{band} is set to 4. The default value is 0.
2087
2088 @end table
2089
2090 Some examples follow.
2091
2092 @itemize
2093
2094 @item
2095 Set a rectangle covering the area with top left corner coordinates 0,0
2096 and size 100x77, setting a band of size 10:
2097 @example
2098 delogo=0:0:100:77:10
2099 @end example
2100
2101 @item
2102 As the previous example, but use named options:
2103 @example
2104 delogo=x=0:y=0:w=100:h=77:band=10
2105 @end example
2106
2107 @end itemize
2108
2109 @section deshake
2110
2111 Attempt to fix small changes in horizontal and/or vertical shift. This
2112 filter helps remove camera shake from hand-holding a camera, bumping a
2113 tripod, moving on a vehicle, etc.
2114
2115 The filter accepts parameters as a string of the form
2116 "@var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}"
2117
2118 A description of the accepted parameters follows.
2119
2120 @table @option
2121
2122 @item x, y, w, h
2123 Specify a rectangular area where to limit the search for motion
2124 vectors.
2125 If desired the search for motion vectors can be limited to a
2126 rectangular area of the frame defined by its top left corner, width
2127 and height. These parameters have the same meaning as the drawbox
2128 filter which can be used to visualise the position of the bounding
2129 box.
2130
2131 This is useful when simultaneous movement of subjects within the frame
2132 might be confused for camera motion by the motion vector search.
2133
2134 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
2135 then the full frame is used. This allows later options to be set
2136 without specifying the bounding box for the motion vector search.
2137
2138 Default - search the whole frame.
2139
2140 @item rx, ry
2141 Specify the maximum extent of movement in x and y directions in the
2142 range 0-64 pixels. Default 16.
2143
2144 @item edge
2145 Specify how to generate pixels to fill blanks at the edge of the
2146 frame. An integer from 0 to 3 as follows:
2147 @table @option
2148 @item 0
2149 Fill zeroes at blank locations
2150 @item 1
2151 Original image at blank locations
2152 @item 2
2153 Extruded edge value at blank locations
2154 @item 3
2155 Mirrored edge at blank locations
2156 @end table
2157
2158 The default setting is mirror edge at blank locations.
2159
2160 @item blocksize
2161 Specify the blocksize to use for motion search. Range 4-128 pixels,
2162 default 8.
2163
2164 @item contrast
2165 Specify the contrast threshold for blocks. Only blocks with more than
2166 the specified contrast (difference between darkest and lightest
2167 pixels) will be considered. Range 1-255, default 125.
2168
2169 @item search
2170 Specify the search strategy 0 = exhaustive search, 1 = less exhaustive
2171 search. Default - exhaustive search.
2172
2173 @item filename
2174 If set then a detailed log of the motion search is written to the
2175 specified file.
2176
2177 @end table
2178
2179 @section drawbox
2180
2181 Draw a colored box on the input image.
2182
2183 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
2184 separated by ":".
2185
2186 The description of the accepted parameters follows.
2187
2188 @table @option
2189 @item x, y
2190 Specify the top left corner coordinates of the box. Default to 0.
2191
2192 @item width, w
2193 @item height, h
2194 Specify the width and height of the box, if 0 they are interpreted as
2195 the input width and height. Default to 0.
2196
2197 @item color, c
2198 Specify the color of the box to write, it can be the name of a color
2199 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
2200 value @code{invert} is used, the box edge color is the same as the
2201 video with inverted luma.
2202
2203 @item thickness, t
2204 Set the thickness of the box edge. Default value is @code{4}.
2205 @end table
2206
2207 If the key of the first options is omitted, the arguments are
2208 interpreted according to the syntax
2209 @var{x}:@var{y}:@var{width}:@var{height}:@var{color}:@var{thickness}.
2210
2211 Some examples follow:
2212 @itemize
2213 @item
2214 Draw a black box around the edge of the input image:
2215 @example
2216 drawbox
2217 @end example
2218
2219 @item
2220 Draw a box with color red and an opacity of 50%:
2221 @example
2222 drawbox=10:20:200:60:red@@0.5
2223 @end example
2224
2225 The previous example can be specified as:
2226 @example
2227 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
2228 @end example
2229
2230 @item
2231 Fill the box with pink color:
2232 @example
2233 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
2234 @end example
2235 @end itemize
2236
2237 @anchor{drawtext}
2238 @section drawtext
2239
2240 Draw text string or text from specified file on top of video using the
2241 libfreetype library.
2242
2243 To enable compilation of this filter you need to configure FFmpeg with
2244 @code{--enable-libfreetype}.
2245
2246 @subsection Syntax
2247
2248 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
2249 separated by ":".
2250
2251 The description of the accepted parameters follows.
2252
2253 @table @option
2254
2255 @item box
2256 Used to draw a box around text using background color.
2257 Value should be either 1 (enable) or 0 (disable).
2258 The default value of @var{box} is 0.
2259
2260 @item boxcolor
2261 The color to be used for drawing box around text.
2262 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
2263 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2264 The default value of @var{boxcolor} is "white".
2265
2266 @item draw
2267 Set an expression which specifies if the text should be drawn. If the
2268 expression evaluates to 0, the text is not drawn. This is useful for
2269 specifying that the text should be drawn only when specific conditions
2270 are met.
2271
2272 Default value is "1".
2273
2274 See below for the list of accepted constants and functions.
2275
2276 @item expansion
2277 Select how the @var{text} is expanded. Can be either @code{none},
2278 @code{strftime} (deprecated) or
2279 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
2280 below for details.
2281
2282 @item fix_bounds
2283 If true, check and fix text coords to avoid clipping.
2284
2285 @item fontcolor
2286 The color to be used for drawing fonts.
2287 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
2288 (e.g. "0xff000033"), possibly followed by an alpha specifier.
2289 The default value of @var{fontcolor} is "black".
2290
2291 @item fontfile
2292 The font file to be used for drawing text. Path must be included.
2293 This parameter is mandatory.
2294
2295 @item fontsize
2296 The font size to be used for drawing text.
2297 The default value of @var{fontsize} is 16.
2298
2299 @item ft_load_flags
2300 Flags to be used for loading the fonts.
2301
2302 The flags map the corresponding flags supported by libfreetype, and are
2303 a combination of the following values:
2304 @table @var
2305 @item default
2306 @item no_scale
2307 @item no_hinting
2308 @item render
2309 @item no_bitmap
2310 @item vertical_layout
2311 @item force_autohint
2312 @item crop_bitmap
2313 @item pedantic
2314 @item ignore_global_advance_width
2315 @item no_recurse
2316 @item ignore_transform
2317 @item monochrome
2318 @item linear_design
2319 @item no_autohint
2320 @item end table
2321 @end table
2322
2323 Default value is "render".
2324
2325 For more information consult the documentation for the FT_LOAD_*
2326 libfreetype flags.
2327
2328 @item shadowcolor
2329 The color to be used for drawing a shadow behind the drawn text.  It
2330 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
2331 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2332 The default value of @var{shadowcolor} is "black".
2333
2334 @item shadowx, shadowy
2335 The x and y offsets for the text shadow position with respect to the
2336 position of the text. They can be either positive or negative
2337 values. Default value for both is "0".
2338
2339 @item tabsize
2340 The size in number of spaces to use for rendering the tab.
2341 Default value is 4.
2342
2343 @item timecode
2344 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
2345 format. It can be used with or without text parameter. @var{timecode_rate}
2346 option must be specified.
2347
2348 @item timecode_rate, rate, r
2349 Set the timecode frame rate (timecode only).
2350
2351 @item text
2352 The text string to be drawn. The text must be a sequence of UTF-8
2353 encoded characters.
2354 This parameter is mandatory if no file is specified with the parameter
2355 @var{textfile}.
2356
2357 @item textfile
2358 A text file containing text to be drawn. The text must be a sequence
2359 of UTF-8 encoded characters.
2360
2361 This parameter is mandatory if no text string is specified with the
2362 parameter @var{text}.
2363
2364 If both @var{text} and @var{textfile} are specified, an error is thrown.
2365
2366 @item reload
2367 If set to 1, the @var{textfile} will be reloaded before each frame.
2368 Be sure to update it atomically, or it may be read partially, or even fail.
2369
2370 @item x, y
2371 The expressions which specify the offsets where text will be drawn
2372 within the video frame. They are relative to the top/left border of the
2373 output image.
2374
2375 The default value of @var{x} and @var{y} is "0".
2376
2377 See below for the list of accepted constants and functions.
2378 @end table
2379
2380 The parameters for @var{x} and @var{y} are expressions containing the
2381 following constants and functions:
2382
2383 @table @option
2384 @item dar
2385 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
2386
2387 @item hsub, vsub
2388 horizontal and vertical chroma subsample values. For example for the
2389 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2390
2391 @item line_h, lh
2392 the height of each text line
2393
2394 @item main_h, h, H
2395 the input height
2396
2397 @item main_w, w, W
2398 the input width
2399
2400 @item max_glyph_a, ascent
2401 the maximum distance from the baseline to the highest/upper grid
2402 coordinate used to place a glyph outline point, for all the rendered
2403 glyphs.
2404 It is a positive value, due to the grid's orientation with the Y axis
2405 upwards.
2406
2407 @item max_glyph_d, descent
2408 the maximum distance from the baseline to the lowest grid coordinate
2409 used to place a glyph outline point, for all the rendered glyphs.
2410 This is a negative value, due to the grid's orientation, with the Y axis
2411 upwards.
2412
2413 @item max_glyph_h
2414 maximum glyph height, that is the maximum height for all the glyphs
2415 contained in the rendered text, it is equivalent to @var{ascent} -
2416 @var{descent}.
2417
2418 @item max_glyph_w
2419 maximum glyph width, that is the maximum width for all the glyphs
2420 contained in the rendered text
2421
2422 @item n
2423 the number of input frame, starting from 0
2424
2425 @item rand(min, max)
2426 return a random number included between @var{min} and @var{max}
2427
2428 @item sar
2429 input sample aspect ratio
2430
2431 @item t
2432 timestamp expressed in seconds, NAN if the input timestamp is unknown
2433
2434 @item text_h, th
2435 the height of the rendered text
2436
2437 @item text_w, tw
2438 the width of the rendered text
2439
2440 @item x, y
2441 the x and y offset coordinates where the text is drawn.
2442
2443 These parameters allow the @var{x} and @var{y} expressions to refer
2444 each other, so you can for example specify @code{y=x/dar}.
2445 @end table
2446
2447 If libavfilter was built with @code{--enable-fontconfig}, then
2448 @option{fontfile} can be a fontconfig pattern or omitted.
2449
2450 @anchor{drawtext_expansion}
2451 @subsection Text expansion
2452
2453 If @option{expansion} is set to @code{strftime},
2454 the filter recognizes strftime() sequences in the provided text and
2455 expands them accordingly. Check the documentation of strftime(). This
2456 feature is deprecated.
2457
2458 If @option{expansion} is set to @code{none}, the text is printed verbatim.
2459
2460 If @option{expansion} is set to @code{normal} (which is the default),
2461 the following expansion mechanism is used.
2462
2463 The backslash character '\', followed by any character, always expands to
2464 the second character.
2465
2466 Sequence of the form @code{%@{...@}} are expanded. The text between the
2467 braces is a function name, possibly followed by arguments separated by ':'.
2468 If the arguments contain special characters or delimiters (':' or '@}'),
2469 they should be escaped.
2470
2471 Note that they probably must also be escaped as the value for the
2472 @option{text} option in the filter argument string and as the filter
2473 argument in the filter graph description, and possibly also for the shell,
2474 that makes up to four levels of escaping; using a text file avoids these
2475 problems.
2476
2477 The following functions are available:
2478
2479 @table @command
2480
2481 @item expr, e
2482 The expression evaluation result.
2483
2484 It must take one argument specifying the expression to be evaluated,
2485 which accepts the same constants and functions as the @var{x} and
2486 @var{y} values. Note that not all constants should be used, for
2487 example the text size is not known when evaluating the expression, so
2488 the constants @var{text_w} and @var{text_h} will have an undefined
2489 value.
2490
2491 @item gmtime
2492 The time at which the filter is running, expressed in UTC.
2493 It can accept an argument: a strftime() format string.
2494
2495 @item localtime
2496 The time at which the filter is running, expressed in the local time zone.
2497 It can accept an argument: a strftime() format string.
2498
2499 @item n, frame_num
2500 The frame number, starting from 0.
2501
2502 @item pts
2503 The timestamp of the current frame, in seconds, with microsecond accuracy.
2504
2505 @end table
2506
2507 @subsection Examples
2508
2509 Some examples follow.
2510
2511 @itemize
2512
2513 @item
2514 Draw "Test Text" with font FreeSerif, using the default values for the
2515 optional parameters.
2516
2517 @example
2518 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
2519 @end example
2520
2521 @item
2522 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
2523 and y=50 (counting from the top-left corner of the screen), text is
2524 yellow with a red box around it. Both the text and the box have an
2525 opacity of 20%.
2526
2527 @example
2528 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
2529           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
2530 @end example
2531
2532 Note that the double quotes are not necessary if spaces are not used
2533 within the parameter list.
2534
2535 @item
2536 Show the text at the center of the video frame:
2537 @example
2538 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
2539 @end example
2540
2541 @item
2542 Show a text line sliding from right to left in the last row of the video
2543 frame. The file @file{LONG_LINE} is assumed to contain a single line
2544 with no newlines.
2545 @example
2546 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
2547 @end example
2548
2549 @item
2550 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
2551 @example
2552 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
2553 @end example
2554
2555 @item
2556 Draw a single green letter "g", at the center of the input video.
2557 The glyph baseline is placed at half screen height.
2558 @example
2559 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
2560 @end example
2561
2562 @item
2563 Show text for 1 second every 3 seconds:
2564 @example
2565 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
2566 @end example
2567
2568 @item
2569 Use fontconfig to set the font. Note that the colons need to be escaped.
2570 @example
2571 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
2572 @end example
2573
2574 @item
2575 Print the date of a real-time encoding (see strftime(3)):
2576 @example
2577 drawtext='fontfile=FreeSans.ttf:text=%@{localtime:%a %b %d %Y@}'
2578 @end example
2579
2580 @end itemize
2581
2582 For more information about libfreetype, check:
2583 @url{http://www.freetype.org/}.
2584
2585 For more information about fontconfig, check:
2586 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
2587
2588 @section edgedetect
2589
2590 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
2591
2592 This filter accepts the following optional named parameters:
2593
2594 @table @option
2595 @item low, high
2596 Set low and high threshold values used by the Canny thresholding
2597 algorithm.
2598
2599 The high threshold selects the "strong" edge pixels, which are then
2600 connected through 8-connectivity with the "weak" edge pixels selected
2601 by the low threshold.
2602
2603 @var{low} and @var{high} threshold values must be choosen in the range
2604 [0,1], and @var{low} should be lesser or equal to @var{high}.
2605
2606 Default value for @var{low} is @code{20/255}, and default value for @var{high}
2607 is @code{50/255}.
2608 @end table
2609
2610 Example:
2611 @example
2612 edgedetect=low=0.1:high=0.4
2613 @end example
2614
2615 @section fade
2616
2617 Apply fade-in/out effect to input video.
2618
2619 The filter accepts parameters as a list of @var{key}=@var{value}
2620 pairs, separated by ":". If the key of the first options is omitted,
2621 the arguments are interpreted according to the syntax
2622 @var{type}:@var{start_frame}:@var{nb_frames}.
2623
2624 A description of the accepted parameters follows.
2625
2626 @table @option
2627 @item type, t
2628 Specify if the effect type, can be either @code{in} for fade-in, or
2629 @code{out} for a fade-out effect. Default is @code{in}.
2630
2631 @item start_frame, s
2632 Specify the number of the start frame for starting to apply the fade
2633 effect. Default is 0.
2634
2635 @item nb_frames, n
2636 Specify the number of frames for which the fade effect has to last. At
2637 the end of the fade-in effect the output video will have the same
2638 intensity as the input video, at the end of the fade-out transition
2639 the output video will be completely black. Default is 25.
2640
2641 @item alpha
2642 If set to 1, fade only alpha channel, if one exists on the input.
2643 Default value is 0.
2644 @end table
2645
2646 @subsection Examples
2647 @itemize
2648 @item
2649 Fade in first 30 frames of video:
2650 @example
2651 fade=in:0:30
2652 @end example
2653
2654 The command above is equivalent to:
2655 @example
2656 fade=t=in:s=0:n=30
2657 @end example
2658
2659 @item
2660 Fade out last 45 frames of a 200-frame video:
2661 @example
2662 fade=out:155:45
2663 @end example
2664
2665 @item
2666 Fade in first 25 frames and fade out last 25 frames of a 1000-frame video:
2667 @example
2668 fade=in:0:25, fade=out:975:25
2669 @end example
2670
2671 @item
2672 Make first 5 frames black, then fade in from frame 5-24:
2673 @example
2674 fade=in:5:20
2675 @end example
2676
2677 @item
2678 Fade in alpha over first 25 frames of video:
2679 @example
2680 fade=in:0:25:alpha=1
2681 @end example
2682 @end itemize
2683
2684 @section field
2685
2686 Extract a single field from an interlaced image using stride
2687 arithmetic to avoid wasting CPU time. The output frames are marked as
2688 non-interlaced.
2689
2690 This filter accepts the following named options:
2691 @table @option
2692 @item type
2693 Specify whether to extract the top (if the value is @code{0} or
2694 @code{top}) or the bottom field (if the value is @code{1} or
2695 @code{bottom}).
2696 @end table
2697
2698 If the option key is not specified, the first value sets the @var{type}
2699 option. For example:
2700 @example
2701 field=bottom
2702 @end example
2703
2704 is equivalent to:
2705 @example
2706 field=type=bottom
2707 @end example
2708
2709 @section fieldorder
2710
2711 Transform the field order of the input video.
2712
2713 It accepts one parameter which specifies the required field order that
2714 the input interlaced video will be transformed to. The parameter can
2715 assume one of the following values:
2716
2717 @table @option
2718 @item 0 or bff
2719 output bottom field first
2720 @item 1 or tff
2721 output top field first
2722 @end table
2723
2724 Default value is "tff".
2725
2726 Transformation is achieved by shifting the picture content up or down
2727 by one line, and filling the remaining line with appropriate picture content.
2728 This method is consistent with most broadcast field order converters.
2729
2730 If the input video is not flagged as being interlaced, or it is already
2731 flagged as being of the required output field order then this filter does
2732 not alter the incoming video.
2733
2734 This filter is very useful when converting to or from PAL DV material,
2735 which is bottom field first.
2736
2737 For example:
2738 @example
2739 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
2740 @end example
2741
2742 @section fifo
2743
2744 Buffer input images and send them when they are requested.
2745
2746 This filter is mainly useful when auto-inserted by the libavfilter
2747 framework.
2748
2749 The filter does not take parameters.
2750
2751 @section format
2752
2753 Convert the input video to one of the specified pixel formats.
2754 Libavfilter will try to pick one that is supported for the input to
2755 the next filter.
2756
2757 The filter accepts a list of pixel format names, separated by ":",
2758 for example "yuv420p:monow:rgb24".
2759
2760 Some examples follow:
2761 @example
2762 # convert the input video to the format "yuv420p"
2763 format=yuv420p
2764
2765 # convert the input video to any of the formats in the list
2766 format=yuv420p:yuv444p:yuv410p
2767 @end example
2768
2769 @section fps
2770
2771 Convert the video to specified constant framerate by duplicating or dropping
2772 frames as necessary.
2773
2774 This filter accepts the following named parameters:
2775 @table @option
2776
2777 @item fps
2778 Desired output framerate. The default is @code{25}.
2779
2780 @item round
2781 Rounding method.
2782
2783 Possible values are:
2784 @table @option
2785 @item zero
2786 zero round towards 0
2787 @item inf
2788 round away from 0
2789 @item down
2790 round towards -infinity
2791 @item up
2792 round towards +infinity
2793 @item near
2794 round to nearest
2795 @end table
2796 The default is @code{near}.
2797
2798 @end table
2799
2800 Alternatively, the options can be specified as a flat string:
2801 @var{fps}[:@var{round}].
2802
2803 See also the @ref{setpts} filter.
2804
2805 @section framestep
2806
2807 Select one frame every N.
2808
2809 This filter accepts in input a string representing a positive
2810 integer. Default argument is @code{1}.
2811
2812 @anchor{frei0r}
2813 @section frei0r
2814
2815 Apply a frei0r effect to the input video.
2816
2817 To enable compilation of this filter you need to install the frei0r
2818 header and configure FFmpeg with @code{--enable-frei0r}.
2819
2820 The filter supports the syntax:
2821 @example
2822 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
2823 @end example
2824
2825 @var{filter_name} is the name of the frei0r effect to load. If the
2826 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
2827 is searched in each one of the directories specified by the colon (or
2828 semicolon on Windows platforms) separated list in @env{FREIOR_PATH},
2829 otherwise in the standard frei0r paths, which are in this order:
2830 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
2831 @file{/usr/lib/frei0r-1/}.
2832
2833 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
2834 for the frei0r effect.
2835
2836 A frei0r effect parameter can be a boolean (whose values are specified
2837 with "y" and "n"), a double, a color (specified by the syntax
2838 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
2839 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
2840 description), a position (specified by the syntax @var{X}/@var{Y},
2841 @var{X} and @var{Y} being float numbers) and a string.
2842
2843 The number and kind of parameters depend on the loaded effect. If an
2844 effect parameter is not specified the default value is set.
2845
2846 Some examples follow:
2847
2848 @itemize
2849 @item
2850 Apply the distort0r effect, set the first two double parameters:
2851 @example
2852 frei0r=distort0r:0.5:0.01
2853 @end example
2854
2855 @item
2856 Apply the colordistance effect, take a color as first parameter:
2857 @example
2858 frei0r=colordistance:0.2/0.3/0.4
2859 frei0r=colordistance:violet
2860 frei0r=colordistance:0x112233
2861 @end example
2862
2863 @item
2864 Apply the perspective effect, specify the top left and top right image
2865 positions:
2866 @example
2867 frei0r=perspective:0.2/0.2:0.8/0.2
2868 @end example
2869 @end itemize
2870
2871 For more information see:
2872 @url{http://frei0r.dyne.org}
2873
2874 @section geq
2875
2876 The filter takes one, two or three equations as parameter, separated by ':'.
2877 The first equation is mandatory and applies to the luma plane. The two
2878 following are respectively for chroma blue and chroma red planes.
2879
2880 The filter syntax allows named parameters:
2881
2882 @table @option
2883 @item lum_expr
2884 the luminance expression
2885 @item cb_expr
2886 the chrominance blue expression
2887 @item cr_expr
2888 the chrominance red expression
2889 @end table
2890
2891 If one of the chrominance expression is not defined, it falls back on the other
2892 one. If none of them are specified, they will evaluate the luminance
2893 expression.
2894
2895 The expressions can use the following variables and functions:
2896
2897 @table @option
2898 @item N
2899 The sequential number of the filtered frame, starting from @code{0}.
2900
2901 @item X, Y
2902 The coordinates of the current sample.
2903
2904 @item W, H
2905 The width and height of the image.
2906
2907 @item SW, SH
2908 Width and height scale depending on the currently filtered plane. It is the
2909 ratio between the corresponding luma plane number of pixels and the current
2910 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
2911 @code{0.5,0.5} for chroma planes.
2912
2913 @item T
2914 Time of the current frame, expressed in seconds.
2915
2916 @item p(x, y)
2917 Return the value of the pixel at location (@var{x},@var{y}) of the current
2918 plane.
2919
2920 @item lum(x, y)
2921 Return the value of the pixel at location (@var{x},@var{y}) of the luminance
2922 plane.
2923
2924 @item cb(x, y)
2925 Return the value of the pixel at location (@var{x},@var{y}) of the
2926 blue-difference chroma plane.
2927
2928 @item cr(x, y)
2929 Return the value of the pixel at location (@var{x},@var{y}) of the
2930 red-difference chroma plane.
2931 @end table
2932
2933 For functions, if @var{x} and @var{y} are outside the area, the value will be
2934 automatically clipped to the closer edge.
2935
2936 Some examples follow:
2937
2938 @itemize
2939 @item
2940 Flip the image horizontally:
2941 @example
2942 geq=p(W-X\,Y)
2943 @end example
2944
2945 @item
2946 Generate a bidimensional sine wave, with angle @code{PI/3} and a
2947 wavelength of 100 pixels:
2948 @example
2949 geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
2950 @end example
2951
2952 @item
2953 Generate a fancy enigmatic moving light:
2954 @example
2955 nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
2956 @end example
2957 @end itemize
2958
2959 @section gradfun
2960
2961 Fix the banding artifacts that are sometimes introduced into nearly flat
2962 regions by truncation to 8bit color depth.
2963 Interpolate the gradients that should go where the bands are, and
2964 dither them.
2965
2966 This filter is designed for playback only.  Do not use it prior to
2967 lossy compression, because compression tends to lose the dither and
2968 bring back the bands.
2969
2970 The filter accepts a list of options in the form of @var{key}=@var{value} pairs
2971 separated by ":". A description of the accepted options follows.
2972
2973 @table @option
2974
2975 @item strength
2976 The maximum amount by which the filter will change
2977 any one pixel. Also the threshold for detecting nearly flat
2978 regions. Acceptable values range from @code{0.51} to @code{64}, default value
2979 is @code{1.2}.
2980
2981 @item radius
2982 The neighborhood to fit the gradient to. A larger
2983 radius makes for smoother gradients, but also prevents the filter from
2984 modifying the pixels near detailed regions. Acceptable values are
2985 @code{8-32}, default value is @code{16}.
2986
2987 @end table
2988
2989 Alternatively, the options can be specified as a flat string:
2990 @var{strength}[:@var{radius}]
2991
2992 @subsection Examples
2993
2994 @itemize
2995 @item
2996 Apply the filter with a @code{3.5} strength and radius of @code{8}:
2997 @example
2998 gradfun=3.5:8
2999 @end example
3000
3001 @item
3002 Specify radius, omitting the strength (which will fall-back to the default
3003 value):
3004 @example
3005 gradfun=radius=8
3006 @end example
3007
3008 @end itemize
3009
3010 @section hflip
3011
3012 Flip the input video horizontally.
3013
3014 For example to horizontally flip the input video with @command{ffmpeg}:
3015 @example
3016 ffmpeg -i in.avi -vf "hflip" out.avi
3017 @end example
3018
3019 @section histeq
3020 This filter applies a global color histogram equalization on a
3021 per-frame basis.
3022
3023 It can be used to correct video that has a compressed range of pixel
3024 intensities.  The filter redistributes the pixel intensities to
3025 equalize their distribution across the intensity range. It may be
3026 viewed as an "automatically adjusting contrast filter". This filter is
3027 useful only for correcting degraded or poorly captured source
3028 video.
3029
3030 The filter accepts parameters as a list of @var{key}=@var{value}
3031 pairs, separated by ":". If the key of the first options is omitted,
3032 the arguments are interpreted according to syntax
3033 @var{strength}:@var{intensity}:@var{antibanding}.
3034
3035 This filter accepts the following named options:
3036
3037 @table @option
3038 @item strength
3039 Determine the amount of equalization to be applied.  As the strength
3040 is reduced, the distribution of pixel intensities more-and-more
3041 approaches that of the input frame. The value must be a float number
3042 in the range [0,1] and defaults to 0.200.
3043
3044 @item intensity
3045 Set the maximum intensity that can generated and scale the output
3046 values appropriately.  The strength should be set as desired and then
3047 the intensity can be limited if needed to avoid washing-out. The value
3048 must be a float number in the range [0,1] and defaults to 0.210.
3049
3050 @item antibanding
3051 Set the antibanding level. If enabled the filter will randomly vary
3052 the luminance of output pixels by a small amount to avoid banding of
3053 the histogram. Possible values are @code{none}, @code{weak} or
3054 @code{strong}. It defaults to @code{none}.
3055 @end table
3056
3057 @section hqdn3d
3058
3059 High precision/quality 3d denoise filter. This filter aims to reduce
3060 image noise producing smooth images and making still images really
3061 still. It should enhance compressibility.
3062
3063 It accepts the following optional parameters:
3064 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
3065
3066 @table @option
3067 @item luma_spatial
3068 a non-negative float number which specifies spatial luma strength,
3069 defaults to 4.0
3070
3071 @item chroma_spatial
3072 a non-negative float number which specifies spatial chroma strength,
3073 defaults to 3.0*@var{luma_spatial}/4.0
3074
3075 @item luma_tmp
3076 a float number which specifies luma temporal strength, defaults to
3077 6.0*@var{luma_spatial}/4.0
3078
3079 @item chroma_tmp
3080 a float number which specifies chroma temporal strength, defaults to
3081 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
3082 @end table
3083
3084 @section hue
3085
3086 Modify the hue and/or the saturation of the input.
3087
3088 This filter accepts the following optional named options:
3089
3090 @table @option
3091 @item h
3092 Specify the hue angle as a number of degrees. It accepts a float
3093 number or an expression, and defaults to 0.0.
3094
3095 @item H
3096 Specify the hue angle as a number of degrees. It accepts a float
3097 number or an expression, and defaults to 0.0.
3098
3099 @item s
3100 Specify the saturation in the [-10,10] range. It accepts a float number and
3101 defaults to 1.0.
3102 @end table
3103
3104 The @var{h}, @var{H} and @var{s} parameters are expressions containing the
3105 following constants:
3106
3107 @table @option
3108 @item n
3109 frame count of the input frame starting from 0
3110
3111 @item pts
3112 presentation timestamp of the input frame expressed in time base units
3113
3114 @item r
3115 frame rate of the input video, NAN if the input frame rate is unknown
3116
3117 @item t
3118 timestamp expressed in seconds, NAN if the input timestamp is unknown
3119
3120 @item tb
3121 time base of the input video
3122 @end table
3123
3124 The options can also be set using the syntax: @var{hue}:@var{saturation}
3125
3126 In this case @var{hue} is expressed in degrees.
3127
3128 Some examples follow:
3129 @itemize
3130 @item
3131 Set the hue to 90 degrees and the saturation to 1.0:
3132 @example
3133 hue=h=90:s=1
3134 @end example
3135
3136 @item
3137 Same command but expressing the hue in radians:
3138 @example
3139 hue=H=PI/2:s=1
3140 @end example
3141
3142 @item
3143 Same command without named options, hue must be expressed in degrees:
3144 @example
3145 hue=90:1
3146 @end example
3147
3148 @item
3149 Note that "h:s" syntax does not support expressions for the values of
3150 h and s, so the following example will issue an error:
3151 @example
3152 hue=PI/2:1
3153 @end example
3154
3155 @item
3156 Rotate hue and make the saturation swing between 0
3157 and 2 over a period of 1 second:
3158 @example
3159 hue="H=2*PI*t: s=sin(2*PI*t)+1"
3160 @end example
3161
3162 @item
3163 Apply a 3 seconds saturation fade-in effect starting at 0:
3164 @example
3165 hue="s=min(t/3\,1)"
3166 @end example
3167
3168 The general fade-in expression can be written as:
3169 @example
3170 hue="s=min(0\, max((t-START)/DURATION\, 1))"
3171 @end example
3172
3173 @item
3174 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
3175 @example
3176 hue="s=max(0\, min(1\, (8-t)/3))"
3177 @end example
3178
3179 The general fade-out expression can be written as:
3180 @example
3181 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
3182 @end example
3183
3184 @end itemize
3185
3186 @subsection Commands
3187
3188 This filter supports the following command:
3189 @table @option
3190 @item reinit
3191 Modify the hue and/or the saturation of the input video.
3192 The command accepts the same named options and syntax than when calling the
3193 filter from the command-line.
3194
3195 If a parameter is omitted, it is kept at its current value.
3196 @end table
3197
3198 @section idet
3199
3200 Interlaceing detect filter. This filter tries to detect if the input is
3201 interlaced or progressive. Top or bottom field first.
3202
3203 @section kerndeint
3204
3205 Deinterlace input video by applying Donald Graft's adaptive kernel
3206 deinterling. Work on interlaced parts of a video to produce
3207 progressive frames.
3208
3209 This filter accepts parameters as a list of @var{key}=@var{value}
3210 pairs, separated by ":". If the key of the first options is omitted,
3211 the arguments are interpreted according to the following syntax:
3212 @var{thresh}:@var{map}:@var{order}:@var{sharp}:@var{twoway}.
3213
3214 The description of the accepted parameters follows.
3215
3216 @table @option
3217 @item thresh
3218 Set the threshold which affects the filter's tolerance when
3219 determining if a pixel line must be processed. It must be an integer
3220 in the range [0,255] and defaults to 10. A value of 0 will result in
3221 applying the process on every pixels.
3222
3223 @item map
3224 Paint pixels exceeding the threshold value to white if set to 1.
3225 Default is 0.
3226
3227 @item order
3228 Set the fields order. Swap fields if set to 1, leave fields alone if
3229 0. Default is 0.
3230
3231 @item sharp
3232 Enable additional sharpening if set to 1. Default is 0.
3233
3234 @item twoway
3235 Enable twoway sharpening if set to 1. Default is 0.
3236 @end table
3237
3238 @subsection Examples
3239
3240 @itemize
3241 @item
3242 Apply default values:
3243 @example
3244 kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
3245 @end example
3246
3247 @item
3248 Enable additional sharpening:
3249 @example
3250 kerndeint=sharp=1
3251 @end example
3252
3253 @item
3254 Paint processed pixels in white:
3255 @example
3256 kerndeint=map=1
3257 @end example
3258 @end itemize
3259
3260 @section lut, lutrgb, lutyuv
3261
3262 Compute a look-up table for binding each pixel component input value
3263 to an output value, and apply it to input video.
3264
3265 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
3266 to an RGB input video.
3267
3268 These filters accept in input a ":"-separated list of options, which
3269 specify the expressions used for computing the lookup table for the
3270 corresponding pixel component values.
3271
3272 The @var{lut} filter requires either YUV or RGB pixel formats in
3273 input, and accepts the options:
3274 @table @option
3275 @item @var{c0} (first  pixel component)
3276 @item @var{c1} (second pixel component)
3277 @item @var{c2} (third  pixel component)
3278 @item @var{c3} (fourth pixel component, corresponds to the alpha component)
3279 @end table
3280
3281 The exact component associated to each option depends on the format in
3282 input.
3283
3284 The @var{lutrgb} filter requires RGB pixel formats in input, and
3285 accepts the options:
3286 @table @option
3287 @item @var{r} (red component)
3288 @item @var{g} (green component)
3289 @item @var{b} (blue component)
3290 @item @var{a} (alpha component)
3291 @end table
3292
3293 The @var{lutyuv} filter requires YUV pixel formats in input, and
3294 accepts the options:
3295 @table @option
3296 @item @var{y} (Y/luminance component)
3297 @item @var{u} (U/Cb component)
3298 @item @var{v} (V/Cr component)
3299 @item @var{a} (alpha component)
3300 @end table
3301
3302 The expressions can contain the following constants and functions:
3303
3304 @table @option
3305 @item w, h
3306 the input width and height
3307
3308 @item val
3309 input value for the pixel component
3310
3311 @item clipval
3312 the input value clipped in the @var{minval}-@var{maxval} range
3313
3314 @item maxval
3315 maximum value for the pixel component
3316
3317 @item minval
3318 minimum value for the pixel component
3319
3320 @item negval
3321 the negated value for the pixel component value clipped in the
3322 @var{minval}-@var{maxval} range , it corresponds to the expression
3323 "maxval-clipval+minval"
3324
3325 @item clip(val)
3326 the computed value in @var{val} clipped in the
3327 @var{minval}-@var{maxval} range
3328
3329 @item gammaval(gamma)
3330 the computed gamma correction value of the pixel component value
3331 clipped in the @var{minval}-@var{maxval} range, corresponds to the
3332 expression
3333 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
3334
3335 @end table
3336
3337 All expressions default to "val".
3338
3339 Some examples follow:
3340 @example
3341 # negate input video
3342 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
3343 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
3344
3345 # the above is the same as
3346 lutrgb="r=negval:g=negval:b=negval"
3347 lutyuv="y=negval:u=negval:v=negval"
3348
3349 # negate luminance
3350 lutyuv=y=negval
3351
3352 # remove chroma components, turns the video into a graytone image
3353 lutyuv="u=128:v=128"
3354
3355 # apply a luma burning effect
3356 lutyuv="y=2*val"
3357
3358 # remove green and blue components
3359 lutrgb="g=0:b=0"
3360
3361 # set a constant alpha channel value on input
3362 format=rgba,lutrgb=a="maxval-minval/2"
3363
3364 # correct luminance gamma by a 0.5 factor
3365 lutyuv=y=gammaval(0.5)
3366 @end example
3367
3368 @section mp
3369
3370 Apply an MPlayer filter to the input video.
3371
3372 This filter provides a wrapper around most of the filters of
3373 MPlayer/MEncoder.
3374
3375 This wrapper is considered experimental. Some of the wrapped filters
3376 may not work properly and we may drop support for them, as they will
3377 be implemented natively into FFmpeg. Thus you should avoid
3378 depending on them when writing portable scripts.
3379
3380 The filters accepts the parameters:
3381 @var{filter_name}[:=]@var{filter_params}
3382
3383 @var{filter_name} is the name of a supported MPlayer filter,
3384 @var{filter_params} is a string containing the parameters accepted by
3385 the named filter.
3386
3387 The list of the currently supported filters follows:
3388 @table @var
3389 @item detc
3390 @item dint
3391 @item divtc
3392 @item down3dright
3393 @item dsize
3394 @item eq2
3395 @item eq
3396 @item fil
3397 @item fspp
3398 @item harddup
3399 @item il
3400 @item ilpack
3401 @item ivtc
3402 @item kerndeint
3403 @item mcdeint
3404 @item noise
3405 @item ow
3406 @item perspective
3407 @item phase
3408 @item pp7
3409 @item pullup
3410 @item qp
3411 @item sab
3412 @item softpulldown
3413 @item softskip
3414 @item spp
3415 @item telecine
3416 @item tinterlace
3417 @item unsharp
3418 @item uspp
3419 @end table
3420
3421 The parameter syntax and behavior for the listed filters are the same
3422 of the corresponding MPlayer filters. For detailed instructions check
3423 the "VIDEO FILTERS" section in the MPlayer manual.
3424
3425 Some examples follow:
3426 @itemize
3427 @item
3428 Adjust gamma, brightness, contrast:
3429 @example
3430 mp=eq2=1.0:2:0.5
3431 @end example
3432
3433 @item
3434 Add temporal noise to input video:
3435 @example
3436 mp=noise=20t
3437 @end example
3438 @end itemize
3439
3440 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
3441
3442 @section negate
3443
3444 Negate input video.
3445
3446 This filter accepts an integer in input, if non-zero it negates the
3447 alpha component (if available). The default value in input is 0.
3448
3449 @section noformat
3450
3451 Force libavfilter not to use any of the specified pixel formats for the
3452 input to the next filter.
3453
3454 The filter accepts a list of pixel format names, separated by ":",
3455 for example "yuv420p:monow:rgb24".
3456
3457 Some examples follow:
3458 @example
3459 # force libavfilter to use a format different from "yuv420p" for the
3460 # input to the vflip filter
3461 noformat=yuv420p,vflip
3462
3463 # convert the input video to any of the formats not contained in the list
3464 noformat=yuv420p:yuv444p:yuv410p
3465 @end example
3466
3467 @section null
3468
3469 Pass the video source unchanged to the output.
3470
3471 @section ocv
3472
3473 Apply video transform using libopencv.
3474
3475 To enable this filter install libopencv library and headers and
3476 configure FFmpeg with @code{--enable-libopencv}.
3477
3478 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
3479
3480 @var{filter_name} is the name of the libopencv filter to apply.
3481
3482 @var{filter_params} specifies the parameters to pass to the libopencv
3483 filter. If not specified the default values are assumed.
3484
3485 Refer to the official libopencv documentation for more precise
3486 information:
3487 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
3488
3489 Follows the list of supported libopencv filters.
3490
3491 @anchor{dilate}
3492 @subsection dilate
3493
3494 Dilate an image by using a specific structuring element.
3495 This filter corresponds to the libopencv function @code{cvDilate}.
3496
3497 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
3498
3499 @var{struct_el} represents a structuring element, and has the syntax:
3500 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
3501
3502 @var{cols} and @var{rows} represent the number of columns and rows of
3503 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
3504 point, and @var{shape} the shape for the structuring element, and
3505 can be one of the values "rect", "cross", "ellipse", "custom".
3506
3507 If the value for @var{shape} is "custom", it must be followed by a
3508 string of the form "=@var{filename}". The file with name
3509 @var{filename} is assumed to represent a binary image, with each
3510 printable character corresponding to a bright pixel. When a custom
3511 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
3512 or columns and rows of the read file are assumed instead.
3513
3514 The default value for @var{struct_el} is "3x3+0x0/rect".
3515
3516 @var{nb_iterations} specifies the number of times the transform is
3517 applied to the image, and defaults to 1.
3518
3519 Follow some example:
3520 @example
3521 # use the default values
3522 ocv=dilate
3523
3524 # dilate using a structuring element with a 5x5 cross, iterate two times
3525 ocv=dilate=5x5+2x2/cross:2
3526
3527 # read the shape from the file diamond.shape, iterate two times
3528 # the file diamond.shape may contain a pattern of characters like this:
3529 #   *
3530 #  ***
3531 # *****
3532 #  ***
3533 #   *
3534 # the specified cols and rows are ignored (but not the anchor point coordinates)
3535 ocv=0x0+2x2/custom=diamond.shape:2
3536 @end example
3537
3538 @subsection erode
3539
3540 Erode an image by using a specific structuring element.
3541 This filter corresponds to the libopencv function @code{cvErode}.
3542
3543 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
3544 with the same syntax and semantics as the @ref{dilate} filter.
3545
3546 @subsection smooth
3547
3548 Smooth the input video.
3549
3550 The filter takes the following parameters:
3551 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
3552
3553 @var{type} is the type of smooth filter to apply, and can be one of
3554 the following values: "blur", "blur_no_scale", "median", "gaussian",
3555 "bilateral". The default value is "gaussian".
3556
3557 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
3558 parameters whose meanings depend on smooth type. @var{param1} and
3559 @var{param2} accept integer positive values or 0, @var{param3} and
3560 @var{param4} accept float values.
3561
3562 The default value for @var{param1} is 3, the default value for the
3563 other parameters is 0.
3564
3565 These parameters correspond to the parameters assigned to the
3566 libopencv function @code{cvSmooth}.
3567
3568 @anchor{overlay}
3569 @section overlay
3570
3571 Overlay one video on top of another.
3572
3573 It takes two inputs and one output, the first input is the "main"
3574 video on which the second input is overlayed.
3575
3576 This filter accepts a list of @var{key}=@var{value} pairs as argument,
3577 separated by ":". If the key of the first options is omitted, the
3578 arguments are interpreted according to the syntax @var{x}:@var{y}.
3579
3580 A description of the accepted options follows.
3581
3582 @table @option
3583 @item x, y
3584 Set the expression for the x and y coordinates of the overlayed video
3585 on the main video. Default value is 0.
3586
3587 The @var{x} and @var{y} expressions can contain the following
3588 parameters:
3589 @table @option
3590 @item main_w, main_h
3591 main input width and height
3592
3593 @item W, H
3594 same as @var{main_w} and @var{main_h}
3595
3596 @item overlay_w, overlay_h
3597 overlay input width and height
3598
3599 @item w, h
3600 same as @var{overlay_w} and @var{overlay_h}
3601 @end table
3602
3603 @item rgb
3604 If set to 1, force the filter to accept inputs in the RGB
3605 color space. Default value is 0.
3606 @end table
3607
3608 Be aware that frames are taken from each input video in timestamp
3609 order, hence, if their initial timestamps differ, it is a a good idea
3610 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
3611 have them begin in the same zero timestamp, as it does the example for
3612 the @var{movie} filter.
3613
3614 You can chain together more overlays but you should test the
3615 efficiency of such approach.
3616
3617 @subsection Examples
3618
3619 @itemize
3620 @item
3621 Draw the overlay at 10 pixels from the bottom right corner of the main
3622 video:
3623 @example
3624 overlay=main_w-overlay_w-10:main_h-overlay_h-10
3625 @end example
3626
3627 Using named options the example above becomes:
3628 @example
3629 overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
3630 @end example
3631
3632 @item
3633 Insert a transparent PNG logo in the bottom left corner of the input,
3634 using the @command{ffmpeg} tool with the @code{-filter_complex} option:
3635 @example
3636 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
3637 @end example
3638
3639 @item
3640 Insert 2 different transparent PNG logos (second logo on bottom
3641 right corner) using the @command{ffmpeg} tool:
3642 @example
3643 ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
3644 @end example
3645
3646 @item
3647 Add a transparent color layer on top of the main video, WxH specifies
3648 the size of the main input to the overlay filter:
3649 @example
3650 color=red@@.3:WxH [over]; [in][over] overlay [out]
3651 @end example
3652
3653 @item
3654 Play an original video and a filtered version (here with the deshake
3655 filter) side by side using the @command{ffplay} tool:
3656 @example
3657 ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
3658 @end example
3659
3660 The above command is the same as:
3661 @example
3662 ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
3663 @end example
3664
3665 @item
3666 Chain several overlays in cascade:
3667 @example
3668 nullsrc=s=200x200 [bg];
3669 testsrc=s=100x100, split=4 [in0][in1][in2][in3];
3670 [in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
3671 [in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
3672 [in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
3673 [in3] null,       [mid2] overlay=100:100 [out0]
3674 @end example
3675
3676 @end itemize
3677
3678 @section pad
3679
3680 Add paddings to the input image, and places the original input at the
3681 given coordinates @var{x}, @var{y}.
3682
3683 It accepts the following parameters:
3684 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
3685
3686 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
3687 expressions containing the following constants:
3688
3689 @table @option
3690 @item in_w, in_h
3691 the input video width and height
3692
3693 @item iw, ih
3694 same as @var{in_w} and @var{in_h}
3695
3696 @item out_w, out_h
3697 the output width and height, that is the size of the padded area as
3698 specified by the @var{width} and @var{height} expressions
3699
3700 @item ow, oh
3701 same as @var{out_w} and @var{out_h}
3702
3703 @item x, y
3704 x and y offsets as specified by the @var{x} and @var{y}
3705 expressions, or NAN if not yet specified
3706
3707 @item a
3708 same as @var{iw} / @var{ih}
3709
3710 @item sar
3711 input sample aspect ratio
3712
3713 @item dar
3714 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
3715
3716 @item hsub, vsub
3717 horizontal and vertical chroma subsample values. For example for the
3718 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3719 @end table
3720
3721 Follows the description of the accepted parameters.
3722
3723 @table @option
3724 @item width, height
3725
3726 Specify the size of the output image with the paddings added. If the
3727 value for @var{width} or @var{height} is 0, the corresponding input size
3728 is used for the output.
3729
3730 The @var{width} expression can reference the value set by the
3731 @var{height} expression, and vice versa.
3732
3733 The default value of @var{width} and @var{height} is 0.
3734
3735 @item x, y
3736
3737 Specify the offsets where to place the input image in the padded area
3738 with respect to the top/left border of the output image.
3739
3740 The @var{x} expression can reference the value set by the @var{y}
3741 expression, and vice versa.
3742
3743 The default value of @var{x} and @var{y} is 0.
3744
3745 @item color
3746
3747 Specify the color of the padded area, it can be the name of a color
3748 (case insensitive match) or a 0xRRGGBB[AA] sequence.
3749
3750 The default value of @var{color} is "black".
3751
3752 @end table
3753
3754 @subsection Examples
3755
3756 @itemize
3757 @item
3758 Add paddings with color "violet" to the input video. Output video
3759 size is 640x480, the top-left corner of the input video is placed at
3760 column 0, row 40:
3761 @example
3762 pad=640:480:0:40:violet
3763 @end example
3764
3765 @item
3766 Pad the input to get an output with dimensions increased by 3/2,
3767 and put the input video at the center of the padded area:
3768 @example
3769 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
3770 @end example
3771
3772 @item
3773 Pad the input to get a squared output with size equal to the maximum
3774 value between the input width and height, and put the input video at
3775 the center of the padded area:
3776 @example
3777 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
3778 @end example
3779
3780 @item
3781 Pad the input to get a final w/h ratio of 16:9:
3782 @example
3783 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
3784 @end example
3785
3786 @item
3787 In case of anamorphic video, in order to set the output display aspect
3788 correctly, it is necessary to use @var{sar} in the expression,
3789 according to the relation:
3790 @example
3791 (ih * X / ih) * sar = output_dar
3792 X = output_dar / sar
3793 @end example
3794
3795 Thus the previous example needs to be modified to:
3796 @example
3797 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
3798 @end example
3799
3800 @item
3801 Double output size and put the input video in the bottom-right
3802 corner of the output padded area:
3803 @example
3804 pad="2*iw:2*ih:ow-iw:oh-ih"
3805 @end example
3806 @end itemize
3807
3808 @section pixdesctest
3809
3810 Pixel format descriptor test filter, mainly useful for internal
3811 testing. The output video should be equal to the input video.
3812
3813 For example:
3814 @example
3815 format=monow, pixdesctest
3816 @end example
3817
3818 can be used to test the monowhite pixel format descriptor definition.
3819
3820 @section pp
3821
3822 Enable the specified chain of postprocessing subfilters using libpostproc. This
3823 library should be automatically selected with a GPL build (@code{--enable-gpl}).
3824 Subfilters must be separated by '/' and can be disabled by prepending a '-'.
3825 Each subfilter and some options have a short and a long name that can be used
3826 interchangeably, i.e. dr/dering are the same.
3827
3828 All subfilters share common options to determine their scope:
3829
3830 @table @option
3831 @item a/autoq
3832 Honor the quality commands for this subfilter.
3833
3834 @item c/chrom
3835 Do chrominance filtering, too (default).
3836
3837 @item y/nochrom
3838 Do luminance filtering only (no chrominance).
3839
3840 @item n/noluma
3841 Do chrominance filtering only (no luminance).
3842 @end table
3843
3844 These options can be appended after the subfilter name, separated by a ':'.
3845
3846 Available subfilters are:
3847
3848 @table @option
3849 @item hb/hdeblock[:difference[:flatness]]
3850 Horizontal deblocking filter
3851 @table @option
3852 @item difference
3853 Difference factor where higher values mean more deblocking (default: @code{32}).
3854 @item flatness
3855 Flatness threshold where lower values mean more deblocking (default: @code{39}).
3856 @end table
3857
3858 @item vb/vdeblock[:difference[:flatness]]
3859 Vertical deblocking filter
3860 @table @option
3861 @item difference
3862 Difference factor where higher values mean more deblocking (default: @code{32}).
3863 @item flatness
3864 Flatness threshold where lower values mean more deblocking (default: @code{39}).
3865 @end table
3866
3867 @item ha/hadeblock[:difference[:flatness]]
3868 Accurate horizontal deblocking filter
3869 @table @option
3870 @item difference
3871 Difference factor where higher values mean more deblocking (default: @code{32}).
3872 @item flatness
3873 Flatness threshold where lower values mean more deblocking (default: @code{39}).
3874 @end table
3875
3876 @item va/vadeblock[:difference[:flatness]]
3877 Accurate vertical deblocking filter
3878 @table @option
3879 @item difference
3880 Difference factor where higher values mean more deblocking (default: @code{32}).
3881 @item flatness
3882 Flatness threshold where lower values mean more deblocking (default: @code{39}).
3883 @end table
3884 @end table
3885
3886 The horizontal and vertical deblocking filters share the difference and
3887 flatness values so you cannot set different horizontal and vertical
3888 thresholds.
3889
3890 @table @option
3891 @item h1/x1hdeblock
3892 Experimental horizontal deblocking filter
3893
3894 @item v1/x1vdeblock
3895 Experimental vertical deblocking filter
3896
3897 @item dr/dering
3898 Deringing filter
3899
3900 @item tn/tmpnoise[:threshold1[:threshold2[:threshold3]]], temporal noise reducer
3901 @table @option
3902 @item threshold1
3903 larger -> stronger filtering
3904 @item threshold2
3905 larger -> stronger filtering
3906 @item threshold3
3907 larger -> stronger filtering
3908 @end table
3909
3910 @item al/autolevels[:f/fullyrange], automatic brightness / contrast correction
3911 @table @option
3912 @item f/fullyrange
3913 Stretch luminance to @code{0-255}.
3914 @end table
3915
3916 @item lb/linblenddeint
3917 Linear blend deinterlacing filter that deinterlaces the given block by
3918 filtering all lines with a @code{(1 2 1)} filter.
3919
3920 @item li/linipoldeint
3921 Linear interpolating deinterlacing filter that deinterlaces the given block by
3922 linearly interpolating every second line.
3923
3924 @item ci/cubicipoldeint
3925 Cubic interpolating deinterlacing filter deinterlaces the given block by
3926 cubically interpolating every second line.
3927
3928 @item md/mediandeint
3929 Median deinterlacing filter that deinterlaces the given block by applying a
3930 median filter to every second line.
3931
3932 @item fd/ffmpegdeint
3933 FFmpeg deinterlacing filter that deinterlaces the given block by filtering every
3934 second line with a @code{(-1 4 2 4 -1)} filter.
3935
3936 @item l5/lowpass5
3937 Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given
3938 block by filtering all lines with a @code{(-1 2 6 2 -1)} filter.
3939
3940 @item fq/forceQuant[:quantizer]
3941 Overrides the quantizer table from the input with the constant quantizer you
3942 specify.
3943 @table @option
3944 @item quantizer
3945 Quantizer to use
3946 @end table
3947
3948 @item de/default
3949 Default pp filter combination (@code{hb:a,vb:a,dr:a})
3950
3951 @item fa/fast
3952 Fast pp filter combination (@code{h1:a,v1:a,dr:a})
3953
3954 @item ac
3955 High quality pp filter combination (@code{ha:a:128:7,va:a,dr:a})
3956 @end table
3957
3958 @subsection Examples
3959
3960 @itemize
3961 @item
3962 Apply horizontal and vertical deblocking, deringing and automatic
3963 brightness/contrast:
3964 @example
3965 pp=hb/vb/dr/al
3966 @end example
3967
3968 @item
3969 Apply default filters without brightness/contrast correction:
3970 @example
3971 pp=de/-al
3972 @end example
3973
3974 @item
3975 Apply default filters and temporal denoiser:
3976 @example
3977 pp=default/tmpnoise:1:2:3
3978 @end example
3979
3980 @item
3981 Apply deblocking on luminance only, and switch vertical deblocking on or off
3982 automatically depending on available CPU time:
3983 @example
3984 pp=hb:y/vb:a
3985 @end example
3986 @end itemize
3987
3988 @section removelogo
3989
3990 Suppress a TV station logo, using an image file to determine which
3991 pixels comprise the logo. It works by filling in the pixels that
3992 comprise the logo with neighboring pixels.
3993
3994 This filter requires one argument which specifies the filter bitmap
3995 file, which can be any image format supported by libavformat. The
3996 width and height of the image file must match those of the video
3997 stream being processed.
3998
3999 Pixels in the provided bitmap image with a value of zero are not
4000 considered part of the logo, non-zero pixels are considered part of
4001 the logo. If you use white (255) for the logo and black (0) for the
4002 rest, you will be safe. For making the filter bitmap, it is
4003 recommended to take a screen capture of a black frame with the logo
4004 visible, and then using a threshold filter followed by the erode
4005 filter once or twice.
4006
4007 If needed, little splotches can be fixed manually. Remember that if
4008 logo pixels are not covered, the filter quality will be much
4009 reduced. Marking too many pixels as part of the logo does not hurt as
4010 much, but it will increase the amount of blurring needed to cover over
4011 the image and will destroy more information than necessary, and extra
4012 pixels will slow things down on a large logo.
4013
4014 @section scale
4015
4016 Scale (resize) the input video, using the libswscale library.
4017
4018 The scale filter forces the output display aspect ratio to be the same
4019 of the input, by changing the output sample aspect ratio.
4020
4021 This filter accepts a list of named options in the form of
4022 @var{key}=@var{value} pairs separated by ":". If the key for the first
4023 two options is not specified, the assumed keys for the first two
4024 values are @code{w} and @code{h}. If the first option has no key and
4025 can be interpreted like a video size specification, it will be used
4026 to set the video size.
4027
4028 A description of the accepted options follows.
4029
4030 @table @option
4031 @item width, w
4032 Set the video width expression, default value is @code{iw}. See below
4033 for the list of accepted constants.
4034
4035 @item height, h
4036 Set the video heiht expression, default value is @code{ih}.
4037 See below for the list of accepted constants.
4038
4039 @item interl
4040 Set the interlacing. It accepts the following values:
4041
4042 @table @option
4043 @item 1
4044 force interlaced aware scaling
4045
4046 @item 0
4047 do not apply interlaced scaling
4048
4049 @item -1
4050 select interlaced aware scaling depending on whether the source frames
4051 are flagged as interlaced or not
4052 @end table
4053
4054 Default value is @code{0}.
4055
4056 @item flags
4057 Set libswscale scaling flags. If not explictly specified the filter
4058 applies a bilinear scaling algorithm.
4059
4060 @item size, s
4061 Set the video size, the value must be a valid abbreviation or in the
4062 form @var{width}x@var{height}.
4063 @end table
4064
4065 The values of the @var{w} and @var{h} options are expressions
4066 containing the following constants:
4067
4068 @table @option
4069 @item in_w, in_h
4070 the input width and height
4071
4072 @item iw, ih
4073 same as @var{in_w} and @var{in_h}
4074
4075 @item out_w, out_h
4076 the output (cropped) width and height
4077
4078 @item ow, oh
4079 same as @var{out_w} and @var{out_h}
4080
4081 @item a
4082 same as @var{iw} / @var{ih}
4083
4084 @item sar
4085 input sample aspect ratio
4086
4087 @item dar
4088 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
4089
4090 @item hsub, vsub
4091 horizontal and vertical chroma subsample values. For example for the
4092 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
4093 @end table
4094
4095 If the input image format is different from the format requested by
4096 the next filter, the scale filter will convert the input to the
4097 requested format.
4098
4099 If the value for @var{width} or @var{height} is 0, the respective input
4100 size is used for the output.
4101
4102 If the value for @var{width} or @var{height} is -1, the scale filter will
4103 use, for the respective output size, a value that maintains the aspect
4104 ratio of the input image.
4105
4106 @subsection Examples
4107
4108 @itemize
4109 @item
4110 Scale the input video to a size of 200x100:
4111 @example
4112 scale=200:100
4113 @end example
4114
4115 This is equivalent to:
4116 @example
4117 scale=w=200:h=100
4118 @end example
4119
4120 or:
4121 @example
4122 scale=200x100
4123 @end example
4124
4125 @item
4126 Specify a size abbreviation for the output size:
4127 @example
4128 scale=qcif
4129 @end example
4130
4131 which can also be written as:
4132 @example
4133 scale=size=qcif
4134 @end example
4135
4136 @item
4137 Scale the input to 2x:
4138 @example
4139 scale=2*iw:2*ih
4140 @end example
4141
4142 @item
4143 The above is the same as:
4144 @example
4145 scale=2*in_w:2*in_h
4146 @end example
4147
4148 @item
4149 Scale the input to 2x with forced interlaced scaling:
4150 @example
4151 scale=2*iw:2*ih:interl=1
4152 @end example
4153
4154 @item
4155 Scale the input to half size:
4156 @example
4157 scale=iw/2:ih/2
4158 @end example
4159
4160 @item
4161 Increase the width, and set the height to the same size:
4162 @example
4163 scale=3/2*iw:ow
4164 @end example
4165
4166 @item
4167 Seek for Greek harmony:
4168 @example
4169 scale=iw:1/PHI*iw
4170 scale=ih*PHI:ih
4171 @end example
4172
4173 @item
4174 Increase the height, and set the width to 3/2 of the height:
4175 @example
4176 scale=3/2*oh:3/5*ih
4177 @end example
4178
4179 @item
4180 Increase the size, but make the size a multiple of the chroma:
4181 @example
4182 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
4183 @end example
4184
4185 @item
4186 Increase the width to a maximum of 500 pixels, keep the same input
4187 aspect ratio:
4188 @example
4189 scale='min(500\, iw*3/2):-1'
4190 @end example
4191 @end itemize
4192
4193 @section setdar, setsar
4194
4195 The @code{setdar} filter sets the Display Aspect Ratio for the filter
4196 output video.
4197
4198 This is done by changing the specified Sample (aka Pixel) Aspect
4199 Ratio, according to the following equation:
4200 @example
4201 @var{DAR} = @var{HORIZONTAL_RESOLUTION} / @var{VERTICAL_RESOLUTION} * @var{SAR}
4202 @end example
4203
4204 Keep in mind that the @code{setdar} filter does not modify the pixel
4205 dimensions of the video frame. Also the display aspect ratio set by
4206 this filter may be changed by later filters in the filterchain,
4207 e.g. in case of scaling or if another "setdar" or a "setsar" filter is
4208 applied.
4209
4210 The @code{setsar} filter sets the Sample (aka Pixel) Aspect Ratio for
4211 the filter output video.
4212
4213 Note that as a consequence of the application of this filter, the
4214 output display aspect ratio will change according to the equation
4215 above.
4216
4217 Keep in mind that the sample aspect ratio set by the @code{setsar}
4218 filter may be changed by later filters in the filterchain, e.g. if
4219 another "setsar" or a "setdar" filter is applied.
4220
4221 The @code{setdar} and @code{setsar} filters accept a string in the
4222 form @var{num}:@var{den} expressing an aspect ratio, or the following
4223 named options, expressed as a sequence of @var{key}=@var{value} pairs,
4224 separated by ":".
4225
4226 @table @option
4227 @item max
4228 Set the maximum integer value to use for expressing numerator and
4229 denominator when reducing the expressed aspect ratio to a rational.
4230 Default value is @code{100}.
4231
4232 @item r, ratio:
4233 Set the aspect ratio used by the filter.
4234
4235 The parameter can be a floating point number string, an expression, or
4236 a string of the form @var{num}:@var{den}, where @var{num} and
4237 @var{den} are the numerator and denominator of the aspect ratio. If
4238 the parameter is not specified, it is assumed the value "0".
4239 In case the form "@var{num}:@var{den}" the @code{:} character should
4240 be escaped.
4241 @end table
4242
4243 If the keys are omitted in the named options list, the specifed values
4244 are assumed to be @var{ratio} and @var{max} in that order.
4245
4246 For example to change the display aspect ratio to 16:9, specify:
4247 @example
4248 setdar='16:9'
4249 @end example
4250
4251 The example above is equivalent to:
4252 @example
4253 setdar=1.77777
4254 @end example
4255
4256 To change the sample aspect ratio to 10:11, specify:
4257 @example
4258 setsar='10:11'
4259 @end example
4260
4261 To set a display aspect ratio of 16:9, and specify a maximum integer value of
4262 1000 in the aspect ratio reduction, use the command:
4263 @example
4264 setdar=ratio='16:9':max=1000
4265 @end example
4266
4267 @section setfield
4268
4269 Force field for the output video frame.
4270
4271 The @code{setfield} filter marks the interlace type field for the
4272 output frames. It does not change the input frame, but only sets the
4273 corresponding property, which affects how the frame is treated by
4274 following filters (e.g. @code{fieldorder} or @code{yadif}).
4275
4276 This filter accepts a single option @option{mode}, which can be
4277 specified either by setting @code{mode=VALUE} or setting the value
4278 alone. Available values are:
4279
4280 @table @samp
4281 @item auto
4282 Keep the same field property.
4283
4284 @item bff
4285 Mark the frame as bottom-field-first.
4286
4287 @item tff
4288 Mark the frame as top-field-first.
4289
4290 @item prog
4291 Mark the frame as progressive.
4292 @end table
4293
4294 @section showinfo
4295
4296 Show a line containing various information for each input video frame.
4297 The input video is not modified.
4298
4299 The shown line contains a sequence of key/value pairs of the form
4300 @var{key}:@var{value}.
4301
4302 A description of each shown parameter follows:
4303
4304 @table @option
4305 @item n
4306 sequential number of the input frame, starting from 0
4307
4308 @item pts
4309 Presentation TimeStamp of the input frame, expressed as a number of
4310 time base units. The time base unit depends on the filter input pad.
4311
4312 @item pts_time
4313 Presentation TimeStamp of the input frame, expressed as a number of
4314 seconds
4315
4316 @item pos
4317 position of the frame in the input stream, -1 if this information in
4318 unavailable and/or meaningless (for example in case of synthetic video)
4319
4320 @item fmt
4321 pixel format name
4322
4323 @item sar
4324 sample aspect ratio of the input frame, expressed in the form
4325 @var{num}/@var{den}
4326
4327 @item s
4328 size of the input frame, expressed in the form
4329 @var{width}x@var{height}
4330
4331 @item i
4332 interlaced mode ("P" for "progressive", "T" for top field first, "B"
4333 for bottom field first)
4334
4335 @item iskey
4336 1 if the frame is a key frame, 0 otherwise
4337
4338 @item type
4339 picture type of the input frame ("I" for an I-frame, "P" for a
4340 P-frame, "B" for a B-frame, "?" for unknown type).
4341 Check also the documentation of the @code{AVPictureType} enum and of
4342 the @code{av_get_picture_type_char} function defined in
4343 @file{libavutil/avutil.h}.
4344
4345 @item checksum
4346 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
4347
4348 @item plane_checksum
4349 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
4350 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
4351 @end table
4352
4353 @section smartblur
4354
4355 Blur the input video without impacting the outlines.
4356
4357 The filter accepts the following parameters:
4358 @var{luma_radius}:@var{luma_strength}:@var{luma_threshold}[:@var{chroma_radius}:@var{chroma_strength}:@var{chroma_threshold}]
4359
4360 Parameters prefixed by @var{luma} indicate that they work on the
4361 luminance of the pixels whereas parameters prefixed by @var{chroma}
4362 refer to the chrominance of the pixels.
4363
4364 If the chroma parameters are not set, the luma parameters are used for
4365 either the luminance and the chrominance of the pixels.
4366
4367 @var{luma_radius} or @var{chroma_radius} must be a float number in the
4368 range [0.1,5.0] that specifies the variance of the gaussian filter
4369 used to blur the image (slower if larger).
4370
4371 @var{luma_strength} or @var{chroma_strength} must be a float number in
4372 the range [-1.0,1.0] that configures the blurring. A value included in
4373 [0.0,1.0] will blur the image whereas a value included in [-1.0,0.0]
4374 will sharpen the image.
4375
4376 @var{luma_threshold} or @var{chroma_threshold} must be an integer in
4377 the range [-30,30] that is used as a coefficient to determine whether
4378 a pixel should be blurred or not. A value of 0 will filter all the
4379 image, a value included in [0,30] will filter flat areas and a value
4380 included in [-30,0] will filter edges.
4381
4382 @anchor{subtitles}
4383 @section subtitles
4384
4385 Draw subtitles on top of input video using the libass library.
4386
4387 To enable compilation of this filter you need to configure FFmpeg with
4388 @code{--enable-libass}. This filter also requires a build with libavcodec and
4389 libavformat to convert the passed subtitles file to ASS (Advanced Substation
4390 Alpha) subtitles format.
4391
4392 This filter accepts the following named options, expressed as a
4393 sequence of @var{key}=@var{value} pairs, separated by ":".
4394
4395 @table @option
4396 @item filename, f
4397 Set the filename of the subtitle file to read. It must be specified.
4398
4399 @item original_size
4400 Specify the size of the original video, the video for which the ASS file
4401 was composed. Due to a misdesign in ASS aspect ratio arithmetic, this is
4402 necessary to correctly scale the fonts if the aspect ratio has been changed.
4403 @end table
4404
4405 If the first key is not specified, it is assumed that the first value
4406 specifies the @option{filename}.
4407
4408 For example, to render the file @file{sub.srt} on top of the input
4409 video, use the command:
4410 @example
4411 subtitles=sub.srt
4412 @end example
4413
4414 which is equivalent to:
4415 @example
4416 subtitles=filename=sub.srt
4417 @end example
4418
4419 @section split
4420
4421 Split input video into several identical outputs.
4422
4423 The filter accepts a single parameter which specifies the number of outputs. If
4424 unspecified, it defaults to 2.
4425
4426 For example
4427 @example
4428 ffmpeg -i INPUT -filter_complex split=5 OUTPUT
4429 @end example
4430 will create 5 copies of the input video.
4431
4432 For example:
4433 @example
4434 [in] split [splitout1][splitout2];
4435 [splitout1] crop=100:100:0:0    [cropout];
4436 [splitout2] pad=200:200:100:100 [padout];
4437 @end example
4438
4439 will create two separate outputs from the same input, one cropped and
4440 one padded.
4441
4442 @section super2xsai
4443
4444 Scale the input by 2x and smooth using the Super2xSaI (Scale and
4445 Interpolate) pixel art scaling algorithm.
4446
4447 Useful for enlarging pixel art images without reducing sharpness.
4448
4449 @section swapuv
4450 Swap U & V plane.
4451
4452 @section thumbnail
4453 Select the most representative frame in a given sequence of consecutive frames.
4454
4455 It accepts as argument the frames batch size to analyze (default @var{N}=100);
4456 in a set of @var{N} frames, the filter will pick one of them, and then handle
4457 the next batch of @var{N} frames until the end.
4458
4459 Since the filter keeps track of the whole frames sequence, a bigger @var{N}
4460 value will result in a higher memory usage, so a high value is not recommended.
4461
4462 The following example extract one picture each 50 frames:
4463 @example
4464 thumbnail=50
4465 @end example
4466
4467 Complete example of a thumbnail creation with @command{ffmpeg}:
4468 @example
4469 ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
4470 @end example
4471
4472 @section tile
4473
4474 Tile several successive frames together.
4475
4476 It accepts a list of options in the form of @var{key}=@var{value} pairs
4477 separated by ":". A description of the accepted options follows.
4478
4479 @table @option
4480
4481 @item layout
4482 Set the grid size (i.e. the number of lines and columns) in the form
4483 "@var{w}x@var{h}".
4484
4485 @item margin
4486 Set the outer border margin in pixels.
4487
4488 @item padding
4489 Set the inner border thickness (i.e. the number of pixels between frames). For
4490 more advanced padding options (such as having different values for the edges),
4491 refer to the pad video filter.
4492
4493 @item nb_frames
4494 Set the maximum number of frames to render in the given area. It must be less
4495 than or equal to @var{w}x@var{h}. The default value is @code{0}, meaning all
4496 the area will be used.
4497
4498 @end table
4499
4500 Alternatively, the options can be specified as a flat string:
4501
4502 @var{layout}[:@var{nb_frames}[:@var{margin}[:@var{padding}]]]
4503
4504 For example, produce 8×8 PNG tiles of all keyframes (@option{-skip_frame
4505 nokey}) in a movie:
4506 @example
4507 ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
4508 @end example
4509 The @option{-vsync 0} is necessary to prevent @command{ffmpeg} from
4510 duplicating each output frame to accomodate the originally detected frame
4511 rate.
4512
4513 Another example to display @code{5} pictures in an area of @code{3x2} frames,
4514 with @code{7} pixels between them, and @code{2} pixels of initial margin, using
4515 mixed flat and named options:
4516 @example
4517 tile=3x2:nb_frames=5:padding=7:margin=2
4518 @end example
4519
4520 @section tinterlace
4521
4522 Perform various types of temporal field interlacing.
4523
4524 Frames are counted starting from 1, so the first input frame is
4525 considered odd.
4526
4527 This filter accepts options in the form of @var{key}=@var{value} pairs
4528 separated by ":".
4529 Alternatively, the @var{mode} option can be specified as a value alone,
4530 optionally followed by a ":" and further ":" separated @var{key}=@var{value}
4531 pairs.
4532
4533 A description of the accepted options follows.
4534
4535 @table @option
4536
4537 @item mode
4538 Specify the mode of the interlacing. This option can also be specified
4539 as a value alone. See below for a list of values for this option.
4540
4541 Available values are:
4542
4543 @table @samp
4544 @item merge, 0
4545 Move odd frames into the upper field, even into the lower field,
4546 generating a double height frame at half framerate.
4547
4548 @item drop_odd, 1
4549 Only output even frames, odd frames are dropped, generating a frame with
4550 unchanged height at half framerate.
4551
4552 @item drop_even, 2
4553 Only output odd frames, even frames are dropped, generating a frame with
4554 unchanged height at half framerate.
4555
4556 @item pad, 3
4557 Expand each frame to full height, but pad alternate lines with black,
4558 generating a frame with double height at the same input framerate.
4559
4560 @item interleave_top, 4
4561 Interleave the upper field from odd frames with the lower field from
4562 even frames, generating a frame with unchanged height at half framerate.
4563
4564 @item interleave_bottom, 5
4565 Interleave the lower field from odd frames with the upper field from
4566 even frames, generating a frame with unchanged height at half framerate.
4567
4568 @item interlacex2, 6
4569 Double frame rate with unchanged height. Frames are inserted each
4570 containing the second temporal field from the previous input frame and
4571 the first temporal field from the next input frame. This mode relies on
4572 the top_field_first flag. Useful for interlaced video displays with no
4573 field synchronisation.
4574 @end table
4575
4576 Numeric values are deprecated but are accepted for backward
4577 compatibility reasons.
4578
4579 Default mode is @code{merge}.
4580
4581 @item flags
4582 Specify flags influencing the filter process.
4583
4584 Available value for @var{flags} is:
4585
4586 @table @option
4587 @item low_pass_filter, vlfp
4588 Enable vertical low-pass filtering in the filter.
4589 Vertical low-pass filtering is required when creating an interlaced
4590 destination from a progressive source which contains high-frequency
4591 vertical detail. Filtering will reduce interlace 'twitter' and Moire
4592 patterning.
4593
4594 Vertical low-pass filtering can only be enabled for @option{mode}
4595 @var{interleave_top} and @var{interleave_bottom}.
4596
4597 @end table
4598 @end table
4599
4600 @section transpose
4601
4602 Transpose rows with columns in the input video and optionally flip it.
4603
4604 The filter accepts parameters as a list of @var{key}=@var{value}
4605 pairs, separated by ':'. If the key of the first options is omitted,
4606 the arguments are interpreted according to the syntax
4607 @var{dir}:@var{passthrough}.
4608
4609 @table @option
4610 @item dir
4611 Specify the transposition direction. Can assume the following values:
4612
4613 @table @samp
4614 @item 0, 4
4615 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
4616 @example
4617 L.R     L.l
4618 . . ->  . .
4619 l.r     R.r
4620 @end example
4621
4622 @item 1, 5
4623 Rotate by 90 degrees clockwise, that is:
4624 @example
4625 L.R     l.L
4626 . . ->  . .
4627 l.r     r.R
4628 @end example
4629
4630 @item 2, 6
4631 Rotate by 90 degrees counterclockwise, that is:
4632 @example
4633 L.R     R.r
4634 . . ->  . .
4635 l.r     L.l
4636 @end example
4637
4638 @item 3, 7
4639 Rotate by 90 degrees clockwise and vertically flip, that is:
4640 @example
4641 L.R     r.R
4642 . . ->  . .
4643 l.r     l.L
4644 @end example
4645 @end table
4646
4647 For values between 4-7, the transposition is only done if the input
4648 video geometry is portrait and not landscape. These values are
4649 deprecated, the @code{passthrough} option should be used instead.
4650
4651 @item passthrough
4652 Do not apply the transposition if the input geometry matches the one
4653 specified by the specified value. It accepts the following values:
4654 @table @samp
4655 @item none
4656 Always apply transposition.
4657 @item portrait
4658 Preserve portrait geometry (when @var{height} >= @var{width}).
4659 @item landscape
4660 Preserve landscape geometry (when @var{width} >= @var{height}).
4661 @end table
4662
4663 Default value is @code{none}.
4664 @end table
4665
4666 For example to rotate by 90 degrees clockwise and preserve portrait
4667 layout:
4668 @example
4669 transpose=dir=1:passthrough=portrait
4670 @end example
4671
4672 The command above can also be specified as:
4673 @example
4674 transpose=1:portrait
4675 @end example
4676
4677 @section unsharp
4678
4679 Sharpen or blur the input video.
4680
4681 It accepts the following parameters:
4682 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
4683
4684 Negative values for the amount will blur the input video, while positive
4685 values will sharpen. All parameters are optional and default to the
4686 equivalent of the string '5:5:1.0:5:5:0.0'.
4687
4688 @table @option
4689
4690 @item luma_msize_x
4691 Set the luma matrix horizontal size. It can be an integer between 3
4692 and 13, default value is 5.
4693
4694 @item luma_msize_y
4695 Set the luma matrix vertical size. It can be an integer between 3
4696 and 13, default value is 5.
4697
4698 @item luma_amount
4699 Set the luma effect strength. It can be a float number between -2.0
4700 and 5.0, default value is 1.0.
4701
4702 @item chroma_msize_x
4703 Set the chroma matrix horizontal size. It can be an integer between 3
4704 and 13, default value is 5.
4705
4706 @item chroma_msize_y
4707 Set the chroma matrix vertical size. It can be an integer between 3
4708 and 13, default value is 5.
4709
4710 @item chroma_amount
4711 Set the chroma effect strength. It can be a float number between -2.0
4712 and 5.0, default value is 0.0.
4713
4714 @end table
4715
4716 @example
4717 # Strong luma sharpen effect parameters
4718 unsharp=7:7:2.5
4719
4720 # Strong blur of both luma and chroma parameters
4721 unsharp=7:7:-2:7:7:-2
4722
4723 # Use the default values with @command{ffmpeg}
4724 ffmpeg -i in.avi -vf "unsharp" out.mp4
4725 @end example
4726
4727 @section vflip
4728
4729 Flip the input video vertically.
4730
4731 @example
4732 ffmpeg -i in.avi -vf "vflip" out.avi
4733 @end example
4734
4735 @section yadif
4736
4737 Deinterlace the input video ("yadif" means "yet another deinterlacing
4738 filter").
4739
4740 The filter accepts parameters as a list of @var{key}=@var{value}
4741 pairs, separated by ":". If the key of the first options is omitted,
4742 the arguments are interpreted according to syntax
4743 @var{mode}:@var{parity}:@var{deint}.
4744
4745 The description of the accepted parameters follows.
4746
4747 @table @option
4748 @item mode
4749 Specify the interlacing mode to adopt. Accept one of the following
4750 values:
4751
4752 @table @option
4753 @item 0, send_frame
4754 output 1 frame for each frame
4755 @item 1, send_field
4756 output 1 frame for each field
4757 @item 2, send_frame_nospatial
4758 like @code{send_frame} but skip spatial interlacing check
4759 @item 3, send_field_nospatial
4760 like @code{send_field} but skip spatial interlacing check
4761 @end table
4762
4763 Default value is @code{send_frame}.
4764
4765 @item parity
4766 Specify the picture field parity assumed for the input interlaced
4767 video. Accept one of the following values:
4768
4769 @table @option
4770 @item 0, tff
4771 assume top field first
4772 @item 1, bff
4773 assume bottom field first
4774 @item -1, auto
4775 enable automatic detection
4776 @end table
4777
4778 Default value is @code{auto}.
4779 If interlacing is unknown or decoder does not export this information,
4780 top field first will be assumed.
4781
4782 @item deint
4783 Specify which frames to deinterlace. Accept one of the following
4784 values:
4785
4786 @table @option
4787 @item 0, all
4788 deinterlace all frames
4789 @item 1, interlaced
4790 only deinterlace frames marked as interlaced
4791 @end table
4792
4793 Default value is @code{all}.
4794 @end table
4795
4796 @c man end VIDEO FILTERS
4797
4798 @chapter Video Sources
4799 @c man begin VIDEO SOURCES
4800
4801 Below is a description of the currently available video sources.
4802
4803 @section buffer
4804
4805 Buffer video frames, and make them available to the filter chain.
4806
4807 This source is mainly intended for a programmatic use, in particular
4808 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
4809
4810 It accepts a list of options in the form of @var{key}=@var{value} pairs
4811 separated by ":". A description of the accepted options follows.
4812
4813 @table @option
4814
4815 @item video_size
4816 Specify the size (width and height) of the buffered video frames.
4817
4818 @item pix_fmt
4819 A string representing the pixel format of the buffered video frames.
4820 It may be a number corresponding to a pixel format, or a pixel format
4821 name.
4822
4823 @item time_base
4824 Specify the timebase assumed by the timestamps of the buffered frames.
4825
4826 @item time_base
4827 Specify the frame rate expected for the video stream.
4828
4829 @item pixel_aspect
4830 Specify the sample aspect ratio assumed by the video frames.
4831
4832 @item sws_param
4833 Specify the optional parameters to be used for the scale filter which
4834 is automatically inserted when an input change is detected in the
4835 input size or format.
4836 @end table
4837
4838 For example:
4839 @example
4840 buffer=size=320x240:pix_fmt=yuv410p:time_base=1/24:pixel_aspect=1/1
4841 @end example
4842
4843 will instruct the source to accept video frames with size 320x240 and
4844 with format "yuv410p", assuming 1/24 as the timestamps timebase and
4845 square pixels (1:1 sample aspect ratio).
4846 Since the pixel format with name "yuv410p" corresponds to the number 6
4847 (check the enum AVPixelFormat definition in @file{libavutil/pixfmt.h}),
4848 this example corresponds to:
4849 @example
4850 buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
4851 @end example
4852
4853 Alternatively, the options can be specified as a flat string, but this
4854 syntax is deprecated:
4855
4856 @var{width}:@var{height}:@var{pix_fmt}:@var{time_base.num}:@var{time_base.den}:@var{pixel_aspect.num}:@var{pixel_aspect.den}[:@var{sws_param}]
4857
4858 @section cellauto
4859
4860 Create a pattern generated by an elementary cellular automaton.
4861
4862 The initial state of the cellular automaton can be defined through the
4863 @option{filename}, and @option{pattern} options. If such options are
4864 not specified an initial state is created randomly.
4865
4866 At each new frame a new row in the video is filled with the result of
4867 the cellular automaton next generation. The behavior when the whole
4868 frame is filled is defined by the @option{scroll} option.
4869
4870 This source accepts a list of options in the form of
4871 @var{key}=@var{value} pairs separated by ":". A description of the
4872 accepted options follows.
4873
4874 @table @option
4875 @item filename, f
4876 Read the initial cellular automaton state, i.e. the starting row, from
4877 the specified file.
4878 In the file, each non-whitespace character is considered an alive
4879 cell, a newline will terminate the row, and further characters in the
4880 file will be ignored.
4881
4882 @item pattern, p
4883 Read the initial cellular automaton state, i.e. the starting row, from
4884 the specified string.
4885
4886 Each non-whitespace character in the string is considered an alive
4887 cell, a newline will terminate the row, and further characters in the
4888 string will be ignored.
4889
4890 @item rate, r
4891 Set the video rate, that is the number of frames generated per second.
4892 Default is 25.
4893
4894 @item random_fill_ratio, ratio
4895 Set the random fill ratio for the initial cellular automaton row. It
4896 is a floating point number value ranging from 0 to 1, defaults to
4897 1/PHI.
4898
4899 This option is ignored when a file or a pattern is specified.
4900
4901 @item random_seed, seed
4902 Set the seed for filling randomly the initial row, must be an integer
4903 included between 0 and UINT32_MAX. If not specified, or if explicitly
4904 set to -1, the filter will try to use a good random seed on a best
4905 effort basis.
4906
4907 @item rule
4908 Set the cellular automaton rule, it is a number ranging from 0 to 255.
4909 Default value is 110.
4910
4911 @item size, s
4912 Set the size of the output video.
4913
4914 If @option{filename} or @option{pattern} is specified, the size is set
4915 by default to the width of the specified initial state row, and the
4916 height is set to @var{width} * PHI.
4917
4918 If @option{size} is set, it must contain the width of the specified
4919 pattern string, and the specified pattern will be centered in the
4920 larger row.
4921
4922 If a filename or a pattern string is not specified, the size value
4923 defaults to "320x518" (used for a randomly generated initial state).
4924
4925 @item scroll
4926 If set to 1, scroll the output upward when all the rows in the output
4927 have been already filled. If set to 0, the new generated row will be
4928 written over the top row just after the bottom row is filled.
4929 Defaults to 1.
4930
4931 @item start_full, full
4932 If set to 1, completely fill the output with generated rows before
4933 outputting the first frame.
4934 This is the default behavior, for disabling set the value to 0.
4935
4936 @item stitch
4937 If set to 1, stitch the left and right row edges together.
4938 This is the default behavior, for disabling set the value to 0.
4939 @end table
4940
4941 @subsection Examples
4942
4943 @itemize
4944 @item
4945 Read the initial state from @file{pattern}, and specify an output of
4946 size 200x400.
4947 @example
4948 cellauto=f=pattern:s=200x400
4949 @end example
4950
4951 @item
4952 Generate a random initial row with a width of 200 cells, with a fill
4953 ratio of 2/3:
4954 @example
4955 cellauto=ratio=2/3:s=200x200
4956 @end example
4957
4958 @item
4959 Create a pattern generated by rule 18 starting by a single alive cell
4960 centered on an initial row with width 100:
4961 @example
4962 cellauto=p=@@:s=100x400:full=0:rule=18
4963 @end example
4964
4965 @item
4966 Specify a more elaborated initial pattern:
4967 @example
4968 cellauto=p='@@@@ @@ @@@@':s=100x400:full=0:rule=18
4969 @end example
4970
4971 @end itemize
4972
4973 @section mandelbrot
4974
4975 Generate a Mandelbrot set fractal, and progressively zoom towards the
4976 point specified with @var{start_x} and @var{start_y}.
4977
4978 This source accepts a list of options in the form of
4979 @var{key}=@var{value} pairs separated by ":". A description of the
4980 accepted options follows.
4981
4982 @table @option
4983
4984 @item end_pts
4985 Set the terminal pts value. Default value is 400.
4986
4987 @item end_scale
4988 Set the terminal scale value.
4989 Must be a floating point value. Default value is 0.3.
4990
4991 @item inner
4992 Set the inner coloring mode, that is the algorithm used to draw the
4993 Mandelbrot fractal internal region.
4994
4995 It shall assume one of the following values:
4996 @table @option
4997 @item black
4998 Set black mode.
4999 @item convergence
5000 Show time until convergence.
5001 @item mincol
5002 Set color based on point closest to the origin of the iterations.
5003 @item period
5004 Set period mode.
5005 @end table
5006
5007 Default value is @var{mincol}.
5008
5009 @item bailout
5010 Set the bailout value. Default value is 10.0.
5011
5012 @item maxiter
5013 Set the maximum of iterations performed by the rendering
5014 algorithm. Default value is 7189.
5015
5016 @item outer
5017 Set outer coloring mode.
5018 It shall assume one of following values:
5019 @table @option
5020 @item iteration_count
5021 Set iteration cound mode.
5022 @item normalized_iteration_count
5023 set normalized iteration count mode.
5024 @end table
5025 Default value is @var{normalized_iteration_count}.
5026
5027 @item rate, r
5028 Set frame rate, expressed as number of frames per second. Default
5029 value is "25".
5030
5031 @item size, s
5032 Set frame size. Default value is "640x480".
5033
5034 @item start_scale
5035 Set the initial scale value. Default value is 3.0.
5036
5037 @item start_x
5038 Set the initial x position. Must be a floating point value between
5039 -100 and 100. Default value is -0.743643887037158704752191506114774.
5040
5041 @item start_y
5042 Set the initial y position. Must be a floating point value between
5043 -100 and 100. Default value is -0.131825904205311970493132056385139.
5044 @end table
5045
5046 @section mptestsrc
5047
5048 Generate various test patterns, as generated by the MPlayer test filter.
5049
5050 The size of the generated video is fixed, and is 256x256.
5051 This source is useful in particular for testing encoding features.
5052
5053 This source accepts an optional sequence of @var{key}=@var{value} pairs,
5054 separated by ":". The description of the accepted options follows.
5055
5056 @table @option
5057
5058 @item rate, r
5059 Specify the frame rate of the sourced video, as the number of frames
5060 generated per second. It has to be a string in the format
5061 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
5062 number or a valid video frame rate abbreviation. The default value is
5063 "25".
5064
5065 @item duration, d
5066 Set the video duration of the sourced video. The accepted syntax is:
5067 @example
5068 [-]HH:MM:SS[.m...]
5069 [-]S+[.m...]
5070 @end example
5071 See also the function @code{av_parse_time()}.
5072
5073 If not specified, or the expressed duration is negative, the video is
5074 supposed to be generated forever.
5075
5076 @item test, t
5077
5078 Set the number or the name of the test to perform. Supported tests are:
5079 @table @option
5080 @item dc_luma
5081 @item dc_chroma
5082 @item freq_luma
5083 @item freq_chroma
5084 @item amp_luma
5085 @item amp_chroma
5086 @item cbp
5087 @item mv
5088 @item ring1
5089 @item ring2
5090 @item all
5091 @end table
5092
5093 Default value is "all", which will cycle through the list of all tests.
5094 @end table
5095
5096 For example the following:
5097 @example
5098 testsrc=t=dc_luma
5099 @end example
5100
5101 will generate a "dc_luma" test pattern.
5102
5103 @section frei0r_src
5104
5105 Provide a frei0r source.
5106
5107 To enable compilation of this filter you need to install the frei0r
5108 header and configure FFmpeg with @code{--enable-frei0r}.
5109
5110 The source supports the syntax:
5111 @example
5112 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
5113 @end example
5114
5115 @var{size} is the size of the video to generate, may be a string of the
5116 form @var{width}x@var{height} or a frame size abbreviation.
5117 @var{rate} is the rate of the video to generate, may be a string of
5118 the form @var{num}/@var{den} or a frame rate abbreviation.
5119 @var{src_name} is the name to the frei0r source to load. For more
5120 information regarding frei0r and how to set the parameters read the
5121 section @ref{frei0r} in the description of the video filters.
5122
5123 For example, to generate a frei0r partik0l source with size 200x200
5124 and frame rate 10 which is overlayed on the overlay filter main input:
5125 @example
5126 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
5127 @end example
5128
5129 @section life
5130
5131 Generate a life pattern.
5132
5133 This source is based on a generalization of John Conway's life game.
5134
5135 The sourced input represents a life grid, each pixel represents a cell
5136 which can be in one of two possible states, alive or dead. Every cell
5137 interacts with its eight neighbours, which are the cells that are
5138 horizontally, vertically, or diagonally adjacent.
5139
5140 At each interaction the grid evolves according to the adopted rule,
5141 which specifies the number of neighbor alive cells which will make a
5142 cell stay alive or born. The @option{rule} option allows to specify
5143 the rule to adopt.
5144
5145 This source accepts a list of options in the form of
5146 @var{key}=@var{value} pairs separated by ":". A description of the
5147 accepted options follows.
5148
5149 @table @option
5150 @item filename, f