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