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