doc: make developer.texi point to correct fate doc
[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
1152 @item timecode
1153 initial timecode representation in "hh:mm:ss[:;.]ff" format. It can be used
1154 with or without text parameter. @var{rate} option must be specified
1155
1156 @item r, rate
1157 frame rate (timecode only)
1158 @end table
1159
1160 Some examples follow.
1161
1162 @itemize
1163
1164 @item
1165 Draw "Test Text" with font FreeSerif, using the default values for the
1166 optional parameters.
1167
1168 @example
1169 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1170 @end example
1171
1172 @item
1173 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
1174 and y=50 (counting from the top-left corner of the screen), text is
1175 yellow with a red box around it. Both the text and the box have an
1176 opacity of 20%.
1177
1178 @example
1179 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1180           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
1181 @end example
1182
1183 Note that the double quotes are not necessary if spaces are not used
1184 within the parameter list.
1185
1186 @item
1187 Show the text at the center of the video frame:
1188 @example
1189 drawtext=fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
1190 @end example
1191
1192 @item
1193 Show a text line sliding from right to left in the last row of the video
1194 frame. The file @file{LONG_LINE} is assumed to contain a single line
1195 with no newlines.
1196 @example
1197 drawtext=fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t
1198 @end example
1199
1200 @item
1201 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
1202 @example
1203 drawtext=fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
1204 @end example
1205
1206 @item
1207 Draw a single green letter "g", at the center of the input video.
1208 The glyph baseline is placed at half screen height.
1209 @example
1210 drawtext=fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent
1211 @end example
1212
1213 @end itemize
1214
1215 For more information about libfreetype, check:
1216 @url{http://www.freetype.org/}.
1217
1218 @section fade
1219
1220 Apply fade-in/out effect to input video.
1221
1222 It accepts the parameters:
1223 @var{type}:@var{start_frame}:@var{nb_frames}[:@var{options}]
1224
1225 @var{type} specifies if the effect type, can be either "in" for
1226 fade-in, or "out" for a fade-out effect.
1227
1228 @var{start_frame} specifies the number of the start frame for starting
1229 to apply the fade effect.
1230
1231 @var{nb_frames} specifies the number of frames for which the fade
1232 effect has to last. At the end of the fade-in effect the output video
1233 will have the same intensity as the input video, at the end of the
1234 fade-out transition the output video will be completely black.
1235
1236 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
1237 separated by ":". The description of the accepted options follows.
1238
1239 @table @option
1240
1241 @item type, t
1242 See @var{type}.
1243
1244 @item start_frame, s
1245 See @var{start_frame}.
1246
1247 @item nb_frames, n
1248 See @var{nb_frames}.
1249
1250 @item alpha
1251 If set to 1, fade only alpha channel, if one exists on the input.
1252 Default value is 0.
1253 @end table
1254
1255 A few usage examples follow, usable too as test scenarios.
1256 @example
1257 # fade in first 30 frames of video
1258 fade=in:0:30
1259
1260 # fade out last 45 frames of a 200-frame video
1261 fade=out:155:45
1262
1263 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
1264 fade=in:0:25, fade=out:975:25
1265
1266 # make first 5 frames black, then fade in from frame 5-24
1267 fade=in:5:20
1268
1269 # fade in alpha over first 25 frames of video
1270 fade=in:0:25:alpha=1
1271 @end example
1272
1273 @section fieldorder
1274
1275 Transform the field order of the input video.
1276
1277 It accepts one parameter which specifies the required field order that
1278 the input interlaced video will be transformed to. The parameter can
1279 assume one of the following values:
1280
1281 @table @option
1282 @item 0 or bff
1283 output bottom field first
1284 @item 1 or tff
1285 output top field first
1286 @end table
1287
1288 Default value is "tff".
1289
1290 Transformation is achieved by shifting the picture content up or down
1291 by one line, and filling the remaining line with appropriate picture content.
1292 This method is consistent with most broadcast field order converters.
1293
1294 If the input video is not flagged as being interlaced, or it is already
1295 flagged as being of the required output field order then this filter does
1296 not alter the incoming video.
1297
1298 This filter is very useful when converting to or from PAL DV material,
1299 which is bottom field first.
1300
1301 For example:
1302 @example
1303 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
1304 @end example
1305
1306 @section fifo
1307
1308 Buffer input images and send them when they are requested.
1309
1310 This filter is mainly useful when auto-inserted by the libavfilter
1311 framework.
1312
1313 The filter does not take parameters.
1314
1315 @section format
1316
1317 Convert the input video to one of the specified pixel formats.
1318 Libavfilter will try to pick one that is supported for the input to
1319 the next filter.
1320
1321 The filter accepts a list of pixel format names, separated by ":",
1322 for example "yuv420p:monow:rgb24".
1323
1324 Some examples follow:
1325 @example
1326 # convert the input video to the format "yuv420p"
1327 format=yuv420p
1328
1329 # convert the input video to any of the formats in the list
1330 format=yuv420p:yuv444p:yuv410p
1331 @end example
1332
1333 @anchor{frei0r}
1334 @section frei0r
1335
1336 Apply a frei0r effect to the input video.
1337
1338 To enable compilation of this filter you need to install the frei0r
1339 header and configure FFmpeg with --enable-frei0r.
1340
1341 The filter supports the syntax:
1342 @example
1343 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
1344 @end example
1345
1346 @var{filter_name} is the name to the frei0r effect to load. If the
1347 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
1348 is searched in each one of the directories specified by the colon
1349 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
1350 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
1351 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
1352
1353 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
1354 for the frei0r effect.
1355
1356 A frei0r effect parameter can be a boolean (whose values are specified
1357 with "y" and "n"), a double, a color (specified by the syntax
1358 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1359 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1360 description), a position (specified by the syntax @var{X}/@var{Y},
1361 @var{X} and @var{Y} being float numbers) and a string.
1362
1363 The number and kind of parameters depend on the loaded effect. If an
1364 effect parameter is not specified the default value is set.
1365
1366 Some examples follow:
1367 @example
1368 # apply the distort0r effect, set the first two double parameters
1369 frei0r=distort0r:0.5:0.01
1370
1371 # apply the colordistance effect, takes a color as first parameter
1372 frei0r=colordistance:0.2/0.3/0.4
1373 frei0r=colordistance:violet
1374 frei0r=colordistance:0x112233
1375
1376 # apply the perspective effect, specify the top left and top right
1377 # image positions
1378 frei0r=perspective:0.2/0.2:0.8/0.2
1379 @end example
1380
1381 For more information see:
1382 @url{http://piksel.org/frei0r}
1383
1384 @section gradfun
1385
1386 Fix the banding artifacts that are sometimes introduced into nearly flat
1387 regions by truncation to 8bit color depth.
1388 Interpolate the gradients that should go where the bands are, and
1389 dither them.
1390
1391 This filter is designed for playback only.  Do not use it prior to
1392 lossy compression, because compression tends to lose the dither and
1393 bring back the bands.
1394
1395 The filter takes two optional parameters, separated by ':':
1396 @var{strength}:@var{radius}
1397
1398 @var{strength} is the maximum amount by which the filter will change
1399 any one pixel. Also the threshold for detecting nearly flat
1400 regions. Acceptable values range from .51 to 255, default value is
1401 1.2, out-of-range values will be clipped to the valid range.
1402
1403 @var{radius} is the neighborhood to fit the gradient to. A larger
1404 radius makes for smoother gradients, but also prevents the filter from
1405 modifying the pixels near detailed regions. Acceptable values are
1406 8-32, default value is 16, out-of-range values will be clipped to the
1407 valid range.
1408
1409 @example
1410 # default parameters
1411 gradfun=1.2:16
1412
1413 # omitting radius
1414 gradfun=1.2
1415 @end example
1416
1417 @section hflip
1418
1419 Flip the input video horizontally.
1420
1421 For example to horizontally flip the input video with @command{ffmpeg}:
1422 @example
1423 ffmpeg -i in.avi -vf "hflip" out.avi
1424 @end example
1425
1426 @section hqdn3d
1427
1428 High precision/quality 3d denoise filter. This filter aims to reduce
1429 image noise producing smooth images and making still images really
1430 still. It should enhance compressibility.
1431
1432 It accepts the following optional parameters:
1433 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
1434
1435 @table @option
1436 @item luma_spatial
1437 a non-negative float number which specifies spatial luma strength,
1438 defaults to 4.0
1439
1440 @item chroma_spatial
1441 a non-negative float number which specifies spatial chroma strength,
1442 defaults to 3.0*@var{luma_spatial}/4.0
1443
1444 @item luma_tmp
1445 a float number which specifies luma temporal strength, defaults to
1446 6.0*@var{luma_spatial}/4.0
1447
1448 @item chroma_tmp
1449 a float number which specifies chroma temporal strength, defaults to
1450 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1451 @end table
1452
1453 @section lut, lutrgb, lutyuv
1454
1455 Compute a look-up table for binding each pixel component input value
1456 to an output value, and apply it to input video.
1457
1458 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1459 to an RGB input video.
1460
1461 These filters accept in input a ":"-separated list of options, which
1462 specify the expressions used for computing the lookup table for the
1463 corresponding pixel component values.
1464
1465 The @var{lut} filter requires either YUV or RGB pixel formats in
1466 input, and accepts the options:
1467 @table @option
1468 @item c0
1469 first  pixel component
1470 @item c1
1471 second pixel component
1472 @item c2
1473 third  pixel component
1474 @item c3
1475 fourth pixel component, corresponds to the alpha component
1476 @end table
1477
1478 The exact component associated to each option depends on the format in
1479 input.
1480
1481 The @var{lutrgb} filter requires RGB pixel formats in input, and
1482 accepts the options:
1483 @table @option
1484 @item r
1485 red component
1486 @item g
1487 green component
1488 @item b
1489 blue component
1490 @item a
1491 alpha component
1492 @end table
1493
1494 The @var{lutyuv} filter requires YUV pixel formats in input, and
1495 accepts the options:
1496 @table @option
1497 @item y
1498 Y/luminance component
1499 @item u
1500 U/Cb component
1501 @item v
1502 V/Cr component
1503 @item a
1504 alpha component
1505 @end table
1506
1507 The expressions can contain the following constants and functions:
1508
1509 @table @option
1510 @item w, h
1511 the input width and height
1512
1513 @item val
1514 input value for the pixel component
1515
1516 @item clipval
1517 the input value clipped in the @var{minval}-@var{maxval} range
1518
1519 @item maxval
1520 maximum value for the pixel component
1521
1522 @item minval
1523 minimum value for the pixel component
1524
1525 @item negval
1526 the negated value for the pixel component value clipped in the
1527 @var{minval}-@var{maxval} range , it corresponds to the expression
1528 "maxval-clipval+minval"
1529
1530 @item clip(val)
1531 the computed value in @var{val} clipped in the
1532 @var{minval}-@var{maxval} range
1533
1534 @item gammaval(gamma)
1535 the computed gamma correction value of the pixel component value
1536 clipped in the @var{minval}-@var{maxval} range, corresponds to the
1537 expression
1538 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1539
1540 @end table
1541
1542 All expressions default to "val".
1543
1544 Some examples follow:
1545 @example
1546 # negate input video
1547 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1548 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1549
1550 # the above is the same as
1551 lutrgb="r=negval:g=negval:b=negval"
1552 lutyuv="y=negval:u=negval:v=negval"
1553
1554 # negate luminance
1555 lutyuv=y=negval
1556
1557 # remove chroma components, turns the video into a graytone image
1558 lutyuv="u=128:v=128"
1559
1560 # apply a luma burning effect
1561 lutyuv="y=2*val"
1562
1563 # remove green and blue components
1564 lutrgb="g=0:b=0"
1565
1566 # set a constant alpha channel value on input
1567 format=rgba,lutrgb=a="maxval-minval/2"
1568
1569 # correct luminance gamma by a 0.5 factor
1570 lutyuv=y=gammaval(0.5)
1571 @end example
1572
1573 @section mp
1574
1575 Apply an MPlayer filter to the input video.
1576
1577 This filter provides a wrapper around most of the filters of
1578 MPlayer/MEncoder.
1579
1580 This wrapper is considered experimental. Some of the wrapped filters
1581 may not work properly and we may drop support for them, as they will
1582 be implemented natively into FFmpeg. Thus you should avoid
1583 depending on them when writing portable scripts.
1584
1585 The filters accepts the parameters:
1586 @var{filter_name}[:=]@var{filter_params}
1587
1588 @var{filter_name} is the name of a supported MPlayer filter,
1589 @var{filter_params} is a string containing the parameters accepted by
1590 the named filter.
1591
1592 The list of the currently supported filters follows:
1593 @table @var
1594 @item 2xsai
1595 @item decimate
1596 @item denoise3d
1597 @item detc
1598 @item dint
1599 @item divtc
1600 @item down3dright
1601 @item dsize
1602 @item eq2
1603 @item eq
1604 @item field
1605 @item fil
1606 @item fixpts
1607 @item framestep
1608 @item fspp
1609 @item geq
1610 @item harddup
1611 @item hqdn3d
1612 @item hue
1613 @item il
1614 @item ilpack
1615 @item ivtc
1616 @item kerndeint
1617 @item mcdeint
1618 @item mirror
1619 @item noise
1620 @item ow
1621 @item palette
1622 @item perspective
1623 @item phase
1624 @item pp7
1625 @item pullup
1626 @item qp
1627 @item rectangle
1628 @item remove-logo
1629 @item rotate
1630 @item sab
1631 @item screenshot
1632 @item smartblur
1633 @item softpulldown
1634 @item softskip
1635 @item spp
1636 @item swapuv
1637 @item telecine
1638 @item tile
1639 @item tinterlace
1640 @item unsharp
1641 @item uspp
1642 @item yuvcsp
1643 @item yvu9
1644 @end table
1645
1646 The parameter syntax and behavior for the listed filters are the same
1647 of the corresponding MPlayer filters. For detailed instructions check
1648 the "VIDEO FILTERS" section in the MPlayer manual.
1649
1650 Some examples follow:
1651 @example
1652 # remove a logo by interpolating the surrounding pixels
1653 mp=delogo=200:200:80:20:1
1654
1655 # adjust gamma, brightness, contrast
1656 mp=eq2=1.0:2:0.5
1657
1658 # tweak hue and saturation
1659 mp=hue=100:-10
1660 @end example
1661
1662 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
1663
1664 @section negate
1665
1666 Negate input video.
1667
1668 This filter accepts an integer in input, if non-zero it negates the
1669 alpha component (if available). The default value in input is 0.
1670
1671 @section noformat
1672
1673 Force libavfilter not to use any of the specified pixel formats for the
1674 input to the next filter.
1675
1676 The filter accepts a list of pixel format names, separated by ":",
1677 for example "yuv420p:monow:rgb24".
1678
1679 Some examples follow:
1680 @example
1681 # force libavfilter to use a format different from "yuv420p" for the
1682 # input to the vflip filter
1683 noformat=yuv420p,vflip
1684
1685 # convert the input video to any of the formats not contained in the list
1686 noformat=yuv420p:yuv444p:yuv410p
1687 @end example
1688
1689 @section null
1690
1691 Pass the video source unchanged to the output.
1692
1693 @section ocv
1694
1695 Apply video transform using libopencv.
1696
1697 To enable this filter install libopencv library and headers and
1698 configure FFmpeg with --enable-libopencv.
1699
1700 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
1701
1702 @var{filter_name} is the name of the libopencv filter to apply.
1703
1704 @var{filter_params} specifies the parameters to pass to the libopencv
1705 filter. If not specified the default values are assumed.
1706
1707 Refer to the official libopencv documentation for more precise
1708 information:
1709 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1710
1711 Follows the list of supported libopencv filters.
1712
1713 @anchor{dilate}
1714 @subsection dilate
1715
1716 Dilate an image by using a specific structuring element.
1717 This filter corresponds to the libopencv function @code{cvDilate}.
1718
1719 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
1720
1721 @var{struct_el} represents a structuring element, and has the syntax:
1722 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1723
1724 @var{cols} and @var{rows} represent the number of columns and rows of
1725 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1726 point, and @var{shape} the shape for the structuring element, and
1727 can be one of the values "rect", "cross", "ellipse", "custom".
1728
1729 If the value for @var{shape} is "custom", it must be followed by a
1730 string of the form "=@var{filename}". The file with name
1731 @var{filename} is assumed to represent a binary image, with each
1732 printable character corresponding to a bright pixel. When a custom
1733 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1734 or columns and rows of the read file are assumed instead.
1735
1736 The default value for @var{struct_el} is "3x3+0x0/rect".
1737
1738 @var{nb_iterations} specifies the number of times the transform is
1739 applied to the image, and defaults to 1.
1740
1741 Follow some example:
1742 @example
1743 # use the default values
1744 ocv=dilate
1745
1746 # dilate using a structuring element with a 5x5 cross, iterate two times
1747 ocv=dilate=5x5+2x2/cross:2
1748
1749 # read the shape from the file diamond.shape, iterate two times
1750 # the file diamond.shape may contain a pattern of characters like this:
1751 #   *
1752 #  ***
1753 # *****
1754 #  ***
1755 #   *
1756 # the specified cols and rows are ignored (but not the anchor point coordinates)
1757 ocv=0x0+2x2/custom=diamond.shape:2
1758 @end example
1759
1760 @subsection erode
1761
1762 Erode an image by using a specific structuring element.
1763 This filter corresponds to the libopencv function @code{cvErode}.
1764
1765 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1766 with the same syntax and semantics as the @ref{dilate} filter.
1767
1768 @subsection smooth
1769
1770 Smooth the input video.
1771
1772 The filter takes the following parameters:
1773 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
1774
1775 @var{type} is the type of smooth filter to apply, and can be one of
1776 the following values: "blur", "blur_no_scale", "median", "gaussian",
1777 "bilateral". The default value is "gaussian".
1778
1779 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1780 parameters whose meanings depend on smooth type. @var{param1} and
1781 @var{param2} accept integer positive values or 0, @var{param3} and
1782 @var{param4} accept float values.
1783
1784 The default value for @var{param1} is 3, the default value for the
1785 other parameters is 0.
1786
1787 These parameters correspond to the parameters assigned to the
1788 libopencv function @code{cvSmooth}.
1789
1790 @anchor{overlay}
1791 @section overlay
1792
1793 Overlay one video on top of another.
1794
1795 It takes two inputs and one output, the first input is the "main"
1796 video on which the second input is overlayed.
1797
1798 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
1799
1800 @var{x} is the x coordinate of the overlayed video on the main video,
1801 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
1802 the following parameters:
1803
1804 @table @option
1805 @item main_w, main_h
1806 main input width and height
1807
1808 @item W, H
1809 same as @var{main_w} and @var{main_h}
1810
1811 @item overlay_w, overlay_h
1812 overlay input width and height
1813
1814 @item w, h
1815 same as @var{overlay_w} and @var{overlay_h}
1816 @end table
1817
1818 @var{options} is an optional list of @var{key}=@var{value} pairs,
1819 separated by ":".
1820
1821 The description of the accepted options follows.
1822
1823 @table @option
1824 @item rgb
1825 If set to 1, force the filter to accept inputs in the RGB
1826 color space. Default value is 0.
1827 @end table
1828
1829 Be aware that frames are taken from each input video in timestamp
1830 order, hence, if their initial timestamps differ, it is a a good idea
1831 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1832 have them begin in the same zero timestamp, as it does the example for
1833 the @var{movie} filter.
1834
1835 Follow some examples:
1836 @example
1837 # draw the overlay at 10 pixels from the bottom right
1838 # corner of the main video.
1839 overlay=main_w-overlay_w-10:main_h-overlay_h-10
1840
1841 # insert a transparent PNG logo in the bottom left corner of the input
1842 movie=logo.png [logo];
1843 [in][logo] overlay=10:main_h-overlay_h-10 [out]
1844
1845 # insert 2 different transparent PNG logos (second logo on bottom
1846 # right corner):
1847 movie=logo1.png [logo1];
1848 movie=logo2.png [logo2];
1849 [in][logo1]       overlay=10:H-h-10 [in+logo1];
1850 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
1851
1852 # add a transparent color layer on top of the main video,
1853 # WxH specifies the size of the main input to the overlay filter
1854 color=red@.3:WxH [over]; [in][over] overlay [out]
1855 @end example
1856
1857 You can chain together more overlays but the efficiency of such
1858 approach is yet to be tested.
1859
1860 @section pad
1861
1862 Add paddings to the input image, and places the original input at the
1863 given coordinates @var{x}, @var{y}.
1864
1865 It accepts the following parameters:
1866 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
1867
1868 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1869 expressions containing the following constants:
1870
1871 @table @option
1872 @item in_w, in_h
1873 the input video width and height
1874
1875 @item iw, ih
1876 same as @var{in_w} and @var{in_h}
1877
1878 @item out_w, out_h
1879 the output width and height, that is the size of the padded area as
1880 specified by the @var{width} and @var{height} expressions
1881
1882 @item ow, oh
1883 same as @var{out_w} and @var{out_h}
1884
1885 @item x, y
1886 x and y offsets as specified by the @var{x} and @var{y}
1887 expressions, or NAN if not yet specified
1888
1889 @item a
1890 same as @var{iw} / @var{ih}
1891
1892 @item sar
1893 input sample aspect ratio
1894
1895 @item dar
1896 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1897
1898 @item hsub, vsub
1899 horizontal and vertical chroma subsample values. For example for the
1900 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1901 @end table
1902
1903 Follows the description of the accepted parameters.
1904
1905 @table @option
1906 @item width, height
1907
1908 Specify the size of the output image with the paddings added. If the
1909 value for @var{width} or @var{height} is 0, the corresponding input size
1910 is used for the output.
1911
1912 The @var{width} expression can reference the value set by the
1913 @var{height} expression, and vice versa.
1914
1915 The default value of @var{width} and @var{height} is 0.
1916
1917 @item x, y
1918
1919 Specify the offsets where to place the input image in the padded area
1920 with respect to the top/left border of the output image.
1921
1922 The @var{x} expression can reference the value set by the @var{y}
1923 expression, and vice versa.
1924
1925 The default value of @var{x} and @var{y} is 0.
1926
1927 @item color
1928
1929 Specify the color of the padded area, it can be the name of a color
1930 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1931
1932 The default value of @var{color} is "black".
1933
1934 @end table
1935
1936 Some examples follow:
1937
1938 @example
1939 # Add paddings with color "violet" to the input video. Output video
1940 # size is 640x480, the top-left corner of the input video is placed at
1941 # column 0, row 40.
1942 pad=640:480:0:40:violet
1943
1944 # pad the input to get an output with dimensions increased bt 3/2,
1945 # and put the input video at the center of the padded area
1946 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1947
1948 # pad the input to get a squared output with size equal to the maximum
1949 # value between the input width and height, and put the input video at
1950 # the center of the padded area
1951 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1952
1953 # pad the input to get a final w/h ratio of 16:9
1954 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1955
1956 # for anamorphic video, in order to set the output display aspect ratio,
1957 # it is necessary to use sar in the expression, according to the relation:
1958 # (ih * X / ih) * sar = output_dar
1959 # X = output_dar / sar
1960 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
1961
1962 # double output size and put the input video in the bottom-right
1963 # corner of the output padded area
1964 pad="2*iw:2*ih:ow-iw:oh-ih"
1965 @end example
1966
1967 @section pixdesctest
1968
1969 Pixel format descriptor test filter, mainly useful for internal
1970 testing. The output video should be equal to the input video.
1971
1972 For example:
1973 @example
1974 format=monow, pixdesctest
1975 @end example
1976
1977 can be used to test the monowhite pixel format descriptor definition.
1978
1979 @section scale
1980
1981 Scale the input video to @var{width}:@var{height}[:@var{interl}=@{1|-1@}] and/or convert the image format.
1982
1983 The parameters @var{width} and @var{height} are expressions containing
1984 the following constants:
1985
1986 @table @option
1987 @item in_w, in_h
1988 the input width and height
1989
1990 @item iw, ih
1991 same as @var{in_w} and @var{in_h}
1992
1993 @item out_w, out_h
1994 the output (cropped) width and height
1995
1996 @item ow, oh
1997 same as @var{out_w} and @var{out_h}
1998
1999 @item a
2000 same as @var{iw} / @var{ih}
2001
2002 @item sar
2003 input sample aspect ratio
2004
2005 @item dar
2006 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2007
2008 @item sar
2009 input sample aspect ratio
2010
2011 @item hsub, vsub
2012 horizontal and vertical chroma subsample values. For example for the
2013 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2014 @end table
2015
2016 If the input image format is different from the format requested by
2017 the next filter, the scale filter will convert the input to the
2018 requested format.
2019
2020 If the value for @var{width} or @var{height} is 0, the respective input
2021 size is used for the output.
2022
2023 If the value for @var{width} or @var{height} is -1, the scale filter will
2024 use, for the respective output size, a value that maintains the aspect
2025 ratio of the input image.
2026
2027 The default value of @var{width} and @var{height} is 0.
2028
2029 Valid values for the optional parameter @var{interl} are:
2030
2031 @table @option
2032 @item 1
2033 force interlaced aware scaling
2034
2035 @item -1
2036 select interlaced aware scaling depending on whether the source frames
2037 are flagged as interlaced or not
2038 @end table
2039
2040 Some examples follow:
2041 @example
2042 # scale the input video to a size of 200x100.
2043 scale=200:100
2044
2045 # scale the input to 2x
2046 scale=2*iw:2*ih
2047 # the above is the same as
2048 scale=2*in_w:2*in_h
2049
2050 # scale the input to half size
2051 scale=iw/2:ih/2
2052
2053 # increase the width, and set the height to the same size
2054 scale=3/2*iw:ow
2055
2056 # seek for Greek harmony
2057 scale=iw:1/PHI*iw
2058 scale=ih*PHI:ih
2059
2060 # increase the height, and set the width to 3/2 of the height
2061 scale=3/2*oh:3/5*ih
2062
2063 # increase the size, but make the size a multiple of the chroma
2064 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
2065
2066 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
2067 scale='min(500\, iw*3/2):-1'
2068 @end example
2069
2070 @section select
2071 Select frames to pass in output.
2072
2073 It accepts in input an expression, which is evaluated for each input
2074 frame. If the expression is evaluated to a non-zero value, the frame
2075 is selected and passed to the output, otherwise it is discarded.
2076
2077 The expression can contain the following constants:
2078
2079 @table @option
2080 @item n
2081 the sequential number of the filtered frame, starting from 0
2082
2083 @item selected_n
2084 the sequential number of the selected frame, starting from 0
2085
2086 @item prev_selected_n
2087 the sequential number of the last selected frame, NAN if undefined
2088
2089 @item TB
2090 timebase of the input timestamps
2091
2092 @item pts
2093 the PTS (Presentation TimeStamp) of the filtered video frame,
2094 expressed in @var{TB} units, NAN if undefined
2095
2096 @item t
2097 the PTS (Presentation TimeStamp) of the filtered video frame,
2098 expressed in seconds, NAN if undefined
2099
2100 @item prev_pts
2101 the PTS of the previously filtered video frame, NAN if undefined
2102
2103 @item prev_selected_pts
2104 the PTS of the last previously filtered video frame, NAN if undefined
2105
2106 @item prev_selected_t
2107 the PTS of the last previously selected video frame, NAN if undefined
2108
2109 @item start_pts
2110 the PTS of the first video frame in the video, NAN if undefined
2111
2112 @item start_t
2113 the time of the first video frame in the video, NAN if undefined
2114
2115 @item pict_type
2116 the type of the filtered frame, can assume one of the following
2117 values:
2118 @table @option
2119 @item I
2120 @item P
2121 @item B
2122 @item S
2123 @item SI
2124 @item SP
2125 @item BI
2126 @end table
2127
2128 @item interlace_type
2129 the frame interlace type, can assume one of the following values:
2130 @table @option
2131 @item PROGRESSIVE
2132 the frame is progressive (not interlaced)
2133 @item TOPFIRST
2134 the frame is top-field-first
2135 @item BOTTOMFIRST
2136 the frame is bottom-field-first
2137 @end table
2138
2139 @item key
2140 1 if the filtered frame is a key-frame, 0 otherwise
2141
2142 @item pos
2143 the position in the file of the filtered frame, -1 if the information
2144 is not available (e.g. for synthetic video)
2145 @end table
2146
2147 The default value of the select expression is "1".
2148
2149 Some examples follow:
2150
2151 @example
2152 # select all frames in input
2153 select
2154
2155 # the above is the same as:
2156 select=1
2157
2158 # skip all frames:
2159 select=0
2160
2161 # select only I-frames
2162 select='eq(pict_type\,I)'
2163
2164 # select one frame every 100
2165 select='not(mod(n\,100))'
2166
2167 # select only frames contained in the 10-20 time interval
2168 select='gte(t\,10)*lte(t\,20)'
2169
2170 # select only I frames contained in the 10-20 time interval
2171 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2172
2173 # select frames with a minimum distance of 10 seconds
2174 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2175 @end example
2176
2177 @anchor{setdar}
2178 @section setdar
2179
2180 Set the Display Aspect Ratio for the filter output video.
2181
2182 This is done by changing the specified Sample (aka Pixel) Aspect
2183 Ratio, according to the following equation:
2184 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2185
2186 Keep in mind that this filter does not modify the pixel dimensions of
2187 the video frame. Also the display aspect ratio set by this filter may
2188 be changed by later filters in the filterchain, e.g. in case of
2189 scaling or if another "setdar" or a "setsar" filter is applied.
2190
2191 The filter accepts a parameter string which represents the wanted
2192 display aspect ratio.
2193 The parameter can be a floating point number string, or an expression
2194 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
2195 numerator and denominator of the aspect ratio.
2196 If the parameter is not specified, it is assumed the value "0:1".
2197
2198 For example to change the display aspect ratio to 16:9, specify:
2199 @example
2200 setdar=16:9
2201 # the above is equivalent to
2202 setdar=1.77777
2203 @end example
2204
2205 See also the @ref{setsar} filter documentation.
2206
2207 @section setpts
2208
2209 Change the PTS (presentation timestamp) of the input video frames.
2210
2211 Accept in input an expression evaluated through the eval API, which
2212 can contain the following constants:
2213
2214 @table @option
2215 @item PTS
2216 the presentation timestamp in input
2217
2218 @item N
2219 the count of the input frame, starting from 0.
2220
2221 @item STARTPTS
2222 the PTS of the first video frame
2223
2224 @item INTERLACED
2225 tell if the current frame is interlaced
2226
2227 @item POS
2228 original position in the file of the frame, or undefined if undefined
2229 for the current frame
2230
2231 @item PREV_INPTS
2232 previous input PTS
2233
2234 @item PREV_OUTPTS
2235 previous output PTS
2236
2237 @end table
2238
2239 Some examples follow:
2240
2241 @example
2242 # start counting PTS from zero
2243 setpts=PTS-STARTPTS
2244
2245 # fast motion
2246 setpts=0.5*PTS
2247
2248 # slow motion
2249 setpts=2.0*PTS
2250
2251 # fixed rate 25 fps
2252 setpts=N/(25*TB)
2253
2254 # fixed rate 25 fps with some jitter
2255 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2256 @end example
2257
2258 @anchor{setsar}
2259 @section setsar
2260
2261 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
2262
2263 Note that as a consequence of the application of this filter, the
2264 output display aspect ratio will change according to the following
2265 equation:
2266 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2267
2268 Keep in mind that the sample aspect ratio set by this filter may be
2269 changed by later filters in the filterchain, e.g. if another "setsar"
2270 or a "setdar" filter is applied.
2271
2272 The filter accepts a parameter string which represents the wanted
2273 sample aspect ratio.
2274 The parameter can be a floating point number string, or an expression
2275 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
2276 numerator and denominator of the aspect ratio.
2277 If the parameter is not specified, it is assumed the value "0:1".
2278
2279 For example to change the sample aspect ratio to 10:11, specify:
2280 @example
2281 setsar=10:11
2282 @end example
2283
2284 @section settb
2285
2286 Set the timebase to use for the output frames timestamps.
2287 It is mainly useful for testing timebase configuration.
2288
2289 It accepts in input an arithmetic expression representing a rational.
2290 The expression can contain the constants "AVTB" (the
2291 default timebase), and "intb" (the input timebase).
2292
2293 The default value for the input is "intb".
2294
2295 Follow some examples.
2296
2297 @example
2298 # set the timebase to 1/25
2299 settb=1/25
2300
2301 # set the timebase to 1/10
2302 settb=0.1
2303
2304 #set the timebase to 1001/1000
2305 settb=1+0.001
2306
2307 #set the timebase to 2*intb
2308 settb=2*intb
2309
2310 #set the default timebase value
2311 settb=AVTB
2312 @end example
2313
2314 @section showinfo
2315
2316 Show a line containing various information for each input video frame.
2317 The input video is not modified.
2318
2319 The shown line contains a sequence of key/value pairs of the form
2320 @var{key}:@var{value}.
2321
2322 A description of each shown parameter follows:
2323
2324 @table @option
2325 @item n
2326 sequential number of the input frame, starting from 0
2327
2328 @item pts
2329 Presentation TimeStamp of the input frame, expressed as a number of
2330 time base units. The time base unit depends on the filter input pad.
2331
2332 @item pts_time
2333 Presentation TimeStamp of the input frame, expressed as a number of
2334 seconds
2335
2336 @item pos
2337 position of the frame in the input stream, -1 if this information in
2338 unavailable and/or meaningless (for example in case of synthetic video)
2339
2340 @item fmt
2341 pixel format name
2342
2343 @item sar
2344 sample aspect ratio of the input frame, expressed in the form
2345 @var{num}/@var{den}
2346
2347 @item s
2348 size of the input frame, expressed in the form
2349 @var{width}x@var{height}
2350
2351 @item i
2352 interlaced mode ("P" for "progressive", "T" for top field first, "B"
2353 for bottom field first)
2354
2355 @item iskey
2356 1 if the frame is a key frame, 0 otherwise
2357
2358 @item type
2359 picture type of the input frame ("I" for an I-frame, "P" for a
2360 P-frame, "B" for a B-frame, "?" for unknown type).
2361 Check also the documentation of the @code{AVPictureType} enum and of
2362 the @code{av_get_picture_type_char} function defined in
2363 @file{libavutil/avutil.h}.
2364
2365 @item checksum
2366 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
2367
2368 @item plane_checksum
2369 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
2370 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
2371 @end table
2372
2373 @section slicify
2374
2375 Pass the images of input video on to next video filter as multiple
2376 slices.
2377
2378 @example
2379 ffmpeg -i in.avi -vf "slicify=32" out.avi
2380 @end example
2381
2382 The filter accepts the slice height as parameter. If the parameter is
2383 not specified it will use the default value of 16.
2384
2385 Adding this in the beginning of filter chains should make filtering
2386 faster due to better use of the memory cache.
2387
2388 @section split
2389
2390 Pass on the input video to two outputs. Both outputs are identical to
2391 the input video.
2392
2393 For example:
2394 @example
2395 [in] split [splitout1][splitout2];
2396 [splitout1] crop=100:100:0:0    [cropout];
2397 [splitout2] pad=200:200:100:100 [padout];
2398 @end example
2399
2400 will create two separate outputs from the same input, one cropped and
2401 one padded.
2402
2403 @section transpose
2404
2405 Transpose rows with columns in the input video and optionally flip it.
2406
2407 It accepts a parameter representing an integer, which can assume the
2408 values:
2409
2410 @table @samp
2411 @item 0
2412 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2413 @example
2414 L.R     L.l
2415 . . ->  . .
2416 l.r     R.r
2417 @end example
2418
2419 @item 1
2420 Rotate by 90 degrees clockwise, that is:
2421 @example
2422 L.R     l.L
2423 . . ->  . .
2424 l.r     r.R
2425 @end example
2426
2427 @item 2
2428 Rotate by 90 degrees counterclockwise, that is:
2429 @example
2430 L.R     R.r
2431 . . ->  . .
2432 l.r     L.l
2433 @end example
2434
2435 @item 3
2436 Rotate by 90 degrees clockwise and vertically flip, that is:
2437 @example
2438 L.R     r.R
2439 . . ->  . .
2440 l.r     l.L
2441 @end example
2442 @end table
2443
2444 @section unsharp
2445
2446 Sharpen or blur the input video.
2447
2448 It accepts the following parameters:
2449 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
2450
2451 Negative values for the amount will blur the input video, while positive
2452 values will sharpen. All parameters are optional and default to the
2453 equivalent of the string '5:5:1.0:5:5:0.0'.
2454
2455 @table @option
2456
2457 @item luma_msize_x
2458 Set the luma matrix horizontal size. It can be an integer between 3
2459 and 13, default value is 5.
2460
2461 @item luma_msize_y
2462 Set the luma matrix vertical size. It can be an integer between 3
2463 and 13, default value is 5.
2464
2465 @item luma_amount
2466 Set the luma effect strength. It can be a float number between -2.0
2467 and 5.0, default value is 1.0.
2468
2469 @item chroma_msize_x
2470 Set the chroma matrix horizontal size. It can be an integer between 3
2471 and 13, default value is 5.
2472
2473 @item chroma_msize_y
2474 Set the chroma matrix vertical size. It can be an integer between 3
2475 and 13, default value is 5.
2476
2477 @item chroma_amount
2478 Set the chroma effect strength. It can be a float number between -2.0
2479 and 5.0, default value is 0.0.
2480
2481 @end table
2482
2483 @example
2484 # Strong luma sharpen effect parameters
2485 unsharp=7:7:2.5
2486
2487 # Strong blur of both luma and chroma parameters
2488 unsharp=7:7:-2:7:7:-2
2489
2490 # Use the default values with @command{ffmpeg}
2491 ffmpeg -i in.avi -vf "unsharp" out.mp4
2492 @end example
2493
2494 @section vflip
2495
2496 Flip the input video vertically.
2497
2498 @example
2499 ffmpeg -i in.avi -vf "vflip" out.avi
2500 @end example
2501
2502 @section yadif
2503
2504 Deinterlace the input video ("yadif" means "yet another deinterlacing
2505 filter").
2506
2507 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
2508
2509 @var{mode} specifies the interlacing mode to adopt, accepts one of the
2510 following values:
2511
2512 @table @option
2513 @item 0
2514 output 1 frame for each frame
2515 @item 1
2516 output 1 frame for each field
2517 @item 2
2518 like 0 but skips spatial interlacing check
2519 @item 3
2520 like 1 but skips spatial interlacing check
2521 @end table
2522
2523 Default value is 0.
2524
2525 @var{parity} specifies the picture field parity assumed for the input
2526 interlaced video, accepts one of the following values:
2527
2528 @table @option
2529 @item 0
2530 assume top field first
2531 @item 1
2532 assume bottom field first
2533 @item -1
2534 enable automatic detection
2535 @end table
2536
2537 Default value is -1.
2538 If interlacing is unknown or decoder does not export this information,
2539 top field first will be assumed.
2540
2541 @var{auto} specifies if deinterlacer should trust the interlaced flag
2542 and only deinterlace frames marked as interlaced
2543
2544 @table @option
2545 @item 0
2546 deinterlace all frames
2547 @item 1
2548 only deinterlace frames marked as interlaced
2549 @end table
2550
2551 Default value is 0.
2552
2553 @c man end VIDEO FILTERS
2554
2555 @chapter Video Sources
2556 @c man begin VIDEO SOURCES
2557
2558 Below is a description of the currently available video sources.
2559
2560 @section buffer
2561
2562 Buffer video frames, and make them available to the filter chain.
2563
2564 This source is mainly intended for a programmatic use, in particular
2565 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2566
2567 It accepts the following parameters:
2568 @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}
2569
2570 All the parameters but @var{scale_params} need to be explicitly
2571 defined.
2572
2573 Follows the list of the accepted parameters.
2574
2575 @table @option
2576
2577 @item width, height
2578 Specify the width and height of the buffered video frames.
2579
2580 @item pix_fmt_string
2581 A string representing the pixel format of the buffered video frames.
2582 It may be a number corresponding to a pixel format, or a pixel format
2583 name.
2584
2585 @item timebase_num, timebase_den
2586 Specify numerator and denomitor of the timebase assumed by the
2587 timestamps of the buffered frames.
2588
2589 @item sample_aspect_ratio.num, sample_aspect_ratio.den
2590 Specify numerator and denominator of the sample aspect ratio assumed
2591 by the video frames.
2592
2593 @item scale_params
2594 Specify the optional parameters to be used for the scale filter which
2595 is automatically inserted when an input change is detected in the
2596 input size or format.
2597 @end table
2598
2599 For example:
2600 @example
2601 buffer=320:240:yuv410p:1:24:1:1
2602 @end example
2603
2604 will instruct the source to accept video frames with size 320x240 and
2605 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2606 square pixels (1:1 sample aspect ratio).
2607 Since the pixel format with name "yuv410p" corresponds to the number 6
2608 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
2609 this example corresponds to:
2610 @example
2611 buffer=320:240:6:1:24:1:1
2612 @end example
2613
2614 @section cellauto
2615
2616 Create a pattern generated by an elementary cellular automaton.
2617
2618 The initial state of the cellular automaton can be defined through the
2619 @option{filename}, and @option{pattern} options. If such options are
2620 not specified an initial state is created randomly.
2621
2622 At each new frame a new row in the video is filled with the result of
2623 the cellular automaton next generation. The behavior when the whole
2624 frame is filled is defined by the @option{scroll} option.
2625
2626 This source accepts a list of options in the form of
2627 @var{key}=@var{value} pairs separated by ":". A description of the
2628 accepted options follows.
2629
2630 @table @option
2631 @item filename, f
2632 Read the initial cellular automaton state, i.e. the starting row, from
2633 the specified file.
2634 In the file, each non-whitespace character is considered an alive
2635 cell, a newline will terminate the row, and further characters in the
2636 file will be ignored.
2637
2638 @item pattern, p
2639 Read the initial cellular automaton state, i.e. the starting row, from
2640 the specified string.
2641
2642 Each non-whitespace character in the string is considered an alive
2643 cell, a newline will terminate the row, and further characters in the
2644 string will be ignored.
2645
2646 @item rate, r
2647 Set the video rate, that is the number of frames generated per second.
2648 Default is 25.
2649
2650 @item random_fill_ratio, ratio
2651 Set the random fill ratio for the initial cellular automaton row. It
2652 is a floating point number value ranging from 0 to 1, defaults to
2653 1/PHI.
2654
2655 This option is ignored when a file or a pattern is specified.
2656
2657 @item random_seed, seed
2658 Set the seed for filling randomly the initial row, must be an integer
2659 included between 0 and UINT32_MAX. If not specified, or if explicitly
2660 set to -1, the filter will try to use a good random seed on a best
2661 effort basis.
2662
2663 @item rule
2664 Set the cellular automaton rule, it is a number ranging from 0 to 255.
2665 Default value is 110.
2666
2667 @item size, s
2668 Set the size of the output video.
2669
2670 If @option{filename} or @option{pattern} is specified, the size is set
2671 by default to the width of the specified initial state row, and the
2672 height is set to @var{width} * PHI.
2673
2674 If @option{size} is set, it must contain the width of the specified
2675 pattern string, and the specified pattern will be centered in the
2676 larger row.
2677
2678 If a filename or a pattern string is not specified, the size value
2679 defaults to "320x518" (used for a randomly generated initial state).
2680
2681 @item scroll
2682 If set to 1, scroll the output upward when all the rows in the output
2683 have been already filled. If set to 0, the new generated row will be
2684 written over the top row just after the bottom row is filled.
2685 Defaults to 1.
2686
2687 @item start_full, full
2688 If set to 1, completely fill the output with generated rows before
2689 outputting the first frame.
2690 This is the default behavior, for disabling set the value to 0.
2691
2692 @item stitch
2693 If set to 1, stitch the left and right row edges together.
2694 This is the default behavior, for disabling set the value to 0.
2695 @end table
2696
2697 @subsection Examples
2698
2699 @itemize
2700 @item
2701 Read the initial state from @file{pattern}, and specify an output of
2702 size 200x400.
2703 @example
2704 cellauto=f=pattern:s=200x400
2705 @end example
2706
2707 @item
2708 Generate a random initial row with a width of 200 cells, with a fill
2709 ratio of 2/3:
2710 @example
2711 cellauto=ratio=2/3:s=200x200
2712 @end example
2713
2714 @item
2715 Create a pattern generated by rule 18 starting by a single alive cell
2716 centered on an initial row with width 100:
2717 @example
2718 cellauto=p=@@:s=100x400:full=0:rule=18
2719 @end example
2720
2721 @item
2722 Specify a more elaborated initial pattern:
2723 @example
2724 cellauto=p='@@@@ @@ @@@@':s=100x400:full=0:rule=18
2725 @end example
2726
2727 @end itemize
2728
2729 @section color
2730
2731 Provide an uniformly colored input.
2732
2733 It accepts the following parameters:
2734 @var{color}:@var{frame_size}:@var{frame_rate}
2735
2736 Follows the description of the accepted parameters.
2737
2738 @table @option
2739
2740 @item color
2741 Specify the color of the source. It can be the name of a color (case
2742 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2743 alpha specifier. The default value is "black".
2744
2745 @item frame_size
2746 Specify the size of the sourced video, it may be a string of the form
2747 @var{width}x@var{height}, or the name of a size abbreviation. The
2748 default value is "320x240".
2749
2750 @item frame_rate
2751 Specify the frame rate of the sourced video, as the number of frames
2752 generated per second. It has to be a string in the format
2753 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2754 number or a valid video frame rate abbreviation. The default value is
2755 "25".
2756
2757 @end table
2758
2759 For example the following graph description will generate a red source
2760 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2761 frames per second, which will be overlayed over the source connected
2762 to the pad with identifier "in".
2763
2764 @example
2765 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2766 @end example
2767
2768 @section movie
2769
2770 Read a video stream from a movie container.
2771
2772 It accepts the syntax: @var{movie_name}[:@var{options}] where
2773 @var{movie_name} is the name of the resource to read (not necessarily
2774 a file but also a device or a stream accessed through some protocol),
2775 and @var{options} is an optional sequence of @var{key}=@var{value}
2776 pairs, separated by ":".
2777
2778 The description of the accepted options follows.
2779
2780 @table @option
2781
2782 @item format_name, f
2783 Specifies the format assumed for the movie to read, and can be either
2784 the name of a container or an input device. If not specified the
2785 format is guessed from @var{movie_name} or by probing.
2786
2787 @item seek_point, sp
2788 Specifies the seek point in seconds, the frames will be output
2789 starting from this seek point, the parameter is evaluated with
2790 @code{av_strtod} so the numerical value may be suffixed by an IS
2791 postfix. Default value is "0".
2792
2793 @item stream_index, si
2794 Specifies the index of the video stream to read. If the value is -1,
2795 the best suited video stream will be automatically selected. Default
2796 value is "-1".
2797
2798 @end table
2799
2800 This filter allows to overlay a second video on top of main input of
2801 a filtergraph as shown in this graph:
2802 @example
2803 input -----------> deltapts0 --> overlay --> output
2804                                     ^
2805                                     |
2806 movie --> scale--> deltapts1 -------+
2807 @end example
2808
2809 Some examples follow:
2810 @example
2811 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
2812 # on top of the input labelled as "in".
2813 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2814 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2815
2816 # read from a video4linux2 device, and overlay it on top of the input
2817 # labelled as "in"
2818 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2819 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2820
2821 @end example
2822
2823 @section mptestsrc
2824
2825 Generate various test patterns, as generated by the MPlayer test filter.
2826
2827 The size of the generated video is fixed, and is 256x256.
2828 This source is useful in particular for testing encoding features.
2829
2830 This source accepts an optional sequence of @var{key}=@var{value} pairs,
2831 separated by ":". The description of the accepted options follows.
2832
2833 @table @option
2834
2835 @item rate, r
2836 Specify the frame rate of the sourced video, as the number of frames
2837 generated per second. It has to be a string in the format
2838 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2839 number or a valid video frame rate abbreviation. The default value is
2840 "25".
2841
2842 @item duration, d
2843 Set the video duration of the sourced video. The accepted syntax is:
2844 @example
2845 [-]HH[:MM[:SS[.m...]]]
2846 [-]S+[.m...]
2847 @end example
2848 See also the function @code{av_parse_time()}.
2849
2850 If not specified, or the expressed duration is negative, the video is
2851 supposed to be generated forever.
2852
2853 @item test, t
2854
2855 Set the number or the name of the test to perform. Supported tests are:
2856 @table @option
2857 @item dc_luma
2858 @item dc_chroma
2859 @item freq_luma
2860 @item freq_chroma
2861 @item amp_luma
2862 @item amp_chroma
2863 @item cbp
2864 @item mv
2865 @item ring1
2866 @item ring2
2867 @item all
2868 @end table
2869
2870 Default value is "all", which will cycle through the list of all tests.
2871 @end table
2872
2873 For example the following:
2874 @example
2875 testsrc=t=dc_luma
2876 @end example
2877
2878 will generate a "dc_luma" test pattern.
2879
2880 @section frei0r_src
2881
2882 Provide a frei0r source.
2883
2884 To enable compilation of this filter you need to install the frei0r
2885 header and configure FFmpeg with --enable-frei0r.
2886
2887 The source supports the syntax:
2888 @example
2889 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
2890 @end example
2891
2892 @var{size} is the size of the video to generate, may be a string of the
2893 form @var{width}x@var{height} or a frame size abbreviation.
2894 @var{rate} is the rate of the video to generate, may be a string of
2895 the form @var{num}/@var{den} or a frame rate abbreviation.
2896 @var{src_name} is the name to the frei0r source to load. For more
2897 information regarding frei0r and how to set the parameters read the
2898 section @ref{frei0r} in the description of the video filters.
2899
2900 Some examples follow:
2901 @example
2902 # generate a frei0r partik0l source with size 200x200 and frame rate 10
2903 # which is overlayed on the overlay filter main input
2904 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
2905 @end example
2906
2907 @section life
2908
2909 Generate a life pattern.
2910
2911 This source is based on a generalization of John Conway's life game.
2912
2913 The sourced input represents a life grid, each pixel represents a cell
2914 which can be in one of two possible states, alive or dead. Every cell
2915 interacts with its eight neighbours, which are the cells that are
2916 horizontally, vertically, or diagonally adjacent.
2917
2918 At each interaction the grid evolves according to the adopted rule,
2919 which specifies the number of neighbor alive cells which will make a
2920 cell stay alive or born. The @option{rule} option allows to specify
2921 the rule to adopt.
2922
2923 This source accepts a list of options in the form of
2924 @var{key}=@var{value} pairs separated by ":". A description of the
2925 accepted options follows.
2926
2927 @table @option
2928 @item filename, f
2929 Set the file from which to read the initial grid state. In the file,
2930 each non-whitespace character is considered an alive cell, and newline
2931 is used to delimit the end of each row.
2932
2933 If this option is not specified, the initial grid is generated
2934 randomly.
2935
2936 @item rate, r
2937 Set the video rate, that is the number of frames generated per second.
2938 Default is 25.
2939
2940 @item random_fill_ratio, ratio
2941 Set the random fill ratio for the initial random grid. It is a
2942 floating point number value ranging from 0 to 1, defaults to 1/PHI.
2943 It is ignored when a file is specified.
2944
2945 @item random_seed, seed
2946 Set the seed for filling the initial random grid, must be an integer
2947 included between 0 and UINT32_MAX. If not specified, or if explicitly
2948 set to -1, the filter will try to use a good random seed on a best
2949 effort basis.
2950
2951 @item rule
2952 Set the life rule.
2953
2954 A rule can be specified with a code of the kind "S@var{NS}/B@var{NB}",
2955 where @var{NS} and @var{NB} are sequences of numbers in the range 0-8,
2956 @var{NS} specifies the number of alive neighbor cells which make a
2957 live cell stay alive, and @var{NB} the number of alive neighbor cells
2958 which make a dead cell to become alive (i.e. to "born").
2959 "s" and "b" can be used in place of "S" and "B", respectively.
2960
2961 Alternatively a rule can be specified by an 18-bits integer. The 9
2962 high order bits are used to encode the next cell state if it is alive
2963 for each number of neighbor alive cells, the low order bits specify
2964 the rule for "borning" new cells. Higher order bits encode for an
2965 higher number of neighbor cells.
2966 For example the number 6153 = @code{(12<<9)+9} specifies a stay alive
2967 rule of 12 and a born rule of 9, which corresponds to "S23/B03".
2968
2969 Default value is "S23/B3", which is the original Conway's game of life
2970 rule, and will keep a cell alive if it has 2 or 3 neighbor alive
2971 cells, and will born a new cell if there are three alive cells around
2972 a dead cell.
2973
2974 @item size, s
2975 Set the size of the output video.
2976
2977 If @option{filename} is specified, the size is set by default to the
2978 same size of the input file. If @option{size} is set, it must contain
2979 the size specified in the input file, and the initial grid defined in
2980 that file is centered in the larger resulting area.
2981
2982 If a filename is not specified, the size value defaults to "320x240"
2983 (used for a randomly generated initial grid).
2984
2985 @item stitch
2986 If set to 1, stitch the left and right grid edges together, and the
2987 top and bottom edges also. Defaults to 1.
2988
2989 @item mold
2990 Set cell mold speed. If set, a dead cell will go from @option{death_color} to
2991 @option{mold_color} with a step of @option{mold}. @option{mold} can have a
2992 value from 0 to 255.
2993
2994 @item life_color
2995 Set the color of living (or new born) cells.
2996
2997 @item death_color
2998 Set the color of dead cells. If @option{mold} is set, this is the first color
2999 used to represent a dead cell.
3000
3001 @item mold_color
3002 Set mold color, for definitely dead and moldy cells.
3003 @end table
3004
3005 @subsection Examples
3006
3007 @itemize
3008 @item
3009 Read a grid from @file{pattern}, and center it on a grid of size
3010 300x300 pixels:
3011 @example
3012 life=f=pattern:s=300x300
3013 @end example
3014
3015 @item
3016 Generate a random grid of size 200x200, with a fill ratio of 2/3:
3017 @example
3018 life=ratio=2/3:s=200x200
3019 @end example
3020
3021 @item
3022 Specify a custom rule for evolving a randomly generated grid:
3023 @example
3024 life=rule=S14/B34
3025 @end example
3026
3027 @item
3028 Full example with slow death effect (mold) using @command{ffplay}:
3029 @example
3030 ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
3031 @end example
3032 @end itemize
3033
3034 @section nullsrc, rgbtestsrc, testsrc
3035
3036 The @code{nullsrc} source returns unprocessed video frames. It is
3037 mainly useful to be employed in analysis / debugging tools, or as the
3038 source for filters which ignore the input data.
3039
3040 The @code{rgbtestsrc} source generates an RGB test pattern useful for
3041 detecting RGB vs BGR issues. You should see a red, green and blue
3042 stripe from top to bottom.
3043
3044 The @code{testsrc} source generates a test video pattern, showing a
3045 color pattern, a scrolling gradient and a timestamp. This is mainly
3046 intended for testing purposes.
3047
3048 These sources accept an optional sequence of @var{key}=@var{value} pairs,
3049 separated by ":". The description of the accepted options follows.
3050
3051 @table @option
3052
3053 @item size, s
3054 Specify the size of the sourced video, it may be a string of the form
3055 @var{width}x@var{height}, or the name of a size abbreviation. The
3056 default value is "320x240".
3057
3058 @item rate, r
3059 Specify the frame rate of the sourced video, as the number of frames
3060 generated per second. It has to be a string in the format
3061 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
3062 number or a valid video frame rate abbreviation. The default value is
3063 "25".
3064
3065 @item sar
3066 Set the sample aspect ratio of the sourced video.
3067
3068 @item duration
3069 Set the video duration of the sourced video. The accepted syntax is:
3070 @example
3071 [-]HH[:MM[:SS[.m...]]]
3072 [-]S+[.m...]
3073 @end example
3074 See also the function @code{av_parse_time()}.
3075
3076 If not specified, or the expressed duration is negative, the video is
3077 supposed to be generated forever.
3078 @end table
3079
3080 For example the following:
3081 @example
3082 testsrc=duration=5.3:size=qcif:rate=10
3083 @end example
3084
3085 will generate a video with a duration of 5.3 seconds, with size
3086 176x144 and a frame rate of 10 frames per second.
3087
3088 If the input content is to be ignored, @code{nullsrc} can be used. The
3089 following command generates noise in the luminance plane by employing
3090 the @code{mp=geq} filter:
3091 @example
3092 nullsrc=s=256x256, mp=geq=random(1)*255:128:128
3093 @end example
3094
3095 @c man end VIDEO SOURCES
3096
3097 @chapter Video Sinks
3098 @c man begin VIDEO SINKS
3099
3100 Below is a description of the currently available video sinks.
3101
3102 @section buffersink
3103
3104 Buffer video frames, and make them available to the end of the filter
3105 graph.
3106
3107 This sink is mainly intended for a programmatic use, in particular
3108 through the interface defined in @file{libavfilter/buffersink.h}.
3109
3110 It does not require a string parameter in input, but you need to
3111 specify a pointer to a list of supported pixel formats terminated by
3112 -1 in the opaque parameter provided to @code{avfilter_init_filter}
3113 when initializing this sink.
3114
3115 @section nullsink
3116
3117 Null video sink, do absolutely nothing with the input video. It is
3118 mainly useful as a template and to be employed in analysis / debugging
3119 tools.
3120
3121 @c man end VIDEO SINKS
3122