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