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