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