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