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