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