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