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