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