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