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