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