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