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