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