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