doc/filters: sort audio filters by name
[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, a filter can have multiple inputs and multiple
7 outputs.
8 To illustrate the sorts of things that are possible, we consider the
9 following filtergraph.
10
11 @example
12 input --> split ---------------------> overlay --> output
13             |                             ^
14             |                             |
15             +-----> crop --> vflip -------+
16 @end example
17
18 This filtergraph splits the input stream in two streams, sends one
19 stream through the crop filter and the vflip filter before merging it
20 back with the other stream by overlaying it on top. You can use the
21 following command to achieve this:
22
23 @example
24 ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
25 @end example
26
27 The result will be that in output the top half of the video is mirrored
28 onto the bottom half.
29
30 Filters in the same linear chain are separated by commas, and distinct
31 linear chains of filters are separated by semicolons. In our example,
32 @var{crop,vflip} are in one linear chain, @var{split} and
33 @var{overlay} are separately in another. The points where the linear
34 chains join are labelled by names enclosed in square brackets. In the
35 example, the split filter generates two outputs that are associated to
36 the labels @var{[main]} and @var{[tmp]}.
37
38 The stream sent to the second output of @var{split}, labelled as
39 @var{[tmp]}, is processed through the @var{crop} filter, which crops
40 away the lower half part of the video, and then vertically flipped. The
41 @var{overlay} filter takes in input the first unchanged output of the
42 split filter (which was labelled as @var{[main]}), and overlay on its
43 lower half the output generated by the @var{crop,vflip} filterchain.
44
45 Some filters take in input a list of parameters: they are specified
46 after the filter name and an equal sign, and are separated from each other
47 by a colon.
48
49 There exist so-called @var{source filters} that do not have an
50 audio/video input, and @var{sink filters} that will not have audio/video
51 output.
52
53 @c man end FILTERING INTRODUCTION
54
55 @chapter graph2dot
56 @c man begin GRAPH2DOT
57
58 The @file{graph2dot} program included in the FFmpeg @file{tools}
59 directory can be used to parse a filtergraph description and issue a
60 corresponding textual representation in the dot language.
61
62 Invoke the command:
63 @example
64 graph2dot -h
65 @end example
66
67 to see how to use @file{graph2dot}.
68
69 You can then pass the dot description to the @file{dot} program (from
70 the graphviz suite of programs) and obtain a graphical representation
71 of the filtergraph.
72
73 For example the sequence of commands:
74 @example
75 echo @var{GRAPH_DESCRIPTION} | \
76 tools/graph2dot -o graph.tmp && \
77 dot -Tpng graph.tmp -o graph.png && \
78 display graph.png
79 @end example
80
81 can be used to create and display an image representing the graph
82 described by the @var{GRAPH_DESCRIPTION} string. Note that this string must be
83 a complete self-contained graph, with its inputs and outputs explicitly defined.
84 For example if your command line is of the form:
85 @example
86 ffmpeg -i infile -vf scale=640:360 outfile
87 @end example
88 your @var{GRAPH_DESCRIPTION} string will need to be of the form:
89 @example
90 nullsrc,scale=640:360,nullsink
91 @end example
92 you may also need to set the @var{nullsrc} parameters and add a @var{format}
93 filter in order to simulate a specific input file.
94
95 @c man end GRAPH2DOT
96
97 @chapter Filtergraph description
98 @c man begin FILTERGRAPH DESCRIPTION
99
100 A filtergraph is a directed graph of connected filters. It can contain
101 cycles, and there can be multiple links between a pair of
102 filters. Each link has one input pad on one side connecting it to one
103 filter from which it takes its input, and one output pad on the other
104 side connecting it to the one filter accepting its output.
105
106 Each filter in a filtergraph is an instance of a filter class
107 registered in the application, which defines the features and the
108 number of input and output pads of the filter.
109
110 A filter with no input pads is called a "source", a filter with no
111 output pads is called a "sink".
112
113 @anchor{Filtergraph syntax}
114 @section Filtergraph syntax
115
116 A filtergraph can be represented using a textual representation, which is
117 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
118 options in @command{ffmpeg} and @option{-vf} in @command{ffplay}, and by the
119 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
120 @file{libavfilter/avfilter.h}.
121
122 A filterchain consists of a sequence of connected filters, each one
123 connected to the previous one in the sequence. A filterchain is
124 represented by a list of ","-separated filter descriptions.
125
126 A filtergraph consists of a sequence of filterchains. A sequence of
127 filterchains is represented by a list of ";"-separated filterchain
128 descriptions.
129
130 A filter is represented by a string of the form:
131 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
132
133 @var{filter_name} is the name of the filter class of which the
134 described filter is an instance of, and has to be the name of one of
135 the filter classes registered in the program.
136 The name of the filter class is optionally followed by a string
137 "=@var{arguments}".
138
139 @var{arguments} is a string which contains the parameters used to
140 initialize the filter instance. It may have one of the following forms:
141 @itemize
142
143 @item
144 A ':'-separated list of @var{key=value} pairs.
145
146 @item
147 A ':'-separated list of @var{value}. In this case, the keys are assumed to be
148 the option names in the order they are declared. E.g. the @code{fade} filter
149 declares three options in this order -- @option{type}, @option{start_frame} and
150 @option{nb_frames}. Then the parameter list @var{in:0:30} means that the value
151 @var{in} is assigned to the option @option{type}, @var{0} to
152 @option{start_frame} and @var{30} to @option{nb_frames}.
153
154 @item
155 A ':'-separated list of mixed direct @var{value} and long @var{key=value}
156 pairs. The direct @var{value} must precede the @var{key=value} pairs, and
157 follow the same constraints order of the previous point. The following
158 @var{key=value} pairs can be set in any preferred order.
159
160 @end itemize
161
162 If the option value itself is a list of items (e.g. the @code{format} filter
163 takes a list of pixel formats), the items in the list are usually separated by
164 '|'.
165
166 The list of arguments can be quoted using the character "'" as initial
167 and ending mark, and the character '\' for escaping the characters
168 within the quoted text; otherwise the argument string is considered
169 terminated when the next special character (belonging to the set
170 "[]=;,") is encountered.
171
172 The name and arguments of the filter are optionally preceded and
173 followed by a list of link labels.
174 A link label allows to name a link and associate it to a filter output
175 or input pad. The preceding labels @var{in_link_1}
176 ... @var{in_link_N}, are associated to the filter input pads,
177 the following labels @var{out_link_1} ... @var{out_link_M}, are
178 associated to the output pads.
179
180 When two link labels with the same name are found in the
181 filtergraph, a link between the corresponding input and output pad is
182 created.
183
184 If an output pad is not labelled, it is linked by default to the first
185 unlabelled input pad of the next filter in the filterchain.
186 For example in the filterchain:
187 @example
188 nullsrc, split[L1], [L2]overlay, nullsink
189 @end example
190 the split filter instance has two output pads, and the overlay filter
191 instance two input pads. The first output pad of split is labelled
192 "L1", the first input pad of overlay is labelled "L2", and the second
193 output pad of split is linked to the second input pad of overlay,
194 which are both unlabelled.
195
196 In a complete filterchain all the unlabelled filter input and output
197 pads must be connected. A filtergraph is considered valid if all the
198 filter input and output pads of all the filterchains are connected.
199
200 Libavfilter will automatically insert scale filters where format
201 conversion is required. It is possible to specify swscale flags
202 for those automatically inserted scalers by prepending
203 @code{sws_flags=@var{flags};}
204 to the filtergraph description.
205
206 Follows a BNF description for the filtergraph syntax:
207 @example
208 @var{NAME}             ::= sequence of alphanumeric characters and '_'
209 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
210 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
211 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
212 @var{FILTER}           ::= [@var{LINKLABELS}] @var{NAME} ["=" @var{FILTER_ARGUMENTS}] [@var{LINKLABELS}]
213 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
214 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
215 @end example
216
217 @section Notes on filtergraph escaping
218
219 Some filter arguments require the use of special characters, typically
220 @code{:} to separate key=value pairs in a named options list. In this
221 case the user should perform a first level escaping when specifying
222 the filter arguments. For example, consider the following literal
223 string to be embedded in the @ref{drawtext} filter arguments:
224 @example
225 this is a 'string': may contain one, or more, special characters
226 @end example
227
228 Since @code{:} is special for the filter arguments syntax, it needs to
229 be escaped, so you get:
230 @example
231 text=this is a \'string\'\: may contain one, or more, special characters
232 @end example
233
234 A second level of escaping is required when embedding the filter
235 arguments in a filtergraph description, in order to escape all the
236 filtergraph special characters. Thus the example above becomes:
237 @example
238 drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
239 @end example
240
241 Finally an additional level of escaping may be needed when writing the
242 filtergraph description in a shell command, which depends on the
243 escaping rules of the adopted shell. For example, assuming that
244 @code{\} is special and needs to be escaped with another @code{\}, the
245 previous string will finally result in:
246 @example
247 -vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
248 @end example
249
250 Sometimes, it might be more convenient to employ quoting in place of
251 escaping. For example the string:
252 @example
253 Caesar: tu quoque, Brute, fili mi
254 @end example
255
256 Can be quoted in the filter arguments as:
257 @example
258 text='Caesar: tu quoque, Brute, fili mi'
259 @end example
260
261 And finally inserted in a filtergraph like:
262 @example
263 drawtext=text=\'Caesar: tu quoque\, Brute\, fili mi\'
264 @end example
265
266 See the ``Quoting and escaping'' section in the ffmpeg-utils manual
267 for more information about the escaping and quoting rules adopted by
268 FFmpeg.
269
270 @chapter Timeline editing
271
272 Some filters support a generic @option{enable} option. For the filters
273 supporting timeline editing, this option can be set to an expression which is
274 evaluated before sending a frame to the filter. If the evaluation is non-zero,
275 the filter will be enabled, otherwise the frame will be sent unchanged to the
276 next filter in the filtergraph.
277
278 The expression accepts the following values:
279 @table @samp
280 @item t
281 timestamp expressed in seconds, NAN if the input timestamp is unknown
282
283 @item n
284 sequential number of the input frame, starting from 0
285
286 @item pos
287 the position in the file of the input frame, NAN if unknown
288 @end table
289
290 Additionally, these filters support an @option{enable} command that can be used
291 to re-define the expression.
292
293 Like any other filtering option, the @option{enable} option follows the same
294 rules.
295
296 For example, to enable a blur filter (@ref{smartblur}) from 10 seconds to 3
297 minutes, and a @ref{curves} filter starting at 3 seconds:
298 @example
299 smartblur = enable='between(t,10,3*60)',
300 curves    = enable='gte(t,3)' : preset=cross_process
301 @end example
302
303 @c man end FILTERGRAPH DESCRIPTION
304
305 @chapter Audio Filters
306 @c man begin AUDIO FILTERS
307
308 When you configure your FFmpeg build, you can disable any of the
309 existing filters using @code{--disable-filters}.
310 The configure output will show the audio filters included in your
311 build.
312
313 Below is a description of the currently available audio filters.
314
315 @section aconvert
316
317 Convert the input audio format to the specified formats.
318
319 @emph{This filter is deprecated. Use @ref{aformat} instead.}
320
321 The filter accepts a string of the form:
322 "@var{sample_format}:@var{channel_layout}".
323
324 @var{sample_format} specifies the sample format, and can be a string or the
325 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
326 suffix for a planar sample format.
327
328 @var{channel_layout} specifies the channel layout, and can be a string
329 or the corresponding number value defined in @file{libavutil/channel_layout.h}.
330
331 The special parameter "auto", signifies that the filter will
332 automatically select the output format depending on the output filter.
333
334 @subsection Examples
335
336 @itemize
337 @item
338 Convert input to float, planar, stereo:
339 @example
340 aconvert=fltp:stereo
341 @end example
342
343 @item
344 Convert input to unsigned 8-bit, automatically select out channel layout:
345 @example
346 aconvert=u8:auto
347 @end example
348 @end itemize
349
350 @section afade
351
352 Apply fade-in/out effect to input audio.
353
354 A description of the accepted parameters follows.
355
356 @table @option
357 @item type, t
358 Specify the effect type, can be either @code{in} for fade-in, or
359 @code{out} for a fade-out effect. Default is @code{in}.
360
361 @item start_sample, ss
362 Specify the number of the start sample for starting to apply the fade
363 effect. Default is 0.
364
365 @item nb_samples, ns
366 Specify the number of samples for which the fade effect has to last. At
367 the end of the fade-in effect the output audio will have the same
368 volume as the input audio, at the end of the fade-out transition
369 the output audio will be silence. Default is 44100.
370
371 @item start_time, st
372 Specify time for starting to apply the fade effect. Default is 0.
373 The accepted syntax is:
374 @example
375 [-]HH[:MM[:SS[.m...]]]
376 [-]S+[.m...]
377 @end example
378 See also the function @code{av_parse_time()}.
379 If set this option is used instead of @var{start_sample} one.
380
381 @item duration, d
382 Specify the duration for which the fade effect has to last. Default is 0.
383 The accepted syntax is:
384 @example
385 [-]HH[:MM[:SS[.m...]]]
386 [-]S+[.m...]
387 @end example
388 See also the function @code{av_parse_time()}.
389 At the end of the fade-in effect the output audio will have the same
390 volume as the input audio, at the end of the fade-out transition
391 the output audio will be silence.
392 If set this option is used instead of @var{nb_samples} one.
393
394 @item curve
395 Set curve for fade transition.
396
397 It accepts the following values:
398 @table @option
399 @item tri
400 select triangular, linear slope (default)
401 @item qsin
402 select quarter of sine wave
403 @item hsin
404 select half of sine wave
405 @item esin
406 select exponential sine wave
407 @item log
408 select logarithmic
409 @item par
410 select inverted parabola
411 @item qua
412 select quadratic
413 @item cub
414 select cubic
415 @item squ
416 select square root
417 @item cbr
418 select cubic root
419 @end table
420 @end table
421
422 @subsection Examples
423
424 @itemize
425 @item
426 Fade in first 15 seconds of audio:
427 @example
428 afade=t=in:ss=0:d=15
429 @end example
430
431 @item
432 Fade out last 25 seconds of a 900 seconds audio:
433 @example
434 afade=t=out:st=875:d=25
435 @end example
436 @end itemize
437
438 @anchor{aformat}
439 @section aformat
440
441 Set output format constraints for the input audio. The framework will
442 negotiate the most appropriate format to minimize conversions.
443
444 The filter accepts the following named parameters:
445 @table @option
446
447 @item sample_fmts
448 A '|'-separated list of requested sample formats.
449
450 @item sample_rates
451 A '|'-separated list of requested sample rates.
452
453 @item channel_layouts
454 A '|'-separated list of requested channel layouts.
455
456 @end table
457
458 If a parameter is omitted, all values are allowed.
459
460 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
461 @example
462 aformat=sample_fmts=u8|s16:channel_layouts=stereo
463 @end example
464
465 @section allpass
466
467 Apply a two-pole all-pass filter with central frequency (in Hz)
468 @var{frequency}, and filter-width @var{width}.
469 An all-pass filter changes the audio's frequency to phase relationship
470 without changing its frequency to amplitude relationship.
471
472 The filter accepts the following options:
473
474 @table @option
475 @item frequency, f
476 Set frequency in Hz.
477
478 @item width_type
479 Set method to specify band-width of filter.
480 @table @option
481 @item h
482 Hz
483 @item q
484 Q-Factor
485 @item o
486 octave
487 @item s
488 slope
489 @end table
490
491 @item width, w
492 Specify the band-width of a filter in width_type units.
493 @end table
494
495 @section amerge
496
497 Merge two or more audio streams into a single multi-channel stream.
498
499 The filter accepts the following options:
500
501 @table @option
502
503 @item inputs
504 Set the number of inputs. Default is 2.
505
506 @end table
507
508 If the channel layouts of the inputs are disjoint, and therefore compatible,
509 the channel layout of the output will be set accordingly and the channels
510 will be reordered as necessary. If the channel layouts of the inputs are not
511 disjoint, the output will have all the channels of the first input then all
512 the channels of the second input, in that order, and the channel layout of
513 the output will be the default value corresponding to the total number of
514 channels.
515
516 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
517 is FC+BL+BR, then the output will be in 5.1, with the channels in the
518 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
519 first input, b1 is the first channel of the second input).
520
521 On the other hand, if both input are in stereo, the output channels will be
522 in the default order: a1, a2, b1, b2, and the channel layout will be
523 arbitrarily set to 4.0, which may or may not be the expected value.
524
525 All inputs must have the same sample rate, and format.
526
527 If inputs do not have the same duration, the output will stop with the
528 shortest.
529
530 @subsection Examples
531
532 @itemize
533 @item
534 Merge two mono files into a stereo stream:
535 @example
536 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
537 @end example
538
539 @item
540 Multiple merges assuming 1 video stream and 6 audio streams in @file{input.mkv}:
541 @example
542 ffmpeg -i input.mkv -filter_complex "[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6" -c:a pcm_s16le output.mkv
543 @end example
544 @end itemize
545
546 @section amix
547
548 Mixes multiple audio inputs into a single output.
549
550 For example
551 @example
552 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
553 @end example
554 will mix 3 input audio streams to a single output with the same duration as the
555 first input and a dropout transition time of 3 seconds.
556
557 The filter accepts the following named parameters:
558 @table @option
559
560 @item inputs
561 Number of inputs. If unspecified, it defaults to 2.
562
563 @item duration
564 How to determine the end-of-stream.
565 @table @option
566
567 @item longest
568 Duration of longest input. (default)
569
570 @item shortest
571 Duration of shortest input.
572
573 @item first
574 Duration of first input.
575
576 @end table
577
578 @item dropout_transition
579 Transition time, in seconds, for volume renormalization when an input
580 stream ends. The default value is 2 seconds.
581
582 @end table
583
584 @section anull
585
586 Pass the audio source unchanged to the output.
587
588 @section apad
589
590 Pad the end of a audio stream with silence, this can be used together with
591 -shortest to extend audio streams to the same length as the video stream.
592
593 @section aphaser
594 Add a phasing effect to the input audio.
595
596 A phaser filter creates series of peaks and troughs in the frequency spectrum.
597 The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
598
599 A description of the accepted parameters follows.
600
601 @table @option
602 @item in_gain
603 Set input gain. Default is 0.4.
604
605 @item out_gain
606 Set output gain. Default is 0.74
607
608 @item delay
609 Set delay in milliseconds. Default is 3.0.
610
611 @item decay
612 Set decay. Default is 0.4.
613
614 @item speed
615 Set modulation speed in Hz. Default is 0.5.
616
617 @item type
618 Set modulation type. Default is triangular.
619
620 It accepts the following values:
621 @table @samp
622 @item triangular, t
623 @item sinusoidal, s
624 @end table
625 @end table
626
627 @anchor{aresample}
628 @section aresample
629
630 Resample the input audio to the specified parameters, using the
631 libswresample library. If none are specified then the filter will
632 automatically convert between its input and output.
633
634 This filter is also able to stretch/squeeze the audio data to make it match
635 the timestamps or to inject silence / cut out audio to make it match the
636 timestamps, do a combination of both or do neither.
637
638 The filter accepts the syntax
639 [@var{sample_rate}:]@var{resampler_options}, where @var{sample_rate}
640 expresses a sample rate and @var{resampler_options} is a list of
641 @var{key}=@var{value} pairs, separated by ":". See the
642 ffmpeg-resampler manual for the complete list of supported options.
643
644 @subsection Examples
645
646 @itemize
647 @item
648 Resample the input audio to 44100Hz:
649 @example
650 aresample=44100
651 @end example
652
653 @item
654 Stretch/squeeze samples to the given timestamps, with a maximum of 1000
655 samples per second compensation:
656 @example
657 aresample=async=1000
658 @end example
659 @end itemize
660
661 @section asetnsamples
662
663 Set the number of samples per each output audio frame.
664
665 The last output packet may contain a different number of samples, as
666 the filter will flush all the remaining samples when the input audio
667 signal its end.
668
669 The filter accepts the following options:
670
671 @table @option
672
673 @item nb_out_samples, n
674 Set the number of frames per each output audio frame. The number is
675 intended as the number of samples @emph{per each channel}.
676 Default value is 1024.
677
678 @item pad, p
679 If set to 1, the filter will pad the last audio frame with zeroes, so
680 that the last frame will contain the same number of samples as the
681 previous ones. Default value is 1.
682 @end table
683
684 For example, to set the number of per-frame samples to 1234 and
685 disable padding for the last frame, use:
686 @example
687 asetnsamples=n=1234:p=0
688 @end example
689
690 @section asetrate
691
692 Set the sample rate without altering the PCM data.
693 This will result in a change of speed and pitch.
694
695 The filter accepts the following options:
696
697 @table @option
698 @item sample_rate, r
699 Set the output sample rate. Default is 44100 Hz.
700 @end table
701
702 @section ashowinfo
703
704 Show a line containing various information for each input audio frame.
705 The input audio is not modified.
706
707 The shown line contains a sequence of key/value pairs of the form
708 @var{key}:@var{value}.
709
710 A description of each shown parameter follows:
711
712 @table @option
713 @item n
714 sequential number of the input frame, starting from 0
715
716 @item pts
717 Presentation timestamp of the input frame, in time base units; the time base
718 depends on the filter input pad, and is usually 1/@var{sample_rate}.
719
720 @item pts_time
721 presentation timestamp of the input frame in seconds
722
723 @item pos
724 position of the frame in the input stream, -1 if this information in
725 unavailable and/or meaningless (for example in case of synthetic audio)
726
727 @item fmt
728 sample format
729
730 @item chlayout
731 channel layout
732
733 @item rate
734 sample rate for the audio frame
735
736 @item nb_samples
737 number of samples (per channel) in the frame
738
739 @item checksum
740 Adler-32 checksum (printed in hexadecimal) of the audio data. For planar audio
741 the data is treated as if all the planes were concatenated.
742
743 @item plane_checksums
744 A list of Adler-32 checksums for each data plane.
745 @end table
746
747 @section astats
748
749 Display time domain statistical information about the audio channels.
750 Statistics are calculated and displayed for each audio channel and,
751 where applicable, an overall figure is also given.
752
753 The filter accepts the following option:
754 @table @option
755 @item length
756 Short window length in seconds, used for peak and trough RMS measurement.
757 Default is @code{0.05} (50 miliseconds). Allowed range is @code{[0.1 - 10]}.
758 @end table
759
760 A description of each shown parameter follows:
761
762 @table @option
763 @item DC offset
764 Mean amplitude displacement from zero.
765
766 @item Min level
767 Minimal sample level.
768
769 @item Max level
770 Maximal sample level.
771
772 @item Peak level dB
773 @item RMS level dB
774 Standard peak and RMS level measured in dBFS.
775
776 @item RMS peak dB
777 @item RMS trough dB
778 Peak and trough values for RMS level measured over a short window.
779
780 @item Crest factor
781 Standard ratio of peak to RMS level (note: not in dB).
782
783 @item Flat factor
784 Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
785 (i.e. either @var{Min level} or @var{Max level}).
786
787 @item Peak count
788 Number of occasions (not the number of samples) that the signal attained either
789 @var{Min level} or @var{Max level}.
790 @end table
791
792 @section astreamsync
793
794 Forward two audio streams and control the order the buffers are forwarded.
795
796 The filter accepts the following options:
797
798 @table @option
799 @item expr, e
800 Set the expression deciding which stream should be
801 forwarded next: if the result is negative, the first stream is forwarded; if
802 the result is positive or zero, the second stream is forwarded. It can use
803 the following variables:
804
805 @table @var
806 @item b1 b2
807 number of buffers forwarded so far on each stream
808 @item s1 s2
809 number of samples forwarded so far on each stream
810 @item t1 t2
811 current timestamp of each stream
812 @end table
813
814 The default value is @code{t1-t2}, which means to always forward the stream
815 that has a smaller timestamp.
816 @end table
817
818 @subsection Examples
819
820 Stress-test @code{amerge} by randomly sending buffers on the wrong
821 input, while avoiding too much of a desynchronization:
822 @example
823 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
824 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
825 [a2] [b2] amerge
826 @end example
827
828 @section asyncts
829
830 Synchronize audio data with timestamps by squeezing/stretching it and/or
831 dropping samples/adding silence when needed.
832
833 This filter is not built by default, please use @ref{aresample} to do squeezing/stretching.
834
835 The filter accepts the following named parameters:
836 @table @option
837
838 @item compensate
839 Enable stretching/squeezing the data to make it match the timestamps. Disabled
840 by default. When disabled, time gaps are covered with silence.
841
842 @item min_delta
843 Minimum difference between timestamps and audio data (in seconds) to trigger
844 adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
845 this filter, try setting this parameter to 0.
846
847 @item max_comp
848 Maximum compensation in samples per second. Relevant only with compensate=1.
849 Default value 500.
850
851 @item first_pts
852 Assume the first pts should be this value. The time base is 1 / sample rate.
853 This allows for padding/trimming at the start of stream. By default, no
854 assumption is made about the first frame's expected pts, so no padding or
855 trimming is done. For example, this could be set to 0 to pad the beginning with
856 silence if an audio stream starts after the video stream or to trim any samples
857 with a negative pts due to encoder delay.
858
859 @end table
860
861 @section atempo
862
863 Adjust audio tempo.
864
865 The filter accepts exactly one parameter, the audio tempo. If not
866 specified then the filter will assume nominal 1.0 tempo. Tempo must
867 be in the [0.5, 2.0] range.
868
869 @subsection Examples
870
871 @itemize
872 @item
873 Slow down audio to 80% tempo:
874 @example
875 atempo=0.8
876 @end example
877
878 @item
879 To speed up audio to 125% tempo:
880 @example
881 atempo=1.25
882 @end example
883 @end itemize
884
885 @section atrim
886
887 Trim the input so that the output contains one continuous subpart of the input.
888
889 This filter accepts the following options:
890 @table @option
891 @item start
892 Timestamp (in seconds) of the start of the kept section. I.e. the audio sample
893 with the timestamp @var{start} will be the first sample in the output.
894
895 @item end
896 Timestamp (in seconds) of the first audio sample that will be dropped. I.e. the
897 audio sample immediately preceding the one with the timestamp @var{end} will be
898 the last sample in the output.
899
900 @item start_pts
901 Same as @var{start}, except this option sets the start timestamp in samples
902 instead of seconds.
903
904 @item end_pts
905 Same as @var{end}, except this option sets the end timestamp in samples instead
906 of seconds.
907
908 @item duration
909 Maximum duration of the output in seconds.
910
911 @item start_sample
912 Number of the first sample that should be passed to output.
913
914 @item end_sample
915 Number of the first sample that should be dropped.
916 @end table
917
918 Note that the first two sets of the start/end options and the @option{duration}
919 option look at the frame timestamp, while the _sample options simply count the
920 samples that pass through the filter. So start/end_pts and start/end_sample will
921 give different results when the timestamps are wrong, inexact or do not start at
922 zero. Also note that this filter does not modify the timestamps. If you wish
923 that the output timestamps start at zero, insert the asetpts filter after the
924 atrim filter.
925
926 If multiple start or end options are set, this filter tries to be greedy and
927 keep all samples that match at least one of the specified constraints. To keep
928 only the part that matches all the constraints at once, chain multiple atrim
929 filters.
930
931 The defaults are such that all the input is kept. So it is possible to set e.g.
932 just the end values to keep everything before the specified time.
933
934 Examples:
935 @itemize
936 @item
937 drop everything except the second minute of input
938 @example
939 ffmpeg -i INPUT -af atrim=60:120
940 @end example
941
942 @item
943 keep only the first 1000 samples
944 @example
945 ffmpeg -i INPUT -af atrim=end_sample=1000
946 @end example
947
948 @end itemize
949
950 @section bandpass
951
952 Apply a two-pole Butterworth band-pass filter with central
953 frequency @var{frequency}, and (3dB-point) band-width width.
954 The @var{csg} option selects a constant skirt gain (peak gain = Q)
955 instead of the default: constant 0dB peak gain.
956 The filter roll off at 6dB per octave (20dB per decade).
957
958 The filter accepts the following options:
959
960 @table @option
961 @item frequency, f
962 Set the filter's central frequency. Default is @code{3000}.
963
964 @item csg
965 Constant skirt gain if set to 1. Defaults to 0.
966
967 @item width_type
968 Set method to specify band-width of filter.
969 @table @option
970 @item h
971 Hz
972 @item q
973 Q-Factor
974 @item o
975 octave
976 @item s
977 slope
978 @end table
979
980 @item width, w
981 Specify the band-width of a filter in width_type units.
982 @end table
983
984 @section bandreject
985
986 Apply a two-pole Butterworth band-reject filter with central
987 frequency @var{frequency}, and (3dB-point) band-width @var{width}.
988 The filter roll off at 6dB per octave (20dB per decade).
989
990 The filter accepts the following options:
991
992 @table @option
993 @item frequency, f
994 Set the filter's central frequency. Default is @code{3000}.
995
996 @item width_type
997 Set method to specify band-width of filter.
998 @table @option
999 @item h
1000 Hz
1001 @item q
1002 Q-Factor
1003 @item o
1004 octave
1005 @item s
1006 slope
1007 @end table
1008
1009 @item width, w
1010 Specify the band-width of a filter in width_type units.
1011 @end table
1012
1013 @section bass
1014
1015 Boost or cut the bass (lower) frequencies of the audio using a two-pole
1016 shelving filter with a response similar to that of a standard
1017 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1018
1019 The filter accepts the following options:
1020
1021 @table @option
1022 @item gain, g
1023 Give the gain at 0 Hz. Its useful range is about -20
1024 (for a large cut) to +20 (for a large boost).
1025 Beware of clipping when using a positive gain.
1026
1027 @item frequency, f
1028 Set the filter's central frequency and so can be used
1029 to extend or reduce the frequency range to be boosted or cut.
1030 The default value is @code{100} Hz.
1031
1032 @item width_type
1033 Set method to specify band-width of filter.
1034 @table @option
1035 @item h
1036 Hz
1037 @item q
1038 Q-Factor
1039 @item o
1040 octave
1041 @item s
1042 slope
1043 @end table
1044
1045 @item width, w
1046 Determine how steep is the filter's shelf transition.
1047 @end table
1048
1049 @section biquad
1050
1051 Apply a biquad IIR filter with the given coefficients.
1052 Where @var{b0}, @var{b1}, @var{b2} and @var{a0}, @var{a1}, @var{a2}
1053 are the numerator and denominator coefficients respectively.
1054
1055 @section channelmap
1056
1057 Remap input channels to new locations.
1058
1059 This filter accepts the following named parameters:
1060 @table @option
1061 @item channel_layout
1062 Channel layout of the output stream.
1063
1064 @item map
1065 Map channels from input to output. The argument is a '|'-separated list of
1066 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
1067 @var{in_channel} form. @var{in_channel} can be either the name of the input
1068 channel (e.g. FL for front left) or its index in the input channel layout.
1069 @var{out_channel} is the name of the output channel or its index in the output
1070 channel layout. If @var{out_channel} is not given then it is implicitly an
1071 index, starting with zero and increasing by one for each mapping.
1072 @end table
1073
1074 If no mapping is present, the filter will implicitly map input channels to
1075 output channels preserving index.
1076
1077 For example, assuming a 5.1+downmix input MOV file
1078 @example
1079 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
1080 @end example
1081 will create an output WAV file tagged as stereo from the downmix channels of
1082 the input.
1083
1084 To fix a 5.1 WAV improperly encoded in AAC's native channel order
1085 @example
1086 ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:channel_layout=5.1' out.wav
1087 @end example
1088
1089 @section channelsplit
1090
1091 Split each channel in input audio stream into a separate output stream.
1092
1093 This filter accepts the following named parameters:
1094 @table @option
1095 @item channel_layout
1096 Channel layout of the input stream. Default is "stereo".
1097 @end table
1098
1099 For example, assuming a stereo input MP3 file
1100 @example
1101 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
1102 @end example
1103 will create an output Matroska file with two audio streams, one containing only
1104 the left channel and the other the right channel.
1105
1106 To split a 5.1 WAV file into per-channel files
1107 @example
1108 ffmpeg -i in.wav -filter_complex
1109 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
1110 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
1111 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
1112 side_right.wav
1113 @end example
1114
1115 @section earwax
1116
1117 Make audio easier to listen to on headphones.
1118
1119 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
1120 so that when listened to on headphones the stereo image is moved from
1121 inside your head (standard for headphones) to outside and in front of
1122 the listener (standard for speakers).
1123
1124 Ported from SoX.
1125
1126 @section equalizer
1127
1128 Apply a two-pole peaking equalisation (EQ) filter. With this
1129 filter, the signal-level at and around a selected frequency can
1130 be increased or decreased, whilst (unlike bandpass and bandreject
1131 filters) that at all other frequencies is unchanged.
1132
1133 In order to produce complex equalisation curves, this filter can
1134 be given several times, each with a different central frequency.
1135
1136 The filter accepts the following options:
1137
1138 @table @option
1139 @item frequency, f
1140 Set the filter's central frequency in Hz.
1141
1142 @item width_type
1143 Set method to specify band-width of filter.
1144 @table @option
1145 @item h
1146 Hz
1147 @item q
1148 Q-Factor
1149 @item o
1150 octave
1151 @item s
1152 slope
1153 @end table
1154
1155 @item width, w
1156 Specify the band-width of a filter in width_type units.
1157
1158 @item gain, g
1159 Set the required gain or attenuation in dB.
1160 Beware of clipping when using a positive gain.
1161 @end table
1162
1163 @section highpass
1164
1165 Apply a high-pass filter with 3dB point frequency.
1166 The filter can be either single-pole, or double-pole (the default).
1167 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1168
1169 The filter accepts the following options:
1170
1171 @table @option
1172 @item frequency, f
1173 Set frequency in Hz. Default is 3000.
1174
1175 @item poles, p
1176 Set number of poles. Default is 2.
1177
1178 @item width_type
1179 Set method to specify band-width of filter.
1180 @table @option
1181 @item h
1182 Hz
1183 @item q
1184 Q-Factor
1185 @item o
1186 octave
1187 @item s
1188 slope
1189 @end table
1190
1191 @item width, w
1192 Specify the band-width of a filter in width_type units.
1193 Applies only to double-pole filter.
1194 The default is 0.707q and gives a Butterworth response.
1195 @end table
1196
1197 @section join
1198
1199 Join multiple input streams into one multi-channel stream.
1200
1201 The filter accepts the following named parameters:
1202 @table @option
1203
1204 @item inputs
1205 Number of input streams. Defaults to 2.
1206
1207 @item channel_layout
1208 Desired output channel layout. Defaults to stereo.
1209
1210 @item map
1211 Map channels from inputs to output. The argument is a '|'-separated list of
1212 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1213 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1214 can be either the name of the input channel (e.g. FL for front left) or its
1215 index in the specified input stream. @var{out_channel} is the name of the output
1216 channel.
1217 @end table
1218
1219 The filter will attempt to guess the mappings when those are not specified
1220 explicitly. It does so by first trying to find an unused matching input channel
1221 and if that fails it picks the first unused input channel.
1222
1223 E.g. to join 3 inputs (with properly set channel layouts)
1224 @example
1225 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1226 @end example
1227
1228 To build a 5.1 output from 6 single-channel streams:
1229 @example
1230 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1231 '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'
1232 out
1233 @end example
1234
1235 @section lowpass
1236
1237 Apply a low-pass filter with 3dB point frequency.
1238 The filter can be either single-pole or double-pole (the default).
1239 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1240
1241 The filter accepts the following options:
1242
1243 @table @option
1244 @item frequency, f
1245 Set frequency in Hz. Default is 500.
1246
1247 @item poles, p
1248 Set number of poles. Default is 2.
1249
1250 @item width_type
1251 Set method to specify band-width of filter.
1252 @table @option
1253 @item h
1254 Hz
1255 @item q
1256 Q-Factor
1257 @item o
1258 octave
1259 @item s
1260 slope
1261 @end table
1262
1263 @item width, w
1264 Specify the band-width of a filter in width_type units.
1265 Applies only to double-pole filter.
1266 The default is 0.707q and gives a Butterworth response.
1267 @end table
1268
1269 @section pan
1270
1271 Mix channels with specific gain levels. The filter accepts the output
1272 channel layout followed by a set of channels definitions.
1273
1274 This filter is also designed to remap efficiently the channels of an audio
1275 stream.
1276
1277 The filter accepts parameters of the form:
1278 "@var{l}:@var{outdef}:@var{outdef}:..."
1279
1280 @table @option
1281 @item l
1282 output channel layout or number of channels
1283
1284 @item outdef
1285 output channel specification, of the form:
1286 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
1287
1288 @item out_name
1289 output channel to define, either a channel name (FL, FR, etc.) or a channel
1290 number (c0, c1, etc.)
1291
1292 @item gain
1293 multiplicative coefficient for the channel, 1 leaving the volume unchanged
1294
1295 @item in_name
1296 input channel to use, see out_name for details; it is not possible to mix
1297 named and numbered input channels
1298 @end table
1299
1300 If the `=' in a channel specification is replaced by `<', then the gains for
1301 that specification will be renormalized so that the total is 1, thus
1302 avoiding clipping noise.
1303
1304 @subsection Mixing examples
1305
1306 For example, if you want to down-mix from stereo to mono, but with a bigger
1307 factor for the left channel:
1308 @example
1309 pan=1:c0=0.9*c0+0.1*c1
1310 @end example
1311
1312 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
1313 7-channels surround:
1314 @example
1315 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
1316 @end example
1317
1318 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
1319 that should be preferred (see "-ac" option) unless you have very specific
1320 needs.
1321
1322 @subsection Remapping examples
1323
1324 The channel remapping will be effective if, and only if:
1325
1326 @itemize
1327 @item gain coefficients are zeroes or ones,
1328 @item only one input per channel output,
1329 @end itemize
1330
1331 If all these conditions are satisfied, the filter will notify the user ("Pure
1332 channel mapping detected"), and use an optimized and lossless method to do the
1333 remapping.
1334
1335 For example, if you have a 5.1 source and want a stereo audio stream by
1336 dropping the extra channels:
1337 @example
1338 pan="stereo: c0=FL : c1=FR"
1339 @end example
1340
1341 Given the same source, you can also switch front left and front right channels
1342 and keep the input channel layout:
1343 @example
1344 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
1345 @end example
1346
1347 If the input is a stereo audio stream, you can mute the front left channel (and
1348 still keep the stereo channel layout) with:
1349 @example
1350 pan="stereo:c1=c1"
1351 @end example
1352
1353 Still with a stereo audio stream input, you can copy the right channel in both
1354 front left and right:
1355 @example
1356 pan="stereo: c0=FR : c1=FR"
1357 @end example
1358
1359 @section resample
1360
1361 Convert the audio sample format, sample rate and channel layout. This filter is
1362 not meant to be used directly.
1363
1364 @section silencedetect
1365
1366 Detect silence in an audio stream.
1367
1368 This filter logs a message when it detects that the input audio volume is less
1369 or equal to a noise tolerance value for a duration greater or equal to the
1370 minimum detected noise duration.
1371
1372 The printed times and duration are expressed in seconds.
1373
1374 The filter accepts the following options:
1375
1376 @table @option
1377 @item duration, d
1378 Set silence duration until notification (default is 2 seconds).
1379
1380 @item noise, n
1381 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
1382 specified value) or amplitude ratio. Default is -60dB, or 0.001.
1383 @end table
1384
1385 @subsection Examples
1386
1387 @itemize
1388 @item
1389 Detect 5 seconds of silence with -50dB noise tolerance:
1390 @example
1391 silencedetect=n=-50dB:d=5
1392 @end example
1393
1394 @item
1395 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
1396 tolerance in @file{silence.mp3}:
1397 @example
1398 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
1399 @end example
1400 @end itemize
1401
1402 @section treble
1403
1404 Boost or cut treble (upper) frequencies of the audio using a two-pole
1405 shelving filter with a response similar to that of a standard
1406 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1407
1408 The filter accepts the following options:
1409
1410 @table @option
1411 @item gain, g
1412 Give the gain at whichever is the lower of ~22 kHz and the
1413 Nyquist frequency. Its useful range is about -20 (for a large cut)
1414 to +20 (for a large boost). Beware of clipping when using a positive gain.
1415
1416 @item frequency, f
1417 Set the filter's central frequency and so can be used
1418 to extend or reduce the frequency range to be boosted or cut.
1419 The default value is @code{3000} Hz.
1420
1421 @item width_type
1422 Set method to specify band-width of filter.
1423 @table @option
1424 @item h
1425 Hz
1426 @item q
1427 Q-Factor
1428 @item o
1429 octave
1430 @item s
1431 slope
1432 @end table
1433
1434 @item width, w
1435 Determine how steep is the filter's shelf transition.
1436 @end table
1437
1438 @section volume
1439
1440 Adjust the input audio volume.
1441
1442 The filter accepts the following options:
1443
1444 @table @option
1445
1446 @item volume
1447 Expresses how the audio volume will be increased or decreased.
1448
1449 Output values are clipped to the maximum value.
1450
1451 The output audio volume is given by the relation:
1452 @example
1453 @var{output_volume} = @var{volume} * @var{input_volume}
1454 @end example
1455
1456 Default value for @var{volume} is 1.0.
1457
1458 @item precision
1459 Set the mathematical precision.
1460
1461 This determines which input sample formats will be allowed, which affects the
1462 precision of the volume scaling.
1463
1464 @table @option
1465 @item fixed
1466 8-bit fixed-point; limits input sample format to U8, S16, and S32.
1467 @item float
1468 32-bit floating-point; limits input sample format to FLT. (default)
1469 @item double
1470 64-bit floating-point; limits input sample format to DBL.
1471 @end table
1472 @end table
1473
1474 @subsection Examples
1475
1476 @itemize
1477 @item
1478 Halve the input audio volume:
1479 @example
1480 volume=volume=0.5
1481 volume=volume=1/2
1482 volume=volume=-6.0206dB
1483 @end example
1484
1485 In all the above example the named key for @option{volume} can be
1486 omitted, for example like in:
1487 @example
1488 volume=0.5
1489 @end example
1490
1491 @item
1492 Increase input audio power by 6 decibels using fixed-point precision:
1493 @example
1494 volume=volume=6dB:precision=fixed
1495 @end example
1496 @end itemize
1497
1498 @section volumedetect
1499
1500 Detect the volume of the input video.
1501
1502 The filter has no parameters. The input is not modified. Statistics about
1503 the volume will be printed in the log when the input stream end is reached.
1504
1505 In particular it will show the mean volume (root mean square), maximum
1506 volume (on a per-sample basis), and the beginning of an histogram of the
1507 registered volume values (from the maximum value to a cumulated 1/1000 of
1508 the samples).
1509
1510 All volumes are in decibels relative to the maximum PCM value.
1511
1512 @subsection Examples
1513
1514 Here is an excerpt of the output:
1515 @example
1516 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
1517 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
1518 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
1519 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
1520 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
1521 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
1522 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
1523 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
1524 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
1525 @end example
1526
1527 It means that:
1528 @itemize
1529 @item
1530 The mean square energy is approximately -27 dB, or 10^-2.7.
1531 @item
1532 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
1533 @item
1534 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
1535 @end itemize
1536
1537 In other words, raising the volume by +4 dB does not cause any clipping,
1538 raising it by +5 dB causes clipping for 6 samples, etc.
1539
1540 @c man end AUDIO FILTERS
1541
1542 @chapter Audio Sources
1543 @c man begin AUDIO SOURCES
1544
1545 Below is a description of the currently available audio sources.
1546
1547 @section abuffer
1548
1549 Buffer audio frames, and make them available to the filter chain.
1550
1551 This source is mainly intended for a programmatic use, in particular
1552 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
1553
1554 It accepts the following named parameters:
1555
1556 @table @option
1557
1558 @item time_base
1559 Timebase which will be used for timestamps of submitted frames. It must be
1560 either a floating-point number or in @var{numerator}/@var{denominator} form.
1561
1562 @item sample_rate
1563 The sample rate of the incoming audio buffers.
1564
1565 @item sample_fmt
1566 The sample format of the incoming audio buffers.
1567 Either a sample format name or its corresponging integer representation from
1568 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
1569
1570 @item channel_layout
1571 The channel layout of the incoming audio buffers.
1572 Either a channel layout name from channel_layout_map in
1573 @file{libavutil/channel_layout.c} or its corresponding integer representation
1574 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
1575
1576 @item channels
1577 The number of channels of the incoming audio buffers.
1578 If both @var{channels} and @var{channel_layout} are specified, then they
1579 must be consistent.
1580
1581 @end table
1582
1583 @subsection Examples
1584
1585 @example
1586 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
1587 @end example
1588
1589 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
1590 Since the sample format with name "s16p" corresponds to the number
1591 6 and the "stereo" channel layout corresponds to the value 0x3, this is
1592 equivalent to:
1593 @example
1594 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
1595 @end example
1596
1597 @section aevalsrc
1598
1599 Generate an audio signal specified by an expression.
1600
1601 This source accepts in input one or more expressions (one for each
1602 channel), which are evaluated and used to generate a corresponding
1603 audio signal.
1604
1605 This source accepts the following options:
1606
1607 @table @option
1608 @item exprs
1609 Set the '|'-separated expressions list for each separate channel. In case the
1610 @option{channel_layout} option is not specified, the selected channel layout
1611 depends on the number of provided expressions.
1612
1613 @item channel_layout, c
1614 Set the channel layout. The number of channels in the specified layout
1615 must be equal to the number of specified expressions.
1616
1617 @item duration, d
1618 Set the minimum duration of the sourced audio. See the function
1619 @code{av_parse_time()} for the accepted format.
1620 Note that the resulting duration may be greater than the specified
1621 duration, as the generated audio is always cut at the end of a
1622 complete frame.
1623
1624 If not specified, or the expressed duration is negative, the audio is
1625 supposed to be generated forever.
1626
1627 @item nb_samples, n
1628 Set the number of samples per channel per each output frame,
1629 default to 1024.
1630
1631 @item sample_rate, s
1632 Specify the sample rate, default to 44100.
1633 @end table
1634
1635 Each expression in @var{exprs} can contain the following constants:
1636
1637 @table @option
1638 @item n
1639 number of the evaluated sample, starting from 0
1640
1641 @item t
1642 time of the evaluated sample expressed in seconds, starting from 0
1643
1644 @item s
1645 sample rate
1646
1647 @end table
1648
1649 @subsection Examples
1650
1651 @itemize
1652 @item
1653 Generate silence:
1654 @example
1655 aevalsrc=0
1656 @end example
1657
1658 @item
1659 Generate a sin signal with frequency of 440 Hz, set sample rate to
1660 8000 Hz:
1661 @example
1662 aevalsrc="sin(440*2*PI*t):s=8000"
1663 @end example
1664
1665 @item
1666 Generate a two channels signal, specify the channel layout (Front
1667 Center + Back Center) explicitly:
1668 @example
1669 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
1670 @end example
1671
1672 @item
1673 Generate white noise:
1674 @example
1675 aevalsrc="-2+random(0)"
1676 @end example
1677
1678 @item
1679 Generate an amplitude modulated signal:
1680 @example
1681 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
1682 @end example
1683
1684 @item
1685 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
1686 @example
1687 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
1688 @end example
1689
1690 @end itemize
1691
1692 @section anullsrc
1693
1694 Null audio source, return unprocessed audio frames. It is mainly useful
1695 as a template and to be employed in analysis / debugging tools, or as
1696 the source for filters which ignore the input data (for example the sox
1697 synth filter).
1698
1699 This source accepts the following options:
1700
1701 @table @option
1702
1703 @item channel_layout, cl
1704
1705 Specify the channel layout, and can be either an integer or a string
1706 representing a channel layout. The default value of @var{channel_layout}
1707 is "stereo".
1708
1709 Check the channel_layout_map definition in
1710 @file{libavutil/channel_layout.c} for the mapping between strings and
1711 channel layout values.
1712
1713 @item sample_rate, r
1714 Specify the sample rate, and defaults to 44100.
1715
1716 @item nb_samples, n
1717 Set the number of samples per requested frames.
1718
1719 @end table
1720
1721 @subsection Examples
1722
1723 @itemize
1724 @item
1725 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
1726 @example
1727 anullsrc=r=48000:cl=4
1728 @end example
1729
1730 @item
1731 Do the same operation with a more obvious syntax:
1732 @example
1733 anullsrc=r=48000:cl=mono
1734 @end example
1735 @end itemize
1736
1737 @section abuffer
1738 Buffer audio frames, and make them available to the filter chain.
1739
1740 This source is not intended to be part of user-supplied graph descriptions but
1741 for insertion by calling programs through the interface defined in
1742 @file{libavfilter/buffersrc.h}.
1743
1744 It accepts the following named parameters:
1745 @table @option
1746
1747 @item time_base
1748 Timebase which will be used for timestamps of submitted frames. It must be
1749 either a floating-point number or in @var{numerator}/@var{denominator} form.
1750
1751 @item sample_rate
1752 Audio sample rate.
1753
1754 @item sample_fmt
1755 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
1756
1757 @item channel_layout
1758 Channel layout of the audio data, in the form that can be accepted by
1759 @code{av_get_channel_layout()}.
1760 @end table
1761
1762 All the parameters need to be explicitly defined.
1763
1764 @section flite
1765
1766 Synthesize a voice utterance using the libflite library.
1767
1768 To enable compilation of this filter you need to configure FFmpeg with
1769 @code{--enable-libflite}.
1770
1771 Note that the flite library is not thread-safe.
1772
1773 The filter accepts the following options:
1774
1775 @table @option
1776
1777 @item list_voices
1778 If set to 1, list the names of the available voices and exit
1779 immediately. Default value is 0.
1780
1781 @item nb_samples, n
1782 Set the maximum number of samples per frame. Default value is 512.
1783
1784 @item textfile
1785 Set the filename containing the text to speak.
1786
1787 @item text
1788 Set the text to speak.
1789
1790 @item voice, v
1791 Set the voice to use for the speech synthesis. Default value is
1792 @code{kal}. See also the @var{list_voices} option.
1793 @end table
1794
1795 @subsection Examples
1796
1797 @itemize
1798 @item
1799 Read from file @file{speech.txt}, and synthetize the text using the
1800 standard flite voice:
1801 @example
1802 flite=textfile=speech.txt
1803 @end example
1804
1805 @item
1806 Read the specified text selecting the @code{slt} voice:
1807 @example
1808 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1809 @end example
1810
1811 @item
1812 Input text to ffmpeg:
1813 @example
1814 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1815 @end example
1816
1817 @item
1818 Make @file{ffplay} speak the specified text, using @code{flite} and
1819 the @code{lavfi} device:
1820 @example
1821 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
1822 @end example
1823 @end itemize
1824
1825 For more information about libflite, check:
1826 @url{http://www.speech.cs.cmu.edu/flite/}
1827
1828 @section sine
1829
1830 Generate an audio signal made of a sine wave with amplitude 1/8.
1831
1832 The audio signal is bit-exact.
1833
1834 The filter accepts the following options:
1835
1836 @table @option
1837
1838 @item frequency, f
1839 Set the carrier frequency. Default is 440 Hz.
1840
1841 @item beep_factor, b
1842 Enable a periodic beep every second with frequency @var{beep_factor} times
1843 the carrier frequency. Default is 0, meaning the beep is disabled.
1844
1845 @item sample_rate, s
1846 Specify the sample rate, default is 44100.
1847
1848 @item duration, d
1849 Specify the duration of the generated audio stream.
1850
1851 @item samples_per_frame
1852 Set the number of samples per output frame, default is 1024.
1853 @end table
1854
1855 @subsection Examples
1856
1857 @itemize
1858
1859 @item
1860 Generate a simple 440 Hz sine wave:
1861 @example
1862 sine
1863 @end example
1864
1865 @item
1866 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
1867 @example
1868 sine=220:4:d=5
1869 sine=f=220:b=4:d=5
1870 sine=frequency=220:beep_factor=4:duration=5
1871 @end example
1872
1873 @end itemize
1874
1875 @c man end AUDIO SOURCES
1876
1877 @chapter Audio Sinks
1878 @c man begin AUDIO SINKS
1879
1880 Below is a description of the currently available audio sinks.
1881
1882 @section abuffersink
1883
1884 Buffer audio frames, and make them available to the end of filter chain.
1885
1886 This sink is mainly intended for programmatic use, in particular
1887 through the interface defined in @file{libavfilter/buffersink.h}
1888 or the options system.
1889
1890 It accepts a pointer to an AVABufferSinkContext structure, which
1891 defines the incoming buffers' formats, to be passed as the opaque
1892 parameter to @code{avfilter_init_filter} for initialization.
1893
1894 @section anullsink
1895
1896 Null audio sink, do absolutely nothing with the input audio. It is
1897 mainly useful as a template and to be employed in analysis / debugging
1898 tools.
1899
1900 @c man end AUDIO SINKS
1901
1902 @chapter Video Filters
1903 @c man begin VIDEO FILTERS
1904
1905 When you configure your FFmpeg build, you can disable any of the
1906 existing filters using @code{--disable-filters}.
1907 The configure output will show the video filters included in your
1908 build.
1909
1910 Below is a description of the currently available video filters.
1911
1912 @section alphaextract
1913
1914 Extract the alpha component from the input as a grayscale video. This
1915 is especially useful with the @var{alphamerge} filter.
1916
1917 @section alphamerge
1918
1919 Add or replace the alpha component of the primary input with the
1920 grayscale value of a second input. This is intended for use with
1921 @var{alphaextract} to allow the transmission or storage of frame
1922 sequences that have alpha in a format that doesn't support an alpha
1923 channel.
1924
1925 For example, to reconstruct full frames from a normal YUV-encoded video
1926 and a separate video created with @var{alphaextract}, you might use:
1927 @example
1928 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
1929 @end example
1930
1931 Since this filter is designed for reconstruction, it operates on frame
1932 sequences without considering timestamps, and terminates when either
1933 input reaches end of stream. This will cause problems if your encoding
1934 pipeline drops frames. If you're trying to apply an image as an
1935 overlay to a video stream, consider the @var{overlay} filter instead.
1936
1937 @section ass
1938
1939 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
1940 and libavformat to work. On the other hand, it is limited to ASS (Advanced
1941 Substation Alpha) subtitles files.
1942
1943 @section bbox
1944
1945 Compute the bounding box for the non-black pixels in the input frame
1946 luminance plane.
1947
1948 This filter computes the bounding box containing all the pixels with a
1949 luminance value greater than the minimum allowed value.
1950 The parameters describing the bounding box are printed on the filter
1951 log.
1952
1953 @section blackdetect
1954
1955 Detect video intervals that are (almost) completely black. Can be
1956 useful to detect chapter transitions, commercials, or invalid
1957 recordings. Output lines contains the time for the start, end and
1958 duration of the detected black interval expressed in seconds.
1959
1960 In order to display the output lines, you need to set the loglevel at
1961 least to the AV_LOG_INFO value.
1962
1963 The filter accepts the following options:
1964
1965 @table @option
1966 @item black_min_duration, d
1967 Set the minimum detected black duration expressed in seconds. It must
1968 be a non-negative floating point number.
1969
1970 Default value is 2.0.
1971
1972 @item picture_black_ratio_th, pic_th
1973 Set the threshold for considering a picture "black".
1974 Express the minimum value for the ratio:
1975 @example
1976 @var{nb_black_pixels} / @var{nb_pixels}
1977 @end example
1978
1979 for which a picture is considered black.
1980 Default value is 0.98.
1981
1982 @item pixel_black_th, pix_th
1983 Set the threshold for considering a pixel "black".
1984
1985 The threshold expresses the maximum pixel luminance value for which a
1986 pixel is considered "black". The provided value is scaled according to
1987 the following equation:
1988 @example
1989 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1990 @end example
1991
1992 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1993 the input video format, the range is [0-255] for YUV full-range
1994 formats and [16-235] for YUV non full-range formats.
1995
1996 Default value is 0.10.
1997 @end table
1998
1999 The following example sets the maximum pixel threshold to the minimum
2000 value, and detects only black intervals of 2 or more seconds:
2001 @example
2002 blackdetect=d=2:pix_th=0.00
2003 @end example
2004
2005 @section blackframe
2006
2007 Detect frames that are (almost) completely black. Can be useful to
2008 detect chapter transitions or commercials. Output lines consist of
2009 the frame number of the detected frame, the percentage of blackness,
2010 the position in the file if known or -1 and the timestamp in seconds.
2011
2012 In order to display the output lines, you need to set the loglevel at
2013 least to the AV_LOG_INFO value.
2014
2015 The filter accepts the following options:
2016
2017 @table @option
2018
2019 @item amount
2020 Set the percentage of the pixels that have to be below the threshold, defaults
2021 to @code{98}.
2022
2023 @item threshold, thresh
2024 Set the threshold below which a pixel value is considered black, defaults to
2025 @code{32}.
2026
2027 @end table
2028
2029 @section blend
2030
2031 Blend two video frames into each other.
2032
2033 It takes two input streams and outputs one stream, the first input is the
2034 "top" layer and second input is "bottom" layer.
2035 Output terminates when shortest input terminates.
2036
2037 A description of the accepted options follows.
2038
2039 @table @option
2040 @item c0_mode
2041 @item c1_mode
2042 @item c2_mode
2043 @item c3_mode
2044 @item all_mode
2045 Set blend mode for specific pixel component or all pixel components in case
2046 of @var{all_mode}. Default value is @code{normal}.
2047
2048 Available values for component modes are:
2049 @table @samp
2050 @item addition
2051 @item and
2052 @item average
2053 @item burn
2054 @item darken
2055 @item difference
2056 @item divide
2057 @item dodge
2058 @item exclusion
2059 @item hardlight
2060 @item lighten
2061 @item multiply
2062 @item negation
2063 @item normal
2064 @item or
2065 @item overlay
2066 @item phoenix
2067 @item pinlight
2068 @item reflect
2069 @item screen
2070 @item softlight
2071 @item subtract
2072 @item vividlight
2073 @item xor
2074 @end table
2075
2076 @item c0_opacity
2077 @item c1_opacity
2078 @item c2_opacity
2079 @item c3_opacity
2080 @item all_opacity
2081 Set blend opacity for specific pixel component or all pixel components in case
2082 of @var{all_opacity}. Only used in combination with pixel component blend modes.
2083
2084 @item c0_expr
2085 @item c1_expr
2086 @item c2_expr
2087 @item c3_expr
2088 @item all_expr
2089 Set blend expression for specific pixel component or all pixel components in case
2090 of @var{all_expr}. Note that related mode options will be ignored if those are set.
2091
2092 The expressions can use the following variables:
2093
2094 @table @option
2095 @item N
2096 The sequential number of the filtered frame, starting from @code{0}.
2097
2098 @item X
2099 @item Y
2100 the coordinates of the current sample
2101
2102 @item W
2103 @item H
2104 the width and height of currently filtered plane
2105
2106 @item SW
2107 @item SH
2108 Width and height scale depending on the currently filtered plane. It is the
2109 ratio between the corresponding luma plane number of pixels and the current
2110 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
2111 @code{0.5,0.5} for chroma planes.
2112
2113 @item T
2114 Time of the current frame, expressed in seconds.
2115
2116 @item TOP, A
2117 Value of pixel component at current location for first video frame (top layer).
2118
2119 @item BOTTOM, B
2120 Value of pixel component at current location for second video frame (bottom layer).
2121 @end table
2122 @end table
2123
2124 @subsection Examples
2125
2126 @itemize
2127 @item
2128 Apply transition from bottom layer to top layer in first 10 seconds:
2129 @example
2130 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
2131 @end example
2132
2133 @item
2134 Apply 1x1 checkerboard effect:
2135 @example
2136 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
2137 @end example
2138 @end itemize
2139
2140 @section boxblur
2141
2142 Apply boxblur algorithm to the input video.
2143
2144 The filter accepts the following options:
2145
2146 @table @option
2147
2148 @item luma_radius, lr
2149 @item luma_power, lp
2150 @item chroma_radius, cr
2151 @item chroma_power, cp
2152 @item alpha_radius, ar
2153 @item alpha_power, ap
2154
2155 @end table
2156
2157 A description of the accepted options follows.
2158
2159 @table @option
2160 @item luma_radius, lr
2161 @item chroma_radius, cr
2162 @item alpha_radius, ar
2163 Set an expression for the box radius in pixels used for blurring the
2164 corresponding input plane.
2165
2166 The radius value must be a non-negative number, and must not be
2167 greater than the value of the expression @code{min(w,h)/2} for the
2168 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
2169 planes.
2170
2171 Default value for @option{luma_radius} is "2". If not specified,
2172 @option{chroma_radius} and @option{alpha_radius} default to the
2173 corresponding value set for @option{luma_radius}.
2174
2175 The expressions can contain the following constants:
2176 @table @option
2177 @item w, h
2178 the input width and height in pixels
2179
2180 @item cw, ch
2181 the input chroma image width and height in pixels
2182
2183 @item hsub, vsub
2184 horizontal and vertical chroma subsample values. For example for the
2185 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2186 @end table
2187
2188 @item luma_power, lp
2189 @item chroma_power, cp
2190 @item alpha_power, ap
2191 Specify how many times the boxblur filter is applied to the
2192 corresponding plane.
2193
2194 Default value for @option{luma_power} is 2. If not specified,
2195 @option{chroma_power} and @option{alpha_power} default to the
2196 corresponding value set for @option{luma_power}.
2197
2198 A value of 0 will disable the effect.
2199 @end table
2200
2201 @subsection Examples
2202
2203 @itemize
2204 @item
2205 Apply a boxblur filter with luma, chroma, and alpha radius
2206 set to 2:
2207 @example
2208 boxblur=luma_radius=2:luma_power=1
2209 boxblur=2:1
2210 @end example
2211
2212 @item
2213 Set luma radius to 2, alpha and chroma radius to 0:
2214 @example
2215 boxblur=2:1:cr=0:ar=0
2216 @end example
2217
2218 @item
2219 Set luma and chroma radius to a fraction of the video dimension:
2220 @example
2221 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
2222 @end example
2223 @end itemize
2224
2225 @section colorbalance
2226 Modify intensity of primary colors (red, green and blue) of input frames.
2227
2228 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
2229 regions for the red-cyan, green-magenta or blue-yellow balance.
2230
2231 A positive adjustment value shifts the balance towards the primary color, a negative
2232 value towards the complementary color.
2233
2234 The filter accepts the following options:
2235
2236 @table @option
2237 @item rs
2238 @item gs
2239 @item bs
2240 Adjust red, green and blue shadows (darkest pixels).
2241
2242 @item rm
2243 @item gm
2244 @item bm
2245 Adjust red, green and blue midtones (medium pixels).
2246
2247 @item rh
2248 @item gh
2249 @item bh
2250 Adjust red, green and blue highlights (brightest pixels).
2251
2252 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
2253 @end table
2254
2255 @subsection Examples
2256
2257 @itemize
2258 @item
2259 Add red color cast to shadows:
2260 @example
2261 colorbalance=rs=.3
2262 @end example
2263 @end itemize
2264
2265 @section colorchannelmixer
2266
2267 Adjust video input frames by re-mixing color channels.
2268
2269 This filter modifies a color channel by adding the values associated to
2270 the other channels of the same pixels. For example if the value to
2271 modify is red, the output value will be:
2272 @example
2273 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
2274 @end example
2275
2276 The filter accepts the following options:
2277
2278 @table @option
2279 @item rr
2280 @item rg
2281 @item rb
2282 @item ra
2283 Adjust contribution of input red, green, blue and alpha channels for output red channel.
2284 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
2285
2286 @item gr
2287 @item gg
2288 @item gb
2289 @item ga
2290 Adjust contribution of input red, green, blue and alpha channels for output green channel.
2291 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
2292
2293 @item br
2294 @item bg
2295 @item bb
2296 @item ba
2297 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
2298 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
2299
2300 @item ar
2301 @item ag
2302 @item ab
2303 @item aa
2304 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
2305 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
2306
2307 Allowed ranges for options are @code{[-2.0, 2.0]}.
2308 @end table
2309
2310 @subsection Examples
2311
2312 @itemize
2313 @item
2314 Convert source to grayscale:
2315 @example
2316 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
2317 @end example
2318 @end itemize
2319
2320 @section colormatrix
2321
2322 Convert color matrix.
2323
2324 The filter accepts the following options:
2325
2326 @table @option
2327 @item src
2328 @item dst
2329 Specify the source and destination color matrix. Both values must be
2330 specified.
2331
2332 The accepted values are:
2333 @table @samp
2334 @item bt709
2335 BT.709
2336
2337 @item bt601
2338 BT.601
2339
2340 @item smpte240m
2341 SMPTE-240M
2342
2343 @item fcc
2344 FCC
2345 @end table
2346 @end table
2347
2348 For example to convert from BT.601 to SMPTE-240M, use the command:
2349 @example
2350 colormatrix=bt601:smpte240m
2351 @end example
2352
2353 @section copy
2354
2355 Copy the input source unchanged to the output. Mainly useful for
2356 testing purposes.
2357
2358 @section crop
2359
2360 Crop the input video to given dimensions.
2361
2362 The filter accepts the following options:
2363
2364 @table @option
2365 @item w, out_w
2366 Width of the output video. It defaults to @code{iw}.
2367 This expression is evaluated only once during the filter
2368 configuration.
2369
2370 @item h, out_h
2371 Height of the output video. It defaults to @code{ih}.
2372 This expression is evaluated only once during the filter
2373 configuration.
2374
2375 @item x
2376 Horizontal position, in the input video, of the left edge of the output video.
2377 It defaults to @code{(in_w-out_w)/2}.
2378 This expression is evaluated per-frame.
2379
2380 @item y
2381 Vertical position, in the input video, of the top edge of the output video.
2382 It defaults to @code{(in_h-out_h)/2}.
2383 This expression is evaluated per-frame.
2384
2385 @item keep_aspect
2386 If set to 1 will force the output display aspect ratio
2387 to be the same of the input, by changing the output sample aspect
2388 ratio. It defaults to 0.
2389 @end table
2390
2391 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
2392 expressions containing the following constants:
2393
2394 @table @option
2395 @item x, y
2396 the computed values for @var{x} and @var{y}. They are evaluated for
2397 each new frame.
2398
2399 @item in_w, in_h
2400 the input width and height
2401
2402 @item iw, ih
2403 same as @var{in_w} and @var{in_h}
2404
2405 @item out_w, out_h
2406 the output (cropped) width and height
2407
2408 @item ow, oh
2409 same as @var{out_w} and @var{out_h}
2410
2411 @item a
2412 same as @var{iw} / @var{ih}
2413
2414 @item sar
2415 input sample aspect ratio
2416
2417 @item dar
2418 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2419
2420 @item hsub, vsub
2421 horizontal and vertical chroma subsample values. For example for the
2422 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2423
2424 @item n
2425 the number of input frame, starting from 0
2426
2427 @item pos
2428 the position in the file of the input frame, NAN if unknown
2429
2430 @item t
2431 timestamp expressed in seconds, NAN if the input timestamp is unknown
2432
2433 @end table
2434
2435 The expression for @var{out_w} may depend on the value of @var{out_h},
2436 and the expression for @var{out_h} may depend on @var{out_w}, but they
2437 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
2438 evaluated after @var{out_w} and @var{out_h}.
2439
2440 The @var{x} and @var{y} parameters specify the expressions for the
2441 position of the top-left corner of the output (non-cropped) area. They
2442 are evaluated for each frame. If the evaluated value is not valid, it
2443 is approximated to the nearest valid value.
2444
2445 The expression for @var{x} may depend on @var{y}, and the expression
2446 for @var{y} may depend on @var{x}.
2447
2448 @subsection Examples
2449
2450 @itemize
2451 @item
2452 Crop area with size 100x100 at position (12,34).
2453 @example
2454 crop=100:100:12:34
2455 @end example
2456
2457 Using named options, the example above becomes:
2458 @example
2459 crop=w=100:h=100:x=12:y=34
2460 @end example
2461
2462 @item
2463 Crop the central input area with size 100x100:
2464 @example
2465 crop=100:100
2466 @end example
2467
2468 @item
2469 Crop the central input area with size 2/3 of the input video:
2470 @example
2471 crop=2/3*in_w:2/3*in_h
2472 @end example
2473
2474 @item
2475 Crop the input video central square:
2476 @example
2477 crop=out_w=in_h
2478 crop=in_h
2479 @end example
2480
2481 @item
2482 Delimit the rectangle with the top-left corner placed at position
2483 100:100 and the right-bottom corner corresponding to the right-bottom
2484 corner of the input image:
2485 @example
2486 crop=in_w-100:in_h-100:100:100
2487 @end example
2488
2489 @item
2490 Crop 10 pixels from the left and right borders, and 20 pixels from
2491 the top and bottom borders
2492 @example
2493 crop=in_w-2*10:in_h-2*20
2494 @end example
2495
2496 @item
2497 Keep only the bottom right quarter of the input image:
2498 @example
2499 crop=in_w/2:in_h/2:in_w/2:in_h/2
2500 @end example
2501
2502 @item
2503 Crop height for getting Greek harmony:
2504 @example
2505 crop=in_w:1/PHI*in_w
2506 @end example
2507
2508 @item
2509 Appply trembling effect:
2510 @example
2511 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)
2512 @end example
2513
2514 @item
2515 Apply erratic camera effect depending on timestamp:
2516 @example
2517 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)"
2518 @end example
2519
2520 @item
2521 Set x depending on the value of y:
2522 @example
2523 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
2524 @end example
2525 @end itemize
2526
2527 @section cropdetect
2528
2529 Auto-detect crop size.
2530
2531 Calculate necessary cropping parameters and prints the recommended
2532 parameters through the logging system. The detected dimensions
2533 correspond to the non-black area of the input video.
2534
2535 The filter accepts the following options:
2536
2537 @table @option
2538
2539 @item limit
2540 Set higher black value threshold, which can be optionally specified
2541 from nothing (0) to everything (255). An intensity value greater
2542 to the set value is considered non-black. Default value is 24.
2543
2544 @item round
2545 Set the value for which the width/height should be divisible by. The
2546 offset is automatically adjusted to center the video. Use 2 to get
2547 only even dimensions (needed for 4:2:2 video). 16 is best when
2548 encoding to most video codecs. Default value is 16.
2549
2550 @item reset_count, reset
2551 Set the counter that determines after how many frames cropdetect will
2552 reset the previously detected largest video area and start over to
2553 detect the current optimal crop area. Default value is 0.
2554
2555 This can be useful when channel logos distort the video area. 0
2556 indicates never reset and return the largest area encountered during
2557 playback.
2558 @end table
2559
2560 @anchor{curves}
2561 @section curves
2562
2563 Apply color adjustments using curves.
2564
2565 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
2566 component (red, green and blue) has its values defined by @var{N} key points
2567 tied from each other using a smooth curve. The x-axis represents the pixel
2568 values from the input frame, and the y-axis the new pixel values to be set for
2569 the output frame.
2570
2571 By default, a component curve is defined by the two points @var{(0;0)} and
2572 @var{(1;1)}. This creates a straight line where each original pixel value is
2573 "adjusted" to its own value, which means no change to the image.
2574
2575 The filter allows you to redefine these two points and add some more. A new
2576 curve (using a natural cubic spline interpolation) will be define to pass
2577 smoothly through all these new coordinates. The new defined points needs to be
2578 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
2579 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
2580 the vector spaces, the values will be clipped accordingly.
2581
2582 If there is no key point defined in @code{x=0}, the filter will automatically
2583 insert a @var{(0;0)} point. In the same way, if there is no key point defined
2584 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
2585
2586 The filter accepts the following options:
2587
2588 @table @option
2589 @item preset
2590 Select one of the available color presets. This option can be used in addition
2591 to the @option{r}, @option{g}, @option{b} parameters; in this case, the later
2592 options takes priority on the preset values.
2593 Available presets are:
2594 @table @samp
2595 @item none
2596 @item color_negative
2597 @item cross_process
2598 @item darker
2599 @item increase_contrast
2600 @item lighter
2601 @item linear_contrast
2602 @item medium_contrast
2603 @item negative
2604 @item strong_contrast
2605 @item vintage
2606 @end table
2607 Default is @code{none}.
2608 @item master, m
2609 Set the master key points. These points will define a second pass mapping. It
2610 is sometimes called a "luminance" or "value" mapping. It can be used with
2611 @option{r}, @option{g}, @option{b} or @option{all} since it acts like a
2612 post-processing LUT.
2613 @item red, r
2614 Set the key points for the red component.
2615 @item green, g
2616 Set the key points for the green component.
2617 @item blue, b
2618 Set the key points for the blue component.
2619 @item all
2620 Set the key points for all components (not including master).
2621 Can be used in addition to the other key points component
2622 options. In this case, the unset component(s) will fallback on this
2623 @option{all} setting.
2624 @item psfile
2625 Specify a Photoshop curves file (@code{.asv}) to import the settings from.
2626 @end table
2627
2628 To avoid some filtergraph syntax conflicts, each key points list need to be
2629 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
2630
2631 @subsection Examples
2632
2633 @itemize
2634 @item
2635 Increase slightly the middle level of blue:
2636 @example
2637 curves=blue='0.5/0.58'
2638 @end example
2639
2640 @item
2641 Vintage effect:
2642 @example
2643 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
2644 @end example
2645 Here we obtain the following coordinates for each components:
2646 @table @var
2647 @item red
2648 @code{(0;0.11) (0.42;0.51) (1;0.95)}
2649 @item green
2650 @code{(0;0) (0.50;0.48) (1;1)}
2651 @item blue
2652 @code{(0;0.22) (0.49;0.44) (1;0.80)}
2653 @end table
2654
2655 @item
2656 The previous example can also be achieved with the associated built-in preset:
2657 @example
2658 curves=preset=vintage
2659 @end example
2660
2661 @item
2662 Or simply:
2663 @example
2664 curves=vintage
2665 @end example
2666
2667 @item
2668 Use a Photoshop preset and redefine the points of the green component:
2669 @example
2670 curves=psfile='MyCurvesPresets/purple.asv':green='0.45/0.53'
2671 @end example
2672 @end itemize
2673
2674 @anchor{decimate}
2675 @section decimate
2676
2677 Drop duplicated frames at regular intervals.
2678
2679 The filter accepts the following options:
2680
2681 @table @option
2682 @item cycle
2683 Set the number of frames from which one will be dropped. Setting this to
2684 @var{N} means one frame in every batch of @var{N} frames will be dropped.
2685 Default is @code{5}.
2686
2687 @item dupthresh
2688 Set the threshold for duplicate detection. If the difference metric for a frame
2689 is less than or equal to this value, then it is declared as duplicate. Default
2690 is @code{1.1}
2691
2692 @item scthresh
2693 Set scene change threshold. Default is @code{15}.
2694
2695 @item blockx
2696 @item blocky
2697 Set the size of the x and y-axis blocks used during metric calculations.
2698 Larger blocks give better noise suppression, but also give worse detection of
2699 small movements. Must be a power of two. Default is @code{32}.
2700
2701 @item ppsrc
2702 Mark main input as a pre-processed input and activate clean source input
2703 stream. This allows the input to be pre-processed with various filters to help
2704 the metrics calculation while keeping the frame selection lossless. When set to
2705 @code{1}, the first stream is for the pre-processed input, and the second
2706 stream is the clean source from where the kept frames are chosen. Default is
2707 @code{0}.
2708
2709 @item chroma
2710 Set whether or not chroma is considered in the metric calculations. Default is
2711 @code{1}.
2712 @end table
2713
2714 @section delogo
2715
2716 Suppress a TV station logo by a simple interpolation of the surrounding
2717 pixels. Just set a rectangle covering the logo and watch it disappear
2718 (and sometimes something even uglier appear - your mileage may vary).
2719
2720 This filter accepts the following options:
2721 @table @option
2722
2723 @item x, y
2724 Specify the top left corner coordinates of the logo. They must be
2725 specified.
2726
2727 @item w, h
2728 Specify the width and height of the logo to clear. They must be
2729 specified.
2730
2731 @item band, t
2732 Specify the thickness of the fuzzy edge of the rectangle (added to
2733 @var{w} and @var{h}). The default value is 4.
2734
2735 @item show
2736 When set to 1, a green rectangle is drawn on the screen to simplify
2737 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
2738 @var{band} is set to 4. The default value is 0.
2739
2740 @end table
2741
2742 @subsection Examples
2743
2744 @itemize
2745 @item
2746 Set a rectangle covering the area with top left corner coordinates 0,0
2747 and size 100x77, setting a band of size 10:
2748 @example
2749 delogo=x=0:y=0:w=100:h=77:band=10
2750 @end example
2751
2752 @end itemize
2753
2754 @section deshake
2755
2756 Attempt to fix small changes in horizontal and/or vertical shift. This
2757 filter helps remove camera shake from hand-holding a camera, bumping a
2758 tripod, moving on a vehicle, etc.
2759
2760 The filter accepts the following options:
2761
2762 @table @option
2763
2764 @item x
2765 @item y
2766 @item w
2767 @item h
2768 Specify a rectangular area where to limit the search for motion
2769 vectors.
2770 If desired the search for motion vectors can be limited to a
2771 rectangular area of the frame defined by its top left corner, width
2772 and height. These parameters have the same meaning as the drawbox
2773 filter which can be used to visualise the position of the bounding
2774 box.
2775
2776 This is useful when simultaneous movement of subjects within the frame
2777 might be confused for camera motion by the motion vector search.
2778
2779 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
2780 then the full frame is used. This allows later options to be set
2781 without specifying the bounding box for the motion vector search.
2782
2783 Default - search the whole frame.
2784
2785 @item rx
2786 @item ry
2787 Specify the maximum extent of movement in x and y directions in the
2788 range 0-64 pixels. Default 16.
2789
2790 @item edge
2791 Specify how to generate pixels to fill blanks at the edge of the
2792 frame. Available values are:
2793 @table @samp
2794 @item blank, 0
2795 Fill zeroes at blank locations
2796 @item original, 1
2797 Original image at blank locations
2798 @item clamp, 2
2799 Extruded edge value at blank locations
2800 @item mirror, 3
2801 Mirrored edge at blank locations
2802 @end table
2803 Default value is @samp{mirror}.
2804
2805 @item blocksize
2806 Specify the blocksize to use for motion search. Range 4-128 pixels,
2807 default 8.
2808
2809 @item contrast
2810 Specify the contrast threshold for blocks. Only blocks with more than
2811 the specified contrast (difference between darkest and lightest
2812 pixels) will be considered. Range 1-255, default 125.
2813
2814 @item search
2815 Specify the search strategy. Available values are:
2816 @table @samp
2817 @item exhaustive, 0
2818 Set exhaustive search
2819 @item less, 1
2820 Set less exhaustive search.
2821 @end table
2822 Default value is @samp{exhaustive}.
2823
2824 @item filename
2825 If set then a detailed log of the motion search is written to the
2826 specified file.
2827
2828 @item opencl
2829 If set to 1, specify using OpenCL capabilities, only available if
2830 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
2831
2832 @end table
2833
2834 @section drawbox
2835
2836 Draw a colored box on the input image.
2837
2838 This filter accepts the following options:
2839
2840 @table @option
2841 @item x, y
2842 Specify the top left corner coordinates of the box. Default to 0.
2843
2844 @item width, w
2845 @item height, h
2846 Specify the width and height of the box, if 0 they are interpreted as
2847 the input width and height. Default to 0.
2848
2849 @item color, c
2850 Specify the color of the box to write, it can be the name of a color
2851 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
2852 value @code{invert} is used, the box edge color is the same as the
2853 video with inverted luma.
2854
2855 @item thickness, t
2856 Set the thickness of the box edge. Default value is @code{4}.
2857 @end table
2858
2859 @subsection Examples
2860
2861 @itemize
2862 @item
2863 Draw a black box around the edge of the input image:
2864 @example
2865 drawbox
2866 @end example
2867
2868 @item
2869 Draw a box with color red and an opacity of 50%:
2870 @example
2871 drawbox=10:20:200:60:red@@0.5
2872 @end example
2873
2874 The previous example can be specified as:
2875 @example
2876 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
2877 @end example
2878
2879 @item
2880 Fill the box with pink color:
2881 @example
2882 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
2883 @end example
2884 @end itemize
2885
2886 @anchor{drawtext}
2887 @section drawtext
2888
2889 Draw text string or text from specified file on top of video using the
2890 libfreetype library.
2891
2892 To enable compilation of this filter you need to configure FFmpeg with
2893 @code{--enable-libfreetype}.
2894
2895 @subsection Syntax
2896
2897 The description of the accepted parameters follows.
2898
2899 @table @option
2900
2901 @item box
2902 Used to draw a box around text using background color.
2903 Value should be either 1 (enable) or 0 (disable).
2904 The default value of @var{box} is 0.
2905
2906 @item boxcolor
2907 The color to be used for drawing box around text.
2908 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
2909 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2910 The default value of @var{boxcolor} is "white".
2911
2912 @item draw
2913 Set an expression which specifies if the text should be drawn. If the
2914 expression evaluates to 0, the text is not drawn. This is useful for
2915 specifying that the text should be drawn only when specific conditions
2916 are met.
2917
2918 Default value is "1".
2919
2920 See below for the list of accepted constants and functions.
2921
2922 @item expansion
2923 Select how the @var{text} is expanded. Can be either @code{none},
2924 @code{strftime} (deprecated) or
2925 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
2926 below for details.
2927
2928 @item fix_bounds
2929 If true, check and fix text coords to avoid clipping.
2930
2931 @item fontcolor
2932 The color to be used for drawing fonts.
2933 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
2934 (e.g. "0xff000033"), possibly followed by an alpha specifier.
2935 The default value of @var{fontcolor} is "black".
2936
2937 @item fontfile
2938 The font file to be used for drawing text. Path must be included.
2939 This parameter is mandatory.
2940
2941 @item fontsize
2942 The font size to be used for drawing text.
2943 The default value of @var{fontsize} is 16.
2944
2945 @item ft_load_flags
2946 Flags to be used for loading the fonts.
2947
2948 The flags map the corresponding flags supported by libfreetype, and are
2949 a combination of the following values:
2950 @table @var
2951 @item default
2952 @item no_scale
2953 @item no_hinting
2954 @item render
2955 @item no_bitmap
2956 @item vertical_layout
2957 @item force_autohint
2958 @item crop_bitmap
2959 @item pedantic
2960 @item ignore_global_advance_width
2961 @item no_recurse
2962 @item ignore_transform
2963 @item monochrome
2964 @item linear_design
2965 @item no_autohint
2966 @end table
2967
2968 Default value is "render".
2969
2970 For more information consult the documentation for the FT_LOAD_*
2971 libfreetype flags.
2972
2973 @item shadowcolor
2974 The color to be used for drawing a shadow behind the drawn text.  It
2975 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
2976 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
2977 The default value of @var{shadowcolor} is "black".
2978
2979 @item shadowx, shadowy
2980 The x and y offsets for the text shadow position with respect to the
2981 position of the text. They can be either positive or negative
2982 values. Default value for both is "0".
2983
2984 @item tabsize
2985 The size in number of spaces to use for rendering the tab.
2986 Default value is 4.
2987
2988 @item timecode
2989 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
2990 format. It can be used with or without text parameter. @var{timecode_rate}
2991 option must be specified.
2992
2993 @item timecode_rate, rate, r
2994 Set the timecode frame rate (timecode only).
2995
2996 @item text
2997 The text string to be drawn. The text must be a sequence of UTF-8
2998 encoded characters.
2999 This parameter is mandatory if no file is specified with the parameter
3000 @var{textfile}.
3001
3002 @item textfile
3003 A text file containing text to be drawn. The text must be a sequence
3004 of UTF-8 encoded characters.
3005
3006 This parameter is mandatory if no text string is specified with the
3007 parameter @var{text}.
3008
3009 If both @var{text} and @var{textfile} are specified, an error is thrown.
3010
3011 @item reload
3012 If set to 1, the @var{textfile} will be reloaded before each frame.
3013 Be sure to update it atomically, or it may be read partially, or even fail.
3014
3015 @item x, y
3016 The expressions which specify the offsets where text will be drawn
3017 within the video frame. They are relative to the top/left border of the
3018 output image.
3019
3020 The default value of @var{x} and @var{y} is "0".
3021
3022 See below for the list of accepted constants and functions.
3023 @end table
3024
3025 The parameters for @var{x} and @var{y} are expressions containing the
3026 following constants and functions:
3027
3028 @table @option
3029 @item dar
3030 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
3031
3032 @item hsub, vsub
3033 horizontal and vertical chroma subsample values. For example for the
3034 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3035
3036 @item line_h, lh
3037 the height of each text line
3038
3039 @item main_h, h, H
3040 the input height
3041
3042 @item main_w, w, W
3043 the input width
3044
3045 @item max_glyph_a, ascent
3046 the maximum distance from the baseline to the highest/upper grid
3047 coordinate used to place a glyph outline point, for all the rendered
3048 glyphs.
3049 It is a positive value, due to the grid's orientation with the Y axis
3050 upwards.
3051
3052 @item max_glyph_d, descent
3053 the maximum distance from the baseline to the lowest grid coordinate
3054 used to place a glyph outline point, for all the rendered glyphs.
3055 This is a negative value, due to the grid's orientation, with the Y axis
3056 upwards.
3057
3058 @item max_glyph_h
3059 maximum glyph height, that is the maximum height for all the glyphs
3060 contained in the rendered text, it is equivalent to @var{ascent} -
3061 @var{descent}.
3062
3063 @item max_glyph_w
3064 maximum glyph width, that is the maximum width for all the glyphs
3065 contained in the rendered text
3066
3067 @item n
3068 the number of input frame, starting from 0
3069
3070 @item rand(min, max)
3071 return a random number included between @var{min} and @var{max}
3072
3073 @item sar
3074 input sample aspect ratio
3075
3076 @item t
3077 timestamp expressed in seconds, NAN if the input timestamp is unknown
3078
3079 @item text_h, th
3080 the height of the rendered text
3081
3082 @item text_w, tw
3083 the width of the rendered text
3084
3085 @item x, y
3086 the x and y offset coordinates where the text is drawn.
3087
3088 These parameters allow the @var{x} and @var{y} expressions to refer
3089 each other, so you can for example specify @code{y=x/dar}.
3090 @end table
3091
3092 If libavfilter was built with @code{--enable-fontconfig}, then
3093 @option{fontfile} can be a fontconfig pattern or omitted.
3094
3095 @anchor{drawtext_expansion}
3096 @subsection Text expansion
3097
3098 If @option{expansion} is set to @code{strftime},
3099 the filter recognizes strftime() sequences in the provided text and
3100 expands them accordingly. Check the documentation of strftime(). This
3101 feature is deprecated.
3102
3103 If @option{expansion} is set to @code{none}, the text is printed verbatim.
3104
3105 If @option{expansion} is set to @code{normal} (which is the default),
3106 the following expansion mechanism is used.
3107
3108 The backslash character '\', followed by any character, always expands to
3109 the second character.
3110
3111 Sequence of the form @code{%@{...@}} are expanded. The text between the
3112 braces is a function name, possibly followed by arguments separated by ':'.
3113 If the arguments contain special characters or delimiters (':' or '@}'),
3114 they should be escaped.
3115
3116 Note that they probably must also be escaped as the value for the
3117 @option{text} option in the filter argument string and as the filter
3118 argument in the filtergraph description, and possibly also for the shell,
3119 that makes up to four levels of escaping; using a text file avoids these
3120 problems.
3121
3122 The following functions are available:
3123
3124 @table @command
3125
3126 @item expr, e
3127 The expression evaluation result.
3128
3129 It must take one argument specifying the expression to be evaluated,
3130 which accepts the same constants and functions as the @var{x} and
3131 @var{y} values. Note that not all constants should be used, for
3132 example the text size is not known when evaluating the expression, so
3133 the constants @var{text_w} and @var{text_h} will have an undefined
3134 value.
3135
3136 @item gmtime
3137 The time at which the filter is running, expressed in UTC.
3138 It can accept an argument: a strftime() format string.
3139
3140 @item localtime
3141 The time at which the filter is running, expressed in the local time zone.
3142 It can accept an argument: a strftime() format string.
3143
3144 @item n, frame_num
3145 The frame number, starting from 0.
3146
3147 @item pict_type
3148 A 1 character description of the current picture type.
3149
3150 @item pts
3151 The timestamp of the current frame, in seconds, with microsecond accuracy.
3152
3153 @end table
3154
3155 @subsection Examples
3156
3157 @itemize
3158 @item
3159 Draw "Test Text" with font FreeSerif, using the default values for the
3160 optional parameters.
3161
3162 @example
3163 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
3164 @end example
3165
3166 @item
3167 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
3168 and y=50 (counting from the top-left corner of the screen), text is
3169 yellow with a red box around it. Both the text and the box have an
3170 opacity of 20%.
3171
3172 @example
3173 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
3174           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
3175 @end example
3176
3177 Note that the double quotes are not necessary if spaces are not used
3178 within the parameter list.
3179
3180 @item
3181 Show the text at the center of the video frame:
3182 @example
3183 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
3184 @end example
3185
3186 @item
3187 Show a text line sliding from right to left in the last row of the video
3188 frame. The file @file{LONG_LINE} is assumed to contain a single line
3189 with no newlines.
3190 @example
3191 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
3192 @end example
3193
3194 @item
3195 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
3196 @example
3197 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
3198 @end example
3199
3200 @item
3201 Draw a single green letter "g", at the center of the input video.
3202 The glyph baseline is placed at half screen height.
3203 @example
3204 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
3205 @end example
3206
3207 @item
3208 Show text for 1 second every 3 seconds:
3209 @example
3210 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
3211 @end example
3212
3213 @item
3214 Use fontconfig to set the font. Note that the colons need to be escaped.
3215 @example
3216 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
3217 @end example
3218
3219 @item
3220 Print the date of a real-time encoding (see strftime(3)):
3221 @example
3222 drawtext='fontfile=FreeSans.ttf:text=%@{localtime:%a %b %d %Y@}'
3223 @end example
3224
3225 @end itemize
3226
3227 For more information about libfreetype, check:
3228 @url{http://www.freetype.org/}.
3229
3230 For more information about fontconfig, check:
3231 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
3232
3233 @section edgedetect
3234
3235 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
3236
3237 The filter accepts the following options:
3238
3239 @table @option
3240 @item low, high
3241 Set low and high threshold values used by the Canny thresholding
3242 algorithm.
3243
3244 The high threshold selects the "strong" edge pixels, which are then
3245 connected through 8-connectivity with the "weak" edge pixels selected
3246 by the low threshold.
3247
3248 @var{low} and @var{high} threshold values must be choosen in the range
3249 [0,1], and @var{low} should be lesser or equal to @var{high}.
3250
3251 Default value for @var{low} is @code{20/255}, and default value for @var{high}
3252 is @code{50/255}.
3253 @end table
3254
3255 Example:
3256 @example
3257 edgedetect=low=0.1:high=0.4
3258 @end example
3259
3260 @section extractplanes
3261
3262 Extract color channel components from input video stream into
3263 separate grayscale video streams.
3264
3265 The filter accepts the following option:
3266
3267 @table @option
3268 @item planes
3269 Set plane(s) to extract.
3270
3271 Available values for planes are:
3272 @table @samp
3273 @item y
3274 @item u
3275 @item v
3276 @item a
3277 @item r
3278 @item g
3279 @item b
3280 @end table
3281
3282 Choosing planes not available in the input will result in an error.
3283 That means you cannot select @code{r}, @code{g}, @code{b} planes
3284 with @code{y}, @code{u}, @code{v} planes at same time.
3285 @end table
3286
3287 @subsection Examples
3288
3289 @itemize
3290 @item
3291 Extract luma, u and v color channel component from input video frame
3292 into 3 grayscale outputs:
3293 @example
3294 ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
3295 @end example
3296 @end itemize
3297
3298 @section fade
3299
3300 Apply fade-in/out effect to input video.
3301
3302 This filter accepts the following options:
3303
3304 @table @option
3305 @item type, t
3306 The effect type -- can be either "in" for fade-in, or "out" for a fade-out
3307 effect.
3308 Default is @code{in}.
3309
3310 @item start_frame, s
3311 Specify the number of the start frame for starting to apply the fade
3312 effect. Default is 0.
3313
3314 @item nb_frames, n
3315 The number of frames for which the fade effect has to last. At the end of the
3316 fade-in effect the output video will have the same intensity as the input video,
3317 at the end of the fade-out transition the output video will be completely black.
3318 Default is 25.
3319
3320 @item alpha
3321 If set to 1, fade only alpha channel, if one exists on the input.
3322 Default value is 0.
3323
3324 @item start_time, st
3325 Specify the timestamp (in seconds) of the frame to start to apply the fade
3326 effect. If both start_frame and start_time are specified, the fade will start at
3327 whichever comes last.  Default is 0.
3328
3329 @item duration, d
3330 The number of seconds for which the fade effect has to last. At the end of the
3331 fade-in effect the output video will have the same intensity as the input video,
3332 at the end of the fade-out transition the output video will be completely black.
3333 If both duration and nb_frames are specified, duration is used. Default is 0.
3334 @end table
3335
3336 @subsection Examples
3337
3338 @itemize
3339 @item
3340 Fade in first 30 frames of video:
3341 @example
3342 fade=in:0:30
3343 @end example
3344
3345 The command above is equivalent to:
3346 @example
3347 fade=t=in:s=0:n=30
3348 @end example
3349
3350 @item
3351 Fade out last 45 frames of a 200-frame video:
3352 @example
3353 fade=out:155:45
3354 fade=type=out:start_frame=155:nb_frames=45
3355 @end example
3356
3357 @item
3358 Fade in first 25 frames and fade out last 25 frames of a 1000-frame video:
3359 @example
3360 fade=in:0:25, fade=out:975:25
3361 @end example
3362
3363 @item
3364 Make first 5 frames black, then fade in from frame 5-24:
3365 @example
3366 fade=in:5:20
3367 @end example
3368
3369 @item
3370 Fade in alpha over first 25 frames of video:
3371 @example
3372 fade=in:0:25:alpha=1
3373 @end example
3374
3375 @item
3376 Make first 5.5 seconds black, then fade in for 0.5 seconds:
3377 @example
3378 fade=t=in:st=5.5:d=0.5
3379 @end example
3380
3381 @end itemize
3382
3383 @section field
3384
3385 Extract a single field from an interlaced image using stride
3386 arithmetic to avoid wasting CPU time. The output frames are marked as
3387 non-interlaced.
3388
3389 The filter accepts the following options:
3390
3391 @table @option
3392 @item type
3393 Specify whether to extract the top (if the value is @code{0} or
3394 @code{top}) or the bottom field (if the value is @code{1} or
3395 @code{bottom}).
3396 @end table
3397
3398 @section fieldmatch
3399
3400 Field matching filter for inverse telecine. It is meant to reconstruct the
3401 progressive frames from a telecined stream. The filter does not drop duplicated
3402 frames, so to achieve a complete inverse telecine @code{fieldmatch} needs to be
3403 followed by a decimation filter such as @ref{decimate} in the filtergraph.
3404
3405 The separation of the field matching and the decimation is notably motivated by
3406 the possibility of inserting a de-interlacing filter fallback between the two.
3407 If the source has mixed telecined and real interlaced content,
3408 @code{fieldmatch} will not be able to match fields for the interlaced parts.
3409 But these remaining combed frames will be marked as interlaced, and thus can be
3410 de-interlaced by a later filter such as @ref{yadif} before decimation.
3411
3412 In addition to the various configuration options, @code{fieldmatch} can take an
3413 optional second stream, activated through the @option{ppsrc} option. If
3414 enabled, the frames reconstruction will be based on the fields and frames from
3415 this second stream. This allows the first input to be pre-processed in order to
3416 help the various algorithms of the filter, while keeping the output lossless
3417 (assuming the fields are matched properly). Typically, a field-aware denoiser,
3418 or brightness/contrast adjustments can help.
3419
3420 Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project)
3421 and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from
3422 which @code{fieldmatch} is based on. While the semantic and usage are very
3423 close, some behaviour and options names can differ.
3424
3425 The filter accepts the following options:
3426
3427 @table @option
3428 @item order
3429 Specify the assumed field order of the input stream. Available values are:
3430
3431 @table @samp
3432 @item auto
3433 Auto detect parity (use FFmpeg's internal parity value).
3434 @item bff
3435 Assume bottom field first.
3436 @item tff
3437 Assume top field first.
3438 @end table
3439
3440 Note that it is sometimes recommended not to trust the parity announced by the
3441 stream.
3442
3443 Default value is @var{auto}.
3444
3445 @item mode
3446 Set the matching mode or strategy to use. @option{pc} mode is the safest in the
3447 sense that it wont risk creating jerkiness due to duplicate frames when
3448 possible, but if there are bad edits or blended fields it will end up
3449 outputting combed frames when a good match might actually exist. On the other
3450 hand, @option{pcn_ub} mode is the most risky in terms of creating jerkiness,
3451 but will almost always find a good frame if there is one. The other values are
3452 all somewhere in between @option{pc} and @option{pcn_ub} in terms of risking
3453 jerkiness and creating duplicate frames versus finding good matches in sections
3454 with bad edits, orphaned fields, blended fields, etc.
3455
3456 More details about p/c/n/u/b are available in @ref{p/c/n/u/b meaning} section.
3457
3458 Available values are:
3459
3460 @table @samp
3461 @item pc
3462 2-way matching (p/c)
3463 @item pc_n
3464 2-way matching, and trying 3rd match if still combed (p/c + n)
3465 @item pc_u
3466 2-way matching, and trying 3rd match (same order) if still combed (p/c + u)
3467 @item pc_n_ub
3468 2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if
3469 still combed (p/c + n + u/b)
3470 @item pcn
3471 3-way matching (p/c/n)
3472 @item pcn_ub
3473 3-way matching, and trying 4th/5th matches if all 3 of the original matches are
3474 detected as combed (p/c/n + u/b)
3475 @end table
3476
3477 The parenthesis at the end indicate the matches that would be used for that
3478 mode assuming @option{order}=@var{tff} (and @option{field} on @var{auto} or
3479 @var{top}).
3480
3481 In terms of speed @option{pc} mode is by far the fastest and @option{pcn_ub} is
3482 the slowest.
3483
3484 Default value is @var{pc_n}.
3485
3486 @item ppsrc
3487 Mark the main input stream as a pre-processed input, and enable the secondary
3488 input stream as the clean source to pick the fields from. See the filter
3489 introduction for more details. It is similar to the @option{clip2} feature from
3490 VFM/TFM.
3491
3492 Default value is @code{0} (disabled).
3493
3494 @item field
3495 Set the field to match from. It is recommended to set this to the same value as
3496 @option{order} unless you experience matching failures with that setting. In
3497 certain circumstances changing the field that is used to match from can have a
3498 large impact on matching performance. Available values are:
3499
3500 @table @samp
3501 @item auto
3502 Automatic (same value as @option{order}).
3503 @item bottom
3504 Match from the bottom field.
3505 @item top
3506 Match from the top field.
3507 @end table
3508
3509 Default value is @var{auto}.
3510
3511 @item mchroma
3512 Set whether or not chroma is included during the match comparisons. In most
3513 cases it is recommended to leave this enabled. You should set this to @code{0}
3514 only if your clip has bad chroma problems such as heavy rainbowing or other
3515 artifacts. Setting this to @code{0} could also be used to speed things up at
3516 the cost of some accuracy.
3517
3518 Default value is @code{1}.
3519
3520 @item y0
3521 @item y1
3522 These define an exclusion band which excludes the lines between @option{y0} and
3523 @option{y1} from being included in the field matching decision. An exclusion
3524 band can be used to ignore subtitles, a logo, or other things that may
3525 interfere with the matching. @option{y0} sets the starting scan line and
3526 @option{y1} sets the ending line; all lines in between @option{y0} and
3527 @option{y1} (including @option{y0} and @option{y1}) will be ignored. Setting
3528 @option{y0} and @option{y1} to the same value will disable the feature.
3529 @option{y0} and @option{y1} defaults to @code{0}.
3530
3531 @item scthresh
3532 Set the scene change detection threshold as a percentage of maximum change on
3533 the luma plane. Good values are in the @code{[8.0, 14.0]} range. Scene change
3534 detection is only relevant in case @option{combmatch}=@var{sc}.  The range for
3535 @option{scthresh} is @code{[0.0, 100.0]}.
3536
3537 Default value is @code{12.0}.
3538
3539 @item combmatch
3540 When @option{combatch} is not @var{none}, @code{fieldmatch} will take into
3541 account the combed scores of matches when deciding what match to use as the
3542 final match. Available values are:
3543
3544 @table @samp
3545 @item none
3546 No final matching based on combed scores.
3547 @item sc
3548 Combed scores are only used when a scene change is detected.
3549 @item full
3550 Use combed scores all the time.
3551 @end table
3552
3553 Default is @var{sc}.
3554
3555 @item combdbg
3556 Force @code{fieldmatch} to calculate the combed metrics for certain matches and
3557 print them. This setting is known as @option{micout} in TFM/VFM vocabulary.
3558 Available values are:
3559
3560 @table @samp
3561 @item none
3562 No forced calculation.
3563 @item pcn
3564 Force p/c/n calculations.
3565 @item pcnub
3566 Force p/c/n/u/b calculations.
3567 @end table
3568
3569 Default value is @var{none}.
3570
3571 @item cthresh
3572 This is the area combing threshold used for combed frame detection. This
3573 essentially controls how "strong" or "visible" combing must be to be detected.
3574 Larger values mean combing must be more visible and smaller values mean combing
3575 can be less visible or strong and still be detected. Valid settings are from
3576 @code{-1} (every pixel will be detected as combed) to @code{255} (no pixel will
3577 be detected as combed). This is basically a pixel difference value. A good
3578 range is @code{[8, 12]}.
3579
3580 Default value is @code{9}.
3581
3582 @item chroma
3583 Sets whether or not chroma is considered in the combed frame decision.  Only
3584 disable this if your source has chroma problems (rainbowing, etc.) that are
3585 causing problems for the combed frame detection with chroma enabled. Actually,
3586 using @option{chroma}=@var{0} is usually more reliable, except for the case
3587 where there is chroma only combing in the source.
3588
3589 Default value is @code{0}.
3590
3591 @item blockx
3592 @item blocky
3593 Respectively set the x-axis and y-axis size of the window used during combed
3594 frame detection. This has to do with the size of the area in which
3595 @option{combpel} pixels are required to be detected as combed for a frame to be
3596 declared combed. See the @option{combpel} parameter description for more info.
3597 Possible values are any number that is a power of 2 starting at 4 and going up
3598 to 512.
3599
3600 Default value is @code{16}.
3601
3602 @item combpel
3603 The number of combed pixels inside any of the @option{blocky} by
3604 @option{blockx} size blocks on the frame for the frame to be detected as
3605 combed. While @option{cthresh} controls how "visible" the combing must be, this
3606 setting controls "how much" combing there must be in any localized area (a
3607 window defined by the @option{blockx} and @option{blocky} settings) on the
3608 frame. Minimum value is @code{0} and maximum is @code{blocky x blockx} (at
3609 which point no frames will ever be detected as combed). This setting is known
3610 as @option{MI} in TFM/VFM vocabulary.
3611
3612 Default value is @code{80}.
3613 @end table
3614
3615 @anchor{p/c/n/u/b meaning}
3616 @subsection p/c/n/u/b meaning
3617
3618 @subsubsection p/c/n
3619
3620 We assume the following telecined stream:
3621
3622 @example
3623 Top fields:     1 2 2 3 4
3624 Bottom fields:  1 2 3 4 4
3625 @end example
3626
3627 The numbers correspond to the progressive frame the fields relate to. Here, the
3628 first two frames are progressive, the 3rd and 4th are combed, and so on.
3629
3630 When @code{fieldmatch} is configured to run a matching from bottom
3631 (@option{field}=@var{bottom}) this is how this input stream get transformed:
3632
3633 @example
3634 Input stream:
3635                 T     1 2 2 3 4
3636                 B     1 2 3 4 4   <-- matching reference
3637
3638 Matches:              c c n n c
3639
3640 Output stream:
3641                 T     1 2 3 4 4
3642                 B     1 2 3 4 4
3643 @end example
3644
3645 As a result of the field matching, we can see that some frames get duplicated.
3646 To perform a complete inverse telecine, you need to rely on a decimation filter
3647 after this operation. See for instance the @ref{decimate} filter.
3648
3649 The same operation now matching from top fields (@option{field}=@var{top})
3650 looks like this:
3651
3652 @example
3653 Input stream:
3654                 T     1 2 2 3 4   <-- matching reference
3655                 B     1 2 3 4 4
3656
3657 Matches:              c c p p c
3658
3659 Output stream:
3660                 T     1 2 2 3 4
3661                 B     1 2 2 3 4
3662 @end example
3663
3664 In these examples, we can see what @var{p}, @var{c} and @var{n} mean;
3665 basically, they refer to the frame and field of the opposite parity:
3666
3667 @itemize
3668 @item @var{p} matches the field of the opposite parity in the previous frame
3669 @item @var{c} matches the field of the opposite parity in the current frame
3670 @item @var{n} matches the field of the opposite parity in the next frame
3671 @end itemize
3672
3673 @subsubsection u/b
3674
3675 The @var{u} and @var{b} matching are a bit special in the sense that they match
3676 from the opposite parity flag. In the following examples, we assume that we are
3677 currently matching the 2nd frame (Top:2, bottom:2). According to the match, a
3678 'x' is placed above and below each matched fields.
3679
3680 With bottom matching (@option{field}=@var{bottom}):
3681 @example
3682 Match:           c         p           n          b          u
3683
3684                  x       x               x        x          x
3685   Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
3686   Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
3687                  x         x           x        x              x
3688
3689 Output frames:
3690                  2          1          2          2          2
3691                  2          2          2          1          3
3692 @end example
3693
3694 With top matching (@option{field}=@var{top}):
3695 @example
3696 Match:           c         p           n          b          u
3697
3698                  x         x           x        x              x
3699   Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
3700   Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
3701                  x       x               x        x          x
3702
3703 Output frames:
3704                  2          2          2          1          2
3705                  2          1          3          2          2
3706 @end example
3707
3708 @subsection Examples
3709
3710 Simple IVTC of a top field first telecined stream:
3711 @example
3712 fieldmatch=order=tff:combmatch=none, decimate
3713 @end example
3714
3715 Advanced IVTC, with fallback on @ref{yadif} for still combed frames:
3716 @example
3717 fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
3718 @end example
3719
3720 @section fieldorder
3721
3722 Transform the field order of the input video.
3723
3724 This filter accepts the following options:
3725
3726 @table @option
3727
3728 @item order
3729 Output field order. Valid values are @var{tff} for top field first or @var{bff}
3730 for bottom field first.
3731 @end table
3732
3733 Default value is @samp{tff}.
3734
3735 Transformation is achieved by shifting the picture content up or down
3736 by one line, and filling the remaining line with appropriate picture content.
3737 This method is consistent with most broadcast field order converters.
3738
3739 If the input video is not flagged as being interlaced, or it is already
3740 flagged as being of the required output field order then this filter does
3741 not alter the incoming video.
3742
3743 This filter is very useful when converting to or from PAL DV material,
3744 which is bottom field first.
3745
3746 For example:
3747 @example
3748 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
3749 @end example
3750
3751 @section fifo
3752
3753 Buffer input images and send them when they are requested.
3754
3755 This filter is mainly useful when auto-inserted by the libavfilter
3756 framework.
3757
3758 The filter does not take parameters.
3759
3760 @anchor{format}
3761 @section format
3762
3763 Convert the input video to one of the specified pixel formats.
3764 Libavfilter will try to pick one that is supported for the input to
3765 the next filter.
3766
3767 This filter accepts the following parameters:
3768 @table @option
3769
3770 @item pix_fmts
3771 A '|'-separated list of pixel format names, for example
3772 "pix_fmts=yuv420p|monow|rgb24".
3773
3774 @end table
3775
3776 @subsection Examples
3777
3778 @itemize
3779 @item
3780 Convert the input video to the format @var{yuv420p}
3781 @example
3782 format=pix_fmts=yuv420p
3783 @end example
3784
3785 Convert the input video to any of the formats in the list
3786 @example
3787 format=pix_fmts=yuv420p|yuv444p|yuv410p
3788 @end example
3789 @end itemize
3790
3791 @section fps
3792
3793 Convert the video to specified constant frame rate by duplicating or dropping
3794 frames as necessary.
3795
3796 This filter accepts the following named parameters:
3797 @table @option
3798
3799 @item fps
3800 Desired output frame rate. The default is @code{25}.
3801
3802 @item round
3803 Rounding method.
3804
3805 Possible values are:
3806 @table @option
3807 @item zero
3808 zero round towards 0
3809 @item inf
3810 round away from 0
3811 @item down
3812 round towards -infinity
3813 @item up
3814 round towards +infinity
3815 @item near
3816 round to nearest
3817 @end table
3818 The default is @code{near}.
3819
3820 @end table
3821
3822 Alternatively, the options can be specified as a flat string:
3823 @var{fps}[:@var{round}].
3824
3825 See also the @ref{setpts} filter.
3826
3827 @section framestep
3828
3829 Select one frame every N-th frame.
3830
3831 This filter accepts the following option:
3832 @table @option
3833 @item step
3834 Select frame after every @code{step} frames.
3835 Allowed values are positive integers higher than 0. Default value is @code{1}.
3836 @end table
3837
3838 @anchor{frei0r}
3839 @section frei0r
3840
3841 Apply a frei0r effect to the input video.
3842
3843 To enable compilation of this filter you need to install the frei0r
3844 header and configure FFmpeg with @code{--enable-frei0r}.
3845
3846 This filter accepts the following options:
3847
3848 @table @option
3849
3850 @item filter_name
3851 The name to the frei0r effect to load. If the environment variable
3852 @env{FREI0R_PATH} is defined, the frei0r effect is searched in each one of the
3853 directories specified by the colon separated list in @env{FREIOR_PATH},
3854 otherwise in the standard frei0r paths, which are in this order:
3855 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
3856 @file{/usr/lib/frei0r-1/}.
3857
3858 @item filter_params
3859 A '|'-separated list of parameters to pass to the frei0r effect.
3860
3861 @end table
3862
3863 A frei0r effect parameter can be a boolean (whose values are specified
3864 with "y" and "n"), a double, a color (specified by the syntax
3865 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
3866 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
3867 description), a position (specified by the syntax @var{X}/@var{Y},
3868 @var{X} and @var{Y} being float numbers) and a string.
3869
3870 The number and kind of parameters depend on the loaded effect. If an
3871 effect parameter is not specified the default value is set.
3872
3873 @subsection Examples
3874
3875 @itemize
3876 @item
3877 Apply the distort0r effect, set the first two double parameters:
3878 @example
3879 frei0r=filter_name=distort0r:filter_params=0.5|0.01
3880 @end example
3881
3882 @item
3883 Apply the colordistance effect, take a color as first parameter:
3884 @example
3885 frei0r=colordistance:0.2/0.3/0.4
3886 frei0r=colordistance:violet
3887 frei0r=colordistance:0x112233
3888 @end example
3889
3890 @item
3891 Apply the perspective effect, specify the top left and top right image
3892 positions:
3893 @example
3894 frei0r=perspective:0.2/0.2|0.8/0.2
3895 @end example
3896 @end itemize
3897
3898 For more information see:
3899 @url{http://frei0r.dyne.org}
3900
3901 @section geq
3902
3903 The filter accepts the following options:
3904
3905 @table @option
3906 @item lum_expr
3907 the luminance expression
3908 @item cb_expr
3909 the chrominance blue expression
3910 @item cr_expr
3911 the chrominance red expression
3912 @item alpha_expr
3913 the alpha expression
3914 @item r
3915 the red expression
3916 @item g
3917 the green expression
3918 @item b
3919 the blue expression
3920 @end table
3921
3922 If one of the chrominance expression is not defined, it falls back on the other
3923 one. If no alpha expression is specified it will evaluate to opaque value.
3924 If none of chrominance expressions are
3925 specified, they will evaluate the luminance expression.
3926
3927 The expressions can use the following variables and functions:
3928
3929 @table @option
3930 @item N
3931 The sequential number of the filtered frame, starting from @code{0}.
3932
3933 @item X
3934 @item Y
3935 The coordinates of the current sample.
3936
3937 @item W
3938 @item H
3939 The width and height of the image.
3940
3941 @item SW
3942 @item SH
3943 Width and height scale depending on the currently filtered plane. It is the
3944 ratio between the corresponding luma plane number of pixels and the current
3945 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
3946 @code{0.5,0.5} for chroma planes.
3947
3948 @item T
3949 Time of the current frame, expressed in seconds.
3950
3951 @item p(x, y)
3952 Return the value of the pixel at location (@var{x},@var{y}) of the current
3953 plane.
3954
3955 @item lum(x, y)
3956 Return the value of the pixel at location (@var{x},@var{y}) of the luminance
3957 plane.
3958
3959 @item cb(x, y)
3960 Return the value of the pixel at location (@var{x},@var{y}) of the
3961 blue-difference chroma plane. Returns 0 if there is no such plane.
3962
3963 @item cr(x, y)
3964 Return the value of the pixel at location (@var{x},@var{y}) of the
3965 red-difference chroma plane. Returns 0 if there is no such plane.
3966
3967 @item alpha(x, y)
3968 Return the value of the pixel at location (@var{x},@var{y}) of the alpha
3969 plane. Returns 0 if there is no such plane.
3970 @end table
3971
3972 For functions, if @var{x} and @var{y} are outside the area, the value will be
3973 automatically clipped to the closer edge.
3974
3975 @subsection Examples
3976
3977 @itemize
3978 @item
3979 Flip the image horizontally:
3980 @example
3981 geq=p(W-X\,Y)
3982 @end example
3983
3984 @item
3985 Generate a bidimensional sine wave, with angle @code{PI/3} and a
3986 wavelength of 100 pixels:
3987 @example
3988 geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
3989 @end example
3990
3991 @item
3992 Generate a fancy enigmatic moving light:
3993 @example
3994 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
3995 @end example
3996
3997 @item
3998 Generate a quick emboss effect:
3999 @example
4000 format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
4001 @end example
4002 @end itemize
4003
4004 @section gradfun
4005
4006 Fix the banding artifacts that are sometimes introduced into nearly flat
4007 regions by truncation to 8bit color depth.
4008 Interpolate the gradients that should go where the bands are, and
4009 dither them.
4010
4011 This filter is designed for playback only.  Do not use it prior to
4012 lossy compression, because compression tends to lose the dither and
4013 bring back the bands.
4014
4015 This filter accepts the following options:
4016
4017 @table @option
4018
4019 @item strength
4020 The maximum amount by which the filter will change any one pixel. Also the
4021 threshold for detecting nearly flat regions. Acceptable values range from .51 to
4022 64, default value is 1.2, out-of-range values will be clipped to the valid
4023 range.
4024
4025 @item radius
4026 The neighborhood to fit the gradient to. A larger radius makes for smoother
4027 gradients, but also prevents the filter from modifying the pixels near detailed
4028 regions. Acceptable values are 8-32, default value is 16, out-of-range values
4029 will be clipped to the valid range.
4030
4031 @end table
4032
4033 Alternatively, the options can be specified as a flat string:
4034 @var{strength}[:@var{radius}]
4035
4036 @subsection Examples
4037
4038 @itemize
4039 @item
4040 Apply the filter with a @code{3.5} strength and radius of @code{8}:
4041 @example
4042 gradfun=3.5:8
4043 @end example
4044
4045 @item
4046 Specify radius, omitting the strength (which will fall-back to the default
4047 value):
4048 @example
4049 gradfun=radius=8
4050 @end example
4051
4052 @end itemize
4053
4054 @section hflip
4055
4056 Flip the input video horizontally.
4057
4058 For example to horizontally flip the input video with @command{ffmpeg}:
4059 @example
4060 ffmpeg -i in.avi -vf "hflip" out.avi
4061 @end example
4062
4063 @section histeq
4064 This filter applies a global color histogram equalization on a
4065 per-frame basis.
4066
4067 It can be used to correct video that has a compressed range of pixel
4068 intensities.  The filter redistributes the pixel intensities to
4069 equalize their distribution across the intensity range. It may be
4070 viewed as an "automatically adjusting contrast filter". This filter is
4071 useful only for correcting degraded or poorly captured source
4072 video.
4073
4074 The filter accepts the following options:
4075
4076 @table @option
4077 @item strength
4078 Determine the amount of equalization to be applied.  As the strength
4079 is reduced, the distribution of pixel intensities more-and-more
4080 approaches that of the input frame. The value must be a float number
4081 in the range [0,1] and defaults to 0.200.
4082
4083 @item intensity
4084 Set the maximum intensity that can generated and scale the output
4085 values appropriately.  The strength should be set as desired and then
4086 the intensity can be limited if needed to avoid washing-out. The value
4087 must be a float number in the range [0,1] and defaults to 0.210.
4088
4089 @item antibanding
4090 Set the antibanding level. If enabled the filter will randomly vary
4091 the luminance of output pixels by a small amount to avoid banding of
4092 the histogram. Possible values are @code{none}, @code{weak} or
4093 @code{strong}. It defaults to @code{none}.
4094 @end table
4095
4096 @section histogram
4097
4098 Compute and draw a color distribution histogram for the input video.
4099
4100 The computed histogram is a representation of distribution of color components
4101 in an image.
4102
4103 The filter accepts the following options:
4104
4105 @table @option
4106 @item mode
4107 Set histogram mode.
4108
4109 It accepts the following values:
4110 @table @samp
4111 @item levels
4112 standard histogram that display color components distribution in an image.
4113 Displays color graph for each color component. Shows distribution
4114 of the Y, U, V, A or G, B, R components, depending on input format,
4115 in current frame. Bellow each graph is color component scale meter.
4116
4117 @item color
4118 chroma values in vectorscope, if brighter more such chroma values are
4119 distributed in an image.
4120 Displays chroma values (U/V color placement) in two dimensional graph
4121 (which is called a vectorscope). It can be used to read of the hue and
4122 saturation of the current frame. At a same time it is a histogram.
4123 The whiter a pixel in the vectorscope, the more pixels of the input frame
4124 correspond to that pixel (that is the more pixels have this chroma value).
4125 The V component is displayed on the horizontal (X) axis, with the leftmost
4126 side being V = 0 and the rightmost side being V = 255.
4127 The U component is displayed on the vertical (Y) axis, with the top
4128 representing U = 0 and the bottom representing U = 255.
4129
4130 The position of a white pixel in the graph corresponds to the chroma value
4131 of a pixel of the input clip. So the graph can be used to read of the
4132 hue (color flavor) and the saturation (the dominance of the hue in the color).
4133 As the hue of a color changes, it moves around the square. At the center of
4134 the square, the saturation is zero, which means that the corresponding pixel
4135 has no color. If you increase the amount of a specific color, while leaving
4136 the other colors unchanged, the saturation increases, and you move towards
4137 the edge of the square.
4138
4139 @item color2
4140 chroma values in vectorscope, similar as @code{color} but actual chroma values
4141 are displayed.
4142
4143 @item waveform
4144 per row/column color component graph. In row mode graph in the left side represents
4145 color component value 0 and right side represents value = 255. In column mode top
4146 side represents color component value = 0 and bottom side represents value = 255.
4147 @end table
4148 Default value is @code{levels}.
4149
4150 @item level_height
4151 Set height of level in @code{levels}. Default value is @code{200}.
4152 Allowed range is [50, 2048].
4153
4154 @item scale_height
4155 Set height of color scale in @code{levels}. Default value is @code{12}.
4156 Allowed range is [0, 40].
4157
4158 @item step
4159 Set step for @code{waveform} mode. Smaller values are useful to find out how much
4160 of same luminance values across input rows/columns are distributed.
4161 Default value is @code{10}. Allowed range is [1, 255].
4162
4163 @item waveform_mode
4164 Set mode for @code{waveform}. Can be either @code{row}, or @code{column}.
4165 Default is @code{row}.
4166
4167 @item display_mode
4168 Set display mode for @code{waveform} and @code{levels}.
4169 It accepts the following values:
4170 @table @samp
4171 @item parade
4172 Display separate graph for the color components side by side in
4173 @code{row} waveform mode or one below other in @code{column} waveform mode
4174 for @code{waveform} histogram mode. For @code{levels} histogram mode
4175 per color component graphs are placed one bellow other.
4176
4177 This display mode in @code{waveform} histogram mode makes it easy to spot
4178 color casts in the highlights and shadows of an image, by comparing the
4179 contours of the top and the bottom of each waveform.
4180 Since whites, grays, and blacks are characterized by
4181 exactly equal amounts of red, green, and blue, neutral areas of the
4182 picture should display three waveforms of roughly equal width/height.
4183 If not, the correction is easy to make by making adjustments to level the
4184 three waveforms.
4185
4186 @item overlay
4187 Presents information that's identical to that in the @code{parade}, except
4188 that the graphs representing color components are superimposed directly
4189 over one another.
4190
4191 This display mode in @code{waveform} histogram mode can make it easier to spot
4192 the relative differences or similarities in overlapping areas of the color
4193 components that are supposed to be identical, such as neutral whites, grays,
4194 or blacks.
4195 @end table
4196 Default is @code{parade}.
4197 @end table
4198
4199 @subsection Examples
4200
4201 @itemize
4202
4203 @item
4204 Calculate and draw histogram:
4205 @example
4206 ffplay -i input -vf histogram
4207 @end example
4208
4209 @end itemize
4210
4211 @anchor{hqdn3d}
4212 @section hqdn3d
4213
4214 High precision/quality 3d denoise filter. This filter aims to reduce
4215 image noise producing smooth images and making still images really
4216 still. It should enhance compressibility.
4217
4218 It accepts the following optional parameters:
4219
4220 @table @option
4221 @item luma_spatial
4222 a non-negative float number which specifies spatial luma strength,
4223 defaults to 4.0
4224
4225 @item chroma_spatial
4226 a non-negative float number which specifies spatial chroma strength,
4227 defaults to 3.0*@var{luma_spatial}/4.0
4228
4229 @item luma_tmp
4230 a float number which specifies luma temporal strength, defaults to
4231 6.0*@var{luma_spatial}/4.0
4232
4233 @item chroma_tmp
4234 a float number which specifies chroma temporal strength, defaults to
4235 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
4236 @end table
4237
4238 @section hue
4239
4240 Modify the hue and/or the saturation of the input.
4241
4242 This filter accepts the following options:
4243
4244 @table @option
4245 @item h
4246 Specify the hue angle as a number of degrees. It accepts an expression,
4247 and defaults to "0".
4248
4249 @item s
4250 Specify the saturation in the [-10,10] range. It accepts an expression and
4251 defaults to "1".
4252
4253 @item H
4254 Specify the hue angle as a number of radians. It accepts an
4255 expression, and defaults to "0".
4256 @end table
4257
4258 @option{h} and @option{H} are mutually exclusive, and can't be
4259 specified at the same time.
4260
4261 The @option{h}, @option{H} and @option{s} option values are
4262 expressions containing the following constants:
4263
4264 @table @option
4265 @item n
4266 frame count of the input frame starting from 0
4267
4268 @item pts
4269 presentation timestamp of the input frame expressed in time base units
4270
4271 @item r
4272 frame rate of the input video, NAN if the input frame rate is unknown
4273
4274 @item t
4275 timestamp expressed in seconds, NAN if the input timestamp is unknown
4276
4277 @item tb
4278 time base of the input video
4279 @end table
4280
4281 @subsection Examples
4282
4283 @itemize
4284 @item
4285 Set the hue to 90 degrees and the saturation to 1.0:
4286 @example
4287 hue=h=90:s=1
4288 @end example
4289
4290 @item
4291 Same command but expressing the hue in radians:
4292 @example
4293 hue=H=PI/2:s=1
4294 @end example
4295
4296 @item
4297 Rotate hue and make the saturation swing between 0
4298 and 2 over a period of 1 second:
4299 @example
4300 hue="H=2*PI*t: s=sin(2*PI*t)+1"
4301 @end example
4302
4303 @item
4304 Apply a 3 seconds saturation fade-in effect starting at 0:
4305 @example
4306 hue="s=min(t/3\,1)"
4307 @end example
4308
4309 The general fade-in expression can be written as:
4310 @example
4311 hue="s=min(0\, max((t-START)/DURATION\, 1))"
4312 @end example
4313
4314 @item
4315 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
4316 @example
4317 hue="s=max(0\, min(1\, (8-t)/3))"
4318 @end example
4319
4320 The general fade-out expression can be written as:
4321 @example
4322 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
4323 @end example
4324
4325 @end itemize
4326
4327 @subsection Commands
4328
4329 This filter supports the following commands:
4330 @table @option
4331 @item s
4332 @item h
4333 @item H
4334 Modify the hue and/or the saturation of the input video.
4335 The command accepts the same syntax of the corresponding option.
4336
4337 If the specified expression is not valid, it is kept at its current
4338 value.
4339 @end table
4340
4341 @section idet
4342
4343 Detect video interlacing type.
4344
4345 This filter tries to detect if the input is interlaced or progressive,
4346 top or bottom field first.
4347
4348 The filter accepts the following options:
4349
4350 @table @option
4351 @item intl_thres
4352 Set interlacing threshold.
4353 @item prog_thres
4354 Set progressive threshold.
4355 @end table
4356
4357 @section il
4358
4359 Deinterleave or interleave fields.
4360
4361 This filter allows to process interlaced images fields without
4362 deinterlacing them. Deinterleaving splits the input frame into 2
4363 fields (so called half pictures). Odd lines are moved to the top
4364 half of the output image, even lines to the bottom half.
4365 You can process (filter) them independently and then re-interleave them.
4366
4367 The filter accepts the following options:
4368
4369 @table @option
4370 @item luma_mode, l
4371 @item chroma_mode, s
4372 @item alpha_mode, a
4373 Available values for @var{luma_mode}, @var{chroma_mode} and
4374 @var{alpha_mode} are:
4375
4376 @table @samp
4377 @item none
4378 Do nothing.
4379
4380 @item deinterleave, d
4381 Deinterleave fields, placing one above the other.
4382
4383 @item interleave, i
4384 Interleave fields. Reverse the effect of deinterleaving.
4385 @end table
4386 Default value is @code{none}.
4387
4388 @item luma_swap, ls
4389 @item chroma_swap, cs
4390 @item alpha_swap, as
4391 Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is @code{0}.
4392 @end table
4393
4394 @section interlace
4395
4396 Simple interlacing filter from progressive contents. This interleaves upper (or
4397 lower) lines from odd frames with lower (or upper) lines from even frames,
4398 halving the frame rate and preserving image height.
4399
4400 @example
4401    Original        Original             New Frame
4402    Frame 'j'      Frame 'j+1'             (tff)
4403   ==========      ===========       ==================
4404     Line 0  -------------------->    Frame 'j' Line 0
4405     Line 1          Line 1  ---->   Frame 'j+1' Line 1
4406     Line 2 --------------------->    Frame 'j' Line 2
4407     Line 3          Line 3  ---->   Frame 'j+1' Line 3
4408      ...             ...                   ...
4409 New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
4410 @end example
4411
4412 It accepts the following optional parameters:
4413
4414 @table @option
4415 @item scan
4416 determines whether the interlaced frame is taken from the even (tff - default)
4417 or odd (bff) lines of the progressive frame.
4418
4419 @item lowpass
4420 Enable (default) or disable the vertical lowpass filter to avoid twitter
4421 interlacing and reduce moire patterns.
4422 @end table
4423
4424 @section kerndeint
4425
4426 Deinterlace input video by applying Donald Graft's adaptive kernel
4427 deinterling. Work on interlaced parts of a video to produce
4428 progressive frames.
4429
4430 The description of the accepted parameters follows.
4431
4432 @table @option
4433 @item thresh
4434 Set the threshold which affects the filter's tolerance when
4435 determining if a pixel line must be processed. It must be an integer
4436 in the range [0,255] and defaults to 10. A value of 0 will result in
4437 applying the process on every pixels.
4438
4439 @item map
4440 Paint pixels exceeding the threshold value to white if set to 1.
4441 Default is 0.
4442
4443 @item order
4444 Set the fields order. Swap fields if set to 1, leave fields alone if
4445 0. Default is 0.
4446
4447 @item sharp
4448 Enable additional sharpening if set to 1. Default is 0.
4449
4450 @item twoway
4451 Enable twoway sharpening if set to 1. Default is 0.
4452 @end table
4453
4454 @subsection Examples
4455
4456 @itemize
4457 @item
4458 Apply default values:
4459 @example
4460 kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
4461 @end example
4462
4463 @item
4464 Enable additional sharpening:
4465 @example
4466 kerndeint=sharp=1
4467 @end example
4468
4469 @item
4470 Paint processed pixels in white:
4471 @example
4472 kerndeint=map=1
4473 @end example
4474 @end itemize
4475
4476 @section lut, lutrgb, lutyuv
4477
4478 Compute a look-up table for binding each pixel component input value
4479 to an output value, and apply it to input video.
4480
4481 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
4482 to an RGB input video.
4483
4484 These filters accept the following options:
4485 @table @option
4486 @item c0
4487 set first pixel component expression
4488 @item c1
4489 set second pixel component expression
4490 @item c2
4491 set third pixel component expression
4492 @item c3
4493 set fourth pixel component expression, corresponds to the alpha component
4494
4495 @item r
4496 set red component expression
4497 @item g
4498 set green component expression
4499 @item b
4500 set blue component expression
4501 @item a
4502 alpha component expression
4503
4504 @item y
4505 set Y/luminance component expression
4506 @item u
4507 set U/Cb component expression
4508 @item v
4509 set V/Cr component expression
4510 @end table
4511
4512 Each of them specifies the expression to use for computing the lookup table for
4513 the corresponding pixel component values.
4514
4515 The exact component associated to each of the @var{c*} options depends on the
4516 format in input.
4517
4518 The @var{lut} filter requires either YUV or RGB pixel formats in input,
4519 @var{lutrgb} requires RGB pixel formats in input, and @var{lutyuv} requires YUV.
4520
4521 The expressions can contain the following constants and functions:
4522
4523 @table @option
4524 @item w, h
4525 the input width and height
4526
4527 @item val
4528 input value for the pixel component
4529
4530 @item clipval
4531 the input value clipped in the @var{minval}-@var{maxval} range
4532
4533 @item maxval
4534 maximum value for the pixel component
4535
4536 @item minval
4537 minimum value for the pixel component
4538
4539 @item negval
4540 the negated value for the pixel component value clipped in the
4541 @var{minval}-@var{maxval} range , it corresponds to the expression
4542 "maxval-clipval+minval"
4543
4544 @item clip(val)
4545 the computed value in @var{val} clipped in the
4546 @var{minval}-@var{maxval} range
4547
4548 @item gammaval(gamma)
4549 the computed gamma correction value of the pixel component value
4550 clipped in the @var{minval}-@var{maxval} range, corresponds to the
4551 expression
4552 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
4553
4554 @end table
4555
4556 All expressions default to "val".
4557
4558 @subsection Examples
4559
4560 @itemize
4561 @item
4562 Negate input video:
4563 @example
4564 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
4565 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
4566 @end example
4567
4568 The above is the same as:
4569 @example
4570 lutrgb="r=negval:g=negval:b=negval"
4571 lutyuv="y=negval:u=negval:v=negval"
4572 @end example
4573
4574 @item
4575 Negate luminance:
4576 @example
4577 lutyuv=y=negval
4578 @end example
4579
4580 @item
4581 Remove chroma components, turns the video into a graytone image:
4582 @example
4583 lutyuv="u=128:v=128"
4584 @end example
4585
4586 @item
4587 Apply a luma burning effect:
4588 @example
4589 lutyuv="y=2*val"
4590 @end example
4591
4592 @item
4593 Remove green and blue components:
4594 @example
4595 lutrgb="g=0:b=0"
4596 @end example
4597
4598 @item
4599 Set a constant alpha channel value on input:
4600 @example
4601 format=rgba,lutrgb=a="maxval-minval/2"
4602 @end example
4603
4604 @item
4605 Correct luminance gamma by a 0.5 factor:
4606 @example
4607 lutyuv=y=gammaval(0.5)
4608 @end example
4609
4610 @item
4611 Discard least significant bits of luma:
4612 @example
4613 lutyuv=y='bitand(val, 128+64+32)'
4614 @end example
4615 @end itemize
4616
4617 @section mp
4618
4619 Apply an MPlayer filter to the input video.
4620
4621 This filter provides a wrapper around most of the filters of
4622 MPlayer/MEncoder.
4623
4624 This wrapper is considered experimental. Some of the wrapped filters
4625 may not work properly and we may drop support for them, as they will
4626 be implemented natively into FFmpeg. Thus you should avoid
4627 depending on them when writing portable scripts.
4628
4629 The filters accepts the parameters:
4630 @var{filter_name}[:=]@var{filter_params}
4631
4632 @var{filter_name} is the name of a supported MPlayer filter,
4633 @var{filter_params} is a string containing the parameters accepted by
4634 the named filter.
4635
4636 The list of the currently supported filters follows:
4637 @table @var
4638 @item dint
4639 @item eq2
4640 @item eq
4641 @item fil
4642 @item fspp
4643 @item ilpack
4644 @item mcdeint
4645 @item ow
4646 @item perspective
4647 @item phase
4648 @item pp7
4649 @item pullup
4650 @item qp
4651 @item sab
4652 @item softpulldown
4653 @item spp
4654 @item uspp
4655 @end table
4656
4657 The parameter syntax and behavior for the listed filters are the same
4658 of the corresponding MPlayer filters. For detailed instructions check
4659 the "VIDEO FILTERS" section in the MPlayer manual.
4660
4661 @subsection Examples
4662
4663 @itemize
4664 @item
4665 Adjust gamma, brightness, contrast:
4666 @example
4667 mp=eq2=1.0:2:0.5
4668 @end example
4669 @end itemize
4670
4671 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
4672
4673 @section mpdecimate
4674
4675 Drop frames that do not differ greatly from the previous frame in
4676 order to reduce frame rate.
4677
4678 The main use of this filter is for very-low-bitrate encoding
4679 (e.g. streaming over dialup modem), but it could in theory be used for
4680 fixing movies that were inverse-telecined incorrectly.
4681
4682 A description of the accepted options follows.
4683
4684 @table @option
4685 @item max
4686 Set the maximum number of consecutive frames which can be dropped (if
4687 positive), or the minimum interval between dropped frames (if
4688 negative). If the value is 0, the frame is dropped unregarding the
4689 number of previous sequentially dropped frames.
4690
4691 Default value is 0.
4692
4693 @item hi
4694 @item lo
4695 @item frac
4696 Set the dropping threshold values.
4697
4698 Values for @option{hi} and @option{lo} are for 8x8 pixel blocks and
4699 represent actual pixel value differences, so a threshold of 64
4700 corresponds to 1 unit of difference for each pixel, or the same spread
4701 out differently over the block.
4702
4703 A frame is a candidate for dropping if no 8x8 blocks differ by more
4704 than a threshold of @option{hi}, and if no more than @option{frac} blocks (1
4705 meaning the whole image) differ by more than a threshold of @option{lo}.
4706
4707 Default value for @option{hi} is 64*12, default value for @option{lo} is
4708 64*5, and default value for @option{frac} is 0.33.
4709 @end table
4710
4711
4712 @section negate
4713
4714 Negate input video.
4715
4716 This filter accepts an integer in input, if non-zero it negates the
4717 alpha component (if available). The default value in input is 0.
4718
4719 @section noformat
4720
4721 Force libavfilter not to use any of the specified pixel formats for the
4722 input to the next filter.
4723
4724 This filter accepts the following parameters:
4725 @table @option
4726
4727 @item pix_fmts
4728 A '|'-separated list of pixel format names, for example
4729 "pix_fmts=yuv420p|monow|rgb24".
4730
4731 @end table
4732
4733 @subsection Examples
4734
4735 @itemize
4736 @item
4737 Force libavfilter to use a format different from @var{yuv420p} for the
4738 input to the vflip filter:
4739 @example
4740 noformat=pix_fmts=yuv420p,vflip
4741 @end example
4742
4743 @item
4744 Convert the input video to any of the formats not contained in the list:
4745 @example
4746 noformat=yuv420p|yuv444p|yuv410p
4747 @end example
4748 @end itemize
4749
4750 @section noise
4751
4752 Add noise on video input frame.
4753
4754 The filter accepts the following options:
4755
4756 @table @option
4757 @item all_seed
4758 @item c0_seed
4759 @item c1_seed
4760 @item c2_seed
4761 @item c3_seed
4762 Set noise seed for specific pixel component or all pixel components in case
4763 of @var{all_seed}. Default value is @code{123457}.
4764
4765 @item all_strength, alls
4766 @item c0_strength, c0s
4767 @item c1_strength, c1s
4768 @item c2_strength, c2s
4769 @item c3_strength, c3s
4770 Set noise strength for specific pixel component or all pixel components in case
4771 @var{all_strength}. Default value is @code{0}. Allowed range is [0, 100].
4772
4773 @item all_flags, allf
4774 @item c0_flags, c0f
4775 @item c1_flags, c1f
4776 @item c2_flags, c2f
4777 @item c3_flags, c3f
4778 Set pixel component flags or set flags for all components if @var{all_flags}.
4779 Available values for component flags are:
4780 @table @samp
4781 @item a
4782 averaged temporal noise (smoother)
4783 @item p
4784 mix random noise with a (semi)regular pattern
4785 @item t
4786 temporal noise (noise pattern changes between frames)
4787 @item u
4788 uniform noise (gaussian otherwise)
4789 @end table
4790 @end table
4791
4792 @subsection Examples
4793
4794 Add temporal and uniform noise to input video:
4795 @example
4796 noise=alls=20:allf=t+u
4797 @end example
4798
4799 @section null
4800
4801 Pass the video source unchanged to the output.
4802
4803 @section ocv
4804
4805 Apply video transform using libopencv.
4806
4807 To enable this filter install libopencv library and headers and
4808 configure FFmpeg with @code{--enable-libopencv}.
4809
4810 This filter accepts the following parameters:
4811
4812 @table @option
4813
4814 @item filter_name
4815 The name of the libopencv filter to apply.
4816
4817 @item filter_params
4818 The parameters to pass to the libopencv filter. If not specified the default
4819 values are assumed.
4820
4821 @end table
4822
4823 Refer to the official libopencv documentation for more precise
4824 information:
4825 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
4826
4827 Follows the list of supported libopencv filters.
4828
4829 @anchor{dilate}
4830 @subsection dilate
4831
4832 Dilate an image by using a specific structuring element.
4833 This filter corresponds to the libopencv function @code{cvDilate}.
4834
4835 It accepts the parameters: @var{struct_el}|@var{nb_iterations}.
4836
4837 @var{struct_el} represents a structuring element, and has the syntax:
4838 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
4839
4840 @var{cols} and @var{rows} represent the number of columns and rows of
4841 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
4842 point, and @var{shape} the shape for the structuring element, and
4843 can be one of the values "rect", "cross", "ellipse", "custom".
4844
4845 If the value for @var{shape} is "custom", it must be followed by a
4846 string of the form "=@var{filename}". The file with name
4847 @var{filename} is assumed to represent a binary image, with each
4848 printable character corresponding to a bright pixel. When a custom
4849 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
4850 or columns and rows of the read file are assumed instead.
4851
4852 The default value for @var{struct_el} is "3x3+0x0/rect".
4853
4854 @var{nb_iterations} specifies the number of times the transform is
4855 applied to the image, and defaults to 1.
4856
4857 Follow some example:
4858 @example
4859 # use the default values
4860 ocv=dilate
4861
4862 # dilate using a structuring element with a 5x5 cross, iterate two times
4863 ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
4864
4865 # read the shape from the file diamond.shape, iterate two times
4866 # the file diamond.shape may contain a pattern of characters like this:
4867 #   *
4868 #  ***
4869 # *****
4870 #  ***
4871 #   *
4872 # the specified cols and rows are ignored (but not the anchor point coordinates)
4873 ocv=dilate:0x0+2x2/custom=diamond.shape|2
4874 @end example
4875
4876 @subsection erode
4877
4878 Erode an image by using a specific structuring element.
4879 This filter corresponds to the libopencv function @code{cvErode}.
4880
4881 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
4882 with the same syntax and semantics as the @ref{dilate} filter.
4883
4884 @subsection smooth
4885
4886 Smooth the input video.
4887
4888 The filter takes the following parameters:
4889 @var{type}|@var{param1}|@var{param2}|@var{param3}|@var{param4}.
4890
4891 @var{type} is the type of smooth filter to apply, and can be one of
4892 the following values: "blur", "blur_no_scale", "median", "gaussian",
4893 "bilateral". The default value is "gaussian".
4894
4895 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
4896 parameters whose meanings depend on smooth type. @var{param1} and
4897 @var{param2} accept integer positive values or 0, @var{param3} and
4898 @var{param4} accept float values.
4899
4900 The default value for @var{param1} is 3, the default value for the
4901 other parameters is 0.
4902
4903 These parameters correspond to the parameters assigned to the
4904 libopencv function @code{cvSmooth}.
4905
4906 @anchor{overlay}
4907 @section overlay
4908
4909 Overlay one video on top of another.
4910
4911 It takes two inputs and one output, the first input is the "main"
4912 video on which the second input is overlayed.
4913
4914 This filter accepts the following parameters:
4915
4916 A description of the accepted options follows.
4917
4918 @table @option
4919 @item x
4920 @item y
4921 Set the expression for the x and y coordinates of the overlayed video
4922 on the main video. Default value is "0" for both expressions. In case
4923 the expression is invalid, it is set to a huge value (meaning that the
4924 overlay will not be displayed within the output visible area).
4925
4926 @item eval
4927 Set when the expressions for @option{x}, and @option{y} are evaluated.
4928
4929 It accepts the following values:
4930 @table @samp
4931 @item init
4932 only evaluate expressions once during the filter initialization or
4933 when a command is processed
4934
4935 @item frame
4936 evaluate expressions for each incoming frame
4937 @end table
4938
4939 Default value is @samp{frame}.
4940
4941 @item shortest
4942 If set to 1, force the output to terminate when the shortest input
4943 terminates. Default value is 0.
4944
4945 @item format
4946 Set the format for the output video.
4947
4948 It accepts the following values:
4949 @table @samp
4950 @item yuv420
4951 force YUV420 output
4952
4953 @item yuv444
4954 force YUV444 output
4955
4956 @item rgb
4957 force RGB output
4958 @end table
4959
4960 Default value is @samp{yuv420}.
4961
4962 @item rgb @emph{(deprecated)}
4963 If set to 1, force the filter to accept inputs in the RGB
4964 color space. Default value is 0. This option is deprecated, use
4965 @option{format} instead.
4966
4967 @item repeatlast
4968 If set to 1, force the filter to draw the last overlay frame over the
4969 main input until the end of the stream. A value of 0 disables this
4970 behavior, which is enabled by default.
4971 @end table
4972
4973 The @option{x}, and @option{y} expressions can contain the following
4974 parameters.
4975
4976 @table @option
4977 @item main_w, W
4978 @item main_h, H
4979 main input width and height
4980
4981 @item overlay_w, w
4982 @item overlay_h, h
4983 overlay input width and height
4984
4985 @item x
4986 @item y
4987 the computed values for @var{x} and @var{y}. They are evaluated for
4988 each new frame.
4989
4990 @item hsub
4991 @item vsub
4992 horizontal and vertical chroma subsample values of the output
4993 format. For example for the pixel format "yuv422p" @var{hsub} is 2 and
4994 @var{vsub} is 1.
4995
4996 @item n
4997 the number of input frame, starting from 0
4998
4999 @item pos
5000 the position in the file of the input frame, NAN if unknown
5001
5002 @item t
5003 timestamp expressed in seconds, NAN if the input timestamp is unknown
5004 @end table
5005
5006 Note that the @var{n}, @var{pos}, @var{t} variables are available only
5007 when evaluation is done @emph{per frame}, and will evaluate to NAN
5008 when @option{eval} is set to @samp{init}.
5009
5010 Be aware that frames are taken from each input video in timestamp
5011 order, hence, if their initial timestamps differ, it is a a good idea
5012 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
5013 have them begin in the same zero timestamp, as it does the example for
5014 the @var{movie} filter.
5015
5016 You can chain together more overlays but you should test the
5017 efficiency of such approach.
5018
5019 @subsection Commands
5020
5021 This filter supports the following commands:
5022 @table @option
5023 @item x
5024 @item y
5025 Modify the x and y of the overlay input.
5026 The command accepts the same syntax of the corresponding option.
5027
5028 If the specified expression is not valid, it is kept at its current
5029 value.
5030 @end table
5031
5032 @subsection Examples
5033
5034 @itemize
5035 @item
5036 Draw the overlay at 10 pixels from the bottom right corner of the main
5037 video:
5038 @example
5039 overlay=main_w-overlay_w-10:main_h-overlay_h-10
5040 @end example
5041
5042 Using named options the example above becomes:
5043 @example
5044 overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
5045 @end example
5046
5047 @item
5048 Insert a transparent PNG logo in the bottom left corner of the input,
5049 using the @command{ffmpeg} tool with the @code{-filter_complex} option:
5050 @example
5051 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
5052 @end example
5053
5054 @item
5055 Insert 2 different transparent PNG logos (second logo on bottom
5056 right corner) using the @command{ffmpeg} tool:
5057 @example
5058 ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
5059 @end example
5060
5061 @item
5062 Add a transparent color layer on top of the main video, @code{WxH}
5063 must specify the size of the main input to the overlay filter:
5064 @example
5065 color=color=red@@.3:size=WxH [over]; [in][over] overlay [out]
5066 @end example
5067
5068 @item
5069 Play an original video and a filtered version (here with the deshake
5070 filter) side by side using the @command{ffplay} tool:
5071 @example
5072 ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
5073 @end example
5074
5075 The above command is the same as:
5076 @example
5077 ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
5078 @end example
5079
5080 @item
5081 Make a sliding overlay appearing from the left to the right top part of the
5082 screen starting since time 2:
5083 @example
5084 overlay=x='if(gte(t,2), -w+(t-2)*20, NAN)':y=0
5085 @end example
5086
5087 @item
5088 Compose output by putting two input videos side to side:
5089 @example
5090 ffmpeg -i left.avi -i right.avi -filter_complex "
5091 nullsrc=size=200x100 [background];
5092 [0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
5093 [1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
5094 [background][left]       overlay=shortest=1       [background+left];
5095 [background+left][right] overlay=shortest=1:x=100 [left+right]
5096 "
5097 @end example
5098
5099 @item
5100 Chain several overlays in cascade:
5101 @example
5102 nullsrc=s=200x200 [bg];
5103 testsrc=s=100x100, split=4 [in0][in1][in2][in3];
5104 [in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
5105 [in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
5106 [in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
5107 [in3] null,       [mid2] overlay=100:100 [out0]
5108 @end example
5109
5110 @end itemize
5111
5112 @section pad
5113
5114 Add paddings to the input image, and place the original input at the
5115 given coordinates @var{x}, @var{y}.
5116
5117 This filter accepts the following parameters:
5118
5119 @table @option
5120 @item width, w
5121 @item height, h
5122 Specify an expression for the size of the output image with the
5123 paddings added. If the value for @var{width} or @var{height} is 0, the
5124 corresponding input size is used for the output.
5125
5126 The @var{width} expression can reference the value set by the
5127 @var{height} expression, and vice versa.
5128
5129 The default value of @var{width} and @var{height} is 0.
5130
5131 @item x
5132 @item y
5133 Specify an expression for the offsets where to place the input image
5134 in the padded area with respect to the top/left border of the output
5135 image.
5136
5137 The @var{x} expression can reference the value set by the @var{y}
5138 expression, and vice versa.
5139
5140 The default value of @var{x} and @var{y} is 0.