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