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