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