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