examples/scaling_video: write to rawvideo file
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtering Introduction
2 @c man begin FILTERING INTRODUCTION
3
4 Filtering in FFmpeg is enabled through the libavfilter library.
5
6 Libavfilter is the filtering API of FFmpeg. It is the substitute of
7 the now deprecated 'vhooks' and started as a Google Summer of Code
8 project.
9
10 Audio filtering integration into the main FFmpeg repository is a work in
11 progress, so audio API and ABI should not be considered stable yet.
12
13 In libavfilter, it is possible for filters to have multiple inputs and
14 multiple outputs.
15 To illustrate the sorts of things that are possible, we can
16 use a complex filter graph. For example, the following one:
17
18 @example
19 input --> split --> fifo -----------------------> overlay --> output
20             |                                        ^
21             |                                        |
22             +------> fifo --> crop --> vflip --------+
23 @end example
24
25 splits the stream in two streams, sends one stream through the crop filter
26 and the vflip filter before merging it back with the other stream by
27 overlaying it on top. You can use the following command to achieve this:
28
29 @example
30 ffmpeg -i input -vf "[in] split [T1], fifo, [T2] overlay=0:H/2 [out]; [T1] fifo, crop=iw:ih/2:0:ih/2, vflip [T2]" output
31 @end example
32
33 The result will be that in output the top half of the video is mirrored
34 onto the bottom half.
35
36 Filters are loaded using the @var{-vf} or @var{-af} option passed to
37 @command{ffmpeg} or to @command{ffplay}. Filters in the same linear
38 chain are separated by commas. In our example, @var{split, fifo,
39 overlay} are in one linear chain, and @var{fifo, crop, vflip} are in
40 another. The points where the linear chains join are labeled by names
41 enclosed in square brackets. In our example, that is @var{[T1]} and
42 @var{[T2]}. The special labels @var{[in]} and @var{[out]} are the points
43 where video is input and output.
44
45 Some filters take in input a list of parameters: they are specified
46 after the filter name and an equal sign, and are separated from each other
47 by a colon.
48
49 There exist so-called @var{source filters} that do not have an
50 audio/video input, and @var{sink filters} that will not have audio/video
51 output.
52
53 @c man end FILTERING INTRODUCTION
54
55 @chapter graph2dot
56 @c man begin GRAPH2DOT
57
58 The @file{graph2dot} program included in the FFmpeg @file{tools}
59 directory can be used to parse a filter graph description and issue a
60 corresponding textual representation in the dot language.
61
62 Invoke the command:
63 @example
64 graph2dot -h
65 @end example
66
67 to see how to use @file{graph2dot}.
68
69 You can then pass the dot description to the @file{dot} program (from
70 the graphviz suite of programs) and obtain a graphical representation
71 of the filter graph.
72
73 For example the sequence of commands:
74 @example
75 echo @var{GRAPH_DESCRIPTION} | \
76 tools/graph2dot -o graph.tmp && \
77 dot -Tpng graph.tmp -o graph.png && \
78 display graph.png
79 @end example
80
81 can be used to create and display an image representing the graph
82 described by the @var{GRAPH_DESCRIPTION} string.
83
84 @c man end GRAPH2DOT
85
86 @chapter Filtergraph description
87 @c man begin FILTERGRAPH DESCRIPTION
88
89 A filtergraph is a directed graph of connected filters. It can contain
90 cycles, and there can be multiple links between a pair of
91 filters. Each link has one input pad on one side connecting it to one
92 filter from which it takes its input, and one output pad on the other
93 side connecting it to the one filter accepting its output.
94
95 Each filter in a filtergraph is an instance of a filter class
96 registered in the application, which defines the features and the
97 number of input and output pads of the filter.
98
99 A filter with no input pads is called a "source", a filter with no
100 output pads is called a "sink".
101
102 @anchor{Filtergraph syntax}
103 @section Filtergraph syntax
104
105 A filtergraph can be represented using a textual representation, which is
106 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
107 options in @command{ffmpeg} and @option{-vf} in @command{ffplay}, and by the
108 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
109 @file{libavfilter/avfiltergraph.h}.
110
111 A filterchain consists of a sequence of connected filters, each one
112 connected to the previous one in the sequence. A filterchain is
113 represented by a list of ","-separated filter descriptions.
114
115 A filtergraph consists of a sequence of filterchains. A sequence of
116 filterchains is represented by a list of ";"-separated filterchain
117 descriptions.
118
119 A filter is represented by a string of the form:
120 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
121
122 @var{filter_name} is the name of the filter class of which the
123 described filter is an instance of, and has to be the name of one of
124 the filter classes registered in the program.
125 The name of the filter class is optionally followed by a string
126 "=@var{arguments}".
127
128 @var{arguments} is a string which contains the parameters used to
129 initialize the filter instance, and are described in the filter
130 descriptions below.
131
132 The list of arguments can be quoted using the character "'" as initial
133 and ending mark, and the character '\' for escaping the characters
134 within the quoted text; otherwise the argument string is considered
135 terminated when the next special character (belonging to the set
136 "[]=;,") is encountered.
137
138 The name and arguments of the filter are optionally preceded and
139 followed by a list of link labels.
140 A link label allows to name a link and associate it to a filter output
141 or input pad. The preceding labels @var{in_link_1}
142 ... @var{in_link_N}, are associated to the filter input pads,
143 the following labels @var{out_link_1} ... @var{out_link_M}, are
144 associated to the output pads.
145
146 When two link labels with the same name are found in the
147 filtergraph, a link between the corresponding input and output pad is
148 created.
149
150 If an output pad is not labelled, it is linked by default to the first
151 unlabelled input pad of the next filter in the filterchain.
152 For example in the filterchain:
153 @example
154 nullsrc, split[L1], [L2]overlay, nullsink
155 @end example
156 the split filter instance has two output pads, and the overlay filter
157 instance two input pads. The first output pad of split is labelled
158 "L1", the first input pad of overlay is labelled "L2", and the second
159 output pad of split is linked to the second input pad of overlay,
160 which are both unlabelled.
161
162 In a complete filterchain all the unlabelled filter input and output
163 pads must be connected. A filtergraph is considered valid if all the
164 filter input and output pads of all the filterchains are connected.
165
166 Libavfilter will automatically insert scale filters where format
167 conversion is required. It is possible to specify swscale flags
168 for those automatically inserted scalers by prepending
169 @code{sws_flags=@var{flags};}
170 to the filtergraph description.
171
172 Follows a BNF description for the filtergraph syntax:
173 @example
174 @var{NAME}             ::= sequence of alphanumeric characters and '_'
175 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
176 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
177 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
178 @var{FILTER}           ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
179 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
180 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
181 @end example
182
183 @c man end FILTERGRAPH DESCRIPTION
184
185 @chapter Audio Filters
186 @c man begin AUDIO FILTERS
187
188 When you configure your FFmpeg build, you can disable any of the
189 existing filters using @code{--disable-filters}.
190 The configure output will show the audio filters included in your
191 build.
192
193 Below is a description of the currently available audio filters.
194
195 @section aconvert
196
197 Convert the input audio format to the specified formats.
198
199 The filter accepts a string of the form:
200 "@var{sample_format}:@var{channel_layout}".
201
202 @var{sample_format} specifies the sample format, and can be a string or the
203 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
204 suffix for a planar sample format.
205
206 @var{channel_layout} specifies the channel layout, and can be a string
207 or the corresponding number value defined in @file{libavutil/audioconvert.h}.
208
209 The special parameter "auto", signifies that the filter will
210 automatically select the output format depending on the output filter.
211
212 Some examples follow.
213
214 @itemize
215 @item
216 Convert input to float, planar, stereo:
217 @example
218 aconvert=fltp:stereo
219 @end example
220
221 @item
222 Convert input to unsigned 8-bit, automatically select out channel layout:
223 @example
224 aconvert=u8:auto
225 @end example
226 @end itemize
227
228 @section aformat
229
230 Convert the input audio to one of the specified formats. The framework will
231 negotiate the most appropriate format to minimize conversions.
232
233 The filter accepts the following named parameters:
234 @table @option
235
236 @item sample_fmts
237 A comma-separated list of requested sample formats.
238
239 @item sample_rates
240 A comma-separated list of requested sample rates.
241
242 @item channel_layouts
243 A comma-separated list of requested channel layouts.
244
245 @end table
246
247 If a parameter is omitted, all values are allowed.
248
249 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
250 @example
251 aformat=sample_fmts\=u8\,s16:channel_layouts\=stereo
252 @end example
253
254 @section amerge
255
256 Merge two or more audio streams into a single multi-channel stream.
257
258 The filter accepts the following named options:
259
260 @table @option
261
262 @item inputs
263 Set the number of inputs. Default is 2.
264
265 @end table
266
267 If the channel layouts of the inputs are disjoint, and therefore compatible,
268 the channel layout of the output will be set accordingly and the channels
269 will be reordered as necessary. If the channel layouts of the inputs are not
270 disjoint, the output will have all the channels of the first input then all
271 the channels of the second input, in that order, and the channel layout of
272 the output will be the default value corresponding to the total number of
273 channels.
274
275 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
276 is FC+BL+BR, then the output will be in 5.1, with the channels in the
277 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
278 first input, b1 is the first channel of the second input).
279
280 On the other hand, if both input are in stereo, the output channels will be
281 in the default order: a1, a2, b1, b2, and the channel layout will be
282 arbitrarily set to 4.0, which may or may not be the expected value.
283
284 All inputs must have the same sample rate, and format.
285
286 If inputs do not have the same duration, the output will stop with the
287 shortest.
288
289 Example: merge two mono files into a stereo stream:
290 @example
291 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
292 @end example
293
294 Example: multiple merges:
295 @example
296 ffmpeg -f lavfi -i "
297 amovie=input.mkv:si=0 [a0];
298 amovie=input.mkv:si=1 [a1];
299 amovie=input.mkv:si=2 [a2];
300 amovie=input.mkv:si=3 [a3];
301 amovie=input.mkv:si=4 [a4];
302 amovie=input.mkv:si=5 [a5];
303 [a0][a1][a2][a3][a4][a5] amerge=inputs=6" -c:a pcm_s16le output.mkv
304 @end example
305
306 @section amix
307
308 Mixes multiple audio inputs into a single output.
309
310 For example
311 @example
312 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
313 @end example
314 will mix 3 input audio streams to a single output with the same duration as the
315 first input and a dropout transition time of 3 seconds.
316
317 The filter accepts the following named parameters:
318 @table @option
319
320 @item inputs
321 Number of inputs. If unspecified, it defaults to 2.
322
323 @item duration
324 How to determine the end-of-stream.
325 @table @option
326
327 @item longest
328 Duration of longest input. (default)
329
330 @item shortest
331 Duration of shortest input.
332
333 @item first
334 Duration of first input.
335
336 @end table
337
338 @item dropout_transition
339 Transition time, in seconds, for volume renormalization when an input
340 stream ends. The default value is 2 seconds.
341
342 @end table
343
344 @section anull
345
346 Pass the audio source unchanged to the output.
347
348 @section aresample
349
350 Resample the input audio to the specified sample rate.
351
352 The filter accepts exactly one parameter, the output sample rate. If not
353 specified then the filter will automatically convert between its input
354 and output sample rates.
355
356 For example, to resample the input audio to 44100Hz:
357 @example
358 aresample=44100
359 @end example
360
361 @section asetnsamples
362
363 Set the number of samples per each output audio frame.
364
365 The last output packet may contain a different number of samples, as
366 the filter will flush all the remaining samples when the input audio
367 signal its end.
368
369 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
370 separated by ":".
371
372 @table @option
373
374 @item nb_out_samples, n
375 Set the number of frames per each output audio frame. The number is
376 intended as the number of samples @emph{per each channel}.
377 Default value is 1024.
378
379 @item pad, p
380 If set to 1, the filter will pad the last audio frame with zeroes, so
381 that the last frame will contain the same number of samples as the
382 previous ones. Default value is 1.
383 @end table
384
385 For example, to set the number of per-frame samples to 1234 and
386 disable padding for the last frame, use:
387 @example
388 asetnsamples=n=1234:p=0
389 @end example
390
391 @section ashowinfo
392
393 Show a line containing various information for each input audio frame.
394 The input audio is not modified.
395
396 The shown line contains a sequence of key/value pairs of the form
397 @var{key}:@var{value}.
398
399 A description of each shown parameter follows:
400
401 @table @option
402 @item n
403 sequential number of the input frame, starting from 0
404
405 @item pts
406 presentation TimeStamp of the input frame, expressed as a number of
407 time base units. The time base unit depends on the filter input pad, and
408 is usually 1/@var{sample_rate}.
409
410 @item pts_time
411 presentation TimeStamp of the input frame, expressed as a number of
412 seconds
413
414 @item pos
415 position of the frame in the input stream, -1 if this information in
416 unavailable and/or meaningless (for example in case of synthetic audio)
417
418 @item fmt
419 sample format name
420
421 @item chlayout
422 channel layout description
423
424 @item nb_samples
425 number of samples (per each channel) contained in the filtered frame
426
427 @item rate
428 sample rate for the audio frame
429
430 @item checksum
431 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
432
433 @item plane_checksum
434 Adler-32 checksum (printed in hexadecimal) for each input frame plane,
435 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3} @var{c4} @var{c5}
436 @var{c6} @var{c7}]"
437 @end table
438
439 @section asplit
440
441 Split input audio into several identical outputs.
442
443 The filter accepts a single parameter which specifies the number of outputs. If
444 unspecified, it defaults to 2.
445
446 For example:
447 @example
448 [in] asplit [out0][out1]
449 @end example
450
451 will create two separate outputs from the same input.
452
453 To create 3 or more outputs, you need to specify the number of
454 outputs, like in:
455 @example
456 [in] asplit=3 [out0][out1][out2]
457 @end example
458
459 @example
460 ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
461 @end example
462 will create 5 copies of the input audio.
463
464
465 @section astreamsync
466
467 Forward two audio streams and control the order the buffers are forwarded.
468
469 The argument to the filter is an expression deciding which stream should be
470 forwarded next: if the result is negative, the first stream is forwarded; if
471 the result is positive or zero, the second stream is forwarded. It can use
472 the following variables:
473
474 @table @var
475 @item b1 b2
476 number of buffers forwarded so far on each stream
477 @item s1 s2
478 number of samples forwarded so far on each stream
479 @item t1 t2
480 current timestamp of each stream
481 @end table
482
483 The default value is @code{t1-t2}, which means to always forward the stream
484 that has a smaller timestamp.
485
486 Example: stress-test @code{amerge} by randomly sending buffers on the wrong
487 input, while avoiding too much of a desynchronization:
488 @example
489 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
490 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
491 [a2] [b2] amerge
492 @end example
493
494 @section atempo
495
496 Adjust audio tempo.
497
498 The filter accepts exactly one parameter, the audio tempo. If not
499 specified then the filter will assume nominal 1.0 tempo. Tempo must
500 be in the [0.5, 2.0] range.
501
502 For example, to slow down audio to 80% tempo:
503 @example
504 atempo=0.8
505 @end example
506
507 For example, to speed up audio to 125% tempo:
508 @example
509 atempo=1.25
510 @end example
511
512 @section earwax
513
514 Make audio easier to listen to on headphones.
515
516 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
517 so that when listened to on headphones the stereo image is moved from
518 inside your head (standard for headphones) to outside and in front of
519 the listener (standard for speakers).
520
521 Ported from SoX.
522
523 @section pan
524
525 Mix channels with specific gain levels. The filter accepts the output
526 channel layout followed by a set of channels definitions.
527
528 This filter is also designed to remap efficiently the channels of an audio
529 stream.
530
531 The filter accepts parameters of the form:
532 "@var{l}:@var{outdef}:@var{outdef}:..."
533
534 @table @option
535 @item l
536 output channel layout or number of channels
537
538 @item outdef
539 output channel specification, of the form:
540 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
541
542 @item out_name
543 output channel to define, either a channel name (FL, FR, etc.) or a channel
544 number (c0, c1, etc.)
545
546 @item gain
547 multiplicative coefficient for the channel, 1 leaving the volume unchanged
548
549 @item in_name
550 input channel to use, see out_name for details; it is not possible to mix
551 named and numbered input channels
552 @end table
553
554 If the `=' in a channel specification is replaced by `<', then the gains for
555 that specification will be renormalized so that the total is 1, thus
556 avoiding clipping noise.
557
558 @subsection Mixing examples
559
560 For example, if you want to down-mix from stereo to mono, but with a bigger
561 factor for the left channel:
562 @example
563 pan=1:c0=0.9*c0+0.1*c1
564 @end example
565
566 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
567 7-channels surround:
568 @example
569 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
570 @end example
571
572 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
573 that should be preferred (see "-ac" option) unless you have very specific
574 needs.
575
576 @subsection Remapping examples
577
578 The channel remapping will be effective if, and only if:
579
580 @itemize
581 @item gain coefficients are zeroes or ones,
582 @item only one input per channel output,
583 @end itemize
584
585 If all these conditions are satisfied, the filter will notify the user ("Pure
586 channel mapping detected"), and use an optimized and lossless method to do the
587 remapping.
588
589 For example, if you have a 5.1 source and want a stereo audio stream by
590 dropping the extra channels:
591 @example
592 pan="stereo: c0=FL : c1=FR"
593 @end example
594
595 Given the same source, you can also switch front left and front right channels
596 and keep the input channel layout:
597 @example
598 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
599 @end example
600
601 If the input is a stereo audio stream, you can mute the front left channel (and
602 still keep the stereo channel layout) with:
603 @example
604 pan="stereo:c1=c1"
605 @end example
606
607 Still with a stereo audio stream input, you can copy the right channel in both
608 front left and right:
609 @example
610 pan="stereo: c0=FR : c1=FR"
611 @end example
612
613 @section silencedetect
614
615 Detect silence in an audio stream.
616
617 This filter logs a message when it detects that the input audio volume is less
618 or equal to a noise tolerance value for a duration greater or equal to the
619 minimum detected noise duration.
620
621 The printed times and duration are expressed in seconds.
622
623 @table @option
624 @item duration, d
625 Set silence duration until notification (default is 2 seconds).
626
627 @item noise, n
628 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
629 specified value) or amplitude ratio. Default is -60dB, or 0.001.
630 @end table
631
632 Detect 5 seconds of silence with -50dB noise tolerance:
633 @example
634 silencedetect=n=-50dB:d=5
635 @end example
636
637 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
638 tolerance in @file{silence.mp3}:
639 @example
640 ffmpeg -f lavfi -i amovie=silence.mp3,silencedetect=noise=0.0001 -f null -
641 @end example
642
643 @section volume
644
645 Adjust the input audio volume.
646
647 The filter accepts exactly one parameter @var{vol}, which expresses
648 how the audio volume will be increased or decreased.
649
650 Output values are clipped to the maximum value.
651
652 If @var{vol} is expressed as a decimal number, the output audio
653 volume is given by the relation:
654 @example
655 @var{output_volume} = @var{vol} * @var{input_volume}
656 @end example
657
658 If @var{vol} is expressed as a decimal number followed by the string
659 "dB", the value represents the requested change in decibels of the
660 input audio power, and the output audio volume is given by the
661 relation:
662 @example
663 @var{output_volume} = 10^(@var{vol}/20) * @var{input_volume}
664 @end example
665
666 Otherwise @var{vol} is considered an expression and its evaluated
667 value is used for computing the output audio volume according to the
668 first relation.
669
670 Default value for @var{vol} is 1.0.
671
672 @subsection Examples
673
674 @itemize
675 @item
676 Half the input audio volume:
677 @example
678 volume=0.5
679 @end example
680
681 The above example is equivalent to:
682 @example
683 volume=1/2
684 @end example
685
686 @item
687 Decrease input audio power by 12 decibels:
688 @example
689 volume=-12dB
690 @end example
691 @end itemize
692
693 @section volumedetect
694
695 Detect the volume of the input video.
696
697 The filter has no parameters. The input is not modified. Statistics about
698 the volume will be printed in the log when the input stream end is reached.
699
700 In particular it will show the mean volume (root mean square), maximum
701 volume (on a per-sample basis), and the beginning of an histogram of the
702 registered volume values (from the maximum value to a cumulated 1/1000 of
703 the samples).
704
705 All volumes are in decibels relative to the maximum PCM value.
706
707 Here is an excerpt of the output:
708 @example
709 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
710 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
711 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
712 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
713 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
714 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
715 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
716 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
717 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
718 @end example
719
720 It means that:
721 @itemize
722 @item
723 The mean square energy is approximately -27 dB, or 10^-2.7.
724 @item
725 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
726 @item
727 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
728 @end itemize
729
730 In other words, raising the volume by +4 dB does not cause any clipping,
731 raising it by +5 dB causes clipping for 6 samples, etc.
732
733 @section asyncts
734 Synchronize audio data with timestamps by squeezing/stretching it and/or
735 dropping samples/adding silence when needed.
736
737 The filter accepts the following named parameters:
738 @table @option
739
740 @item compensate
741 Enable stretching/squeezing the data to make it match the timestamps.
742
743 @item min_delta
744 Minimum difference between timestamps and audio data (in seconds) to trigger
745 adding/dropping samples.
746
747 @item max_comp
748 Maximum compensation in samples per second.
749
750 @item first_pts
751 Assume the first pts should be this value.
752 This allows for padding/trimming at the start of stream. By default, no
753 assumption is made about the first frame's expected pts, so no padding or
754 trimming is done. For example, this could be set to 0 to pad the beginning with
755 silence if an audio stream starts after the video stream.
756
757 @end table
758
759 @section channelsplit
760 Split each channel in input audio stream into a separate output stream.
761
762 This filter accepts the following named parameters:
763 @table @option
764 @item channel_layout
765 Channel layout of the input stream. Default is "stereo".
766 @end table
767
768 For example, assuming a stereo input MP3 file
769 @example
770 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
771 @end example
772 will create an output Matroska file with two audio streams, one containing only
773 the left channel and the other the right channel.
774
775 To split a 5.1 WAV file into per-channel files
776 @example
777 ffmpeg -i in.wav -filter_complex
778 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
779 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
780 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
781 side_right.wav
782 @end example
783
784 @section channelmap
785 Remap input channels to new locations.
786
787 This filter accepts the following named parameters:
788 @table @option
789 @item channel_layout
790 Channel layout of the output stream.
791
792 @item map
793 Map channels from input to output. The argument is a comma-separated list of
794 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
795 @var{in_channel} form. @var{in_channel} can be either the name of the input
796 channel (e.g. FL for front left) or its index in the input channel layout.
797 @var{out_channel} is the name of the output channel or its index in the output
798 channel layout. If @var{out_channel} is not given then it is implicitly an
799 index, starting with zero and increasing by one for each mapping.
800 @end table
801
802 If no mapping is present, the filter will implicitly map input channels to
803 output channels preserving index.
804
805 For example, assuming a 5.1+downmix input MOV file
806 @example
807 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL\,DR-FR' out.wav
808 @end example
809 will create an output WAV file tagged as stereo from the downmix channels of
810 the input.
811
812 To fix a 5.1 WAV improperly encoded in AAC's native channel order
813 @example
814 ffmpeg -i in.wav -filter 'channelmap=1\,2\,0\,5\,3\,4:channel_layout=5.1' out.wav
815 @end example
816
817 @section join
818 Join multiple input streams into one multi-channel stream.
819
820 The filter accepts the following named parameters:
821 @table @option
822
823 @item inputs
824 Number of input streams. Defaults to 2.
825
826 @item channel_layout
827 Desired output channel layout. Defaults to stereo.
828
829 @item map
830 Map channels from inputs to output. The argument is a comma-separated list of
831 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
832 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
833 can be either the name of the input channel (e.g. FL for front left) or its
834 index in the specified input stream. @var{out_channel} is the name of the output
835 channel.
836 @end table
837
838 The filter will attempt to guess the mappings when those are not specified
839 explicitly. It does so by first trying to find an unused matching input channel
840 and if that fails it picks the first unused input channel.
841
842 E.g. to join 3 inputs (with properly set channel layouts)
843 @example
844 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
845 @end example
846
847 To build a 5.1 output from 6 single-channel streams:
848 @example
849 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
850 'join=inputs=6:channel_layout=5.1:map=0.0-FL\,1.0-FR\,2.0-FC\,3.0-SL\,4.0-SR\,5.0-LFE'
851 out
852 @end example
853
854 @section resample
855 Convert the audio sample format, sample rate and channel layout. This filter is
856 not meant to be used directly.
857
858 @c man end AUDIO FILTERS
859
860 @chapter Audio Sources
861 @c man begin AUDIO SOURCES
862
863 Below is a description of the currently available audio sources.
864
865 @section abuffer
866
867 Buffer audio frames, and make them available to the filter chain.
868
869 This source is mainly intended for a programmatic use, in particular
870 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
871
872 It accepts the following mandatory parameters:
873 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}
874
875 @table @option
876
877 @item sample_rate
878 The sample rate of the incoming audio buffers.
879
880 @item sample_fmt
881 The sample format of the incoming audio buffers.
882 Either a sample format name or its corresponging integer representation from
883 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
884
885 @item channel_layout
886 The channel layout of the incoming audio buffers.
887 Either a channel layout name from channel_layout_map in
888 @file{libavutil/audioconvert.c} or its corresponding integer representation
889 from the AV_CH_LAYOUT_* macros in @file{libavutil/audioconvert.h}
890
891 @end table
892
893 For example:
894 @example
895 abuffer=44100:s16p:stereo
896 @end example
897
898 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
899 Since the sample format with name "s16p" corresponds to the number
900 6 and the "stereo" channel layout corresponds to the value 0x3, this is
901 equivalent to:
902 @example
903 abuffer=44100:6:0x3
904 @end example
905
906 @section aevalsrc
907
908 Generate an audio signal specified by an expression.
909
910 This source accepts in input one or more expressions (one for each
911 channel), which are evaluated and used to generate a corresponding
912 audio signal.
913
914 It accepts the syntax: @var{exprs}[::@var{options}].
915 @var{exprs} is a list of expressions separated by ":", one for each
916 separate channel. In case the @var{channel_layout} is not
917 specified, the selected channel layout depends on the number of
918 provided expressions.
919
920 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
921 separated by ":".
922
923 The description of the accepted options follows.
924
925 @table @option
926
927 @item channel_layout, c
928 Set the channel layout. The number of channels in the specified layout
929 must be equal to the number of specified expressions.
930
931 @item duration, d
932 Set the minimum duration of the sourced audio. See the function
933 @code{av_parse_time()} for the accepted format.
934 Note that the resulting duration may be greater than the specified
935 duration, as the generated audio is always cut at the end of a
936 complete frame.
937
938 If not specified, or the expressed duration is negative, the audio is
939 supposed to be generated forever.
940
941 @item nb_samples, n
942 Set the number of samples per channel per each output frame,
943 default to 1024.
944
945 @item sample_rate, s
946 Specify the sample rate, default to 44100.
947 @end table
948
949 Each expression in @var{exprs} can contain the following constants:
950
951 @table @option
952 @item n
953 number of the evaluated sample, starting from 0
954
955 @item t
956 time of the evaluated sample expressed in seconds, starting from 0
957
958 @item s
959 sample rate
960
961 @end table
962
963 @subsection Examples
964
965 @itemize
966
967 @item
968 Generate silence:
969 @example
970 aevalsrc=0
971 @end example
972
973 @item
974
975 Generate a sin signal with frequency of 440 Hz, set sample rate to
976 8000 Hz:
977 @example
978 aevalsrc="sin(440*2*PI*t)::s=8000"
979 @end example
980
981 @item
982 Generate a two channels signal, specify the channel layout (Front
983 Center + Back Center) explicitly:
984 @example
985 aevalsrc="sin(420*2*PI*t):cos(430*2*PI*t)::c=FC|BC"
986 @end example
987
988 @item
989 Generate white noise:
990 @example
991 aevalsrc="-2+random(0)"
992 @end example
993
994 @item
995 Generate an amplitude modulated signal:
996 @example
997 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
998 @end example
999
1000 @item
1001 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
1002 @example
1003 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"
1004 @end example
1005
1006 @end itemize
1007
1008 @section anullsrc
1009
1010 Null audio source, return unprocessed audio frames. It is mainly useful
1011 as a template and to be employed in analysis / debugging tools, or as
1012 the source for filters which ignore the input data (for example the sox
1013 synth filter).
1014
1015 It accepts an optional sequence of @var{key}=@var{value} pairs,
1016 separated by ":".
1017
1018 The description of the accepted options follows.
1019
1020 @table @option
1021
1022 @item sample_rate, s
1023 Specify the sample rate, and defaults to 44100.
1024
1025 @item channel_layout, cl
1026
1027 Specify the channel layout, and can be either an integer or a string
1028 representing a channel layout. The default value of @var{channel_layout}
1029 is "stereo".
1030
1031 Check the channel_layout_map definition in
1032 @file{libavcodec/audioconvert.c} for the mapping between strings and
1033 channel layout values.
1034
1035 @item nb_samples, n
1036 Set the number of samples per requested frames.
1037
1038 @end table
1039
1040 Follow some examples:
1041 @example
1042 #  set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
1043 anullsrc=r=48000:cl=4
1044
1045 # same as
1046 anullsrc=r=48000:cl=mono
1047 @end example
1048
1049 @section abuffer
1050 Buffer audio frames, and make them available to the filter chain.
1051
1052 This source is not intended to be part of user-supplied graph descriptions but
1053 for insertion by calling programs through the interface defined in
1054 @file{libavfilter/buffersrc.h}.
1055
1056 It accepts the following named parameters:
1057 @table @option
1058
1059 @item time_base
1060 Timebase which will be used for timestamps of submitted frames. It must be
1061 either a floating-point number or in @var{numerator}/@var{denominator} form.
1062
1063 @item sample_rate
1064 Audio sample rate.
1065
1066 @item sample_fmt
1067 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
1068
1069 @item channel_layout
1070 Channel layout of the audio data, in the form that can be accepted by
1071 @code{av_get_channel_layout()}.
1072 @end table
1073
1074 All the parameters need to be explicitly defined.
1075
1076 @section flite
1077
1078 Synthesize a voice utterance using the libflite library.
1079
1080 To enable compilation of this filter you need to configure FFmpeg with
1081 @code{--enable-libflite}.
1082
1083 Note that the flite library is not thread-safe.
1084
1085 The source accepts parameters as a list of @var{key}=@var{value} pairs,
1086 separated by ":".
1087
1088 The description of the accepted parameters follows.
1089
1090 @table @option
1091
1092 @item list_voices
1093 If set to 1, list the names of the available voices and exit
1094 immediately. Default value is 0.
1095
1096 @item nb_samples, n
1097 Set the maximum number of samples per frame. Default value is 512.
1098
1099 @item textfile
1100 Set the filename containing the text to speak.
1101
1102 @item text
1103 Set the text to speak.
1104
1105 @item voice, v
1106 Set the voice to use for the speech synthesis. Default value is
1107 @code{kal}. See also the @var{list_voices} option.
1108 @end table
1109
1110 @subsection Examples
1111
1112 @itemize
1113 @item
1114 Read from file @file{speech.txt}, and synthetize the text using the
1115 standard flite voice:
1116 @example
1117 flite=textfile=speech.txt
1118 @end example
1119
1120 @item
1121 Read the specified text selecting the @code{slt} voice:
1122 @example
1123 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1124 @end example
1125
1126 @item
1127 Make @file{ffplay} speech the specified text, using @code{flite} and
1128 the @code{lavfi} device:
1129 @example
1130 ffplay -f lavfi flite='No more be grieved for which that thou hast done.'
1131 @end example
1132 @end itemize
1133
1134 For more information about libflite, check:
1135 @url{http://www.speech.cs.cmu.edu/flite/}
1136
1137 @c man end AUDIO SOURCES
1138
1139 @chapter Audio Sinks
1140 @c man begin AUDIO SINKS
1141
1142 Below is a description of the currently available audio sinks.
1143
1144 @section abuffersink
1145
1146 Buffer audio frames, and make them available to the end of filter chain.
1147
1148 This sink is mainly intended for programmatic use, in particular
1149 through the interface defined in @file{libavfilter/buffersink.h}.
1150
1151 It requires a pointer to an AVABufferSinkContext structure, which
1152 defines the incoming buffers' formats, to be passed as the opaque
1153 parameter to @code{avfilter_init_filter} for initialization.
1154
1155 @section anullsink
1156
1157 Null audio sink, do absolutely nothing with the input audio. It is
1158 mainly useful as a template and to be employed in analysis / debugging
1159 tools.
1160
1161 @section abuffersink
1162 This sink is intended for programmatic use. Frames that arrive on this sink can
1163 be retrieved by the calling program using the interface defined in
1164 @file{libavfilter/buffersink.h}.
1165
1166 This filter accepts no parameters.
1167
1168 @c man end AUDIO SINKS
1169
1170 @chapter Video Filters
1171 @c man begin VIDEO FILTERS
1172
1173 When you configure your FFmpeg build, you can disable any of the
1174 existing filters using @code{--disable-filters}.
1175 The configure output will show the video filters included in your
1176 build.
1177
1178 Below is a description of the currently available video filters.
1179
1180 @section alphaextract
1181
1182 Extract the alpha component from the input as a grayscale video. This
1183 is especially useful with the @var{alphamerge} filter.
1184
1185 @section alphamerge
1186
1187 Add or replace the alpha component of the primary input with the
1188 grayscale value of a second input. This is intended for use with
1189 @var{alphaextract} to allow the transmission or storage of frame
1190 sequences that have alpha in a format that doesn't support an alpha
1191 channel.
1192
1193 For example, to reconstruct full frames from a normal YUV-encoded video
1194 and a separate video created with @var{alphaextract}, you might use:
1195 @example
1196 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
1197 @end example
1198
1199 Since this filter is designed for reconstruction, it operates on frame
1200 sequences without considering timestamps, and terminates when either
1201 input reaches end of stream. This will cause problems if your encoding
1202 pipeline drops frames. If you're trying to apply an image as an
1203 overlay to a video stream, consider the @var{overlay} filter instead.
1204
1205 @section ass
1206
1207 Draw ASS (Advanced Substation Alpha) subtitles on top of input video
1208 using the libass library.
1209
1210 To enable compilation of this filter you need to configure FFmpeg with
1211 @code{--enable-libass}.
1212
1213 This filter accepts the syntax: @var{ass_filename}[:@var{options}],
1214 where @var{ass_filename} is the filename of the ASS file to read, and
1215 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
1216 separated by ":".
1217
1218 A description of the accepted options follows.
1219
1220 @table @option
1221 @item original_size
1222 Specifies the size of the original video, the video for which the ASS file
1223 was composed. Due to a misdesign in ASS aspect ratio arithmetic, this is
1224 necessary to correctly scale the fonts if the aspect ratio has been changed.
1225 @end table
1226
1227 For example, to render the file @file{sub.ass} on top of the input
1228 video, use the command:
1229 @example
1230 ass=sub.ass
1231 @end example
1232
1233 @section bbox
1234
1235 Compute the bounding box for the non-black pixels in the input frame
1236 luminance plane.
1237
1238 This filter computes the bounding box containing all the pixels with a
1239 luminance value greater than the minimum allowed value.
1240 The parameters describing the bounding box are printed on the filter
1241 log.
1242
1243 @section blackdetect
1244
1245 Detect video intervals that are (almost) completely black. Can be
1246 useful to detect chapter transitions, commercials, or invalid
1247 recordings. Output lines contains the time for the start, end and
1248 duration of the detected black interval expressed in seconds.
1249
1250 In order to display the output lines, you need to set the loglevel at
1251 least to the AV_LOG_INFO value.
1252
1253 This filter accepts a list of options in the form of
1254 @var{key}=@var{value} pairs separated by ":". A description of the
1255 accepted options follows.
1256
1257 @table @option
1258 @item black_min_duration, d
1259 Set the minimum detected black duration expressed in seconds. It must
1260 be a non-negative floating point number.
1261
1262 Default value is 2.0.
1263
1264 @item picture_black_ratio_th, pic_th
1265 Set the threshold for considering a picture "black".
1266 Express the minimum value for the ratio:
1267 @example
1268 @var{nb_black_pixels} / @var{nb_pixels}
1269 @end example
1270
1271 for which a picture is considered black.
1272 Default value is 0.98.
1273
1274 @item pixel_black_th, pix_th
1275 Set the threshold for considering a pixel "black".
1276
1277 The threshold expresses the maximum pixel luminance value for which a
1278 pixel is considered "black". The provided value is scaled according to
1279 the following equation:
1280 @example
1281 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1282 @end example
1283
1284 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1285 the input video format, the range is [0-255] for YUV full-range
1286 formats and [16-235] for YUV non full-range formats.
1287
1288 Default value is 0.10.
1289 @end table
1290
1291 The following example sets the maximum pixel threshold to the minimum
1292 value, and detects only black intervals of 2 or more seconds:
1293 @example
1294 blackdetect=d=2:pix_th=0.00
1295 @end example
1296
1297 @section blackframe
1298
1299 Detect frames that are (almost) completely black. Can be useful to
1300 detect chapter transitions or commercials. Output lines consist of
1301 the frame number of the detected frame, the percentage of blackness,
1302 the position in the file if known or -1 and the timestamp in seconds.
1303
1304 In order to display the output lines, you need to set the loglevel at
1305 least to the AV_LOG_INFO value.
1306
1307 The filter accepts the syntax:
1308 @example
1309 blackframe[=@var{amount}:[@var{threshold}]]
1310 @end example
1311
1312 @var{amount} is the percentage of the pixels that have to be below the
1313 threshold, and defaults to 98.
1314
1315 @var{threshold} is the threshold below which a pixel value is
1316 considered black, and defaults to 32.
1317
1318 @section boxblur
1319
1320 Apply boxblur algorithm to the input video.
1321
1322 This filter accepts the parameters:
1323 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
1324
1325 Chroma and alpha parameters are optional, if not specified they default
1326 to the corresponding values set for @var{luma_radius} and
1327 @var{luma_power}.
1328
1329 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
1330 the radius in pixels of the box used for blurring the corresponding
1331 input plane. They are expressions, and can contain the following
1332 constants:
1333 @table @option
1334 @item w, h
1335 the input width and height in pixels
1336
1337 @item cw, ch
1338 the input chroma image width and height in pixels
1339
1340 @item hsub, vsub
1341 horizontal and vertical chroma subsample values. For example for the
1342 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1343 @end table
1344
1345 The radius must be a non-negative number, and must not be greater than
1346 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
1347 and of @code{min(cw,ch)/2} for the chroma planes.
1348
1349 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
1350 how many times the boxblur filter is applied to the corresponding
1351 plane.
1352
1353 Some examples follow:
1354
1355 @itemize
1356
1357 @item
1358 Apply a boxblur filter with luma, chroma, and alpha radius
1359 set to 2:
1360 @example
1361 boxblur=2:1
1362 @end example
1363
1364 @item
1365 Set luma radius to 2, alpha and chroma radius to 0
1366 @example
1367 boxblur=2:1:0:0:0:0
1368 @end example
1369
1370 @item
1371 Set luma and chroma radius to a fraction of the video dimension
1372 @example
1373 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
1374 @end example
1375
1376 @end itemize
1377
1378 @section colormatrix
1379
1380 The colormatrix filter allows conversion between any of the following color
1381 space: BT.709 (@var{bt709}), BT.601 (@var{bt601}), SMPTE-240M (@var{smpte240m})
1382 and FCC (@var{fcc}).
1383
1384 The syntax of the parameters is @var{source}:@var{destination}:
1385
1386 @example
1387 colormatrix=bt601:smpte240m
1388 @end example
1389
1390 @section copy
1391
1392 Copy the input source unchanged to the output. Mainly useful for
1393 testing purposes.
1394
1395 @section crop
1396
1397 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}:@var{keep_aspect}
1398
1399 The @var{keep_aspect} parameter is optional, if specified and set to a
1400 non-zero value will force the output display aspect ratio to be the
1401 same of the input, by changing the output sample aspect ratio.
1402
1403 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
1404 expressions containing the following constants:
1405
1406 @table @option
1407 @item x, y
1408 the computed values for @var{x} and @var{y}. They are evaluated for
1409 each new frame.
1410
1411 @item in_w, in_h
1412 the input width and height
1413
1414 @item iw, ih
1415 same as @var{in_w} and @var{in_h}
1416
1417 @item out_w, out_h
1418 the output (cropped) width and height
1419
1420 @item ow, oh
1421 same as @var{out_w} and @var{out_h}
1422
1423 @item a
1424 same as @var{iw} / @var{ih}
1425
1426 @item sar
1427 input sample aspect ratio
1428
1429 @item dar
1430 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1431
1432 @item hsub, vsub
1433 horizontal and vertical chroma subsample values. For example for the
1434 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1435
1436 @item n
1437 the number of input frame, starting from 0
1438
1439 @item pos
1440 the position in the file of the input frame, NAN if unknown
1441
1442 @item t
1443 timestamp expressed in seconds, NAN if the input timestamp is unknown
1444
1445 @end table
1446
1447 The @var{out_w} and @var{out_h} parameters specify the expressions for
1448 the width and height of the output (cropped) video. They are
1449 evaluated just at the configuration of the filter.
1450
1451 The default value of @var{out_w} is "in_w", and the default value of
1452 @var{out_h} is "in_h".
1453
1454 The expression for @var{out_w} may depend on the value of @var{out_h},
1455 and the expression for @var{out_h} may depend on @var{out_w}, but they
1456 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
1457 evaluated after @var{out_w} and @var{out_h}.
1458
1459 The @var{x} and @var{y} parameters specify the expressions for the
1460 position of the top-left corner of the output (non-cropped) area. They
1461 are evaluated for each frame. If the evaluated value is not valid, it
1462 is approximated to the nearest valid value.
1463
1464 The default value of @var{x} is "(in_w-out_w)/2", and the default
1465 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
1466 the center of the input image.
1467
1468 The expression for @var{x} may depend on @var{y}, and the expression
1469 for @var{y} may depend on @var{x}.
1470
1471 Follow some examples:
1472 @example
1473 # crop the central input area with size 100x100
1474 crop=100:100
1475
1476 # crop the central input area with size 2/3 of the input video
1477 "crop=2/3*in_w:2/3*in_h"
1478
1479 # crop the input video central square
1480 crop=in_h
1481
1482 # delimit the rectangle with the top-left corner placed at position
1483 # 100:100 and the right-bottom corner corresponding to the right-bottom
1484 # corner of the input image.
1485 crop=in_w-100:in_h-100:100:100
1486
1487 # crop 10 pixels from the left and right borders, and 20 pixels from
1488 # the top and bottom borders
1489 "crop=in_w-2*10:in_h-2*20"
1490
1491 # keep only the bottom right quarter of the input image
1492 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
1493
1494 # crop height for getting Greek harmony
1495 "crop=in_w:1/PHI*in_w"
1496
1497 # trembling effect
1498 "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)"
1499
1500 # erratic camera effect depending on timestamp
1501 "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)"
1502
1503 # set x depending on the value of y
1504 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
1505 @end example
1506
1507 @section cropdetect
1508
1509 Auto-detect crop size.
1510
1511 Calculate necessary cropping parameters and prints the recommended
1512 parameters through the logging system. The detected dimensions
1513 correspond to the non-black area of the input video.
1514
1515 It accepts the syntax:
1516 @example
1517 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
1518 @end example
1519
1520 @table @option
1521
1522 @item limit
1523 Threshold, which can be optionally specified from nothing (0) to
1524 everything (255), defaults to 24.
1525
1526 @item round
1527 Value which the width/height should be divisible by, defaults to
1528 16. The offset is automatically adjusted to center the video. Use 2 to
1529 get only even dimensions (needed for 4:2:2 video). 16 is best when
1530 encoding to most video codecs.
1531
1532 @item reset
1533 Counter that determines after how many frames cropdetect will reset
1534 the previously detected largest video area and start over to detect
1535 the current optimal crop area. Defaults to 0.
1536
1537 This can be useful when channel logos distort the video area. 0
1538 indicates never reset and return the largest area encountered during
1539 playback.
1540 @end table
1541
1542 @section decimate
1543
1544 This filter drops frames that do not differ greatly from the previous
1545 frame in order to reduce framerate.  The main use of this filter is
1546 for very-low-bitrate encoding (e.g. streaming over dialup modem), but
1547 it could in theory be used for fixing movies that were
1548 inverse-telecined incorrectly.
1549
1550 It accepts the following parameters:
1551 @var{max}:@var{hi}:@var{lo}:@var{frac}.
1552
1553 @table @option
1554
1555 @item max
1556 Set the maximum number of consecutive frames which can be dropped (if
1557 positive), or the minimum interval between dropped frames (if
1558 negative). If the value is 0, the frame is dropped unregarding the
1559 number of previous sequentially dropped frames.
1560
1561 Default value is 0.
1562
1563 @item hi, lo, frac
1564 Set the dropping threshold values.
1565
1566 Values for @var{hi} and @var{lo} are for 8x8 pixel blocks and
1567 represent actual pixel value differences, so a threshold of 64
1568 corresponds to 1 unit of difference for each pixel, or the same spread
1569 out differently over the block.
1570
1571 A frame is a candidate for dropping if no 8x8 blocks differ by more
1572 than a threshold of @var{hi}, and if no more than @var{frac} blocks (1
1573 meaning the whole image) differ by more than a threshold of @var{lo}.
1574
1575 Default value for @var{hi} is 64*12, default value for @var{lo} is
1576 64*5, and default value for @var{frac} is 0.33.
1577 @end table
1578
1579 @section delogo
1580
1581 Suppress a TV station logo by a simple interpolation of the surrounding
1582 pixels. Just set a rectangle covering the logo and watch it disappear
1583 (and sometimes something even uglier appear - your mileage may vary).
1584
1585 The filter accepts parameters as a string of the form
1586 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
1587 @var{key}=@var{value} pairs, separated by ":".
1588
1589 The description of the accepted parameters follows.
1590
1591 @table @option
1592
1593 @item x, y
1594 Specify the top left corner coordinates of the logo. They must be
1595 specified.
1596
1597 @item w, h
1598 Specify the width and height of the logo to clear. They must be
1599 specified.
1600
1601 @item band, t
1602 Specify the thickness of the fuzzy edge of the rectangle (added to
1603 @var{w} and @var{h}). The default value is 4.
1604
1605 @item show
1606 When set to 1, a green rectangle is drawn on the screen to simplify
1607 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
1608 @var{band} is set to 4. The default value is 0.
1609
1610 @end table
1611
1612 Some examples follow.
1613
1614 @itemize
1615
1616 @item
1617 Set a rectangle covering the area with top left corner coordinates 0,0
1618 and size 100x77, setting a band of size 10:
1619 @example
1620 delogo=0:0:100:77:10
1621 @end example
1622
1623 @item
1624 As the previous example, but use named options:
1625 @example
1626 delogo=x=0:y=0:w=100:h=77:band=10
1627 @end example
1628
1629 @end itemize
1630
1631 @section deshake
1632
1633 Attempt to fix small changes in horizontal and/or vertical shift. This
1634 filter helps remove camera shake from hand-holding a camera, bumping a
1635 tripod, moving on a vehicle, etc.
1636
1637 The filter accepts parameters as a string of the form
1638 "@var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}"
1639
1640 A description of the accepted parameters follows.
1641
1642 @table @option
1643
1644 @item x, y, w, h
1645 Specify a rectangular area where to limit the search for motion
1646 vectors.
1647 If desired the search for motion vectors can be limited to a
1648 rectangular area of the frame defined by its top left corner, width
1649 and height. These parameters have the same meaning as the drawbox
1650 filter which can be used to visualise the position of the bounding
1651 box.
1652
1653 This is useful when simultaneous movement of subjects within the frame
1654 might be confused for camera motion by the motion vector search.
1655
1656 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
1657 then the full frame is used. This allows later options to be set
1658 without specifying the bounding box for the motion vector search.
1659
1660 Default - search the whole frame.
1661
1662 @item rx, ry
1663 Specify the maximum extent of movement in x and y directions in the
1664 range 0-64 pixels. Default 16.
1665
1666 @item edge
1667 Specify how to generate pixels to fill blanks at the edge of the
1668 frame. An integer from 0 to 3 as follows:
1669 @table @option
1670 @item 0
1671 Fill zeroes at blank locations
1672 @item 1
1673 Original image at blank locations
1674 @item 2
1675 Extruded edge value at blank locations
1676 @item 3
1677 Mirrored edge at blank locations
1678 @end table
1679
1680 The default setting is mirror edge at blank locations.
1681
1682 @item blocksize
1683 Specify the blocksize to use for motion search. Range 4-128 pixels,
1684 default 8.
1685
1686 @item contrast
1687 Specify the contrast threshold for blocks. Only blocks with more than
1688 the specified contrast (difference between darkest and lightest
1689 pixels) will be considered. Range 1-255, default 125.
1690
1691 @item search
1692 Specify the search strategy 0 = exhaustive search, 1 = less exhaustive
1693 search. Default - exhaustive search.
1694
1695 @item filename
1696 If set then a detailed log of the motion search is written to the
1697 specified file.
1698
1699 @end table
1700
1701 @section drawbox
1702
1703 Draw a colored box on the input image.
1704
1705 It accepts the syntax:
1706 @example
1707 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
1708 @end example
1709
1710 @table @option
1711
1712 @item x, y
1713 Specify the top left corner coordinates of the box. Default to 0.
1714
1715 @item width, height
1716 Specify the width and height of the box, if 0 they are interpreted as
1717 the input width and height. Default to 0.
1718
1719 @item color
1720 Specify the color of the box to write, it can be the name of a color
1721 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1722 @end table
1723
1724 Follow some examples:
1725 @example
1726 # draw a black box around the edge of the input image
1727 drawbox
1728
1729 # draw a box with color red and an opacity of 50%
1730 drawbox=10:20:200:60:red@@0.5"
1731 @end example
1732
1733 @section drawtext
1734
1735 Draw text string or text from specified file on top of video using the
1736 libfreetype library.
1737
1738 To enable compilation of this filter you need to configure FFmpeg with
1739 @code{--enable-libfreetype}.
1740
1741 The filter also recognizes strftime() sequences in the provided text
1742 and expands them accordingly. Check the documentation of strftime().
1743
1744 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
1745 separated by ":".
1746
1747 The description of the accepted parameters follows.
1748
1749 @table @option
1750
1751 @item box
1752 Used to draw a box around text using background color.
1753 Value should be either 1 (enable) or 0 (disable).
1754 The default value of @var{box} is 0.
1755
1756 @item boxcolor
1757 The color to be used for drawing box around text.
1758 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
1759 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1760 The default value of @var{boxcolor} is "white".
1761
1762 @item draw
1763 Set an expression which specifies if the text should be drawn. If the
1764 expression evaluates to 0, the text is not drawn. This is useful for
1765 specifying that the text should be drawn only when specific conditions
1766 are met.
1767
1768 Default value is "1".
1769
1770 See below for the list of accepted constants and functions.
1771
1772 @item fix_bounds
1773 If true, check and fix text coords to avoid clipping.
1774
1775 @item fontcolor
1776 The color to be used for drawing fonts.
1777 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
1778 (e.g. "0xff000033"), possibly followed by an alpha specifier.
1779 The default value of @var{fontcolor} is "black".
1780
1781 @item fontfile
1782 The font file to be used for drawing text. Path must be included.
1783 This parameter is mandatory.
1784
1785 @item fontsize
1786 The font size to be used for drawing text.
1787 The default value of @var{fontsize} is 16.
1788
1789 @item ft_load_flags
1790 Flags to be used for loading the fonts.
1791
1792 The flags map the corresponding flags supported by libfreetype, and are
1793 a combination of the following values:
1794 @table @var
1795 @item default
1796 @item no_scale
1797 @item no_hinting
1798 @item render
1799 @item no_bitmap
1800 @item vertical_layout
1801 @item force_autohint
1802 @item crop_bitmap
1803 @item pedantic
1804 @item ignore_global_advance_width
1805 @item no_recurse
1806 @item ignore_transform
1807 @item monochrome
1808 @item linear_design
1809 @item no_autohint
1810 @item end table
1811 @end table
1812
1813 Default value is "render".
1814
1815 For more information consult the documentation for the FT_LOAD_*
1816 libfreetype flags.
1817
1818 @item shadowcolor
1819 The color to be used for drawing a shadow behind the drawn text.  It
1820 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
1821 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1822 The default value of @var{shadowcolor} is "black".
1823
1824 @item shadowx, shadowy
1825 The x and y offsets for the text shadow position with respect to the
1826 position of the text. They can be either positive or negative
1827 values. Default value for both is "0".
1828
1829 @item tabsize
1830 The size in number of spaces to use for rendering the tab.
1831 Default value is 4.
1832
1833 @item timecode
1834 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
1835 format. It can be used with or without text parameter. @var{timecode_rate}
1836 option must be specified.
1837
1838 @item timecode_rate, rate, r
1839 Set the timecode frame rate (timecode only).
1840
1841 @item text
1842 The text string to be drawn. The text must be a sequence of UTF-8
1843 encoded characters.
1844 This parameter is mandatory if no file is specified with the parameter
1845 @var{textfile}.
1846
1847 @item textfile
1848 A text file containing text to be drawn. The text must be a sequence
1849 of UTF-8 encoded characters.
1850
1851 This parameter is mandatory if no text string is specified with the
1852 parameter @var{text}.
1853
1854 If both @var{text} and @var{textfile} are specified, an error is thrown.
1855
1856 @item x, y
1857 The expressions which specify the offsets where text will be drawn
1858 within the video frame. They are relative to the top/left border of the
1859 output image.
1860
1861 The default value of @var{x} and @var{y} is "0".
1862
1863 See below for the list of accepted constants and functions.
1864 @end table
1865
1866 The parameters for @var{x} and @var{y} are expressions containing the
1867 following constants and functions:
1868
1869 @table @option
1870 @item dar
1871 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
1872
1873 @item hsub, vsub
1874 horizontal and vertical chroma subsample values. For example for the
1875 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1876
1877 @item line_h, lh
1878 the height of each text line
1879
1880 @item main_h, h, H
1881 the input height
1882
1883 @item main_w, w, W
1884 the input width
1885
1886 @item max_glyph_a, ascent
1887 the maximum distance from the baseline to the highest/upper grid
1888 coordinate used to place a glyph outline point, for all the rendered
1889 glyphs.
1890 It is a positive value, due to the grid's orientation with the Y axis
1891 upwards.
1892
1893 @item max_glyph_d, descent
1894 the maximum distance from the baseline to the lowest grid coordinate
1895 used to place a glyph outline point, for all the rendered glyphs.
1896 This is a negative value, due to the grid's orientation, with the Y axis
1897 upwards.
1898
1899 @item max_glyph_h
1900 maximum glyph height, that is the maximum height for all the glyphs
1901 contained in the rendered text, it is equivalent to @var{ascent} -
1902 @var{descent}.
1903
1904 @item max_glyph_w
1905 maximum glyph width, that is the maximum width for all the glyphs
1906 contained in the rendered text
1907
1908 @item n
1909 the number of input frame, starting from 0
1910
1911 @item rand(min, max)
1912 return a random number included between @var{min} and @var{max}
1913
1914 @item sar
1915 input sample aspect ratio
1916
1917 @item t
1918 timestamp expressed in seconds, NAN if the input timestamp is unknown
1919
1920 @item text_h, th
1921 the height of the rendered text
1922
1923 @item text_w, tw
1924 the width of the rendered text
1925
1926 @item x, y
1927 the x and y offset coordinates where the text is drawn.
1928
1929 These parameters allow the @var{x} and @var{y} expressions to refer
1930 each other, so you can for example specify @code{y=x/dar}.
1931 @end table
1932
1933 If libavfilter was built with @code{--enable-fontconfig}, then
1934 @option{fontfile} can be a fontconfig pattern or omitted.
1935
1936 Some examples follow.
1937
1938 @itemize
1939
1940 @item
1941 Draw "Test Text" with font FreeSerif, using the default values for the
1942 optional parameters.
1943
1944 @example
1945 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1946 @end example
1947
1948 @item
1949 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
1950 and y=50 (counting from the top-left corner of the screen), text is
1951 yellow with a red box around it. Both the text and the box have an
1952 opacity of 20%.
1953
1954 @example
1955 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1956           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
1957 @end example
1958
1959 Note that the double quotes are not necessary if spaces are not used
1960 within the parameter list.
1961
1962 @item
1963 Show the text at the center of the video frame:
1964 @example
1965 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
1966 @end example
1967
1968 @item
1969 Show a text line sliding from right to left in the last row of the video
1970 frame. The file @file{LONG_LINE} is assumed to contain a single line
1971 with no newlines.
1972 @example
1973 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
1974 @end example
1975
1976 @item
1977 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
1978 @example
1979 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
1980 @end example
1981
1982 @item
1983 Draw a single green letter "g", at the center of the input video.
1984 The glyph baseline is placed at half screen height.
1985 @example
1986 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
1987 @end example
1988
1989 @item
1990 Show text for 1 second every 3 seconds:
1991 @example
1992 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\\,3)\\,1):text='blink'"
1993 @end example
1994
1995 @item
1996 Use fontconfig to set the font. Note that the colons need to be escaped.
1997 @example
1998 drawtext='fontfile=Linux Libertine O-40\\:style=Semibold:text=FFmpeg'
1999 @end example
2000
2001 @end itemize
2002
2003 For more information about libfreetype, check:
2004 @url{http://www.freetype.org/}.
2005
2006 For more information about fontconfig, check:
2007 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
2008
2009 @section edgedetect
2010
2011 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
2012
2013 This filter accepts the following optional named parameters:
2014
2015 @table @option
2016 @item low, high
2017 Set low and high threshold values used by the Canny thresholding
2018 algorithm.
2019
2020 The high threshold selects the "strong" edge pixels, which are then
2021 connected through 8-connectivity with the "weak" edge pixels selected
2022 by the low threshold.
2023
2024 @var{low} and @var{high} threshold values must be choosen in the range
2025 [0,1], and @var{low} should be lesser or equal to @var{high}.
2026
2027 Default value for @var{low} is @code{20/255}, and default value for @var{high}
2028 is @code{50/255}.
2029 @end table
2030
2031 Example:
2032 @example
2033 edgedetect=low=0.1:high=0.4
2034 @end example
2035
2036 @section fade
2037
2038 Apply fade-in/out effect to input video.
2039
2040 It accepts the parameters:
2041 @var{type}:@var{start_frame}:@var{nb_frames}[:@var{options}]
2042
2043 @var{type} specifies if the effect type, can be either "in" for
2044 fade-in, or "out" for a fade-out effect.
2045
2046 @var{start_frame} specifies the number of the start frame for starting
2047 to apply the fade effect.
2048
2049 @var{nb_frames} specifies the number of frames for which the fade
2050 effect has to last. At the end of the fade-in effect the output video
2051 will have the same intensity as the input video, at the end of the
2052 fade-out transition the output video will be completely black.
2053
2054 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
2055 separated by ":". The description of the accepted options follows.
2056
2057 @table @option
2058
2059 @item type, t
2060 See @var{type}.
2061
2062 @item start_frame, s
2063 See @var{start_frame}.
2064
2065 @item nb_frames, n
2066 See @var{nb_frames}.
2067
2068 @item alpha
2069 If set to 1, fade only alpha channel, if one exists on the input.
2070 Default value is 0.
2071 @end table
2072
2073 A few usage examples follow, usable too as test scenarios.
2074 @example
2075 # fade in first 30 frames of video
2076 fade=in:0:30
2077
2078 # fade out last 45 frames of a 200-frame video
2079 fade=out:155:45
2080
2081 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
2082 fade=in:0:25, fade=out:975:25
2083
2084 # make first 5 frames black, then fade in from frame 5-24
2085 fade=in:5:20
2086
2087 # fade in alpha over first 25 frames of video
2088 fade=in:0:25:alpha=1
2089 @end example
2090
2091 @section fieldorder
2092
2093 Transform the field order of the input video.
2094
2095 It accepts one parameter which specifies the required field order that
2096 the input interlaced video will be transformed to. The parameter can
2097 assume one of the following values:
2098
2099 @table @option
2100 @item 0 or bff
2101 output bottom field first
2102 @item 1 or tff
2103 output top field first
2104 @end table
2105
2106 Default value is "tff".
2107
2108 Transformation is achieved by shifting the picture content up or down
2109 by one line, and filling the remaining line with appropriate picture content.
2110 This method is consistent with most broadcast field order converters.
2111
2112 If the input video is not flagged as being interlaced, or it is already
2113 flagged as being of the required output field order then this filter does
2114 not alter the incoming video.
2115
2116 This filter is very useful when converting to or from PAL DV material,
2117 which is bottom field first.
2118
2119 For example:
2120 @example
2121 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
2122 @end example
2123
2124 @section fifo
2125
2126 Buffer input images and send them when they are requested.
2127
2128 This filter is mainly useful when auto-inserted by the libavfilter
2129 framework.
2130
2131 The filter does not take parameters.
2132
2133 @section format
2134
2135 Convert the input video to one of the specified pixel formats.
2136 Libavfilter will try to pick one that is supported for the input to
2137 the next filter.
2138
2139 The filter accepts a list of pixel format names, separated by ":",
2140 for example "yuv420p:monow:rgb24".
2141
2142 Some examples follow:
2143 @example
2144 # convert the input video to the format "yuv420p"
2145 format=yuv420p
2146
2147 # convert the input video to any of the formats in the list
2148 format=yuv420p:yuv444p:yuv410p
2149 @end example
2150
2151 @section fps
2152
2153 Convert the video to specified constant framerate by duplicating or dropping
2154 frames as necessary.
2155
2156 This filter accepts the following named parameters:
2157 @table @option
2158
2159 @item fps
2160 Desired output framerate.
2161
2162 @end table
2163
2164 @section framestep
2165
2166 Select one frame every N.
2167
2168 This filter accepts in input a string representing a positive
2169 integer. Default argument is @code{1}.
2170
2171 @anchor{frei0r}
2172 @section frei0r
2173
2174 Apply a frei0r effect to the input video.
2175
2176 To enable compilation of this filter you need to install the frei0r
2177 header and configure FFmpeg with @code{--enable-frei0r}.
2178
2179 The filter supports the syntax:
2180 @example
2181 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
2182 @end example
2183
2184 @var{filter_name} is the name to the frei0r effect to load. If the
2185 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
2186 is searched in each one of the directories specified by the colon
2187 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
2188 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
2189 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
2190
2191 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
2192 for the frei0r effect.
2193
2194 A frei0r effect parameter can be a boolean (whose values are specified
2195 with "y" and "n"), a double, a color (specified by the syntax
2196 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
2197 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
2198 description), a position (specified by the syntax @var{X}/@var{Y},
2199 @var{X} and @var{Y} being float numbers) and a string.
2200
2201 The number and kind of parameters depend on the loaded effect. If an
2202 effect parameter is not specified the default value is set.
2203
2204 Some examples follow:
2205
2206 @itemize
2207 @item
2208 Apply the distort0r effect, set the first two double parameters:
2209 @example
2210 frei0r=distort0r:0.5:0.01
2211 @end example
2212
2213 @item
2214 Apply the colordistance effect, takes a color as first parameter:
2215 @example
2216 frei0r=colordistance:0.2/0.3/0.4
2217 frei0r=colordistance:violet
2218 frei0r=colordistance:0x112233
2219 @end example
2220
2221 @item
2222 Apply the perspective effect, specify the top left and top right image
2223 positions:
2224 @example
2225 frei0r=perspective:0.2/0.2:0.8/0.2
2226 @end example
2227 @end itemize
2228
2229 For more information see:
2230 @url{http://frei0r.dyne.org}
2231
2232 @section gradfun
2233
2234 Fix the banding artifacts that are sometimes introduced into nearly flat
2235 regions by truncation to 8bit color depth.
2236 Interpolate the gradients that should go where the bands are, and
2237 dither them.
2238
2239 This filter is designed for playback only.  Do not use it prior to
2240 lossy compression, because compression tends to lose the dither and
2241 bring back the bands.
2242
2243 The filter takes two optional parameters, separated by ':':
2244 @var{strength}:@var{radius}
2245
2246 @var{strength} is the maximum amount by which the filter will change
2247 any one pixel. Also the threshold for detecting nearly flat
2248 regions. Acceptable values range from .51 to 255, default value is
2249 1.2, out-of-range values will be clipped to the valid range.
2250
2251 @var{radius} is the neighborhood to fit the gradient to. A larger
2252 radius makes for smoother gradients, but also prevents the filter from
2253 modifying the pixels near detailed regions. Acceptable values are
2254 8-32, default value is 16, out-of-range values will be clipped to the
2255 valid range.
2256
2257 @example
2258 # default parameters
2259 gradfun=1.2:16
2260
2261 # omitting radius
2262 gradfun=1.2
2263 @end example
2264
2265 @section hflip
2266
2267 Flip the input video horizontally.
2268
2269 For example to horizontally flip the input video with @command{ffmpeg}:
2270 @example
2271 ffmpeg -i in.avi -vf "hflip" out.avi
2272 @end example
2273
2274 @section hqdn3d
2275
2276 High precision/quality 3d denoise filter. This filter aims to reduce
2277 image noise producing smooth images and making still images really
2278 still. It should enhance compressibility.
2279
2280 It accepts the following optional parameters:
2281 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
2282
2283 @table @option
2284 @item luma_spatial
2285 a non-negative float number which specifies spatial luma strength,
2286 defaults to 4.0
2287
2288 @item chroma_spatial
2289 a non-negative float number which specifies spatial chroma strength,
2290 defaults to 3.0*@var{luma_spatial}/4.0
2291
2292 @item luma_tmp
2293 a float number which specifies luma temporal strength, defaults to
2294 6.0*@var{luma_spatial}/4.0
2295
2296 @item chroma_tmp
2297 a float number which specifies chroma temporal strength, defaults to
2298 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
2299 @end table
2300
2301 @section hue
2302
2303 Modify the hue and/or the saturation of the input.
2304
2305 This filter accepts the following optional named options:
2306
2307 @table @option
2308 @item h
2309 Specify the hue angle as a number of degrees. It accepts a float
2310 number or an expression, and defaults to 0.0.
2311
2312 @item H
2313 Specify the hue angle as a number of degrees. It accepts a float
2314 number or an expression, and defaults to 0.0.
2315
2316 @item s
2317 Specify the saturation in the [-10,10] range. It accepts a float number and
2318 defaults to 1.0.
2319 @end table
2320
2321 The options can also be set using the syntax: @var{hue}:@var{saturation}
2322
2323 In this case @var{hue} is expressed in degrees.
2324
2325 Some examples follow:
2326 @itemize
2327 @item
2328 Set the hue to 90 degrees and the saturation to 1.0:
2329 @example
2330 hue=h=90:s=1
2331 @end example
2332
2333 @item
2334 Same command but expressing the hue in radians:
2335 @example
2336 hue=H=PI/2:s=1
2337 @end example
2338
2339 @item
2340 Same command without named options, hue must be expressed in degrees:
2341 @example
2342 hue=90:1
2343 @end example
2344
2345 @item
2346 Note that "h:s" syntax does not support expressions for the values of
2347 h and s, so the following example will issue an error:
2348 @example
2349 hue=PI/2:1
2350 @end example
2351 @end itemize
2352
2353 @subsection Commands
2354
2355 This filter supports the following command:
2356 @table @option
2357 @item reinit
2358 Modify the hue and/or the saturation of the input video.
2359 The command accepts the same named options and syntax than when calling the
2360 filter from the command-line.
2361
2362 If a parameter is omitted, it is kept at its current value.
2363 @end table
2364
2365 @section idet
2366
2367 Interlaceing detect filter. This filter tries to detect if the input is
2368 interlaced or progressive. Top or bottom field first.
2369
2370 @section lut, lutrgb, lutyuv
2371
2372 Compute a look-up table for binding each pixel component input value
2373 to an output value, and apply it to input video.
2374
2375 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
2376 to an RGB input video.
2377
2378 These filters accept in input a ":"-separated list of options, which
2379 specify the expressions used for computing the lookup table for the
2380 corresponding pixel component values.
2381
2382 The @var{lut} filter requires either YUV or RGB pixel formats in
2383 input, and accepts the options:
2384 @table @option
2385 @item c0
2386 first  pixel component
2387 @item c1
2388 second pixel component
2389 @item c2
2390 third  pixel component
2391 @item c3
2392 fourth pixel component, corresponds to the alpha component
2393 @end table
2394
2395 The exact component associated to each option depends on the format in
2396 input.
2397
2398 The @var{lutrgb} filter requires RGB pixel formats in input, and
2399 accepts the options:
2400 @table @option
2401 @item r
2402 red component
2403 @item g
2404 green component
2405 @item b
2406 blue component
2407 @item a
2408 alpha component
2409 @end table
2410
2411 The @var{lutyuv} filter requires YUV pixel formats in input, and
2412 accepts the options:
2413 @table @option
2414 @item y
2415 Y/luminance component
2416 @item u
2417 U/Cb component
2418 @item v
2419 V/Cr component
2420 @item a
2421 alpha component
2422 @end table
2423
2424 The expressions can contain the following constants and functions:
2425
2426 @table @option
2427 @item w, h
2428 the input width and height
2429
2430 @item val
2431 input value for the pixel component
2432
2433 @item clipval
2434 the input value clipped in the @var{minval}-@var{maxval} range
2435
2436 @item maxval
2437 maximum value for the pixel component
2438
2439 @item minval
2440 minimum value for the pixel component
2441
2442 @item negval
2443 the negated value for the pixel component value clipped in the
2444 @var{minval}-@var{maxval} range , it corresponds to the expression
2445 "maxval-clipval+minval"
2446
2447 @item clip(val)
2448 the computed value in @var{val} clipped in the
2449 @var{minval}-@var{maxval} range
2450
2451 @item gammaval(gamma)
2452 the computed gamma correction value of the pixel component value
2453 clipped in the @var{minval}-@var{maxval} range, corresponds to the
2454 expression
2455 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
2456
2457 @end table
2458
2459 All expressions default to "val".
2460
2461 Some examples follow:
2462 @example
2463 # negate input video
2464 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
2465 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
2466
2467 # the above is the same as
2468 lutrgb="r=negval:g=negval:b=negval"
2469 lutyuv="y=negval:u=negval:v=negval"
2470
2471 # negate luminance
2472 lutyuv=y=negval
2473
2474 # remove chroma components, turns the video into a graytone image
2475 lutyuv="u=128:v=128"
2476
2477 # apply a luma burning effect
2478 lutyuv="y=2*val"
2479
2480 # remove green and blue components
2481 lutrgb="g=0:b=0"
2482
2483 # set a constant alpha channel value on input
2484 format=rgba,lutrgb=a="maxval-minval/2"
2485
2486 # correct luminance gamma by a 0.5 factor
2487 lutyuv=y=gammaval(0.5)
2488 @end example
2489
2490 @section mp
2491
2492 Apply an MPlayer filter to the input video.
2493
2494 This filter provides a wrapper around most of the filters of
2495 MPlayer/MEncoder.
2496
2497 This wrapper is considered experimental. Some of the wrapped filters
2498 may not work properly and we may drop support for them, as they will
2499 be implemented natively into FFmpeg. Thus you should avoid
2500 depending on them when writing portable scripts.
2501
2502 The filters accepts the parameters:
2503 @var{filter_name}[:=]@var{filter_params}
2504
2505 @var{filter_name} is the name of a supported MPlayer filter,
2506 @var{filter_params} is a string containing the parameters accepted by
2507 the named filter.
2508
2509 The list of the currently supported filters follows:
2510 @table @var
2511 @item denoise3d
2512 @item detc
2513 @item dint
2514 @item divtc
2515 @item down3dright
2516 @item dsize
2517 @item eq2
2518 @item eq
2519 @item field
2520 @item fil
2521 @item fixpts
2522 @item fspp
2523 @item geq
2524 @item harddup
2525 @item hqdn3d
2526 @item il
2527 @item ilpack
2528 @item ivtc
2529 @item kerndeint
2530 @item mcdeint
2531 @item noise
2532 @item ow
2533 @item palette
2534 @item perspective
2535 @item phase
2536 @item pp7
2537 @item pullup
2538 @item qp
2539 @item rectangle
2540 @item rotate
2541 @item sab
2542 @item softpulldown
2543 @item softskip
2544 @item spp
2545 @item telecine
2546 @item tile
2547 @item tinterlace
2548 @item unsharp
2549 @item uspp
2550 @item yuvcsp
2551 @item yvu9
2552 @end table
2553
2554 The parameter syntax and behavior for the listed filters are the same
2555 of the corresponding MPlayer filters. For detailed instructions check
2556 the "VIDEO FILTERS" section in the MPlayer manual.
2557
2558 Some examples follow:
2559 @example
2560 # adjust gamma, brightness, contrast
2561 mp=eq2=1.0:2:0.5
2562
2563 # tweak hue and saturation
2564 mp=hue=100:-10
2565 @end example
2566
2567 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
2568
2569 @section negate
2570
2571 Negate input video.
2572
2573 This filter accepts an integer in input, if non-zero it negates the
2574 alpha component (if available). The default value in input is 0.
2575
2576 @section noformat
2577
2578 Force libavfilter not to use any of the specified pixel formats for the
2579 input to the next filter.
2580
2581 The filter accepts a list of pixel format names, separated by ":",
2582 for example "yuv420p:monow:rgb24".
2583
2584 Some examples follow:
2585 @example
2586 # force libavfilter to use a format different from "yuv420p" for the
2587 # input to the vflip filter
2588 noformat=yuv420p,vflip
2589
2590 # convert the input video to any of the formats not contained in the list
2591 noformat=yuv420p:yuv444p:yuv410p
2592 @end example
2593
2594 @section null
2595
2596 Pass the video source unchanged to the output.
2597
2598 @section ocv
2599
2600 Apply video transform using libopencv.
2601
2602 To enable this filter install libopencv library and headers and
2603 configure FFmpeg with @code{--enable-libopencv}.
2604
2605 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
2606
2607 @var{filter_name} is the name of the libopencv filter to apply.
2608
2609 @var{filter_params} specifies the parameters to pass to the libopencv
2610 filter. If not specified the default values are assumed.
2611
2612 Refer to the official libopencv documentation for more precise
2613 information:
2614 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
2615
2616 Follows the list of supported libopencv filters.
2617
2618 @anchor{dilate}
2619 @subsection dilate
2620
2621 Dilate an image by using a specific structuring element.
2622 This filter corresponds to the libopencv function @code{cvDilate}.
2623
2624 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
2625
2626 @var{struct_el} represents a structuring element, and has the syntax:
2627 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
2628
2629 @var{cols} and @var{rows} represent the number of columns and rows of
2630 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
2631 point, and @var{shape} the shape for the structuring element, and
2632 can be one of the values "rect", "cross", "ellipse", "custom".
2633
2634 If the value for @var{shape} is "custom", it must be followed by a
2635 string of the form "=@var{filename}". The file with name
2636 @var{filename} is assumed to represent a binary image, with each
2637 printable character corresponding to a bright pixel. When a custom
2638 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
2639 or columns and rows of the read file are assumed instead.
2640
2641 The default value for @var{struct_el} is "3x3+0x0/rect".
2642
2643 @var{nb_iterations} specifies the number of times the transform is
2644 applied to the image, and defaults to 1.
2645
2646 Follow some example:
2647 @example
2648 # use the default values
2649 ocv=dilate
2650
2651 # dilate using a structuring element with a 5x5 cross, iterate two times
2652 ocv=dilate=5x5+2x2/cross:2
2653
2654 # read the shape from the file diamond.shape, iterate two times
2655 # the file diamond.shape may contain a pattern of characters like this:
2656 #   *
2657 #  ***
2658 # *****
2659 #  ***
2660 #   *
2661 # the specified cols and rows are ignored (but not the anchor point coordinates)
2662 ocv=0x0+2x2/custom=diamond.shape:2
2663 @end example
2664
2665 @subsection erode
2666
2667 Erode an image by using a specific structuring element.
2668 This filter corresponds to the libopencv function @code{cvErode}.
2669
2670 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
2671 with the same syntax and semantics as the @ref{dilate} filter.
2672
2673 @subsection smooth
2674
2675 Smooth the input video.
2676
2677 The filter takes the following parameters:
2678 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
2679
2680 @var{type} is the type of smooth filter to apply, and can be one of
2681 the following values: "blur", "blur_no_scale", "median", "gaussian",
2682 "bilateral". The default value is "gaussian".
2683
2684 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
2685 parameters whose meanings depend on smooth type. @var{param1} and
2686 @var{param2} accept integer positive values or 0, @var{param3} and
2687 @var{param4} accept float values.
2688
2689 The default value for @var{param1} is 3, the default value for the
2690 other parameters is 0.
2691
2692 These parameters correspond to the parameters assigned to the
2693 libopencv function @code{cvSmooth}.
2694
2695 @anchor{overlay}
2696 @section overlay
2697
2698 Overlay one video on top of another.
2699
2700 It takes two inputs and one output, the first input is the "main"
2701 video on which the second input is overlayed.
2702
2703 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
2704
2705 @var{x} is the x coordinate of the overlayed video on the main video,
2706 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
2707 the following parameters:
2708
2709 @table @option
2710 @item main_w, main_h
2711 main input width and height
2712
2713 @item W, H
2714 same as @var{main_w} and @var{main_h}
2715
2716 @item overlay_w, overlay_h
2717 overlay input width and height
2718
2719 @item w, h
2720 same as @var{overlay_w} and @var{overlay_h}
2721 @end table
2722
2723 @var{options} is an optional list of @var{key}=@var{value} pairs,
2724 separated by ":".
2725
2726 The description of the accepted options follows.
2727
2728 @table @option
2729 @item rgb
2730 If set to 1, force the filter to accept inputs in the RGB
2731 color space. Default value is 0.
2732 @end table
2733
2734 Be aware that frames are taken from each input video in timestamp
2735 order, hence, if their initial timestamps differ, it is a a good idea
2736 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
2737 have them begin in the same zero timestamp, as it does the example for
2738 the @var{movie} filter.
2739
2740 Follow some examples:
2741 @example
2742 # draw the overlay at 10 pixels from the bottom right
2743 # corner of the main video.
2744 overlay=main_w-overlay_w-10:main_h-overlay_h-10
2745
2746 # insert a transparent PNG logo in the bottom left corner of the input
2747 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
2748
2749 # insert 2 different transparent PNG logos (second logo on bottom
2750 # right corner):
2751 ffmpeg -i input -i logo1 -i logo2 -filter_complex
2752 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
2753
2754 # add a transparent color layer on top of the main video,
2755 # WxH specifies the size of the main input to the overlay filter
2756 color=red@.3:WxH [over]; [in][over] overlay [out]
2757
2758 # play an original video and a filtered version (here with the deshake filter)
2759 # side by side
2760 ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
2761
2762 # the previous example is the same as:
2763 ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
2764 @end example
2765
2766 You can chain together more overlays but the efficiency of such
2767 approach is yet to be tested.
2768
2769 @section pad
2770
2771 Add paddings to the input image, and places the original input at the
2772 given coordinates @var{x}, @var{y}.
2773
2774 It accepts the following parameters:
2775 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
2776
2777 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
2778 expressions containing the following constants:
2779
2780 @table @option
2781 @item in_w, in_h
2782 the input video width and height
2783
2784 @item iw, ih
2785 same as @var{in_w} and @var{in_h}
2786
2787 @item out_w, out_h
2788 the output width and height, that is the size of the padded area as
2789 specified by the @var{width} and @var{height} expressions
2790
2791 @item ow, oh
2792 same as @var{out_w} and @var{out_h}
2793
2794 @item x, y
2795 x and y offsets as specified by the @var{x} and @var{y}
2796 expressions, or NAN if not yet specified
2797
2798 @item a
2799 same as @var{iw} / @var{ih}
2800
2801 @item sar
2802 input sample aspect ratio
2803
2804 @item dar
2805 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2806
2807 @item hsub, vsub
2808 horizontal and vertical chroma subsample values. For example for the
2809 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2810 @end table
2811
2812 Follows the description of the accepted parameters.
2813
2814 @table @option
2815 @item width, height
2816
2817 Specify the size of the output image with the paddings added. If the
2818 value for @var{width} or @var{height} is 0, the corresponding input size
2819 is used for the output.
2820
2821 The @var{width} expression can reference the value set by the
2822 @var{height} expression, and vice versa.
2823
2824 The default value of @var{width} and @var{height} is 0.
2825
2826 @item x, y
2827
2828 Specify the offsets where to place the input image in the padded area
2829 with respect to the top/left border of the output image.
2830
2831 The @var{x} expression can reference the value set by the @var{y}
2832 expression, and vice versa.
2833
2834 The default value of @var{x} and @var{y} is 0.
2835
2836 @item color
2837
2838 Specify the color of the padded area, it can be the name of a color
2839 (case insensitive match) or a 0xRRGGBB[AA] sequence.
2840
2841 The default value of @var{color} is "black".
2842
2843 @end table
2844
2845 @section Examples
2846
2847 @itemize
2848 @item
2849 Add paddings with color "violet" to the input video. Output video
2850 size is 640x480, the top-left corner of the input video is placed at
2851 column 0, row 40:
2852 @example
2853 pad=640:480:0:40:violet
2854 @end example
2855
2856 @item
2857 Pad the input to get an output with dimensions increased by 3/2,
2858 and put the input video at the center of the padded area:
2859 @example
2860 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
2861 @end example
2862
2863 @item
2864 Pad the input to get a squared output with size equal to the maximum
2865 value between the input width and height, and put the input video at
2866 the center of the padded area:
2867 @example
2868 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
2869 @end example
2870
2871 @item
2872 Pad the input to get a final w/h ratio of 16:9:
2873 @example
2874 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
2875 @end example
2876
2877 @item
2878 In case of anamorphic video, in order to set the output display aspect
2879 correctly, it is necessary to use @var{sar} in the expression,
2880 according to the relation:
2881 @example
2882 (ih * X / ih) * sar = output_dar
2883 X = output_dar / sar
2884 @end example
2885
2886 Thus the previous example needs to be modified to:
2887 @example
2888 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
2889 @end example
2890
2891 @item
2892 Double output size and put the input video in the bottom-right
2893 corner of the output padded area:
2894 @example
2895 pad="2*iw:2*ih:ow-iw:oh-ih"
2896 @end example
2897 @end itemize
2898
2899 @section pixdesctest
2900
2901 Pixel format descriptor test filter, mainly useful for internal
2902 testing. The output video should be equal to the input video.
2903
2904 For example:
2905 @example
2906 format=monow, pixdesctest
2907 @end example
2908
2909 can be used to test the monowhite pixel format descriptor definition.
2910
2911 @section removelogo
2912
2913 Suppress a TV station logo, using an image file to determine which
2914 pixels comprise the logo. It works by filling in the pixels that
2915 comprise the logo with neighboring pixels.
2916
2917 This filter requires one argument which specifies the filter bitmap
2918 file, which can be any image format supported by libavformat. The
2919 width and height of the image file must match those of the video
2920 stream being processed.
2921
2922 Pixels in the provided bitmap image with a value of zero are not
2923 considered part of the logo, non-zero pixels are considered part of
2924 the logo. If you use white (255) for the logo and black (0) for the
2925 rest, you will be safe. For making the filter bitmap, it is
2926 recommended to take a screen capture of a black frame with the logo
2927 visible, and then using a threshold filter followed by the erode
2928 filter once or twice.
2929
2930 If needed, little splotches can be fixed manually. Remember that if
2931 logo pixels are not covered, the filter quality will be much
2932 reduced. Marking too many pixels as part of the logo does not hurt as
2933 much, but it will increase the amount of blurring needed to cover over
2934 the image and will destroy more information than necessary, and extra
2935 pixels will slow things down on a large logo.
2936
2937 @section scale
2938
2939 Scale the input video to @var{width}:@var{height}[:@var{interl}=@{1|-1@}] and/or convert the image format.
2940
2941 The scale filter forces the output display aspect ratio to be the same
2942 of the input, by changing the output sample aspect ratio.
2943
2944 The parameters @var{width} and @var{height} are expressions containing
2945 the following constants:
2946
2947 @table @option
2948 @item in_w, in_h
2949 the input width and height
2950
2951 @item iw, ih
2952 same as @var{in_w} and @var{in_h}
2953
2954 @item out_w, out_h
2955 the output (cropped) width and height
2956
2957 @item ow, oh
2958 same as @var{out_w} and @var{out_h}
2959
2960 @item a
2961 same as @var{iw} / @var{ih}
2962
2963 @item sar
2964 input sample aspect ratio
2965
2966 @item dar
2967 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2968
2969 @item hsub, vsub
2970 horizontal and vertical chroma subsample values. For example for the
2971 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2972 @end table
2973
2974 If the input image format is different from the format requested by
2975 the next filter, the scale filter will convert the input to the
2976 requested format.
2977
2978 If the value for @var{width} or @var{height} is 0, the respective input
2979 size is used for the output.
2980
2981 If the value for @var{width} or @var{height} is -1, the scale filter will
2982 use, for the respective output size, a value that maintains the aspect
2983 ratio of the input image.
2984
2985 The default value of @var{width} and @var{height} is 0.
2986
2987 Valid values for the optional parameter @var{interl} are:
2988
2989 @table @option
2990 @item 1
2991 force interlaced aware scaling
2992
2993 @item -1
2994 select interlaced aware scaling depending on whether the source frames
2995 are flagged as interlaced or not
2996 @end table
2997
2998 Unless @var{interl} is set to one of the above options, interlaced scaling will not be used.
2999
3000 Some examples follow:
3001 @example
3002 # scale the input video to a size of 200x100.
3003 scale=200:100
3004
3005 # scale the input to 2x
3006 scale=2*iw:2*ih
3007 # the above is the same as
3008 scale=2*in_w:2*in_h
3009
3010 # scale the input to 2x with forced interlaced scaling
3011 scale=2*iw:2*ih:interl=1
3012
3013 # scale the input to half size
3014 scale=iw/2:ih/2
3015
3016 # increase the width, and set the height to the same size
3017 scale=3/2*iw:ow
3018
3019 # seek for Greek harmony
3020 scale=iw:1/PHI*iw
3021 scale=ih*PHI:ih
3022
3023 # increase the height, and set the width to 3/2 of the height
3024 scale=3/2*oh:3/5*ih
3025
3026 # increase the size, but make the size a multiple of the chroma
3027 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
3028
3029 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
3030 scale='min(500\, iw*3/2):-1'
3031 @end example
3032
3033 @section select
3034 Select frames to pass in output.
3035
3036 It accepts in input an expression, which is evaluated for each input
3037 frame. If the expression is evaluated to a non-zero value, the frame
3038 is selected and passed to the output, otherwise it is discarded.
3039
3040 The expression can contain the following constants:
3041
3042 @table @option
3043 @item n
3044 the sequential number of the filtered frame, starting from 0
3045
3046 @item selected_n
3047 the sequential number of the selected frame, starting from 0
3048
3049 @item prev_selected_n
3050 the sequential number of the last selected frame, NAN if undefined
3051
3052 @item TB
3053 timebase of the input timestamps
3054
3055 @item pts
3056 the PTS (Presentation TimeStamp) of the filtered video frame,
3057 expressed in @var{TB} units, NAN if undefined
3058
3059 @item t
3060 the PTS (Presentation TimeStamp) of the filtered video frame,
3061 expressed in seconds, NAN if undefined
3062
3063 @item prev_pts
3064 the PTS of the previously filtered video frame, NAN if undefined
3065
3066 @item prev_selected_pts
3067 the PTS of the last previously filtered video frame, NAN if undefined
3068
3069 @item prev_selected_t
3070 the PTS of the last previously selected video frame, NAN if undefined
3071
3072 @item start_pts
3073 the PTS of the first video frame in the video, NAN if undefined
3074
3075 @item start_t
3076 the time of the first video frame in the video, NAN if undefined
3077
3078 @item pict_type
3079 the type of the filtered frame, can assume one of the following
3080 values:
3081 @table @option
3082 @item I
3083 @item P
3084 @item B
3085 @item S
3086 @item SI
3087 @item SP
3088 @item BI
3089 @end table
3090
3091 @item interlace_type
3092 the frame interlace type, can assume one of the following values:
3093 @table @option
3094 @item PROGRESSIVE
3095 the frame is progressive (not interlaced)
3096 @item TOPFIRST
3097 the frame is top-field-first
3098 @item BOTTOMFIRST
3099 the frame is bottom-field-first
3100 @end table
3101
3102 @item key
3103 1 if the filtered frame is a key-frame, 0 otherwise
3104
3105 @item pos
3106 the position in the file of the filtered frame, -1 if the information
3107 is not available (e.g. for synthetic video)
3108
3109 @item scene
3110 value between 0 and 1 to indicate a new scene; a low value reflects a low
3111 probability for the current frame to introduce a new scene, while a higher
3112 value means the current frame is more likely to be one (see the example below)
3113
3114 @end table
3115
3116 The default value of the select expression is "1".
3117
3118 Some examples follow:
3119
3120 @example
3121 # select all frames in input
3122 select
3123
3124 # the above is the same as:
3125 select=1
3126
3127 # skip all frames:
3128 select=0
3129
3130 # select only I-frames
3131 select='eq(pict_type\,I)'
3132
3133 # select one frame every 100
3134 select='not(mod(n\,100))'
3135
3136 # select only frames contained in the 10-20 time interval
3137 select='gte(t\,10)*lte(t\,20)'
3138
3139 # select only I frames contained in the 10-20 time interval
3140 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
3141
3142 # select frames with a minimum distance of 10 seconds
3143 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
3144 @end example
3145
3146 Complete example to create a mosaic of the first scenes:
3147
3148 @example
3149 ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
3150 @end example
3151
3152 Comparing @var{scene} against a value between 0.3 and 0.5 is generally a sane
3153 choice.
3154
3155 @section setdar, setsar
3156
3157 The @code{setdar} filter sets the Display Aspect Ratio for the filter
3158 output video.
3159
3160 This is done by changing the specified Sample (aka Pixel) Aspect
3161 Ratio, according to the following equation:
3162 @example
3163 @var{DAR} = @var{HORIZONTAL_RESOLUTION} / @var{VERTICAL_RESOLUTION} * @var{SAR}
3164 @end example
3165
3166 Keep in mind that the @code{setdar} filter does not modify the pixel
3167 dimensions of the video frame. Also the display aspect ratio set by
3168 this filter may be changed by later filters in the filterchain,
3169 e.g. in case of scaling or if another "setdar" or a "setsar" filter is
3170 applied.
3171
3172 The @code{setsar} filter sets the Sample (aka Pixel) Aspect Ratio for
3173 the filter output video.
3174
3175 Note that as a consequence of the application of this filter, the
3176 output display aspect ratio will change according to the equation
3177 above.
3178
3179 Keep in mind that the sample aspect ratio set by the @code{setsar}
3180 filter may be changed by later filters in the filterchain, e.g. if
3181 another "setsar" or a "setdar" filter is applied.
3182
3183 The @code{setdar} and @code{setsar} filters accept a parameter string
3184 which represents the wanted aspect ratio.  The parameter can
3185 be a floating point number string, an expression, or a string of the form
3186 @var{num}:@var{den}, where @var{num} and @var{den} are the numerator
3187 and denominator of the aspect ratio. If the parameter is not
3188 specified, it is assumed the value "0:1".
3189
3190 For example to change the display aspect ratio to 16:9, specify:
3191 @example
3192 setdar=16:9
3193 @end example
3194
3195 The example above is equivalent to:
3196 @example
3197 setdar=1.77777
3198 @end example
3199
3200 To change the sample aspect ratio to 10:11, specify:
3201 @example
3202 setsar=10:11
3203 @end example
3204
3205 @section setfield
3206
3207 Force field for the output video frame.
3208
3209 The @code{setfield} filter marks the interlace type field for the
3210 output frames. It does not change the input frame, but only sets the
3211 corresponding property, which affects how the frame is treated by
3212 following filters (e.g. @code{fieldorder} or @code{yadif}).
3213
3214 It accepts a string parameter, which can assume the following values:
3215 @table @samp
3216 @item auto
3217 Keep the same field property.
3218
3219 @item bff
3220 Mark the frame as bottom-field-first.
3221
3222 @item tff
3223 Mark the frame as top-field-first.
3224
3225 @item prog
3226 Mark the frame as progressive.
3227 @end table
3228
3229 @section showinfo
3230
3231 Show a line containing various information for each input video frame.
3232 The input video is not modified.
3233
3234 The shown line contains a sequence of key/value pairs of the form
3235 @var{key}:@var{value}.
3236
3237 A description of each shown parameter follows:
3238
3239 @table @option
3240 @item n
3241 sequential number of the input frame, starting from 0
3242
3243 @item pts
3244 Presentation TimeStamp of the input frame, expressed as a number of
3245 time base units. The time base unit depends on the filter input pad.
3246
3247 @item pts_time
3248 Presentation TimeStamp of the input frame, expressed as a number of
3249 seconds
3250
3251 @item pos
3252 position of the frame in the input stream, -1 if this information in
3253 unavailable and/or meaningless (for example in case of synthetic video)
3254
3255 @item fmt
3256 pixel format name
3257
3258 @item sar
3259 sample aspect ratio of the input frame, expressed in the form
3260 @var{num}/@var{den}
3261
3262 @item s
3263 size of the input frame, expressed in the form
3264 @var{width}x@var{height}
3265
3266 @item i
3267 interlaced mode ("P" for "progressive", "T" for top field first, "B"
3268 for bottom field first)
3269
3270 @item iskey
3271 1 if the frame is a key frame, 0 otherwise
3272
3273 @item type
3274 picture type of the input frame ("I" for an I-frame, "P" for a
3275 P-frame, "B" for a B-frame, "?" for unknown type).
3276 Check also the documentation of the @code{AVPictureType} enum and of
3277 the @code{av_get_picture_type_char} function defined in
3278 @file{libavutil/avutil.h}.
3279
3280 @item checksum
3281 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
3282
3283 @item plane_checksum
3284 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
3285 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
3286 @end table
3287
3288 @section slicify
3289
3290 Pass the images of input video on to next video filter as multiple
3291 slices.
3292
3293 @example
3294 ffmpeg -i in.avi -vf "slicify=32" out.avi
3295 @end example
3296
3297 The filter accepts the slice height as parameter. If the parameter is
3298 not specified it will use the default value of 16.
3299
3300 Adding this in the beginning of filter chains should make filtering
3301 faster due to better use of the memory cache.
3302
3303 @section smartblur
3304
3305 Blur the input video without impacting the outlines.
3306
3307 The filter accepts the following parameters:
3308 @var{luma_radius}:@var{luma_strength}:@var{luma_threshold}[:@var{chroma_radius}:@var{chroma_strength}:@var{chroma_threshold}]
3309
3310 Parameters prefixed by @var{luma} indicate that they work on the
3311 luminance of the pixels whereas parameters prefixed by @var{chroma}
3312 refer to the chrominance of the pixels.
3313
3314 If the chroma parameters are not set, the luma parameters are used for
3315 either the luminance and the chrominance of the pixels.
3316
3317 @var{luma_radius} or @var{chroma_radius} must be a float number in the
3318 range [0.1,5.0] that specifies the variance of the gaussian filter
3319 used to blur the image (slower if larger).
3320
3321 @var{luma_strength} or @var{chroma_strength} must be a float number in
3322 the range [-1.0,1.0] that configures the blurring. A value included in
3323 [0.0,1.0] will blur the image whereas a value included in [-1.0,0.0]
3324 will sharpen the image.
3325
3326 @var{luma_threshold} or @var{chroma_threshold} must be an integer in
3327 the range [-30,30] that is used as a coefficient to determine whether
3328 a pixel should be blurred or not. A value of 0 will filter all the
3329 image, a value included in [0,30] will filter flat areas and a value
3330 included in [-30,0] will filter edges.
3331
3332 @section split
3333
3334 Split input video into several identical outputs.
3335
3336 The filter accepts a single parameter which specifies the number of outputs. If
3337 unspecified, it defaults to 2.
3338
3339 For example
3340 @example
3341 ffmpeg -i INPUT -filter_complex split=5 OUTPUT
3342 @end example
3343 will create 5 copies of the input video.
3344
3345 For example:
3346 @example
3347 [in] split [splitout1][splitout2];
3348 [splitout1] crop=100:100:0:0    [cropout];
3349 [splitout2] pad=200:200:100:100 [padout];
3350 @end example
3351
3352 will create two separate outputs from the same input, one cropped and
3353 one padded.
3354
3355 @section super2xsai
3356
3357 Scale the input by 2x and smooth using the Super2xSaI (Scale and
3358 Interpolate) pixel art scaling algorithm.
3359
3360 Useful for enlarging pixel art images without reducing sharpness.
3361
3362 @section swapuv
3363 Swap U & V plane.
3364
3365 @section thumbnail
3366 Select the most representative frame in a given sequence of consecutive frames.
3367
3368 It accepts as argument the frames batch size to analyze (default @var{N}=100);
3369 in a set of @var{N} frames, the filter will pick one of them, and then handle
3370 the next batch of @var{N} frames until the end.
3371
3372 Since the filter keeps track of the whole frames sequence, a bigger @var{N}
3373 value will result in a higher memory usage, so a high value is not recommended.
3374
3375 The following example extract one picture each 50 frames:
3376 @example
3377 thumbnail=50
3378 @end example
3379
3380 Complete example of a thumbnail creation with @command{ffmpeg}:
3381 @example
3382 ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
3383 @end example
3384
3385 @section tile
3386
3387 Tile several successive frames together.
3388
3389 It accepts as argument the tile size (i.e. the number of lines and columns)
3390 in the form "@var{w}x@var{h}".
3391
3392 For example, produce 8×8 PNG tiles of all keyframes (@option{-skip_frame
3393 nokey}) in a movie:
3394 @example
3395 ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
3396 @end example
3397 The @option{-vsync 0} is necessary to prevent @command{ffmpeg} from
3398 duplicating each output frame to accomodate the originally detected frame
3399 rate.
3400
3401 @section tinterlace
3402
3403 Perform various types of temporal field interlacing.
3404
3405 Frames are counted starting from 1, so the first input frame is
3406 considered odd.
3407
3408 This filter accepts a single parameter specifying the mode. Available
3409 modes are:
3410
3411 @table @samp
3412 @item merge, 0
3413 Move odd frames into the upper field, even into the lower field,
3414 generating a double height frame at half framerate.
3415
3416 @item drop_odd, 1
3417 Only output even frames, odd frames are dropped, generating a frame with
3418 unchanged height at half framerate.
3419
3420 @item drop_even, 2
3421 Only output odd frames, even frames are dropped, generating a frame with
3422 unchanged height at half framerate.
3423
3424 @item pad, 3
3425 Expand each frame to full height, but pad alternate lines with black,
3426 generating a frame with double height at the same input framerate.
3427
3428 @item interleave_top, 4
3429 Interleave the upper field from odd frames with the lower field from
3430 even frames, generating a frame with unchanged height at half framerate.
3431
3432 @item interleave_bottom, 5
3433 Interleave the lower field from odd frames with the upper field from
3434 even frames, generating a frame with unchanged height at half framerate.
3435
3436 @item interlacex2, 6
3437 Double frame rate with unchanged height. Frames are inserted each
3438 containing the second temporal field from the previous input frame and
3439 the first temporal field from the next input frame. This mode relies on
3440 the top_field_first flag. Useful for interlaced video displays with no
3441 field synchronisation.
3442 @end table
3443
3444 Numeric values are deprecated but are accepted for backward
3445 compatibility reasons.
3446
3447 Default mode is @code{merge}.
3448
3449 @section transpose
3450
3451 Transpose rows with columns in the input video and optionally flip it.
3452
3453 It accepts a parameter representing an integer, which can assume the
3454 values:
3455
3456 @table @samp
3457 @item 0
3458 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
3459 @example
3460 L.R     L.l
3461 . . ->  . .
3462 l.r     R.r
3463 @end example
3464
3465 @item 1
3466 Rotate by 90 degrees clockwise, that is:
3467 @example
3468 L.R     l.L
3469 . . ->  . .
3470 l.r     r.R
3471 @end example
3472
3473 @item 2
3474 Rotate by 90 degrees counterclockwise, that is:
3475 @example
3476 L.R     R.r
3477 . . ->  . .
3478 l.r     L.l
3479 @end example
3480
3481 @item 3
3482 Rotate by 90 degrees clockwise and vertically flip, that is:
3483 @example
3484 L.R     r.R
3485 . . ->  . .
3486 l.r     l.L
3487 @end example
3488 @end table
3489
3490 @section unsharp
3491
3492 Sharpen or blur the input video.
3493
3494 It accepts the following parameters:
3495 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
3496
3497 Negative values for the amount will blur the input video, while positive
3498 values will sharpen. All parameters are optional and default to the
3499 equivalent of the string '5:5:1.0:5:5:0.0'.
3500
3501 @table @option
3502
3503 @item luma_msize_x
3504 Set the luma matrix horizontal size. It can be an integer between 3
3505 and 13, default value is 5.
3506
3507 @item luma_msize_y
3508 Set the luma matrix vertical size. It can be an integer between 3
3509 and 13, default value is 5.
3510
3511 @item luma_amount
3512 Set the luma effect strength. It can be a float number between -2.0
3513 and 5.0, default value is 1.0.
3514
3515 @item chroma_msize_x
3516 Set the chroma matrix horizontal size. It can be an integer between 3
3517 and 13, default value is 5.
3518
3519 @item chroma_msize_y
3520 Set the chroma matrix vertical size. It can be an integer between 3
3521 and 13, default value is 5.
3522
3523 @item chroma_amount
3524 Set the chroma effect strength. It can be a float number between -2.0
3525 and 5.0, default value is 0.0.
3526
3527 @end table
3528
3529 @example
3530 # Strong luma sharpen effect parameters
3531 unsharp=7:7:2.5
3532
3533 # Strong blur of both luma and chroma parameters
3534 unsharp=7:7:-2:7:7:-2
3535
3536 # Use the default values with @command{ffmpeg}
3537 ffmpeg -i in.avi -vf "unsharp" out.mp4
3538 @end example
3539
3540 @section vflip
3541
3542 Flip the input video vertically.
3543
3544 @example
3545 ffmpeg -i in.avi -vf "vflip" out.avi
3546 @end example
3547
3548 @section yadif
3549
3550 Deinterlace the input video ("yadif" means "yet another deinterlacing
3551 filter").
3552
3553 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
3554
3555 @var{mode} specifies the interlacing mode to adopt, accepts one of the
3556 following values:
3557
3558 @table @option
3559 @item 0
3560 output 1 frame for each frame
3561 @item 1
3562 output 1 frame for each field
3563 @item 2
3564 like 0 but skips spatial interlacing check
3565 @item 3
3566 like 1 but skips spatial interlacing check
3567 @end table
3568
3569 Default value is 0.
3570
3571 @var{parity} specifies the picture field parity assumed for the input
3572 interlaced video, accepts one of the following values:
3573
3574 @table @option
3575 @item 0
3576 assume top field first
3577 @item 1
3578 assume bottom field first
3579 @item -1
3580 enable automatic detection
3581 @end table
3582
3583 Default value is -1.
3584 If interlacing is unknown or decoder does not export this information,
3585 top field first will be assumed.
3586
3587 @var{auto} specifies if deinterlacer should trust the interlaced flag
3588 and only deinterlace frames marked as interlaced
3589
3590 @table @option
3591 @item 0
3592 deinterlace all frames
3593 @item 1
3594 only deinterlace frames marked as interlaced
3595 @end table
3596
3597 Default value is 0.
3598
3599 @c man end VIDEO FILTERS
3600
3601 @chapter Video Sources
3602 @c man begin VIDEO SOURCES
3603
3604 Below is a description of the currently available video sources.
3605
3606 @section buffer
3607
3608 Buffer video frames, and make them available to the filter chain.
3609
3610 This source is mainly intended for a programmatic use, in particular
3611 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
3612
3613 It accepts a list of options in the form of @var{key}=@var{value} pairs
3614 separated by ":". A descroption of the accepted options follows.
3615
3616 @table @option
3617
3618 @item video_size
3619 Specify the size (width and height) of the buffered video frames.
3620
3621 @item pix_fmt
3622 A string representing the pixel format of the buffered video frames.
3623 It may be a number corresponding to a pixel format, or a pixel format
3624 name.
3625
3626 @item time_base
3627 Specify the timebase assumed by the timestamps of the buffered frames.
3628
3629 @item time_base
3630 Specify the frame rate expected for the video stream.
3631
3632 @item pixel_aspect
3633 Specify the sample aspect ratio assumed by the video frames.
3634
3635 @item sws_param
3636 Specify the optional parameters to be used for the scale filter which
3637 is automatically inserted when an input change is detected in the
3638 input size or format.
3639 @end table
3640
3641 For example:
3642 @example
3643 buffer=size=320x240:pix_fmt=yuv410p:time_base=1/24:pixel_aspect=1/1
3644 @end example
3645
3646 will instruct the source to accept video frames with size 320x240 and
3647 with format "yuv410p", assuming 1/24 as the timestamps timebase and
3648 square pixels (1:1 sample aspect ratio).
3649 Since the pixel format with name "yuv410p" corresponds to the number 6
3650 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
3651 this example corresponds to:
3652 @example
3653 buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
3654 @end example
3655
3656 Alternatively, the options can be specified as a flat string, but this
3657 syntax is deprecated:
3658
3659 @var{width}:@var{height}:@var{pix_fmt}:@var{time_base.num}:@var{time_base.den}:@var{pixel_aspect.num}:@var{pixel_aspect.den}[:@var{sws_param}]
3660
3661 @section cellauto
3662
3663 Create a pattern generated by an elementary cellular automaton.
3664
3665 The initial state of the cellular automaton can be defined through the
3666 @option{filename}, and @option{pattern} options. If such options are
3667 not specified an initial state is created randomly.
3668
3669 At each new frame a new row in the video is filled with the result of
3670 the cellular automaton next generation. The behavior when the whole
3671 frame is filled is defined by the @option{scroll} option.
3672
3673 This source accepts a list of options in the form of
3674 @var{key}=@var{value} pairs separated by ":". A description of the
3675 accepted options follows.
3676
3677 @table @option
3678 @item filename, f
3679 Read the initial cellular automaton state, i.e. the starting row, from
3680 the specified file.
3681 In the file, each non-whitespace character is considered an alive
3682 cell, a newline will terminate the row, and further characters in the
3683 file will be ignored.
3684
3685 @item pattern, p
3686 Read the initial cellular automaton state, i.e. the starting row, from
3687 the specified string.
3688
3689 Each non-whitespace character in the string is considered an alive
3690 cell, a newline will terminate the row, and further characters in the
3691 string will be ignored.
3692
3693 @item rate, r
3694 Set the video rate, that is the number of frames generated per second.
3695 Default is 25.
3696
3697 @item random_fill_ratio, ratio
3698 Set the random fill ratio for the initial cellular automaton row. It
3699 is a floating point number value ranging from 0 to 1, defaults to
3700 1/PHI.
3701
3702 This option is ignored when a file or a pattern is specified.
3703
3704 @item random_seed, seed
3705 Set the seed for filling randomly the initial row, must be an integer
3706 included between 0 and UINT32_MAX. If not specified, or if explicitly
3707 set to -1, the filter will try to use a good random seed on a best
3708 effort basis.
3709
3710 @item rule
3711 Set the cellular automaton rule, it is a number ranging from 0 to 255.
3712 Default value is 110.
3713
3714 @item size, s
3715 Set the size of the output video.
3716
3717 If @option{filename} or @option{pattern} is specified, the size is set
3718 by default to the width of the specified initial state row, and the
3719 height is set to @var{width} * PHI.
3720
3721 If @option{size} is set, it must contain the width of the specified
3722 pattern string, and the specified pattern will be centered in the
3723 larger row.
3724
3725 If a filename or a pattern string is not specified, the size value
3726 defaults to "320x518" (used for a randomly generated initial state).
3727
3728 @item scroll
3729 If set to 1, scroll the output upward when all the rows in the output
3730 have been already filled. If set to 0, the new generated row will be
3731 written over the top row just after the bottom row is filled.
3732 Defaults to 1.
3733
3734 @item start_full, full
3735 If set to 1, completely fill the output with generated rows before
3736 outputting the first frame.
3737 This is the default behavior, for disabling set the value to 0.
3738
3739 @item stitch
3740 If set to 1, stitch the left and right row edges together.
3741 This is the default behavior, for disabling set the value to 0.
3742 @end table
3743
3744 @subsection Examples
3745
3746 @itemize
3747 @item
3748 Read the initial state from @file{pattern}, and specify an output of
3749 size 200x400.
3750 @example
3751 cellauto=f=pattern:s=200x400
3752 @end example
3753
3754 @item
3755 Generate a random initial row with a width of 200 cells, with a fill
3756 ratio of 2/3:
3757 @example
3758 cellauto=ratio=2/3:s=200x200
3759 @end example
3760
3761 @item
3762 Create a pattern generated by rule 18 starting by a single alive cell
3763 centered on an initial row with width 100:
3764 @example
3765 cellauto=p=@@:s=100x400:full=0:rule=18
3766 @end example
3767
3768 @item
3769 Specify a more elaborated initial pattern:
3770 @example
3771 cellauto=p='@@@@ @@ @@@@':s=100x400:full=0:rule=18
3772 @end example
3773
3774 @end itemize
3775
3776 @section mandelbrot
3777
3778 Generate a Mandelbrot set fractal, and progressively zoom towards the
3779 point specified with @var{start_x} and @var{start_y}.
3780
3781 This source accepts a list of options in the form of
3782 @var{key}=@var{value} pairs separated by ":". A description of the
3783 accepted options follows.
3784
3785 @table @option
3786
3787 @item end_pts
3788 Set the terminal pts value. Default value is 400.
3789
3790 @item end_scale
3791 Set the terminal scale value.
3792 Must be a floating point value. Default value is 0.3.
3793
3794 @item inner
3795 Set the inner coloring mode, that is the algorithm used to draw the
3796 Mandelbrot fractal internal region.
3797
3798 It shall assume one of the following values:
3799 @table @option
3800 @item black
3801 Set black mode.
3802 @item convergence
3803 Show time until convergence.
3804 @item mincol
3805 Set color based on point closest to the origin of the iterations.
3806 @item period
3807 Set period mode.
3808 @end table
3809
3810 Default value is @var{mincol}.
3811
3812 @item bailout
3813 Set the bailout value. Default value is 10.0.
3814
3815 @item maxiter
3816 Set the maximum of iterations performed by the rendering
3817 algorithm. Default value is 7189.
3818
3819 @item outer
3820 Set outer coloring mode.
3821 It shall assume one of following values:
3822 @table @option
3823 @item iteration_count
3824 Set iteration cound mode.
3825 @item normalized_iteration_count
3826 set normalized iteration count mode.
3827 @end table
3828 Default value is @var{normalized_iteration_count}.
3829
3830 @item rate, r
3831 Set frame rate, expressed as number of frames per second. Default
3832 value is "25".
3833
3834 @item size, s
3835 Set frame size. Default value is "640x480".
3836
3837 @item start_scale
3838 Set the initial scale value. Default value is 3.0.
3839
3840 @item start_x
3841 Set the initial x position. Must be a floating point value between
3842 -100 and 100. Default value is -0.743643887037158704752191506114774.
3843
3844 @item start_y
3845 Set the initial y position. Must be a floating point value between
3846 -100 and 100. Default value is -0.131825904205311970493132056385139.
3847 @end table
3848
3849 @section mptestsrc
3850
3851 Generate various test patterns, as generated by the MPlayer test filter.
3852
3853 The size of the generated video is fixed, and is 256x256.
3854 This source is useful in particular for testing encoding features.
3855
3856 This source accepts an optional sequence of @var{key}=@var{value} pairs,
3857 separated by ":". The description of the accepted options follows.
3858
3859 @table @option
3860
3861 @item rate, r
3862 Specify the frame rate of the sourced video, as the number of frames
3863 generated per second. It has to be a string in the format
3864 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
3865 number or a valid video frame rate abbreviation. The default value is
3866 "25".
3867
3868 @item duration, d
3869 Set the video duration of the sourced video. The accepted syntax is:
3870 @example
3871 [-]HH:MM:SS[.m...]
3872 [-]S+[.m...]
3873 @end example
3874 See also the function @code{av_parse_time()}.
3875
3876 If not specified, or the expressed duration is negative, the video is
3877 supposed to be generated forever.
3878
3879 @item test, t
3880
3881 Set the number or the name of the test to perform. Supported tests are:
3882 @table @option
3883 @item dc_luma
3884 @item dc_chroma
3885 @item freq_luma
3886 @item freq_chroma
3887 @item amp_luma
3888 @item amp_chroma
3889 @item cbp
3890 @item mv
3891 @item ring1
3892 @item ring2
3893 @item all
3894 @end table
3895
3896 Default value is "all", which will cycle through the list of all tests.
3897 @end table
3898
3899 For example the following:
3900 @example
3901 testsrc=t=dc_luma
3902 @end example
3903
3904 will generate a "dc_luma" test pattern.
3905
3906 @section frei0r_src
3907
3908 Provide a frei0r source.
3909
3910 To enable compilation of this filter you need to install the frei0r
3911 header and configure FFmpeg with @code{--enable-frei0r}.
3912
3913 The source supports the syntax:
3914 @example
3915 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
3916 @end example
3917
3918 @var{size} is the size of the video to generate, may be a string of the
3919 form @var{width}x@var{height} or a frame size abbreviation.
3920 @var{rate} is the rate of the video to generate, may be a string of
3921 the form @var{num}/@var{den} or a frame rate abbreviation.
3922 @var{src_name} is the name to the frei0r source to load. For more
3923 information regarding frei0r and how to set the parameters read the
3924 section @ref{frei0r} in the description of the video filters.
3925
3926 For example, to generate a frei0r partik0l source with size 200x200
3927 and frame rate 10 which is overlayed on the overlay filter main input:
3928 @example
3929 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
3930 @end example
3931
3932 @section life
3933
3934 Generate a life pattern.
3935
3936 This source is based on a generalization of John Conway's life game.
3937
3938 The sourced input represents a life grid, each pixel represents a cell
3939 which can be in one of two possible states, alive or dead. Every cell
3940 interacts with its eight neighbours, which are the cells that are
3941 horizontally, vertically, or diagonally adjacent.
3942
3943 At each interaction the grid evolves according to the adopted rule,
3944 which specifies the number of neighbor alive cells which will make a
3945 cell stay alive or born. The @option{rule} option allows to specify
3946 the rule to adopt.
3947
3948 This source accepts a list of options in the form of
3949 @var{key}=@var{value} pairs separated by ":". A description of the
3950 accepted options follows.
3951
3952 @table @option
3953 @item filename, f
3954 Set the file from which to read the initial grid state. In the file,
3955 each non-whitespace character is considered an alive cell, and newline
3956 is used to delimit the end of each row.
3957
3958 If this option is not specified, the initial grid is generated
3959 randomly.
3960
3961 @item rate, r
3962 Set the video rate, that is the number of frames generated per second.
3963 Default is 25.
3964
3965 @item random_fill_ratio, ratio
3966 Set the random fill ratio for the initial random grid. It is a
3967 floating point number value ranging from 0 to 1, defaults to 1/PHI.
3968 It is ignored when a file is specified.
3969
3970 @item random_seed, seed
3971 Set the seed for filling the initial random grid, must be an integer
3972 included between 0 and UINT32_MAX. If not specified, or if explicitly
3973 set to -1, the filter will try to use a good random seed on a best
3974 effort basis.
3975
3976 @item rule
3977 Set the life rule.
3978
3979 A rule can be specified with a code of the kind "S@var{NS}/B@var{NB}",
3980 where @var{NS} and @var{NB} are sequences of numbers in the range 0-8,
3981 @var{NS} specifies the number of alive neighbor cells which make a
3982 live cell stay alive, and @var{NB} the number of alive neighbor cells
3983 which make a dead cell to become alive (i.e. to "born").
3984 "s" and "b" can be used in place of "S" and "B", respectively.
3985
3986 Alternatively a rule can be specified by an 18-bits integer. The 9
3987 high order bits are used to encode the next cell state if it is alive
3988 for each number of neighbor alive cells, the low order bits specify
3989 the rule for "borning" new cells. Higher order bits encode for an
3990 higher number of neighbor cells.
3991 For example the number 6153 = @code{(12<<9)+9} specifies a stay alive
3992 rule of 12 and a born rule of 9, which corresponds to "S23/B03".
3993
3994 Default value is "S23/B3", which is the original Conway's game of life
3995 rule, and will keep a cell alive if it has 2 or 3 neighbor alive
3996 cells, and will born a new cell if there are three alive cells around
3997 a dead cell.
3998
3999 @item size, s
4000 Set the size of the output video.
4001
4002 If @option{filename} is specified, the size is set by default to the
4003 same size of the input file. If @option{size} is set, it must contain
4004 the size specified in the input file, and the initial grid defined in
4005 that file is centered in the larger resulting area.
4006
4007 If a filename is not specified, the size value defaults to "320x240"
4008 (used for a randomly generated initial grid).
4009
4010 @item stitch
4011 If set to 1, stitch the left and right grid edges together, and the
4012 top and bottom edges also. Defaults to 1.
4013
4014 @item mold
4015 Set cell mold speed. If set, a dead cell will go from @option{death_color} to
4016 @option{mold_color} with a step of @option{mold}. @option{mold} can have a
4017 value from 0 to 255.
4018
4019 @item life_color
4020 Set the color of living (or new born) cells.
4021
4022 @item death_color
4023 Set the color of dead cells. If @option{mold} is set, this is the first color
4024 used to represent a dead cell.
4025
4026 @item mold_color
4027 Set mold color, for definitely dead and moldy cells.
4028 @end table
4029
4030 @subsection Examples
4031
4032 @itemize
4033 @item
4034 Read a grid from @file{pattern}, and center it on a grid of size
4035 300x300 pixels:
4036 @example
4037 life=f=pattern:s=300x300
4038 @end example
4039
4040 @item
4041 Generate a random grid of size 200x200, with a fill ratio of 2/3:
4042 @example
4043 life=ratio=2/3:s=200x200
4044 @end example
4045
4046 @item
4047 Specify a custom rule for evolving a randomly generated grid:
4048 @example
4049 life=rule=S14/B34
4050 @end example
4051
4052 @item
4053 Full example with slow death effect (mold) using @command{ffplay}:
4054 @example
4055 ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
4056 @end example
4057 @end itemize
4058
4059 @section color, nullsrc, rgbtestsrc, smptebars, testsrc
4060
4061 The @code{color} source provides an uniformly colored input.
4062
4063 The @code{nullsrc} source returns unprocessed video frames. It is
4064 mainly useful to be employed in analysis / debugging tools, or as the
4065 source for filters which ignore the input data.
4066
4067 The @code{rgbtestsrc} source generates an RGB test pattern useful for
4068 detecting RGB vs BGR issues. You should see a red, green and blue
4069 stripe from top to bottom.
4070
4071 The @code{smptebars} source generates a color bars pattern, based on
4072 the SMPTE Engineering Guideline EG 1-1990.
4073
4074 The @code{testsrc} source generates a test video pattern, showing a
4075 color pattern, a scrolling gradient and a timestamp. This is mainly
4076 intended for testing purposes.
4077
4078 These sources accept an optional sequence of @var{key}=@var{value} pairs,
4079 separated by ":". The description of the accepted options follows.
4080
4081 @table @option
4082
4083 @item color, c
4084 Specify the color of the source, only used in the @code{color}
4085 source. It can be the name of a color (case insensitive match) or a
4086 0xRRGGBB[AA] sequence, possibly followed by an alpha specifier. The
4087 default value is "black".
4088
4089 @item size, s
4090 Specify the size of the sourced video, it may be a string of the form
4091 @var{width}x@var{height}, or the name of a size abbreviation. The
4092 default value is "320x240".
4093
4094 @item rate, r
4095 Specify the frame rate of the sourced video, as the number of frames
4096 generated per second. It has to be a string in the format
4097 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
4098 number or a valid video frame rate abbreviation. The default value is
4099 "25".
4100
4101 @item sar
4102 Set the sample aspect ratio of the sourced video.
4103
4104 @item duration, d
4105 Set the video duration of the sourced video. The accepted syntax is:
4106 @example
4107 [-]HH[:MM[:SS[.m...]]]
4108 [-]S+[.m...]
4109 @end example
4110 See also the function @code{av_parse_time()}.
4111
4112 If not specified, or the expressed duration is negative, the video is
4113 supposed to be generated forever.
4114
4115 @item decimals, n
4116 Set the number of decimals to show in the timestamp, only used in the
4117 @code{testsrc} source.
4118
4119 The displayed timestamp value will correspond to the original
4120 timestamp value multiplied by the power of 10 of the specified
4121 value. Default value is 0.
4122 @end table
4123
4124 For example the following:
4125 @example
4126 testsrc=duration=5.3:size=qcif:rate=10
4127 @end example
4128
4129 will generate a video with a duration of 5.3 seconds, with size
4130 176x144 and a frame rate of 10 frames per second.
4131
4132 The following graph description will generate a red source
4133 with an opacity of 0.2, with size "qcif" and a frame rate of 10
4134 frames per second.
4135 @example
4136 color=c=red@@0.2:s=qcif:r=10
4137 @end example
4138
4139 If the input content is to be ignored, @code{nullsrc} can be used. The
4140 following command generates noise in the luminance plane by employing
4141 the @code{mp=geq} filter:
4142 @example
4143 nullsrc=s=256x256, mp=geq=random(1)*255:128:128
4144 @end example
4145
4146 @c man end VIDEO SOURCES
4147
4148 @chapter Video Sinks
4149 @c man begin VIDEO SINKS
4150
4151 Below is a description of the currently available video sinks.
4152
4153 @section buffersink
4154
4155 Buffer video frames, and make them available to the end of the filter
4156 graph.
4157
4158 This sink is mainly intended for a programmatic use, in particular
4159 through the interface defined in @file{libavfilter/buffersink.h}.
4160
4161 It does not require a string parameter in input, but you need to
4162 specify a pointer to a list of supported pixel formats terminated by
4163 -1 in the opaque parameter provided to @code{avfilter_init_filter}
4164 when initializing this sink.
4165
4166 @section nullsink
4167
4168 Null video sink, do absolutely nothing with the input video. It is
4169 mainly useful as a template and to be employed in analysis / debugging
4170 tools.
4171
4172 @c man end VIDEO SINKS
4173
4174 @chapter Multimedia Filters
4175 @c man begin MULTIMEDIA FILTERS
4176
4177 Below is a description of the currently available multimedia filters.
4178
4179 @section asetpts, setpts
4180
4181 Change the PTS (presentation timestamp) of the input frames.
4182
4183 @code{asetpts} works on audio frames, @code{setpts} on video frames.
4184
4185 Accept in input an expression evaluated through the eval API, which
4186 can contain the following constants:
4187
4188 @table @option
4189 @item PTS
4190 the presentation timestamp in input
4191