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