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