doc: drop "./" binary prefixes.
[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 @item alpha
1170 If set to 1, fade only alpha channel, if one exists on the input.
1171 Default value is 0.
1172 @end table
1173
1174 A few usage examples follow, usable too as test scenarios.
1175 @example
1176 # fade in first 30 frames of video
1177 fade=in:0:30
1178
1179 # fade out last 45 frames of a 200-frame video
1180 fade=out:155:45
1181
1182 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
1183 fade=in:0:25, fade=out:975:25
1184
1185 # make first 5 frames black, then fade in from frame 5-24
1186 fade=in:5:20
1187
1188 # fade in alpha over first 25 frames of video
1189 fade=in:0:25:alpha=1
1190 @end example
1191
1192 @section fieldorder
1193
1194 Transform the field order of the input video.
1195
1196 It accepts one parameter which specifies the required field order that
1197 the input interlaced video will be transformed to. The parameter can
1198 assume one of the following values:
1199
1200 @table @option
1201 @item 0 or bff
1202 output bottom field first
1203 @item 1 or tff
1204 output top field first
1205 @end table
1206
1207 Default value is "tff".
1208
1209 Transformation is achieved by shifting the picture content up or down
1210 by one line, and filling the remaining line with appropriate picture content.
1211 This method is consistent with most broadcast field order converters.
1212
1213 If the input video is not flagged as being interlaced, or it is already
1214 flagged as being of the required output field order then this filter does
1215 not alter the incoming video.
1216
1217 This filter is very useful when converting to or from PAL DV material,
1218 which is bottom field first.
1219
1220 For example:
1221 @example
1222 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
1223 @end example
1224
1225 @section fifo
1226
1227 Buffer input images and send them when they are requested.
1228
1229 This filter is mainly useful when auto-inserted by the libavfilter
1230 framework.
1231
1232 The filter does not take parameters.
1233
1234 @section format
1235
1236 Convert the input video to one of the specified pixel formats.
1237 Libavfilter will try to pick one that is supported for the input to
1238 the next filter.
1239
1240 The filter accepts a list of pixel format names, separated by ":",
1241 for example "yuv420p:monow:rgb24".
1242
1243 Some examples follow:
1244 @example
1245 # convert the input video to the format "yuv420p"
1246 format=yuv420p
1247
1248 # convert the input video to any of the formats in the list
1249 format=yuv420p:yuv444p:yuv410p
1250 @end example
1251
1252 @anchor{frei0r}
1253 @section frei0r
1254
1255 Apply a frei0r effect to the input video.
1256
1257 To enable compilation of this filter you need to install the frei0r
1258 header and configure FFmpeg with --enable-frei0r.
1259
1260 The filter supports the syntax:
1261 @example
1262 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
1263 @end example
1264
1265 @var{filter_name} is the name to the frei0r effect to load. If the
1266 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
1267 is searched in each one of the directories specified by the colon
1268 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
1269 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
1270 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
1271
1272 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
1273 for the frei0r effect.
1274
1275 A frei0r effect parameter can be a boolean (whose values are specified
1276 with "y" and "n"), a double, a color (specified by the syntax
1277 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1278 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1279 description), a position (specified by the syntax @var{X}/@var{Y},
1280 @var{X} and @var{Y} being float numbers) and a string.
1281
1282 The number and kind of parameters depend on the loaded effect. If an
1283 effect parameter is not specified the default value is set.
1284
1285 Some examples follow:
1286 @example
1287 # apply the distort0r effect, set the first two double parameters
1288 frei0r=distort0r:0.5:0.01
1289
1290 # apply the colordistance effect, takes a color as first parameter
1291 frei0r=colordistance:0.2/0.3/0.4
1292 frei0r=colordistance:violet
1293 frei0r=colordistance:0x112233
1294
1295 # apply the perspective effect, specify the top left and top right
1296 # image positions
1297 frei0r=perspective:0.2/0.2:0.8/0.2
1298 @end example
1299
1300 For more information see:
1301 @url{http://piksel.org/frei0r}
1302
1303 @section gradfun
1304
1305 Fix the banding artifacts that are sometimes introduced into nearly flat
1306 regions by truncation to 8bit colordepth.
1307 Interpolate the gradients that should go where the bands are, and
1308 dither them.
1309
1310 This filter is designed for playback only.  Do not use it prior to
1311 lossy compression, because compression tends to lose the dither and
1312 bring back the bands.
1313
1314 The filter takes two optional parameters, separated by ':':
1315 @var{strength}:@var{radius}
1316
1317 @var{strength} is the maximum amount by which the filter will change
1318 any one pixel. Also the threshold for detecting nearly flat
1319 regions. Acceptable values range from .51 to 255, default value is
1320 1.2, out-of-range values will be clipped to the valid range.
1321
1322 @var{radius} is the neighborhood to fit the gradient to. A larger
1323 radius makes for smoother gradients, but also prevents the filter from
1324 modifying the pixels near detailed regions. Acceptable values are
1325 8-32, default value is 16, out-of-range values will be clipped to the
1326 valid range.
1327
1328 @example
1329 # default parameters
1330 gradfun=1.2:16
1331
1332 # omitting radius
1333 gradfun=1.2
1334 @end example
1335
1336 @section hflip
1337
1338 Flip the input video horizontally.
1339
1340 For example to horizontally flip the video in input with
1341 @file{ffmpeg}:
1342 @example
1343 ffmpeg -i in.avi -vf "hflip" out.avi
1344 @end example
1345
1346 @section hqdn3d
1347
1348 High precision/quality 3d denoise filter. This filter aims to reduce
1349 image noise producing smooth images and making still images really
1350 still. It should enhance compressibility.
1351
1352 It accepts the following optional parameters:
1353 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
1354
1355 @table @option
1356 @item luma_spatial
1357 a non-negative float number which specifies spatial luma strength,
1358 defaults to 4.0
1359
1360 @item chroma_spatial
1361 a non-negative float number which specifies spatial chroma strength,
1362 defaults to 3.0*@var{luma_spatial}/4.0
1363
1364 @item luma_tmp
1365 a float number which specifies luma temporal strength, defaults to
1366 6.0*@var{luma_spatial}/4.0
1367
1368 @item chroma_tmp
1369 a float number which specifies chroma temporal strength, defaults to
1370 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1371 @end table
1372
1373 @section lut, lutrgb, lutyuv
1374
1375 Compute a look-up table for binding each pixel component input value
1376 to an output value, and apply it to input video.
1377
1378 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1379 to an RGB input video.
1380
1381 These filters accept in input a ":"-separated list of options, which
1382 specify the expressions used for computing the lookup table for the
1383 corresponding pixel component values.
1384
1385 The @var{lut} filter requires either YUV or RGB pixel formats in
1386 input, and accepts the options:
1387 @table @option
1388 @item c0
1389 first  pixel component
1390 @item c1
1391 second pixel component
1392 @item c2
1393 third  pixel component
1394 @item c3
1395 fourth pixel component, corresponds to the alpha component
1396 @end table
1397
1398 The exact component associated to each option depends on the format in
1399 input.
1400
1401 The @var{lutrgb} filter requires RGB pixel formats in input, and
1402 accepts the options:
1403 @table @option
1404 @item r
1405 red component
1406 @item g
1407 green component
1408 @item b
1409 blue component
1410 @item a
1411 alpha component
1412 @end table
1413
1414 The @var{lutyuv} filter requires YUV pixel formats in input, and
1415 accepts the options:
1416 @table @option
1417 @item y
1418 Y/luminance component
1419 @item u
1420 U/Cb component
1421 @item v
1422 V/Cr component
1423 @item a
1424 alpha component
1425 @end table
1426
1427 The expressions can contain the following constants and functions:
1428
1429 @table @option
1430 @item w, h
1431 the input width and heigth
1432
1433 @item val
1434 input value for the pixel component
1435
1436 @item clipval
1437 the input value clipped in the @var{minval}-@var{maxval} range
1438
1439 @item maxval
1440 maximum value for the pixel component
1441
1442 @item minval
1443 minimum value for the pixel component
1444
1445 @item negval
1446 the negated value for the pixel component value clipped in the
1447 @var{minval}-@var{maxval} range , it corresponds to the expression
1448 "maxval-clipval+minval"
1449
1450 @item clip(val)
1451 the computed value in @var{val} clipped in the
1452 @var{minval}-@var{maxval} range
1453
1454 @item gammaval(gamma)
1455 the computed gamma correction value of the pixel component value
1456 clipped in the @var{minval}-@var{maxval} range, corresponds to the
1457 expression
1458 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1459
1460 @end table
1461
1462 All expressions default to "val".
1463
1464 Some examples follow:
1465 @example
1466 # negate input video
1467 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1468 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1469
1470 # the above is the same as
1471 lutrgb="r=negval:g=negval:b=negval"
1472 lutyuv="y=negval:u=negval:v=negval"
1473
1474 # negate luminance
1475 lutyuv=y=negval
1476
1477 # remove chroma components, turns the video into a graytone image
1478 lutyuv="u=128:v=128"
1479
1480 # apply a luma burning effect
1481 lutyuv="y=2*val"
1482
1483 # remove green and blue components
1484 lutrgb="g=0:b=0"
1485
1486 # set a constant alpha channel value on input
1487 format=rgba,lutrgb=a="maxval-minval/2"
1488
1489 # correct luminance gamma by a 0.5 factor
1490 lutyuv=y=gammaval(0.5)
1491 @end example
1492
1493 @section mp
1494
1495 Apply an MPlayer filter to the input video.
1496
1497 This filter provides a wrapper around most of the filters of
1498 MPlayer/MEncoder.
1499
1500 This wrapper is considered experimental. Some of the wrapped filters
1501 may not work properly and we may drop support for them, as they will
1502 be implemented natively into FFmpeg. Thus you should avoid
1503 depending on them when writing portable scripts.
1504
1505 The filters accepts the parameters:
1506 @var{filter_name}[:=]@var{filter_params}
1507
1508 @var{filter_name} is the name of a supported MPlayer filter,
1509 @var{filter_params} is a string containing the parameters accepted by
1510 the named filter.
1511
1512 The list of the currently supported filters follows:
1513 @table @var
1514 @item 2xsai
1515 @item decimate
1516 @item denoise3d
1517 @item detc
1518 @item dint
1519 @item divtc
1520 @item down3dright
1521 @item dsize
1522 @item eq2
1523 @item eq
1524 @item field
1525 @item fil
1526 @item fixpts
1527 @item framestep
1528 @item fspp
1529 @item geq
1530 @item harddup
1531 @item hqdn3d
1532 @item hue
1533 @item il
1534 @item ilpack
1535 @item ivtc
1536 @item kerndeint
1537 @item mcdeint
1538 @item mirror
1539 @item noise
1540 @item ow
1541 @item palette
1542 @item perspective
1543 @item phase
1544 @item pp7
1545 @item pullup
1546 @item qp
1547 @item rectangle
1548 @item remove-logo
1549 @item rotate
1550 @item sab
1551 @item screenshot
1552 @item smartblur
1553 @item softpulldown
1554 @item softskip
1555 @item spp
1556 @item swapuv
1557 @item telecine
1558 @item tile
1559 @item tinterlace
1560 @item unsharp
1561 @item uspp
1562 @item yuvcsp
1563 @item yvu9
1564 @end table
1565
1566 The parameter syntax and behavior for the listed filters are the same
1567 of the corresponding MPlayer filters. For detailed instructions check
1568 the "VIDEO FILTERS" section in the MPlayer manual.
1569
1570 Some examples follow:
1571 @example
1572 # remove a logo by interpolating the surrounding pixels
1573 mp=delogo=200:200:80:20:1
1574
1575 # adjust gamma, brightness, contrast
1576 mp=eq2=1.0:2:0.5
1577
1578 # tweak hue and saturation
1579 mp=hue=100:-10
1580 @end example
1581
1582 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
1583
1584 @section negate
1585
1586 Negate input video.
1587
1588 This filter accepts an integer in input, if non-zero it negates the
1589 alpha component (if available). The default value in input is 0.
1590
1591 @section noformat
1592
1593 Force libavfilter not to use any of the specified pixel formats for the
1594 input to the next filter.
1595
1596 The filter accepts a list of pixel format names, separated by ":",
1597 for example "yuv420p:monow:rgb24".
1598
1599 Some examples follow:
1600 @example
1601 # force libavfilter to use a format different from "yuv420p" for the
1602 # input to the vflip filter
1603 noformat=yuv420p,vflip
1604
1605 # convert the input video to any of the formats not contained in the list
1606 noformat=yuv420p:yuv444p:yuv410p
1607 @end example
1608
1609 @section null
1610
1611 Pass the video source unchanged to the output.
1612
1613 @section ocv
1614
1615 Apply video transform using libopencv.
1616
1617 To enable this filter install libopencv library and headers and
1618 configure FFmpeg with --enable-libopencv.
1619
1620 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
1621
1622 @var{filter_name} is the name of the libopencv filter to apply.
1623
1624 @var{filter_params} specifies the parameters to pass to the libopencv
1625 filter. If not specified the default values are assumed.
1626
1627 Refer to the official libopencv documentation for more precise
1628 informations:
1629 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1630
1631 Follows the list of supported libopencv filters.
1632
1633 @anchor{dilate}
1634 @subsection dilate
1635
1636 Dilate an image by using a specific structuring element.
1637 This filter corresponds to the libopencv function @code{cvDilate}.
1638
1639 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
1640
1641 @var{struct_el} represents a structuring element, and has the syntax:
1642 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1643
1644 @var{cols} and @var{rows} represent the number of colums and rows of
1645 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1646 point, and @var{shape} the shape for the structuring element, and
1647 can be one of the values "rect", "cross", "ellipse", "custom".
1648
1649 If the value for @var{shape} is "custom", it must be followed by a
1650 string of the form "=@var{filename}". The file with name
1651 @var{filename} is assumed to represent a binary image, with each
1652 printable character corresponding to a bright pixel. When a custom
1653 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1654 or columns and rows of the read file are assumed instead.
1655
1656 The default value for @var{struct_el} is "3x3+0x0/rect".
1657
1658 @var{nb_iterations} specifies the number of times the transform is
1659 applied to the image, and defaults to 1.
1660
1661 Follow some example:
1662 @example
1663 # use the default values
1664 ocv=dilate
1665
1666 # dilate using a structuring element with a 5x5 cross, iterate two times
1667 ocv=dilate=5x5+2x2/cross:2
1668
1669 # read the shape from the file diamond.shape, iterate two times
1670 # the file diamond.shape may contain a pattern of characters like this:
1671 #   *
1672 #  ***
1673 # *****
1674 #  ***
1675 #   *
1676 # the specified cols and rows are ignored (but not the anchor point coordinates)
1677 ocv=0x0+2x2/custom=diamond.shape:2
1678 @end example
1679
1680 @subsection erode
1681
1682 Erode an image by using a specific structuring element.
1683 This filter corresponds to the libopencv function @code{cvErode}.
1684
1685 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1686 with the same syntax and semantics as the @ref{dilate} filter.
1687
1688 @subsection smooth
1689
1690 Smooth the input video.
1691
1692 The filter takes the following parameters:
1693 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
1694
1695 @var{type} is the type of smooth filter to apply, and can be one of
1696 the following values: "blur", "blur_no_scale", "median", "gaussian",
1697 "bilateral". The default value is "gaussian".
1698
1699 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1700 parameters whose meanings depend on smooth type. @var{param1} and
1701 @var{param2} accept integer positive values or 0, @var{param3} and
1702 @var{param4} accept float values.
1703
1704 The default value for @var{param1} is 3, the default value for the
1705 other parameters is 0.
1706
1707 These parameters correspond to the parameters assigned to the
1708 libopencv function @code{cvSmooth}.
1709
1710 @section overlay
1711
1712 Overlay one video on top of another.
1713
1714 It takes two inputs and one output, the first input is the "main"
1715 video on which the second input is overlayed.
1716
1717 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
1718
1719 @var{x} is the x coordinate of the overlayed video on the main video,
1720 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
1721 the following parameters:
1722
1723 @table @option
1724 @item main_w, main_h
1725 main input width and height
1726
1727 @item W, H
1728 same as @var{main_w} and @var{main_h}
1729
1730 @item overlay_w, overlay_h
1731 overlay input width and height
1732
1733 @item w, h
1734 same as @var{overlay_w} and @var{overlay_h}
1735 @end table
1736
1737 @var{options} is an optional list of @var{key}=@var{value} pairs,
1738 separated by ":".
1739
1740 The description of the accepted options follows.
1741
1742 @table @option
1743 @item rgb
1744 If set to 1, force the filter to accept inputs in the RGB
1745 colorspace. Default value is 0.
1746 @end table
1747
1748 Be aware that frames are taken from each input video in timestamp
1749 order, hence, if their initial timestamps differ, it is a a good idea
1750 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1751 have them begin in the same zero timestamp, as it does the example for
1752 the @var{movie} filter.
1753
1754 Follow some examples:
1755 @example
1756 # draw the overlay at 10 pixels from the bottom right
1757 # corner of the main video.
1758 overlay=main_w-overlay_w-10:main_h-overlay_h-10
1759
1760 # insert a transparent PNG logo in the bottom left corner of the input
1761 movie=logo.png [logo];
1762 [in][logo] overlay=10:main_h-overlay_h-10 [out]
1763
1764 # insert 2 different transparent PNG logos (second logo on bottom
1765 # right corner):
1766 movie=logo1.png [logo1];
1767 movie=logo2.png [logo2];
1768 [in][logo1]       overlay=10:H-h-10 [in+logo1];
1769 [in+logo1][logo2] overlay=W-w-10:H-h-10 [out]
1770
1771 # add a transparent color layer on top of the main video,
1772 # WxH specifies the size of the main input to the overlay filter
1773 color=red@.3:WxH [over]; [in][over] overlay [out]
1774 @end example
1775
1776 You can chain together more overlays but the efficiency of such
1777 approach is yet to be tested.
1778
1779 @section pad
1780
1781 Add paddings to the input image, and places the original input at the
1782 given coordinates @var{x}, @var{y}.
1783
1784 It accepts the following parameters:
1785 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
1786
1787 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1788 expressions containing the following constants:
1789
1790 @table @option
1791 @item in_w, in_h
1792 the input video width and height
1793
1794 @item iw, ih
1795 same as @var{in_w} and @var{in_h}
1796
1797 @item out_w, out_h
1798 the output width and height, that is the size of the padded area as
1799 specified by the @var{width} and @var{height} expressions
1800
1801 @item ow, oh
1802 same as @var{out_w} and @var{out_h}
1803
1804 @item x, y
1805 x and y offsets as specified by the @var{x} and @var{y}
1806 expressions, or NAN if not yet specified
1807
1808 @item a
1809 same as @var{iw} / @var{ih}
1810
1811 @item sar
1812 input sample aspect ratio
1813
1814 @item dar
1815 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1816
1817 @item hsub, vsub
1818 horizontal and vertical chroma subsample values. For example for the
1819 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1820 @end table
1821
1822 Follows the description of the accepted parameters.
1823
1824 @table @option
1825 @item width, height
1826
1827 Specify the size of the output image with the paddings added. If the
1828 value for @var{width} or @var{height} is 0, the corresponding input size
1829 is used for the output.
1830
1831 The @var{width} expression can reference the value set by the
1832 @var{height} expression, and viceversa.
1833
1834 The default value of @var{width} and @var{height} is 0.
1835
1836 @item x, y
1837
1838 Specify the offsets where to place the input image in the padded area
1839 with respect to the top/left border of the output image.
1840
1841 The @var{x} expression can reference the value set by the @var{y}
1842 expression, and viceversa.
1843
1844 The default value of @var{x} and @var{y} is 0.
1845
1846 @item color
1847
1848 Specify the color of the padded area, it can be the name of a color
1849 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1850
1851 The default value of @var{color} is "black".
1852
1853 @end table
1854
1855 Some examples follow:
1856
1857 @example
1858 # Add paddings with color "violet" to the input video. Output video
1859 # size is 640x480, the top-left corner of the input video is placed at
1860 # column 0, row 40.
1861 pad=640:480:0:40:violet
1862
1863 # pad the input to get an output with dimensions increased bt 3/2,
1864 # and put the input video at the center of the padded area
1865 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1866
1867 # pad the input to get a squared output with size equal to the maximum
1868 # value between the input width and height, and put the input video at
1869 # the center of the padded area
1870 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1871
1872 # pad the input to get a final w/h ratio of 16:9
1873 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1874
1875 # for anamorphic video, in order to set the output display aspect ratio,
1876 # it is necessary to use sar in the expression, according to the relation:
1877 # (ih * X / ih) * sar = output_dar
1878 # X = output_dar / sar
1879 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
1880
1881 # double output size and put the input video in the bottom-right
1882 # corner of the output padded area
1883 pad="2*iw:2*ih:ow-iw:oh-ih"
1884 @end example
1885
1886 @section pixdesctest
1887
1888 Pixel format descriptor test filter, mainly useful for internal
1889 testing. The output video should be equal to the input video.
1890
1891 For example:
1892 @example
1893 format=monow, pixdesctest
1894 @end example
1895
1896 can be used to test the monowhite pixel format descriptor definition.
1897
1898 @section scale
1899
1900 Scale the input video to @var{width}:@var{height}[:@var{interl}=@{1|-1@}] and/or convert the image format.
1901
1902 The parameters @var{width} and @var{height} are expressions containing
1903 the following constants:
1904
1905 @table @option
1906 @item in_w, in_h
1907 the input width and height
1908
1909 @item iw, ih
1910 same as @var{in_w} and @var{in_h}
1911
1912 @item out_w, out_h
1913 the output (cropped) width and height
1914
1915 @item ow, oh
1916 same as @var{out_w} and @var{out_h}
1917
1918 @item a
1919 same as @var{iw} / @var{ih}
1920
1921 @item sar
1922 input sample aspect ratio
1923
1924 @item dar
1925 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1926
1927 @item sar
1928 input sample aspect ratio
1929
1930 @item hsub, vsub
1931 horizontal and vertical chroma subsample values. For example for the
1932 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1933 @end table
1934
1935 If the input image format is different from the format requested by
1936 the next filter, the scale filter will convert the input to the
1937 requested format.
1938
1939 If the value for @var{width} or @var{height} is 0, the respective input
1940 size is used for the output.
1941
1942 If the value for @var{width} or @var{height} is -1, the scale filter will
1943 use, for the respective output size, a value that maintains the aspect
1944 ratio of the input image.
1945
1946 The default value of @var{width} and @var{height} is 0.
1947
1948 Valid values for the optional parameter @var{interl} are:
1949
1950 @table @option
1951 @item 1
1952 force interlaced aware scaling
1953
1954 @item -1
1955 select interlaced aware scaling depending on whether the source frames
1956 are flagged as interlaced or not
1957 @end table
1958
1959 Some examples follow:
1960 @example
1961 # scale the input video to a size of 200x100.
1962 scale=200:100
1963
1964 # scale the input to 2x
1965 scale=2*iw:2*ih
1966 # the above is the same as
1967 scale=2*in_w:2*in_h
1968
1969 # scale the input to half size
1970 scale=iw/2:ih/2
1971
1972 # increase the width, and set the height to the same size
1973 scale=3/2*iw:ow
1974
1975 # seek for Greek harmony
1976 scale=iw:1/PHI*iw
1977 scale=ih*PHI:ih
1978
1979 # increase the height, and set the width to 3/2 of the height
1980 scale=3/2*oh:3/5*ih
1981
1982 # increase the size, but make the size a multiple of the chroma
1983 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1984
1985 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1986 scale='min(500\, iw*3/2):-1'
1987 @end example
1988
1989 @section select
1990 Select frames to pass in output.
1991
1992 It accepts in input an expression, which is evaluated for each input
1993 frame. If the expression is evaluated to a non-zero value, the frame
1994 is selected and passed to the output, otherwise it is discarded.
1995
1996 The expression can contain the following constants:
1997
1998 @table @option
1999 @item n
2000 the sequential number of the filtered frame, starting from 0
2001
2002 @item selected_n
2003 the sequential number of the selected frame, starting from 0
2004
2005 @item prev_selected_n
2006 the sequential number of the last selected frame, NAN if undefined
2007
2008 @item TB
2009 timebase of the input timestamps
2010
2011 @item pts
2012 the PTS (Presentation TimeStamp) of the filtered video frame,
2013 expressed in @var{TB} units, NAN if undefined
2014
2015 @item t
2016 the PTS (Presentation TimeStamp) of the filtered video frame,
2017 expressed in seconds, NAN if undefined
2018
2019 @item prev_pts
2020 the PTS of the previously filtered video frame, NAN if undefined
2021
2022 @item prev_selected_pts
2023 the PTS of the last previously filtered video frame, NAN if undefined
2024
2025 @item prev_selected_t
2026 the PTS of the last previously selected video frame, NAN if undefined
2027
2028 @item start_pts
2029 the PTS of the first video frame in the video, NAN if undefined
2030
2031 @item start_t
2032 the time of the first video frame in the video, NAN if undefined
2033
2034 @item pict_type
2035 the type of the filtered frame, can assume one of the following
2036 values:
2037 @table @option
2038 @item I
2039 @item P
2040 @item B
2041 @item S
2042 @item SI
2043 @item SP
2044 @item BI
2045 @end table
2046
2047 @item interlace_type
2048 the frame interlace type, can assume one of the following values:
2049 @table @option
2050 @item PROGRESSIVE
2051 the frame is progressive (not interlaced)
2052 @item TOPFIRST
2053 the frame is top-field-first
2054 @item BOTTOMFIRST
2055 the frame is bottom-field-first
2056 @end table
2057
2058 @item key
2059 1 if the filtered frame is a key-frame, 0 otherwise
2060
2061 @item pos
2062 the position in the file of the filtered frame, -1 if the information
2063 is not available (e.g. for synthetic video)
2064 @end table
2065
2066 The default value of the select expression is "1".
2067
2068 Some examples follow:
2069
2070 @example
2071 # select all frames in input
2072 select
2073
2074 # the above is the same as:
2075 select=1
2076
2077 # skip all frames:
2078 select=0
2079
2080 # select only I-frames
2081 select='eq(pict_type\,I)'
2082
2083 # select one frame every 100
2084 select='not(mod(n\,100))'
2085
2086 # select only frames contained in the 10-20 time interval
2087 select='gte(t\,10)*lte(t\,20)'
2088
2089 # select only I frames contained in the 10-20 time interval
2090 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2091
2092 # select frames with a minimum distance of 10 seconds
2093 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2094 @end example
2095
2096 @anchor{setdar}
2097 @section setdar
2098
2099 Set the Display Aspect Ratio for the filter output video.
2100
2101 This is done by changing the specified Sample (aka Pixel) Aspect
2102 Ratio, according to the following equation:
2103 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2104
2105 Keep in mind that this filter does not modify the pixel dimensions of
2106 the video frame. Also the display aspect ratio set by this filter may
2107 be changed by later filters in the filterchain, e.g. in case of
2108 scaling or if another "setdar" or a "setsar" filter is applied.
2109
2110 The filter accepts a parameter string which represents the wanted
2111 display aspect ratio.
2112 The parameter can be a floating point number string, or an expression
2113 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
2114 numerator and denominator of the aspect ratio.
2115 If the parameter is not specified, it is assumed the value "0:1".
2116
2117 For example to change the display aspect ratio to 16:9, specify:
2118 @example
2119 setdar=16:9
2120 # the above is equivalent to
2121 setdar=1.77777
2122 @end example
2123
2124 See also the @ref{setsar} filter documentation.
2125
2126 @section setpts
2127
2128 Change the PTS (presentation timestamp) of the input video frames.
2129
2130 Accept in input an expression evaluated through the eval API, which
2131 can contain the following constants:
2132
2133 @table @option
2134 @item PTS
2135 the presentation timestamp in input
2136
2137 @item N
2138 the count of the input frame, starting from 0.
2139
2140 @item STARTPTS
2141 the PTS of the first video frame
2142
2143 @item INTERLACED
2144 tell if the current frame is interlaced
2145
2146 @item POS
2147 original position in the file of the frame, or undefined if undefined
2148 for the current frame
2149
2150 @item PREV_INPTS
2151 previous input PTS
2152
2153 @item PREV_OUTPTS
2154 previous output PTS
2155
2156 @end table
2157
2158 Some examples follow:
2159
2160 @example
2161 # start counting PTS from zero
2162 setpts=PTS-STARTPTS
2163
2164 # fast motion
2165 setpts=0.5*PTS
2166
2167 # slow motion
2168 setpts=2.0*PTS
2169
2170 # fixed rate 25 fps
2171 setpts=N/(25*TB)
2172
2173 # fixed rate 25 fps with some jitter
2174 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2175 @end example
2176
2177 @anchor{setsar}
2178 @section setsar
2179
2180 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
2181
2182 Note that as a consequence of the application of this filter, the
2183 output display aspect ratio will change according to the following
2184 equation:
2185 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2186
2187 Keep in mind that the sample aspect ratio set by this filter may be
2188 changed by later filters in the filterchain, e.g. if another "setsar"
2189 or a "setdar" filter is applied.
2190
2191 The filter accepts a parameter string which represents the wanted
2192 sample aspect ratio.
2193 The parameter can be a floating point number string, or an expression
2194 of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
2195 numerator and denominator of the aspect ratio.
2196 If the parameter is not specified, it is assumed the value "0:1".
2197
2198 For example to change the sample aspect ratio to 10:11, specify:
2199 @example
2200 setsar=10:11
2201 @end example
2202
2203 @section settb
2204
2205 Set the timebase to use for the output frames timestamps.
2206 It is mainly useful for testing timebase configuration.
2207
2208 It accepts in input an arithmetic expression representing a rational.
2209 The expression can contain the constants "AVTB" (the
2210 default timebase), and "intb" (the input timebase).
2211
2212 The default value for the input is "intb".
2213
2214 Follow some examples.
2215
2216 @example
2217 # set the timebase to 1/25
2218 settb=1/25
2219
2220 # set the timebase to 1/10
2221 settb=0.1
2222
2223 #set the timebase to 1001/1000
2224 settb=1+0.001
2225
2226 #set the timebase to 2*intb
2227 settb=2*intb
2228
2229 #set the default timebase value
2230 settb=AVTB
2231 @end example
2232
2233 @section showinfo
2234
2235 Show a line containing various information for each input video frame.
2236 The input video is not modified.
2237
2238 The shown line contains a sequence of key/value pairs of the form
2239 @var{key}:@var{value}.
2240
2241 A description of each shown parameter follows:
2242
2243 @table @option
2244 @item n
2245 sequential number of the input frame, starting from 0
2246
2247 @item pts
2248 Presentation TimeStamp of the input frame, expressed as a number of
2249 time base units. The time base unit depends on the filter input pad.
2250
2251 @item pts_time
2252 Presentation TimeStamp of the input frame, expressed as a number of
2253 seconds
2254
2255 @item pos
2256 position of the frame in the input stream, -1 if this information in
2257 unavailable and/or meanigless (for example in case of synthetic video)
2258
2259 @item fmt
2260 pixel format name
2261
2262 @item sar
2263 sample aspect ratio of the input frame, expressed in the form
2264 @var{num}/@var{den}
2265
2266 @item s
2267 size of the input frame, expressed in the form
2268 @var{width}x@var{height}
2269
2270 @item i
2271 interlaced mode ("P" for "progressive", "T" for top field first, "B"
2272 for bottom field first)
2273
2274 @item iskey
2275 1 if the frame is a key frame, 0 otherwise
2276
2277 @item type
2278 picture type of the input frame ("I" for an I-frame, "P" for a
2279 P-frame, "B" for a B-frame, "?" for unknown type).
2280 Check also the documentation of the @code{AVPictureType} enum and of
2281 the @code{av_get_picture_type_char} function defined in
2282 @file{libavutil/avutil.h}.
2283
2284 @item checksum
2285 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
2286
2287 @item plane_checksum
2288 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
2289 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
2290 @end table
2291
2292 @section slicify
2293
2294 Pass the images of input video on to next video filter as multiple
2295 slices.
2296
2297 @example
2298 ffmpeg -i in.avi -vf "slicify=32" out.avi
2299 @end example
2300
2301 The filter accepts the slice height as parameter. If the parameter is
2302 not specified it will use the default value of 16.
2303
2304 Adding this in the beginning of filter chains should make filtering
2305 faster due to better use of the memory cache.
2306
2307 @section split
2308
2309 Pass on the input video to two outputs. Both outputs are identical to
2310 the input video.
2311
2312 For example:
2313 @example
2314 [in] split [splitout1][splitout2];
2315 [splitout1] crop=100:100:0:0    [cropout];
2316 [splitout2] pad=200:200:100:100 [padout];
2317 @end example
2318
2319 will create two separate outputs from the same input, one cropped and
2320 one padded.
2321
2322 @section transpose
2323
2324 Transpose rows with columns in the input video and optionally flip it.
2325
2326 It accepts a parameter representing an integer, which can assume the
2327 values:
2328
2329 @table @samp
2330 @item 0
2331 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2332 @example
2333 L.R     L.l
2334 . . ->  . .
2335 l.r     R.r
2336 @end example
2337
2338 @item 1
2339 Rotate by 90 degrees clockwise, that is:
2340 @example
2341 L.R     l.L
2342 . . ->  . .
2343 l.r     r.R
2344 @end example
2345
2346 @item 2
2347 Rotate by 90 degrees counterclockwise, that is:
2348 @example
2349 L.R     R.r
2350 . . ->  . .
2351 l.r     L.l
2352 @end example
2353
2354 @item 3
2355 Rotate by 90 degrees clockwise and vertically flip, that is:
2356 @example
2357 L.R     r.R
2358 . . ->  . .
2359 l.r     l.L
2360 @end example
2361 @end table
2362
2363 @section unsharp
2364
2365 Sharpen or blur the input video.
2366
2367 It accepts the following parameters:
2368 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
2369
2370 Negative values for the amount will blur the input video, while positive
2371 values will sharpen. All parameters are optional and default to the
2372 equivalent of the string '5:5:1.0:5:5:0.0'.
2373
2374 @table @option
2375
2376 @item luma_msize_x
2377 Set the luma matrix horizontal size. It can be an integer between 3
2378 and 13, default value is 5.
2379
2380 @item luma_msize_y
2381 Set the luma matrix vertical size. It can be an integer between 3
2382 and 13, default value is 5.
2383
2384 @item luma_amount
2385 Set the luma effect strength. It can be a float number between -2.0
2386 and 5.0, default value is 1.0.
2387
2388 @item chroma_msize_x
2389 Set the chroma matrix horizontal size. It can be an integer between 3
2390 and 13, default value is 5.
2391
2392 @item chroma_msize_y
2393 Set the chroma matrix vertical size. It can be an integer between 3
2394 and 13, default value is 5.
2395
2396 @item chroma_amount
2397 Set the chroma effect strength. It can be a float number between -2.0
2398 and 5.0, default value is 0.0.
2399
2400 @end table
2401
2402 @example
2403 # Strong luma sharpen effect parameters
2404 unsharp=7:7:2.5
2405
2406 # Strong blur of both luma and chroma parameters
2407 unsharp=7:7:-2:7:7:-2
2408
2409 # Use the default values with @command{ffmpeg}
2410 ffmpeg -i in.avi -vf "unsharp" out.mp4
2411 @end example
2412
2413 @section vflip
2414
2415 Flip the input video vertically.
2416
2417 @example
2418 ffmpeg -i in.avi -vf "vflip" out.avi
2419 @end example
2420
2421 @section yadif
2422
2423 Deinterlace the input video ("yadif" means "yet another deinterlacing
2424 filter").
2425
2426 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
2427
2428 @var{mode} specifies the interlacing mode to adopt, accepts one of the
2429 following values:
2430
2431 @table @option
2432 @item 0
2433 output 1 frame for each frame
2434 @item 1
2435 output 1 frame for each field
2436 @item 2
2437 like 0 but skips spatial interlacing check
2438 @item 3
2439 like 1 but skips spatial interlacing check
2440 @end table
2441
2442 Default value is 0.
2443
2444 @var{parity} specifies the picture field parity assumed for the input
2445 interlaced video, accepts one of the following values:
2446
2447 @table @option
2448 @item 0
2449 assume top field first
2450 @item 1
2451 assume bottom field first
2452 @item -1
2453 enable automatic detection
2454 @end table
2455
2456 Default value is -1.
2457 If interlacing is unknown or decoder does not export this information,
2458 top field first will be assumed.
2459
2460 @var{auto} specifies if deinterlacer should trust the interlaced flag
2461 and only deinterlace frames marked as interlaced
2462
2463 @table @option
2464 @item 0
2465 deinterlace all frames
2466 @item 1
2467 only deinterlace frames marked as interlaced
2468 @end table
2469
2470 Default value is 0.
2471
2472 @c man end VIDEO FILTERS
2473
2474 @chapter Video Sources
2475 @c man begin VIDEO SOURCES
2476
2477 Below is a description of the currently available video sources.
2478
2479 @section buffer
2480
2481 Buffer video frames, and make them available to the filter chain.
2482
2483 This source is mainly intended for a programmatic use, in particular
2484 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2485
2486 It accepts the following parameters:
2487 @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}
2488
2489 All the parameters but @var{scale_params} need to be explicitly
2490 defined.
2491
2492 Follows the list of the accepted parameters.
2493
2494 @table @option
2495
2496 @item width, height
2497 Specify the width and height of the buffered video frames.
2498
2499 @item pix_fmt_string
2500 A string representing the pixel format of the buffered video frames.
2501 It may be a number corresponding to a pixel format, or a pixel format
2502 name.
2503
2504 @item timebase_num, timebase_den
2505 Specify numerator and denomitor of the timebase assumed by the
2506 timestamps of the buffered frames.
2507
2508 @item sample_aspect_ratio.num, sample_aspect_ratio.den
2509 Specify numerator and denominator of the sample aspect ratio assumed
2510 by the video frames.
2511
2512 @item scale_params
2513 Specify the optional parameters to be used for the scale filter which
2514 is automatically inserted when an input change is detected in the
2515 input size or format.
2516 @end table
2517
2518 For example:
2519 @example
2520 buffer=320:240:yuv410p:1:24:1:1
2521 @end example
2522
2523 will instruct the source to accept video frames with size 320x240 and
2524 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2525 square pixels (1:1 sample aspect ratio).
2526 Since the pixel format with name "yuv410p" corresponds to the number 6
2527 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
2528 this example corresponds to:
2529 @example
2530 buffer=320:240:6:1:24:1:1
2531 @end example
2532
2533 @section color
2534
2535 Provide an uniformly colored input.
2536
2537 It accepts the following parameters:
2538 @var{color}:@var{frame_size}:@var{frame_rate}
2539
2540 Follows the description of the accepted parameters.
2541
2542 @table @option
2543
2544 @item color
2545 Specify the color of the source. It can be the name of a color (case
2546 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2547 alpha specifier. The default value is "black".
2548
2549 @item frame_size
2550 Specify the size of the sourced video, it may be a string of the form
2551 @var{width}x@var{height}, or the name of a size abbreviation. The
2552 default value is "320x240".
2553
2554 @item frame_rate
2555 Specify the frame rate of the sourced video, as the number of frames
2556 generated per second. It has to be a string in the format
2557 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2558 number or a valid video frame rate abbreviation. The default value is
2559 "25".
2560
2561 @end table
2562
2563 For example the following graph description will generate a red source
2564 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2565 frames per second, which will be overlayed over the source connected
2566 to the pad with identifier "in".
2567
2568 @example
2569 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2570 @end example
2571
2572 @section movie
2573
2574 Read a video stream from a movie container.
2575
2576 It accepts the syntax: @var{movie_name}[:@var{options}] where
2577 @var{movie_name} is the name of the resource to read (not necessarily
2578 a file but also a device or a stream accessed through some protocol),
2579 and @var{options} is an optional sequence of @var{key}=@var{value}
2580 pairs, separated by ":".
2581
2582 The description of the accepted options follows.
2583
2584 @table @option
2585
2586 @item format_name, f
2587 Specifies the format assumed for the movie to read, and can be either
2588 the name of a container or an input device. If not specified the
2589 format is guessed from @var{movie_name} or by probing.
2590
2591 @item seek_point, sp
2592 Specifies the seek point in seconds, the frames will be output
2593 starting from this seek point, the parameter is evaluated with
2594 @code{av_strtod} so the numerical value may be suffixed by an IS
2595 postfix. Default value is "0".
2596
2597 @item stream_index, si
2598 Specifies the index of the video stream to read. If the value is -1,
2599 the best suited video stream will be automatically selected. Default
2600 value is "-1".
2601
2602 @end table
2603
2604 This filter allows to overlay a second video on top of main input of
2605 a filtergraph as shown in this graph:
2606 @example
2607 input -----------> deltapts0 --> overlay --> output
2608                                     ^
2609                                     |
2610 movie --> scale--> deltapts1 -------+
2611 @end example
2612
2613 Some examples follow:
2614 @example
2615 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
2616 # on top of the input labelled as "in".
2617 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2618 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2619
2620 # read from a video4linux2 device, and overlay it on top of the input
2621 # labelled as "in"
2622 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2623 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2624
2625 @end example
2626
2627 @section mptestsrc
2628
2629 Generate various test patterns, as generated by the MPlayer test filter.
2630
2631 The size of the generated video is fixed, and is 256x256.
2632 This source is useful in particular for testing encoding features.
2633
2634 This source accepts an optional sequence of @var{key}=@var{value} pairs,
2635 separated by ":". The description of the accepted options follows.
2636
2637 @table @option
2638
2639 @item rate, r
2640 Specify the frame rate of the sourced video, as the number of frames
2641 generated per second. It has to be a string in the format
2642 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2643 number or a valid video frame rate abbreviation. The default value is
2644 "25".
2645
2646 @item duration, d
2647 Set the video duration of the sourced video. The accepted syntax is:
2648 @example
2649 [-]HH[:MM[:SS[.m...]]]
2650 [-]S+[.m...]
2651 @end example
2652 See also the function @code{av_parse_time()}.
2653
2654 If not specified, or the expressed duration is negative, the video is
2655 supposed to be generated forever.
2656
2657 @item test, t
2658
2659 Set the number or the name of the test to perform. Supported tests are:
2660 @table @option
2661 @item dc_luma
2662 @item dc_chroma
2663 @item freq_luma
2664 @item freq_chroma
2665 @item amp_luma
2666 @item amp_chroma
2667 @item cbp
2668 @item mv
2669 @item ring1
2670 @item ring2
2671 @item all
2672 @end table
2673
2674 Default value is "all", which will cycle through the list of all tests.
2675 @end table
2676
2677 For example the following:
2678 @example
2679 testsrc=t=dc_luma
2680 @end example
2681
2682 will generate a "dc_luma" test pattern.
2683
2684 @section frei0r_src
2685
2686 Provide a frei0r source.
2687
2688 To enable compilation of this filter you need to install the frei0r
2689 header and configure FFmpeg with --enable-frei0r.
2690
2691 The source supports the syntax:
2692 @example
2693 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
2694 @end example
2695
2696 @var{size} is the size of the video to generate, may be a string of the
2697 form @var{width}x@var{height} or a frame size abbreviation.
2698 @var{rate} is the rate of the video to generate, may be a string of
2699 the form @var{num}/@var{den} or a frame rate abbreviation.
2700 @var{src_name} is the name to the frei0r source to load. For more
2701 information regarding frei0r and how to set the parameters read the
2702 section @ref{frei0r} in the description of the video filters.
2703
2704 Some examples follow:
2705 @example
2706 # generate a frei0r partik0l source with size 200x200 and framerate 10
2707 # which is overlayed on the overlay filter main input
2708 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
2709 @end example
2710
2711 @section nullsrc, rgbtestsrc, testsrc
2712
2713 The @code{nullsrc} source returns unprocessed video frames. It is
2714 mainly useful to be employed in analysis / debugging tools, or as the
2715 source for filters which ignore the input data.
2716
2717 The @code{rgbtestsrc} source generates an RGB test pattern useful for
2718 detecting RGB vs BGR issues. You should see a red, green and blue
2719 stripe from top to bottom.
2720
2721 The @code{testsrc} source generates a test video pattern, showing a
2722 color pattern, a scrolling gradient and a timestamp. This is mainly
2723 intended for testing purposes.
2724
2725 These sources accept an optional sequence of @var{key}=@var{value} pairs,
2726 separated by ":". The description of the accepted options follows.
2727
2728 @table @option
2729
2730 @item size, s
2731 Specify the size of the sourced video, it may be a string of the form
2732 @var{width}x@var{heigth}, or the name of a size abbreviation. The
2733 default value is "320x240".
2734
2735 @item rate, r
2736 Specify the frame rate of the sourced video, as the number of frames
2737 generated per second. It has to be a string in the format
2738 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2739 number or a valid video frame rate abbreviation. The default value is
2740 "25".
2741
2742 @item sar
2743 Set the sample aspect ratio of the sourced video.
2744
2745 @item duration
2746 Set the video duration of the sourced video. The accepted syntax is:
2747 @example
2748 [-]HH[:MM[:SS[.m...]]]
2749 [-]S+[.m...]
2750 @end example
2751 See also the function @code{av_parse_time()}.
2752
2753 If not specified, or the expressed duration is negative, the video is
2754 supposed to be generated forever.
2755 @end table
2756
2757 For example the following:
2758 @example
2759 testsrc=duration=5.3:size=qcif:rate=10
2760 @end example
2761
2762 will generate a video with a duration of 5.3 seconds, with size
2763 176x144 and a framerate of 10 frames per second.
2764
2765 If the input content is to be ignored, @code{nullsrc} can be used. The
2766 following command generates noise in the luminance plane by employing
2767 the @code{mp=geq} filter:
2768 @example
2769 nullsrc=s=256x256, mp=geq=random(1)*255:128:128
2770 @end example
2771
2772 @c man end VIDEO SOURCES
2773
2774 @chapter Video Sinks
2775 @c man begin VIDEO SINKS
2776
2777 Below is a description of the currently available video sinks.
2778
2779 @section buffersink
2780
2781 Buffer video frames, and make them available to the end of the filter
2782 graph.
2783
2784 This sink is mainly intended for a programmatic use, in particular
2785 through the interface defined in @file{libavfilter/buffersink.h}.
2786
2787 It does not require a string parameter in input, but you need to
2788 specify a pointer to a list of supported pixel formats terminated by
2789 -1 in the opaque parameter provided to @code{avfilter_init_filter}
2790 when initializing this sink.
2791
2792 @section nullsink
2793
2794 Null video sink, do absolutely nothing with the input video. It is
2795 mainly useful as a template and to be employed in analysis / debugging
2796 tools.
2797
2798 @c man end VIDEO SINKS
2799