5bdd745fd7ba76f56e0fb3133a570f018608e83a
[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 pts
2087 The timestamp of the current frame, in seconds, with microsecond accuracy.
2088
2089 @end table
2090
2091 @subsection Examples
2092
2093 Some examples follow.
2094
2095 @itemize
2096
2097 @item
2098 Draw "Test Text" with font FreeSerif, using the default values for the
2099 optional parameters.
2100
2101 @example
2102 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
2103 @end example
2104
2105 @item
2106 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
2107 and y=50 (counting from the top-left corner of the screen), text is
2108 yellow with a red box around it. Both the text and the box have an
2109 opacity of 20%.
2110
2111 @example
2112 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
2113           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
2114 @end example
2115
2116 Note that the double quotes are not necessary if spaces are not used
2117 within the parameter list.
2118
2119 @item
2120 Show the text at the center of the video frame:
2121 @example
2122 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
2123 @end example
2124
2125 @item
2126 Show a text line sliding from right to left in the last row of the video
2127 frame. The file @file{LONG_LINE} is assumed to contain a single line
2128 with no newlines.
2129 @example
2130 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
2131 @end example
2132
2133 @item
2134 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
2135 @example
2136 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
2137 @end example
2138
2139 @item
2140 Draw a single green letter "g", at the center of the input video.
2141 The glyph baseline is placed at half screen height.
2142 @example
2143 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
2144 @end example
2145
2146 @item
2147 Show text for 1 second every 3 seconds:
2148 @example
2149 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
2150 @end example
2151
2152 @item
2153 Use fontconfig to set the font. Note that the colons need to be escaped.
2154 @example
2155 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
2156 @end example
2157
2158 @item
2159 Print the date of a real-time encoding (see strftime(3)):
2160 @example
2161 drawtext='fontfile=FreeSans.ttf:expansion=normal:text=%@{localtime:%a %b %d %Y@}'
2162 @end example
2163
2164 @end itemize
2165
2166 For more information about libfreetype, check:
2167 @url{http://www.freetype.org/}.
2168
2169 For more information about fontconfig, check:
2170 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
2171
2172 @section edgedetect
2173
2174 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
2175
2176 This filter accepts the following optional named parameters:
2177
2178 @table @option
2179 @item low, high
2180 Set low and high threshold values used by the Canny thresholding
2181 algorithm.
2182
2183 The high threshold selects the "strong" edge pixels, which are then
2184 connected through 8-connectivity with the "weak" edge pixels selected
2185 by the low threshold.
2186
2187 @var{low} and @var{high} threshold values must be choosen in the range
2188 [0,1], and @var{low} should be lesser or equal to @var{high}.
2189
2190 Default value for @var{low} is @code{20/255}, and default value for @var{high}
2191 is @code{50/255}.
2192 @end table
2193
2194 Example:
2195 @example
2196 edgedetect=low=0.1:high=0.4
2197 @end example
2198
2199 @section fade
2200
2201 Apply fade-in/out effect to input video.
2202
2203 It accepts the parameters:
2204 @var{type}:@var{start_frame}:@var{nb_frames}[:@var{options}]
2205
2206 @var{type} specifies if the effect type, can be either "in" for
2207 fade-in, or "out" for a fade-out effect.
2208
2209 @var{start_frame} specifies the number of the start frame for starting
2210 to apply the fade effect.
2211
2212 @var{nb_frames} specifies the number of frames for which the fade
2213 effect has to last. At the end of the fade-in effect the output video
2214 will have the same intensity as the input video, at the end of the
2215 fade-out transition the output video will be completely black.
2216
2217 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
2218 separated by ":". The description of the accepted options follows.
2219
2220 @table @option
2221
2222 @item type, t
2223 See @var{type}.
2224
2225 @item start_frame, s
2226 See @var{start_frame}.
2227
2228 @item nb_frames, n
2229 See @var{nb_frames}.
2230
2231 @item alpha
2232 If set to 1, fade only alpha channel, if one exists on the input.
2233 Default value is 0.
2234 @end table
2235
2236 A few usage examples follow, usable too as test scenarios.
2237 @example
2238 # fade in first 30 frames of video
2239 fade=in:0:30
2240
2241 # fade out last 45 frames of a 200-frame video
2242 fade=out:155:45
2243
2244 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
2245 fade=in:0:25, fade=out:975:25
2246
2247 # make first 5 frames black, then fade in from frame 5-24
2248 fade=in:5:20
2249
2250 # fade in alpha over first 25 frames of video
2251 fade=in:0:25:alpha=1
2252 @end example
2253
2254 @section field
2255
2256 Extract a single field from an interlaced image using stride
2257 arithmetic to avoid wasting CPU time. The output frames are marked as
2258 non-interlaced.
2259
2260 This filter accepts the following named options:
2261 @table @option
2262 @item type
2263 Specify whether to extract the top (if the value is @code{0} or
2264 @code{top}) or the bottom field (if the value is @code{1} or
2265 @code{bottom}).
2266 @end table
2267
2268 If the option key is not specified, the first value sets the @var{type}
2269 option. For example:
2270 @example
2271 field=bottom
2272 @end example
2273
2274 is equivalent to:
2275 @example
2276 field=type=bottom
2277 @end example
2278
2279 @section fieldorder
2280
2281 Transform the field order of the input video.
2282
2283 It accepts one parameter which specifies the required field order that
2284 the input interlaced video will be transformed to. The parameter can
2285 assume one of the following values:
2286
2287 @table @option
2288 @item 0 or bff
2289 output bottom field first
2290 @item 1 or tff
2291 output top field first
2292 @end table
2293
2294 Default value is "tff".
2295
2296 Transformation is achieved by shifting the picture content up or down
2297 by one line, and filling the remaining line with appropriate picture content.
2298 This method is consistent with most broadcast field order converters.
2299
2300 If the input video is not flagged as being interlaced, or it is already
2301 flagged as being of the required output field order then this filter does
2302 not alter the incoming video.
2303
2304 This filter is very useful when converting to or from PAL DV material,
2305 which is bottom field first.
2306
2307 For example:
2308 @example
2309 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
2310 @end example
2311
2312 @section fifo
2313
2314 Buffer input images and send them when they are requested.
2315
2316 This filter is mainly useful when auto-inserted by the libavfilter
2317 framework.
2318
2319 The filter does not take parameters.
2320
2321 @section format
2322
2323 Convert the input video to one of the specified pixel formats.
2324 Libavfilter will try to pick one that is supported for the input to
2325 the next filter.
2326
2327 The filter accepts a list of pixel format names, separated by ":",
2328 for example "yuv420p:monow:rgb24".
2329
2330 Some examples follow:
2331 @example
2332 # convert the input video to the format "yuv420p"
2333 format=yuv420p
2334
2335 # convert the input video to any of the formats in the list
2336 format=yuv420p:yuv444p:yuv410p
2337 @end example
2338
2339 @section fps
2340
2341 Convert the video to specified constant framerate by duplicating or dropping
2342 frames as necessary.
2343
2344 This filter accepts the following named parameters:
2345 @table @option
2346
2347 @item fps
2348 Desired output framerate.
2349
2350 @item round
2351 Rounding method. The default is @code{near}.
2352
2353 @end table
2354
2355 @section framestep
2356
2357 Select one frame every N.
2358
2359 This filter accepts in input a string representing a positive
2360 integer. Default argument is @code{1}.
2361
2362 @anchor{frei0r}
2363 @section frei0r
2364
2365 Apply a frei0r effect to the input video.
2366
2367 To enable compilation of this filter you need to install the frei0r
2368 header and configure FFmpeg with @code{--enable-frei0r}.
2369
2370 The filter supports the syntax:
2371 @example
2372 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
2373 @end example
2374
2375 @var{filter_name} is the name of the frei0r effect to load. If the
2376 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
2377 is searched in each one of the directories specified by the colon (or
2378 semicolon on Windows platforms) separated list in @env{FREIOR_PATH},
2379 otherwise in the standard frei0r paths, which are in this order:
2380 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
2381 @file{/usr/lib/frei0r-1/}.
2382
2383 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
2384 for the frei0r effect.
2385
2386 A frei0r effect parameter can be a boolean (whose values are specified
2387 with "y" and "n"), a double, a color (specified by the syntax
2388 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
2389 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
2390 description), a position (specified by the syntax @var{X}/@var{Y},
2391 @var{X} and @var{Y} being float numbers) and a string.
2392
2393 The number and kind of parameters depend on the loaded effect. If an
2394 effect parameter is not specified the default value is set.
2395
2396 Some examples follow:
2397
2398 @itemize
2399 @item
2400 Apply the distort0r effect, set the first two double parameters:
2401 @example
2402 frei0r=distort0r:0.5:0.01
2403 @end example
2404
2405 @item
2406 Apply the colordistance effect, take a color as first parameter:
2407 @example
2408 frei0r=colordistance:0.2/0.3/0.4
2409 frei0r=colordistance:violet
2410 frei0r=colordistance:0x112233
2411 @end example
2412
2413 @item
2414 Apply the perspective effect, specify the top left and top right image
2415 positions:
2416 @example
2417 frei0r=perspective:0.2/0.2:0.8/0.2
2418 @end example
2419 @end itemize
2420
2421 For more information see:
2422 @url{http://frei0r.dyne.org}
2423
2424 @section geq
2425
2426 The filter takes one, two or three equations as parameter, separated by ':'.
2427 The first equation is mandatory and applies to the luma plane. The two
2428 following are respectively for chroma blue and chroma red planes.
2429
2430 The filter syntax allows named parameters:
2431
2432 @table @option
2433 @item lum_expr
2434 the luminance expression
2435 @item cb_expr
2436 the chrominance blue expression
2437 @item cr_expr
2438 the chrominance red expression
2439 @end table
2440
2441 If one of the chrominance expression is not defined, it falls back on the other
2442 one. If none of them are specified, they will evaluate the luminance
2443 expression.
2444
2445 The expressions can use the following variables and functions:
2446
2447 @table @option
2448 @item N
2449 The sequential number of the filtered frame, starting from @code{0}.
2450
2451 @item X, Y
2452 The coordinates of the current sample.
2453
2454 @item W, H
2455 The width and height of the image.
2456
2457 @item SW, SH
2458 Width and height scale depending on the currently filtered plane. It is the
2459 ratio between the corresponding luma plane number of pixels and the current
2460 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
2461 @code{0.5,0.5} for chroma planes.
2462
2463 @item p(x, y)
2464 Return the value of the pixel at location (@var{x},@var{y}) of the current
2465 plane.
2466
2467 @item lum(x, y)
2468 Return the value of the pixel at location (@var{x},@var{y}) of the luminance
2469 plane.
2470
2471 @item cb(x, y)
2472 Return the value of the pixel at location (@var{x},@var{y}) of the
2473 blue-difference chroma plane.
2474
2475 @item cr(x, y)
2476 Return the value of the pixel at location (@var{x},@var{y}) of the
2477 red-difference chroma plane.
2478 @end table
2479
2480 For functions, if @var{x} and @var{y} are outside the area, the value will be
2481 automatically clipped to the closer edge.
2482
2483 Some examples follow:
2484
2485 @itemize
2486 @item
2487 Flip the image horizontally:
2488 @example
2489 geq=p(W-X\,Y)
2490 @end example
2491
2492 @item
2493 Generate a fancy enigmatic moving light:
2494 @example
2495 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
2496 @end example
2497 @end itemize
2498
2499 @section gradfun
2500
2501 Fix the banding artifacts that are sometimes introduced into nearly flat
2502 regions by truncation to 8bit color depth.
2503 Interpolate the gradients that should go where the bands are, and
2504 dither them.
2505
2506 This filter is designed for playback only.  Do not use it prior to
2507 lossy compression, because compression tends to lose the dither and
2508 bring back the bands.
2509
2510 The filter takes two optional parameters, separated by ':':
2511 @var{strength}:@var{radius}
2512
2513 @var{strength} is the maximum amount by which the filter will change
2514 any one pixel. Also the threshold for detecting nearly flat
2515 regions. Acceptable values range from .51 to 255, default value is
2516 1.2, out-of-range values will be clipped to the valid range.
2517
2518 @var{radius} is the neighborhood to fit the gradient to. A larger
2519 radius makes for smoother gradients, but also prevents the filter from
2520 modifying the pixels near detailed regions. Acceptable values are
2521 8-32, default value is 16, out-of-range values will be clipped to the
2522 valid range.
2523
2524 @example
2525 # default parameters
2526 gradfun=1.2:16
2527
2528 # omitting radius
2529 gradfun=1.2
2530 @end example
2531
2532 @section hflip
2533
2534 Flip the input video horizontally.
2535
2536 For example to horizontally flip the input video with @command{ffmpeg}:
2537 @example
2538 ffmpeg -i in.avi -vf "hflip" out.avi
2539 @end example
2540
2541 @section hqdn3d
2542
2543 High precision/quality 3d denoise filter. This filter aims to reduce
2544 image noise producing smooth images and making still images really
2545 still. It should enhance compressibility.
2546
2547 It accepts the following optional parameters:
2548 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
2549
2550 @table @option
2551 @item luma_spatial
2552 a non-negative float number which specifies spatial luma strength,
2553 defaults to 4.0
2554
2555 @item chroma_spatial
2556 a non-negative float number which specifies spatial chroma strength,
2557 defaults to 3.0*@var{luma_spatial}/4.0
2558
2559 @item luma_tmp
2560 a float number which specifies luma temporal strength, defaults to
2561 6.0*@var{luma_spatial}/4.0
2562
2563 @item chroma_tmp
2564 a float number which specifies chroma temporal strength, defaults to
2565 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
2566 @end table
2567
2568 @section hue
2569
2570 Modify the hue and/or the saturation of the input.
2571
2572 This filter accepts the following optional named options:
2573
2574 @table @option
2575 @item h
2576 Specify the hue angle as a number of degrees. It accepts a float
2577 number or an expression, and defaults to 0.0.
2578
2579 @item H
2580 Specify the hue angle as a number of degrees. It accepts a float
2581 number or an expression, and defaults to 0.0.
2582
2583 @item s
2584 Specify the saturation in the [-10,10] range. It accepts a float number and
2585 defaults to 1.0.
2586 @end table
2587
2588 The @var{h}, @var{H} and @var{s} parameters are expressions containing the
2589 following constants:
2590
2591 @table @option
2592 @item n
2593 frame count of the input frame starting from 0
2594
2595 @item pts
2596 presentation timestamp of the input frame expressed in time base units
2597
2598 @item r
2599 frame rate of the input video, NAN if the input frame rate is unknown
2600
2601 @item t
2602 timestamp expressed in seconds, NAN if the input timestamp is unknown
2603
2604 @item tb
2605 time base of the input video
2606 @end table
2607
2608 The options can also be set using the syntax: @var{hue}:@var{saturation}
2609
2610 In this case @var{hue} is expressed in degrees.
2611
2612 Some examples follow:
2613 @itemize
2614 @item
2615 Set the hue to 90 degrees and the saturation to 1.0:
2616 @example
2617 hue=h=90:s=1
2618 @end example
2619
2620 @item
2621 Same command but expressing the hue in radians:
2622 @example
2623 hue=H=PI/2:s=1
2624 @end example
2625
2626 @item
2627 Same command without named options, hue must be expressed in degrees:
2628 @example
2629 hue=90:1
2630 @end example
2631
2632 @item
2633 Note that "h:s" syntax does not support expressions for the values of
2634 h and s, so the following example will issue an error:
2635 @example
2636 hue=PI/2:1
2637 @end example
2638
2639 @item
2640 Rotate hue and make the saturation swing between 0
2641 and 2 over a period of 1 second:
2642 @example
2643 hue="H=2*PI*t: s=sin(2*PI*t)+1"
2644 @end example
2645
2646 @item
2647 Apply a 3 seconds saturation fade-in effect starting at 0:
2648 @example
2649 hue="s=min(t/3\,1)"
2650 @end example
2651
2652 The general fade-in expression can be written as:
2653 @example
2654 hue="s=min(0\, max((t-START)/DURATION\, 1))"
2655 @end example
2656
2657 @item
2658 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
2659 @example
2660 hue="s=max(0\, min(1\, (8-t)/3))"
2661 @end example
2662
2663 The general fade-out expression can be written as:
2664 @example
2665 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
2666 @end example
2667
2668 @end itemize
2669
2670 @subsection Commands
2671
2672 This filter supports the following command:
2673 @table @option
2674 @item reinit
2675 Modify the hue and/or the saturation of the input video.
2676 The command accepts the same named options and syntax than when calling the
2677 filter from the command-line.
2678
2679 If a parameter is omitted, it is kept at its current value.
2680 @end table
2681
2682 @section idet
2683
2684 Interlaceing detect filter. This filter tries to detect if the input is
2685 interlaced or progressive. Top or bottom field first.
2686
2687 @section lut, lutrgb, lutyuv
2688
2689 Compute a look-up table for binding each pixel component input value
2690 to an output value, and apply it to input video.
2691
2692 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
2693 to an RGB input video.
2694
2695 These filters accept in input a ":"-separated list of options, which
2696 specify the expressions used for computing the lookup table for the
2697 corresponding pixel component values.
2698
2699 The @var{lut} filter requires either YUV or RGB pixel formats in
2700 input, and accepts the options:
2701 @table @option
2702 @item @var{c0} (first  pixel component)
2703 @item @var{c1} (second pixel component)
2704 @item @var{c2} (third  pixel component)
2705 @item @var{c3} (fourth pixel component, corresponds to the alpha component)
2706 @end table
2707
2708 The exact component associated to each option depends on the format in
2709 input.
2710
2711 The @var{lutrgb} filter requires RGB pixel formats in input, and
2712 accepts the options:
2713 @table @option
2714 @item @var{r} (red component)
2715 @item @var{g} (green component)
2716 @item @var{b} (blue component)
2717 @item @var{a} (alpha component)
2718 @end table
2719
2720 The @var{lutyuv} filter requires YUV pixel formats in input, and
2721 accepts the options:
2722 @table @option
2723 @item @var{y} (Y/luminance component)
2724 @item @var{u} (U/Cb component)
2725 @item @var{v} (V/Cr component)
2726 @item @var{a} (alpha component)
2727 @end table
2728
2729 The expressions can contain the following constants and functions:
2730
2731 @table @option
2732 @item w, h
2733 the input width and height
2734
2735 @item val
2736 input value for the pixel component
2737
2738 @item clipval
2739 the input value clipped in the @var{minval}-@var{maxval} range
2740
2741 @item maxval
2742 maximum value for the pixel component
2743
2744 @item minval
2745 minimum value for the pixel component
2746
2747 @item negval
2748 the negated value for the pixel component value clipped in the
2749 @var{minval}-@var{maxval} range , it corresponds to the expression
2750 "maxval-clipval+minval"
2751
2752 @item clip(val)
2753 the computed value in @var{val} clipped in the
2754 @var{minval}-@var{maxval} range
2755
2756 @item gammaval(gamma)
2757 the computed gamma correction value of the pixel component value
2758 clipped in the @var{minval}-@var{maxval} range, corresponds to the
2759 expression
2760 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
2761
2762 @end table
2763
2764 All expressions default to "val".
2765
2766 Some examples follow:
2767 @example
2768 # negate input video
2769 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
2770 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
2771
2772 # the above is the same as
2773 lutrgb="r=negval:g=negval:b=negval"
2774 lutyuv="y=negval:u=negval:v=negval"
2775
2776 # negate luminance
2777 lutyuv=y=negval
2778
2779 # remove chroma components, turns the video into a graytone image
2780 lutyuv="u=128:v=128"
2781
2782 # apply a luma burning effect
2783 lutyuv="y=2*val"
2784
2785 # remove green and blue components
2786 lutrgb="g=0:b=0"
2787
2788 # set a constant alpha channel value on input
2789 format=rgba,lutrgb=a="maxval-minval/2"
2790
2791 # correct luminance gamma by a 0.5 factor
2792 lutyuv=y=gammaval(0.5)
2793 @end example
2794
2795 @section mp
2796
2797 Apply an MPlayer filter to the input video.
2798
2799 This filter provides a wrapper around most of the filters of
2800 MPlayer/MEncoder.
2801
2802 This wrapper is considered experimental. Some of the wrapped filters
2803 may not work properly and we may drop support for them, as they will
2804 be implemented natively into FFmpeg. Thus you should avoid
2805 depending on them when writing portable scripts.
2806
2807 The filters accepts the parameters:
2808 @var{filter_name}[:=]@var{filter_params}
2809
2810 @var{filter_name} is the name of a supported MPlayer filter,
2811 @var{filter_params} is a string containing the parameters accepted by
2812 the named filter.
2813
2814 The list of the currently supported filters follows:
2815 @table @var
2816 @item denoise3d
2817 @item detc
2818 @item dint
2819 @item divtc
2820 @item down3dright
2821 @item dsize
2822 @item eq2
2823 @item eq
2824 @item fil
2825 @item fspp
2826 @item harddup
2827 @item il
2828 @item ilpack
2829 @item ivtc
2830 @item kerndeint
2831 @item mcdeint
2832 @item noise
2833 @item ow
2834 @item perspective
2835 @item phase
2836 @item pp7
2837 @item pullup
2838 @item qp
2839 @item sab
2840 @item softpulldown
2841 @item softskip
2842 @item spp
2843 @item telecine
2844 @item tinterlace
2845 @item unsharp
2846 @item uspp
2847 @end table
2848
2849 The parameter syntax and behavior for the listed filters are the same
2850 of the corresponding MPlayer filters. For detailed instructions check
2851 the "VIDEO FILTERS" section in the MPlayer manual.
2852
2853 Some examples follow:
2854 @itemize
2855 @item
2856 Adjust gamma, brightness, contrast:
2857 @example
2858 mp=eq2=1.0:2:0.5
2859 @end example
2860
2861 @item
2862 Add temporal noise to input video:
2863 @example
2864 mp=noise=20t
2865 @end example
2866 @end itemize
2867
2868 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
2869
2870 @section negate
2871
2872 Negate input video.
2873
2874 This filter accepts an integer in input, if non-zero it negates the
2875 alpha component (if available). The default value in input is 0.
2876
2877 @section noformat
2878
2879 Force libavfilter not to use any of the specified pixel formats for the
2880 input to the next filter.
2881
2882 The filter accepts a list of pixel format names, separated by ":",
2883 for example "yuv420p:monow:rgb24".
2884
2885 Some examples follow:
2886 @example
2887 # force libavfilter to use a format different from "yuv420p" for the
2888 # input to the vflip filter
2889 noformat=yuv420p,vflip
2890
2891 # convert the input video to any of the formats not contained in the list
2892 noformat=yuv420p:yuv444p:yuv410p
2893 @end example
2894
2895 @section null
2896
2897 Pass the video source unchanged to the output.
2898
2899 @section ocv
2900
2901 Apply video transform using libopencv.
2902
2903 To enable this filter install libopencv library and headers and
2904 configure FFmpeg with @code{--enable-libopencv}.
2905
2906 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
2907
2908 @var{filter_name} is the name of the libopencv filter to apply.
2909
2910 @var{filter_params} specifies the parameters to pass to the libopencv
2911 filter. If not specified the default values are assumed.
2912
2913 Refer to the official libopencv documentation for more precise
2914 information:
2915 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
2916
2917 Follows the list of supported libopencv filters.
2918
2919 @anchor{dilate}
2920 @subsection dilate
2921
2922 Dilate an image by using a specific structuring element.
2923 This filter corresponds to the libopencv function @code{cvDilate}.
2924
2925 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
2926
2927 @var{struct_el} represents a structuring element, and has the syntax:
2928 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
2929
2930 @var{cols} and @var{rows} represent the number of columns and rows of
2931 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
2932 point, and @var{shape} the shape for the structuring element, and
2933 can be one of the values "rect", "cross", "ellipse", "custom".
2934
2935 If the value for @var{shape} is "custom", it must be followed by a
2936 string of the form "=@var{filename}". The file with name
2937 @var{filename} is assumed to represent a binary image, with each
2938 printable character corresponding to a bright pixel. When a custom
2939 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
2940 or columns and rows of the read file are assumed instead.
2941
2942 The default value for @var{struct_el} is "3x3+0x0/rect".
2943
2944 @var{nb_iterations} specifies the number of times the transform is
2945 applied to the image, and defaults to 1.
2946
2947 Follow some example:
2948 @example
2949 # use the default values
2950 ocv=dilate
2951
2952 # dilate using a structuring element with a 5x5 cross, iterate two times
2953 ocv=dilate=5x5+2x2/cross:2
2954
2955 # read the shape from the file diamond.shape, iterate two times
2956 # the file diamond.shape may contain a pattern of characters like this:
2957 #   *
2958 #  ***
2959 # *****
2960 #  ***
2961 #   *
2962 # the specified cols and rows are ignored (but not the anchor point coordinates)
2963 ocv=0x0+2x2/custom=diamond.shape:2
2964 @end example
2965
2966 @subsection erode
2967
2968 Erode an image by using a specific structuring element.
2969 This filter corresponds to the libopencv function @code{cvErode}.
2970
2971 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
2972 with the same syntax and semantics as the @ref{dilate} filter.
2973
2974 @subsection smooth
2975
2976 Smooth the input video.
2977
2978 The filter takes the following parameters:
2979 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
2980
2981 @var{type} is the type of smooth filter to apply, and can be one of
2982 the following values: "blur", "blur_no_scale", "median", "gaussian",
2983 "bilateral". The default value is "gaussian".
2984
2985 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
2986 parameters whose meanings depend on smooth type. @var{param1} and
2987 @var{param2} accept integer positive values or 0, @var{param3} and
2988 @var{param4} accept float values.
2989
2990 The default value for @var{param1} is 3, the default value for the
2991 other parameters is 0.
2992
2993 These parameters correspond to the parameters assigned to the
2994 libopencv function @code{cvSmooth}.
2995
2996 @anchor{overlay}
2997 @section overlay
2998
2999 Overlay one video on top of another.
3000
3001 It takes two inputs and one output, the first input is the "main"
3002 video on which the second input is overlayed.
3003
3004 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
3005
3006 @var{x} is the x coordinate of the overlayed video on the main video,
3007 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
3008 the following parameters:
3009
3010 @table @option
3011 @item main_w, main_h
3012 main input width and height
3013
3014 @item W, H
3015 same as @var{main_w} and @var{main_h}
3016
3017 @item overlay_w, overlay_h
3018 overlay input width and height
3019
3020 @item w, h
3021 same as @var{overlay_w} and @var{overlay_h}
3022 @end table
3023
3024 @var{options} is an optional list of @var{key}=@var{value} pairs,
3025 separated by ":".
3026
3027 The description of the accepted options follows.
3028
3029 @table @option
3030 @item rgb
3031 If set to 1, force the filter to accept inputs in the RGB
3032 color space. Default value is 0.
3033 @end table
3034
3035 Be aware that frames are taken from each input video in timestamp
3036 order, hence, if their initial timestamps differ, it is a a good idea
3037 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
3038 have them begin in the same zero timestamp, as it does the example for
3039 the @var{movie} filter.
3040
3041 Follow some examples:
3042 @example
3043 # draw the overlay at 10 pixels from the bottom right
3044 # corner of the main video.
3045 overlay=main_w-overlay_w-10:main_h-overlay_h-10
3046
3047 # insert a transparent PNG logo in the bottom left corner of the input
3048 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
3049
3050 # insert 2 different transparent PNG logos (second logo on bottom
3051 # right corner):
3052 ffmpeg -i input -i logo1 -i logo2 -filter_complex
3053 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
3054
3055 # add a transparent color layer on top of the main video,
3056 # WxH specifies the size of the main input to the overlay filter
3057 color=red@@.3:WxH [over]; [in][over] overlay [out]
3058
3059 # play an original video and a filtered version (here with the deshake filter)
3060 # side by side
3061 ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
3062
3063 # the previous example is the same as:
3064 ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
3065 @end example
3066
3067 You can chain together more overlays but the efficiency of such
3068 approach is yet to be tested.
3069
3070 @section pad
3071
3072 Add paddings to the input image, and places the original input at the
3073 given coordinates @var{x}, @var{y}.
3074
3075 It accepts the following parameters:
3076 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
3077
3078 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
3079 expressions containing the following constants:
3080
3081 @table @option
3082 @item in_w, in_h
3083 the input video width and height
3084
3085 @item iw, ih
3086 same as @var{in_w} and @var{in_h}
3087
3088 @item out_w, out_h
3089 the output width and height, that is the size of the padded area as
3090 specified by the @var{width} and @var{height} expressions
3091
3092 @item ow, oh
3093 same as @var{out_w} and @var{out_h}
3094
3095 @item x, y
3096 x and y offsets as specified by the @var{x} and @var{y}
3097 expressions, or NAN if not yet specified
3098
3099 @item a
3100 same as @var{iw} / @var{ih}
3101
3102 @item sar
3103 input sample aspect ratio
3104
3105 @item dar
3106 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
3107
3108 @item hsub, vsub
3109 horizontal and vertical chroma subsample values. For example for the
3110 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3111 @end table
3112
3113 Follows the description of the accepted parameters.
3114
3115 @table @option
3116 @item width, height
3117
3118 Specify the size of the output image with the paddings added. If the
3119 value for @var{width} or @var{height} is 0, the corresponding input size
3120 is used for the output.
3121
3122 The @var{width} expression can reference the value set by the
3123 @var{height} expression, and vice versa.
3124
3125 The default value of @var{width} and @var{height} is 0.
3126
3127 @item x, y
3128
3129 Specify the offsets where to place the input image in the padded area
3130 with respect to the top/left border of the output image.
3131
3132 The @var{x} expression can reference the value set by the @var{y}
3133 expression, and vice versa.
3134
3135 The default value of @var{x} and @var{y} is 0.
3136
3137 @item color
3138
3139 Specify the color of the padded area, it can be the name of a color
3140 (case insensitive match) or a 0xRRGGBB[AA] sequence.
3141
3142 The default value of @var{color} is "black".
3143
3144 @end table
3145
3146 @subsection Examples
3147
3148 @itemize
3149 @item
3150 Add paddings with color "violet" to the input video. Output video
3151 size is 640x480, the top-left corner of the input video is placed at
3152 column 0, row 40:
3153 @example
3154 pad=640:480:0:40:violet
3155 @end example
3156
3157 @item
3158 Pad the input to get an output with dimensions increased by 3/2,
3159 and put the input video at the center of the padded area:
3160 @example
3161 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
3162 @end example
3163
3164 @item
3165 Pad the input to get a squared output with size equal to the maximum
3166 value between the input width and height, and put the input video at
3167 the center of the padded area:
3168 @example
3169 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
3170 @end example
3171
3172 @item
3173 Pad the input to get a final w/h ratio of 16:9:
3174 @example
3175 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
3176 @end example
3177
3178 @item
3179 In case of anamorphic video, in order to set the output display aspect
3180 correctly, it is necessary to use @var{sar} in the expression,
3181 according to the relation:
3182 @example
3183 (ih * X / ih) * sar = output_dar
3184 X = output_dar / sar
3185 @end example
3186
3187 Thus the previous example needs to be modified to:
3188 @example
3189 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
3190 @end example
3191
3192 @item
3193 Double output size and put the input video in the bottom-right
3194 corner of the output padded area:
3195 @example
3196 pad="2*iw:2*ih:ow-iw:oh-ih"
3197 @end example
3198 @end itemize
3199
3200 @section pixdesctest
3201
3202 Pixel format descriptor test filter, mainly useful for internal
3203 testing. The output video should be equal to the input video.
3204
3205 For example:
3206 @example
3207 format=monow, pixdesctest
3208 @end example
3209
3210 can be used to test the monowhite pixel format descriptor definition.
3211
3212 @section removelogo
3213
3214 Suppress a TV station logo, using an image file to determine which
3215 pixels comprise the logo. It works by filling in the pixels that
3216 comprise the logo with neighboring pixels.
3217
3218 This filter requires one argument which specifies the filter bitmap
3219 file, which can be any image format supported by libavformat. The
3220 width and height of the image file must match those of the video
3221 stream being processed.
3222
3223 Pixels in the provided bitmap image with a value of zero are not
3224 considered part of the logo, non-zero pixels are considered part of
3225 the logo. If you use white (255) for the logo and black (0) for the
3226 rest, you will be safe. For making the filter bitmap, it is
3227 recommended to take a screen capture of a black frame with the logo
3228 visible, and then using a threshold filter followed by the erode
3229 filter once or twice.
3230
3231 If needed, little splotches can be fixed manually. Remember that if
3232 logo pixels are not covered, the filter quality will be much
3233 reduced. Marking too many pixels as part of the logo does not hurt as
3234 much, but it will increase the amount of blurring needed to cover over
3235 the image and will destroy more information than necessary, and extra
3236 pixels will slow things down on a large logo.
3237
3238 @section scale
3239
3240 Scale (resize) the input video, using the libswscale library.
3241
3242 The scale filter forces the output display aspect ratio to be the same
3243 of the input, by changing the output sample aspect ratio.
3244
3245 This filter accepts a list of named options in the form of
3246 @var{key}=@var{value} pairs separated by ":". If the key for the first
3247 two options is not specified, the assumed keys for the first two
3248 values are @code{w} and @code{h}. If the first option has no key and
3249 can be interpreted like a video size specification, it will be used
3250 to set the video size.
3251
3252 A description of the accepted options follows.
3253
3254 @table @option
3255 @item width, w
3256 Set the video width expression, default value is @code{iw}. See below
3257 for the list of accepted constants.
3258
3259 @item height, h
3260 Set the video heiht expression, default value is @code{ih}.
3261 See below for the list of accepted constants.
3262
3263 @item interl
3264 Set the interlacing. It accepts the following values:
3265
3266 @table @option
3267 @item 1
3268 force interlaced aware scaling
3269
3270 @item 0
3271 do not apply interlaced scaling
3272
3273 @item -1
3274 select interlaced aware scaling depending on whether the source frames
3275 are flagged as interlaced or not
3276 @end table
3277
3278 Default value is @code{0}.
3279
3280 @item flags
3281 Set libswscale scaling flags. If not explictly specified the filter
3282 applies a bilinear scaling algorithm.
3283
3284 @item size, s
3285 Set the video size, the value must be a valid abbreviation or in the
3286 form @var{width}x@var{height}.
3287 @end table
3288
3289 The values of the @var{w} and @var{h} options are expressions
3290 containing the following constants:
3291
3292 @table @option
3293 @item in_w, in_h
3294 the input width and height
3295
3296 @item iw, ih
3297 same as @var{in_w} and @var{in_h}
3298
3299 @item out_w, out_h
3300 the output (cropped) width and height
3301
3302 @item ow, oh
3303 same as @var{out_w} and @var{out_h}
3304
3305 @item a
3306 same as @var{iw} / @var{ih}
3307
3308 @item sar
3309 input sample aspect ratio
3310
3311 @item dar
3312 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
3313
3314 @item hsub, vsub
3315 horizontal and vertical chroma subsample values. For example for the
3316 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3317 @end table
3318
3319 If the input image format is different from the format requested by
3320 the next filter, the scale filter will convert the input to the
3321 requested format.
3322
3323 If the value for @var{width} or @var{height} is 0, the respective input
3324 size is used for the output.
3325
3326 If the value for @var{width} or @var{height} is -1, the scale filter will
3327 use, for the respective output size, a value that maintains the aspect
3328 ratio of the input image.
3329
3330 @subsection Examples
3331
3332 @itemize
3333 @item
3334 Scale the input video to a size of 200x100:
3335 @example
3336 scale=200:100
3337 @end example
3338
3339 This is equivalent to:
3340 @example
3341 scale=w=200:h=100
3342 @end example
3343
3344 or:
3345 @example
3346 scale=200x100
3347 @end example
3348
3349 @item
3350 Specify a size abbreviation for the output size:
3351 @example
3352 scale=qcif
3353 @end example
3354
3355 which can also be written as:
3356 @example
3357 scale=size=qcif
3358 @end example
3359
3360 @item
3361 Scale the input to 2x:
3362 @example
3363 scale=2*iw:2*ih
3364 @end example
3365
3366 @item
3367 The above is the same as:
3368 @example
3369 scale=2*in_w:2*in_h
3370 @end example
3371
3372 @item
3373 Scale the input to 2x with forced interlaced scaling:
3374 @example
3375 scale=2*iw:2*ih:interl=1
3376 @end example
3377
3378 @item
3379 Scale the input to half size:
3380 @example
3381 scale=iw/2:ih/2
3382 @end example
3383
3384 @item
3385 Increase the width, and set the height to the same size:
3386 @example
3387 scale=3/2*iw:ow
3388 @end example
3389
3390 @item
3391 Seek for Greek harmony:
3392 @example
3393 scale=iw:1/PHI*iw
3394 scale=ih*PHI:ih
3395 @end example
3396
3397 @item
3398 Increase the height, and set the width to 3/2 of the height:
3399 @example
3400 scale=3/2*oh:3/5*ih
3401 @end example
3402
3403 @item
3404 Increase the size, but make the size a multiple of the chroma:
3405 @example
3406 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
3407 @end example
3408
3409 @item
3410 Increase the width to a maximum of 500 pixels, keep the same input
3411 aspect ratio:
3412 @example
3413 scale='min(500\, iw*3/2):-1'
3414 @end example
3415 @end itemize
3416
3417 @section select
3418 Select frames to pass in output.
3419
3420 It accepts in input an expression, which is evaluated for each input
3421 frame. If the expression is evaluated to a non-zero value, the frame
3422 is selected and passed to the output, otherwise it is discarded.
3423
3424 The expression can contain the following constants:
3425
3426 @table @option
3427 @item n
3428 the sequential number of the filtered frame, starting from 0
3429
3430 @item selected_n
3431 the sequential number of the selected frame, starting from 0
3432
3433 @item prev_selected_n
3434 the sequential number of the last selected frame, NAN if undefined
3435
3436 @item TB
3437 timebase of the input timestamps
3438
3439 @item pts
3440 the PTS (Presentation TimeStamp) of the filtered video frame,
3441 expressed in @var{TB} units, NAN if undefined
3442
3443 @item t
3444 the PTS (Presentation TimeStamp) of the filtered video frame,
3445 expressed in seconds, NAN if undefined
3446
3447 @item prev_pts
3448 the PTS of the previously filtered video frame, NAN if undefined
3449
3450 @item prev_selected_pts
3451 the PTS of the last previously filtered video frame, NAN if undefined
3452
3453 @item prev_selected_t
3454 the PTS of the last previously selected video frame, NAN if undefined
3455
3456 @item start_pts
3457 the PTS of the first video frame in the video, NAN if undefined
3458
3459 @item start_t
3460 the time of the first video frame in the video, NAN if undefined
3461
3462 @item pict_type
3463 the type of the filtered frame, can assume one of the following
3464 values:
3465 @table @option
3466 @item I
3467 @item P
3468 @item B
3469 @item S
3470 @item SI
3471 @item SP
3472 @item BI
3473 @end table
3474
3475 @item interlace_type
3476 the frame interlace type, can assume one of the following values:
3477 @table @option
3478 @item PROGRESSIVE
3479 the frame is progressive (not interlaced)
3480 @item TOPFIRST
3481 the frame is top-field-first
3482 @item BOTTOMFIRST
3483 the frame is bottom-field-first
3484 @end table
3485
3486 @item key
3487 1 if the filtered frame is a key-frame, 0 otherwise
3488
3489 @item pos
3490 the position in the file of the filtered frame, -1 if the information
3491 is not available (e.g. for synthetic video)
3492
3493 @item scene
3494 value between 0 and 1 to indicate a new scene; a low value reflects a low
3495 probability for the current frame to introduce a new scene, while a higher
3496 value means the current frame is more likely to be one (see the example below)
3497
3498 @end table
3499
3500 The default value of the select expression is "1".
3501
3502 Some examples follow:
3503
3504 @example
3505 # select all frames in input
3506 select
3507
3508 # the above is the same as:
3509 select=1
3510
3511 # skip all frames:
3512 select=0
3513
3514 # select only I-frames
3515 select='eq(pict_type\,I)'
3516
3517 # select one frame every 100
3518 select='not(mod(n\,100))'
3519
3520 # select only frames contained in the 10-20 time interval
3521 select='gte(t\,10)*lte(t\,20)'
3522
3523 # select only I frames contained in the 10-20 time interval
3524 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
3525
3526 # select frames with a minimum distance of 10 seconds
3527 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
3528 @end example
3529
3530 Complete example to create a mosaic of the first scenes:
3531
3532 @example
3533 ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
3534 @end example
3535
3536 Comparing @var{scene} against a value between 0.3 and 0.5 is generally a sane
3537 choice.
3538
3539 @section setdar, setsar
3540
3541 The @code{setdar} filter sets the Display Aspect Ratio for the filter
3542 output video.
3543
3544 This is done by changing the specified Sample (aka Pixel) Aspect
3545 Ratio, according to the following equation:
3546 @example
3547 @var{DAR} = @var{HORIZONTAL_RESOLUTION} / @var{VERTICAL_RESOLUTION} * @var{SAR}
3548 @end example
3549
3550 Keep in mind that the @code{setdar} filter does not modify the pixel
3551 dimensions of the video frame. Also the display aspect ratio set by
3552 this filter may be changed by later filters in the filterchain,
3553 e.g. in case of scaling or if another "setdar" or a "setsar" filter is
3554 applied.
3555
3556 The @code{setsar} filter sets the Sample (aka Pixel) Aspect Ratio for
3557 the filter output video.
3558
3559 Note that as a consequence of the application of this filter, the
3560 output display aspect ratio will change according to the equation
3561 above.
3562
3563 Keep in mind that the sample aspect ratio set by the @code{setsar}
3564 filter may be changed by later filters in the filterchain, e.g. if
3565 another "setsar" or a "setdar" filter is applied.
3566
3567 The @code{setdar} and @code{setsar} filters accept a string in the
3568 form @var{num}:@var{den} expressing an aspect ratio, or the following
3569 named options, expressed as a sequence of @var{key}=@var{value} pairs,
3570 separated by ":".
3571
3572 @table @option
3573 @item max
3574 Set the maximum integer value to use for expressing numerator and
3575 denominator when reducing the expressed aspect ratio to a rational.
3576 Default value is @code{100}.
3577
3578 @item r, ratio:
3579 Set the aspect ratio used by the filter.
3580
3581 The parameter can be a floating point number string, an expression, or
3582 a string of the form @var{num}:@var{den}, where @var{num} and
3583 @var{den} are the numerator and denominator of the aspect ratio. If
3584 the parameter is not specified, it is assumed the value "0".
3585 In case the form "@var{num}:@var{den}" the @code{:} character should
3586 be escaped.
3587 @end table
3588
3589 If the keys are omitted in the named options list, the specifed values
3590 are assumed to be @var{ratio} and @var{max} in that order.
3591
3592 For example to change the display aspect ratio to 16:9, specify:
3593 @example
3594 setdar='16:9'
3595 @end example
3596
3597 The example above is equivalent to:
3598 @example
3599 setdar=1.77777
3600 @end example
3601
3602 To change the sample aspect ratio to 10:11, specify:
3603 @example
3604 setsar='10:11'
3605 @end example
3606
3607 To set a display aspect ratio of 16:9, and specify a maximum integer value of
3608 1000 in the aspect ratio reduction, use the command:
3609 @example
3610 setdar=ratio='16:9':max=1000
3611 @end example
3612
3613 @section setfield
3614
3615 Force field for the output video frame.
3616
3617 The @code{setfield} filter marks the interlace type field for the
3618 output frames. It does not change the input frame, but only sets the
3619 corresponding property, which affects how the frame is treated by
3620 following filters (e.g. @code{fieldorder} or @code{yadif}).
3621
3622 It accepts a string parameter, which can assume the following values:
3623 @table @samp
3624 @item auto
3625 Keep the same field property.
3626
3627 @item bff
3628 Mark the frame as bottom-field-first.
3629
3630 @item tff
3631 Mark the frame as top-field-first.
3632
3633 @item prog
3634 Mark the frame as progressive.
3635 @end table
3636
3637 @section showinfo
3638
3639 Show a line containing various information for each input video frame.
3640 The input video is not modified.
3641
3642 The shown line contains a sequence of key/value pairs of the form
3643 @var{key}:@var{value}.
3644
3645 A description of each shown parameter follows:
3646
3647 @table @option
3648 @item n
3649 sequential number of the input frame, starting from 0
3650
3651 @item pts
3652 Presentation TimeStamp of the input frame, expressed as a number of
3653 time base units. The time base unit depends on the filter input pad.
3654
3655 @item pts_time
3656 Presentation TimeStamp of the input frame, expressed as a number of
3657 seconds
3658
3659 @item pos
3660 position of the frame in the input stream, -1 if this information in
3661 unavailable and/or meaningless (for example in case of synthetic video)
3662
3663 @item fmt
3664 pixel format name
3665
3666 @item sar
3667 sample aspect ratio of the input frame, expressed in the form
3668 @var{num}/@var{den}
3669
3670 @item s
3671 size of the input frame, expressed in the form
3672 @var{width}x@var{height}
3673
3674 @item i
3675 interlaced mode ("P" for "progressive", "T" for top field first, "B"
3676 for bottom field first)
3677
3678 @item iskey
3679 1 if the frame is a key frame, 0 otherwise
3680
3681 @item type
3682 picture type of the input frame ("I" for an I-frame, "P" for a
3683 P-frame, "B" for a B-frame, "?" for unknown type).
3684 Check also the documentation of the @code{AVPictureType} enum and of
3685 the @code{av_get_picture_type_char} function defined in
3686 @file{libavutil/avutil.h}.
3687
3688 @item checksum
3689 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
3690
3691 @item plane_checksum
3692 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
3693 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
3694 @end table
3695
3696 @section slicify
3697
3698 Pass the images of input video on to next video filter as multiple
3699 slices.
3700
3701 @example
3702 ffmpeg -i in.avi -vf "slicify=32" out.avi
3703 @end example
3704
3705 The filter accepts the slice height as parameter. If the parameter is
3706 not specified it will use the default value of 16.
3707
3708 Adding this in the beginning of filter chains should make filtering
3709 faster due to better use of the memory cache.
3710
3711 @section smartblur
3712
3713 Blur the input video without impacting the outlines.
3714
3715 The filter accepts the following parameters:
3716 @var{luma_radius}:@var{luma_strength}:@var{luma_threshold}[:@var{chroma_radius}:@var{chroma_strength}:@var{chroma_threshold}]
3717
3718 Parameters prefixed by @var{luma} indicate that they work on the
3719 luminance of the pixels whereas parameters prefixed by @var{chroma}
3720 refer to the chrominance of the pixels.
3721
3722 If the chroma parameters are not set, the luma parameters are used for
3723 either the luminance and the chrominance of the pixels.
3724
3725 @var{luma_radius} or @var{chroma_radius} must be a float number in the
3726 range [0.1,5.0] that specifies the variance of the gaussian filter
3727 used to blur the image (slower if larger).
3728
3729 @var{luma_strength} or @var{chroma_strength} must be a float number in
3730 the range [-1.0,1.0] that configures the blurring. A value included in
3731 [0.0,1.0] will blur the image whereas a value included in [-1.0,0.0]
3732 will sharpen the image.
3733
3734 @var{luma_threshold} or @var{chroma_threshold} must be an integer in
3735 the range [-30,30] that is used as a coefficient to determine whether
3736 a pixel should be blurred or not. A value of 0 will filter all the
3737 image, a value included in [0,30] will filter flat areas and a value
3738 included in [-30,0] will filter edges.
3739
3740 @section split
3741
3742 Split input video into several identical outputs.
3743
3744 The filter accepts a single parameter which specifies the number of outputs. If
3745 unspecified, it defaults to 2.
3746
3747 For example
3748 @example
3749 ffmpeg -i INPUT -filter_complex split=5 OUTPUT
3750 @end example
3751 will create 5 copies of the input video.
3752
3753 For example:
3754 @example
3755 [in] split [splitout1][splitout2];
3756 [splitout1] crop=100:100:0:0    [cropout];
3757 [splitout2] pad=200:200:100:100 [padout];
3758 @end example
3759
3760 will create two separate outputs from the same input, one cropped and
3761 one padded.
3762
3763 @section super2xsai
3764
3765 Scale the input by 2x and smooth using the Super2xSaI (Scale and
3766 Interpolate) pixel art scaling algorithm.
3767
3768 Useful for enlarging pixel art images without reducing sharpness.
3769
3770 @section swapuv
3771 Swap U & V plane.
3772
3773 @section thumbnail
3774 Select the most representative frame in a given sequence of consecutive frames.
3775
3776 It accepts as argument the frames batch size to analyze (default @var{N}=100);
3777 in a set of @var{N} frames, the filter will pick one of them, and then handle
3778 the next batch of @var{N} frames until the end.
3779
3780 Since the filter keeps track of the whole frames sequence, a bigger @var{N}
3781 value will result in a higher memory usage, so a high value is not recommended.
3782
3783 The following example extract one picture each 50 frames:
3784 @example
3785 thumbnail=50
3786 @end example
3787
3788 Complete example of a thumbnail creation with @command{ffmpeg}:
3789 @example
3790 ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
3791 @end example
3792
3793 @section tile
3794
3795 Tile several successive frames together.
3796
3797 It accepts a list of options in the form of @var{key}=@var{value} pairs
3798 separated by ":". A description of the accepted options follows.
3799
3800 @table @option
3801
3802 @item layout
3803 Set the grid size (i.e. the number of lines and columns) in the form
3804 "@var{w}x@var{h}".
3805
3806 @item margin
3807 Set the outer border margin in pixels.
3808
3809 @item padding
3810 Set the inner border thickness (i.e. the number of pixels between frames). For
3811 more advanced padding options (such as having different values for the edges),
3812 refer to the pad video filter.
3813
3814 @item nb_frames
3815 Set the maximum number of frames to render in the given area. It must be less
3816 than or equal to @var{w}x@var{h}. The default value is @code{0}, meaning all
3817 the area will be used.
3818
3819 @end table
3820
3821 Alternatively, the options can be specified as a flat string:
3822
3823 @var{layout}[:@var{nb_frames}[:@var{margin}[:@var{padding}]]]
3824
3825 For example, produce 8×8 PNG tiles of all keyframes (@option{-skip_frame
3826 nokey}) in a movie:
3827 @example
3828 ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
3829 @end example
3830 The @option{-vsync 0} is necessary to prevent @command{ffmpeg} from
3831 duplicating each output frame to accomodate the originally detected frame
3832 rate.
3833
3834 Another example to display @code{5} pictures in an area of @code{3x2} frames,
3835 with @code{7} pixels between them, and @code{2} pixels of initial margin, using
3836 mixed flat and named options:
3837 @example
3838 tile=3x2:nb_frames=5:padding=7:margin=2
3839 @end example
3840
3841 @section tinterlace
3842
3843 Perform various types of temporal field interlacing.
3844
3845 Frames are counted starting from 1, so the first input frame is
3846 considered odd.
3847
3848 This filter accepts a single parameter specifying the mode. Available
3849 modes are:
3850
3851 @table @samp
3852 @item merge, 0
3853 Move odd frames into the upper field, even into the lower field,
3854 generating a double height frame at half framerate.
3855
3856 @item drop_odd, 1
3857 Only output even frames, odd frames are dropped, generating a frame with
3858 unchanged height at half framerate.
3859
3860 @item drop_even, 2
3861 Only output odd frames, even frames are dropped, generating a frame with
3862 unchanged height at half framerate.
3863
3864 @item pad, 3
3865 Expand each frame to full height, but pad alternate lines with black,
3866 generating a frame with double height at the same input framerate.
3867
3868 @item interleave_top, 4
3869 Interleave the upper field from odd frames with the lower field from
3870 even frames, generating a frame with unchanged height at half framerate.
3871
3872 @item interleave_bottom, 5
3873 Interleave the lower field from odd frames with the upper field from
3874 even frames, generating a frame with unchanged height at half framerate.
3875
3876 @item interlacex2, 6
3877 Double frame rate with unchanged height. Frames are inserted each
3878 containing the second temporal field from the previous input frame and
3879 the first temporal field from the next input frame. This mode relies on
3880 the top_field_first flag. Useful for interlaced video displays with no
3881 field synchronisation.
3882 @end table
3883
3884 Numeric values are deprecated but are accepted for backward
3885 compatibility reasons.
3886
3887 Default mode is @code{merge}.
3888
3889 @section transpose
3890
3891 Transpose rows with columns in the input video and optionally flip it.
3892
3893 This filter accepts the following named parameters:
3894
3895 @table @option
3896 @item dir
3897 Specify the transposition direction. Can assume the following values:
3898
3899 @table @samp
3900 @item 0, 4
3901 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
3902 @example
3903 L.R     L.l
3904 . . ->  . .
3905 l.r     R.r
3906 @end example
3907
3908 @item 1, 5
3909 Rotate by 90 degrees clockwise, that is:
3910 @example
3911 L.R     l.L
3912 . . ->  . .
3913 l.r     r.R
3914 @end example
3915
3916 @item 2, 6
3917 Rotate by 90 degrees counterclockwise, that is:
3918 @example
3919 L.R     R.r
3920 . . ->  . .
3921 l.r     L.l
3922 @end example
3923
3924 @item 3, 7
3925 Rotate by 90 degrees clockwise and vertically flip, that is:
3926 @example
3927 L.R     r.R
3928 . . ->  . .
3929 l.r     l.L
3930 @end example
3931 @end table
3932
3933 For values between 4-7, the transposition is only done if the input
3934 video geometry is portrait and not landscape. These values are
3935 deprecated, the @code{passthrough} option should be used instead.
3936
3937 @item passthrough
3938 Do not apply the transposition if the input geometry matches the one
3939 specified by the specified value. It accepts the following values:
3940 @table @samp
3941 @item none
3942 Always apply transposition.
3943 @item portrait
3944 Preserve portrait geometry (when @var{height} >= @var{width}).
3945 @item landscape
3946 Preserve landscape geometry (when @var{width} >= @var{height}).
3947 @end table
3948
3949 Default value is @code{none}.
3950 @end table
3951
3952 @section unsharp
3953
3954 Sharpen or blur the input video.
3955
3956 It accepts the following parameters:
3957 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
3958
3959 Negative values for the amount will blur the input video, while positive
3960 values will sharpen. All parameters are optional and default to the
3961 equivalent of the string '5:5:1.0:5:5:0.0'.
3962
3963 @table @option
3964
3965 @item luma_msize_x
3966 Set the luma matrix horizontal size. It can be an integer between 3
3967 and 13, default value is 5.
3968
3969 @item luma_msize_y
3970 Set the luma matrix vertical size. It can be an integer between 3
3971 and 13, default value is 5.
3972
3973 @item luma_amount
3974 Set the luma effect strength. It can be a float number between -2.0
3975 and 5.0, default value is 1.0.
3976
3977 @item chroma_msize_x
3978 Set the chroma matrix horizontal size. It can be an integer between 3
3979 and 13, default value is 5.
3980
3981 @item chroma_msize_y
3982 Set the chroma matrix vertical size. It can be an integer between 3
3983 and 13, default value is 5.
3984
3985 @item chroma_amount
3986 Set the chroma effect strength. It can be a float number between -2.0
3987 and 5.0, default value is 0.0.
3988
3989 @end table
3990
3991 @example
3992 # Strong luma sharpen effect parameters
3993 unsharp=7:7:2.5
3994
3995 # Strong blur of both luma and chroma parameters
3996 unsharp=7:7:-2:7:7:-2
3997
3998 # Use the default values with @command{ffmpeg}
3999 ffmpeg -i in.avi -vf "unsharp" out.mp4
4000 @end example
4001
4002 @section vflip
4003
4004 Flip the input video vertically.
4005
4006 @example
4007 ffmpeg -i in.avi -vf "vflip" out.avi
4008 @end example
4009
4010 @section yadif
4011
4012 Deinterlace the input video ("yadif" means "yet another deinterlacing
4013 filter").
4014
4015 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
4016
4017 @var{mode} specifies the interlacing mode to adopt, accepts one of the
4018 following values:
4019
4020 @table @option
4021 @item 0
4022 output 1 frame for each frame
4023 @item 1
4024 output 1 frame for each field
4025 @item 2
4026 like 0 but skips spatial interlacing check
4027 @item 3
4028 like 1 but skips spatial interlacing check
4029 @end table
4030
4031 Default value is 0.
4032
4033 @var{parity} specifies the picture field parity assumed for the input
4034 interlaced video, accepts one of the following values:
4035
4036 @table @option
4037 @item 0
4038 assume top field first
4039 @item 1
4040 assume bottom field first
4041 @item -1
4042 enable automatic detection
4043 @end table
4044
4045 Default value is -1.
4046 If interlacing is unknown or decoder does not export this information,
4047 top field first will be assumed.
4048
4049 @var{auto} specifies if deinterlacer should trust the interlaced flag
4050 and only deinterlace frames marked as interlaced
4051
4052 @table @option
4053 @item 0
4054 deinterlace all frames
4055 @item 1
4056 only deinterlace frames marked as interlaced
4057 @end table
4058
4059 Default value is 0.
4060
4061 @c man end VIDEO FILTERS
4062
4063 @chapter Video Sources
4064 @c man begin VIDEO SOURCES
4065
4066 Below is a description of the currently available video sources.
4067
4068 @section buffer
4069
4070 Buffer video frames, and make them available to the filter chain.
4071
4072 This source is mainly intended for a programmatic use, in particular
4073 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
4074
4075 It accepts a list of options in the form of @var{key}=@var{value} pairs
4076 separated by ":". A description of the accepted options follows.
4077
4078 @table @option
4079
4080 @item video_size
4081 Specify the size (width and height) of the buffered video frames.
4082
4083 @item pix_fmt
4084 A string representing the pixel format of the buffered video frames.
4085 It may be a number corresponding to a pixel format, or a pixel format
4086 name.
4087
4088 @item time_base
4089 Specify the timebase assumed by the timestamps of the buffered frames.
4090
4091 @item time_base
4092 Specify the frame rate expected for the video stream.
4093
4094 @item pixel_aspect
4095 Specify the sample aspect ratio assumed by the video frames.
4096
4097 @item sws_param
4098 Specify the optional parameters to be used for the scale filter which
4099 is automatically inserted when an input change is detected in the
4100 input size or format.
4101 @end table
4102
4103 For example:
4104 @example
4105 buffer=size=320x240:pix_fmt=yuv410p:time_base=1/24:pixel_aspect=1/1
4106 @end example
4107
4108 will instruct the source to accept video frames with size 320x240 and
4109 with format "yuv410p", assuming 1/24 as the timestamps timebase and
4110 square pixels (1:1 sample aspect ratio).
4111 Since the pixel format with name "yuv410p" corresponds to the number 6
4112 (check the enum AVPixelFormat definition in @file{libavutil/pixfmt.h}),
4113 this example corresponds to:
4114 @example
4115 buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
4116 @end example
4117
4118 Alternatively, the options can be specified as a flat string, but this
4119 syntax is deprecated:
4120
4121 @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}]
4122
4123 @section cellauto
4124
4125 Create a pattern generated by an elementary cellular automaton.
4126
4127 The initial state of the cellular automaton can be defined through the
4128 @option{filename}, and @option{pattern} options. If such options are
4129 not specified an initial state is created randomly.
4130
4131 At each new frame a new row in the video is filled with the result of
4132 the cellular automaton next generation. The behavior when the whole
4133 frame is filled is defined by the @option{scroll} option.
4134
4135 This source accepts a list of options in the form of
4136 @var{key}=@var{value} pairs separated by ":". A description of the
4137 accepted options follows.
4138
4139 @table @option
4140 @item filename, f
4141 Read the initial cellular automaton state, i.e. the starting row, from
4142 the specified file.
4143 In the file, each non-whitespace character is considered an alive
4144 cell, a newline will terminate the row, and further characters in the
4145 file will be ignored.
4146
4147 @item pattern, p
4148 Read the initial cellular automaton state, i.e. the starting row, from
4149 the specified string.
4150
4151 Each non-whitespace character in the string is considered an alive
4152 cell, a newline will terminate the row, and further characters in the
4153 string will be ignored.
4154
4155 @item rate, r
4156 Set the video rate, that is the number of frames generated per second.
4157 Default is 25.
4158
4159 @item random_fill_ratio, ratio
4160 Set the random fill ratio for the initial cellular automaton row. It
4161 is a floating point number value ranging from 0 to 1, defaults to
4162 1/PHI.
4163
4164 This option is ignored when a file or a pattern is specified.
4165
4166 @item random_seed, seed
4167 Set the seed for filling randomly the initial row, must be an integer
4168 included between 0 and UINT32_MAX. If not specified, or if explicitly
4169 set to -1, the filter will try to use a good random seed on a best
4170 effort basis.
4171
4172 @item rule
4173 Set the cellular automaton rule, it is a number ranging from 0 to 255.
4174 Default value is 110.
4175
4176 @item size, s
4177 Set the size of the output video.
4178
4179 If @option{filename} or @option{pattern} is specified, the size is set
4180 by default to the width of the specified initial state row, and the
4181 height is set to @var{width} * PHI.
4182
4183 If @option{size} is set, it must contain the width of the specified
4184 pattern string, and the specified pattern will be centered in the
4185 larger row.
4186
4187 If a filename or a pattern string is not specified, the size value
4188 defaults to "320x518" (used for a randomly generated initial state).
4189
4190 @item scroll
4191 If set to 1, scroll the output upward when all the rows in the output
4192 have been already filled. If set to 0, the new generated row will be
4193 written over the top row just after the bottom row is filled.
4194 Defaults to 1.
4195
4196 @item start_full, full
4197 If set to 1, completely fill the output with generated rows before
4198 outputting the first frame.
4199 This is the default behavior, for disabling set the value to 0.
4200
4201 @item stitch
4202 If set to 1, stitch the left and right row edges together.
4203 This is the default behavior, for disabling set the value to 0.
4204 @end table
4205
4206 @subsection Examples
4207
4208 @itemize
4209 @item
4210 Read the initial state from @file{pattern}, and specify an output of
4211 size 200x400.
4212 @example
4213 cellauto=f=pattern:s=200x400
4214 @end example
4215
4216 @item
4217 Generate a random initial row with a width of 200 cells, with a fill
4218 ratio of 2/3:
4219 @example
4220 cellauto=ratio=2/3:s=200x200
4221 @end example
4222
4223 @item
4224 Create a pattern generated by rule 18 starting by a single alive cell
4225 centered on an initial row with width 100:
4226 @example
4227 cellauto=p=@@:s=100x400:full=0:rule=18
4228 @end example
4229
4230 @item
4231 Specify a more elaborated initial pattern:
4232 @example
4233 cellauto=p='@@@@ @@ @@@@':s=100x400:full=0:rule=18
4234 @end example
4235
4236 @end itemize
4237
4238 @section mandelbrot
4239
4240 Generate a Mandelbrot set fractal, and progressively zoom towards the
4241 point specified with @var{start_x} and @var{start_y}.
4242
4243 This source accepts a list of options in the form of
4244 @var{key}=@var{value} pairs separated by ":". A description of the
4245 accepted options follows.
4246
4247 @table @option
4248
4249 @item end_pts
4250 Set the terminal pts value. Default value is 400.
4251
4252 @item end_scale
4253 Set the terminal scale value.
4254 Must be a floating point value. Default value is 0.3.
4255
4256 @item inner
4257 Set the inner coloring mode, that is the algorithm used to draw the
4258 Mandelbrot fractal internal region.
4259
4260 It shall assume one of the following values:
4261 @table @option
4262 @item black
4263 Set black mode.
4264 @item convergence
4265 Show time until convergence.
4266 @item mincol
4267 Set color based on point closest to the origin of the iterations.
4268 @item period
4269 Set period mode.
4270 @end table
4271
4272 Default value is @var{mincol}.
4273
4274 @item bailout
4275 Set the bailout value. Default value is 10.0.
4276
4277 @item maxiter
4278 Set the maximum of iterations performed by the rendering
4279 algorithm. Default value is 7189.
4280
4281 @item outer
4282 Set outer coloring mode.
4283 It shall assume one of following values:
4284 @table @option
4285 @item iteration_count
4286 Set iteration cound mode.
4287 @item normalized_iteration_count
4288 set normalized iteration count mode.
4289 @end table
4290 Default value is @var{normalized_iteration_count}.
4291
4292 @item rate, r
4293 Set frame rate, expressed as number of frames per second. Default
4294 value is "25".
4295
4296 @item size, s
4297 Set frame size. Default value is "640x480".
4298
4299 @item start_scale
4300 Set the initial scale value. Default value is 3.0.
4301
4302 @item start_x
4303 Set the initial x position. Must be a floating point value between
4304 -100 and 100. Default value is -0.743643887037158704752191506114774.
4305
4306 @item start_y
4307 Set the initial y position. Must be a floating point value between
4308 -100 and 100. Default value is -0.131825904205311970493132056385139.
4309 @end table
4310
4311 @section mptestsrc
4312
4313 Generate various test patterns, as generated by the MPlayer test filter.
4314
4315 The size of the generated video is fixed, and is 256x256.
4316 This source is useful in particular for testing encoding features.
4317
4318 This source accepts an optional sequence of @var{key}=@var{value} pairs,
4319 separated by ":". The description of the accepted options follows.
4320
4321 @table @option
4322
4323 @item rate, r
4324 Specify the frame rate of the sourced video, as the number of frames
4325 generated per second. It has to be a string in the format
4326 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
4327 number or a valid video frame rate abbreviation. The default value is
4328 "25".
4329
4330 @item duration, d
4331 Set the video duration of the sourced video. The accepted syntax is:
4332 @example
4333 [-]HH:MM:SS[.m...]
4334 [-]S+[.m...]
4335 @end example
4336 See also the function @code{av_parse_time()}.
4337
4338 If not specified, or the expressed duration is negative, the video is
4339 supposed to be generated forever.
4340
4341 @item test, t
4342
4343 Set the number or the name of the test to perform. Supported tests are:
4344 @table @option
4345 @item dc_luma
4346 @item dc_chroma
4347 @item freq_luma
4348 @item freq_chroma
4349 @item amp_luma
4350 @item amp_chroma
4351 @item cbp
4352 @item mv
4353 @item ring1
4354 @item ring2
4355 @item all
4356 @end table
4357
4358 Default value is "all", which will cycle through the list of all tests.
4359 @end table
4360
4361 For example the following:
4362 @example
4363 testsrc=t=dc_luma
4364 @end example
4365
4366 will generate a "dc_luma" test pattern.
4367
4368 @section frei0r_src
4369
4370 Provide a frei0r source.
4371
4372 To enable compilation of this filter you need to install the frei0r
4373 header and configure FFmpeg with @code{--enable-frei0r}.
4374
4375 The source supports the syntax:
4376 @example
4377 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
4378 @end example
4379
4380 @var{size} is the size of the video to generate, may be a string of the
4381 form @var{width}x@var{height} or a frame size abbreviation.
4382 @var{rate} is the rate of the video to generate, may be a string of
4383 the form @var{num}/@var{den} or a frame rate abbreviation.
4384 @var{src_name} is the name to the frei0r source to load. For more
4385 information regarding frei0r and how to set the parameters read the
4386 section @ref{frei0r} in the description of the video filters.
4387
4388 For example, to generate a frei0r partik0l source with size 200x200
4389 and frame rate 10 which is overlayed on the overlay filter main input:
4390 @example
4391 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
4392 @end example
4393
4394 @section life
4395
4396 Generate a life pattern.
4397
4398 This source is based on a generalization of John Conway's life game.
4399
4400 The sourced input represents a life grid, each pixel represents a cell
4401 which can be in one of two possible states, alive or dead. Every cell
4402 interacts with its eight neighbours, which are the cells that are
4403 horizontally, vertically, or diagonally adjacent.
4404
4405 At each interaction the grid evolves according to the adopted rule,
4406 which specifies the number of neighbor alive cells which will make a
4407 cell stay alive or born. The @option{rule} option allows to specify
4408 the rule to adopt.
4409
4410 This source accepts a list of options in the form of
4411 @var{key}=@var{value} pairs separated by ":". A description of the
4412 accepted options follows.
4413
4414 @table @option
4415 @item filename, f
4416 Set the file from which to read the initial grid state. In the file,
4417 each non-whitespace character is considered an alive cell, and newline
4418 is used to delimit the end of each row.
4419
4420 If this option is not specified, the initial grid is generated
4421 randomly.
4422
4423 @item rate, r
4424 Set the video rate, that is the number of frames generated per second.
4425 Default is 25.
4426
4427 @item random_fill_ratio, ratio
4428 Set the random fill ratio for the initial random grid. It is a
4429 floating point number value ranging from 0 to 1, defaults to 1/PHI.
4430 It is ignored when a file is specified.
4431
4432 @item random_seed, seed
4433 Set the seed for filling the initial random grid, must be an integer
4434 included between 0 and UINT32_MAX. If not specified, or if explicitly
4435 set to -1, the filter will try to use a good random seed on a best
4436 effort basis.
4437
4438 @item rule
4439 Set the life rule.
4440
4441 A rule can be specified with a code of the kind "S@var{NS}/B@var{NB}",
4442 where @var{NS} and @var{NB} are sequences of numbers in the range 0-8,
4443 @var{NS} specifies the number of alive neighbor cells which make a
4444 live cell stay alive, and @var{NB} the number of alive neighbor cells
4445 which make a dead cell to become alive (i.e. to "born").
4446 "s" and "b" can be used in place of "S" and "B", respectively.
4447
4448 Alternatively a rule can be specified by an 18-bits integer. The 9
4449 high order bits are used to encode the next cell state if it is alive
4450 for each number of neighbor alive cells, the low order bits specify
4451 the rule for "borning" new cells. Higher order bits encode for an
4452 higher number of neighbor cells.
4453 For example the number 6153 = @code{(12<<9)+9} specifies a stay alive
4454 rule of 12 and a born rule of 9, which corresponds to "S23/B03".
4455
4456 Default value is "S23/B3", which is the original Conway's game of life
4457 rule, and will keep a cell alive if it has 2 or 3 neighbor alive
4458 cells, and will born a new cell if there are three alive cells around
4459 a dead cell.
4460
4461 @item size, s
4462 Set the size of the output video.
4463
4464 If @option{filename} is specified, the size is set by default to the
4465 same size of the input file. If @option{size} is set, it must contain
4466 the size specified in the input file, and the initial grid defined in
4467 that file is centered in the larger resulting area.
4468
4469 If a filename is not specified, the size value defaults to "320x240"
4470 (used for a randomly generated initial grid).
4471
4472 @item stitch
4473 If set to 1, stitch the left and right grid edges together, and the
4474 top and bottom edges also. Defaults to 1.
4475
4476 @item mold
4477 Set cell mold speed. If set, a dead cell will go from @option{death_color} to
4478 @option{mold_color} with a step of @option{mold}. @option{mold} can have a
4479 value from 0 to 255.
4480
4481 @item life_color
4482 Set the color of living (or new born) cells.
4483
4484 @item death_color
4485 Set the color of dead cells. If @option{mold} is set, this is the first color
4486 used to represent a dead cell.
4487
4488 @item mold_color
4489 Set mold color, for definitely dead and moldy cells.
4490 @end table
4491
4492 @subsection Examples
4493
4494 @itemize
4495 @item
4496 Read a grid from @file{pattern}, and center it on a grid of size
4497 300x300 pixels:
4498 @example
4499 life=f=pattern:s=300x300
4500 @end example
4501
4502 @item
4503 Generate a random grid of size 200x200, with a fill ratio of 2/3:
4504 @example
4505 life=ratio=2/3:s=200x200
4506 @end example
4507
4508 @item
4509 Specify a custom rule for evolving a randomly generated grid:
4510 @example
4511 life=rule=S14/B34
4512 @end example
4513
4514 @item
4515 Full example with slow death effect (mold) using @command{ffplay}:
4516 @example
4517 ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
4518 @end example
4519 @end itemize
4520
4521 @section color, nullsrc, rgbtestsrc, smptebars, testsrc
4522
4523 The @code{color} source provides an uniformly colored input.
4524
4525 The @code{nullsrc} source returns unprocessed video frames. It is
4526 mainly useful to be employed in analysis / debugging tools, or as the
4527 source for filters which ignore the input data.
4528
4529 The @code{rgbtestsrc} source generates an RGB test pattern useful for
4530 detecting RGB vs BGR issues. You should see a red, green and blue
4531 stripe from top to bottom.
4532
4533 The @code{smptebars} source generates a color bars pattern, based on
4534 the SMPTE Engineering Guideline EG 1-1990.
4535
4536 The @code{testsrc} source generates a test video pattern, showing a
4537 color pattern, a scrolling gradient and a timestamp. This is mainly
4538 intended for testing purposes.
4539
4540 These sources accept an optional sequence of @var{key}=@var{value} pairs,
4541 separated by ":". The description of the accepted options follows.
4542
4543 @table @option
4544
4545 @item color, c
4546 Specify the color of the source, only used in the @code{color}
4547 source. It can be the name of a color (case insensitive match) or a
4548 0xRRGGBB[AA] sequence, possibly followed by an alpha specifier. The
4549 default value is "black".
4550
4551 @item size, s
4552 Specify the size of the sourced video, it may be a string of the form
4553 @var{width}x@var{height}, or the name of a size abbreviation. The
4554 default value is "320x240".
4555
4556 @item rate, r
4557 Specify the frame rate of the sourced video, as the number of frames
4558 generated per second. It has to be a string in the format
4559 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
4560 number or a valid video frame rate abbreviation. The default value is
4561 "25".
4562
4563 @item sar
4564 Set the sample aspect ratio of the sourced video.
4565
4566 @item duration, d
4567 Set the video duration of the sourced video. The accepted syntax is:
4568 @example
4569 [-]HH[:MM[:SS[.m...]]]
4570 [-]S+[.m...]
4571 @end example
4572 See also the function @code{av_parse_time()}.
4573
4574 If not specified, or the expressed duration is negative, the video is
4575 supposed to be generated forever.
4576
4577 @item decimals, n
4578 Set the number of decimals to show in the timestamp, only used in the
4579 @code{testsrc} source.
4580
4581 The displayed timestamp value will correspond to the original
4582 timestamp value multiplied by the power of 10 of the specified
4583 value. Default value is 0.
4584 @end table
4585
4586 For example the following:
4587 @example
4588 testsrc=duration=5.3:size=qcif:rate=10
4589 @end example
4590
4591 will generate a video with a duration of 5.3 seconds, with size
4592 176x144 and a frame rate of 10 frames per second.
4593
4594 The following graph description will generate a red source
4595 with an opacity of 0.2, with size "qcif" and a frame rate of 10
4596 frames per second.
4597 @example
4598 color=c=red@@0.2:s=qcif:r=10
4599 @end example
4600
4601 If the input content is to be ignored, @code{nullsrc} can be used. The
4602 following command generates noise in the luminance plane by employing
4603 the @code{geq} filter:
4604 @example
4605 nullsrc=s=256x256, geq=random(1)*255:128:128
4606 @end example
4607
4608 @c man end VIDEO SOURCES
4609
4610 @chapter Video Sinks
4611 @c man begin VIDEO SINKS
4612
4613 Below is a description of the currently available video sinks.
4614
4615 @section buffersink
4616
4617 Buffer video frames, and make them available to the end of the filter
4618 graph.
4619
4620 This sink is mainly intended for a programmatic use, in particular
4621 through the interface defined in @file{libavfilter/buffersink.h}.
4622
4623 It does not require a string parameter in input, but you need to
4624 specify a pointer to a list of supported pixel formats terminated by
4625 -1 in the opaque parameter provided to @code{avfilter_init_filter}
4626 when initializing this sink.
4627
4628 @section nullsink
4629
4630 Null video sink, do absolutely nothing with the input video. It is
4631 mainly useful as a template and to be employed in analysis / debugging
4632 tools.
4633
4634 @c man end VIDEO SINKS
4635
4636 @chapter Multimedia Filters
4637 @c man begin MULTIMEDIA FILTERS
4638
4639 Below is a description of the currently available multimedia filters.
4640
4641 @section asendcmd, sendcmd
4642
4643 Send commands to filters in the filtergraph.
4644
4645 These filters read commands to be sent to other filters in the
4646 filtergraph.
4647
4648 @code{asendcmd} must be inserted between two audio filters,
4649 @code{sendcmd} must be inserted between two video filters, but apart
4650 from that they act the same way.
4651
4652 The specification of commands can be provided in the filter arguments
4653 with the @var{commands} option, or in a file specified by the
4654 @var{filename} option.
4655
4656 These filters accept the following options:
4657 @table @option
4658 @item commands, c
4659 Set the commands to be read and sent to the other filters.
4660 @item filename, f
4661 Set the filename of the commands to be read and sent to the other
4662 filters.
4663 @end table
4664
4665 @subsection Commands syntax
4666
4667 A commands description consists of a sequence of interval
4668 specifications, comprising a list of commands to be executed when a
4669 particular event related to that interval occurs. The occurring event
4670 is typically the current frame time entering or leaving a given time
4671 interval.
4672
4673 An interval is specified by the following syntax:
4674 @example
4675 @var{START}[-@var{END}] @var{COMMANDS};
4676 @end example
4677
4678 The time interval is specified by the @var{START} and @var{END} times.
4679 @var{END} is optional and defaults to the maximum time.
4680
4681 The current frame time is considered within the specified interval if
4682 it is included in the interval [@var{START}, @var{END}), that is when
4683 the time is greater or equal to @var{START} and is lesser than
4684 @var{END}.
4685
4686 @var{COMMANDS} consists of a sequence of one or more command
4687 specifications, separated by ",", relating to that interval.  The
4688 syntax of a command specification is given by:
4689 @example
4690 [@var{FLAGS}] @var{TARGET} @var{COMMAND} @var{ARG}
4691 @end example
4692
4693 @var{FLAGS} is optional and specifies the type of events relating to
4694 the time interval which enable sending the specified command, and must
4695 be a non-null sequence of identifier flags separated by "+" or "|" and
4696 enclosed between "[" and "]".
4697
4698 The following flags are recognized:
4699 @table @option
4700 @item enter
4701 The command is sent when the current frame timestamp enters the
4702 specified interval. In other words, the command is sent when the
4703 previous frame timestamp was not in the given interval, and the
4704 current is.
4705
4706 @item leave
4707 The command is sent when the current frame timestamp leaves the
4708 specified interval. In other words, the command is sent when the
4709 previous frame timestamp was in the given interval, and the
4710 current is not.
4711 @end table
4712
4713 If @var{FLAGS} is not specified, a default value of @code{[enter]} is
4714 assumed.
4715
4716 @var{TARGET} specifies the target of the command, usually the name of
4717 the filter class or a specific filter instance name.
4718
4719 @var{COMMAND} specifies the name of the command for the target filter.
4720
4721 @var{ARG} is optional and specifies the optional list of argument for
4722 the given @var{COMMAND}.
4723
4724 Between one interval specification and another, whitespaces, or
4725 sequences of characters starting with @code{#} until the end of line,
4726 are ignored and can be used to annotate comments.
4727
4728 A simplified BNF description of the commands specification syntax
4729 follows:
4730 @example
4731 @var{COMMAND_FLAG}  ::= "enter" | "leave"
4732 @var{COMMAND_FLAGS} ::= @var{COMMAND_FLAG} [(+|"|")@var{COMMAND_FLAG}]
4733 @var{COMMAND}       ::= ["[" @var{COMMAND_FLAGS} "]"] @var{TARGET} @var{COMMAND} [@var{ARG}]
4734 @var{COMMANDS}      ::= @var{COMMAND} [,@var{COMMANDS}]
4735 @var{INTERVAL}      ::= @var{START}[-@var{END}] @var{COMMANDS}
4736 @var{INTERVALS}     ::= @var{INTERVAL}[;@var{INTERVALS}]
4737 @end example
4738
4739 @subsection Examples
4740
4741 @itemize
4742 @item
4743 Specify audio tempo change at second 4:
4744 @example
4745 asendcmd=c='4.0 atempo tempo 1.5',atempo
4746 @end example
4747
4748 @item
4749 Specify a list of drawtext and hue commands in a file.
4750 @example
4751 # show text in the interval 5-10
4752 5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
4753          [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
4754
4755 # desaturate the image in the interval 15-20
4756 15.0-20.0 [enter] hue reinit s=0,
4757           [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
4758           [leave] hue reinit s=1,
4759           [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
4760
4761 # apply an exponential saturation fade-out effect, starting from time 25
4762 25 [enter] hue s=exp(t-25)
4763 @end example
4764
4765 A filtergraph allowing to read and process the above command list
4766 stored in a file @file{test.cmd}, can be specified with:
4767 @example
4768 sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
4769 @end example
4770 @end itemize
4771
4772 @section asetpts, setpts
4773
4774 Change the PTS (presentation timestamp) of the input frames.
4775
4776 @code{asetpts} works on audio frames, @code{setpts} on video frames.
4777
4778 Accept in input an expression evaluated through the eval API, which
4779 can contain the following constants:
4780
4781 @table @option
4782 @item FRAME_RATE
4783 frame rate, only defined for constant frame-rate video
4784
4785 @item PTS
4786 the presentation timestamp in input
4787
4788 @item N
4789 the count of the input frame, starting from 0.
4790
4791 @item NB_CONSUMED_SAMPLES
4792 the number of consumed samples, not including the current frame (only
4793 audio)
4794
4795 @item NB_SAMPLES
4796 the number of samples in the current frame (only audio)
4797
4798 @item SAMPLE_RATE
4799 audio sample rate
4800
4801 @item STARTPTS
4802 the PTS of the first frame
4803
4804 @item STARTT
4805 the time in seconds of the first frame
4806
4807 @item INTERLACED
4808 tell if the current frame is interlaced
4809
4810 @item T
4811 the time in seconds of the current frame
4812
4813 @item TB
4814 the time base
4815
4816 @item POS
4817 original position in the file of the frame, or undefined if undefined
4818 for the current frame
4819
4820 @item PREV_INPTS
4821 previous input PTS
4822
4823 @item PREV_INT
4824 previous input time in seconds
4825
4826 @item PREV_OUTPTS
4827 previous output PTS
4828
4829 @item PREV_OUTT
4830 previous output time in seconds
4831 @end table
4832
4833 @subsection Examples
4834
4835 @itemize
4836 @item
4837 Start counting PTS from zero
4838 @example
4839 setpts=PTS-STARTPTS
4840 @end example
4841
4842 @item
4843 Apply fast motion effect:
4844 @example
4845 setpts=0.5*PTS
4846 @end example
4847
4848 @item
4849 Apply slow motion effect:
4850 @example
4851 setpts=2.0*PTS
4852 @end example
4853
4854 @item
4855 Set fixed rate of 25 frames per second:
4856 @example
4857 setpts=N/(25*TB)
4858 @end example
4859
4860 @item
4861 Set fixed rate 25 fps with some jitter:
4862 @example
4863 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
4864 @end example
4865
4866 @item
4867 Apply an offset of 10 seconds to the input PTS:
4868 @example
4869 setpts=PTS+10/TB
4870 @end example
4871 @end itemize
4872
4873 @section ebur128
4874
4875 EBU R128 scanner filter. This filter takes an audio stream as input and outputs
4876 it unchanged. By default, it logs a message at a frequency of 10Hz with the
4877 Momentary loudness (identified by @code{M}), Short-term loudness (@code{S}),
4878 Integrated loudness (@code{I}) and Loudness Range (@code{LRA}).
4879
4880 The filter also has a video output (see the @var{video} option) with a real
4881 time graph to observe the loudness evolution. The graphic contains the logged
4882 message mentioned above, so it is not printed anymore when this option is set,
4883 unless the verbose logging is set. The main graphing area contains the
4884 short-term loudness (3 seconds of analysis), and the gauge on the right is for
4885 the momentary loudness (400 milliseconds).
4886
4887 More information about the Loudness Recommendation EBU R128 on
4888 @url{http://tech.ebu.ch/loudness}.
4889
4890 The filter accepts the following named parameters:
4891
4892 @table @option
4893
4894 @item video
4895 Activate the video output. The audio stream is passed unchanged whether this
4896 option is set or no. The video stream will be the first output stream if
4897 activated. Default is @code{0}.
4898
4899 @item size
4900 Set the video size. This option is for video only. Default and minimum
4901 resolution is @code{640x480}.
4902
4903 @item meter
4904 Set the EBU scale meter. Default is @code{9}. Common values are @code{9} and
4905 @code{18}, respectively for EBU scale meter +9 and EBU scale meter +18. Any
4906 other integer value between this range is allowed.
4907
4908 @end table
4909
4910 Example of real-time graph using @command{ffplay}, with a EBU scale meter +18:
4911 @example
4912 ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
4913 @end example
4914
4915 Run an analysis with @command{ffmpeg}:
4916 @example
4917 ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
4918 @end example
4919
4920 @section settb, asettb
4921
4922 Set the timebase to use for the output frames timestamps.
4923 It is mainly useful for testing timebase configuration.
4924
4925 It accepts in input an arithmetic expression representing a rational.
4926 The expression can contain the constants "AVTB" (the
4927 default timebase), "intb" (the input timebase) and "sr" (the sample rate,
4928 audio only).
4929
4930 The default value for the input is "intb".
4931
4932 @subsection Examples
4933
4934 @itemize
4935 @item
4936 Set the timebase to 1/25:
4937 @example
4938 settb=1/25
4939 @end example
4940
4941 @item
4942 Set the timebase to 1/10:
4943 @example
4944 settb=0.1
4945 @end example
4946
4947 @item
4948 Set the timebase to 1001/1000:
4949 @example
4950 settb=1+0.001
4951 @end example
4952
4953 @item
4954 Set the timebase to 2*intb:
4955 @example
4956 settb=2*intb
4957 @end example
4958
4959 @item
4960 Set the default timebase value:
4961 @example
4962 settb=AVTB
4963 @end example
4964 @end itemize
4965
4966 @section concat
4967
4968 Concatenate audio and video streams, joining them together one after the
4969 other.
4970
4971 The filter works on segments of synchronized video and audio streams. All
4972 segments must have the same number of streams of each type, and that will
4973 also be the number of streams at output.
4974
4975 The filter accepts the following named parameters:
4976 @table @option
4977
4978 @item n
4979 Set the number of segments. Default is 2.
4980
4981 @item v
4982 Set the number of output video streams, that is also the number of video
4983 streams in each segment. Default is 1.
4984
4985 @item a
4986 Set the number of output audio streams, that is also the number of video
4987 streams in each segment. Default is 0.
4988
4989 @item unsafe
4990 Activate unsafe mode: do not fail if segments have a different format.
4991
4992 @end table
4993
4994 The filter has @var{v}+@var{a} outputs: first @var{v} video outputs, then
4995 @var{a} audio outputs.
4996
4997 There are @var{n}×(@var{v}+@var{a}) inputs: first the inputs for the first
4998 segment, in the same order as the outputs, then the inputs for the second
4999 segment, etc.
5000
5001 Related streams do not always have exactly the same duration, for various
5002 reasons including codec frame size or sloppy authoring. For that reason,
5003 related synchronized streams (e.g. a video and its audio track) should be
5004 concatenated at once. The concat filter will use the duration of the longest
5005 stream in each segment (except the last one), and if necessary pad shorter
5006 audio streams with silence.
5007
5008 For this filter to work correctly, all segments must start at timestamp 0.
5009
5010 All corresponding streams must have the same parameters in all segments; the
5011 filtering system will automatically select a common pixel format for video
5012 streams, and a common sample format, sample rate and channel layout for
5013 audio streams, but other settings, such as resolution, must be converted
5014 explicitly by the user.
5015
5016 Different frame rates are acceptable but will result in variable frame rate
5017 at output; be sure to configure the output file to handle it.
5018
5019 Examples:
5020 @itemize
5021 @item
5022 Concatenate an opening, an episode and an ending, all in bilingual version
5023 (video in stream 0, audio in streams 1 and 2):
5024 @example
5025 ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
5026   '[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
5027    concat=n=3:v=1:a=2 [v] [a1] [a2]' \
5028   -map '[v]' -map '[a1]' -map '[a2]' output.mkv
5029 @end example
5030
5031 @item
5032 Concatenate two parts, handling audio and video separately, using the
5033 (a)movie sources, and adjusting the resolution:
5034 @example
5035 movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
5036 movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
5037 [v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
5038 @end example
5039 Note that a desync will happen at the stitch if the audio and video streams
5040 do not have exactly the same duration in the first file.
5041
5042 @end itemize
5043
5044 @section showspectrum
5045
5046 Convert input audio to a video output, representing the audio frequency
5047 spectrum.
5048
5049 The filter accepts the following named parameters:
5050 @table @option
5051 @item size, s
5052 Specify the video size for the output. Default value is @code{640x480}.
5053 @item slide
5054 Specify if the spectrum should slide along the window. Default value is
5055 @code{0}.
5056 @end table
5057
5058 The usage is very similar to the showwaves filter; see the examples in that
5059 section.
5060
5061 @section showwaves
5062
5063 Convert input audio to a video output, representing the samples waves.
5064
5065 The filter accepts the following named parameters:
5066 @table @option
5067
5068 @item n
5069 Set the number of samples which are printed on the same column. A
5070 larger value will decrease the frame rate. Must be a positive
5071 integer. This option can be set only if the value for @var{rate}
5072 is not explicitly specified.
5073
5074 @item rate, r
5075 Set the (approximate) output frame rate. This is done by setting the
5076 option @var{n}. Default value is "25".
5077
5078 @item size, s
5079 Specify the video size for the output. Default value is "600x240".
5080 @end table
5081
5082 Some examples follow.
5083 @itemize
5084 @item
5085 Output the input file audio and the corresponding video representation
5086 at the same time:
5087 @example
5088 amovie=a.mp3,asplit[out0],showwaves[out1]
5089 @end example
5090
5091 @item
5092 Create a synthetic signal and show it with showwaves, forcing a
5093 framerate of 30 frames per second:
5094 @example
5095 aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
5096 @end example
5097 @end itemize
5098
5099 @c man end MULTIMEDIA FILTERS