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