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