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