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