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