lavfi/blend: use dual input helpers
[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 @chapter Timeline editing
271
272 Some filters support a generic @option{enable} option. For the filters
273 supporting timeline editing, this option can be set to an expression which is
274 evaluated before sending a frame to the filter. If the evaluation is non-zero,
275 the filter will be enabled, otherwise the frame will be sent unchanged to the
276 next filter in the filtergraph.
277
278 The expression accepts the following values:
279 @table @samp
280 @item t
281 timestamp expressed in seconds, NAN if the input timestamp is unknown
282
283 @item n
284 sequential number of the input frame, starting from 0
285
286 @item pos
287 the position in the file of the input frame, NAN if unknown
288 @end table
289
290 Additionally, these filters support an @option{enable} command that can be used
291 to re-define the expression.
292
293 Like any other filtering option, the @option{enable} option follows the same
294 rules.
295
296 For example, to enable a blur filter (@ref{smartblur}) from 10 seconds to 3
297 minutes, and a @ref{curves} filter starting at 3 seconds:
298 @example
299 smartblur = enable='between(t,10,3*60)',
300 curves    = enable='gte(t,3)' : preset=cross_process
301 @end example
302
303 @c man end FILTERGRAPH DESCRIPTION
304
305 @chapter Audio Filters
306 @c man begin AUDIO FILTERS
307
308 When you configure your FFmpeg build, you can disable any of the
309 existing filters using @code{--disable-filters}.
310 The configure output will show the audio filters included in your
311 build.
312
313 Below is a description of the currently available audio filters.
314
315 @section aconvert
316
317 Convert the input audio format to the specified formats.
318
319 @emph{This filter is deprecated. Use @ref{aformat} instead.}
320
321 The filter accepts a string of the form:
322 "@var{sample_format}:@var{channel_layout}".
323
324 @var{sample_format} specifies the sample format, and can be a string or the
325 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
326 suffix for a planar sample format.
327
328 @var{channel_layout} specifies the channel layout, and can be a string
329 or the corresponding number value defined in @file{libavutil/channel_layout.h}.
330
331 The special parameter "auto", signifies that the filter will
332 automatically select the output format depending on the output filter.
333
334 @subsection Examples
335
336 @itemize
337 @item
338 Convert input to float, planar, stereo:
339 @example
340 aconvert=fltp:stereo
341 @end example
342
343 @item
344 Convert input to unsigned 8-bit, automatically select out channel layout:
345 @example
346 aconvert=u8:auto
347 @end example
348 @end itemize
349
350 @section afade
351
352 Apply fade-in/out effect to input audio.
353
354 A description of the accepted parameters follows.
355
356 @table @option
357 @item type, t
358 Specify the effect type, can be either @code{in} for fade-in, or
359 @code{out} for a fade-out effect. Default is @code{in}.
360
361 @item start_sample, ss
362 Specify the number of the start sample for starting to apply the fade
363 effect. Default is 0.
364
365 @item nb_samples, ns
366 Specify the number of samples for which the fade effect has to last. At
367 the end of the fade-in effect the output audio will have the same
368 volume as the input audio, at the end of the fade-out transition
369 the output audio will be silence. Default is 44100.
370
371 @item start_time, st
372 Specify time for starting to apply the fade effect. Default is 0.
373 The accepted syntax is:
374 @example
375 [-]HH[:MM[:SS[.m...]]]
376 [-]S+[.m...]
377 @end example
378 See also the function @code{av_parse_time()}.
379 If set this option is used instead of @var{start_sample} one.
380
381 @item duration, d
382 Specify the duration for which the fade effect has to last. Default is 0.
383 The accepted syntax is:
384 @example
385 [-]HH[:MM[:SS[.m...]]]
386 [-]S+[.m...]
387 @end example
388 See also the function @code{av_parse_time()}.
389 At the end of the fade-in effect the output audio will have the same
390 volume as the input audio, at the end of the fade-out transition
391 the output audio will be silence.
392 If set this option is used instead of @var{nb_samples} one.
393
394 @item curve
395 Set curve for fade transition.
396
397 It accepts the following values:
398 @table @option
399 @item tri
400 select triangular, linear slope (default)
401 @item qsin
402 select quarter of sine wave
403 @item hsin
404 select half of sine wave
405 @item esin
406 select exponential sine wave
407 @item log
408 select logarithmic
409 @item par
410 select inverted parabola
411 @item qua
412 select quadratic
413 @item cub
414 select cubic
415 @item squ
416 select square root
417 @item cbr
418 select cubic root
419 @end table
420 @end table
421
422 @subsection Examples
423
424 @itemize
425 @item
426 Fade in first 15 seconds of audio:
427 @example
428 afade=t=in:ss=0:d=15
429 @end example
430
431 @item
432 Fade out last 25 seconds of a 900 seconds audio:
433 @example
434 afade=t=out:st=875:d=25
435 @end example
436 @end itemize
437
438 @anchor{aformat}
439 @section aformat
440
441 Set output format constraints for the input audio. The framework will
442 negotiate the most appropriate format to minimize conversions.
443
444 The filter accepts the following named parameters:
445 @table @option
446
447 @item sample_fmts
448 A '|'-separated list of requested sample formats.
449
450 @item sample_rates
451 A '|'-separated list of requested sample rates.
452
453 @item channel_layouts
454 A '|'-separated list of requested channel layouts.
455
456 @end table
457
458 If a parameter is omitted, all values are allowed.
459
460 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
461 @example
462 aformat=sample_fmts=u8|s16:channel_layouts=stereo
463 @end example
464
465 @section allpass
466
467 Apply a two-pole all-pass filter with central frequency (in Hz)
468 @var{frequency}, and filter-width @var{width}.
469 An all-pass filter changes the audio's frequency to phase relationship
470 without changing its frequency to amplitude relationship.
471
472 The filter accepts the following options:
473
474 @table @option
475 @item frequency, f
476 Set frequency in Hz.
477
478 @item width_type
479 Set method to specify band-width of filter.
480 @table @option
481 @item h
482 Hz
483 @item q
484 Q-Factor
485 @item o
486 octave
487 @item s
488 slope
489 @end table
490
491 @item width, w
492 Specify the band-width of a filter in width_type units.
493 @end table
494
495 @section amerge
496
497 Merge two or more audio streams into a single multi-channel stream.
498
499 The filter accepts the following options:
500
501 @table @option
502
503 @item inputs
504 Set the number of inputs. Default is 2.
505
506 @end table
507
508 If the channel layouts of the inputs are disjoint, and therefore compatible,
509 the channel layout of the output will be set accordingly and the channels
510 will be reordered as necessary. If the channel layouts of the inputs are not
511 disjoint, the output will have all the channels of the first input then all
512 the channels of the second input, in that order, and the channel layout of
513 the output will be the default value corresponding to the total number of
514 channels.
515
516 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
517 is FC+BL+BR, then the output will be in 5.1, with the channels in the
518 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
519 first input, b1 is the first channel of the second input).
520
521 On the other hand, if both input are in stereo, the output channels will be
522 in the default order: a1, a2, b1, b2, and the channel layout will be
523 arbitrarily set to 4.0, which may or may not be the expected value.
524
525 All inputs must have the same sample rate, and format.
526
527 If inputs do not have the same duration, the output will stop with the
528 shortest.
529
530 @subsection Examples
531
532 @itemize
533 @item
534 Merge two mono files into a stereo stream:
535 @example
536 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
537 @end example
538
539 @item
540 Multiple merges assuming 1 video stream and 6 audio streams in @file{input.mkv}:
541 @example
542 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
543 @end example
544 @end itemize
545
546 @section amix
547
548 Mixes multiple audio inputs into a single output.
549
550 For example
551 @example
552 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
553 @end example
554 will mix 3 input audio streams to a single output with the same duration as the
555 first input and a dropout transition time of 3 seconds.
556
557 The filter accepts the following named parameters:
558 @table @option
559
560 @item inputs
561 Number of inputs. If unspecified, it defaults to 2.
562
563 @item duration
564 How to determine the end-of-stream.
565 @table @option
566
567 @item longest
568 Duration of longest input. (default)
569
570 @item shortest
571 Duration of shortest input.
572
573 @item first
574 Duration of first input.
575
576 @end table
577
578 @item dropout_transition
579 Transition time, in seconds, for volume renormalization when an input
580 stream ends. The default value is 2 seconds.
581
582 @end table
583
584 @section anull
585
586 Pass the audio source unchanged to the output.
587
588 @section apad
589
590 Pad the end of a audio stream with silence, this can be used together with
591 -shortest to extend audio streams to the same length as the video stream.
592
593 @section aphaser
594 Add a phasing effect to the input audio.
595
596 A phaser filter creates series of peaks and troughs in the frequency spectrum.
597 The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
598
599 A description of the accepted parameters follows.
600
601 @table @option
602 @item in_gain
603 Set input gain. Default is 0.4.
604
605 @item out_gain
606 Set output gain. Default is 0.74
607
608 @item delay
609 Set delay in milliseconds. Default is 3.0.
610
611 @item decay
612 Set decay. Default is 0.4.
613
614 @item speed
615 Set modulation speed in Hz. Default is 0.5.
616
617 @item type
618 Set modulation type. Default is triangular.
619
620 It accepts the following values:
621 @table @samp
622 @item triangular, t
623 @item sinusoidal, s
624 @end table
625 @end table
626
627 @anchor{aresample}
628 @section aresample
629
630 Resample the input audio to the specified parameters, using the
631 libswresample library. If none are specified then the filter will
632 automatically convert between its input and output.
633
634 This filter is also able to stretch/squeeze the audio data to make it match
635 the timestamps or to inject silence / cut out audio to make it match the
636 timestamps, do a combination of both or do neither.
637
638 The filter accepts the syntax
639 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
640 expresses a sample rate and @var{resampler_options} is a list of
641 @var{key}=@var{value} pairs, separated by ":". See the
642 ffmpeg-resampler manual for the complete list of supported options.
643
644 @subsection Examples
645
646 @itemize
647 @item
648 Resample the input audio to 44100Hz:
649 @example
650 aresample=44100
651 @end example
652
653 @item
654 Stretch/squeeze samples to the given timestamps, with a maximum of 1000
655 samples per second compensation:
656 @example
657 aresample=async=1000
658 @end example
659 @end itemize
660
661 @section asetnsamples
662
663 Set the number of samples per each output audio frame.
664
665 The last output packet may contain a different number of samples, as
666 the filter will flush all the remaining samples when the input audio
667 signal its end.
668
669 The filter accepts the following options:
670
671 @table @option
672
673 @item nb_out_samples, n
674 Set the number of frames per each output audio frame. The number is
675 intended as the number of samples @emph{per each channel}.
676 Default value is 1024.
677
678 @item pad, p
679 If set to 1, the filter will pad the last audio frame with zeroes, so
680 that the last frame will contain the same number of samples as the
681 previous ones. Default value is 1.
682 @end table
683
684 For example, to set the number of per-frame samples to 1234 and
685 disable padding for the last frame, use:
686 @example
687 asetnsamples=n=1234:p=0
688 @end example
689
690 @section asetrate
691
692 Set the sample rate without altering the PCM data.
693 This will result in a change of speed and pitch.
694
695 The filter accepts the following options:
696
697 @table @option
698 @item sample_rate, r
699 Set the output sample rate. Default is 44100 Hz.
700 @end table
701
702 @section ashowinfo
703
704 Show a line containing various information for each input audio frame.
705 The input audio is not modified.
706
707 The shown line contains a sequence of key/value pairs of the form
708 @var{key}:@var{value}.
709
710 A description of each shown parameter follows:
711
712 @table @option
713 @item n
714 sequential number of the input frame, starting from 0
715
716 @item pts
717 Presentation timestamp of the input frame, in time base units; the time base
718 depends on the filter input pad, and is usually 1/@var{sample_rate}.
719
720 @item pts_time
721 presentation timestamp of the input frame in seconds
722
723 @item pos
724 position of the frame in the input stream, -1 if this information in
725 unavailable and/or meaningless (for example in case of synthetic audio)
726
727 @item fmt
728 sample format
729
730 @item chlayout
731 channel layout
732
733 @item rate
734 sample rate for the audio frame
735
736 @item nb_samples
737 number of samples (per channel) in the frame
738
739 @item checksum
740 Adler-32 checksum (printed in hexadecimal) of the audio data. For planar audio
741 the data is treated as if all the planes were concatenated.
742
743 @item plane_checksums
744 A list of Adler-32 checksums for each data plane.
745 @end table
746
747 @section astats
748
749 Display time domain statistical information about the audio channels.
750 Statistics are calculated and displayed for each audio channel and,
751 where applicable, an overall figure is also given.
752
753 The filter accepts the following option:
754 @table @option
755 @item length
756 Short window length in seconds, used for peak and trough RMS measurement.
757 Default is @code{0.05} (50 miliseconds). Allowed range is @code{[0.1 - 10]}.
758 @end table
759
760 A description of each shown parameter follows:
761
762 @table @option
763 @item DC offset
764 Mean amplitude displacement from zero.
765
766 @item Min level
767 Minimal sample level.
768
769 @item Max level
770 Maximal sample level.
771
772 @item Peak level dB
773 @item RMS level dB
774 Standard peak and RMS level measured in dBFS.
775
776 @item RMS peak dB
777 @item RMS trough dB
778 Peak and trough values for RMS level measured over a short window.
779
780 @item Crest factor
781 Standard ratio of peak to RMS level (note: not in dB).
782
783 @item Flat factor
784 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
785 (i.e. either @var{Min level} or @var{Max level}).
786
787 @item Peak count
788 Number of occasions (not the number of samples) that the signal attained either
789 @var{Min level} or @var{Max level}.
790 @end table
791
792 @section astreamsync
793
794 Forward two audio streams and control the order the buffers are forwarded.
795
796 The filter accepts the following options:
797
798 @table @option
799 @item expr, e
800 Set the expression deciding which stream should be
801 forwarded next: if the result is negative, the first stream is forwarded; if
802 the result is positive or zero, the second stream is forwarded. It can use
803 the following variables:
804
805 @table @var
806 @item b1 b2
807 number of buffers forwarded so far on each stream
808 @item s1 s2
809 number of samples forwarded so far on each stream
810 @item t1 t2
811 current timestamp of each stream
812 @end table
813
814 The default value is @code{t1-t2}, which means to always forward the stream
815 that has a smaller timestamp.
816 @end table
817
818 @subsection Examples
819
820 Stress-test @code{amerge} by randomly sending buffers on the wrong
821 input, while avoiding too much of a desynchronization:
822 @example
823 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
824 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
825 [a2] [b2] amerge
826 @end example
827
828 @section asyncts
829
830 Synchronize audio data with timestamps by squeezing/stretching it and/or
831 dropping samples/adding silence when needed.
832
833 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
834
835 The filter accepts the following named parameters:
836 @table @option
837
838 @item compensate
839 Enable stretching/squeezing the data to make it match the timestamps. Disabled
840 by default. When disabled, time gaps are covered with silence.
841
842 @item min_delta
843 Minimum difference between timestamps and audio data (in seconds) to trigger
844 adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
845 this filter, try setting this parameter to 0.
846
847 @item max_comp
848 Maximum compensation in samples per second. Relevant only with compensate=1.
849 Default value 500.
850
851 @item first_pts
852 Assume the first pts should be this value. The time base is 1 / sample rate.
853 This allows for padding/trimming at the start of stream. By default, no
854 assumption is made about the first frame's expected pts, so no padding or
855 trimming is done. For example, this could be set to 0 to pad the beginning with
856 silence if an audio stream starts after the video stream or to trim any samples
857 with a negative pts due to encoder delay.
858
859 @end table
860
861 @section atempo
862
863 Adjust audio tempo.
864
865 The filter accepts exactly one parameter, the audio tempo. If not
866 specified then the filter will assume nominal 1.0 tempo. Tempo must
867 be in the [0.5, 2.0] range.
868
869 @subsection Examples
870
871 @itemize
872 @item
873 Slow down audio to 80% tempo:
874 @example
875 atempo=0.8
876 @end example
877
878 @item
879 To speed up audio to 125% tempo:
880 @example
881 atempo=1.25
882 @end example
883 @end itemize
884
885 @section atrim
886
887 Trim the input so that the output contains one continuous subpart of the input.
888
889 This filter accepts the following options:
890 @table @option
891 @item start
892 Timestamp (in seconds) of the start of the kept section. I.e. the audio sample
893 with the timestamp @var{start} will be the first sample in the output.
894
895 @item end
896 Timestamp (in seconds) of the first audio sample that will be dropped. I.e. the
897 audio sample immediately preceding the one with the timestamp @var{end} will be
898 the last sample in the output.
899
900 @item start_pts
901 Same as @var{start}, except this option sets the start timestamp in samples
902 instead of seconds.
903
904 @item end_pts
905 Same as @var{end}, except this option sets the end timestamp in samples instead
906 of seconds.
907
908 @item duration
909 Maximum duration of the output in seconds.
910
911 @item start_sample
912 Number of the first sample that should be passed to output.
913
914 @item end_sample
915 Number of the first sample that should be dropped.
916 @end table
917
918 Note that the first two sets of the start/end options and the @option{duration}
919 option look at the frame timestamp, while the _sample options simply count the
920 samples that pass through the filter. So start/end_pts and start/end_sample will
921 give different results when the timestamps are wrong, inexact or do not start at
922 zero. Also note that this filter does not modify the timestamps. If you wish
923 that the output timestamps start at zero, insert the asetpts filter after the
924 atrim filter.
925
926 If multiple start or end options are set, this filter tries to be greedy and
927 keep all samples that match at least one of the specified constraints. To keep
928 only the part that matches all the constraints at once, chain multiple atrim
929 filters.
930
931 The defaults are such that all the input is kept. So it is possible to set e.g.
932 just the end values to keep everything before the specified time.
933
934 Examples:
935 @itemize
936 @item
937 drop everything except the second minute of input
938 @example
939 ffmpeg -i INPUT -af atrim=60:120
940 @end example
941
942 @item
943 keep only the first 1000 samples
944 @example
945 ffmpeg -i INPUT -af atrim=end_sample=1000
946 @end example
947
948 @end itemize
949
950 @section bandpass
951
952 Apply a two-pole Butterworth band-pass filter with central
953 frequency @var{frequency}, and (3dB-point) band-width width.
954 The @var{csg} option selects a constant skirt gain (peak gain = Q)
955 instead of the default: constant 0dB peak gain.
956 The filter roll off at 6dB per octave (20dB per decade).
957
958 The filter accepts the following options:
959
960 @table @option
961 @item frequency, f
962 Set the filter's central frequency. Default is @code{3000}.
963
964 @item csg
965 Constant skirt gain if set to 1. Defaults to 0.
966
967 @item width_type
968 Set method to specify band-width of filter.
969 @table @option
970 @item h
971 Hz
972 @item q
973 Q-Factor
974 @item o
975 octave
976 @item s
977 slope
978 @end table
979
980 @item width, w
981 Specify the band-width of a filter in width_type units.
982 @end table
983
984 @section bandreject
985
986 Apply a two-pole Butterworth band-reject filter with central
987 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
988 The filter roll off at 6dB per octave (20dB per decade).
989
990 The filter accepts the following options:
991
992 @table @option
993 @item frequency, f
994 Set the filter's central frequency. Default is @code{3000}.
995
996 @item width_type
997 Set method to specify band-width of filter.
998 @table @option
999 @item h
1000 Hz
1001 @item q
1002 Q-Factor
1003 @item o
1004 octave
1005 @item s
1006 slope
1007 @end table
1008
1009 @item width, w
1010 Specify the band-width of a filter in width_type units.
1011 @end table
1012
1013 @section bass
1014
1015 Boost or cut the bass (lower) frequencies of the audio using a two-pole
1016 shelving filter with a response similar to that of a standard
1017 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1018
1019 The filter accepts the following options:
1020
1021 @table @option
1022 @item gain, g
1023 Give the gain at 0 Hz. Its useful range is about -20
1024 (for a large cut) to +20 (for a large boost).
1025 Beware of clipping when using a positive gain.
1026
1027 @item frequency, f
1028 Set the filter's central frequency and so can be used
1029 to extend or reduce the frequency range to be boosted or cut.
1030 The default value is @code{100} Hz.
1031
1032 @item width_type
1033 Set method to specify band-width of filter.
1034 @table @option
1035 @item h
1036 Hz
1037 @item q
1038 Q-Factor
1039 @item o
1040 octave
1041 @item s
1042 slope
1043 @end table
1044
1045 @item width, w
1046 Determine how steep is the filter's shelf transition.
1047 @end table
1048
1049 @section biquad
1050
1051 Apply a biquad IIR filter with the given coefficients.
1052 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
1053 are the numerator and denominator coefficients respectively.
1054
1055 @section channelmap
1056
1057 Remap input channels to new locations.
1058
1059 This filter accepts the following named parameters:
1060 @table @option
1061 @item channel_layout
1062 Channel layout of the output stream.
1063
1064 @item map
1065 Map channels from input to output. The argument is a '|'-separated list of
1066 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1067 @var{in_channel} form. @var{in_channel} can be either the name of the input
1068 channel (e.g. FL for front left) or its index in the input channel layout.
1069 @var{out_channel} is the name of the output channel or its index in the output
1070 channel layout. If @var{out_channel} is not given then it is implicitly an
1071 index, starting with zero and increasing by one for each mapping.
1072 @end table
1073
1074 If no mapping is present, the filter will implicitly map input channels to
1075 output channels preserving index.
1076
1077 For example, assuming a 5.1+downmix input MOV file
1078 @example
1079 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
1080 @end example
1081 will create an output WAV file tagged as stereo from the downmix channels of
1082 the input.
1083
1084 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1085 @example
1086 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:channel_layout=5.1' out.wav
1087 @end example
1088
1089 @section channelsplit
1090
1091 Split each channel in input audio stream into a separate output stream.
1092
1093 This filter accepts the following named parameters:
1094 @table @option
1095 @item channel_layout
1096 Channel layout of the input stream. Default is "stereo".
1097 @end table
1098
1099 For example, assuming a stereo input MP3 file
1100 @example
1101 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1102 @end example
1103 will create an output Matroska file with two audio streams, one containing only
1104 the left channel and the other the right channel.
1105
1106 To split a 5.1 WAV file into per-channel files
1107 @example
1108 ffmpeg -i in.wav -filter_complex
1109 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1110 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1111 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1112 side_right.wav
1113 @end example
1114
1115 @section earwax
1116
1117 Make audio easier to listen to on headphones.
1118
1119 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
1120 so that when listened to on headphones the stereo image is moved from
1121 inside your head (standard for headphones) to outside and in front of
1122 the listener (standard for speakers).
1123
1124 Ported from SoX.
1125
1126 @section equalizer
1127
1128 Apply a two-pole peaking equalisation (EQ) filter. With this
1129 filter, the signal-level at and around a selected frequency can
1130 be increased or decreased, whilst (unlike bandpass and bandreject
1131 filters) that at all other frequencies is unchanged.
1132
1133 In order to produce complex equalisation curves, this filter can
1134 be given several times, each with a different central frequency.
1135
1136 The filter accepts the following options:
1137
1138 @table @option
1139 @item frequency, f
1140 Set the filter's central frequency in Hz.
1141
1142 @item width_type
1143 Set method to specify band-width of filter.
1144 @table @option
1145 @item h
1146 Hz
1147 @item q
1148 Q-Factor
1149 @item o
1150 octave
1151 @item s
1152 slope
1153 @end table
1154
1155 @item width, w
1156 Specify the band-width of a filter in width_type units.
1157
1158 @item gain, g
1159 Set the required gain or attenuation in dB.
1160 Beware of clipping when using a positive gain.
1161 @end table
1162
1163 @section highpass
1164
1165 Apply a high-pass filter with 3dB point frequency.
1166 The filter can be either single-pole, or double-pole (the default).
1167 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1168
1169 The filter accepts the following options:
1170
1171 @table @option
1172 @item frequency, f
1173 Set frequency in Hz. Default is 3000.
1174
1175 @item poles, p
1176 Set number of poles. Default is 2.
1177
1178 @item width_type
1179 Set method to specify band-width of filter.
1180 @table @option
1181 @item h
1182 Hz
1183 @item q
1184 Q-Factor
1185 @item o
1186 octave
1187 @item s
1188 slope
1189 @end table
1190
1191 @item width, w
1192 Specify the band-width of a filter in width_type units.
1193 Applies only to double-pole filter.
1194 The default is 0.707q and gives a Butterworth response.
1195 @end table
1196
1197 @section join
1198
1199 Join multiple input streams into one multi-channel stream.
1200
1201 The filter accepts the following named parameters:
1202 @table @option
1203
1204 @item inputs
1205 Number of input streams. Defaults to 2.
1206
1207 @item channel_layout
1208 Desired output channel layout. Defaults to stereo.
1209
1210 @item map
1211 Map channels from inputs to output. The argument is a '|'-separated list of
1212 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1213 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1214 can be either the name of the input channel (e.g. FL for front left) or its
1215 index in the specified input stream. @var{out_channel} is the name of the output
1216 channel.
1217 @end table
1218
1219 The filter will attempt to guess the mappings when those are not specified
1220 explicitly. It does so by first trying to find an unused matching input channel
1221 and if that fails it picks the first unused input channel.
1222
1223 E.g. to join 3 inputs (with properly set channel layouts)
1224 @example
1225 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1226 @end example
1227
1228 To build a 5.1 output from 6 single-channel streams:
1229 @example
1230 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1231 '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'
1232 out
1233 @end example
1234
1235 @section lowpass
1236
1237 Apply a low-pass filter with 3dB point frequency.
1238 The filter can be either single-pole or double-pole (the default).
1239 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1240
1241 The filter accepts the following options:
1242
1243 @table @option
1244 @item frequency, f
1245 Set frequency in Hz. Default is 500.
1246
1247 @item poles, p
1248 Set number of poles. Default is 2.
1249
1250 @item width_type
1251 Set method to specify band-width of filter.
1252 @table @option
1253 @item h
1254 Hz
1255 @item q
1256 Q-Factor
1257 @item o
1258 octave
1259 @item s
1260 slope
1261 @end table
1262
1263 @item width, w
1264 Specify the band-width of a filter in width_type units.
1265 Applies only to double-pole filter.
1266 The default is 0.707q and gives a Butterworth response.
1267 @end table
1268
1269 @section pan
1270
1271 Mix channels with specific gain levels. The filter accepts the output
1272 channel layout followed by a set of channels definitions.
1273
1274 This filter is also designed to remap efficiently the channels of an audio
1275 stream.
1276
1277 The filter accepts parameters of the form:
1278 "@var{l}:@var{outdef}:@var{outdef}:..."
1279
1280 @table @option
1281 @item l
1282 output channel layout or number of channels
1283
1284 @item outdef
1285 output channel specification, of the form:
1286 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
1287
1288 @item out_name
1289 output channel to define, either a channel name (FL, FR, etc.) or a channel
1290 number (c0, c1, etc.)
1291
1292 @item gain
1293 multiplicative coefficient for the channel, 1 leaving the volume unchanged
1294
1295 @item in_name
1296 input channel to use, see out_name for details; it is not possible to mix
1297 named and numbered input channels
1298 @end table
1299
1300 If the `=' in a channel specification is replaced by `<', then the gains for
1301 that specification will be renormalized so that the total is 1, thus
1302 avoiding clipping noise.
1303
1304 @subsection Mixing examples
1305
1306 For example, if you want to down-mix from stereo to mono, but with a bigger
1307 factor for the left channel:
1308 @example
1309 pan=1:c0=0.9*c0+0.1*c1
1310 @end example
1311
1312 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
1313 7-channels surround:
1314 @example
1315 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
1316 @end example
1317
1318 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
1319 that should be preferred (see "-ac" option) unless you have very specific
1320 needs.
1321
1322 @subsection Remapping examples
1323
1324 The channel remapping will be effective if, and only if:
1325
1326 @itemize
1327 @item gain coefficients are zeroes or ones,
1328 @item only one input per channel output,
1329 @end itemize
1330
1331 If all these conditions are satisfied, the filter will notify the user ("Pure
1332 channel mapping detected"), and use an optimized and lossless method to do the
1333 remapping.
1334
1335 For example, if you have a 5.1 source and want a stereo audio stream by
1336 dropping the extra channels:
1337 @example
1338 pan="stereo: c0=FL : c1=FR"
1339 @end example
1340
1341 Given the same source, you can also switch front left and front right channels
1342 and keep the input channel layout:
1343 @example
1344 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
1345 @end example
1346
1347 If the input is a stereo audio stream, you can mute the front left channel (and
1348 still keep the stereo channel layout) with:
1349 @example
1350 pan="stereo:c1=c1"
1351 @end example
1352
1353 Still with a stereo audio stream input, you can copy the right channel in both
1354 front left and right:
1355 @example
1356 pan="stereo: c0=FR : c1=FR"
1357 @end example
1358
1359 @section resample
1360
1361 Convert the audio sample format, sample rate and channel layout. This filter is
1362 not meant to be used directly.
1363
1364 @section silencedetect
1365
1366 Detect silence in an audio stream.
1367
1368 This filter logs a message when it detects that the input audio volume is less
1369 or equal to a noise tolerance value for a duration greater or equal to the
1370 minimum detected noise duration.
1371
1372 The printed times and duration are expressed in seconds.
1373
1374 The filter accepts the following options:
1375
1376 @table @option
1377 @item duration, d
1378 Set silence duration until notification (default is 2 seconds).
1379
1380 @item noise, n
1381 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
1382 specified value) or amplitude ratio. Default is -60dB, or 0.001.
1383 @end table
1384
1385 @subsection Examples
1386
1387 @itemize
1388 @item
1389 Detect 5 seconds of silence with -50dB noise tolerance:
1390 @example
1391 silencedetect=n=-50dB:d=5
1392 @end example
1393
1394 @item
1395 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
1396 tolerance in @file{silence.mp3}:
1397 @example
1398 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
1399 @end example
1400 @end itemize
1401
1402 @section treble
1403
1404 Boost or cut treble (upper) frequencies of the audio using a two-pole
1405 shelving filter with a response similar to that of a standard
1406 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1407
1408 The filter accepts the following options:
1409
1410 @table @option
1411 @item gain, g
1412 Give the gain at whichever is the lower of ~22 kHz and the
1413 Nyquist frequency. Its useful range is about -20 (for a large cut)
1414 to +20 (for a large boost). Beware of clipping when using a positive gain.
1415
1416 @item frequency, f
1417 Set the filter's central frequency and so can be used
1418 to extend or reduce the frequency range to be boosted or cut.
1419 The default value is @code{3000} Hz.
1420
1421 @item width_type
1422 Set method to specify band-width of filter.
1423 @table @option
1424 @item h
1425 Hz
1426 @item q
1427 Q-Factor
1428 @item o
1429 octave
1430 @item s
1431 slope
1432 @end table
1433
1434 @item width, w
1435 Determine how steep is the filter's shelf transition.
1436 @end table
1437
1438 @section volume
1439
1440 Adjust the input audio volume.
1441
1442 The filter accepts the following options:
1443
1444 @table @option
1445
1446 @item volume
1447 Expresses how the audio volume will be increased or decreased.
1448
1449 Output values are clipped to the maximum value.
1450
1451 The output audio volume is given by the relation:
1452 @example
1453 @var{output_volume} = @var{volume} * @var{input_volume}
1454 @end example
1455
1456 Default value for @var{volume} is 1.0.
1457
1458 @item precision
1459 Set the mathematical precision.
1460
1461 This determines which input sample formats will be allowed, which affects the
1462 precision of the volume scaling.
1463
1464 @table @option
1465 @item fixed
1466 8-bit fixed-point; limits input sample format to U8, S16, and S32.
1467 @item float
1468 32-bit floating-point; limits input sample format to FLT. (default)
1469 @item double
1470 64-bit floating-point; limits input sample format to DBL.
1471 @end table
1472 @end table
1473
1474 @subsection Examples
1475
1476 @itemize
1477 @item
1478 Halve the input audio volume:
1479 @example
1480 volume=volume=0.5
1481 volume=volume=1/2
1482 volume=volume=-6.0206dB
1483 @end example
1484
1485 In all the above example the named key for @option{volume} can be
1486 omitted, for example like in:
1487 @example
1488 volume=0.5
1489 @end example
1490
1491 @item
1492 Increase input audio power by 6 decibels using fixed-point precision:
1493 @example
1494 volume=volume=6dB:precision=fixed
1495 @end example
1496 @end itemize
1497
1498 @section volumedetect
1499
1500 Detect the volume of the input video.
1501
1502 The filter has no parameters. The input is not modified. Statistics about
1503 the volume will be printed in the log when the input stream end is reached.
1504
1505 In particular it will show the mean volume (root mean square), maximum
1506 volume (on a per-sample basis), and the beginning of an histogram of the
1507 registered volume values (from the maximum value to a cumulated 1/1000 of
1508 the samples).
1509
1510 All volumes are in decibels relative to the maximum PCM value.
1511
1512 @subsection Examples
1513
1514 Here is an excerpt of the output:
1515 @example
1516 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
1517 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
1518 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
1519 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
1520 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
1521 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
1522 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
1523 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
1524 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
1525 @end example
1526
1527 It means that:
1528 @itemize
1529 @item
1530 The mean square energy is approximately -27 dB, or 10^-2.7.
1531 @item
1532 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
1533 @item
1534 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
1535 @end itemize
1536
1537 In other words, raising the volume by +4 dB does not cause any clipping,
1538 raising it by +5 dB causes clipping for 6 samples, etc.
1539
1540 @c man end AUDIO FILTERS
1541
1542 @chapter Audio Sources
1543 @c man begin AUDIO SOURCES
1544
1545 Below is a description of the currently available audio sources.
1546
1547 @section abuffer
1548
1549 Buffer audio frames, and make them available to the filter chain.
1550
1551 This source is mainly intended for a programmatic use, in particular
1552 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
1553
1554 It accepts the following named parameters:
1555
1556 @table @option
1557
1558 @item time_base
1559 Timebase which will be used for timestamps of submitted frames. It must be
1560 either a floating-point number or in @var{numerator}/@var{denominator} form.
1561
1562 @item sample_rate
1563 The sample rate of the incoming audio buffers.
1564
1565 @item sample_fmt
1566 The sample format of the incoming audio buffers.
1567 Either a sample format name or its corresponging integer representation from
1568 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
1569
1570 @item channel_layout
1571 The channel layout of the incoming audio buffers.
1572 Either a channel layout name from channel_layout_map in
1573 @file{libavutil/channel_layout.c} or its corresponding integer representation
1574 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
1575
1576 @item channels
1577 The number of channels of the incoming audio buffers.
1578 If both @var{channels} and @var{channel_layout} are specified, then they
1579 must be consistent.
1580
1581 @end table
1582
1583 @subsection Examples
1584
1585 @example
1586 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
1587 @end example
1588
1589 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
1590 Since the sample format with name "s16p" corresponds to the number
1591 6 and the "stereo" channel layout corresponds to the value 0x3, this is
1592 equivalent to:
1593 @example
1594 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
1595 @end example
1596
1597 @section aevalsrc
1598
1599 Generate an audio signal specified by an expression.
1600
1601 This source accepts in input one or more expressions (one for each
1602 channel), which are evaluated and used to generate a corresponding
1603 audio signal.
1604
1605 This source accepts the following options:
1606
1607 @table @option
1608 @item exprs
1609 Set the '|'-separated expressions list for each separate channel. In case the
1610 @option{channel_layout} option is not specified, the selected channel layout
1611 depends on the number of provided expressions.
1612
1613 @item channel_layout, c
1614 Set the channel layout. The number of channels in the specified layout
1615 must be equal to the number of specified expressions.
1616
1617 @item duration, d
1618 Set the minimum duration of the sourced audio. See the function
1619 @code{av_parse_time()} for the accepted format.
1620 Note that the resulting duration may be greater than the specified
1621 duration, as the generated audio is always cut at the end of a
1622 complete frame.
1623
1624 If not specified, or the expressed duration is negative, the audio is
1625 supposed to be generated forever.
1626
1627 @item nb_samples, n
1628 Set the number of samples per channel per each output frame,
1629 default to 1024.
1630
1631 @item sample_rate, s
1632 Specify the sample rate, default to 44100.
1633 @end table
1634
1635 Each expression in @var{exprs} can contain the following constants:
1636
1637 @table @option
1638 @item n
1639 number of the evaluated sample, starting from 0
1640
1641 @item t
1642 time of the evaluated sample expressed in seconds, starting from 0
1643
1644 @item s
1645 sample rate
1646
1647 @end table
1648
1649 @subsection Examples
1650
1651 @itemize
1652 @item
1653 Generate silence:
1654 @example
1655 aevalsrc=0
1656 @end example
1657
1658 @item
1659 Generate a sin signal with frequency of 440 Hz, set sample rate to
1660 8000 Hz:
1661 @example
1662 aevalsrc="sin(440*2*PI*t):s=8000"
1663 @end example
1664
1665 @item
1666 Generate a two channels signal, specify the channel layout (Front
1667 Center + Back Center) explicitly:
1668 @example
1669 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
1670 @end example
1671
1672 @item
1673 Generate white noise:
1674 @example
1675 aevalsrc="-2+random(0)"
1676 @end example
1677
1678 @item
1679 Generate an amplitude modulated signal:
1680 @example
1681 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
1682 @end example
1683
1684 @item
1685 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
1686 @example
1687 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
1688 @end example
1689
1690 @end itemize
1691
1692 @section anullsrc
1693
1694 Null audio source, return unprocessed audio frames. It is mainly useful
1695 as a template and to be employed in analysis / debugging tools, or as
1696 the source for filters which ignore the input data (for example the sox
1697 synth filter).
1698
1699 This source accepts the following options:
1700
1701 @table @option
1702
1703 @item channel_layout, cl
1704
1705 Specify the channel layout, and can be either an integer or a string
1706 representing a channel layout. The default value of @var{channel_layout}
1707 is "stereo".
1708
1709 Check the channel_layout_map definition in
1710 @file{libavutil/channel_layout.c} for the mapping between strings and
1711 channel layout values.
1712
1713 @item sample_rate, r
1714 Specify the sample rate, and defaults to 44100.
1715
1716 @item nb_samples, n
1717 Set the number of samples per requested frames.
1718
1719 @end table
1720
1721 @subsection Examples
1722
1723 @itemize
1724 @item
1725 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
1726 @example
1727 anullsrc=r=48000:cl=4
1728 @end example
1729
1730 @item
1731 Do the same operation with a more obvious syntax:
1732 @example
1733 anullsrc=r=48000:cl=mono
1734 @end example
1735 @end itemize
1736
1737 All the parameters need to be explicitly defined.
1738
1739 @section flite
1740
1741 Synthesize a voice utterance using the libflite library.
1742
1743 To enable compilation of this filter you need to configure FFmpeg with
1744 @code{--enable-libflite}.
1745
1746 Note that the flite library is not thread-safe.
1747
1748 The filter accepts the following options:
1749
1750 @table @option
1751
1752 @item list_voices
1753 If set to 1, list the names of the available voices and exit
1754 immediately. Default value is 0.
1755
1756 @item nb_samples, n
1757 Set the maximum number of samples per frame. Default value is 512.
1758
1759 @item textfile
1760 Set the filename containing the text to speak.
1761
1762 @item text
1763 Set the text to speak.
1764
1765 @item voice, v
1766 Set the voice to use for the speech synthesis. Default value is
1767 @code{kal}. See also the @var{list_voices} option.
1768 @end table
1769
1770 @subsection Examples
1771
1772 @itemize
1773 @item
1774 Read from file @file{speech.txt}, and synthetize the text using the
1775 standard flite voice:
1776 @example
1777 flite=textfile=speech.txt
1778 @end example
1779
1780 @item
1781 Read the specified text selecting the @code{slt} voice:
1782 @example
1783 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1784 @end example
1785
1786 @item
1787 Input text to ffmpeg:
1788 @example
1789 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1790 @end example
1791
1792 @item
1793 Make @file{ffplay} speak the specified text, using @code{flite} and
1794 the @code{lavfi} device:
1795 @example
1796 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
1797 @end example
1798 @end itemize
1799
1800 For more information about libflite, check:
1801 @url{http://www.speech.cs.cmu.edu/flite/}
1802
1803 @section sine
1804
1805 Generate an audio signal made of a sine wave with amplitude 1/8.
1806
1807 The audio signal is bit-exact.
1808
1809 The filter accepts the following options:
1810
1811 @table @option
1812
1813 @item frequency, f
1814 Set the carrier frequency. Default is 440 Hz.
1815
1816 @item beep_factor, b
1817 Enable a periodic beep every second with frequency @var{beep_factor} times
1818 the carrier frequency. Default is 0, meaning the beep is disabled.
1819
1820 @item sample_rate, s
1821 Specify the sample rate, default is 44100.
1822
1823 @item duration, d
1824 Specify the duration of the generated audio stream.
1825
1826 @item samples_per_frame
1827 Set the number of samples per output frame, default is 1024.
1828 @end table
1829
1830 @subsection Examples
1831
1832 @itemize
1833
1834 @item
1835 Generate a simple 440 Hz sine wave:
1836 @example
1837 sine
1838 @end example
1839
1840 @item
1841 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
1842 @example
1843 sine=220:4:d=5
1844 sine=f=220:b=4:d=5
1845 sine=frequency=220:beep_factor=4:duration=5
1846 @end example
1847
1848 @end itemize
1849
1850 @c man end AUDIO SOURCES
1851
1852 @chapter Audio Sinks
1853 @c man begin AUDIO SINKS
1854
1855 Below is a description of the currently available audio sinks.
1856
1857 @section abuffersink
1858
1859 Buffer audio frames, and make them available to the end of filter chain.
1860
1861 This sink is mainly intended for programmatic use, in particular
1862 through the interface defined in @file{libavfilter/buffersink.h}
1863 or the options system.
1864
1865 It accepts a pointer to an AVABufferSinkContext structure, which
1866 defines the incoming buffers' formats, to be passed as the opaque
1867 parameter to @code{avfilter_init_filter} for initialization.
1868
1869 @section anullsink
1870
1871 Null audio sink, do absolutely nothing with the input audio. It is
1872 mainly useful as a template and to be employed in analysis / debugging
1873 tools.
1874
1875 @c man end AUDIO SINKS
1876
1877 @chapter Video Filters
1878 @c man begin VIDEO FILTERS
1879
1880 When you configure your FFmpeg build, you can disable any of the
1881 existing filters using @code{--disable-filters}.
1882 The configure output will show the video filters included in your
1883 build.
1884
1885 Below is a description of the currently available video filters.
1886
1887 @section alphaextract
1888
1889 Extract the alpha component from the input as a grayscale video. This
1890 is especially useful with the @var{alphamerge} filter.
1891
1892 @section alphamerge
1893
1894 Add or replace the alpha component of the primary input with the
1895 grayscale value of a second input. This is intended for use with
1896 @var{alphaextract} to allow the transmission or storage of frame
1897 sequences that have alpha in a format that doesn't support an alpha
1898 channel.
1899
1900 For example, to reconstruct full frames from a normal YUV-encoded video
1901 and a separate video created with @var{alphaextract}, you might use:
1902 @example
1903 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
1904 @end example
1905
1906 Since this filter is designed for reconstruction, it operates on frame
1907 sequences without considering timestamps, and terminates when either
1908 input reaches end of stream. This will cause problems if your encoding
1909 pipeline drops frames. If you're trying to apply an image as an
1910 overlay to a video stream, consider the @var{overlay} filter instead.
1911
1912 @section ass
1913
1914 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
1915 and libavformat to work. On the other hand, it is limited to ASS (Advanced
1916 Substation Alpha) subtitles files.
1917
1918 @section bbox
1919
1920 Compute the bounding box for the non-black pixels in the input frame
1921 luminance plane.
1922
1923 This filter computes the bounding box containing all the pixels with a
1924 luminance value greater than the minimum allowed value.
1925 The parameters describing the bounding box are printed on the filter
1926 log.
1927
1928 The filter accepts the following option:
1929
1930 @table @option
1931 @item min_val
1932 Set the minimal luminance value. Default is @code{16}.
1933 @end table
1934
1935 @section blackdetect
1936
1937 Detect video intervals that are (almost) completely black. Can be
1938 useful to detect chapter transitions, commercials, or invalid
1939 recordings. Output lines contains the time for the start, end and
1940 duration of the detected black interval expressed in seconds.
1941
1942 In order to display the output lines, you need to set the loglevel at
1943 least to the AV_LOG_INFO value.
1944
1945 The filter accepts the following options:
1946
1947 @table @option
1948 @item black_min_duration, d
1949 Set the minimum detected black duration expressed in seconds. It must
1950 be a non-negative floating point number.
1951
1952 Default value is 2.0.
1953
1954 @item picture_black_ratio_th, pic_th
1955 Set the threshold for considering a picture "black".
1956 Express the minimum value for the ratio:
1957 @example
1958 @var{nb_black_pixels} / @var{nb_pixels}
1959 @end example
1960
1961 for which a picture is considered black.
1962 Default value is 0.98.
1963
1964 @item pixel_black_th, pix_th
1965 Set the threshold for considering a pixel "black".
1966
1967 The threshold expresses the maximum pixel luminance value for which a
1968 pixel is considered "black". The provided value is scaled according to
1969 the following equation:
1970 @example
1971 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1972 @end example
1973
1974 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1975 the input video format, the range is [0-255] for YUV full-range
1976 formats and [16-235] for YUV non full-range formats.
1977
1978 Default value is 0.10.
1979 @end table
1980
1981 The following example sets the maximum pixel threshold to the minimum
1982 value, and detects only black intervals of 2 or more seconds:
1983 @example
1984 blackdetect=d=2:pix_th=0.00
1985 @end example
1986
1987 @section blackframe
1988
1989 Detect frames that are (almost) completely black. Can be useful to
1990 detect chapter transitions or commercials. Output lines consist of
1991 the frame number of the detected frame, the percentage of blackness,
1992 the position in the file if known or -1 and the timestamp in seconds.
1993
1994 In order to display the output lines, you need to set the loglevel at
1995 least to the AV_LOG_INFO value.
1996
1997 The filter accepts the following options:
1998
1999 @table @option
2000
2001 @item amount
2002 Set the percentage of the pixels that have to be below the threshold, defaults
2003 to @code{98}.
2004
2005 @item threshold, thresh
2006 Set the threshold below which a pixel value is considered black, defaults to
2007 @code{32}.
2008
2009 @end table
2010
2011 @section blend
2012
2013 Blend two video frames into each other.
2014
2015 It takes two input streams and outputs one stream, the first input is the
2016 "top" layer and second input is "bottom" layer.
2017 Output terminates when shortest input terminates.
2018
2019 A description of the accepted options follows.
2020
2021 @table @option
2022 @item c0_mode
2023 @item c1_mode
2024 @item c2_mode
2025 @item c3_mode
2026 @item all_mode
2027 Set blend mode for specific pixel component or all pixel components in case
2028 of @var{all_mode}. Default value is @code{normal}.
2029
2030 Available values for component modes are:
2031 @table @samp
2032 @item addition
2033 @item and
2034 @item average
2035 @item burn
2036 @item darken
2037 @item difference
2038 @item divide
2039 @item dodge
2040 @item exclusion
2041 @item hardlight
2042 @item lighten
2043 @item multiply
2044 @item negation
2045 @item normal
2046 @item or
2047 @item overlay
2048 @item phoenix
2049 @item pinlight
2050 @item reflect
2051 @item screen
2052 @item softlight
2053 @item subtract
2054 @item vividlight
2055 @item xor
2056 @end table
2057
2058 @item c0_opacity
2059 @item c1_opacity
2060 @item c2_opacity
2061 @item c3_opacity
2062 @item all_opacity
2063 Set blend opacity for specific pixel component or all pixel components in case
2064 of @var{all_opacity}. Only used in combination with pixel component blend modes.
2065
2066 @item c0_expr
2067 @item c1_expr
2068 @item c2_expr
2069 @item c3_expr
2070 @item all_expr
2071 Set blend expression for specific pixel component or all pixel components in case
2072 of @var{all_expr}. Note that related mode options will be ignored if those are set.
2073
2074 The expressions can use the following variables:
2075
2076 @table @option
2077 @item N
2078 The sequential number of the filtered frame, starting from @code{0}.
2079
2080 @item X
2081 @item Y
2082 the coordinates of the current sample
2083
2084 @item W
2085 @item H
2086 the width and height of currently filtered plane
2087
2088 @item SW
2089 @item SH
2090 Width and height scale depending on the currently filtered plane. It is the
2091 ratio between the corresponding luma plane number of pixels and the current
2092 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
2093 @code{0.5,0.5} for chroma planes.
2094
2095 @item T
2096 Time of the current frame, expressed in seconds.
2097
2098 @item TOP, A
2099 Value of pixel component at current location for first video frame (top layer).
2100
2101 @item BOTTOM, B
2102 Value of pixel component at current location for second video frame (bottom layer).
2103 @end table
2104
2105 @item shortest
2106 Force termination when the shortest input terminates. Default is @code{0}.
2107 @item repeatlast
2108 Continue applying the last bottom frame after the end of the stream. A value of
2109 @code{0} disable the filter after the last frame of the bottom layer is reached.
2110 Default is @code{1}.
2111 @end table
2112
2113 @subsection Examples
2114
2115 @itemize
2116 @item
2117 Apply transition from bottom layer to top layer in first 10 seconds:
2118 @example
2119 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
2120 @end example
2121
2122 @item
2123 Apply 1x1 checkerboard effect:
2124 @example
2125 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
2126 @end example
2127 @end itemize
2128
2129 @section boxblur
2130
2131 Apply boxblur algorithm to the input video.
2132
2133 The filter accepts the following options:
2134
2135 @table @option
2136
2137 @item luma_radius, lr
2138 @item luma_power, lp
2139 @item chroma_radius, cr
2140 @item chroma_power, cp
2141 @item alpha_radius, ar
2142 @item alpha_power, ap
2143
2144 @end table
2145
2146 A description of the accepted options follows.
2147
2148 @table @option
2149 @item luma_radius, lr
2150 @item chroma_radius, cr
2151 @item alpha_radius, ar
2152 Set an expression for the box radius in pixels used for blurring the
2153 corresponding input plane.
2154
2155 The radius value must be a non-negative number, and must not be
2156 greater than the value of the expression @code{min(w,h)/2} for the
2157 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
2158 planes.
2159
2160 Default value for @option{luma_radius} is "2". If not specified,
2161 @option{chroma_radius} and @option{alpha_radius} default to the
2162 corresponding value set for @option{luma_radius}.
2163
2164 The expressions can contain the following constants:
2165 @table @option
2166 @item w
2167 @item h
2168 the input width and height in pixels
2169
2170 @item cw
2171 @item ch
2172 the input chroma image width and height in pixels
2173
2174 @item hsub
2175 @item vsub
2176 horizontal and vertical chroma subsample values. For example for the
2177 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2178 @end table
2179
2180 @item luma_power, lp
2181 @item chroma_power, cp
2182 @item alpha_power, ap
2183 Specify how many times the boxblur filter is applied to the
2184 corresponding plane.
2185
2186 Default value for @option{luma_power} is 2. If not specified,
2187 @option{chroma_power} and @option{alpha_power} default to the
2188 corresponding value set for @option{luma_power}.
2189
2190 A value of 0 will disable the effect.
2191 @end table
2192
2193 @subsection Examples
2194
2195 @itemize
2196 @item
2197 Apply a boxblur filter with luma, chroma, and alpha radius
2198 set to 2:
2199 @example
2200 boxblur=luma_radius=2:luma_power=1
2201 boxblur=2:1
2202 @end example
2203
2204 @item
2205 Set luma radius to 2, alpha and chroma radius to 0:
2206 @example
2207 boxblur=2:1:cr=0:ar=0
2208 @end example
2209
2210 @item
2211 Set luma and chroma radius to a fraction of the video dimension:
2212 @example
2213 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
2214 @end example
2215 @end itemize
2216
2217 @section colorbalance
2218 Modify intensity of primary colors (red, green and blue) of input frames.
2219
2220 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
2221 regions for the red-cyan, green-magenta or blue-yellow balance.
2222
2223 A positive adjustment value shifts the balance towards the primary color, a negative
2224 value towards the complementary color.
2225
2226 The filter accepts the following options:
2227
2228 @table @option
2229 @item rs
2230 @item gs
2231 @item bs
2232 Adjust red, green and blue shadows (darkest pixels).
2233
2234 @item rm
2235 @item gm
2236 @item bm
2237 Adjust red, green and blue midtones (medium pixels).
2238
2239 @item rh
2240 @item gh
2241 @item bh
2242 Adjust red, green and blue highlights (brightest pixels).
2243
2244 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
2245 @end table
2246
2247 @subsection Examples
2248
2249 @itemize
2250 @item
2251 Add red color cast to shadows:
2252 @example
2253 colorbalance=rs=.3
2254 @end example
2255 @end itemize
2256
2257 @section colorchannelmixer
2258
2259 Adjust video input frames by re-mixing color channels.
2260
2261 This filter modifies a color channel by adding the values associated to
2262 the other channels of the same pixels. For example if the value to
2263 modify is red, the output value will be:
2264 @example
2265 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
2266 @end example
2267
2268 The filter accepts the following options:
2269
2270 @table @option
2271 @item rr
2272 @item rg
2273 @item rb
2274 @item ra
2275 Adjust contribution of input red, green, blue and alpha channels for output red channel.
2276 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
2277
2278 @item gr
2279 @item gg
2280 @item gb
2281 @item ga
2282 Adjust contribution of input red, green, blue and alpha channels for output green channel.
2283 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
2284
2285 @item br
2286 @item bg
2287 @item bb
2288 @item ba
2289 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
2290 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
2291
2292 @item ar
2293 @item ag
2294 @item ab
2295 @item aa
2296 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
2297 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
2298
2299 Allowed ranges for options are @code{[-2.0, 2.0]}.
2300 @end table
2301
2302 @subsection Examples
2303
2304 @itemize
2305 @item
2306 Convert source to grayscale:
2307 @example
2308 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
2309 @end example
2310 @end itemize
2311
2312 @section colormatrix
2313
2314 Convert color matrix.
2315
2316 The filter accepts the following options:
2317
2318 @table @option
2319 @item src
2320 @item dst
2321 Specify the source and destination color matrix. Both values must be
2322 specified.
2323
2324 The accepted values are:
2325 @table @samp
2326 @item bt709
2327 BT.709
2328
2329 @item bt601
2330 BT.601
2331
2332 @item smpte240m
2333 SMPTE-240M
2334
2335 @item fcc
2336 FCC
2337 @end table
2338 @end table
2339
2340 For example to convert from BT.601 to SMPTE-240M, use the command:
2341 @example
2342 colormatrix=bt601:smpte240m
2343 @end example
2344
2345 @section copy
2346
2347 Copy the input source unchanged to the output. Mainly useful for
2348 testing purposes.
2349
2350 @section crop
2351
2352 Crop the input video to given dimensions.
2353
2354 The filter accepts the following options:
2355
2356 @table @option
2357 @item w, out_w
2358 Width of the output video. It defaults to @code{iw}.
2359 This expression is evaluated only once during the filter
2360 configuration.
2361
2362 @item h, out_h
2363 Height of the output video. It defaults to @code{ih}.
2364 This expression is evaluated only once during the filter
2365 configuration.
2366
2367 @item x
2368 Horizontal position, in the input video, of the left edge of the output video.
2369 It defaults to @code{(in_w-out_w)/2}.
2370 This expression is evaluated per-frame.
2371
2372 @item y
2373 Vertical position, in the input video, of the top edge of the output video.
2374 It defaults to @code{(in_h-out_h)/2}.
2375 This expression is evaluated per-frame.
2376
2377 @item keep_aspect
2378 If set to 1 will force the output display aspect ratio
2379 to be the same of the input, by changing the output sample aspect
2380 ratio. It defaults to 0.
2381 @end table
2382
2383 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
2384 expressions containing the following constants:
2385
2386 @table @option
2387 @item x
2388 @item y
2389 the computed values for @var{x} and @var{y}. They are evaluated for
2390 each new frame.
2391
2392 @item in_w
2393 @item in_h
2394 the input width and height
2395
2396 @item iw
2397 @item ih
2398 same as @var{in_w} and @var{in_h}
2399
2400 @item out_w
2401 @item out_h
2402 the output (cropped) width and height
2403
2404 @item ow
2405 @item oh
2406 same as @var{out_w} and @var{out_h}
2407
2408 @item a
2409 same as @var{iw} / @var{ih}
2410
2411 @item sar
2412 input sample aspect ratio
2413
2414 @item dar
2415 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2416
2417 @item hsub
2418 @item vsub
2419 horizontal and vertical chroma subsample values. For example for the
2420 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2421
2422 @item n
2423 the number of input frame, starting from 0
2424
2425 @item pos
2426 the position in the file of the input frame, NAN if unknown
2427
2428 @item t
2429 timestamp expressed in seconds, NAN if the input timestamp is unknown
2430
2431 @end table
2432
2433 The expression for @var{out_w} may depend on the value of @var{out_h},
2434 and the expression for @var{out_h} may depend on @var{out_w}, but they
2435 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
2436 evaluated after @var{out_w} and @var{out_h}.
2437
2438 The @var{x} and @var{y} parameters specify the expressions for the
2439 position of the top-left corner of the output (non-cropped) area. They
2440 are evaluated for each frame. If the evaluated value is not valid, it
2441 is approximated to the nearest valid value.
2442
2443 The expression for @var{x} may depend on @var{y}, and the expression
2444 for @var{y} may depend on @var{x}.
2445
2446 @subsection Examples
2447
2448 @itemize
2449 @item
2450 Crop area with size 100x100 at position (12,34).
2451 @example
2452 crop=100:100:12:34
2453 @end example
2454
2455 Using named options, the example above becomes:
2456 @example
2457 crop=w=100:h=100:x=12:y=34
2458 @end example
2459
2460 @item
2461 Crop the central input area with size 100x100:
2462 @example
2463 crop=100:100
2464 @end example
2465
2466 @item
2467 Crop the central input area with size 2/3 of the input video:
2468 @example
2469 crop=2/3*in_w:2/3*in_h
2470 @end example
2471
2472 @item
2473 Crop the input video central square:
2474 @example
2475 crop=out_w=in_h
2476 crop=in_h
2477 @end example
2478
2479 @item
2480 Delimit the rectangle with the top-left corner placed at position
2481 100:100 and the right-bottom corner corresponding to the right-bottom
2482 corner of the input image:
2483 @example
2484 crop=in_w-100:in_h-100:100:100
2485 @end example
2486
2487 @item
2488 Crop 10 pixels from the left and right borders, and 20 pixels from
2489 the top and bottom borders
2490 @example
2491 crop=in_w-2*10:in_h-2*20
2492 @end example
2493
2494 @item
2495 Keep only the bottom right quarter of the input image:
2496 @example
2497 crop=in_w/2:in_h/2:in_w/2:in_h/2
2498 @end example
2499
2500 @item
2501 Crop height for getting Greek harmony:
2502 @example
2503 crop=in_w:1/PHI*in_w
2504 @end example
2505
2506 @item
2507 Appply trembling effect:
2508 @example
2509 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)
2510 @end example
2511
2512 @item
2513 Apply erratic camera effect depending on timestamp:
2514 @example
2515 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)"
2516 @end example
2517
2518 @item
2519 Set x depending on the value of y:
2520 @example
2521 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
2522 @end example
2523 @end itemize
2524
2525 @section cropdetect
2526
2527 Auto-detect crop size.
2528
2529 Calculate necessary cropping parameters and prints the recommended
2530 parameters through the logging system. The detected dimensions
2531 correspond to the non-black area of the input video.
2532
2533 The filter accepts the following options:
2534
2535 @table @option
2536
2537 @item limit
2538 Set higher black value threshold, which can be optionally specified
2539 from nothing (0) to everything (255). An intensity value greater
2540 to the set value is considered non-black. Default value is 24.
2541
2542 @item round
2543 Set the value for which the width/height should be divisible by. The
2544 offset is automatically adjusted to center the video. Use 2 to get
2545 only even dimensions (needed for 4:2:2 video). 16 is best when
2546 encoding to most video codecs. Default value is 16.
2547
2548 @item reset_count, reset
2549 Set the counter that determines after how many frames cropdetect will
2550 reset the previously detected largest video area and start over to
2551 detect the current optimal crop area. Default value is 0.
2552
2553 This can be useful when channel logos distort the video area. 0
2554 indicates never reset and return the largest area encountered during
2555 playback.
2556 @end table
2557
2558 @anchor{curves}
2559 @section curves
2560
2561 Apply color adjustments using curves.
2562
2563 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
2564 component (red, green and blue) has its values defined by @var{N} key points
2565 tied from each other using a smooth curve. The x-axis represents the pixel
2566 values from the input frame, and the y-axis the new pixel values to be set for
2567 the output frame.
2568
2569 By default, a component curve is defined by the two points @var{(0;0)} and
2570 @var{(1;1)}. This creates a straight line where each original pixel value is
2571 "adjusted" to its own value, which means no change to the image.
2572
2573 The filter allows you to redefine these two points and add some more. A new
2574 curve (using a natural cubic spline interpolation) will be define to pass
2575 smoothly through all these new coordinates. The new defined points needs to be
2576 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
2577 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
2578 the vector spaces, the values will be clipped accordingly.
2579
2580 If there is no key point defined in @code{x=0}, the filter will automatically
2581 insert a @var{(0;0)} point. In the same way, if there is no key point defined
2582 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
2583
2584 The filter accepts the following options:
2585
2586 @table @option
2587 @item preset
2588 Select one of the available color presets. This option can be used in addition
2589 to the @option{r}, @option{g}, @option{b} parameters; in this case, the later
2590 options takes priority on the preset values.
2591 Available presets are:
2592 @table @samp
2593 @item none
2594 @item color_negative
2595 @item cross_process
2596 @item darker
2597 @item increase_contrast
2598 @item lighter
2599 @item linear_contrast
2600 @item medium_contrast
2601 @item negative
2602 @item strong_contrast
2603 @item vintage
2604 @end table
2605 Default is @code{none}.
2606 @item master, m
2607 Set the master key points. These points will define a second pass mapping. It
2608 is sometimes called a "luminance" or "value" mapping. It can be used with
2609 @option{r}, @option{g}, @option{b} or @option{all} since it acts like a
2610 post-processing LUT.
2611 @item red, r
2612 Set the key points for the red component.
2613 @item green, g
2614 Set the key points for the green component.
2615 @item blue, b
2616 Set the key points for the blue component.
2617 @item all
2618 Set the key points for all components (not including master).
2619 Can be used in addition to the other key points component
2620 options. In this case, the unset component(s) will fallback on this
2621 @option{all} setting.
2622 @item psfile
2623 Specify a Photoshop curves file (@code{.asv}) to import the settings from.
2624 @end table
2625
2626 To avoid some filtergraph syntax conflicts, each key points list need to be
2627 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
2628
2629 @subsection Examples
2630
2631 @itemize
2632 @item
2633 Increase slightly the middle level of blue:
2634 @example
2635 curves=blue='0.5/0.58'
2636 @end example
2637
2638 @item
2639 Vintage effect:
2640 @example
2641 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
2642 @end example
2643 Here we obtain the following coordinates for each components:
2644 @table @var
2645 @item red
2646 @code{(0;0.11) (0.42;0.51) (1;0.95)}
2647 @item green
2648 @code{(0;0) (0.50;0.48) (1;1)}
2649 @item blue
2650 @code{(0;0.22) (0.49;0.44) (1;0.80)}
2651 @end table
2652
2653 @item
2654 The previous example can also be achieved with the associated built-in preset:
2655 @example
2656 curves=preset=vintage
2657 @end example
2658
2659 @item
2660 Or simply:
2661 @example
2662 curves=vintage
2663 @end example
2664
2665 @item
2666 Use a Photoshop preset and redefine the points of the green component:
2667 @example
2668 curves=psfile='MyCurvesPresets/purple.asv':green='0.45/0.53'
2669 @end example
2670 @end itemize
2671
2672 @section dctdnoiz
2673
2674 Denoise frames using 2D DCT (frequency domain filtering).
2675
2676 This filter is not designed for real time and can be extremely slow.
2677
2678 The filter accepts the following options:
2679
2680 @table @option
2681 @item sigma, s
2682 Set the noise sigma constant.
2683
2684 This @var{sigma} defines a hard threshold of @code{3 * sigma}; every DCT
2685 coefficient (absolute value) below this threshold with be dropped.
2686
2687 If you need a more advanced filtering, see @option{expr}.
2688
2689 Default is @code{0}.
2690
2691 @item overlap
2692 Set number overlapping pixels for each block. Each block is of size
2693 @code{16x16}. Since the filter can be slow, you may want to reduce this value,
2694 at the cost of a less effective filter and the risk of various artefacts.
2695
2696 If the overlapping value doesn't allow to process the whole input width or
2697 height, a warning will be displayed and according borders won't be denoised.
2698
2699 Default value is @code{15}.
2700
2701 @item expr, e
2702 Set the coefficient factor expression.
2703
2704 For each coefficient of a DCT block, this expression will be evaluated as a
2705 multiplier value for the coefficient.
2706
2707 If this is option is set, the @option{sigma} option will be ignored.
2708
2709 The absolute value of the coefficient can be accessed through the @var{c}
2710 variable.
2711 @end table
2712
2713 @subsection Examples
2714
2715 Apply a denoise with a @option{sigma} of @code{4.5}:
2716 @example
2717 dctdnoiz=4.5
2718 @end example
2719
2720 The same operation can be achieved using the expression system:
2721 @example
2722 dctdnoiz=e='gte(c, 4.5*3)'
2723 @end example
2724
2725 @anchor{decimate}
2726 @section decimate
2727
2728 Drop duplicated frames at regular intervals.
2729
2730 The filter accepts the following options:
2731
2732 @table @option
2733 @item cycle
2734 Set the number of frames from which one will be dropped. Setting this to
2735 @var{N} means one frame in every batch of @var{N} frames will be dropped.
2736 Default is @code{5}.
2737
2738 @item dupthresh
2739 Set the threshold for duplicate detection. If the difference metric for a frame
2740 is less than or equal to this value, then it is declared as duplicate. Default
2741 is @code{1.1}
2742
2743 @item scthresh
2744 Set scene change threshold. Default is @code{15}.
2745
2746 @item blockx
2747 @item blocky
2748 Set the size of the x and y-axis blocks used during metric calculations.
2749 Larger blocks give better noise suppression, but also give worse detection of
2750 small movements. Must be a power of two. Default is @code{32}.
2751
2752 @item ppsrc
2753 Mark main input as a pre-processed input and activate clean source input
2754 stream. This allows the input to be pre-processed with various filters to help
2755 the metrics calculation while keeping the frame selection lossless. When set to
2756 @code{1}, the first stream is for the pre-processed input, and the second
2757 stream is the clean source from where the kept frames are chosen. Default is
2758 @code{0}.
2759
2760 @item chroma
2761 Set whether or not chroma is considered in the metric calculations. Default is
2762 @code{1}.
2763 @end table
2764
2765 @section delogo
2766
2767 Suppress a TV station logo by a simple interpolation of the surrounding
2768 pixels. Just set a rectangle covering the logo and watch it disappear
2769 (and sometimes something even uglier appear - your mileage may vary).
2770
2771 This filter accepts the following options:
2772 @table @option
2773
2774 @item x
2775 @item y
2776 Specify the top left corner coordinates of the logo. They must be
2777 specified.
2778
2779 @item w
2780 @item h
2781 Specify the width and height of the logo to clear. They must be
2782 specified.
2783
2784 @item band, t
2785 Specify the thickness of the fuzzy edge of the rectangle (added to
2786 @var{w} and @var{h}). The default value is 4.
2787
2788 @item show
2789 When set to 1, a green rectangle is drawn on the screen to simplify
2790 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.
2791 The default value is 0.
2792
2793 @end table
2794
2795 @subsection Examples
2796
2797 @itemize
2798 @item
2799 Set a rectangle covering the area with top left corner coordinates 0,0
2800 and size 100x77, setting a band of size 10:
2801 @example
2802 delogo=x=0:y=0:w=100:h=77:band=10
2803 @end example
2804
2805 @end itemize
2806
2807 @section deshake
2808
2809 Attempt to fix small changes in horizontal and/or vertical shift. This
2810 filter helps remove camera shake from hand-holding a camera, bumping a
2811 tripod, moving on a vehicle, etc.
2812
2813 The filter accepts the following options:
2814
2815 @table @option
2816
2817 @item x
2818 @item y
2819 @item w
2820 @item h
2821 Specify a rectangular area where to limit the search for motion
2822 vectors.
2823 If desired the search for motion vectors can be limited to a
2824 rectangular area of the frame defined by its top left corner, width
2825 and height. These parameters have the same meaning as the drawbox
2826 filter which can be used to visualise the position of the bounding
2827 box.
2828
2829 This is useful when simultaneous movement of subjects within the frame
2830 might be confused for camera motion by the motion vector search.
2831
2832 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
2833 then the full frame is used. This allows later options to be set
2834 without specifying the bounding box for the motion vector search.
2835
2836 Default - search the whole frame.
2837
2838 @item rx
2839 @item ry
2840 Specify the maximum extent of movement in x and y directions in the
2841 range 0-64 pixels. Default 16.
2842
2843 @item edge
2844 Specify how to generate pixels to fill blanks at the edge of the
2845 frame. Available values are:
2846 @table @samp
2847 @item blank, 0
2848 Fill zeroes at blank locations
2849 @item original, 1
2850 Original image at blank locations
2851 @item clamp, 2
2852 Extruded edge value at blank locations
2853 @item mirror, 3
2854 Mirrored edge at blank locations
2855 @end table
2856 Default value is @samp{mirror}.
2857
2858 @item blocksize
2859 Specify the blocksize to use for motion search. Range 4-128 pixels,
2860 default 8.
2861
2862 @item contrast
2863 Specify the contrast threshold for blocks. Only blocks with more than
2864 the specified contrast (difference between darkest and lightest
2865 pixels) will be considered. Range 1-255, default 125.
2866
2867 @item search
2868 Specify the search strategy. Available values are:
2869 @table @samp
2870 @item exhaustive, 0
2871 Set exhaustive search
2872 @item less, 1
2873 Set less exhaustive search.
2874 @end table
2875 Default value is @samp{exhaustive}.
2876
2877 @item filename
2878 If set then a detailed log of the motion search is written to the
2879 specified file.
2880
2881 @item opencl
2882 If set to 1, specify using OpenCL capabilities, only available if
2883 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
2884
2885 @end table
2886
2887 @section drawbox
2888
2889 Draw a colored box on the input image.
2890
2891 This filter accepts the following options:
2892
2893 @table @option
2894 @item x
2895 @item y
2896 The expressions which specify the top left corner coordinates of the box. Default to 0.
2897
2898 @item width, w
2899 @item height, h
2900 The expressions which specify the width and height of the box, if 0 they are interpreted as
2901 the input width and height. Default to 0.
2902
2903 @item color, c
2904 Specify the color of the box to write, it can be the name of a color
2905 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
2906 value @code{invert} is used, the box edge color is the same as the
2907 video with inverted luma.
2908
2909 @item thickness, t
2910 The expression which sets the thickness of the box edge. Default value is @code{3}.
2911
2912 See below for the list of accepted constants.
2913 @end table
2914
2915 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
2916 following constants:
2917
2918 @table @option
2919 @item dar
2920 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
2921
2922 @item hsub
2923 @item vsub
2924 horizontal and vertical chroma subsample values. For example for the
2925 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2926
2927 @item in_h, ih
2928 @item in_w, iw
2929 The input width and height.
2930
2931 @item sar
2932 The input sample aspect ratio.
2933
2934 @item x
2935 @item y
2936 The x and y offset coordinates where the box is drawn.
2937
2938 @item w
2939 @item h
2940 The width and height of the drawn box.
2941
2942 @item t
2943 The thickness of the drawn box.
2944
2945 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
2946 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
2947
2948 @end table
2949
2950 @subsection Examples
2951
2952 @itemize
2953 @item
2954 Draw a black box around the edge of the input image:
2955 @example
2956 drawbox
2957 @end example
2958
2959 @item
2960 Draw a box with color red and an opacity of 50%:
2961 @example
2962 drawbox=10:20:200:60:red@@0.5
2963 @end example
2964
2965 The previous example can be specified as:
2966 @example
2967 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
2968 @end example
2969
2970 @item
2971 Fill the box with pink color:
2972 @example
2973 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
2974 @end example
2975
2976 @item
2977 Draw a 2-pixel red 2.40:1 mask:
2978 @example
2979 drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
2980 @end example
2981 @end itemize
2982
2983 @section drawgrid
2984
2985 Draw a grid on the input image.
2986
2987 This filter accepts the following options:
2988
2989 @table @option
2990 @item x
2991 @item y
2992 The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0.
2993
2994 @item width, w
2995 @item height, h
2996 The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the
2997 input width and height, respectively, minus @code{thickness}, so image gets
2998 framed. Default to 0.
2999
3000 @item color, c
3001 Specify the color of the grid, it can be the name of a color
3002 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
3003 value @code{invert} is used, the grid color is the same as the
3004 video with inverted luma.
3005 Note that you can append opacity value (in range of 0.0 - 1.0)
3006 to color name after @@ sign.
3007
3008 @item thickness, t
3009 The expression which sets the thickness of the grid line. Default value is @code{1}.
3010
3011 See below for the list of accepted constants.
3012 @end table
3013
3014 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
3015 following constants:
3016
3017 @table @option
3018 @item dar
3019 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
3020
3021 @item hsub
3022 @item vsub
3023 horizontal and vertical chroma subsample values. For example for the
3024 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3025
3026 @item in_h, ih
3027 @item in_w, iw
3028 The input grid cell width and height.
3029
3030 @item sar
3031 The input sample aspect ratio.
3032
3033 @item x
3034 @item y
3035 The x and y coordinates of some point of grid intersection (meant to configure offset).
3036
3037 @item w
3038 @item h
3039 The width and height of the drawn cell.
3040
3041 @item t
3042 The thickness of the drawn cell.
3043
3044 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
3045 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
3046
3047 @end table
3048
3049 @subsection Examples
3050
3051 @itemize
3052 @item
3053 Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%:
3054 @example
3055 drawgrid=width=100:height=100:thickness=2:color=red@@0.5
3056 @end example
3057
3058 @item
3059 Draw a white 3x3 grid with an opacity of 50%:
3060 @example
3061 drawgrid=w=iw/3:h=ih/3:t=2:c=white@@0.5
3062 @end example
3063 @end itemize
3064
3065 @anchor{drawtext}
3066 @section drawtext
3067
3068 Draw text string or text from specified file on top of video using the
3069 libfreetype library.
3070
3071 To enable compilation of this filter you need to configure FFmpeg with
3072 @code{--enable-libfreetype}.
3073
3074 @subsection Syntax
3075
3076 The description of the accepted parameters follows.
3077
3078 @table @option
3079
3080 @item box
3081 Used to draw a box around text using background color.
3082 Value should be either 1 (enable) or 0 (disable).
3083 The default value of @var{box} is 0.
3084
3085 @item boxcolor
3086 The color to be used for drawing box around text.
3087 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
3088 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
3089 The default value of @var{boxcolor} is "white".
3090
3091 @item draw
3092 Set an expression which specifies if the text should be drawn. If the
3093 expression evaluates to 0, the text is not drawn. This is useful for
3094 specifying that the text should be drawn only when specific conditions
3095 are met.
3096
3097 Default value is "1".
3098
3099 See below for the list of accepted constants and functions.
3100
3101 @item expansion
3102 Select how the @var{text} is expanded. Can be either @code{none},
3103 @code{strftime} (deprecated) or
3104 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
3105 below for details.
3106
3107 @item fix_bounds
3108 If true, check and fix text coords to avoid clipping.
3109
3110 @item fontcolor
3111 The color to be used for drawing fonts.
3112 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
3113 (e.g. "0xff000033"), possibly followed by an alpha specifier.
3114 The default value of @var{fontcolor} is "black".
3115
3116 @item fontfile
3117 The font file to be used for drawing text. Path must be included.
3118 This parameter is mandatory.
3119
3120 @item fontsize
3121 The font size to be used for drawing text.
3122 The default value of @var{fontsize} is 16.
3123
3124 @item ft_load_flags
3125 Flags to be used for loading the fonts.
3126
3127 The flags map the corresponding flags supported by libfreetype, and are
3128 a combination of the following values:
3129 @table @var
3130 @item default
3131 @item no_scale
3132 @item no_hinting
3133 @item render
3134 @item no_bitmap
3135 @item vertical_layout
3136 @item force_autohint
3137 @item crop_bitmap
3138 @item pedantic
3139 @item ignore_global_advance_width
3140 @item no_recurse
3141 @item ignore_transform
3142 @item monochrome
3143 @item linear_design
3144 @item no_autohint
3145 @end table
3146
3147 Default value is "render".
3148
3149 For more information consult the documentation for the FT_LOAD_*
3150 libfreetype flags.
3151
3152 @item shadowcolor
3153 The color to be used for drawing a shadow behind the drawn text.  It
3154 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
3155 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
3156 The default value of @var{shadowcolor} is "black".
3157
3158 @item shadowx
3159 @item shadowy
3160 The x and y offsets for the text shadow position with respect to the
3161 position of the text. They can be either positive or negative
3162 values. Default value for both is "0".
3163
3164 @item start_number
3165 The starting frame number for the n/frame_num variable. The default value
3166 is "0".
3167
3168 @item tabsize
3169 The size in number of spaces to use for rendering the tab.
3170 Default value is 4.
3171
3172 @item timecode
3173 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
3174 format. It can be used with or without text parameter. @var{timecode_rate}
3175 option must be specified.
3176
3177 @item timecode_rate, rate, r
3178 Set the timecode frame rate (timecode only).
3179
3180 @item text
3181 The text string to be drawn. The text must be a sequence of UTF-8
3182 encoded characters.
3183 This parameter is mandatory if no file is specified with the parameter
3184 @var{textfile}.
3185
3186 @item textfile
3187 A text file containing text to be drawn. The text must be a sequence
3188 of UTF-8 encoded characters.
3189
3190 This parameter is mandatory if no text string is specified with the
3191 parameter @var{text}.
3192
3193 If both @var{text} and @var{textfile} are specified, an error is thrown.
3194
3195 @item reload
3196 If set to 1, the @var{textfile} will be reloaded before each frame.
3197 Be sure to update it atomically, or it may be read partially, or even fail.
3198
3199 @item x
3200 @item y
3201 The expressions which specify the offsets where text will be drawn
3202 within the video frame. They are relative to the top/left border of the
3203 output image.
3204
3205 The default value of @var{x} and @var{y} is "0".
3206
3207 See below for the list of accepted constants and functions.
3208 @end table
3209
3210 The parameters for @var{x} and @var{y} are expressions containing the
3211 following constants and functions:
3212
3213 @table @option
3214 @item dar
3215 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
3216
3217 @item hsub
3218 @item vsub
3219 horizontal and vertical chroma subsample values. For example for the
3220 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3221
3222 @item line_h, lh
3223 the height of each text line
3224
3225 @item main_h, h, H
3226 the input height
3227
3228 @item main_w, w, W
3229 the input width
3230
3231 @item max_glyph_a, ascent
3232 the maximum distance from the baseline to the highest/upper grid
3233 coordinate used to place a glyph outline point, for all the rendered
3234 glyphs.
3235 It is a positive value, due to the grid's orientation with the Y axis
3236 upwards.
3237
3238 @item max_glyph_d, descent
3239 the maximum distance from the baseline to the lowest grid coordinate
3240 used to place a glyph outline point, for all the rendered glyphs.
3241 This is a negative value, due to the grid's orientation, with the Y axis
3242 upwards.
3243
3244 @item max_glyph_h
3245 maximum glyph height, that is the maximum height for all the glyphs
3246 contained in the rendered text, it is equivalent to @var{ascent} -
3247 @var{descent}.
3248
3249 @item max_glyph_w
3250 maximum glyph width, that is the maximum width for all the glyphs
3251 contained in the rendered text
3252
3253 @item n
3254 the number of input frame, starting from 0
3255
3256 @item rand(min, max)
3257 return a random number included between @var{min} and @var{max}
3258
3259 @item sar
3260 input sample aspect ratio
3261
3262 @item t
3263 timestamp expressed in seconds, NAN if the input timestamp is unknown
3264
3265 @item text_h, th
3266 the height of the rendered text
3267
3268 @item text_w, tw
3269 the width of the rendered text
3270
3271 @item x
3272 @item y
3273 the x and y offset coordinates where the text is drawn.
3274
3275 These parameters allow the @var{x} and @var{y} expressions to refer
3276 each other, so you can for example specify @code{y=x/dar}.
3277 @end table
3278
3279 If libavfilter was built with @code{--enable-fontconfig}, then
3280 @option{fontfile} can be a fontconfig pattern or omitted.
3281
3282 @anchor{drawtext_expansion}
3283 @subsection Text expansion
3284
3285 If @option{expansion} is set to @code{strftime},
3286 the filter recognizes strftime() sequences in the provided text and
3287 expands them accordingly. Check the documentation of strftime(). This
3288 feature is deprecated.
3289
3290 If @option{expansion} is set to @code{none}, the text is printed verbatim.
3291
3292 If @option{expansion} is set to @code{normal} (which is the default),
3293 the following expansion mechanism is used.
3294
3295 The backslash character '\', followed by any character, always expands to
3296 the second character.
3297
3298 Sequence of the form @code{%@{...@}} are expanded. The text between the
3299 braces is a function name, possibly followed by arguments separated by ':'.
3300 If the arguments contain special characters or delimiters (':' or '@}'),
3301 they should be escaped.
3302
3303 Note that they probably must also be escaped as the value for the
3304 @option{text} option in the filter argument string and as the filter
3305 argument in the filtergraph description, and possibly also for the shell,
3306 that makes up to four levels of escaping; using a text file avoids these
3307 problems.
3308
3309 The following functions are available:
3310
3311 @table @command
3312
3313 @item expr, e
3314 The expression evaluation result.
3315
3316 It must take one argument specifying the expression to be evaluated,
3317 which accepts the same constants and functions as the @var{x} and
3318 @var{y} values. Note that not all constants should be used, for
3319 example the text size is not known when evaluating the expression, so
3320 the constants @var{text_w} and @var{text_h} will have an undefined
3321 value.
3322
3323 @item gmtime
3324 The time at which the filter is running, expressed in UTC.
3325 It can accept an argument: a strftime() format string.
3326
3327 @item localtime
3328 The time at which the filter is running, expressed in the local time zone.
3329 It can accept an argument: a strftime() format string.
3330
3331 @item n, frame_num
3332 The frame number, starting from 0.
3333
3334 @item pict_type
3335 A 1 character description of the current picture type.
3336
3337 @item pts
3338 The timestamp of the current frame, in seconds, with microsecond accuracy.
3339
3340 @end table
3341
3342 @subsection Examples
3343
3344 @itemize
3345 @item
3346 Draw "Test Text" with font FreeSerif, using the default values for the
3347 optional parameters.
3348
3349 @example
3350 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
3351 @end example
3352
3353 @item
3354 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
3355 and y=50 (counting from the top-left corner of the screen), text is
3356 yellow with a red box around it. Both the text and the box have an
3357 opacity of 20%.
3358
3359 @example
3360 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
3361           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
3362 @end example
3363
3364 Note that the double quotes are not necessary if spaces are not used
3365 within the parameter list.
3366
3367 @item
3368 Show the text at the center of the video frame:
3369 @example
3370 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
3371 @end example
3372
3373 @item
3374 Show a text line sliding from right to left in the last row of the video
3375 frame. The file @file{LONG_LINE} is assumed to contain a single line
3376 with no newlines.
3377 @example
3378 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
3379 @end example
3380
3381 @item
3382 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
3383 @example
3384 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
3385 @end example
3386
3387 @item
3388 Draw a single green letter "g", at the center of the input video.
3389 The glyph baseline is placed at half screen height.
3390 @example
3391 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
3392 @end example
3393
3394 @item
3395 Show text for 1 second every 3 seconds:
3396 @example
3397 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
3398 @end example
3399
3400 @item
3401 Use fontconfig to set the font. Note that the colons need to be escaped.
3402 @example
3403 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
3404 @end example
3405
3406 @item
3407 Print the date of a real-time encoding (see strftime(3)):
3408 @example
3409 drawtext='fontfile=FreeSans.ttf:text=%@{localtime:%a %b %d %Y@}'
3410 @end example
3411
3412 @end itemize
3413
3414 For more information about libfreetype, check:
3415 @url{http://www.freetype.org/}.
3416
3417 For more information about fontconfig, check:
3418 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
3419
3420 @section edgedetect
3421
3422 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
3423
3424 The filter accepts the following options:
3425
3426 @table @option
3427 @item low
3428 @item high
3429 Set low and high threshold values used by the Canny thresholding
3430 algorithm.
3431
3432 The high threshold selects the "strong" edge pixels, which are then
3433 connected through 8-connectivity with the "weak" edge pixels selected
3434 by the low threshold.
3435
3436 @var{low} and @var{high} threshold values must be choosen in the range
3437 [0,1], and @var{low} should be lesser or equal to @var{high}.
3438
3439 Default value for @var{low} is @code{20/255}, and default value for @var{high}
3440 is @code{50/255}.
3441 @end table
3442
3443 Example:
3444 @example
3445 edgedetect=low=0.1:high=0.4
3446 @end example
3447
3448 @section extractplanes
3449
3450 Extract color channel components from input video stream into
3451 separate grayscale video streams.
3452
3453 The filter accepts the following option:
3454
3455 @table @option
3456 @item planes
3457 Set plane(s) to extract.
3458
3459 Available values for planes are:
3460 @table @samp
3461 @item y
3462 @item u
3463 @item v
3464 @item a
3465 @item r
3466 @item g
3467 @item b
3468 @end table
3469
3470 Choosing planes not available in the input will result in an error.
3471 That means you cannot select @code{r}, @code{g}, @code{b} planes
3472 with @code{y}, @code{u}, @code{v} planes at same time.
3473 @end table
3474
3475 @subsection Examples
3476
3477 @itemize
3478 @item
3479 Extract luma, u and v color channel component from input video frame
3480 into 3 grayscale outputs:
3481 @example
3482 ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
3483 @end example
3484 @end itemize
3485
3486 @section fade
3487
3488 Apply fade-in/out effect to input video.
3489
3490 This filter accepts the following options:
3491
3492 @table @option
3493 @item type, t
3494 The effect type -- can be either "in" for fade-in, or "out" for a fade-out
3495 effect.
3496 Default is @code{in}.
3497
3498 @item start_frame, s
3499 Specify the number of the start frame for starting to apply the fade
3500 effect. Default is 0.
3501
3502 @item nb_frames, n
3503 The number of frames for which the fade effect has to last. At the end of the
3504 fade-in effect the output video will have the same intensity as the input video,
3505 at the end of the fade-out transition the output video will be completely black.
3506 Default is 25.
3507
3508 @item alpha
3509 If set to 1, fade only alpha channel, if one exists on the input.
3510 Default value is 0.
3511
3512 @item start_time, st
3513 Specify the timestamp (in seconds) of the frame to start to apply the fade
3514 effect. If both start_frame and start_time are specified, the fade will start at
3515 whichever comes last.  Default is 0.
3516
3517 @item duration, d
3518 The number of seconds for which the fade effect has to last. At the end of the
3519 fade-in effect the output video will have the same intensity as the input video,
3520 at the end of the fade-out transition the output video will be completely black.
3521 If both duration and nb_frames are specified, duration is used. Default is 0.
3522 @end table
3523
3524 @subsection Examples
3525
3526 @itemize
3527 @item
3528 Fade in first 30 frames of video:
3529 @example
3530 fade=in:0:30
3531 @end example
3532
3533 The command above is equivalent to:
3534 @example
3535 fade=t=in:s=0:n=30
3536 @end example
3537
3538 @item
3539 Fade out last 45 frames of a 200-frame video:
3540 @example
3541 fade=out:155:45
3542 fade=type=out:start_frame=155:nb_frames=45
3543 @end example
3544
3545 @item
3546 Fade in first 25 frames and fade out last 25 frames of a 1000-frame video:
3547 @example
3548 fade=in:0:25, fade=out:975:25
3549 @end example
3550
3551 @item
3552 Make first 5 frames black, then fade in from frame 5-24:
3553 @example
3554 fade=in:5:20
3555 @end example
3556
3557 @item
3558 Fade in alpha over first 25 frames of video:
3559 @example
3560 fade=in:0:25:alpha=1
3561 @end example
3562
3563 @item
3564 Make first 5.5 seconds black, then fade in for 0.5 seconds:
3565 @example
3566 fade=t=in:st=5.5:d=0.5
3567 @end example
3568
3569 @end itemize
3570
3571 @section field
3572
3573 Extract a single field from an interlaced image using stride
3574 arithmetic to avoid wasting CPU time. The output frames are marked as
3575 non-interlaced.
3576
3577 The filter accepts the following options:
3578
3579 @table @option
3580 @item type
3581 Specify whether to extract the top (if the value is @code{0} or
3582 @code{top}) or the bottom field (if the value is @code{1} or
3583 @code{bottom}).
3584 @end table
3585
3586 @section fieldmatch
3587
3588 Field matching filter for inverse telecine. It is meant to reconstruct the
3589 progressive frames from a telecined stream. The filter does not drop duplicated
3590 frames, so to achieve a complete inverse telecine @code{fieldmatch} needs to be
3591 followed by a decimation filter such as @ref{decimate} in the filtergraph.
3592
3593 The separation of the field matching and the decimation is notably motivated by
3594 the possibility of inserting a de-interlacing filter fallback between the two.
3595 If the source has mixed telecined and real interlaced content,
3596 @code{fieldmatch} will not be able to match fields for the interlaced parts.
3597 But these remaining combed frames will be marked as interlaced, and thus can be
3598 de-interlaced by a later filter such as @ref{yadif} before decimation.
3599
3600 In addition to the various configuration options, @code{fieldmatch} can take an
3601 optional second stream, activated through the @option{ppsrc} option. If
3602 enabled, the frames reconstruction will be based on the fields and frames from
3603 this second stream. This allows the first input to be pre-processed in order to
3604 help the various algorithms of the filter, while keeping the output lossless
3605 (assuming the fields are matched properly). Typically, a field-aware denoiser,
3606 or brightness/contrast adjustments can help.
3607
3608 Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project)
3609 and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from
3610 which @code{fieldmatch} is based on. While the semantic and usage are very
3611 close, some behaviour and options names can differ.
3612
3613 The filter accepts the following options:
3614
3615 @table @option
3616 @item order
3617 Specify the assumed field order of the input stream. Available values are:
3618
3619 @table @samp
3620 @item auto
3621 Auto detect parity (use FFmpeg's internal parity value).
3622 @item bff
3623 Assume bottom field first.
3624 @item tff
3625 Assume top field first.
3626 @end table
3627
3628 Note that it is sometimes recommended not to trust the parity announced by the
3629 stream.
3630
3631 Default value is @var{auto}.
3632
3633 @item mode
3634 Set the matching mode or strategy to use. @option{pc} mode is the safest in the
3635 sense that it won't risk creating jerkiness due to duplicate frames when
3636 possible, but if there are bad edits or blended fields it will end up
3637 outputting combed frames when a good match might actually exist. On the other
3638 hand, @option{pcn_ub} mode is the most risky in terms of creating jerkiness,
3639 but will almost always find a good frame if there is one. The other values are
3640 all somewhere in between @option{pc} and @option{pcn_ub} in terms of risking
3641 jerkiness and creating duplicate frames versus finding good matches in sections
3642 with bad edits, orphaned fields, blended fields, etc.
3643
3644 More details about p/c/n/u/b are available in @ref{p/c/n/u/b meaning} section.
3645
3646 Available values are:
3647
3648 @table @samp
3649 @item pc
3650 2-way matching (p/c)
3651 @item pc_n
3652 2-way matching, and trying 3rd match if still combed (p/c + n)
3653 @item pc_u
3654 2-way matching, and trying 3rd match (same order) if still combed (p/c + u)
3655 @item pc_n_ub
3656 2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if
3657 still combed (p/c + n + u/b)
3658 @item pcn
3659 3-way matching (p/c/n)
3660 @item pcn_ub
3661 3-way matching, and trying 4th/5th matches if all 3 of the original matches are
3662 detected as combed (p/c/n + u/b)
3663 @end table
3664
3665 The parenthesis at the end indicate the matches that would be used for that
3666 mode assuming @option{order}=@var{tff} (and @option{field} on @var{auto} or
3667 @var{top}).
3668
3669 In terms of speed @option{pc} mode is by far the fastest and @option{pcn_ub} is
3670 the slowest.
3671
3672 Default value is @var{pc_n}.
3673
3674 @item ppsrc
3675 Mark the main input stream as a pre-processed input, and enable the secondary
3676 input stream as the clean source to pick the fields from. See the filter
3677 introduction for more details. It is similar to the @option{clip2} feature from
3678 VFM/TFM.
3679
3680 Default value is @code{0} (disabled).
3681
3682 @item field
3683 Set the field to match from. It is recommended to set this to the same value as
3684 @option{order} unless you experience matching failures with that setting. In
3685 certain circumstances changing the field that is used to match from can have a
3686 large impact on matching performance. Available values are:
3687
3688 @table @samp
3689 @item auto
3690 Automatic (same value as @option{order}).
3691 @item bottom
3692 Match from the bottom field.
3693 @item top
3694 Match from the top field.
3695 @end table
3696
3697 Default value is @var{auto}.
3698
3699 @item mchroma
3700 Set whether or not chroma is included during the match comparisons. In most
3701 cases it is recommended to leave this enabled. You should set this to @code{0}
3702 only if your clip has bad chroma problems such as heavy rainbowing or other
3703 artifacts. Setting this to @code{0} could also be used to speed things up at
3704 the cost of some accuracy.
3705
3706 Default value is @code{1}.
3707
3708 @item y0
3709 @item y1
3710 These define an exclusion band which excludes the lines between @option{y0} and
3711 @option{y1} from being included in the field matching decision. An exclusion
3712 band can be used to ignore subtitles, a logo, or other things that may
3713 interfere with the matching. @option{y0} sets the starting scan line and
3714 @option{y1} sets the ending line; all lines in between @option{y0} and
3715 @option{y1} (including @option{y0} and @option{y1}) will be ignored. Setting
3716 @option{y0} and @option{y1} to the same value will disable the feature.
3717 @option{y0} and @option{y1} defaults to @code{0}.
3718
3719 @item scthresh
3720 Set the scene change detection threshold as a percentage of maximum change on
3721 the luma plane. Good values are in the @code{[8.0, 14.0]} range. Scene change
3722 detection is only relevant in case @option{combmatch}=@var{sc}.  The range for
3723 @option{scthresh} is @code{[0.0, 100.0]}.
3724
3725 Default value is @code{12.0}.
3726
3727 @item combmatch
3728 When @option{combatch} is not @var{none}, @code{fieldmatch} will take into
3729 account the combed scores of matches when deciding what match to use as the
3730 final match. Available values are:
3731
3732 @table @samp
3733 @item none
3734 No final matching based on combed scores.
3735 @item sc
3736 Combed scores are only used when a scene change is detected.
3737 @item full
3738 Use combed scores all the time.
3739 @end table
3740
3741 Default is @var{sc}.
3742
3743 @item combdbg
3744 Force @code{fieldmatch} to calculate the combed metrics for certain matches and
3745 print them. This setting is known as @option{micout} in TFM/VFM vocabulary.
3746 Available values are:
3747
3748 @table @samp
3749 @item none
3750 No forced calculation.
3751 @item pcn
3752 Force p/c/n calculations.
3753 @item pcnub
3754 Force p/c/n/u/b calculations.
3755 @end table
3756
3757 Default value is @var{none}.
3758
3759 @item cthresh
3760 This is the area combing threshold used for combed frame detection. This
3761 essentially controls how "strong" or "visible" combing must be to be detected.
3762 Larger values mean combing must be more visible and smaller values mean combing
3763 can be less visible or strong and still be detected. Valid settings are from
3764 @code{-1} (every pixel will be detected as combed) to @code{255} (no pixel will
3765 be detected as combed). This is basically a pixel difference value. A good
3766 range is @code{[8, 12]}.
3767
3768 Default value is @code{9}.
3769
3770 @item chroma
3771 Sets whether or not chroma is considered in the combed frame decision.  Only
3772 disable this if your source has chroma problems (rainbowing, etc.) that are
3773 causing problems for the combed frame detection with chroma enabled. Actually,
3774 using @option{chroma}=@var{0} is usually more reliable, except for the case
3775 where there is chroma only combing in the source.
3776
3777 Default value is @code{0}.
3778
3779 @item blockx
3780 @item blocky
3781 Respectively set the x-axis and y-axis size of the window used during combed
3782 frame detection. This has to do with the size of the area in which
3783 @option{combpel} pixels are required to be detected as combed for a frame to be
3784 declared combed. See the @option{combpel} parameter description for more info.
3785 Possible values are any number that is a power of 2 starting at 4 and going up
3786 to 512.
3787
3788 Default value is @code{16}.
3789
3790 @item combpel
3791 The number of combed pixels inside any of the @option{blocky} by
3792 @option{blockx} size blocks on the frame for the frame to be detected as
3793 combed. While @option{cthresh} controls how "visible" the combing must be, this
3794 setting controls "how much" combing there must be in any localized area (a
3795 window defined by the @option{blockx} and @option{blocky} settings) on the
3796 frame. Minimum value is @code{0} and maximum is @code{blocky x blockx} (at
3797 which point no frames will ever be detected as combed). This setting is known
3798 as @option{MI} in TFM/VFM vocabulary.
3799
3800 Default value is @code{80}.
3801 @end table
3802
3803 @anchor{p/c/n/u/b meaning}
3804 @subsection p/c/n/u/b meaning
3805
3806 @subsubsection p/c/n
3807
3808 We assume the following telecined stream:
3809
3810 @example
3811 Top fields:     1 2 2 3 4
3812 Bottom fields:  1 2 3 4 4
3813 @end example
3814
3815 The numbers correspond to the progressive frame the fields relate to. Here, the
3816 first two frames are progressive, the 3rd and 4th are combed, and so on.
3817
3818 When @code{fieldmatch} is configured to run a matching from bottom
3819 (@option{field}=@var{bottom}) this is how this input stream get transformed:
3820
3821 @example
3822 Input stream:
3823                 T     1 2 2 3 4
3824                 B     1 2 3 4 4   <-- matching reference
3825
3826 Matches:              c c n n c
3827
3828 Output stream:
3829                 T     1 2 3 4 4
3830                 B     1 2 3 4 4
3831 @end example
3832
3833 As a result of the field matching, we can see that some frames get duplicated.
3834 To perform a complete inverse telecine, you need to rely on a decimation filter
3835 after this operation. See for instance the @ref{decimate} filter.
3836
3837 The same operation now matching from top fields (@option{field}=@var{top})
3838 looks like this:
3839
3840 @example
3841 Input stream:
3842                 T     1 2 2 3 4   <-- matching reference
3843                 B     1 2 3 4 4
3844
3845 Matches:              c c p p c
3846
3847 Output stream:
3848                 T     1 2 2 3 4
3849                 B     1 2 2 3 4
3850 @end example
3851
3852 In these examples, we can see what @var{p}, @var{c} and @var{n} mean;
3853 basically, they refer to the frame and field of the opposite parity:
3854
3855 @itemize
3856 @item @var{p} matches the field of the opposite parity in the previous frame
3857 @item @var{c} matches the field of the opposite parity in the current frame
3858 @item @var{n} matches the field of the opposite parity in the next frame
3859 @end itemize
3860
3861 @subsubsection u/b
3862
3863 The @var{u} and @var{b} matching are a bit special in the sense that they match
3864 from the opposite parity flag. In the following examples, we assume that we are
3865 currently matching the 2nd frame (Top:2, bottom:2). According to the match, a
3866 'x' is placed above and below each matched fields.
3867
3868 With bottom matching (@option{field}=@var{bottom}):
3869 @example
3870 Match:           c         p           n          b          u
3871
3872                  x       x               x        x          x
3873   Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
3874   Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
3875                  x         x           x        x              x
3876
3877 Output frames:
3878                  2          1          2          2          2
3879                  2          2          2          1          3
3880 @end example
3881
3882 With top matching (@option{field}=@var{top}):
3883 @example
3884 Match:           c         p           n          b          u
3885
3886                  x         x           x        x              x
3887   Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
3888   Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
3889                  x       x               x        x          x
3890
3891 Output frames:
3892                  2          2          2          1          2
3893                  2          1          3          2          2
3894 @end example
3895
3896 @subsection Examples
3897
3898 Simple IVTC of a top field first telecined stream:
3899 @example
3900 fieldmatch=order=tff:combmatch=none, decimate
3901 @end example
3902
3903 Advanced IVTC, with fallback on @ref{yadif} for still combed frames:
3904 @example
3905 fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
3906 @end example
3907
3908 @section fieldorder
3909
3910 Transform the field order of the input video.
3911
3912 This filter accepts the following options:
3913
3914 @table @option
3915
3916 @item order
3917 Output field order. Valid values are @var{tff} for top field first or @var{bff}
3918 for bottom field first.
3919 @end table
3920
3921 Default value is @samp{tff}.
3922
3923 Transformation is achieved by shifting the picture content up or down
3924 by one line, and filling the remaining line with appropriate picture content.
3925 This method is consistent with most broadcast field order converters.
3926
3927 If the input video is not flagged as being interlaced, or it is already
3928 flagged as being of the required output field order then this filter does
3929 not alter the incoming video.
3930
3931 This filter is very useful when converting to or from PAL DV material,
3932 which is bottom field first.
3933
3934 For example:
3935 @example
3936 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
3937 @end example
3938
3939 @section fifo
3940
3941 Buffer input images and send them when they are requested.
3942
3943 This filter is mainly useful when auto-inserted by the libavfilter
3944 framework.
3945
3946 The filter does not take parameters.
3947
3948 @anchor{format}
3949 @section format
3950
3951 Convert the input video to one of the specified pixel formats.
3952 Libavfilter will try to pick one that is supported for the input to
3953 the next filter.
3954
3955 This filter accepts the following parameters:
3956 @table @option
3957
3958 @item pix_fmts
3959 A '|'-separated list of pixel format names, for example
3960 "pix_fmts=yuv420p|monow|rgb24".
3961
3962 @end table
3963
3964 @subsection Examples
3965
3966 @itemize
3967 @item
3968 Convert the input video to the format @var{yuv420p}
3969 @example
3970 format=pix_fmts=yuv420p
3971 @end example
3972
3973 Convert the input video to any of the formats in the list
3974 @example
3975 format=pix_fmts=yuv420p|yuv444p|yuv410p
3976 @end example
3977 @end itemize
3978
3979 @section fps
3980
3981 Convert the video to specified constant frame rate by duplicating or dropping
3982 frames as necessary.
3983
3984 This filter accepts the following named parameters:
3985 @table @option
3986
3987 @item fps
3988 Desired output frame rate. The default is @code{25}.
3989
3990 @item round
3991 Rounding method.
3992
3993 Possible values are:
3994 @table @option
3995 @item zero
3996 zero round towards 0
3997 @item inf
3998 round away from 0
3999 @item down
4000 round towards -infinity
4001 @item up
4002 round towards +infinity
4003 @item near
4004 round to nearest
4005 @end table
4006 The default is @code{near}.
4007
4008 @end table
4009
4010 Alternatively, the options can be specified as a flat string:
4011 @var{fps}[:@var{round}].
4012
4013 See also the @ref{setpts} filter.
4014
4015 @subsection Examples
4016
4017 @itemize
4018 @item
4019 A typical usage in order to set the fps to 25:
4020 @example
4021 fps=fps=25
4022 @end example
4023
4024 @item
4025 Sets the fps to 24, using abbreviation and rounding method to round to nearest:
4026 @example
4027 fps=fps=film:round=near
4028 @end example
4029 @end itemize
4030
4031 @section framestep
4032
4033 Select one frame every N-th frame.
4034
4035 This filter accepts the following option:
4036 @table @option
4037 @item step
4038 Select frame after every @code{step} frames.
4039 Allowed values are positive integers higher than 0. Default value is @code{1}.
4040 @end table
4041
4042 @anchor{frei0r}
4043 @section frei0r
4044
4045 Apply a frei0r effect to the input video.
4046
4047 To enable compilation of this filter you need to install the frei0r
4048 header and configure FFmpeg with @code{--enable-frei0r}.
4049
4050 This filter accepts the following options:
4051
4052 @table @option
4053
4054 @item filter_name
4055 The name to the frei0r effect to load. If the environment variable
4056 @env{FREI0R_PATH} is defined, the frei0r effect is searched in each one of the
4057 directories specified by the colon separated list in @env{FREIOR_PATH},
4058 otherwise in the standard frei0r paths, which are in this order:
4059 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
4060 @file{/usr/lib/frei0r-1/}.
4061
4062 @item filter_params
4063 A '|'-separated list of parameters to pass to the frei0r effect.
4064
4065 @end table
4066
4067 A frei0r effect parameter can be a boolean (whose values are specified
4068 with "y" and "n"), a double, a color (specified by the syntax
4069 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
4070 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
4071 description), a position (specified by the syntax @var{X}/@var{Y},
4072 @var{X} and @var{Y} being float numbers) and a string.
4073
4074 The number and kind of parameters depend on the loaded effect. If an
4075 effect parameter is not specified the default value is set.
4076
4077 @subsection Examples
4078
4079 @itemize
4080 @item
4081 Apply the distort0r effect, set the first two double parameters:
4082 @example
4083 frei0r=filter_name=distort0r:filter_params=0.5|0.01
4084 @end example
4085
4086 @item
4087 Apply the colordistance effect, take a color as first parameter:
4088 @example
4089 frei0r=colordistance:0.2/0.3/0.4
4090 frei0r=colordistance:violet
4091 frei0r=colordistance:0x112233
4092 @end example
4093
4094 @item
4095 Apply the perspective effect, specify the top left and top right image
4096 positions:
4097 @example
4098 frei0r=perspective:0.2/0.2|0.8/0.2
4099 @end example
4100 @end itemize
4101
4102 For more information see:
4103 @url{http://frei0r.dyne.org}
4104
4105 @section geq
4106
4107 The filter accepts the following options:
4108
4109 @table @option
4110 @item lum_expr, lum
4111 Set the luminance expression.
4112 @item cb_expr, cb
4113 Set the chrominance blue expression.
4114 @item cr_expr, cr
4115 Set the chrominance red expression.
4116 @item alpha_expr, a
4117 Set the alpha expression.
4118 @item red_expr, r
4119 Set the red expression.
4120 @item green_expr, g
4121 Set the green expression.
4122 @item blue_expr, b
4123 Set the blue expression.
4124 @end table
4125
4126 The colorspace is selected according to the specified options. If one
4127 of the @option{lum_expr}, @option{cb_expr}, or @option{cr_expr}
4128 options is specified, the filter will automatically select a YCbCr
4129 colorspace. If one of the @option{red_expr}, @option{green_expr}, or
4130 @option{blue_expr} options is specified, it will select an RGB
4131 colorspace.
4132
4133 If one of the chrominance expression is not defined, it falls back on the other
4134 one. If no alpha expression is specified it will evaluate to opaque value.
4135 If none of chrominance expressions are specified, they will evaluate
4136 to the luminance expression.
4137
4138 The expressions can use the following variables and functions:
4139
4140 @table @option
4141 @item N
4142 The sequential number of the filtered frame, starting from @code{0}.
4143
4144 @item X
4145 @item Y
4146 The coordinates of the current sample.
4147
4148 @item W
4149 @item H
4150 The width and height of the image.
4151
4152 @item SW
4153 @item SH
4154 Width and height scale depending on the currently filtered plane. It is the
4155 ratio between the corresponding luma plane number of pixels and the current
4156 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
4157 @code{0.5,0.5} for chroma planes.
4158
4159 @item T
4160 Time of the current frame, expressed in seconds.
4161
4162 @item p(x, y)
4163 Return the value of the pixel at location (@var{x},@var{y}) of the current
4164 plane.
4165
4166 @item lum(x, y)
4167 Return the value of the pixel at location (@var{x},@var{y}) of the luminance
4168 plane.
4169
4170 @item cb(x, y)
4171 Return the value of the pixel at location (@var{x},@var{y}) of the
4172 blue-difference chroma plane. Return 0 if there is no such plane.
4173
4174 @item cr(x, y)
4175 Return the value of the pixel at location (@var{x},@var{y}) of the
4176 red-difference chroma plane. Return 0 if there is no such plane.
4177
4178 @item r(x, y)
4179 @item g(x, y)
4180 @item b(x, y)
4181 Return the value of the pixel at location (@var{x},@var{y}) of the
4182 red/green/blue component. Return 0 if there is no such component.
4183
4184 @item alpha(x, y)
4185 Return the value of the pixel at location (@var{x},@var{y}) of the alpha
4186 plane. Return 0 if there is no such plane.
4187 @end table
4188
4189 For functions, if @var{x} and @var{y} are outside the area, the value will be
4190 automatically clipped to the closer edge.
4191
4192 @subsection Examples
4193
4194 @itemize
4195 @item
4196 Flip the image horizontally:
4197 @example
4198 geq=p(W-X\,Y)
4199 @end example
4200
4201 @item
4202 Generate a bidimensional sine wave, with angle @code{PI/3} and a
4203 wavelength of 100 pixels:
4204 @example
4205 geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
4206 @end example
4207
4208 @item
4209 Generate a fancy enigmatic moving light:
4210 @example
4211 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
4212 @end example
4213
4214 @item
4215 Generate a quick emboss effect:
4216 @example
4217 format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
4218 @end example
4219
4220 @item
4221 Modify RGB components depending on pixel position:
4222 @example
4223 geq=r='X/W*r(X,Y)':g='(1-X/W)*g(X,Y)':b='(H-Y)/H*b(X,Y)'
4224 @end example
4225 @end itemize
4226
4227 @section gradfun
4228
4229 Fix the banding artifacts that are sometimes introduced into nearly flat
4230 regions by truncation to 8bit color depth.
4231 Interpolate the gradients that should go where the bands are, and
4232 dither them.
4233
4234 This filter is designed for playback only.  Do not use it prior to
4235 lossy compression, because compression tends to lose the dither and
4236 bring back the bands.
4237
4238 This filter accepts the following options:
4239
4240 @table @option
4241
4242 @item strength
4243 The maximum amount by which the filter will change any one pixel. Also the
4244 threshold for detecting nearly flat regions. Acceptable values range from .51 to
4245 64, default value is 1.2, out-of-range values will be clipped to the valid
4246 range.
4247
4248 @item radius
4249 The neighborhood to fit the gradient to. A larger radius makes for smoother
4250 gradients, but also prevents the filter from modifying the pixels near detailed
4251 regions. Acceptable values are 8-32, default value is 16, out-of-range values
4252 will be clipped to the valid range.
4253
4254 @end table
4255
4256 Alternatively, the options can be specified as a flat string:
4257 @var{strength}[:@var{radius}]
4258
4259 @subsection Examples
4260
4261 @itemize
4262 @item
4263 Apply the filter with a @code{3.5} strength and radius of @code{8}:
4264 @example
4265 gradfun=3.5:8
4266 @end example
4267
4268 @item
4269 Specify radius, omitting the strength (which will fall-back to the default
4270 value):
4271 @example
4272 gradfun=radius=8
4273 @end example
4274
4275 @end itemize
4276
4277 @anchor{haldclut}
4278 @section haldclut
4279
4280 Apply a Hald CLUT to a video stream.
4281
4282 First input is the video stream to process, and second one is the Hald CLUT.
4283 The Hald CLUT input can be a simple picture or a complete video stream.
4284
4285 The filter accepts the following options:
4286
4287 @table @option
4288 @item shortest
4289 Force termination when the shortest input terminates. Default is @code{0}.
4290 @item repeatlast
4291 Continue applying the last CLUT after the end of the stream. A value of
4292 @code{0} disable the filter after the last frame of the CLUT is reached.
4293 Default is @code{1}.
4294 @end table
4295
4296 @code{haldclut} also has the same interpolation options as @ref{lut3d} (both
4297 filters share the same internals).
4298
4299 More information about the Hald CLUT can be found on Eskil Steenberg's website
4300 (Hald CLUT author) at @url{http://www.quelsolaar.com/technology/clut.html}.
4301
4302 @subsection Workflow examples
4303
4304 @subsubsection Hald CLUT video stream
4305
4306 Generate an identity Hald CLUT stream altered with various effects:
4307 @example
4308 ffmpeg -f lavfi -i @ref{haldclutsrc}=8 -vf "hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process" -t 10 -c:v ffv1 clut.nut
4309 @end example
4310
4311 Note: make sure you use a lossless codec.
4312
4313 Then use it with @code{haldclut} to apply it on some random stream:
4314 @example
4315 ffmpeg -f lavfi -i mandelbrot -i clut.nut -filter_complex '[0][1] haldclut' -t 20 mandelclut.mkv
4316 @end example
4317
4318 The Hald CLUT will be applied to the 10 first seconds (duration of
4319 @file{clut.nut}), then the latest picture of that CLUT stream will be applied
4320 to the remaining frames of the @code{mandelbrot} stream.
4321
4322 @subsubsection Hald CLUT with preview
4323
4324 A Hald CLUT is supposed to be a squared image of @code{Level*Level*Level} by
4325 @code{Level*Level*Level} pixels. For a given Hald CLUT, FFmpeg will select the
4326 biggest possible square starting at the top left of the picture. The remaining
4327 padding pixels (bottom or right) will be ignored. This area can be used to add
4328 a preview of the Hald CLUT.
4329
4330 Typically, the following generated Hald CLUT will be supported by the
4331 @code{haldclut} filter:
4332
4333 @example
4334 ffmpeg -f lavfi -i @ref{haldclutsrc}=8 -vf "
4335    pad=iw+320 [padded_clut];
4336    smptebars=s=320x256, split [a][b];
4337    [padded_clut][a] overlay=W-320:h, curves=color_negative [main];
4338    [main][b] overlay=W-320" -frames:v 1 clut.png
4339 @end example
4340
4341 It contains the original and a preview of the effect of the CLUT: SMPTE color
4342 bars are displayed on the right-top, and below the same color bars processed by
4343 the color changes.
4344
4345 Then, the effect of this Hald CLUT can be visualized with:
4346 @example
4347 ffplay input.mkv -vf "movie=clut.png, [in] haldclut"
4348 @end example
4349
4350 @section hflip
4351
4352 Flip the input video horizontally.
4353
4354 For example to horizontally flip the input video with @command{ffmpeg}:
4355 @example
4356 ffmpeg -i in.avi -vf "hflip" out.avi
4357 @end example
4358
4359 @section histeq
4360 This filter applies a global color histogram equalization on a
4361 per-frame basis.
4362
4363 It can be used to correct video that has a compressed range of pixel
4364 intensities.  The filter redistributes the pixel intensities to
4365 equalize their distribution across the intensity range. It may be
4366 viewed as an "automatically adjusting contrast filter". This filter is
4367 useful only for correcting degraded or poorly captured source
4368 video.
4369
4370 The filter accepts the following options:
4371
4372 @table @option
4373 @item strength
4374 Determine the amount of equalization to be applied.  As the strength
4375 is reduced, the distribution of pixel intensities more-and-more
4376 approaches that of the input frame. The value must be a float number
4377 in the range [0,1] and defaults to 0.200.
4378
4379 @item intensity
4380 Set the maximum intensity that can generated and scale the output
4381 values appropriately.  The strength should be set as desired and then
4382 the intensity can be limited if needed to avoid washing-out. The value
4383 must be a float number in the range [0,1] and defaults to 0.210.
4384
4385 @item antibanding
4386 Set the antibanding level. If enabled the filter will randomly vary
4387 the luminance of output pixels by a small amount to avoid banding of
4388 the histogram. Possible values are @code{none}, @code{weak} or
4389 @code{strong}. It defaults to @code{none}.
4390 @end table
4391
4392 @section histogram
4393
4394 Compute and draw a color distribution histogram for the input video.
4395
4396 The computed histogram is a representation of distribution of color components
4397 in an image.
4398
4399 The filter accepts the following options:
4400
4401 @table @option
4402 @item mode
4403 Set histogram mode.
4404
4405 It accepts the following values:
4406 @table @samp
4407 @item levels
4408 standard histogram that display color components distribution in an image.
4409 Displays color graph for each color component. Shows distribution
4410 of the Y, U, V, A or G, B, R components, depending on input format,
4411 in current frame. Bellow each graph is color component scale meter.
4412
4413 @item color
4414 chroma values in vectorscope, if brighter more such chroma values are
4415 distributed in an image.
4416 Displays chroma values (U/V color placement) in two dimensional graph
4417 (which is called a vectorscope). It can be used to read of the hue and
4418 saturation of the current frame. At a same time it is a histogram.
4419 The whiter a pixel in the vectorscope, the more pixels of the input frame
4420 correspond to that pixel (that is the more pixels have this chroma value).
4421 The V component is displayed on the horizontal (X) axis, with the leftmost
4422 side being V = 0 and the rightmost side being V = 255.
4423 The U component is displayed on the vertical (Y) axis, with the top
4424 representing U = 0 and the bottom representing U = 255.
4425
4426 The position of a white pixel in the graph corresponds to the chroma value
4427 of a pixel of the input clip. So the graph can be used to read of the
4428 hue (color flavor) and the saturation (the dominance of the hue in the color).
4429 As the hue of a color changes, it moves around the square. At the center of
4430 the square, the saturation is zero, which means that the corresponding pixel
4431 has no color. If you increase the amount of a specific color, while leaving
4432 the other colors unchanged, the saturation increases, and you move towards
4433 the edge of the square.
4434
4435 @item color2
4436 chroma values in vectorscope, similar as @code{color} but actual chroma values
4437 are displayed.
4438
4439 @item waveform
4440 per row/column color component graph. In row mode graph in the left side represents
4441 color component value 0 and right side represents value = 255. In column mode top
4442 side represents color component value = 0 and bottom side represents value = 255.
4443 @end table
4444 Default value is @code{levels}.
4445
4446 @item level_height
4447 Set height of level in @code{levels}. Default value is @code{200}.
4448 Allowed range is [50, 2048].
4449
4450 @item scale_height
4451 Set height of color scale in @code{levels}. Default value is @code{12}.
4452 Allowed range is [0, 40].
4453
4454 @item step
4455 Set step for @code{waveform} mode. Smaller values are useful to find out how much
4456 of same luminance values across input rows/columns are distributed.
4457 Default value is @code{10}. Allowed range is [1, 255].
4458
4459 @item waveform_mode
4460 Set mode for @code{waveform}. Can be either @code{row}, or @code{column}.
4461 Default is @code{row}.
4462
4463 @item display_mode
4464 Set display mode for @code{waveform} and @code{levels}.
4465 It accepts the following values:
4466 @table @samp
4467 @item parade
4468 Display separate graph for the color components side by side in
4469 @code{row} waveform mode or one below other in @code{column} waveform mode
4470 for @code{waveform} histogram mode. For @code{levels} histogram mode
4471 per color component graphs are placed one bellow other.
4472
4473 This display mode in @code{waveform} histogram mode makes it easy to spot
4474 color casts in the highlights and shadows of an image, by comparing the
4475 contours of the top and the bottom of each waveform.
4476 Since whites, grays, and blacks are characterized by
4477 exactly equal amounts of red, green, and blue, neutral areas of the
4478 picture should display three waveforms of roughly equal width/height.
4479 If not, the correction is easy to make by making adjustments to level the
4480 three waveforms.
4481
4482 @item overlay
4483 Presents information that's identical to that in the @code{parade}, except
4484 that the graphs representing color components are superimposed directly
4485 over one another.
4486
4487 This display mode in @code{waveform} histogram mode can make it easier to spot
4488 the relative differences or similarities in overlapping areas of the color
4489 components that are supposed to be identical, such as neutral whites, grays,
4490 or blacks.
4491 @end table
4492 Default is @code{parade}.
4493
4494 @item levels_mode
4495 Set mode for @code{levels}. Can be either @code{linear}, or @code{logarithmic}.
4496 Default is @code{linear}.
4497 @end table
4498
4499 @subsection Examples
4500
4501 @itemize
4502
4503 @item
4504 Calculate and draw histogram:
4505 @example
4506 ffplay -i input -vf histogram
4507 @end example
4508
4509 @end itemize
4510
4511 @anchor{hqdn3d}
4512 @section hqdn3d
4513
4514 High precision/quality 3d denoise filter. This filter aims to reduce
4515 image noise producing smooth images and making still images really
4516 still. It should enhance compressibility.
4517
4518 It accepts the following optional parameters:
4519
4520 @table @option
4521 @item luma_spatial
4522 a non-negative float number which specifies spatial luma strength,
4523 defaults to 4.0
4524
4525 @item chroma_spatial
4526 a non-negative float number which specifies spatial chroma strength,
4527 defaults to 3.0*@var{luma_spatial}/4.0
4528
4529 @item luma_tmp
4530 a float number which specifies luma temporal strength, defaults to
4531 6.0*@var{luma_spatial}/4.0
4532
4533 @item chroma_tmp
4534 a float number which specifies chroma temporal strength, defaults to
4535 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
4536 @end table
4537
4538 @section hue
4539
4540 Modify the hue and/or the saturation of the input.
4541
4542 This filter accepts the following options:
4543
4544 @table @option
4545 @item h
4546 Specify the hue angle as a number of degrees. It accepts an expression,
4547 and defaults to "0".
4548
4549 @item s
4550 Specify the saturation in the [-10,10] range. It accepts an expression and
4551 defaults to "1".
4552
4553 @item H
4554 Specify the hue angle as a number of radians. It accepts an
4555 expression, and defaults to "0".
4556 @end table
4557
4558 @option{h} and @option{H} are mutually exclusive, and can't be
4559 specified at the same time.
4560
4561 The @option{h}, @option{H} and @option{s} option values are
4562 expressions containing the following constants:
4563
4564 @table @option
4565 @item n
4566 frame count of the input frame starting from 0
4567
4568 @item pts
4569 presentation timestamp of the input frame expressed in time base units
4570
4571 @item r
4572 frame rate of the input video, NAN if the input frame rate is unknown
4573
4574 @item t
4575 timestamp expressed in seconds, NAN if the input timestamp is unknown
4576
4577 @item tb
4578 time base of the input video
4579 @end table
4580
4581 @subsection Examples
4582
4583 @itemize
4584 @item
4585 Set the hue to 90 degrees and the saturation to 1.0:
4586 @example
4587 hue=h=90:s=1
4588 @end example
4589
4590 @item
4591 Same command but expressing the hue in radians:
4592 @example
4593 hue=H=PI/2:s=1
4594 @end example
4595
4596 @item
4597 Rotate hue and make the saturation swing between 0
4598 and 2 over a period of 1 second:
4599 @example
4600 hue="H=2*PI*t: s=sin(2*PI*t)+1"
4601 @end example
4602
4603 @item
4604 Apply a 3 seconds saturation fade-in effect starting at 0:
4605 @example
4606 hue="s=min(t/3\,1)"
4607 @end example
4608
4609 The general fade-in expression can be written as:
4610 @example
4611 hue="s=min(0\, max((t-START)/DURATION\, 1))"
4612 @end example
4613
4614 @item
4615 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
4616 @example
4617 hue="s=max(0\, min(1\, (8-t)/3))"
4618 @end example
4619
4620 The general fade-out expression can be written as:
4621 @example
4622 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
4623 @end example
4624
4625 @end itemize
4626
4627 @subsection Commands
4628
4629 This filter supports the following commands:
4630 @table @option
4631 @item s
4632 @item h
4633 @item H
4634 Modify the hue and/or the saturation of the input video.
4635 The command accepts the same syntax of the corresponding option.
4636
4637 If the specified expression is not valid, it is kept at its current
4638 value.
4639 @end table
4640
4641 @section idet
4642
4643 Detect video interlacing type.
4644
4645 This filter tries to detect if the input is interlaced or progressive,
4646 top or bottom field first.
4647
4648 The filter accepts the following options:
4649
4650 @table @option
4651 @item intl_thres
4652 Set interlacing threshold.
4653 @item prog_thres
4654 Set progressive threshold.
4655 @end table
4656
4657 @section il
4658
4659 Deinterleave or interleave fields.
4660
4661 This filter allows to process interlaced images fields without
4662 deinterlacing them. Deinterleaving splits the input frame into 2
4663 fields (so called half pictures). Odd lines are moved to the top
4664 half of the output image, even lines to the bottom half.
4665 You can process (filter) them independently and then re-interleave them.
4666
4667 The filter accepts the following options:
4668
4669 @table @option
4670 @item luma_mode, l
4671 @item chroma_mode, c
4672 @item alpha_mode, a
4673 Available values for @var{luma_mode}, @var{chroma_mode} and
4674 @var{alpha_mode} are:
4675
4676 @table @samp
4677 @item none
4678 Do nothing.
4679
4680 @item deinterleave, d
4681 Deinterleave fields, placing one above the other.
4682
4683 @item interleave, i
4684 Interleave fields. Reverse the effect of deinterleaving.
4685 @end table
4686 Default value is @code{none}.
4687
4688 @item luma_swap, ls
4689 @item chroma_swap, cs
4690 @item alpha_swap, as
4691 Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is @code{0}.
4692 @end table
4693
4694 @section interlace
4695
4696 Simple interlacing filter from progressive contents. This interleaves upper (or
4697 lower) lines from odd frames with lower (or upper) lines from even frames,
4698 halving the frame rate and preserving image height.
4699
4700 @example
4701    Original        Original             New Frame
4702    Frame 'j'      Frame 'j+1'             (tff)
4703   ==========      ===========       ==================
4704     Line 0  -------------------->    Frame 'j' Line 0
4705     Line 1          Line 1  ---->   Frame 'j+1' Line 1
4706     Line 2 --------------------->    Frame 'j' Line 2
4707     Line 3          Line 3  ---->   Frame 'j+1' Line 3
4708      ...             ...                   ...
4709 New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
4710 @end example
4711
4712 It accepts the following optional parameters:
4713
4714 @table @option
4715 @item scan
4716 determines whether the interlaced frame is taken from the even (tff - default)
4717 or odd (bff) lines of the progressive frame.
4718
4719 @item lowpass
4720 Enable (default) or disable the vertical lowpass filter to avoid twitter
4721 interlacing and reduce moire patterns.
4722 @end table
4723
4724 @section kerndeint
4725
4726 Deinterlace input video by applying Donald Graft's adaptive kernel
4727 deinterling. Work on interlaced parts of a video to produce
4728 progressive frames.
4729
4730 The description of the accepted parameters follows.
4731
4732 @table @option
4733 @item thresh
4734 Set the threshold which affects the filter's tolerance when
4735 determining if a pixel line must be processed. It must be an integer
4736 in the range [0,255] and defaults to 10. A value of 0 will result in
4737 applying the process on every pixels.
4738
4739 @item map
4740 Paint pixels exceeding the threshold value to white if set to 1.
4741 Default is 0.
4742
4743 @item order
4744 Set the fields order. Swap fields if set to 1, leave fields alone if
4745 0. Default is 0.
4746
4747 @item sharp
4748 Enable additional sharpening if set to 1. Default is 0.
4749
4750 @item twoway
4751 Enable twoway sharpening if set to 1. Default is 0.
4752 @end table
4753
4754 @subsection Examples
4755
4756 @itemize
4757 @item
4758 Apply default values:
4759 @example
4760 kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
4761 @end example
4762
4763 @item
4764 Enable additional sharpening:
4765 @example
4766 kerndeint=sharp=1
4767 @end example
4768
4769 @item
4770 Paint processed pixels in white:
4771 @example
4772 kerndeint=map=1
4773 @end example
4774 @end itemize
4775
4776 @anchor{lut3d}
4777 @section lut3d
4778
4779 Apply a 3D LUT to an input video.
4780
4781 The filter accepts the following options:
4782
4783 @table @option
4784 @item file
4785 Set the 3D LUT file name.
4786
4787 Currently supported formats:
4788 @table @samp
4789 @item 3dl
4790 AfterEffects
4791 @item cube
4792 Iridas
4793 @item dat
4794 DaVinci
4795 @item m3d
4796 Pandora
4797 @end table
4798 @item interp
4799 Select interpolation mode.
4800
4801 Available values are:
4802
4803 @table @samp
4804 @item nearest
4805 Use values from the nearest defined point.
4806 @item trilinear
4807 Interpolate values using the 8 points defining a cube.
4808 @item tetrahedral
4809 Interpolate values using a tetrahedron.
4810 @end table
4811 @end table
4812
4813 @section lut, lutrgb, lutyuv
4814
4815 Compute a look-up table for binding each pixel component input value
4816 to an output value, and apply it to input video.
4817
4818 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
4819 to an RGB input video.
4820
4821 These filters accept the following options:
4822 @table @option
4823 @item c0
4824 set first pixel component expression
4825 @item c1
4826 set second pixel component expression
4827 @item c2
4828 set third pixel component expression
4829 @item c3
4830 set fourth pixel component expression, corresponds to the alpha component
4831
4832 @item r
4833 set red component expression
4834 @item g
4835 set green component expression
4836 @item b
4837 set blue component expression
4838 @item a
4839 alpha component expression
4840
4841 @item y
4842 set Y/luminance component expression
4843 @item u
4844 set U/Cb component expression
4845 @item v
4846 set V/Cr component expression
4847 @end table
4848
4849 Each of them specifies the expression to use for computing the lookup table for
4850 the corresponding pixel component values.
4851
4852 The exact component associated to each of the @var{c*} options depends on the
4853 format in input.
4854
4855 The @var{lut} filter requires either YUV or RGB pixel formats in input,
4856 @var{lutrgb} requires RGB pixel formats in input, and @var{lutyuv} requires YUV.
4857
4858 The expressions can contain the following constants and functions:
4859
4860 @table @option
4861 @item w
4862 @item h
4863 the input width and height
4864
4865 @item val
4866 input value for the pixel component
4867
4868 @item clipval
4869 the input value clipped in the @var{minval}-@var{maxval} range
4870
4871 @item maxval
4872 maximum value for the pixel component
4873
4874 @item minval
4875 minimum value for the pixel component
4876
4877 @item negval
4878 the negated value for the pixel component value clipped in the
4879 @var{minval}-@var{maxval} range , it corresponds to the expression
4880 "maxval-clipval+minval"
4881
4882 @item clip(val)
4883 the computed value in @var{val} clipped in the
4884 @var{minval}-@var{maxval} range
4885
4886 @item gammaval(gamma)
4887 the computed gamma correction value of the pixel component value
4888 clipped in the @var{minval}-@var{maxval} range, corresponds to the
4889 expression
4890 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
4891
4892 @end table
4893
4894 All expressions default to "val".
4895
4896 @subsection Examples
4897
4898 @itemize
4899 @item
4900 Negate input video:
4901 @example
4902 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
4903 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
4904 @end example
4905
4906 The above is the same as:
4907 @example
4908 lutrgb="r=negval:g=negval:b=negval"
4909 lutyuv="y=negval:u=negval:v=negval"
4910 @end example
4911
4912 @item
4913 Negate luminance:
4914 @example
4915 lutyuv=y=negval
4916 @end example
4917
4918 @item
4919 Remove chroma components, turns the video into a graytone image:
4920 @example
4921 lutyuv="u=128:v=128"
4922 @end example
4923
4924 @item
4925 Apply a luma burning effect:
4926 @example
4927 lutyuv="y=2*val"
4928 @end example
4929
4930 @item
4931 Remove green and blue components:
4932 @example
4933 lutrgb="g=0:b=0"
4934 @end example
4935
4936 @item
4937 Set a constant alpha channel value on input:
4938 @example
4939 format=rgba,lutrgb=a="maxval-minval/2"
4940 @end example
4941
4942 @item
4943 Correct luminance gamma by a 0.5 factor:
4944 @example
4945 lutyuv=y=gammaval(0.5)
4946 @end example
4947
4948 @item
4949 Discard least significant bits of luma:
4950 @example
4951 lutyuv=y='bitand(val, 128+64+32)'
4952 @end example
4953 @end itemize
4954
4955 @section mcdeint
4956
4957 Apply motion-compensation deinterlacing.
4958
4959 It needs one field per frame as input and must thus be used together
4960 with yadif=1/3 or equivalent.
4961
4962 This filter accepts the following options:
4963 @table @option
4964 @item mode
4965 Set the deinterlacing mode.
4966
4967 It accepts one of the following values:
4968 @table @samp
4969 @item fast
4970 @item medium
4971 @item slow
4972 use iterative motion estimation
4973 @item extra_slow
4974 like @samp{slow}, but use multiple reference frames.
4975 @end table
4976 Default value is @samp{fast}.
4977
4978 @item parity
4979 Set the picture field parity assumed for the input video. It must be
4980 one of the following values:
4981
4982 @table @samp
4983 @item 0, tff
4984 assume top field first
4985 @item 1, bff
4986 assume bottom field first
4987 @end table
4988
4989 Default value is @samp{bff}.
4990
4991 @item qp
4992 Set per-block quantization parameter (QP) used by the internal
4993 encoder.
4994
4995 Higher values should result in a smoother motion vector field but less
4996 optimal individual vectors. Default value is 1.
4997 @end table
4998
4999 @section mp
5000
5001 Apply an MPlayer filter to the input video.
5002
5003 This filter provides a wrapper around most of the filters of
5004 MPlayer/MEncoder.
5005
5006 This wrapper is considered experimental. Some of the wrapped filters
5007 may not work properly and we may drop support for them, as they will
5008 be implemented natively into FFmpeg. Thus you should avoid
5009 depending on them when writing portable scripts.
5010
5011 The filters accepts the parameters:
5012 @var{filter_name}[:=]@var{filter_params}
5013
5014 @var{filter_name} is the name of a supported MPlayer filter,
5015 @var{filter_params} is a string containing the parameters accepted by
5016 the named filter.
5017
5018 The list of the currently supported filters follows:
5019 @table @var
5020 @item dint
5021 @item eq2
5022 @item eq
5023 @item fil
5024 @item fspp
5025 @item ilpack
5026 @item perspective
5027 @item phase
5028 @item pp7
5029 @item pullup
5030 @item qp
5031 @item softpulldown
5032 @item uspp
5033 @end table
5034
5035 The parameter syntax and behavior for the listed filters are the same
5036 of the corresponding MPlayer filters. For detailed instructions check
5037 the "VIDEO FILTERS" section in the MPlayer manual.
5038
5039 @subsection Examples
5040
5041 @itemize
5042 @item
5043 Adjust gamma, brightness, contrast:
5044 @example
5045 mp=eq2=1.0:2:0.5
5046 @end example
5047 @end itemize
5048
5049 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
5050
5051 @section mpdecimate
5052
5053 Drop frames that do not differ greatly from the previous frame in
5054 order to reduce frame rate.
5055
5056 The main use of this filter is for very-low-bitrate encoding
5057 (e.g. streaming over dialup modem), but it could in theory be used for
5058 fixing movies that were inverse-telecined incorrectly.
5059
5060 A description of the accepted options follows.
5061
5062 @table @option
5063 @item max
5064 Set the maximum number of consecutive frames which can be dropped (if
5065 positive), or the minimum interval between dropped frames (if
5066 negative). If the value is 0, the frame is dropped unregarding the
5067 number of previous sequentially dropped frames.
5068
5069 Default value is 0.
5070
5071 @item hi
5072 @item lo
5073 @item frac
5074 Set the dropping threshold values.
5075
5076 Values for @option{hi} and @option{lo} are for 8x8 pixel blocks and
5077 represent actual pixel value differences, so a threshold of 64
5078 corresponds to 1 unit of difference for each pixel, or the same spread
5079 out differently over the block.
5080
5081 A frame is a candidate for dropping if no 8x8 blocks differ by more
5082 than a threshold of @option{hi}, and if no more than @option{frac} blocks (1
5083 meaning the whole image) differ by more than a threshold of @option{lo}.
5084
5085 Default value for @option{hi} is 64*12, default value for @option{lo} is
5086 64*5, and default value for @option{frac} is 0.33.
5087 @end table
5088
5089
5090 @section negate
5091
5092 Negate input video.
5093
5094 This filter accepts an integer in input, if non-zero it negates the
5095 alpha component (if available). The default value in input is 0.
5096
5097 @section noformat
5098
5099 Force libavfilter not to use any of the specified pixel formats for the
5100 input to the next filter.
5101
5102 This filter accepts the following parameters:
5103 @table @option
5104
5105 @item pix_fmts
5106 A '|'-separated list of pixel format names, for example
5107 "pix_fmts=yuv420p|monow|rgb24".
5108
5109 @end table
5110
5111 @subsection Examples
5112
5113 @itemize
5114 @item
5115 Force libavfilter to use a format different from @var{yuv420p} for the
5116 input to the vflip filter:
5117 @example
5118 noformat=pix_fmts=yuv420p,vflip
5119 @end example
5120
5121 @item
5122 Convert the input video to any of the formats not contained in the list:
5123 @example
5124 noformat=yuv420p|yuv444p|yuv410p
5125 @end example
5126 @end itemize
5127
5128 @section noise
5129
5130 Add noise on video input frame.
5131
5132 The filter accepts the following options:
5133
5134 @table @option
5135 @item all_seed
5136 @item c0_seed
5137 @item c1_seed
5138 @item c2_seed
5139 @item c3_seed
5140 Set noise seed for specific pixel component or all pixel components in case
5141 of @var{all_seed}. Default value is @code{123457}.
5142
5143 @item all_strength, alls
5144 @item c0_strength, c0s
5145 @item c1_strength, c1s
5146 @item c2_strength, c2s
5147 @item c3_strength, c3s</