4825b0d5479520a36359f12d31c0d5b1f0727319
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtergraph description
2 @c man begin FILTERGRAPH DESCRIPTION
3
4 A filtergraph is a directed graph of connected filters. It can contain
5 cycles, and there can be multiple links between a pair of
6 filters. Each link has one input pad on one side connecting it to one
7 filter from which it takes its input, and one output pad on the other
8 side connecting it to the one filter accepting its output.
9
10 Each filter in a filtergraph is an instance of a filter class
11 registered in the application, which defines the features and the
12 number of input and output pads of the filter.
13
14 A filter with no input pads is called a "source", a filter with no
15 output pads is called a "sink".
16
17 @anchor{Filtergraph syntax}
18 @section Filtergraph syntax
19
20 A filtergraph can be represented using a textual representation, which is
21 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
22 options in @command{avconv} and @option{-vf} in @command{avplay}, and by the
23 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
24 @file{libavfilter/avfiltergraph.h}.
25
26 A filterchain consists of a sequence of connected filters, each one
27 connected to the previous one in the sequence. A filterchain is
28 represented by a list of ","-separated filter descriptions.
29
30 A filtergraph consists of a sequence of filterchains. A sequence of
31 filterchains is represented by a list of ";"-separated filterchain
32 descriptions.
33
34 A filter is represented by a string of the form:
35 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
36
37 @var{filter_name} is the name of the filter class of which the
38 described filter is an instance of, and has to be the name of one of
39 the filter classes registered in the program.
40 The name of the filter class is optionally followed by a string
41 "=@var{arguments}".
42
43 @var{arguments} is a string which contains the parameters used to
44 initialize the filter instance, and are described in the filter
45 descriptions below.
46
47 The list of arguments can be quoted using the character "'" as initial
48 and ending mark, and the character '\' for escaping the characters
49 within the quoted text; otherwise the argument string is considered
50 terminated when the next special character (belonging to the set
51 "[]=;,") is encountered.
52
53 The name and arguments of the filter are optionally preceded and
54 followed by a list of link labels.
55 A link label allows to name a link and associate it to a filter output
56 or input pad. The preceding labels @var{in_link_1}
57 ... @var{in_link_N}, are associated to the filter input pads,
58 the following labels @var{out_link_1} ... @var{out_link_M}, are
59 associated to the output pads.
60
61 When two link labels with the same name are found in the
62 filtergraph, a link between the corresponding input and output pad is
63 created.
64
65 If an output pad is not labelled, it is linked by default to the first
66 unlabelled input pad of the next filter in the filterchain.
67 For example in the filterchain:
68 @example
69 nullsrc, split[L1], [L2]overlay, nullsink
70 @end example
71 the split filter instance has two output pads, and the overlay filter
72 instance two input pads. The first output pad of split is labelled
73 "L1", the first input pad of overlay is labelled "L2", and the second
74 output pad of split is linked to the second input pad of overlay,
75 which are both unlabelled.
76
77 In a complete filterchain all the unlabelled filter input and output
78 pads must be connected. A filtergraph is considered valid if all the
79 filter input and output pads of all the filterchains are connected.
80
81 Libavfilter will automatically insert scale filters where format
82 conversion is required. It is possible to specify swscale flags
83 for those automatically inserted scalers by prepending
84 @code{sws_flags=@var{flags};}
85 to the filtergraph description.
86
87 Follows a BNF description for the filtergraph syntax:
88 @example
89 @var{NAME}             ::= sequence of alphanumeric characters and '_'
90 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
91 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
92 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
93 @var{FILTER}           ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
94 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
95 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
96 @end example
97
98 @c man end FILTERGRAPH DESCRIPTION
99
100 @chapter Audio Filters
101 @c man begin AUDIO FILTERS
102
103 When you configure your Libav build, you can disable any of the
104 existing filters using --disable-filters.
105 The configure output will show the audio filters included in your
106 build.
107
108 Below is a description of the currently available audio filters.
109
110 @section aformat
111
112 Convert the input audio to one of the specified formats. The framework will
113 negotiate the most appropriate format to minimize conversions.
114
115 The filter accepts the following named parameters:
116 @table @option
117
118 @item sample_fmts
119 A comma-separated list of requested sample formats.
120
121 @item sample_rates
122 A comma-separated list of requested sample rates.
123
124 @item channel_layouts
125 A comma-separated list of requested channel layouts.
126
127 @end table
128
129 If a parameter is omitted, all values are allowed.
130
131 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
132 @example
133 aformat=sample_fmts\=u8\,s16:channel_layouts\=stereo
134 @end example
135
136 @section amix
137
138 Mixes multiple audio inputs into a single output.
139
140 For example
141 @example
142 avconv -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
143 @end example
144 will mix 3 input audio streams to a single output with the same duration as the
145 first input and a dropout transition time of 3 seconds.
146
147 The filter accepts the following named parameters:
148 @table @option
149
150 @item inputs
151 Number of inputs. If unspecified, it defaults to 2.
152
153 @item duration
154 How to determine the end-of-stream.
155 @table @option
156
157 @item longest
158 Duration of longest input. (default)
159
160 @item shortest
161 Duration of shortest input.
162
163 @item first
164 Duration of first input.
165
166 @end table
167
168 @item dropout_transition
169 Transition time, in seconds, for volume renormalization when an input
170 stream ends. The default value is 2 seconds.
171
172 @end table
173
174 @section anull
175
176 Pass the audio source unchanged to the output.
177
178 @section asplit
179
180 Split input audio into several identical outputs.
181
182 The filter accepts a single parameter which specifies the number of outputs. If
183 unspecified, it defaults to 2.
184
185 For example
186 @example
187 avconv -i INPUT -filter_complex asplit=5 OUTPUT
188 @end example
189 will create 5 copies of the input audio.
190
191 @section asyncts
192 Synchronize audio data with timestamps by squeezing/stretching it and/or
193 dropping samples/adding silence when needed.
194
195 The filter accepts the following named parameters:
196 @table @option
197
198 @item compensate
199 Enable stretching/squeezing the data to make it match the timestamps. Disabled
200 by default. When disabled, time gaps are covered with silence.
201
202 @item min_delta
203 Minimum difference between timestamps and audio data (in seconds) to trigger
204 adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
205 this filter, try setting this parameter to 0.
206
207 @item max_comp
208 Maximum compensation in samples per second. Relevant only with compensate=1.
209 Default value 500.
210
211 @item first_pts
212 Assume the first pts should be this value.
213 This allows for padding/trimming at the start of stream. By default, no
214 assumption is made about the first frame's expected pts, so no padding or
215 trimming is done. For example, this could be set to 0 to pad the beginning with
216 silence if an audio stream starts after the video stream.
217
218 @end table
219
220 @section channelsplit
221 Split each channel in input audio stream into a separate output stream.
222
223 This filter accepts the following named parameters:
224 @table @option
225 @item channel_layout
226 Channel layout of the input stream. Default is "stereo".
227 @end table
228
229 For example, assuming a stereo input MP3 file
230 @example
231 avconv -i in.mp3 -filter_complex channelsplit out.mkv
232 @end example
233 will create an output Matroska file with two audio streams, one containing only
234 the left channel and the other the right channel.
235
236 To split a 5.1 WAV file into per-channel files
237 @example
238 avconv -i in.wav -filter_complex
239 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
240 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
241 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
242 side_right.wav
243 @end example
244
245 @section channelmap
246 Remap input channels to new locations.
247
248 This filter accepts the following named parameters:
249 @table @option
250 @item channel_layout
251 Channel layout of the output stream.
252
253 @item map
254 Map channels from input to output. The argument is a comma-separated list of
255 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
256 @var{in_channel} form. @var{in_channel} can be either the name of the input
257 channel (e.g. FL for front left) or its index in the input channel layout.
258 @var{out_channel} is the name of the output channel or its index in the output
259 channel layout. If @var{out_channel} is not given then it is implicitly an
260 index, starting with zero and increasing by one for each mapping.
261 @end table
262
263 If no mapping is present, the filter will implicitly map input channels to
264 output channels preserving index.
265
266 For example, assuming a 5.1+downmix input MOV file
267 @example
268 avconv -i in.mov -filter 'channelmap=map=DL-FL\,DR-FR' out.wav
269 @end example
270 will create an output WAV file tagged as stereo from the downmix channels of
271 the input.
272
273 To fix a 5.1 WAV improperly encoded in AAC's native channel order
274 @example
275 avconv -i in.wav -filter 'channelmap=1\,2\,0\,5\,3\,4:channel_layout=5.1' out.wav
276 @end example
277
278 @section join
279 Join multiple input streams into one multi-channel stream.
280
281 The filter accepts the following named parameters:
282 @table @option
283
284 @item inputs
285 Number of input streams. Defaults to 2.
286
287 @item channel_layout
288 Desired output channel layout. Defaults to stereo.
289
290 @item map
291 Map channels from inputs to output. The argument is a comma-separated list of
292 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
293 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
294 can be either the name of the input channel (e.g. FL for front left) or its
295 index in the specified input stream. @var{out_channel} is the name of the output
296 channel.
297 @end table
298
299 The filter will attempt to guess the mappings when those are not specified
300 explicitly. It does so by first trying to find an unused matching input channel
301 and if that fails it picks the first unused input channel.
302
303 E.g. to join 3 inputs (with properly set channel layouts)
304 @example
305 avconv -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
306 @end example
307
308 To build a 5.1 output from 6 single-channel streams:
309 @example
310 avconv -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
311 'join=inputs=6:channel_layout=5.1:map=0.0-FL\,1.0-FR\,2.0-FC\,3.0-SL\,4.0-SR\,5.0-LFE'
312 out
313 @end example
314
315 @section resample
316 Convert the audio sample format, sample rate and channel layout. This filter is
317 not meant to be used directly, it is inserted automatically by libavfilter
318 whenever conversion is needed. Use the @var{aformat} filter to force a specific
319 conversion.
320
321 @c man end AUDIO FILTERS
322
323 @chapter Audio Sources
324 @c man begin AUDIO SOURCES
325
326 Below is a description of the currently available audio sources.
327
328 @section anullsrc
329
330 Null audio source, never return audio frames. It is mainly useful as a
331 template and to be employed in analysis / debugging tools.
332
333 It accepts as optional parameter a string of the form
334 @var{sample_rate}:@var{channel_layout}.
335
336 @var{sample_rate} specify the sample rate, and defaults to 44100.
337
338 @var{channel_layout} specify the channel layout, and can be either an
339 integer or a string representing a channel layout. The default value
340 of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
341
342 Check the channel_layout_map definition in
343 @file{libavcodec/audioconvert.c} for the mapping between strings and
344 channel layout values.
345
346 Follow some examples:
347 @example
348 #  set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
349 anullsrc=48000:4
350
351 # same as
352 anullsrc=48000:mono
353 @end example
354
355 @section abuffer
356 Buffer audio frames, and make them available to the filter chain.
357
358 This source is not intended to be part of user-supplied graph descriptions but
359 for insertion by calling programs through the interface defined in
360 @file{libavfilter/buffersrc.h}.
361
362 It accepts the following named parameters:
363 @table @option
364
365 @item time_base
366 Timebase which will be used for timestamps of submitted frames. It must be
367 either a floating-point number or in @var{numerator}/@var{denominator} form.
368
369 @item sample_rate
370 Audio sample rate.
371
372 @item sample_fmt
373 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
374
375 @item channel_layout
376 Channel layout of the audio data, in the form that can be accepted by
377 @code{av_get_channel_layout()}.
378 @end table
379
380 All the parameters need to be explicitly defined.
381
382 @c man end AUDIO SOURCES
383
384 @chapter Audio Sinks
385 @c man begin AUDIO SINKS
386
387 Below is a description of the currently available audio sinks.
388
389 @section anullsink
390
391 Null audio sink, do absolutely nothing with the input audio. It is
392 mainly useful as a template and to be employed in analysis / debugging
393 tools.
394
395 @section abuffersink
396 This sink is intended for programmatic use. Frames that arrive on this sink can
397 be retrieved by the calling program using the interface defined in
398 @file{libavfilter/buffersink.h}.
399
400 This filter accepts no parameters.
401
402 @c man end AUDIO SINKS
403
404 @chapter Video Filters
405 @c man begin VIDEO FILTERS
406
407 When you configure your Libav build, you can disable any of the
408 existing filters using --disable-filters.
409 The configure output will show the video filters included in your
410 build.
411
412 Below is a description of the currently available video filters.
413
414 @section blackframe
415
416 Detect frames that are (almost) completely black. Can be useful to
417 detect chapter transitions or commercials. Output lines consist of
418 the frame number of the detected frame, the percentage of blackness,
419 the position in the file if known or -1 and the timestamp in seconds.
420
421 In order to display the output lines, you need to set the loglevel at
422 least to the AV_LOG_INFO value.
423
424 The filter accepts the syntax:
425 @example
426 blackframe[=@var{amount}:[@var{threshold}]]
427 @end example
428
429 @var{amount} is the percentage of the pixels that have to be below the
430 threshold, and defaults to 98.
431
432 @var{threshold} is the threshold below which a pixel value is
433 considered black, and defaults to 32.
434
435 @section boxblur
436
437 Apply boxblur algorithm to the input video.
438
439 This filter accepts the parameters:
440 @var{luma_power}:@var{luma_radius}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
441
442 Chroma and alpha parameters are optional, if not specified they default
443 to the corresponding values set for @var{luma_radius} and
444 @var{luma_power}.
445
446 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
447 the radius in pixels of the box used for blurring the corresponding
448 input plane. They are expressions, and can contain the following
449 constants:
450 @table @option
451 @item w, h
452 the input width and height in pixels
453
454 @item cw, ch
455 the input chroma image width and height in pixels
456
457 @item hsub, vsub
458 horizontal and vertical chroma subsample values. For example for the
459 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
460 @end table
461
462 The radius must be a non-negative number, and must not be greater than
463 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
464 and of @code{min(cw,ch)/2} for the chroma planes.
465
466 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
467 how many times the boxblur filter is applied to the corresponding
468 plane.
469
470 Some examples follow:
471
472 @itemize
473
474 @item
475 Apply a boxblur filter with luma, chroma, and alpha radius
476 set to 2:
477 @example
478 boxblur=2:1
479 @end example
480
481 @item
482 Set luma radius to 2, alpha and chroma radius to 0
483 @example
484 boxblur=2:1:0:0:0:0
485 @end example
486
487 @item
488 Set luma and chroma radius to a fraction of the video dimension
489 @example
490 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
491 @end example
492
493 @end itemize
494
495 @section copy
496
497 Copy the input source unchanged to the output. Mainly useful for
498 testing purposes.
499
500 @section crop
501
502 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}.
503
504 The parameters are expressions containing the following constants:
505
506 @table @option
507 @item E, PI, PHI
508 the corresponding mathematical approximated values for e
509 (euler number), pi (greek PI), PHI (golden ratio)
510
511 @item x, y
512 the computed values for @var{x} and @var{y}. They are evaluated for
513 each new frame.
514
515 @item in_w, in_h
516 the input width and height
517
518 @item iw, ih
519 same as @var{in_w} and @var{in_h}
520
521 @item out_w, out_h
522 the output (cropped) width and height
523
524 @item ow, oh
525 same as @var{out_w} and @var{out_h}
526
527 @item n
528 the number of input frame, starting from 0
529
530 @item pos
531 the position in the file of the input frame, NAN if unknown
532
533 @item t
534 timestamp expressed in seconds, NAN if the input timestamp is unknown
535
536 @end table
537
538 The @var{out_w} and @var{out_h} parameters specify the expressions for
539 the width and height of the output (cropped) video. They are
540 evaluated just at the configuration of the filter.
541
542 The default value of @var{out_w} is "in_w", and the default value of
543 @var{out_h} is "in_h".
544
545 The expression for @var{out_w} may depend on the value of @var{out_h},
546 and the expression for @var{out_h} may depend on @var{out_w}, but they
547 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
548 evaluated after @var{out_w} and @var{out_h}.
549
550 The @var{x} and @var{y} parameters specify the expressions for the
551 position of the top-left corner of the output (non-cropped) area. They
552 are evaluated for each frame. If the evaluated value is not valid, it
553 is approximated to the nearest valid value.
554
555 The default value of @var{x} is "(in_w-out_w)/2", and the default
556 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
557 the center of the input image.
558
559 The expression for @var{x} may depend on @var{y}, and the expression
560 for @var{y} may depend on @var{x}.
561
562 Follow some examples:
563 @example
564 # crop the central input area with size 100x100
565 crop=100:100
566
567 # crop the central input area with size 2/3 of the input video
568 "crop=2/3*in_w:2/3*in_h"
569
570 # crop the input video central square
571 crop=in_h
572
573 # delimit the rectangle with the top-left corner placed at position
574 # 100:100 and the right-bottom corner corresponding to the right-bottom
575 # corner of the input image.
576 crop=in_w-100:in_h-100:100:100
577
578 # crop 10 pixels from the left and right borders, and 20 pixels from
579 # the top and bottom borders
580 "crop=in_w-2*10:in_h-2*20"
581
582 # keep only the bottom right quarter of the input image
583 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
584
585 # crop height for getting Greek harmony
586 "crop=in_w:1/PHI*in_w"
587
588 # trembling effect
589 "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)"
590
591 # erratic camera effect depending on timestamp
592 "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)"
593
594 # set x depending on the value of y
595 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
596 @end example
597
598 @section cropdetect
599
600 Auto-detect crop size.
601
602 Calculate necessary cropping parameters and prints the recommended
603 parameters through the logging system. The detected dimensions
604 correspond to the non-black area of the input video.
605
606 It accepts the syntax:
607 @example
608 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
609 @end example
610
611 @table @option
612
613 @item limit
614 Threshold, which can be optionally specified from nothing (0) to
615 everything (255), defaults to 24.
616
617 @item round
618 Value which the width/height should be divisible by, defaults to
619 16. The offset is automatically adjusted to center the video. Use 2 to
620 get only even dimensions (needed for 4:2:2 video). 16 is best when
621 encoding to most video codecs.
622
623 @item reset
624 Counter that determines after how many frames cropdetect will reset
625 the previously detected largest video area and start over to detect
626 the current optimal crop area. Defaults to 0.
627
628 This can be useful when channel logos distort the video area. 0
629 indicates never reset and return the largest area encountered during
630 playback.
631 @end table
632
633 @section delogo
634
635 Suppress a TV station logo by a simple interpolation of the surrounding
636 pixels. Just set a rectangle covering the logo and watch it disappear
637 (and sometimes something even uglier appear - your mileage may vary).
638
639 The filter accepts parameters as a string of the form
640 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
641 @var{key}=@var{value} pairs, separated by ":".
642
643 The description of the accepted parameters follows.
644
645 @table @option
646
647 @item x, y
648 Specify the top left corner coordinates of the logo. They must be
649 specified.
650
651 @item w, h
652 Specify the width and height of the logo to clear. They must be
653 specified.
654
655 @item band, t
656 Specify the thickness of the fuzzy edge of the rectangle (added to
657 @var{w} and @var{h}). The default value is 4.
658
659 @item show
660 When set to 1, a green rectangle is drawn on the screen to simplify
661 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
662 @var{band} is set to 4. The default value is 0.
663
664 @end table
665
666 Some examples follow.
667
668 @itemize
669
670 @item
671 Set a rectangle covering the area with top left corner coordinates 0,0
672 and size 100x77, setting a band of size 10:
673 @example
674 delogo=0:0:100:77:10
675 @end example
676
677 @item
678 As the previous example, but use named options:
679 @example
680 delogo=x=0:y=0:w=100:h=77:band=10
681 @end example
682
683 @end itemize
684
685 @section drawbox
686
687 Draw a colored box on the input image.
688
689 It accepts the syntax:
690 @example
691 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
692 @end example
693
694 @table @option
695
696 @item x, y
697 Specify the top left corner coordinates of the box. Default to 0.
698
699 @item width, height
700 Specify the width and height of the box, if 0 they are interpreted as
701 the input width and height. Default to 0.
702
703 @item color
704 Specify the color of the box to write, it can be the name of a color
705 (case insensitive match) or a 0xRRGGBB[AA] sequence.
706 @end table
707
708 Follow some examples:
709 @example
710 # draw a black box around the edge of the input image
711 drawbox
712
713 # draw a box with color red and an opacity of 50%
714 drawbox=10:20:200:60:red@@0.5"
715 @end example
716
717 @section drawtext
718
719 Draw text string or text from specified file on top of video using the
720 libfreetype library.
721
722 To enable compilation of this filter you need to configure Libav with
723 @code{--enable-libfreetype}.
724
725 The filter also recognizes strftime() sequences in the provided text
726 and expands them accordingly. Check the documentation of strftime().
727
728 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
729 separated by ":".
730
731 The description of the accepted parameters follows.
732
733 @table @option
734
735 @item fontfile
736 The font file to be used for drawing text. Path must be included.
737 This parameter is mandatory.
738
739 @item text
740 The text string to be drawn. The text must be a sequence of UTF-8
741 encoded characters.
742 This parameter is mandatory if no file is specified with the parameter
743 @var{textfile}.
744
745 @item textfile
746 A text file containing text to be drawn. The text must be a sequence
747 of UTF-8 encoded characters.
748
749 This parameter is mandatory if no text string is specified with the
750 parameter @var{text}.
751
752 If both text and textfile are specified, an error is thrown.
753
754 @item x, y
755 The offsets where text will be drawn within the video frame.
756 Relative to the top/left border of the output image.
757 They accept expressions similar to the @ref{overlay} filter:
758 @table @option
759
760 @item x, y
761 the computed values for @var{x} and @var{y}. They are evaluated for
762 each new frame.
763
764 @item main_w, main_h
765 main input width and height
766
767 @item W, H
768 same as @var{main_w} and @var{main_h}
769
770 @item text_w, text_h
771 rendered text width and height
772
773 @item w, h
774 same as @var{text_w} and @var{text_h}
775
776 @item n
777 the number of frames processed, starting from 0
778
779 @item t
780 timestamp expressed in seconds, NAN if the input timestamp is unknown
781
782 @end table
783
784 The default value of @var{x} and @var{y} is 0.
785
786 @item fontsize
787 The font size to be used for drawing text.
788 The default value of @var{fontsize} is 16.
789
790 @item fontcolor
791 The color to be used for drawing fonts.
792 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
793 (e.g. "0xff000033"), possibly followed by an alpha specifier.
794 The default value of @var{fontcolor} is "black".
795
796 @item boxcolor
797 The color to be used for drawing box around text.
798 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
799 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
800 The default value of @var{boxcolor} is "white".
801
802 @item box
803 Used to draw a box around text using background color.
804 Value should be either 1 (enable) or 0 (disable).
805 The default value of @var{box} is 0.
806
807 @item shadowx, shadowy
808 The x and y offsets for the text shadow position with respect to the
809 position of the text. They can be either positive or negative
810 values. Default value for both is "0".
811
812 @item shadowcolor
813 The color to be used for drawing a shadow behind the drawn text.  It
814 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
815 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
816 The default value of @var{shadowcolor} is "black".
817
818 @item ft_load_flags
819 Flags to be used for loading the fonts.
820
821 The flags map the corresponding flags supported by libfreetype, and are
822 a combination of the following values:
823 @table @var
824 @item default
825 @item no_scale
826 @item no_hinting
827 @item render
828 @item no_bitmap
829 @item vertical_layout
830 @item force_autohint
831 @item crop_bitmap
832 @item pedantic
833 @item ignore_global_advance_width
834 @item no_recurse
835 @item ignore_transform
836 @item monochrome
837 @item linear_design
838 @item no_autohint
839 @item end table
840 @end table
841
842 Default value is "render".
843
844 For more information consult the documentation for the FT_LOAD_*
845 libfreetype flags.
846
847 @item tabsize
848 The size in number of spaces to use for rendering the tab.
849 Default value is 4.
850
851 @item fix_bounds
852 If true, check and fix text coords to avoid clipping.
853 @end table
854
855 For example the command:
856 @example
857 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
858 @end example
859
860 will draw "Test Text" with font FreeSerif, using the default values
861 for the optional parameters.
862
863 The command:
864 @example
865 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
866           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
867 @end example
868
869 will draw 'Test Text' with font FreeSerif of size 24 at position x=100
870 and y=50 (counting from the top-left corner of the screen), text is
871 yellow with a red box around it. Both the text and the box have an
872 opacity of 20%.
873
874 Note that the double quotes are not necessary if spaces are not used
875 within the parameter list.
876
877 For more information about libfreetype, check:
878 @url{http://www.freetype.org/}.
879
880 @section fade
881
882 Apply fade-in/out effect to input video.
883
884 It accepts the parameters:
885 @var{type}:@var{start_frame}:@var{nb_frames}
886
887 @var{type} specifies if the effect type, can be either "in" for
888 fade-in, or "out" for a fade-out effect.
889
890 @var{start_frame} specifies the number of the start frame for starting
891 to apply the fade effect.
892
893 @var{nb_frames} specifies the number of frames for which the fade
894 effect has to last. At the end of the fade-in effect the output video
895 will have the same intensity as the input video, at the end of the
896 fade-out transition the output video will be completely black.
897
898 A few usage examples follow, usable too as test scenarios.
899 @example
900 # fade in first 30 frames of video
901 fade=in:0:30
902
903 # fade out last 45 frames of a 200-frame video
904 fade=out:155:45
905
906 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
907 fade=in:0:25, fade=out:975:25
908
909 # make first 5 frames black, then fade in from frame 5-24
910 fade=in:5:20
911 @end example
912
913 @section fieldorder
914
915 Transform the field order of the input video.
916
917 It accepts one parameter which specifies the required field order that
918 the input interlaced video will be transformed to. The parameter can
919 assume one of the following values:
920
921 @table @option
922 @item 0 or bff
923 output bottom field first
924 @item 1 or tff
925 output top field first
926 @end table
927
928 Default value is "tff".
929
930 Transformation is achieved by shifting the picture content up or down
931 by one line, and filling the remaining line with appropriate picture content.
932 This method is consistent with most broadcast field order converters.
933
934 If the input video is not flagged as being interlaced, or it is already
935 flagged as being of the required output field order then this filter does
936 not alter the incoming video.
937
938 This filter is very useful when converting to or from PAL DV material,
939 which is bottom field first.
940
941 For example:
942 @example
943 ./avconv -i in.vob -vf "fieldorder=bff" out.dv
944 @end example
945
946 @section fifo
947
948 Buffer input images and send them when they are requested.
949
950 This filter is mainly useful when auto-inserted by the libavfilter
951 framework.
952
953 The filter does not take parameters.
954
955 @section format
956
957 Convert the input video to one of the specified pixel formats.
958 Libavfilter will try to pick one that is supported for the input to
959 the next filter.
960
961 The filter accepts a list of pixel format names, separated by ":",
962 for example "yuv420p:monow:rgb24".
963
964 Some examples follow:
965 @example
966 # convert the input video to the format "yuv420p"
967 format=yuv420p
968
969 # convert the input video to any of the formats in the list
970 format=yuv420p:yuv444p:yuv410p
971 @end example
972
973 @section fps
974
975 Convert the video to specified constant framerate by duplicating or dropping
976 frames as necessary.
977
978 This filter accepts the following named parameters:
979 @table @option
980
981 @item fps
982 Desired output framerate.
983
984 @end table
985
986 @anchor{frei0r}
987 @section frei0r
988
989 Apply a frei0r effect to the input video.
990
991 To enable compilation of this filter you need to install the frei0r
992 header and configure Libav with --enable-frei0r.
993
994 The filter supports the syntax:
995 @example
996 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
997 @end example
998
999 @var{filter_name} is the name to the frei0r effect to load. If the
1000 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
1001 is searched in each one of the directories specified by the colon
1002 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
1003 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
1004 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
1005
1006 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
1007 for the frei0r effect.
1008
1009 A frei0r effect parameter can be a boolean (whose values are specified
1010 with "y" and "n"), a double, a color (specified by the syntax
1011 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1012 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1013 description), a position (specified by the syntax @var{X}/@var{Y},
1014 @var{X} and @var{Y} being float numbers) and a string.
1015
1016 The number and kind of parameters depend on the loaded effect. If an
1017 effect parameter is not specified the default value is set.
1018
1019 Some examples follow:
1020 @example
1021 # apply the distort0r effect, set the first two double parameters
1022 frei0r=distort0r:0.5:0.01
1023
1024 # apply the colordistance effect, takes a color as first parameter
1025 frei0r=colordistance:0.2/0.3/0.4
1026 frei0r=colordistance:violet
1027 frei0r=colordistance:0x112233
1028
1029 # apply the perspective effect, specify the top left and top right
1030 # image positions
1031 frei0r=perspective:0.2/0.2:0.8/0.2
1032 @end example
1033
1034 For more information see:
1035 @url{http://piksel.org/frei0r}
1036
1037 @section gradfun
1038
1039 Fix the banding artifacts that are sometimes introduced into nearly flat
1040 regions by truncation to 8bit colordepth.
1041 Interpolate the gradients that should go where the bands are, and
1042 dither them.
1043
1044 This filter is designed for playback only.  Do not use it prior to
1045 lossy compression, because compression tends to lose the dither and
1046 bring back the bands.
1047
1048 The filter takes two optional parameters, separated by ':':
1049 @var{strength}:@var{radius}
1050
1051 @var{strength} is the maximum amount by which the filter will change
1052 any one pixel. Also the threshold for detecting nearly flat
1053 regions. Acceptable values range from .51 to 255, default value is
1054 1.2, out-of-range values will be clipped to the valid range.
1055
1056 @var{radius} is the neighborhood to fit the gradient to. A larger
1057 radius makes for smoother gradients, but also prevents the filter from
1058 modifying the pixels near detailed regions. Acceptable values are
1059 8-32, default value is 16, out-of-range values will be clipped to the
1060 valid range.
1061
1062 @example
1063 # default parameters
1064 gradfun=1.2:16
1065
1066 # omitting radius
1067 gradfun=1.2
1068 @end example
1069
1070 @section hflip
1071
1072 Flip the input video horizontally.
1073
1074 For example to horizontally flip the input video with @command{avconv}:
1075 @example
1076 avconv -i in.avi -vf "hflip" out.avi
1077 @end example
1078
1079 @section hqdn3d
1080
1081 High precision/quality 3d denoise filter. This filter aims to reduce
1082 image noise producing smooth images and making still images really
1083 still. It should enhance compressibility.
1084
1085 It accepts the following optional parameters:
1086 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
1087
1088 @table @option
1089 @item luma_spatial
1090 a non-negative float number which specifies spatial luma strength,
1091 defaults to 4.0
1092
1093 @item chroma_spatial
1094 a non-negative float number which specifies spatial chroma strength,
1095 defaults to 3.0*@var{luma_spatial}/4.0
1096
1097 @item luma_tmp
1098 a float number which specifies luma temporal strength, defaults to
1099 6.0*@var{luma_spatial}/4.0
1100
1101 @item chroma_tmp
1102 a float number which specifies chroma temporal strength, defaults to
1103 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1104 @end table
1105
1106 @section lut, lutrgb, lutyuv
1107
1108 Compute a look-up table for binding each pixel component input value
1109 to an output value, and apply it to input video.
1110
1111 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1112 to an RGB input video.
1113
1114 These filters accept in input a ":"-separated list of options, which
1115 specify the expressions used for computing the lookup table for the
1116 corresponding pixel component values.
1117
1118 The @var{lut} filter requires either YUV or RGB pixel formats in
1119 input, and accepts the options:
1120 @table @option
1121 @var{c0} (first  pixel component)
1122 @var{c1} (second pixel component)
1123 @var{c2} (third  pixel component)
1124 @var{c3} (fourth pixel component, corresponds to the alpha component)
1125 @end table
1126
1127 The exact component associated to each option depends on the format in
1128 input.
1129
1130 The @var{lutrgb} filter requires RGB pixel formats in input, and
1131 accepts the options:
1132 @table @option
1133 @var{r} (red component)
1134 @var{g} (green component)
1135 @var{b} (blue component)
1136 @var{a} (alpha component)
1137 @end table
1138
1139 The @var{lutyuv} filter requires YUV pixel formats in input, and
1140 accepts the options:
1141 @table @option
1142 @var{y} (Y/luminance component)
1143 @var{u} (U/Cb component)
1144 @var{v} (V/Cr component)
1145 @var{a} (alpha component)
1146 @end table
1147
1148 The expressions can contain the following constants and functions:
1149
1150 @table @option
1151 @item E, PI, PHI
1152 the corresponding mathematical approximated values for e
1153 (euler number), pi (greek PI), PHI (golden ratio)
1154
1155 @item w, h
1156 the input width and height
1157
1158 @item val
1159 input value for the pixel component
1160
1161 @item clipval
1162 the input value clipped in the @var{minval}-@var{maxval} range
1163
1164 @item maxval
1165 maximum value for the pixel component
1166
1167 @item minval
1168 minimum value for the pixel component
1169
1170 @item negval
1171 the negated value for the pixel component value clipped in the
1172 @var{minval}-@var{maxval} range , it corresponds to the expression
1173 "maxval-clipval+minval"
1174
1175 @item clip(val)
1176 the computed value in @var{val} clipped in the
1177 @var{minval}-@var{maxval} range
1178
1179 @item gammaval(gamma)
1180 the computed gamma correction value of the pixel component value
1181 clipped in the @var{minval}-@var{maxval} range, corresponds to the
1182 expression
1183 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1184
1185 @end table
1186
1187 All expressions default to "val".
1188
1189 Some examples follow:
1190 @example
1191 # negate input video
1192 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1193 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1194
1195 # the above is the same as
1196 lutrgb="r=negval:g=negval:b=negval"
1197 lutyuv="y=negval:u=negval:v=negval"
1198
1199 # negate luminance
1200 lutyuv=negval
1201
1202 # remove chroma components, turns the video into a graytone image
1203 lutyuv="u=128:v=128"
1204
1205 # apply a luma burning effect
1206 lutyuv="y=2*val"
1207
1208 # remove green and blue components
1209 lutrgb="g=0:b=0"
1210
1211 # set a constant alpha channel value on input
1212 format=rgba,lutrgb=a="maxval-minval/2"
1213
1214 # correct luminance gamma by a 0.5 factor
1215 lutyuv=y=gammaval(0.5)
1216 @end example
1217
1218 @section negate
1219
1220 Negate input video.
1221
1222 This filter accepts an integer in input, if non-zero it negates the
1223 alpha component (if available). The default value in input is 0.
1224
1225 Force libavfilter not to use any of the specified pixel formats for the
1226 input to the next filter.
1227
1228 The filter accepts a list of pixel format names, separated by ":",
1229 for example "yuv420p:monow:rgb24".
1230
1231 Some examples follow:
1232 @example
1233 # force libavfilter to use a format different from "yuv420p" for the
1234 # input to the vflip filter
1235 noformat=yuv420p,vflip
1236
1237 # convert the input video to any of the formats not contained in the list
1238 noformat=yuv420p:yuv444p:yuv410p
1239 @end example
1240
1241 @section null
1242
1243 Pass the video source unchanged to the output.
1244
1245 @section ocv
1246
1247 Apply video transform using libopencv.
1248
1249 To enable this filter install libopencv library and headers and
1250 configure Libav with --enable-libopencv.
1251
1252 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
1253
1254 @var{filter_name} is the name of the libopencv filter to apply.
1255
1256 @var{filter_params} specifies the parameters to pass to the libopencv
1257 filter. If not specified the default values are assumed.
1258
1259 Refer to the official libopencv documentation for more precise
1260 information:
1261 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1262
1263 Follows the list of supported libopencv filters.
1264
1265 @anchor{dilate}
1266 @subsection dilate
1267
1268 Dilate an image by using a specific structuring element.
1269 This filter corresponds to the libopencv function @code{cvDilate}.
1270
1271 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
1272
1273 @var{struct_el} represents a structuring element, and has the syntax:
1274 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1275
1276 @var{cols} and @var{rows} represent the number of columns and rows of
1277 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1278 point, and @var{shape} the shape for the structuring element, and
1279 can be one of the values "rect", "cross", "ellipse", "custom".
1280
1281 If the value for @var{shape} is "custom", it must be followed by a
1282 string of the form "=@var{filename}". The file with name
1283 @var{filename} is assumed to represent a binary image, with each
1284 printable character corresponding to a bright pixel. When a custom
1285 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1286 or columns and rows of the read file are assumed instead.
1287
1288 The default value for @var{struct_el} is "3x3+0x0/rect".
1289
1290 @var{nb_iterations} specifies the number of times the transform is
1291 applied to the image, and defaults to 1.
1292
1293 Follow some example:
1294 @example
1295 # use the default values
1296 ocv=dilate
1297
1298 # dilate using a structuring element with a 5x5 cross, iterate two times
1299 ocv=dilate=5x5+2x2/cross:2
1300
1301 # read the shape from the file diamond.shape, iterate two times
1302 # the file diamond.shape may contain a pattern of characters like this:
1303 #   *
1304 #  ***
1305 # *****
1306 #  ***
1307 #   *
1308 # the specified cols and rows are ignored (but not the anchor point coordinates)
1309 ocv=0x0+2x2/custom=diamond.shape:2
1310 @end example
1311
1312 @subsection erode
1313
1314 Erode an image by using a specific structuring element.
1315 This filter corresponds to the libopencv function @code{cvErode}.
1316
1317 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1318 with the same syntax and semantics as the @ref{dilate} filter.
1319
1320 @subsection smooth
1321
1322 Smooth the input video.
1323
1324 The filter takes the following parameters:
1325 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
1326
1327 @var{type} is the type of smooth filter to apply, and can be one of
1328 the following values: "blur", "blur_no_scale", "median", "gaussian",
1329 "bilateral". The default value is "gaussian".
1330
1331 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1332 parameters whose meanings depend on smooth type. @var{param1} and
1333 @var{param2} accept integer positive values or 0, @var{param3} and
1334 @var{param4} accept float values.
1335
1336 The default value for @var{param1} is 3, the default value for the
1337 other parameters is 0.
1338
1339 These parameters correspond to the parameters assigned to the
1340 libopencv function @code{cvSmooth}.
1341
1342 @anchor{overlay}
1343 @section overlay
1344
1345 Overlay one video on top of another.
1346
1347 It takes two inputs and one output, the first input is the "main"
1348 video on which the second input is overlayed.
1349
1350 It accepts the parameters: @var{x}:@var{y}.
1351
1352 @var{x} is the x coordinate of the overlayed video on the main video,
1353 @var{y} is the y coordinate. The parameters are expressions containing
1354 the following parameters:
1355
1356 @table @option
1357 @item main_w, main_h
1358 main input width and height
1359
1360 @item W, H
1361 same as @var{main_w} and @var{main_h}
1362
1363 @item overlay_w, overlay_h
1364 overlay input width and height
1365
1366 @item w, h
1367 same as @var{overlay_w} and @var{overlay_h}
1368 @end table
1369
1370 Be aware that frames are taken from each input video in timestamp
1371 order, hence, if their initial timestamps differ, it is a a good idea
1372 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1373 have them begin in the same zero timestamp, as it does the example for
1374 the @var{movie} filter.
1375
1376 Follow some examples:
1377 @example
1378 # draw the overlay at 10 pixels from the bottom right
1379 # corner of the main video.
1380 overlay=main_w-overlay_w-10:main_h-overlay_h-10
1381
1382 # insert a transparent PNG logo in the bottom left corner of the input
1383 avconv -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
1384
1385 # insert 2 different transparent PNG logos (second logo on bottom
1386 # right corner):
1387 avconv -i input -i logo1 -i logo2 -filter_complex
1388 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
1389
1390 # add a transparent color layer on top of the main video,
1391 # WxH specifies the size of the main input to the overlay filter
1392 color=red@.3:WxH [over]; [in][over] overlay [out]
1393 @end example
1394
1395 You can chain together more overlays but the efficiency of such
1396 approach is yet to be tested.
1397
1398 @section pad
1399
1400 Add paddings to the input image, and places the original input at the
1401 given coordinates @var{x}, @var{y}.
1402
1403 It accepts the following parameters:
1404 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
1405
1406 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1407 expressions containing the following constants:
1408
1409 @table @option
1410 @item E, PI, PHI
1411 the corresponding mathematical approximated values for e
1412 (euler number), pi (greek PI), phi (golden ratio)
1413
1414 @item in_w, in_h
1415 the input video width and height
1416
1417 @item iw, ih
1418 same as @var{in_w} and @var{in_h}
1419
1420 @item out_w, out_h
1421 the output width and height, that is the size of the padded area as
1422 specified by the @var{width} and @var{height} expressions
1423
1424 @item ow, oh
1425 same as @var{out_w} and @var{out_h}
1426
1427 @item x, y
1428 x and y offsets as specified by the @var{x} and @var{y}
1429 expressions, or NAN if not yet specified
1430
1431 @item a
1432 input display aspect ratio, same as @var{iw} / @var{ih}
1433
1434 @item hsub, vsub
1435 horizontal and vertical chroma subsample values. For example for the
1436 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1437 @end table
1438
1439 Follows the description of the accepted parameters.
1440
1441 @table @option
1442 @item width, height
1443
1444 Specify the size of the output image with the paddings added. If the
1445 value for @var{width} or @var{height} is 0, the corresponding input size
1446 is used for the output.
1447
1448 The @var{width} expression can reference the value set by the
1449 @var{height} expression, and vice versa.
1450
1451 The default value of @var{width} and @var{height} is 0.
1452
1453 @item x, y
1454
1455 Specify the offsets where to place the input image in the padded area
1456 with respect to the top/left border of the output image.
1457
1458 The @var{x} expression can reference the value set by the @var{y}
1459 expression, and vice versa.
1460
1461 The default value of @var{x} and @var{y} is 0.
1462
1463 @item color
1464
1465 Specify the color of the padded area, it can be the name of a color
1466 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1467
1468 The default value of @var{color} is "black".
1469
1470 @end table
1471
1472 Some examples follow:
1473
1474 @example
1475 # Add paddings with color "violet" to the input video. Output video
1476 # size is 640x480, the top-left corner of the input video is placed at
1477 # column 0, row 40.
1478 pad=640:480:0:40:violet
1479
1480 # pad the input to get an output with dimensions increased bt 3/2,
1481 # and put the input video at the center of the padded area
1482 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1483
1484 # pad the input to get a squared output with size equal to the maximum
1485 # value between the input width and height, and put the input video at
1486 # the center of the padded area
1487 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1488
1489 # pad the input to get a final w/h ratio of 16:9
1490 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1491
1492 # double output size and put the input video in the bottom-right
1493 # corner of the output padded area
1494 pad="2*iw:2*ih:ow-iw:oh-ih"
1495 @end example
1496
1497 @section pixdesctest
1498
1499 Pixel format descriptor test filter, mainly useful for internal
1500 testing. The output video should be equal to the input video.
1501
1502 For example:
1503 @example
1504 format=monow, pixdesctest
1505 @end example
1506
1507 can be used to test the monowhite pixel format descriptor definition.
1508
1509 @section scale
1510
1511 Scale the input video to @var{width}:@var{height} and/or convert the image format.
1512
1513 The parameters @var{width} and @var{height} are expressions containing
1514 the following constants:
1515
1516 @table @option
1517 @item E, PI, PHI
1518 the corresponding mathematical approximated values for e
1519 (euler number), pi (greek PI), phi (golden ratio)
1520
1521 @item in_w, in_h
1522 the input width and height
1523
1524 @item iw, ih
1525 same as @var{in_w} and @var{in_h}
1526
1527 @item out_w, out_h
1528 the output (cropped) width and height
1529
1530 @item ow, oh
1531 same as @var{out_w} and @var{out_h}
1532
1533 @item dar, a
1534 input display aspect ratio, same as @var{iw} / @var{ih}
1535
1536 @item sar
1537 input sample aspect ratio
1538
1539 @item hsub, vsub
1540 horizontal and vertical chroma subsample values. For example for the
1541 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1542 @end table
1543
1544 If the input image format is different from the format requested by
1545 the next filter, the scale filter will convert the input to the
1546 requested format.
1547
1548 If the value for @var{width} or @var{height} is 0, the respective input
1549 size is used for the output.
1550
1551 If the value for @var{width} or @var{height} is -1, the scale filter will
1552 use, for the respective output size, a value that maintains the aspect
1553 ratio of the input image.
1554
1555 The default value of @var{width} and @var{height} is 0.
1556
1557 Some examples follow:
1558 @example
1559 # scale the input video to a size of 200x100.
1560 scale=200:100
1561
1562 # scale the input to 2x
1563 scale=2*iw:2*ih
1564 # the above is the same as
1565 scale=2*in_w:2*in_h
1566
1567 # scale the input to half size
1568 scale=iw/2:ih/2
1569
1570 # increase the width, and set the height to the same size
1571 scale=3/2*iw:ow
1572
1573 # seek for Greek harmony
1574 scale=iw:1/PHI*iw
1575 scale=ih*PHI:ih
1576
1577 # increase the height, and set the width to 3/2 of the height
1578 scale=3/2*oh:3/5*ih
1579
1580 # increase the size, but make the size a multiple of the chroma
1581 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1582
1583 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1584 scale='min(500\, iw*3/2):-1'
1585 @end example
1586
1587 @section select
1588 Select frames to pass in output.
1589
1590 It accepts in input an expression, which is evaluated for each input
1591 frame. If the expression is evaluated to a non-zero value, the frame
1592 is selected and passed to the output, otherwise it is discarded.
1593
1594 The expression can contain the following constants:
1595
1596 @table @option
1597 @item PI
1598 Greek PI
1599
1600 @item PHI
1601 golden ratio
1602
1603 @item E
1604 Euler number
1605
1606 @item n
1607 the sequential number of the filtered frame, starting from 0
1608
1609 @item selected_n
1610 the sequential number of the selected frame, starting from 0
1611
1612 @item prev_selected_n
1613 the sequential number of the last selected frame, NAN if undefined
1614
1615 @item TB
1616 timebase of the input timestamps
1617
1618 @item pts
1619 the PTS (Presentation TimeStamp) of the filtered video frame,
1620 expressed in @var{TB} units, NAN if undefined
1621
1622 @item t
1623 the PTS (Presentation TimeStamp) of the filtered video frame,
1624 expressed in seconds, NAN if undefined
1625
1626 @item prev_pts
1627 the PTS of the previously filtered video frame, NAN if undefined
1628
1629 @item prev_selected_pts
1630 the PTS of the last previously filtered video frame, NAN if undefined
1631
1632 @item prev_selected_t
1633 the PTS of the last previously selected video frame, NAN if undefined
1634
1635 @item start_pts
1636 the PTS of the first video frame in the video, NAN if undefined
1637
1638 @item start_t
1639 the time of the first video frame in the video, NAN if undefined
1640
1641 @item pict_type
1642 the type of the filtered frame, can assume one of the following
1643 values:
1644 @table @option
1645 @item I
1646 @item P
1647 @item B
1648 @item S
1649 @item SI
1650 @item SP
1651 @item BI
1652 @end table
1653
1654 @item interlace_type
1655 the frame interlace type, can assume one of the following values:
1656 @table @option
1657 @item PROGRESSIVE
1658 the frame is progressive (not interlaced)
1659 @item TOPFIRST
1660 the frame is top-field-first
1661 @item BOTTOMFIRST
1662 the frame is bottom-field-first
1663 @end table
1664
1665 @item key
1666 1 if the filtered frame is a key-frame, 0 otherwise
1667
1668 @item pos
1669 the position in the file of the filtered frame, -1 if the information
1670 is not available (e.g. for synthetic video)
1671 @end table
1672
1673 The default value of the select expression is "1".
1674
1675 Some examples follow:
1676
1677 @example
1678 # select all frames in input
1679 select
1680
1681 # the above is the same as:
1682 select=1
1683
1684 # skip all frames:
1685 select=0
1686
1687 # select only I-frames
1688 select='eq(pict_type\,I)'
1689
1690 # select one frame every 100
1691 select='not(mod(n\,100))'
1692
1693 # select only frames contained in the 10-20 time interval
1694 select='gte(t\,10)*lte(t\,20)'
1695
1696 # select only I frames contained in the 10-20 time interval
1697 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
1698
1699 # select frames with a minimum distance of 10 seconds
1700 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
1701 @end example
1702
1703 @anchor{setdar}
1704 @section setdar
1705
1706 Set the Display Aspect Ratio for the filter output video.
1707
1708 This is done by changing the specified Sample (aka Pixel) Aspect
1709 Ratio, according to the following equation:
1710 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1711
1712 Keep in mind that this filter does not modify the pixel dimensions of
1713 the video frame. Also the display aspect ratio set by this filter may
1714 be changed by later filters in the filterchain, e.g. in case of
1715 scaling or if another "setdar" or a "setsar" filter is applied.
1716
1717 The filter accepts a parameter string which represents the wanted
1718 display aspect ratio.
1719 The parameter can be a floating point number string, or an expression
1720 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1721 numerator and denominator of the aspect ratio.
1722 If the parameter is not specified, it is assumed the value "0:1".
1723
1724 For example to change the display aspect ratio to 16:9, specify:
1725 @example
1726 setdar=16:9
1727 # the above is equivalent to
1728 setdar=1.77777
1729 @end example
1730
1731 See also the @ref{setsar} filter documentation.
1732
1733 @section setpts
1734
1735 Change the PTS (presentation timestamp) of the input video frames.
1736
1737 Accept in input an expression evaluated through the eval API, which
1738 can contain the following constants:
1739
1740 @table @option
1741 @item PTS
1742 the presentation timestamp in input
1743
1744 @item PI
1745 Greek PI
1746
1747 @item PHI
1748 golden ratio
1749
1750 @item E
1751 Euler number
1752
1753 @item N
1754 the count of the input frame, starting from 0.
1755
1756 @item STARTPTS
1757 the PTS of the first video frame
1758
1759 @item INTERLACED
1760 tell if the current frame is interlaced
1761
1762 @item POS
1763 original position in the file of the frame, or undefined if undefined
1764 for the current frame
1765
1766 @item PREV_INPTS
1767 previous input PTS
1768
1769 @item PREV_OUTPTS
1770 previous output PTS
1771
1772 @end table
1773
1774 Some examples follow:
1775
1776 @example
1777 # start counting PTS from zero
1778 setpts=PTS-STARTPTS
1779
1780 # fast motion
1781 setpts=0.5*PTS
1782
1783 # slow motion
1784 setpts=2.0*PTS
1785
1786 # fixed rate 25 fps
1787 setpts=N/(25*TB)
1788
1789 # fixed rate 25 fps with some jitter
1790 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
1791 @end example
1792
1793 @anchor{setsar}
1794 @section setsar
1795
1796 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1797
1798 Note that as a consequence of the application of this filter, the
1799 output display aspect ratio will change according to the following
1800 equation:
1801 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1802
1803 Keep in mind that the sample aspect ratio set by this filter may be
1804 changed by later filters in the filterchain, e.g. if another "setsar"
1805 or a "setdar" filter is applied.
1806
1807 The filter accepts a parameter string which represents the wanted
1808 sample aspect ratio.
1809 The parameter can be a floating point number string, or an expression
1810 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1811 numerator and denominator of the aspect ratio.
1812 If the parameter is not specified, it is assumed the value "0:1".
1813
1814 For example to change the sample aspect ratio to 10:11, specify:
1815 @example
1816 setsar=10:11
1817 @end example
1818
1819 @section settb
1820
1821 Set the timebase to use for the output frames timestamps.
1822 It is mainly useful for testing timebase configuration.
1823
1824 It accepts in input an arithmetic expression representing a rational.
1825 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
1826 default timebase), and "intb" (the input timebase).
1827
1828 The default value for the input is "intb".
1829
1830 Follow some examples.
1831
1832 @example
1833 # set the timebase to 1/25
1834 settb=1/25
1835
1836 # set the timebase to 1/10
1837 settb=0.1
1838
1839 #set the timebase to 1001/1000
1840 settb=1+0.001
1841
1842 #set the timebase to 2*intb
1843 settb=2*intb
1844
1845 #set the default timebase value
1846 settb=AVTB
1847 @end example
1848
1849 @section showinfo
1850
1851 Show a line containing various information for each input video frame.
1852 The input video is not modified.
1853
1854 The shown line contains a sequence of key/value pairs of the form
1855 @var{key}:@var{value}.
1856
1857 A description of each shown parameter follows:
1858
1859 @table @option
1860 @item n
1861 sequential number of the input frame, starting from 0
1862
1863 @item pts
1864 Presentation TimeStamp of the input frame, expressed as a number of
1865 time base units. The time base unit depends on the filter input pad.
1866
1867 @item pts_time
1868 Presentation TimeStamp of the input frame, expressed as a number of
1869 seconds
1870
1871 @item pos
1872 position of the frame in the input stream, -1 if this information in
1873 unavailable and/or meaningless (for example in case of synthetic video)
1874
1875 @item fmt
1876 pixel format name
1877
1878 @item sar
1879 sample aspect ratio of the input frame, expressed in the form
1880 @var{num}/@var{den}
1881
1882 @item s
1883 size of the input frame, expressed in the form
1884 @var{width}x@var{height}
1885
1886 @item i
1887 interlaced mode ("P" for "progressive", "T" for top field first, "B"
1888 for bottom field first)
1889
1890 @item iskey
1891 1 if the frame is a key frame, 0 otherwise
1892
1893 @item type
1894 picture type of the input frame ("I" for an I-frame, "P" for a
1895 P-frame, "B" for a B-frame, "?" for unknown type).
1896 Check also the documentation of the @code{AVPictureType} enum and of
1897 the @code{av_get_picture_type_char} function defined in
1898 @file{libavutil/avutil.h}.
1899
1900 @item checksum
1901 Adler-32 checksum of all the planes of the input frame
1902
1903 @item plane_checksum
1904 Adler-32 checksum of each plane of the input frame, expressed in the form
1905 "[@var{c0} @var{c1} @var{c2} @var{c3}]"
1906 @end table
1907
1908 @section slicify
1909
1910 Pass the images of input video on to next video filter as multiple
1911 slices.
1912
1913 @example
1914 ./avconv -i in.avi -vf "slicify=32" out.avi
1915 @end example
1916
1917 The filter accepts the slice height as parameter. If the parameter is
1918 not specified it will use the default value of 16.
1919
1920 Adding this in the beginning of filter chains should make filtering
1921 faster due to better use of the memory cache.
1922
1923 @section split
1924
1925 Split input video into several identical outputs.
1926
1927 The filter accepts a single parameter which specifies the number of outputs. If
1928 unspecified, it defaults to 2.
1929
1930 For example
1931 @example
1932 avconv -i INPUT -filter_complex split=5 OUTPUT
1933 @end example
1934 will create 5 copies of the input video.
1935
1936 @section transpose
1937
1938 Transpose rows with columns in the input video and optionally flip it.
1939
1940 It accepts a parameter representing an integer, which can assume the
1941 values:
1942
1943 @table @samp
1944 @item 0
1945 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
1946 @example
1947 L.R     L.l
1948 . . ->  . .
1949 l.r     R.r
1950 @end example
1951
1952 @item 1
1953 Rotate by 90 degrees clockwise, that is:
1954 @example
1955 L.R     l.L
1956 . . ->  . .
1957 l.r     r.R
1958 @end example
1959
1960 @item 2
1961 Rotate by 90 degrees counterclockwise, that is:
1962 @example
1963 L.R     R.r
1964 . . ->  . .
1965 l.r     L.l
1966 @end example
1967
1968 @item 3
1969 Rotate by 90 degrees clockwise and vertically flip, that is:
1970 @example
1971 L.R     r.R
1972 . . ->  . .
1973 l.r     l.L
1974 @end example
1975 @end table
1976
1977 @section unsharp
1978
1979 Sharpen or blur the input video.
1980
1981 It accepts the following parameters:
1982 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
1983
1984 Negative values for the amount will blur the input video, while positive
1985 values will sharpen. All parameters are optional and default to the
1986 equivalent of the string '5:5:1.0:5:5:0.0'.
1987
1988 @table @option
1989
1990 @item luma_msize_x
1991 Set the luma matrix horizontal size. It can be an integer between 3
1992 and 13, default value is 5.
1993
1994 @item luma_msize_y
1995 Set the luma matrix vertical size. It can be an integer between 3
1996 and 13, default value is 5.
1997
1998 @item luma_amount
1999 Set the luma effect strength. It can be a float number between -2.0
2000 and 5.0, default value is 1.0.
2001
2002 @item chroma_msize_x
2003 Set the chroma matrix horizontal size. It can be an integer between 3
2004 and 13, default value is 5.
2005
2006 @item chroma_msize_y
2007 Set the chroma matrix vertical size. It can be an integer between 3
2008 and 13, default value is 5.
2009
2010 @item luma_amount
2011 Set the chroma effect strength. It can be a float number between -2.0
2012 and 5.0, default value is 0.0.
2013
2014 @end table
2015
2016 @example
2017 # Strong luma sharpen effect parameters
2018 unsharp=7:7:2.5
2019
2020 # Strong blur of both luma and chroma parameters
2021 unsharp=7:7:-2:7:7:-2
2022
2023 # Use the default values with @command{avconv}
2024 ./avconv -i in.avi -vf "unsharp" out.mp4
2025 @end example
2026
2027 @section vflip
2028
2029 Flip the input video vertically.
2030
2031 @example
2032 ./avconv -i in.avi -vf "vflip" out.avi
2033 @end example
2034
2035 @section yadif
2036
2037 Deinterlace the input video ("yadif" means "yet another deinterlacing
2038 filter").
2039
2040 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
2041
2042 @var{mode} specifies the interlacing mode to adopt, accepts one of the
2043 following values:
2044
2045 @table @option
2046 @item 0
2047 output 1 frame for each frame
2048 @item 1
2049 output 1 frame for each field
2050 @item 2
2051 like 0 but skips spatial interlacing check
2052 @item 3
2053 like 1 but skips spatial interlacing check
2054 @end table
2055
2056 Default value is 0.
2057
2058 @var{parity} specifies the picture field parity assumed for the input
2059 interlaced video, accepts one of the following values:
2060
2061 @table @option
2062 @item 0
2063 assume top field first
2064 @item 1
2065 assume bottom field first
2066 @item -1
2067 enable automatic detection
2068 @end table
2069
2070 Default value is -1.
2071 If interlacing is unknown or decoder does not export this information,
2072 top field first will be assumed.
2073
2074 @var{auto} specifies if deinterlacer should trust the interlaced flag
2075 and only deinterlace frames marked as interlaced
2076
2077 @table @option
2078 @item 0
2079 deinterlace all frames
2080 @item 1
2081 only deinterlace frames marked as interlaced
2082 @end table
2083
2084 Default value is 0.
2085
2086 @c man end VIDEO FILTERS
2087
2088 @chapter Video Sources
2089 @c man begin VIDEO SOURCES
2090
2091 Below is a description of the currently available video sources.
2092
2093 @section buffer
2094
2095 Buffer video frames, and make them available to the filter chain.
2096
2097 This source is mainly intended for a programmatic use, in particular
2098 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2099
2100 It accepts the following parameters:
2101 @var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den}
2102
2103 All the parameters need to be explicitly defined.
2104
2105 Follows the list of the accepted parameters.
2106
2107 @table @option
2108
2109 @item width, height
2110 Specify the width and height of the buffered video frames.
2111
2112 @item pix_fmt_string
2113 A string representing the pixel format of the buffered video frames.
2114 It may be a number corresponding to a pixel format, or a pixel format
2115 name.
2116
2117 @item timebase_num, timebase_den
2118 Specify numerator and denomitor of the timebase assumed by the
2119 timestamps of the buffered frames.
2120
2121 @item sample_aspect_ratio.num, sample_aspect_ratio.den
2122 Specify numerator and denominator of the sample aspect ratio assumed
2123 by the video frames.
2124 @end table
2125
2126 For example:
2127 @example
2128 buffer=320:240:yuv410p:1:24:1:1
2129 @end example
2130
2131 will instruct the source to accept video frames with size 320x240 and
2132 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2133 square pixels (1:1 sample aspect ratio).
2134 Since the pixel format with name "yuv410p" corresponds to the number 6
2135 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
2136 this example corresponds to:
2137 @example
2138 buffer=320:240:6:1:24
2139 @end example
2140
2141 @section color
2142
2143 Provide an uniformly colored input.
2144
2145 It accepts the following parameters:
2146 @var{color}:@var{frame_size}:@var{frame_rate}
2147
2148 Follows the description of the accepted parameters.
2149
2150 @table @option
2151
2152 @item color
2153 Specify the color of the source. It can be the name of a color (case
2154 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2155 alpha specifier. The default value is "black".
2156
2157 @item frame_size
2158 Specify the size of the sourced video, it may be a string of the form
2159 @var{width}x@var{height}, or the name of a size abbreviation. The
2160 default value is "320x240".
2161
2162 @item frame_rate
2163 Specify the frame rate of the sourced video, as the number of frames
2164 generated per second. It has to be a string in the format
2165 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2166 number or a valid video frame rate abbreviation. The default value is
2167 "25".
2168
2169 @end table
2170
2171 For example the following graph description will generate a red source
2172 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2173 frames per second, which will be overlayed over the source connected
2174 to the pad with identifier "in".
2175
2176 @example
2177 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2178 @end example
2179
2180 @section movie
2181
2182 Read a video stream from a movie container.
2183
2184 Note that this source is a hack that bypasses the standard input path. It can be
2185 useful in applications that do not support arbitrary filter graphs, but its use
2186 is discouraged in those that do. Specifically in @command{avconv} this filter
2187 should never be used, the @option{-filter_complex} option fully replaces it.
2188
2189 It accepts the syntax: @var{movie_name}[:@var{options}] where
2190 @var{movie_name} is the name of the resource to read (not necessarily
2191 a file but also a device or a stream accessed through some protocol),
2192 and @var{options} is an optional sequence of @var{key}=@var{value}
2193 pairs, separated by ":".
2194
2195 The description of the accepted options follows.
2196
2197 @table @option
2198
2199 @item format_name, f
2200 Specifies the format assumed for the movie to read, and can be either
2201 the name of a container or an input device. If not specified the
2202 format is guessed from @var{movie_name} or by probing.
2203
2204 @item seek_point, sp
2205 Specifies the seek point in seconds, the frames will be output
2206 starting from this seek point, the parameter is evaluated with
2207 @code{av_strtod} so the numerical value may be suffixed by an IS
2208 postfix. Default value is "0".
2209
2210 @item stream_index, si
2211 Specifies the index of the video stream to read. If the value is -1,
2212 the best suited video stream will be automatically selected. Default
2213 value is "-1".
2214
2215 @end table
2216
2217 This filter allows to overlay a second video on top of main input of
2218 a filtergraph as shown in this graph:
2219 @example
2220 input -----------> deltapts0 --> overlay --> output
2221                                     ^
2222                                     |
2223 movie --> scale--> deltapts1 -------+
2224 @end example
2225
2226 Some examples follow:
2227 @example
2228 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
2229 # on top of the input labelled as "in".
2230 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2231 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2232
2233 # read from a video4linux2 device, and overlay it on top of the input
2234 # labelled as "in"
2235 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2236 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2237
2238 @end example
2239
2240 @section nullsrc
2241
2242 Null video source, never return images. It is mainly useful as a
2243 template and to be employed in analysis / debugging tools.
2244
2245 It accepts as optional parameter a string of the form
2246 @var{width}:@var{height}:@var{timebase}.
2247
2248 @var{width} and @var{height} specify the size of the configured
2249 source. The default values of @var{width} and @var{height} are
2250 respectively 352 and 288 (corresponding to the CIF size format).
2251
2252 @var{timebase} specifies an arithmetic expression representing a
2253 timebase. The expression can contain the constants "PI", "E", "PHI",
2254 "AVTB" (the default timebase), and defaults to the value "AVTB".
2255
2256 @section frei0r_src
2257
2258 Provide a frei0r source.
2259
2260 To enable compilation of this filter you need to install the frei0r
2261 header and configure Libav with --enable-frei0r.
2262
2263 The source supports the syntax:
2264 @example
2265 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
2266 @end example
2267
2268 @var{size} is the size of the video to generate, may be a string of the
2269 form @var{width}x@var{height} or a frame size abbreviation.
2270 @var{rate} is the rate of the video to generate, may be a string of
2271 the form @var{num}/@var{den} or a frame rate abbreviation.
2272 @var{src_name} is the name to the frei0r source to load. For more
2273 information regarding frei0r and how to set the parameters read the
2274 section @ref{frei0r} in the description of the video filters.
2275
2276 Some examples follow:
2277 @example
2278 # generate a frei0r partik0l source with size 200x200 and framerate 10
2279 # which is overlayed on the overlay filter main input
2280 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
2281 @end example
2282
2283 @section rgbtestsrc, testsrc
2284
2285 The @code{rgbtestsrc} source generates an RGB test pattern useful for
2286 detecting RGB vs BGR issues. You should see a red, green and blue
2287 stripe from top to bottom.
2288
2289 The @code{testsrc} source generates a test video pattern, showing a
2290 color pattern, a scrolling gradient and a timestamp. This is mainly
2291 intended for testing purposes.
2292
2293 Both sources accept an optional sequence of @var{key}=@var{value} pairs,
2294 separated by ":". The description of the accepted options follows.
2295
2296 @table @option
2297
2298 @item size, s
2299 Specify the size of the sourced video, it may be a string of the form
2300 @var{width}x@var{height}, or the name of a size abbreviation. The
2301 default value is "320x240".
2302
2303 @item rate, r
2304 Specify the frame rate of the sourced video, as the number of frames
2305 generated per second. It has to be a string in the format
2306 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2307 number or a valid video frame rate abbreviation. The default value is
2308 "25".
2309
2310 @item sar
2311 Set the sample aspect ratio of the sourced video.
2312
2313 @item duration
2314 Set the video duration of the sourced video. The accepted syntax is:
2315 @example
2316 [-]HH[:MM[:SS[.m...]]]
2317 [-]S+[.m...]
2318 @end example
2319 See also the function @code{av_parse_time()}.
2320
2321 If not specified, or the expressed duration is negative, the video is
2322 supposed to be generated forever.
2323 @end table
2324
2325 For example the following:
2326 @example
2327 testsrc=duration=5.3:size=qcif:rate=10
2328 @end example
2329
2330 will generate a video with a duration of 5.3 seconds, with size
2331 176x144 and a framerate of 10 frames per second.
2332
2333 @c man end VIDEO SOURCES
2334
2335 @chapter Video Sinks
2336 @c man begin VIDEO SINKS
2337
2338 Below is a description of the currently available video sinks.
2339
2340 @section buffersink
2341
2342 Buffer video frames, and make them available to the end of the filter
2343 graph.
2344
2345 This sink is intended for a programmatic use through the interface defined in
2346 @file{libavfilter/buffersink.h}.
2347
2348 @section nullsink
2349
2350 Null video sink, do absolutely nothing with the input video. It is
2351 mainly useful as a template and to be employed in analysis / debugging
2352 tools.
2353
2354 @c man end VIDEO SINKS