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