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