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