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