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