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