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