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