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