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