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