Merge commit '8075c3d8bb1f6aade0cc7c5c40db9bc1bcd84cab'
[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 one 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 Compress or expand audio dynamic range.
1271
1272 A description of the accepted options follows.
1273
1274 @table @option
1275
1276 @item attacks
1277 @item decays
1278 Set list of times in seconds for each channel over which the instantaneous level
1279 of the input signal is averaged to determine its volume. @var{attacks} refers to
1280 increase of volume and @var{decays} refers to decrease of volume. For most
1281 situations, the attack time (response to the audio getting louder) should be
1282 shorter than the decay time because the human ear is more sensitive to sudden
1283 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
1284 a typical value for decay is 0.8 seconds.
1285
1286 @item points
1287 Set list of points for the transfer function, specified in dB relative to the
1288 maximum possible signal amplitude. Each key points list must be defined using
1289 the following syntax: @code{x0/y0|x1/y1|x2/y2|....} or
1290 @code{x0/y0 x1/y1 x2/y2 ....}
1291
1292 The input values must be in strictly increasing order but the transfer function
1293 does not have to be monotonically rising. The point @code{0/0} is assumed but
1294 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
1295 function are @code{-70/-70|-60/-20}.
1296
1297 @item soft-knee
1298 Set the curve radius in dB for all joints. Defaults to 0.01.
1299
1300 @item gain
1301 Set additional gain in dB to be applied at all points on the transfer function.
1302 This allows easy adjustment of the overall gain. Defaults to 0.
1303
1304 @item volume
1305 Set initial volume in dB to be assumed for each channel when filtering starts.
1306 This permits the user to supply a nominal level initially, so that, for
1307 example, a very large gain is not applied to initial signal levels before the
1308 companding has begun to operate. A typical value for audio which is initially
1309 quiet is -90 dB. Defaults to 0.
1310
1311 @item delay
1312 Set delay in seconds. The input audio is analyzed immediately, but audio is
1313 delayed before being fed to the volume adjuster. Specifying a delay
1314 approximately equal to the attack/decay times allows the filter to effectively
1315 operate in predictive rather than reactive mode. Defaults to 0.
1316
1317 @end table
1318
1319 @subsection Examples
1320
1321 @itemize
1322 @item
1323 Make music with both quiet and loud passages suitable for listening in a noisy
1324 environment:
1325 @example
1326 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
1327 @end example
1328
1329 @item
1330 Noise gate for when the noise is at a lower level than the signal:
1331 @example
1332 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
1333 @end example
1334
1335 @item
1336 Here is another noise gate, this time for when the noise is at a higher level
1337 than the signal (making it, in some ways, similar to squelch):
1338 @example
1339 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
1340 @end example
1341 @end itemize
1342
1343 @section earwax
1344
1345 Make audio easier to listen to on headphones.
1346
1347 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
1348 so that when listened to on headphones the stereo image is moved from
1349 inside your head (standard for headphones) to outside and in front of
1350 the listener (standard for speakers).
1351
1352 Ported from SoX.
1353
1354 @section equalizer
1355
1356 Apply a two-pole peaking equalisation (EQ) filter. With this
1357 filter, the signal-level at and around a selected frequency can
1358 be increased or decreased, whilst (unlike bandpass and bandreject
1359 filters) that at all other frequencies is unchanged.
1360
1361 In order to produce complex equalisation curves, this filter can
1362 be given several times, each with a different central frequency.
1363
1364 The filter accepts the following options:
1365
1366 @table @option
1367 @item frequency, f
1368 Set the filter's central frequency in Hz.
1369
1370 @item width_type
1371 Set method to specify band-width of filter.
1372 @table @option
1373 @item h
1374 Hz
1375 @item q
1376 Q-Factor
1377 @item o
1378 octave
1379 @item s
1380 slope
1381 @end table
1382
1383 @item width, w
1384 Specify the band-width of a filter in width_type units.
1385
1386 @item gain, g
1387 Set the required gain or attenuation in dB.
1388 Beware of clipping when using a positive gain.
1389 @end table
1390
1391 @subsection Examples
1392 @itemize
1393 @item
1394 Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
1395 @example
1396 equalizer=f=1000:width_type=h:width=200:g=-10
1397 @end example
1398
1399 @item
1400 Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
1401 @example
1402 equalizer=f=1000:width_type=q:width=1:g=2,equalizer=f=100:width_type=q:width=2:g=-5
1403 @end example
1404 @end itemize
1405
1406 @section highpass
1407
1408 Apply a high-pass filter with 3dB point frequency.
1409 The filter can be either single-pole, or double-pole (the default).
1410 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1411
1412 The filter accepts the following options:
1413
1414 @table @option
1415 @item frequency, f
1416 Set frequency in Hz. Default is 3000.
1417
1418 @item poles, p
1419 Set number of poles. Default is 2.
1420
1421 @item width_type
1422 Set method to specify band-width of filter.
1423 @table @option
1424 @item h
1425 Hz
1426 @item q
1427 Q-Factor
1428 @item o
1429 octave
1430 @item s
1431 slope
1432 @end table
1433
1434 @item width, w
1435 Specify the band-width of a filter in width_type units.
1436 Applies only to double-pole filter.
1437 The default is 0.707q and gives a Butterworth response.
1438 @end table
1439
1440 @section join
1441
1442 Join multiple input streams into one multi-channel stream.
1443
1444 The filter accepts the following named parameters:
1445 @table @option
1446
1447 @item inputs
1448 Number of input streams. Defaults to 2.
1449
1450 @item channel_layout
1451 Desired output channel layout. Defaults to stereo.
1452
1453 @item map
1454 Map channels from inputs to output. The argument is a '|'-separated list of
1455 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
1456 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
1457 can be either the name of the input channel (e.g. FL for front left) or its
1458 index in the specified input stream. @var{out_channel} is the name of the output
1459 channel.
1460 @end table
1461
1462 The filter will attempt to guess the mappings when those are not specified
1463 explicitly. It does so by first trying to find an unused matching input channel
1464 and if that fails it picks the first unused input channel.
1465
1466 E.g. to join 3 inputs (with properly set channel layouts)
1467 @example
1468 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
1469 @end example
1470
1471 To build a 5.1 output from 6 single-channel streams:
1472 @example
1473 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
1474 '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'
1475 out
1476 @end example
1477
1478 @section ladspa
1479
1480 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
1481
1482 To enable compilation of this filter you need to configure FFmpeg with
1483 @code{--enable-ladspa}.
1484
1485 @table @option
1486 @item file, f
1487 Specifies the name of LADSPA plugin library to load. If the environment
1488 variable @env{LADSPA_PATH} is defined, the LADSPA plugin is searched in
1489 each one of the directories specified by the colon separated list in
1490 @env{LADSPA_PATH}, otherwise in the standard LADSPA paths, which are in
1491 this order: @file{HOME/.ladspa/lib/}, @file{/usr/local/lib/ladspa/},
1492 @file{/usr/lib/ladspa/}.
1493
1494 @item plugin, p
1495 Specifies the plugin within the library. Some libraries contain only
1496 one plugin, but others contain many of them. If this is not set filter
1497 will list all available plugins within the specified library.
1498
1499 @item controls, c
1500 Set the '|' separated list of controls which are zero or more floating point
1501 values that determine the behavior of the loaded plugin (for example delay,
1502 threshold or gain).
1503 Controls need to be defined using the following syntax:
1504 c0=@var{value0}|c1=@var{value1}|c2=@var{value2}|..., where
1505 @var{valuei} is the value set on the @var{i}-th control.
1506 If @option{controls} is set to @code{help}, all available controls and
1507 their valid ranges are printed.
1508
1509 @item sample_rate, s
1510 Specify the sample rate, default to 44100. Only used if plugin have
1511 zero inputs.
1512
1513 @item nb_samples, n
1514 Set the number of samples per channel per each output frame, default
1515 is 1024. Only used if plugin have zero inputs.
1516
1517 @item duration, d
1518 Set the minimum duration of the sourced audio. See the function
1519 @code{av_parse_time()} for the accepted format, also check the "Time duration"
1520 section in the ffmpeg-utils manual.
1521 Note that the resulting duration may be greater than the specified duration,
1522 as the generated audio is always cut at the end of a complete frame.
1523 If not specified, or the expressed duration is negative, the audio is
1524 supposed to be generated forever.
1525 Only used if plugin have zero inputs.
1526
1527 @end table
1528
1529 @subsection Examples
1530
1531 @itemize
1532 @item
1533 List all available plugins within amp (LADSPA example plugin) library:
1534 @example
1535 ladspa=file=amp
1536 @end example
1537
1538 @item
1539 List all available controls and their valid ranges for @code{vcf_notch}
1540 plugin from @code{VCF} library:
1541 @example
1542 ladspa=f=vcf:p=vcf_notch:c=help
1543 @end example
1544
1545 @item
1546 Simulate low quality audio equipment using @code{Computer Music Toolkit} (CMT)
1547 plugin library:
1548 @example
1549 ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
1550 @end example
1551
1552 @item
1553 Add reverberation to the audio using TAP-plugins
1554 (Tom's Audio Processing plugins):
1555 @example
1556 ladspa=file=tap_reverb:tap_reverb
1557 @end example
1558
1559 @item
1560 Generate white noise, with 0.2 amplitude:
1561 @example
1562 ladspa=file=cmt:noise_source_white:c=c0=.2
1563 @end example
1564
1565 @item
1566 Generate 20 bpm clicks using plugin @code{C* Click - Metronome} from the
1567 @code{C* Audio Plugin Suite} (CAPS) library:
1568 @example
1569 ladspa=file=caps:Click:c=c1=20'
1570 @end example
1571
1572 @item
1573 Apply @code{C* Eq10X2 - Stereo 10-band equaliser} effect:
1574 @example
1575 ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
1576 @end example
1577 @end itemize
1578
1579 @subsection Commands
1580
1581 This filter supports the following commands:
1582 @table @option
1583 @item cN
1584 Modify the @var{N}-th control value.
1585
1586 If the specified value is not valid, it is ignored and prior one is kept.
1587 @end table
1588
1589 @section lowpass
1590
1591 Apply a low-pass filter with 3dB point frequency.
1592 The filter can be either single-pole or double-pole (the default).
1593 The filter roll off at 6dB per pole per octave (20dB per pole per decade).
1594
1595 The filter accepts the following options:
1596
1597 @table @option
1598 @item frequency, f
1599 Set frequency in Hz. Default is 500.
1600
1601 @item poles, p
1602 Set number of poles. Default is 2.
1603
1604 @item width_type
1605 Set method to specify band-width of filter.
1606 @table @option
1607 @item h
1608 Hz
1609 @item q
1610 Q-Factor
1611 @item o
1612 octave
1613 @item s
1614 slope
1615 @end table
1616
1617 @item width, w
1618 Specify the band-width of a filter in width_type units.
1619 Applies only to double-pole filter.
1620 The default is 0.707q and gives a Butterworth response.
1621 @end table
1622
1623 @section pan
1624
1625 Mix channels with specific gain levels. The filter accepts the output
1626 channel layout followed by a set of channels definitions.
1627
1628 This filter is also designed to remap efficiently the channels of an audio
1629 stream.
1630
1631 The filter accepts parameters of the form:
1632 "@var{l}:@var{outdef}:@var{outdef}:..."
1633
1634 @table @option
1635 @item l
1636 output channel layout or number of channels
1637
1638 @item outdef
1639 output channel specification, of the form:
1640 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
1641
1642 @item out_name
1643 output channel to define, either a channel name (FL, FR, etc.) or a channel
1644 number (c0, c1, etc.)
1645
1646 @item gain
1647 multiplicative coefficient for the channel, 1 leaving the volume unchanged
1648
1649 @item in_name
1650 input channel to use, see out_name for details; it is not possible to mix
1651 named and numbered input channels
1652 @end table
1653
1654 If the `=' in a channel specification is replaced by `<', then the gains for
1655 that specification will be renormalized so that the total is 1, thus
1656 avoiding clipping noise.
1657
1658 @subsection Mixing examples
1659
1660 For example, if you want to down-mix from stereo to mono, but with a bigger
1661 factor for the left channel:
1662 @example
1663 pan=1:c0=0.9*c0+0.1*c1
1664 @end example
1665
1666 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
1667 7-channels surround:
1668 @example
1669 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
1670 @end example
1671
1672 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
1673 that should be preferred (see "-ac" option) unless you have very specific
1674 needs.
1675
1676 @subsection Remapping examples
1677
1678 The channel remapping will be effective if, and only if:
1679
1680 @itemize
1681 @item gain coefficients are zeroes or ones,
1682 @item only one input per channel output,
1683 @end itemize
1684
1685 If all these conditions are satisfied, the filter will notify the user ("Pure
1686 channel mapping detected"), and use an optimized and lossless method to do the
1687 remapping.
1688
1689 For example, if you have a 5.1 source and want a stereo audio stream by
1690 dropping the extra channels:
1691 @example
1692 pan="stereo: c0=FL : c1=FR"
1693 @end example
1694
1695 Given the same source, you can also switch front left and front right channels
1696 and keep the input channel layout:
1697 @example
1698 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
1699 @end example
1700
1701 If the input is a stereo audio stream, you can mute the front left channel (and
1702 still keep the stereo channel layout) with:
1703 @example
1704 pan="stereo:c1=c1"
1705 @end example
1706
1707 Still with a stereo audio stream input, you can copy the right channel in both
1708 front left and right:
1709 @example
1710 pan="stereo: c0=FR : c1=FR"
1711 @end example
1712
1713 @section replaygain
1714
1715 ReplayGain scanner filter. This filter takes an audio stream as an input and
1716 outputs it unchanged.
1717 At end of filtering it displays @code{track_gain} and @code{track_peak}.
1718
1719 @section resample
1720
1721 Convert the audio sample format, sample rate and channel layout. This filter is
1722 not meant to be used directly.
1723
1724 @section silencedetect
1725
1726 Detect silence in an audio stream.
1727
1728 This filter logs a message when it detects that the input audio volume is less
1729 or equal to a noise tolerance value for a duration greater or equal to the
1730 minimum detected noise duration.
1731
1732 The printed times and duration are expressed in seconds.
1733
1734 The filter accepts the following options:
1735
1736 @table @option
1737 @item duration, d
1738 Set silence duration until notification (default is 2 seconds).
1739
1740 @item noise, n
1741 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
1742 specified value) or amplitude ratio. Default is -60dB, or 0.001.
1743 @end table
1744
1745 @subsection Examples
1746
1747 @itemize
1748 @item
1749 Detect 5 seconds of silence with -50dB noise tolerance:
1750 @example
1751 silencedetect=n=-50dB:d=5
1752 @end example
1753
1754 @item
1755 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
1756 tolerance in @file{silence.mp3}:
1757 @example
1758 ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
1759 @end example
1760 @end itemize
1761
1762 @section treble
1763
1764 Boost or cut treble (upper) frequencies of the audio using a two-pole
1765 shelving filter with a response similar to that of a standard
1766 hi-fi's tone-controls. This is also known as shelving equalisation (EQ).
1767
1768 The filter accepts the following options:
1769
1770 @table @option
1771 @item gain, g
1772 Give the gain at whichever is the lower of ~22 kHz and the
1773 Nyquist frequency. Its useful range is about -20 (for a large cut)
1774 to +20 (for a large boost). Beware of clipping when using a positive gain.
1775
1776 @item frequency, f
1777 Set the filter's central frequency and so can be used
1778 to extend or reduce the frequency range to be boosted or cut.
1779 The default value is @code{3000} Hz.
1780
1781 @item width_type
1782 Set method to specify band-width of filter.
1783 @table @option
1784 @item h
1785 Hz
1786 @item q
1787 Q-Factor
1788 @item o
1789 octave
1790 @item s
1791 slope
1792 @end table
1793
1794 @item width, w
1795 Determine how steep is the filter's shelf transition.
1796 @end table
1797
1798 @section volume
1799
1800 Adjust the input audio volume.
1801
1802 The filter accepts the following options:
1803
1804 @table @option
1805
1806 @item volume
1807 Set audio volume expression.
1808
1809 Output values are clipped to the maximum value.
1810
1811 The output audio volume is given by the relation:
1812 @example
1813 @var{output_volume} = @var{volume} * @var{input_volume}
1814 @end example
1815
1816 Default value for @var{volume} is "1.0".
1817
1818 @item precision
1819 Set the mathematical precision.
1820
1821 This determines which input sample formats will be allowed, which affects the
1822 precision of the volume scaling.
1823
1824 @table @option
1825 @item fixed
1826 8-bit fixed-point; limits input sample format to U8, S16, and S32.
1827 @item float
1828 32-bit floating-point; limits input sample format to FLT. (default)
1829 @item double
1830 64-bit floating-point; limits input sample format to DBL.
1831 @end table
1832
1833 @item eval
1834 Set when the volume expression is evaluated.
1835
1836 It accepts the following values:
1837 @table @samp
1838 @item once
1839 only evaluate expression once during the filter initialization, or
1840 when the @samp{volume} command is sent
1841
1842 @item frame
1843 evaluate expression for each incoming frame
1844 @end table
1845
1846 Default value is @samp{once}.
1847 @end table
1848
1849 The volume expression can contain the following parameters.
1850
1851 @table @option
1852 @item n
1853 frame number (starting at zero)
1854 @item nb_channels
1855 number of channels
1856 @item nb_consumed_samples
1857 number of samples consumed by the filter
1858 @item nb_samples
1859 number of samples in the current frame
1860 @item pos
1861 original frame position in the file
1862 @item pts
1863 frame PTS
1864 @item sample_rate
1865 sample rate
1866 @item startpts
1867 PTS at start of stream
1868 @item startt
1869 time at start of stream
1870 @item t
1871 frame time
1872 @item tb
1873 timestamp timebase
1874 @item volume
1875 last set volume value
1876 @end table
1877
1878 Note that when @option{eval} is set to @samp{once} only the
1879 @var{sample_rate} and @var{tb} variables are available, all other
1880 variables will evaluate to NAN.
1881
1882 @subsection Commands
1883
1884 This filter supports the following commands:
1885 @table @option
1886 @item volume
1887 Modify the volume expression.
1888 The command accepts the same syntax of the corresponding option.
1889
1890 If the specified expression is not valid, it is kept at its current
1891 value.
1892 @end table
1893
1894 @subsection Examples
1895
1896 @itemize
1897 @item
1898 Halve the input audio volume:
1899 @example
1900 volume=volume=0.5
1901 volume=volume=1/2
1902 volume=volume=-6.0206dB
1903 @end example
1904
1905 In all the above example the named key for @option{volume} can be
1906 omitted, for example like in:
1907 @example
1908 volume=0.5
1909 @end example
1910
1911 @item
1912 Increase input audio power by 6 decibels using fixed-point precision:
1913 @example
1914 volume=volume=6dB:precision=fixed
1915 @end example
1916
1917 @item
1918 Fade volume after time 10 with an annihilation period of 5 seconds:
1919 @example
1920 volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
1921 @end example
1922 @end itemize
1923
1924 @section volumedetect
1925
1926 Detect the volume of the input video.
1927
1928 The filter has no parameters. The input is not modified. Statistics about
1929 the volume will be printed in the log when the input stream end is reached.
1930
1931 In particular it will show the mean volume (root mean square), maximum
1932 volume (on a per-sample basis), and the beginning of a histogram of the
1933 registered volume values (from the maximum value to a cumulated 1/1000 of
1934 the samples).
1935
1936 All volumes are in decibels relative to the maximum PCM value.
1937
1938 @subsection Examples
1939
1940 Here is an excerpt of the output:
1941 @example
1942 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
1943 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
1944 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
1945 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
1946 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
1947 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
1948 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
1949 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
1950 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
1951 @end example
1952
1953 It means that:
1954 @itemize
1955 @item
1956 The mean square energy is approximately -27 dB, or 10^-2.7.
1957 @item
1958 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
1959 @item
1960 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
1961 @end itemize
1962
1963 In other words, raising the volume by +4 dB does not cause any clipping,
1964 raising it by +5 dB causes clipping for 6 samples, etc.
1965
1966 @c man end AUDIO FILTERS
1967
1968 @chapter Audio Sources
1969 @c man begin AUDIO SOURCES
1970
1971 Below is a description of the currently available audio sources.
1972
1973 @section abuffer
1974
1975 Buffer audio frames, and make them available to the filter chain.
1976
1977 This source is mainly intended for a programmatic use, in particular
1978 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
1979
1980 It accepts the following named parameters:
1981
1982 @table @option
1983
1984 @item time_base
1985 Timebase which will be used for timestamps of submitted frames. It must be
1986 either a floating-point number or in @var{numerator}/@var{denominator} form.
1987
1988 @item sample_rate
1989 The sample rate of the incoming audio buffers.
1990
1991 @item sample_fmt
1992 The sample format of the incoming audio buffers.
1993 Either a sample format name or its corresponging integer representation from
1994 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
1995
1996 @item channel_layout
1997 The channel layout of the incoming audio buffers.
1998 Either a channel layout name from channel_layout_map in
1999 @file{libavutil/channel_layout.c} or its corresponding integer representation
2000 from the AV_CH_LAYOUT_* macros in @file{libavutil/channel_layout.h}
2001
2002 @item channels
2003 The number of channels of the incoming audio buffers.
2004 If both @var{channels} and @var{channel_layout} are specified, then they
2005 must be consistent.
2006
2007 @end table
2008
2009 @subsection Examples
2010
2011 @example
2012 abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
2013 @end example
2014
2015 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
2016 Since the sample format with name "s16p" corresponds to the number
2017 6 and the "stereo" channel layout corresponds to the value 0x3, this is
2018 equivalent to:
2019 @example
2020 abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
2021 @end example
2022
2023 @section aevalsrc
2024
2025 Generate an audio signal specified by an expression.
2026
2027 This source accepts in input one or more expressions (one for each
2028 channel), which are evaluated and used to generate a corresponding
2029 audio signal.
2030
2031 This source accepts the following options:
2032
2033 @table @option
2034 @item exprs
2035 Set the '|'-separated expressions list for each separate channel. In case the
2036 @option{channel_layout} option is not specified, the selected channel layout
2037 depends on the number of provided expressions. Otherwise the last
2038 specified expression is applied to the remaining output channels.
2039
2040 @item channel_layout, c
2041 Set the channel layout. The number of channels in the specified layout
2042 must be equal to the number of specified expressions.
2043
2044 @item duration, d
2045 Set the minimum duration of the sourced audio. See the function
2046 @code{av_parse_time()} for the accepted format.
2047 Note that the resulting duration may be greater than the specified
2048 duration, as the generated audio is always cut at the end of a
2049 complete frame.
2050
2051 If not specified, or the expressed duration is negative, the audio is
2052 supposed to be generated forever.
2053
2054 @item nb_samples, n
2055 Set the number of samples per channel per each output frame,
2056 default to 1024.
2057
2058 @item sample_rate, s
2059 Specify the sample rate, default to 44100.
2060 @end table
2061
2062 Each expression in @var{exprs} can contain the following constants:
2063
2064 @table @option
2065 @item n
2066 number of the evaluated sample, starting from 0
2067
2068 @item t
2069 time of the evaluated sample expressed in seconds, starting from 0
2070
2071 @item s
2072 sample rate
2073
2074 @end table
2075
2076 @subsection Examples
2077
2078 @itemize
2079 @item
2080 Generate silence:
2081 @example
2082 aevalsrc=0
2083 @end example
2084
2085 @item
2086 Generate a sin signal with frequency of 440 Hz, set sample rate to
2087 8000 Hz:
2088 @example
2089 aevalsrc="sin(440*2*PI*t):s=8000"
2090 @end example
2091
2092 @item
2093 Generate a two channels signal, specify the channel layout (Front
2094 Center + Back Center) explicitly:
2095 @example
2096 aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
2097 @end example
2098
2099 @item
2100 Generate white noise:
2101 @example
2102 aevalsrc="-2+random(0)"
2103 @end example
2104
2105 @item
2106 Generate an amplitude modulated signal:
2107 @example
2108 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
2109 @end example
2110
2111 @item
2112 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
2113 @example
2114 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
2115 @end example
2116
2117 @end itemize
2118
2119 @section anullsrc
2120
2121 Null audio source, return unprocessed audio frames. It is mainly useful
2122 as a template and to be employed in analysis / debugging tools, or as
2123 the source for filters which ignore the input data (for example the sox
2124 synth filter).
2125
2126 This source accepts the following options:
2127
2128 @table @option
2129
2130 @item channel_layout, cl
2131
2132 Specify the channel layout, and can be either an integer or a string
2133 representing a channel layout. The default value of @var{channel_layout}
2134 is "stereo".
2135
2136 Check the channel_layout_map definition in
2137 @file{libavutil/channel_layout.c} for the mapping between strings and
2138 channel layout values.
2139
2140 @item sample_rate, r
2141 Specify the sample rate, and defaults to 44100.
2142
2143 @item nb_samples, n
2144 Set the number of samples per requested frames.
2145
2146 @end table
2147
2148 @subsection Examples
2149
2150 @itemize
2151 @item
2152 Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
2153 @example
2154 anullsrc=r=48000:cl=4
2155 @end example
2156
2157 @item
2158 Do the same operation with a more obvious syntax:
2159 @example
2160 anullsrc=r=48000:cl=mono
2161 @end example
2162 @end itemize
2163
2164 All the parameters need to be explicitly defined.
2165
2166 @section flite
2167
2168 Synthesize a voice utterance using the libflite library.
2169
2170 To enable compilation of this filter you need to configure FFmpeg with
2171 @code{--enable-libflite}.
2172
2173 Note that the flite library is not thread-safe.
2174
2175 The filter accepts the following options:
2176
2177 @table @option
2178
2179 @item list_voices
2180 If set to 1, list the names of the available voices and exit
2181 immediately. Default value is 0.
2182
2183 @item nb_samples, n
2184 Set the maximum number of samples per frame. Default value is 512.
2185
2186 @item textfile
2187 Set the filename containing the text to speak.
2188
2189 @item text
2190 Set the text to speak.
2191
2192 @item voice, v
2193 Set the voice to use for the speech synthesis. Default value is
2194 @code{kal}. See also the @var{list_voices} option.
2195 @end table
2196
2197 @subsection Examples
2198
2199 @itemize
2200 @item
2201 Read from file @file{speech.txt}, and synthetize the text using the
2202 standard flite voice:
2203 @example
2204 flite=textfile=speech.txt
2205 @end example
2206
2207 @item
2208 Read the specified text selecting the @code{slt} voice:
2209 @example
2210 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
2211 @end example
2212
2213 @item
2214 Input text to ffmpeg:
2215 @example
2216 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
2217 @end example
2218
2219 @item
2220 Make @file{ffplay} speak the specified text, using @code{flite} and
2221 the @code{lavfi} device:
2222 @example
2223 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
2224 @end example
2225 @end itemize
2226
2227 For more information about libflite, check:
2228 @url{http://www.speech.cs.cmu.edu/flite/}
2229
2230 @section sine
2231
2232 Generate an audio signal made of a sine wave with amplitude 1/8.
2233
2234 The audio signal is bit-exact.
2235
2236 The filter accepts the following options:
2237
2238 @table @option
2239
2240 @item frequency, f
2241 Set the carrier frequency. Default is 440 Hz.
2242
2243 @item beep_factor, b
2244 Enable a periodic beep every second with frequency @var{beep_factor} times
2245 the carrier frequency. Default is 0, meaning the beep is disabled.
2246
2247 @item sample_rate, r
2248 Specify the sample rate, default is 44100.
2249
2250 @item duration, d
2251 Specify the duration of the generated audio stream.
2252
2253 @item samples_per_frame
2254 Set the number of samples per output frame, default is 1024.
2255 @end table
2256
2257 @subsection Examples
2258
2259 @itemize
2260
2261 @item
2262 Generate a simple 440 Hz sine wave:
2263 @example
2264 sine
2265 @end example
2266
2267 @item
2268 Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
2269 @example
2270 sine=220:4:d=5
2271 sine=f=220:b=4:d=5
2272 sine=frequency=220:beep_factor=4:duration=5
2273 @end example
2274
2275 @end itemize
2276
2277 @c man end AUDIO SOURCES
2278
2279 @chapter Audio Sinks
2280 @c man begin AUDIO SINKS
2281
2282 Below is a description of the currently available audio sinks.
2283
2284 @section abuffersink
2285
2286 Buffer audio frames, and make them available to the end of filter chain.
2287
2288 This sink is mainly intended for programmatic use, in particular
2289 through the interface defined in @file{libavfilter/buffersink.h}
2290 or the options system.
2291
2292 It accepts a pointer to an AVABufferSinkContext structure, which
2293 defines the incoming buffers' formats, to be passed as the opaque
2294 parameter to @code{avfilter_init_filter} for initialization.
2295
2296 @section anullsink
2297
2298 Null audio sink, do absolutely nothing with the input audio. It is
2299 mainly useful as a template and to be employed in analysis / debugging
2300 tools.
2301
2302 @c man end AUDIO SINKS
2303
2304 @chapter Video Filters
2305 @c man begin VIDEO FILTERS
2306
2307 When you configure your FFmpeg build, you can disable any of the
2308 existing filters using @code{--disable-filters}.
2309 The configure output will show the video filters included in your
2310 build.
2311
2312 Below is a description of the currently available video filters.
2313
2314 @section alphaextract
2315
2316 Extract the alpha component from the input as a grayscale video. This
2317 is especially useful with the @var{alphamerge} filter.
2318
2319 @section alphamerge
2320
2321 Add or replace the alpha component of the primary input with the
2322 grayscale value of a second input. This is intended for use with
2323 @var{alphaextract} to allow the transmission or storage of frame
2324 sequences that have alpha in a format that doesn't support an alpha
2325 channel.
2326
2327 For example, to reconstruct full frames from a normal YUV-encoded video
2328 and a separate video created with @var{alphaextract}, you might use:
2329 @example
2330 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
2331 @end example
2332
2333 Since this filter is designed for reconstruction, it operates on frame
2334 sequences without considering timestamps, and terminates when either
2335 input reaches end of stream. This will cause problems if your encoding
2336 pipeline drops frames. If you're trying to apply an image as an
2337 overlay to a video stream, consider the @var{overlay} filter instead.
2338
2339 @section ass
2340
2341 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
2342 and libavformat to work. On the other hand, it is limited to ASS (Advanced
2343 Substation Alpha) subtitles files.
2344
2345 @section bbox
2346
2347 Compute the bounding box for the non-black pixels in the input frame
2348 luminance plane.
2349
2350 This filter computes the bounding box containing all the pixels with a
2351 luminance value greater than the minimum allowed value.
2352 The parameters describing the bounding box are printed on the filter
2353 log.
2354
2355 The filter accepts the following option:
2356
2357 @table @option
2358 @item min_val
2359 Set the minimal luminance value. Default is @code{16}.
2360 @end table
2361
2362 @section blackdetect
2363
2364 Detect video intervals that are (almost) completely black. Can be
2365 useful to detect chapter transitions, commercials, or invalid
2366 recordings. Output lines contains the time for the start, end and
2367 duration of the detected black interval expressed in seconds.
2368
2369 In order to display the output lines, you need to set the loglevel at
2370 least to the AV_LOG_INFO value.
2371
2372 The filter accepts the following options:
2373
2374 @table @option
2375 @item black_min_duration, d
2376 Set the minimum detected black duration expressed in seconds. It must
2377 be a non-negative floating point number.
2378
2379 Default value is 2.0.
2380
2381 @item picture_black_ratio_th, pic_th
2382 Set the threshold for considering a picture "black".
2383 Express the minimum value for the ratio:
2384 @example
2385 @var{nb_black_pixels} / @var{nb_pixels}
2386 @end example
2387
2388 for which a picture is considered black.
2389 Default value is 0.98.
2390
2391 @item pixel_black_th, pix_th
2392 Set the threshold for considering a pixel "black".
2393
2394 The threshold expresses the maximum pixel luminance value for which a
2395 pixel is considered "black". The provided value is scaled according to
2396 the following equation:
2397 @example
2398 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
2399 @end example
2400
2401 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
2402 the input video format, the range is [0-255] for YUV full-range
2403 formats and [16-235] for YUV non full-range formats.
2404
2405 Default value is 0.10.
2406 @end table
2407
2408 The following example sets the maximum pixel threshold to the minimum
2409 value, and detects only black intervals of 2 or more seconds:
2410 @example
2411 blackdetect=d=2:pix_th=0.00
2412 @end example
2413
2414 @section blackframe
2415
2416 Detect frames that are (almost) completely black. Can be useful to
2417 detect chapter transitions or commercials. Output lines consist of
2418 the frame number of the detected frame, the percentage of blackness,
2419 the position in the file if known or -1 and the timestamp in seconds.
2420
2421 In order to display the output lines, you need to set the loglevel at
2422 least to the AV_LOG_INFO value.
2423
2424 The filter accepts the following options:
2425
2426 @table @option
2427
2428 @item amount
2429 Set the percentage of the pixels that have to be below the threshold, defaults
2430 to @code{98}.
2431
2432 @item threshold, thresh
2433 Set the threshold below which a pixel value is considered black, defaults to
2434 @code{32}.
2435
2436 @end table
2437
2438 @section blend
2439
2440 Blend two video frames into each other.
2441
2442 It takes two input streams and outputs one stream, the first input is the
2443 "top" layer and second input is "bottom" layer.
2444 Output terminates when shortest input terminates.
2445
2446 A description of the accepted options follows.
2447
2448 @table @option
2449 @item c0_mode
2450 @item c1_mode
2451 @item c2_mode
2452 @item c3_mode
2453 @item all_mode
2454 Set blend mode for specific pixel component or all pixel components in case
2455 of @var{all_mode}. Default value is @code{normal}.
2456
2457 Available values for component modes are:
2458 @table @samp
2459 @item addition
2460 @item and
2461 @item average
2462 @item burn
2463 @item darken
2464 @item difference
2465 @item divide
2466 @item dodge
2467 @item exclusion
2468 @item hardlight
2469 @item lighten
2470 @item multiply
2471 @item negation
2472 @item normal
2473 @item or
2474 @item overlay
2475 @item phoenix
2476 @item pinlight
2477 @item reflect
2478 @item screen
2479 @item softlight
2480 @item subtract
2481 @item vividlight
2482 @item xor
2483 @end table
2484
2485 @item c0_opacity
2486 @item c1_opacity
2487 @item c2_opacity
2488 @item c3_opacity
2489 @item all_opacity
2490 Set blend opacity for specific pixel component or all pixel components in case
2491 of @var{all_opacity}. Only used in combination with pixel component blend modes.
2492
2493 @item c0_expr
2494 @item c1_expr
2495 @item c2_expr
2496 @item c3_expr
2497 @item all_expr
2498 Set blend expression for specific pixel component or all pixel components in case
2499 of @var{all_expr}. Note that related mode options will be ignored if those are set.
2500
2501 The expressions can use the following variables:
2502
2503 @table @option
2504 @item N
2505 The sequential number of the filtered frame, starting from @code{0}.
2506
2507 @item X
2508 @item Y
2509 the coordinates of the current sample
2510
2511 @item W
2512 @item H
2513 the width and height of currently filtered plane
2514
2515 @item SW
2516 @item SH
2517 Width and height scale depending on the currently filtered plane. It is the
2518 ratio between the corresponding luma plane number of pixels and the current
2519 plane ones. E.g. for YUV4:2:0 the values are @code{1,1} for the luma plane, and
2520 @code{0.5,0.5} for chroma planes.
2521
2522 @item T
2523 Time of the current frame, expressed in seconds.
2524
2525 @item TOP, A
2526 Value of pixel component at current location for first video frame (top layer).
2527
2528 @item BOTTOM, B
2529 Value of pixel component at current location for second video frame (bottom layer).
2530 @end table
2531
2532 @item shortest
2533 Force termination when the shortest input terminates. Default is @code{0}.
2534 @item repeatlast
2535 Continue applying the last bottom frame after the end of the stream. A value of
2536 @code{0} disable the filter after the last frame of the bottom layer is reached.
2537 Default is @code{1}.
2538 @end table
2539
2540 @subsection Examples
2541
2542 @itemize
2543 @item
2544 Apply transition from bottom layer to top layer in first 10 seconds:
2545 @example
2546 blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
2547 @end example
2548
2549 @item
2550 Apply 1x1 checkerboard effect:
2551 @example
2552 blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
2553 @end example
2554
2555 @item
2556 Apply uncover left effect:
2557 @example
2558 blend=all_expr='if(gte(N*SW+X,W),A,B)'
2559 @end example
2560
2561 @item
2562 Apply uncover down effect:
2563 @example
2564 blend=all_expr='if(gte(Y-N*SH,0),A,B)'
2565 @end example
2566
2567 @item
2568 Apply uncover up-left effect:
2569 @example
2570 blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
2571 @end example
2572 @end itemize
2573
2574 @section boxblur
2575
2576 Apply boxblur algorithm to the input video.
2577
2578 The filter accepts the following options:
2579
2580 @table @option
2581
2582 @item luma_radius, lr
2583 @item luma_power, lp
2584 @item chroma_radius, cr
2585 @item chroma_power, cp
2586 @item alpha_radius, ar
2587 @item alpha_power, ap
2588
2589 @end table
2590
2591 A description of the accepted options follows.
2592
2593 @table @option
2594 @item luma_radius, lr
2595 @item chroma_radius, cr
2596 @item alpha_radius, ar
2597 Set an expression for the box radius in pixels used for blurring the
2598 corresponding input plane.
2599
2600 The radius value must be a non-negative number, and must not be
2601 greater than the value of the expression @code{min(w,h)/2} for the
2602 luma and alpha planes, and of @code{min(cw,ch)/2} for the chroma
2603 planes.
2604
2605 Default value for @option{luma_radius} is "2". If not specified,
2606 @option{chroma_radius} and @option{alpha_radius} default to the
2607 corresponding value set for @option{luma_radius}.
2608
2609 The expressions can contain the following constants:
2610 @table @option
2611 @item w
2612 @item h
2613 the input width and height in pixels
2614
2615 @item cw
2616 @item ch
2617 the input chroma image width and height in pixels
2618
2619 @item hsub
2620 @item vsub
2621 horizontal and vertical chroma subsample values. For example for the
2622 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2623 @end table
2624
2625 @item luma_power, lp
2626 @item chroma_power, cp
2627 @item alpha_power, ap
2628 Specify how many times the boxblur filter is applied to the
2629 corresponding plane.
2630
2631 Default value for @option{luma_power} is 2. If not specified,
2632 @option{chroma_power} and @option{alpha_power} default to the
2633 corresponding value set for @option{luma_power}.
2634
2635 A value of 0 will disable the effect.
2636 @end table
2637
2638 @subsection Examples
2639
2640 @itemize
2641 @item
2642 Apply a boxblur filter with luma, chroma, and alpha radius
2643 set to 2:
2644 @example
2645 boxblur=luma_radius=2:luma_power=1
2646 boxblur=2:1
2647 @end example
2648
2649 @item
2650 Set luma radius to 2, alpha and chroma radius to 0:
2651 @example
2652 boxblur=2:1:cr=0:ar=0
2653 @end example
2654
2655 @item
2656 Set luma and chroma radius to a fraction of the video dimension:
2657 @example
2658 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
2659 @end example
2660 @end itemize
2661
2662 @section colorbalance
2663 Modify intensity of primary colors (red, green and blue) of input frames.
2664
2665 The filter allows an input frame to be adjusted in the shadows, midtones or highlights
2666 regions for the red-cyan, green-magenta or blue-yellow balance.
2667
2668 A positive adjustment value shifts the balance towards the primary color, a negative
2669 value towards the complementary color.
2670
2671 The filter accepts the following options:
2672
2673 @table @option
2674 @item rs
2675 @item gs
2676 @item bs
2677 Adjust red, green and blue shadows (darkest pixels).
2678
2679 @item rm
2680 @item gm
2681 @item bm
2682 Adjust red, green and blue midtones (medium pixels).
2683
2684 @item rh
2685 @item gh
2686 @item bh
2687 Adjust red, green and blue highlights (brightest pixels).
2688
2689 Allowed ranges for options are @code{[-1.0, 1.0]}. Defaults are @code{0}.
2690 @end table
2691
2692 @subsection Examples
2693
2694 @itemize
2695 @item
2696 Add red color cast to shadows:
2697 @example
2698 colorbalance=rs=.3
2699 @end example
2700 @end itemize
2701
2702 @section colorchannelmixer
2703
2704 Adjust video input frames by re-mixing color channels.
2705
2706 This filter modifies a color channel by adding the values associated to
2707 the other channels of the same pixels. For example if the value to
2708 modify is red, the output value will be:
2709 @example
2710 @var{red}=@var{red}*@var{rr} + @var{blue}*@var{rb} + @var{green}*@var{rg} + @var{alpha}*@var{ra}
2711 @end example
2712
2713 The filter accepts the following options:
2714
2715 @table @option
2716 @item rr
2717 @item rg
2718 @item rb
2719 @item ra
2720 Adjust contribution of input red, green, blue and alpha channels for output red channel.
2721 Default is @code{1} for @var{rr}, and @code{0} for @var{rg}, @var{rb} and @var{ra}.
2722
2723 @item gr
2724 @item gg
2725 @item gb
2726 @item ga
2727 Adjust contribution of input red, green, blue and alpha channels for output green channel.
2728 Default is @code{1} for @var{gg}, and @code{0} for @var{gr}, @var{gb} and @var{ga}.
2729
2730 @item br
2731 @item bg
2732 @item bb
2733 @item ba
2734 Adjust contribution of input red, green, blue and alpha channels for output blue channel.
2735 Default is @code{1} for @var{bb}, and @code{0} for @var{br}, @var{bg} and @var{ba}.
2736
2737 @item ar
2738 @item ag
2739 @item ab
2740 @item aa
2741 Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
2742 Default is @code{1} for @var{aa}, and @code{0} for @var{ar}, @var{ag} and @var{ab}.
2743
2744 Allowed ranges for options are @code{[-2.0, 2.0]}.
2745 @end table
2746
2747 @subsection Examples
2748
2749 @itemize
2750 @item
2751 Convert source to grayscale:
2752 @example
2753 colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
2754 @end example
2755 @item
2756 Simulate sepia tones:
2757 @example
2758 colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
2759 @end example
2760 @end itemize
2761
2762 @section colormatrix
2763
2764 Convert color matrix.
2765
2766 The filter accepts the following options:
2767
2768 @table @option
2769 @item src
2770 @item dst
2771 Specify the source and destination color matrix. Both values must be
2772 specified.
2773
2774 The accepted values are:
2775 @table @samp
2776 @item bt709
2777 BT.709
2778
2779 @item bt601
2780 BT.601
2781
2782 @item smpte240m
2783 SMPTE-240M
2784
2785 @item fcc
2786 FCC
2787 @end table
2788 @end table
2789
2790 For example to convert from BT.601 to SMPTE-240M, use the command:
2791 @example
2792 colormatrix=bt601:smpte240m
2793 @end example
2794
2795 @section copy
2796
2797 Copy the input source unchanged to the output. Mainly useful for
2798 testing purposes.
2799
2800 @section crop
2801
2802 Crop the input video to given dimensions.
2803
2804 The filter accepts the following options:
2805
2806 @table @option
2807 @item w, out_w
2808 Width of the output video. It defaults to @code{iw}.
2809 This expression is evaluated only once during the filter
2810 configuration.
2811
2812 @item h, out_h
2813 Height of the output video. It defaults to @code{ih}.
2814 This expression is evaluated only once during the filter
2815 configuration.
2816
2817 @item x
2818 Horizontal position, in the input video, of the left edge of the output video.
2819 It defaults to @code{(in_w-out_w)/2}.
2820 This expression is evaluated per-frame.
2821
2822 @item y
2823 Vertical position, in the input video, of the top edge of the output video.
2824 It defaults to @code{(in_h-out_h)/2}.
2825 This expression is evaluated per-frame.
2826
2827 @item keep_aspect
2828 If set to 1 will force the output display aspect ratio
2829 to be the same of the input, by changing the output sample aspect
2830 ratio. It defaults to 0.
2831 @end table
2832
2833 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
2834 expressions containing the following constants:
2835
2836 @table @option
2837 @item x
2838 @item y
2839 the computed values for @var{x} and @var{y}. They are evaluated for
2840 each new frame.
2841
2842 @item in_w
2843 @item in_h
2844 the input width and height
2845
2846 @item iw
2847 @item ih
2848 same as @var{in_w} and @var{in_h}
2849
2850 @item out_w
2851 @item out_h
2852 the output (cropped) width and height
2853
2854 @item ow
2855 @item oh
2856 same as @var{out_w} and @var{out_h}
2857
2858 @item a
2859 same as @var{iw} / @var{ih}
2860
2861 @item sar
2862 input sample aspect ratio
2863
2864 @item dar
2865 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2866
2867 @item hsub
2868 @item vsub
2869 horizontal and vertical chroma subsample values. For example for the
2870 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2871
2872 @item n
2873 the number of input frame, starting from 0
2874
2875 @item pos
2876 the position in the file of the input frame, NAN if unknown
2877
2878 @item t
2879 timestamp expressed in seconds, NAN if the input timestamp is unknown
2880
2881 @end table
2882
2883 The expression for @var{out_w} may depend on the value of @var{out_h},
2884 and the expression for @var{out_h} may depend on @var{out_w}, but they
2885 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
2886 evaluated after @var{out_w} and @var{out_h}.
2887
2888 The @var{x} and @var{y} parameters specify the expressions for the
2889 position of the top-left corner of the output (non-cropped) area. They
2890 are evaluated for each frame. If the evaluated value is not valid, it
2891 is approximated to the nearest valid value.
2892
2893 The expression for @var{x} may depend on @var{y}, and the expression
2894 for @var{y} may depend on @var{x}.
2895
2896 @subsection Examples
2897
2898 @itemize
2899 @item
2900 Crop area with size 100x100 at position (12,34).
2901 @example
2902 crop=100:100:12:34
2903 @end example
2904
2905 Using named options, the example above becomes:
2906 @example
2907 crop=w=100:h=100:x=12:y=34
2908 @end example
2909
2910 @item
2911 Crop the central input area with size 100x100:
2912 @example
2913 crop=100:100
2914 @end example
2915
2916 @item
2917 Crop the central input area with size 2/3 of the input video:
2918 @example
2919 crop=2/3*in_w:2/3*in_h
2920 @end example
2921
2922 @item
2923 Crop the input video central square:
2924 @example
2925 crop=out_w=in_h
2926 crop=in_h
2927 @end example
2928
2929 @item
2930 Delimit the rectangle with the top-left corner placed at position
2931 100:100 and the right-bottom corner corresponding to the right-bottom
2932 corner of the input image:
2933 @example
2934 crop=in_w-100:in_h-100:100:100
2935 @end example
2936
2937 @item
2938 Crop 10 pixels from the left and right borders, and 20 pixels from
2939 the top and bottom borders
2940 @example
2941 crop=in_w-2*10:in_h-2*20
2942 @end example
2943
2944 @item
2945 Keep only the bottom right quarter of the input image:
2946 @example
2947 crop=in_w/2:in_h/2:in_w/2:in_h/2
2948 @end example
2949
2950 @item
2951 Crop height for getting Greek harmony:
2952 @example
2953 crop=in_w:1/PHI*in_w
2954 @end example
2955
2956 @item
2957 Appply trembling effect:
2958 @example
2959 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)
2960 @end example
2961
2962 @item
2963 Apply erratic camera effect depending on timestamp:
2964 @example
2965 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)"
2966 @end example
2967
2968 @item
2969 Set x depending on the value of y:
2970 @example
2971 crop=in_w/2:in_h/2:y:10+10*sin(n/10)
2972 @end example
2973 @end itemize
2974
2975 @section cropdetect
2976
2977 Auto-detect crop size.
2978
2979 Calculate necessary cropping parameters and prints the recommended
2980 parameters through the logging system. The detected dimensions
2981 correspond to the non-black area of the input video.
2982
2983 The filter accepts the following options:
2984
2985 @table @option
2986
2987 @item limit
2988 Set higher black value threshold, which can be optionally specified
2989 from nothing (0) to everything (255). An intensity value greater
2990 to the set value is considered non-black. Default value is 24.
2991
2992 @item round
2993 Set the value for which the width/height should be divisible by. The
2994 offset is automatically adjusted to center the video. Use 2 to get
2995 only even dimensions (needed for 4:2:2 video). 16 is best when
2996 encoding to most video codecs. Default value is 16.
2997
2998 @item reset_count, reset
2999 Set the counter that determines after how many frames cropdetect will
3000 reset the previously detected largest video area and start over to
3001 detect the current optimal crop area. Default value is 0.
3002
3003 This can be useful when channel logos distort the video area. 0
3004 indicates never reset and return the largest area encountered during
3005 playback.
3006 @end table
3007
3008 @anchor{curves}
3009 @section curves
3010
3011 Apply color adjustments using curves.
3012
3013 This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
3014 component (red, green and blue) has its values defined by @var{N} key points
3015 tied from each other using a smooth curve. The x-axis represents the pixel
3016 values from the input frame, and the y-axis the new pixel values to be set for
3017 the output frame.
3018
3019 By default, a component curve is defined by the two points @var{(0;0)} and
3020 @var{(1;1)}. This creates a straight line where each original pixel value is
3021 "adjusted" to its own value, which means no change to the image.
3022
3023 The filter allows you to redefine these two points and add some more. A new
3024 curve (using a natural cubic spline interpolation) will be define to pass
3025 smoothly through all these new coordinates. The new defined points needs to be
3026 strictly increasing over the x-axis, and their @var{x} and @var{y} values must
3027 be in the @var{[0;1]} interval.  If the computed curves happened to go outside
3028 the vector spaces, the values will be clipped accordingly.
3029
3030 If there is no key point defined in @code{x=0}, the filter will automatically
3031 insert a @var{(0;0)} point. In the same way, if there is no key point defined
3032 in @code{x=1}, the filter will automatically insert a @var{(1;1)} point.
3033
3034 The filter accepts the following options:
3035
3036 @table @option
3037 @item preset
3038 Select one of the available color presets. This option can be used in addition
3039 to the @option{r}, @option{g}, @option{b} parameters; in this case, the later
3040 options takes priority on the preset values.
3041 Available presets are:
3042 @table @samp
3043 @item none
3044 @item color_negative
3045 @item cross_process
3046 @item darker
3047 @item increase_contrast
3048 @item lighter
3049 @item linear_contrast
3050 @item medium_contrast
3051 @item negative
3052 @item strong_contrast
3053 @item vintage
3054 @end table
3055 Default is @code{none}.
3056 @item master, m
3057 Set the master key points. These points will define a second pass mapping. It
3058 is sometimes called a "luminance" or "value" mapping. It can be used with
3059 @option{r}, @option{g}, @option{b} or @option{all} since it acts like a
3060 post-processing LUT.
3061 @item red, r
3062 Set the key points for the red component.
3063 @item green, g
3064 Set the key points for the green component.
3065 @item blue, b
3066 Set the key points for the blue component.
3067 @item all
3068 Set the key points for all components (not including master).
3069 Can be used in addition to the other key points component
3070 options. In this case, the unset component(s) will fallback on this
3071 @option{all} setting.
3072 @item psfile
3073 Specify a Photoshop curves file (@code{.asv}) to import the settings from.
3074 @end table
3075
3076 To avoid some filtergraph syntax conflicts, each key points list need to be
3077 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
3078
3079 @subsection Examples
3080
3081 @itemize
3082 @item
3083 Increase slightly the middle level of blue:
3084 @example
3085 curves=blue='0.5/0.58'
3086 @end example
3087
3088 @item
3089 Vintage effect:
3090 @example
3091 curves=r='0/0.11 .42/.51 1/0.95':g='0.50/0.48':b='0/0.22 .49/.44 1/0.8'
3092 @end example
3093 Here we obtain the following coordinates for each components:
3094 @table @var
3095 @item red
3096 @code{(0;0.11) (0.42;0.51) (1;0.95)}
3097 @item green
3098 @code{(0;0) (0.50;0.48) (1;1)}
3099 @item blue
3100 @code{(0;0.22) (0.49;0.44) (1;0.80)}
3101 @end table
3102
3103 @item
3104 The previous example can also be achieved with the associated built-in preset:
3105 @example
3106 curves=preset=vintage
3107 @end example
3108
3109 @item
3110 Or simply:
3111 @example
3112 curves=vintage
3113 @end example
3114
3115 @item
3116 Use a Photoshop preset and redefine the points of the green component:
3117 @example
3118 curves=psfile='MyCurvesPresets/purple.asv':green='0.45/0.53'
3119 @end example
3120 @end itemize
3121
3122 @section dctdnoiz
3123
3124 Denoise frames using 2D DCT (frequency domain filtering).
3125
3126 This filter is not designed for real time and can be extremely slow.
3127
3128 The filter accepts the following options:
3129
3130 @table @option
3131 @item sigma, s
3132 Set the noise sigma constant.
3133
3134 This @var{sigma} defines a hard threshold of @code{3 * sigma}; every DCT
3135 coefficient (absolute value) below this threshold with be dropped.
3136
3137 If you need a more advanced filtering, see @option{expr}.
3138
3139 Default is @code{0}.
3140
3141 @item overlap
3142 Set number overlapping pixels for each block. Each block is of size
3143 @code{16x16}. Since the filter can be slow, you may want to reduce this value,
3144 at the cost of a less effective filter and the risk of various artefacts.
3145
3146 If the overlapping value doesn't allow to process the whole input width or
3147 height, a warning will be displayed and according borders won't be denoised.
3148
3149 Default value is @code{15}.
3150
3151 @item expr, e
3152 Set the coefficient factor expression.
3153
3154 For each coefficient of a DCT block, this expression will be evaluated as a
3155 multiplier value for the coefficient.
3156
3157 If this is option is set, the @option{sigma} option will be ignored.
3158
3159 The absolute value of the coefficient can be accessed through the @var{c}
3160 variable.
3161 @end table
3162
3163 @subsection Examples
3164
3165 Apply a denoise with a @option{sigma} of @code{4.5}:
3166 @example
3167 dctdnoiz=4.5
3168 @end example
3169
3170 The same operation can be achieved using the expression system:
3171 @example
3172 dctdnoiz=e='gte(c, 4.5*3)'
3173 @end example
3174
3175 @anchor{decimate}
3176 @section decimate
3177
3178 Drop duplicated frames at regular intervals.
3179
3180 The filter accepts the following options:
3181
3182 @table @option
3183 @item cycle
3184 Set the number of frames from which one will be dropped. Setting this to
3185 @var{N} means one frame in every batch of @var{N} frames will be dropped.
3186 Default is @code{5}.
3187
3188 @item dupthresh
3189 Set the threshold for duplicate detection. If the difference metric for a frame
3190 is less than or equal to this value, then it is declared as duplicate. Default
3191 is @code{1.1}
3192
3193 @item scthresh
3194 Set scene change threshold. Default is @code{15}.
3195
3196 @item blockx
3197 @item blocky
3198 Set the size of the x and y-axis blocks used during metric calculations.
3199 Larger blocks give better noise suppression, but also give worse detection of
3200 small movements. Must be a power of two. Default is @code{32}.
3201
3202 @item ppsrc
3203 Mark main input as a pre-processed input and activate clean source input
3204 stream. This allows the input to be pre-processed with various filters to help
3205 the metrics calculation while keeping the frame selection lossless. When set to
3206 @code{1}, the first stream is for the pre-processed input, and the second
3207 stream is the clean source from where the kept frames are chosen. Default is
3208 @code{0}.
3209
3210 @item chroma
3211 Set whether or not chroma is considered in the metric calculations. Default is
3212 @code{1}.
3213 @end table
3214
3215 @section dejudder
3216
3217 Remove judder produced by partially interlaced telecined content.
3218
3219 Judder can be introduced, for instance, by @ref{pullup} filter. If the original
3220 source was partially telecined content then the output of @code{pullup,dejudder}
3221 will have a variable frame rate. May change the recorded frame rate of the
3222 container. Aside from that change, this filter will not affect constant frame
3223 rate video.
3224
3225 The option available in this filter is:
3226 @table @option
3227
3228 @item cycle
3229 Specify the length of the window over which the judder repeats.
3230
3231 Accepts any interger greater than 1. Useful values are:
3232 @table @samp
3233
3234 @item 4
3235 If the original was telecined from 24 to 30 fps (Film to NTSC).
3236
3237 @item 5
3238 If the original was telecined from 25 to 30 fps (PAL to NTSC).
3239
3240 @item 20
3241 If a mixture of the two.
3242 @end table
3243
3244 The default is @samp{4}.
3245 @end table
3246
3247 @section delogo
3248
3249 Suppress a TV station logo by a simple interpolation of the surrounding
3250 pixels. Just set a rectangle covering the logo and watch it disappear
3251 (and sometimes something even uglier appear - your mileage may vary).
3252
3253 This filter accepts the following options:
3254 @table @option
3255
3256 @item x
3257 @item y
3258 Specify the top left corner coordinates of the logo. They must be
3259 specified.
3260
3261 @item w
3262 @item h
3263 Specify the width and height of the logo to clear. They must be
3264 specified.
3265
3266 @item band, t
3267 Specify the thickness of the fuzzy edge of the rectangle (added to
3268 @var{w} and @var{h}). The default value is 4.
3269
3270 @item show
3271 When set to 1, a green rectangle is drawn on the screen to simplify
3272 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.
3273 The default value is 0.
3274
3275 The rectangle is drawn on the outermost pixels which will be (partly)
3276 replaced with interpolated values. The values of the next pixels
3277 immediately outside this rectangle in each direction will be used to
3278 compute the interpolated pixel values inside the rectangle.
3279
3280 @end table
3281
3282 @subsection Examples
3283
3284 @itemize
3285 @item
3286 Set a rectangle covering the area with top left corner coordinates 0,0
3287 and size 100x77, setting a band of size 10:
3288 @example
3289 delogo=x=0:y=0:w=100:h=77:band=10
3290 @end example
3291
3292 @end itemize
3293
3294 @section deshake
3295
3296 Attempt to fix small changes in horizontal and/or vertical shift. This
3297 filter helps remove camera shake from hand-holding a camera, bumping a
3298 tripod, moving on a vehicle, etc.
3299
3300 The filter accepts the following options:
3301
3302 @table @option
3303
3304 @item x
3305 @item y
3306 @item w
3307 @item h
3308 Specify a rectangular area where to limit the search for motion
3309 vectors.
3310 If desired the search for motion vectors can be limited to a
3311 rectangular area of the frame defined by its top left corner, width
3312 and height. These parameters have the same meaning as the drawbox
3313 filter which can be used to visualise the position of the bounding
3314 box.
3315
3316 This is useful when simultaneous movement of subjects within the frame
3317 might be confused for camera motion by the motion vector search.
3318
3319 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
3320 then the full frame is used. This allows later options to be set
3321 without specifying the bounding box for the motion vector search.
3322
3323 Default - search the whole frame.
3324
3325 @item rx
3326 @item ry
3327 Specify the maximum extent of movement in x and y directions in the
3328 range 0-64 pixels. Default 16.
3329
3330 @item edge
3331 Specify how to generate pixels to fill blanks at the edge of the
3332 frame. Available values are:
3333 @table @samp
3334 @item blank, 0
3335 Fill zeroes at blank locations
3336 @item original, 1
3337 Original image at blank locations
3338 @item clamp, 2
3339 Extruded edge value at blank locations
3340 @item mirror, 3
3341 Mirrored edge at blank locations
3342 @end table
3343 Default value is @samp{mirror}.
3344
3345 @item blocksize
3346 Specify the blocksize to use for motion search. Range 4-128 pixels,
3347 default 8.
3348
3349 @item contrast
3350 Specify the contrast threshold for blocks. Only blocks with more than
3351 the specified contrast (difference between darkest and lightest
3352 pixels) will be considered. Range 1-255, default 125.
3353
3354 @item search
3355 Specify the search strategy. Available values are:
3356 @table @samp
3357 @item exhaustive, 0
3358 Set exhaustive search
3359 @item less, 1
3360 Set less exhaustive search.
3361 @end table
3362 Default value is @samp{exhaustive}.
3363
3364 @item filename
3365 If set then a detailed log of the motion search is written to the
3366 specified file.
3367
3368 @item opencl
3369 If set to 1, specify using OpenCL capabilities, only available if
3370 FFmpeg was configured with @code{--enable-opencl}. Default value is 0.
3371
3372 @end table
3373
3374 @section drawbox
3375
3376 Draw a colored box on the input image.
3377
3378 This filter accepts the following options:
3379
3380 @table @option
3381 @item x
3382 @item y
3383 The expressions which specify the top left corner coordinates of the box. Default to 0.
3384
3385 @item width, w
3386 @item height, h
3387 The expressions which specify the width and height of the box, if 0 they are interpreted as
3388 the input width and height. Default to 0.
3389
3390 @item color, c
3391 Specify the color of the box to write. For the general syntax of this option,
3392 check the "Color" section in the ffmpeg-utils manual. If the special
3393 value @code{invert} is used, the box edge color is the same as the
3394 video with inverted luma.
3395
3396 @item thickness, t
3397 The expression which sets the thickness of the box edge. Default value is @code{3}.
3398
3399 See below for the list of accepted constants.
3400 @end table
3401
3402 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
3403 following constants:
3404
3405 @table @option
3406 @item dar
3407 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
3408
3409 @item hsub
3410 @item vsub
3411 horizontal and vertical chroma subsample values. For example for the
3412 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3413
3414 @item in_h, ih
3415 @item in_w, iw
3416 The input width and height.
3417
3418 @item sar
3419 The input sample aspect ratio.
3420
3421 @item x
3422 @item y
3423 The x and y offset coordinates where the box is drawn.
3424
3425 @item w
3426 @item h
3427 The width and height of the drawn box.
3428
3429 @item t
3430 The thickness of the drawn box.
3431
3432 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
3433 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
3434
3435 @end table
3436
3437 @subsection Examples
3438
3439 @itemize
3440 @item
3441 Draw a black box around the edge of the input image:
3442 @example
3443 drawbox
3444 @end example
3445
3446 @item
3447 Draw a box with color red and an opacity of 50%:
3448 @example
3449 drawbox=10:20:200:60:red@@0.5
3450 @end example
3451
3452 The previous example can be specified as:
3453 @example
3454 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
3455 @end example
3456
3457 @item
3458 Fill the box with pink color:
3459 @example
3460 drawbox=x=10:y=10:w=100:h=100:color=pink@@0.5:t=max
3461 @end example
3462
3463 @item
3464 Draw a 2-pixel red 2.40:1 mask:
3465 @example
3466 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
3467 @end example
3468 @end itemize
3469
3470 @section drawgrid
3471
3472 Draw a grid on the input image.
3473
3474 This filter accepts the following options:
3475
3476 @table @option
3477 @item x
3478 @item y
3479 The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0.
3480
3481 @item width, w
3482 @item height, h
3483 The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the
3484 input width and height, respectively, minus @code{thickness}, so image gets
3485 framed. Default to 0.
3486
3487 @item color, c
3488 Specify the color of the grid. For the general syntax of this option,
3489 check the "Color" section in the ffmpeg-utils manual. If the special
3490 value @code{invert} is used, the grid color is the same as the
3491 video with inverted luma.
3492
3493 @item thickness, t
3494 The expression which sets the thickness of the grid line. Default value is @code{1}.
3495
3496 See below for the list of accepted constants.
3497 @end table
3498
3499 The parameters for @var{x}, @var{y}, @var{w} and @var{h} and @var{t} are expressions containing the
3500 following constants:
3501
3502 @table @option
3503 @item dar
3504 The input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}.
3505
3506 @item hsub
3507 @item vsub
3508 horizontal and vertical chroma subsample values. For example for the
3509 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3510
3511 @item in_h, ih
3512 @item in_w, iw
3513 The input grid cell width and height.
3514
3515 @item sar
3516 The input sample aspect ratio.
3517
3518 @item x
3519 @item y
3520 The x and y coordinates of some point of grid intersection (meant to configure offset).
3521
3522 @item w
3523 @item h
3524 The width and height of the drawn cell.
3525
3526 @item t
3527 The thickness of the drawn cell.
3528
3529 These constants allow the @var{x}, @var{y}, @var{w}, @var{h} and @var{t} expressions to refer to
3530 each other, so you may for example specify @code{y=x/dar} or @code{h=w/dar}.
3531
3532 @end table
3533
3534 @subsection Examples
3535
3536 @itemize
3537 @item
3538 Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%:
3539 @example
3540 drawgrid=width=100:height=100:thickness=2:color=red@@0.5
3541 @end example
3542
3543 @item
3544 Draw a white 3x3 grid with an opacity of 50%:
3545 @example
3546 drawgrid=w=iw/3:h=ih/3:t=2:c=white@@0.5
3547 @end example
3548 @end itemize
3549
3550 @anchor{drawtext}
3551 @section drawtext
3552
3553 Draw text string or text from specified file on top of video using the
3554 libfreetype library.
3555
3556 To enable compilation of this filter you need to configure FFmpeg with
3557 @code{--enable-libfreetype}.
3558
3559 @subsection Syntax
3560
3561 The description of the accepted parameters follows.
3562
3563 @table @option
3564
3565 @item box
3566 Used to draw a box around text using background color.
3567 Value should be either 1 (enable) or 0 (disable).
3568 The default value of @var{box} is 0.
3569
3570 @item boxcolor
3571 The color to be used for drawing box around text. For the syntax of this
3572 option, check the "Color" section in the ffmpeg-utils manual.
3573
3574 The default value of @var{boxcolor} is "white".
3575
3576 @item borderw
3577 Set the width of the border to be drawn around the text using @var{bordercolor}.
3578 The default value of @var{borderw} is 0.
3579
3580 @item bordercolor
3581 Set the color to be used for drawing border around text. For the syntax of this
3582 option, check the "Color" section in the ffmpeg-utils manual.
3583
3584 The default value of @var{bordercolor} is "black".
3585
3586 @item expansion
3587 Select how the @var{text} is expanded. Can be either @code{none},
3588 @code{strftime} (deprecated) or
3589 @code{normal} (default). See the @ref{drawtext_expansion, Text expansion} section
3590 below for details.
3591
3592 @item fix_bounds
3593 If true, check and fix text coords to avoid clipping.
3594
3595 @item fontcolor
3596 The color to be used for drawing fonts. For the syntax of this option, check
3597 the "Color" section in the ffmpeg-utils manual.
3598
3599 The default value of @var{fontcolor} is "black".
3600
3601 @item fontfile
3602 The font file to be used for drawing text. Path must be included.
3603 This parameter is mandatory.
3604
3605 @item fontsize
3606 The font size to be used for drawing text.
3607 The default value of @var{fontsize} is 16.
3608
3609 @item ft_load_flags
3610 Flags to be used for loading the fonts.
3611
3612 The flags map the corresponding flags supported by libfreetype, and are
3613 a combination of the following values:
3614 @table @var
3615 @item default
3616 @item no_scale
3617 @item no_hinting
3618 @item render
3619 @item no_bitmap
3620 @item vertical_layout
3621 @item force_autohint
3622 @item crop_bitmap
3623 @item pedantic
3624 @item ignore_global_advance_width
3625 @item no_recurse
3626 @item ignore_transform
3627 @item monochrome
3628 @item linear_design
3629 @item no_autohint
3630 @end table
3631
3632 Default value is "default".
3633
3634 For more information consult the documentation for the FT_LOAD_*
3635 libfreetype flags.
3636
3637 @item shadowcolor
3638 The color to be used for drawing a shadow behind the drawn text. For the
3639 syntax of this option, check the "Color" section in the ffmpeg-utils manual.
3640
3641 The default value of @var{shadowcolor} is "black".
3642
3643 @item shadowx
3644 @item shadowy
3645 The x and y offsets for the text shadow position with respect to the
3646 position of the text. They can be either positive or negative
3647 values. Default value for both is "0".
3648
3649 @item start_number
3650 The starting frame number for the n/frame_num variable. The default value
3651 is "0".
3652
3653 @item tabsize
3654 The size in number of spaces to use for rendering the tab.
3655 Default value is 4.
3656
3657 @item timecode
3658 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
3659 format. It can be used with or without text parameter. @var{timecode_rate}
3660 option must be specified.
3661
3662 @item timecode_rate, rate, r
3663 Set the timecode frame rate (timecode only).
3664
3665 @item text
3666 The text string to be drawn. The text must be a sequence of UTF-8
3667 encoded characters.
3668 This parameter is mandatory if no file is specified with the parameter
3669 @var{textfile}.
3670
3671 @item textfile
3672 A text file containing text to be drawn. The text must be a sequence
3673 of UTF-8 encoded characters.
3674
3675 This parameter is mandatory if no text string is specified with the
3676 parameter @var{text}.
3677
3678 If both @var{text} and @var{textfile} are specified, an error is thrown.
3679
3680 @item reload
3681 If set to 1, the @var{textfile} will be reloaded before each frame.
3682 Be sure to update it atomically, or it may be read partially, or even fail.
3683
3684 @item x
3685 @item y
3686 The expressions which specify the offsets where text will be drawn
3687 within the video frame. They are relative to the top/left border of the
3688 output image.
3689
3690 The default value of @var{x} and @var{y} is "0".
3691
3692 See below for the list of accepted constants and functions.
3693 @end table
3694
3695 The parameters for @var{x} and @var{y} are expressions containing the
3696 following constants and functions:
3697
3698 @table @option
3699 @item dar
3700 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
3701
3702 @item hsub
3703 @item vsub
3704 horizontal and vertical chroma subsample values. For example for the
3705 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3706
3707 @item line_h, lh
3708 the height of each text line
3709
3710 @item main_h, h, H
3711 the input height
3712
3713 @item main_w, w, W
3714 the input width
3715
3716 @item max_glyph_a, ascent
3717 the maximum distance from the baseline to the highest/upper grid
3718 coordinate used to place a glyph outline point, for all the rendered
3719 glyphs.
3720 It is a positive value, due to the grid's orientation with the Y axis
3721 upwards.
3722
3723 @item max_glyph_d, descent
3724 the maximum distance from the baseline to the lowest grid coordinate
3725 used to place a glyph outline point, for all the rendered glyphs.
3726 This is a negative value, due to the grid's orientation, with the Y axis
3727 upwards.
3728
3729 @item max_glyph_h
3730 maximum glyph height, that is the maximum height for all the glyphs
3731 contained in the rendered text, it is equivalent to @var{ascent} -
3732 @var{descent}.
3733
3734 @item max_glyph_w
3735 maximum glyph width, that is the maximum width for all the glyphs
3736 contained in the rendered text
3737
3738 @item n
3739 the number of input frame, starting from 0
3740
3741 @item rand(min, max)
3742 return a random number included between @var{min} and @var{max}
3743
3744 @item sar
3745 input sample aspect ratio
3746
3747 @item t
3748 timestamp expressed in seconds, NAN if the input timestamp is unknown
3749
3750 @item text_h, th
3751 the height of the rendered text
3752
3753 @item text_w, tw
3754 the width of the rendered text
3755
3756 @item x
3757 @item y
3758 the x and y offset coordinates where the text is drawn.
3759
3760 These parameters allow the @var{x} and @var{y} expressions to refer
3761 each other, so you can for example specify @code{y=x/dar}.
3762 @end table
3763
3764 If libavfilter was built with @code{--enable-fontconfig}, then
3765 @option{fontfile} can be a fontconfig pattern or omitted.
3766
3767 @anchor{drawtext_expansion}
3768 @subsection Text expansion
3769
3770 If @option{expansion} is set to @code{strftime},
3771 the filter recognizes strftime() sequences in the provided text and
3772 expands them accordingly. Check the documentation of strftime(). This
3773 feature is deprecated.
3774
3775 If @option{expansion} is set to @code{none}, the text is printed verbatim.
3776
3777 If @option{expansion} is set to @code{normal} (which is the default),
3778 the following expansion mechanism is used.
3779
3780 The backslash character '\', followed by any character, always expands to
3781 the second character.
3782
3783 Sequence of the form @code{%@{...@}} are expanded. The text between the
3784 braces is a function name, possibly followed by arguments separated by ':'.
3785 If the arguments contain special characters or delimiters (':' or '@}'),
3786 they should be escaped.
3787
3788 Note that they probably must also be escaped as the value for the
3789 @option{text} option in the filter argument string and as the filter
3790 argument in the filtergraph description, and possibly also for the shell,
3791 that makes up to four levels of escaping; using a text file avoids these
3792 problems.
3793
3794 The following functions are available:
3795
3796 @table @command
3797
3798 @item expr, e
3799 The expression evaluation result.
3800
3801 It must take one argument specifying the expression to be evaluated,
3802 which accepts the same constants and functions as the @var{x} and
3803 @var{y} values. Note that not all constants should be used, for
3804 example the text size is not known when evaluating the expression, so
3805 the constants @var{text_w} and @var{text_h} will have an undefined
3806 value.
3807
3808 @item gmtime
3809 The time at which the filter is running, expressed in UTC.
3810 It can accept an argument: a strftime() format string.
3811
3812 @item localtime
3813 The time at which the filter is running, expressed in the local time zone.
3814 It can accept an argument: a strftime() format string.
3815
3816 @item metadata
3817 Frame metadata. It must take one argument specifying metadata key.
3818
3819 @item n, frame_num
3820 The frame number, starting from 0.
3821
3822 @item pict_type
3823 A 1 character description of the current picture type.
3824
3825 @item pts
3826 The timestamp of the current frame, in seconds, with microsecond accuracy.
3827
3828 @end table
3829
3830 @subsection Examples
3831
3832 @itemize
3833 @item
3834 Draw "Test Text" with font FreeSerif, using the default values for the
3835 optional parameters.
3836
3837 @example
3838 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
3839 @end example
3840
3841 @item
3842 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
3843 and y=50 (counting from the top-left corner of the screen), text is
3844 yellow with a red box around it. Both the text and the box have an
3845 opacity of 20%.
3846
3847 @example
3848 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
3849           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
3850 @end example
3851
3852 Note that the double quotes are not necessary if spaces are not used
3853 within the parameter list.
3854
3855 @item
3856 Show the text at the center of the video frame:
3857 @example
3858 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
3859 @end example
3860
3861 @item
3862 Show a text line sliding from right to left in the last row of the video
3863 frame. The file @file{LONG_LINE} is assumed to contain a single line
3864 with no newlines.
3865 @example
3866 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
3867 @end example
3868
3869 @item
3870 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
3871 @example
3872 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
3873 @end example
3874
3875 @item
3876 Draw a single green letter "g", at the center of the input video.
3877 The glyph baseline is placed at half screen height.
3878 @example
3879 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
3880 @end example
3881
3882 @item
3883 Show text for 1 second every 3 seconds:
3884 @example
3885 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'"
3886 @end example
3887
3888 @item
3889 Use fontconfig to set the font. Note that the colons need to be escaped.
3890 @example
3891 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
3892 @end example
3893
3894 @item
3895 Print the date of a real-time encoding (see strftime(3)):
3896 @example
3897 drawtext='fontfile=FreeSans.ttf:text=%@{localtime:%a %b %d %Y@}'
3898 @end example
3899
3900 @end itemize
3901
3902 For more information about libfreetype, check:
3903 @url{http://www.freetype.org/}.
3904
3905 For more information about fontconfig, check:
3906 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
3907
3908 @section edgedetect
3909
3910 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
3911
3912 The filter accepts the following options:
3913
3914 @table @option
3915 @item low
3916 @item high
3917 Set low and high threshold values used by the Canny thresholding
3918 algorithm.
3919
3920 The high threshold selects the "strong" edge pixels, which are then
3921 connected through 8-connectivity with the "weak" edge pixels selected
3922 by the low threshold.
3923
3924 @var{low} and @var{high} threshold values must be chosen in the range
3925 [0,1], and @var{low} should be lesser or equal to @var{high}.
3926
3927 Default value for @var{low} is @code{20/255}, and default value for @var{high}
3928 is @code{50/255}.
3929 @end table
3930
3931 Example:
3932 @example
3933 edgedetect=low=0.1:high=0.4
3934 @end example
3935
3936 @section extractplanes
3937
3938 Extract color channel components from input video stream into
3939 separate grayscale video streams.
3940
3941 The filter accepts the following option:
3942
3943 @table @option
3944 @item planes
3945 Set plane(s) to extract.
3946
3947 Available values for planes are:
3948 @table @samp
3949 @item y
3950 @item u
3951 @item v
3952 @item a
3953 @item r
3954 @item g
3955 @item b
3956 @end table
3957
3958 Choosing planes not available in the input will result in an error.
3959 That means you cannot select @code{r}, @code{g}, @code{b} planes
3960 with @code{y}, @code{u}, @code{v} planes at same time.
3961 @end table
3962
3963 @subsection Examples
3964
3965 @itemize
3966 @item
3967 Extract luma, u and v color channel component from input video frame
3968 into 3 grayscale outputs:
3969 @example
3970 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
3971 @end example
3972 @end itemize
3973
3974 @section elbg
3975
3976 Apply a posterize effect using the ELBG (Enhanced LBG) algorithm.
3977
3978 For each input image, the filter will compute the optimal mapping from
3979 the input to the output given the codebook length, that is the number
3980 of distinct output colors.
3981
3982 This filter accepts the following options.
3983
3984 @table @option
3985 @item codebook_length, l
3986 Set codebook length. The value must be a positive integer, and
3987 represents the number of distinct output colors. Default value is 256.
3988
3989 @item nb_steps, n
3990 Set the maximum number of iterations to apply for computing the optimal
3991 mapping. The higher the value the better the result and the higher the
3992 computation time. Default value is 1.
3993
3994 @item seed, s
3995 Set a random seed, must be an integer included between 0 and
3996 UINT32_MAX. If not specified, or if explicitly set to -1, the filter
3997 will try to use a good random seed on a best effort basis.
3998 @end table
3999
4000 @section fade
4001
4002 Apply fade-in/out effect to input video.
4003
4004 This filter accepts the following options:
4005
4006 @table @option
4007 @item type, t
4008 The effect type -- can be either "in" for fade-in, or "out" for a fade-out
4009 effect.
4010 Default is @code{in}.
4011
4012 @item start_frame, s
4013 Specify the number of the start frame for starting to apply the fade
4014 effect. Default is 0.
4015
4016 @item nb_frames, n
4017 The number of frames for which the fade effect has to last. At the end of the
4018 fade-in effect the output video will have the same intensity as the input video,
4019 at the end of the fade-out transition the output video will be filled with the
4020 selected @option{color}.
4021 Default is 25.
4022
4023 @item alpha
4024 If set to 1, fade only alpha channel, if one exists on the input.
4025 Default value is 0.
4026
4027 @item start_time, st
4028 Specify the timestamp (in seconds) of the frame to start to apply the fade
4029 effect. If both start_frame and start_time are specified, the fade will start at
4030 whichever comes last.  Default is 0.
4031
4032 @item duration, d
4033 The number of seconds for which the fade effect has to last. At the end of the
4034 fade-in effect the output video will have the same intensity as the input video,
4035 at the end of the fade-out transition the output video will be filled with the
4036 selected @option{color}.
4037 If both duration and nb_frames are specified, duration is used. Default is 0.
4038
4039 @item color, c
4040 Specify the color of the fade. Default is "black".
4041 @end table
4042
4043 @subsection Examples
4044
4045 @itemize
4046 @item
4047 Fade in first 30 frames of video:
4048 @example
4049 fade=in:0:30
4050 @end example
4051
4052 The command above is equivalent to:
4053 @example
4054 fade=t=in:s=0:n=30
4055 @end example
4056
4057 @item
4058 Fade out last 45 frames of a 200-frame video:
4059 @example
4060 fade=out:155:45
4061 fade=type=out:start_frame=155:nb_frames=45
4062 @end example
4063
4064 @item
4065 Fade in first 25 frames and fade out last 25 frames of a 1000-frame video:
4066 @example
4067 fade=in:0:25, fade=out:975:25
4068 @end example
4069
4070 @item
4071 Make first 5 frames yellow, then fade in from frame 5-24:
4072 @example
4073 fade=in:5:20:color=yellow
4074 @end example
4075
4076 @item
4077 Fade in alpha over first 25 frames of video:
4078 @example
4079 fade=in:0:25:alpha=1
4080 @end example
4081
4082 @item
4083 Make first 5.5 seconds black, then fade in for 0.5 seconds:
4084 @example
4085 fade=t=in:st=5.5:d=0.5
4086 @end example
4087
4088 @end itemize
4089
4090 @section field
4091
4092 Extract a single field from an interlaced image using stride
4093 arithmetic to avoid wasting CPU time. The output frames are marked as
4094 non-interlaced.
4095
4096 The filter accepts the following options:
4097
4098 @table @option
4099 @item type
4100 Specify whether to extract the top (if the value is @code{0} or
4101 @code{top}) or the bottom field (if the value is @code{1} or
4102 @code{bottom}).
4103 @end table
4104
4105 @section fieldmatch
4106
4107 Field matching filter for inverse telecine. It is meant to reconstruct the
4108 progressive frames from a telecined stream. The filter does not drop duplicated
4109 frames, so to achieve a complete inverse telecine @code{fieldmatch} needs to be
4110 followed by a decimation filter such as @ref{decimate} in the filtergraph.
4111
4112 The separation of the field matching and the decimation is notably motivated by
4113 the possibility of inserting a de-interlacing filter fallback between the two.
4114 If the source has mixed telecined and real interlaced content,
4115 @code{fieldmatch} will not be able to match fields for the interlaced parts.
4116 But these remaining combed frames will be marked as interlaced, and thus can be
4117 de-interlaced by a later filter such as @ref{yadif} before decimation.
4118
4119 In addition to the various configuration options, @code{fieldmatch} can take an
4120 optional second stream, activated through the @option{ppsrc} option. If
4121 enabled, the frames reconstruction will be based on the fields and frames from
4122 this second stream. This allows the first input to be pre-processed in order to
4123 help the various algorithms of the filter, while keeping the output lossless
4124 (assuming the fields are matched properly). Typically, a field-aware denoiser,
4125 or brightness/contrast adjustments can help.
4126
4127 Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project)
4128 and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from
4129 which @code{fieldmatch} is based on. While the semantic and usage are very
4130 close, some behaviour and options names can differ.
4131
4132 The filter accepts the following options:
4133
4134 @table @option
4135 @item order
4136 Specify the assumed field order of the input stream. Available values are:
4137
4138 @table @samp
4139 @item auto
4140 Auto detect parity (use FFmpeg's internal parity value).
4141 @item bff
4142 Assume bottom field first.
4143 @item tff
4144 Assume top field first.
4145 @end table
4146
4147 Note that it is sometimes recommended not to trust the parity announced by the
4148 stream.
4149
4150 Default value is @var{auto}.
4151
4152 @item mode
4153 Set the matching mode or strategy to use. @option{pc} mode is the safest in the
4154 sense that it won't risk creating jerkiness due to duplicate frames when
4155 possible, but if there are bad edits or blended fields it will end up
4156 outputting combed frames when a good match might actually exist. On the other
4157 hand, @option{pcn_ub} mode is the most risky in terms of creating jerkiness,
4158 but will almost always find a good frame if there is one. The other values are
4159 all somewhere in between @option{pc} and @option{pcn_ub} in terms of risking
4160 jerkiness and creating duplicate frames versus finding good matches in sections
4161 with bad edits, orphaned fields, blended fields, etc.
4162
4163 More details about p/c/n/u/b are available in @ref{p/c/n/u/b meaning} section.
4164
4165 Available values are:
4166
4167 @table @samp
4168 @item pc
4169 2-way matching (p/c)
4170 @item pc_n
4171 2-way matching, and trying 3rd match if still combed (p/c + n)
4172 @item pc_u
4173 2-way matching, and trying 3rd match (same order) if still combed (p/c + u)
4174 @item pc_n_ub
4175 2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if
4176 still combed (p/c + n + u/b)
4177 @item pcn
4178 3-way matching (p/c/n)
4179 @item pcn_ub
4180 3-way matching, and trying 4th/5th matches if all 3 of the original matches are
4181 detected as combed (p/c/n + u/b)
4182 @end table
4183
4184 The parenthesis at the end indicate the matches that would be used for that
4185 mode assuming @option{order}=@var{tff} (and @option{field} on @var{auto} or
4186 @var{top}).
4187
4188 In terms of speed @option{pc} mode is by far the fastest and @option{pcn_ub} is
4189 the slowest.
4190
4191 Default value is @var{pc_n}.
4192
4193 @item ppsrc
4194 Mark the main input stream as a pre-processed input, and enable the secondary
4195 input stream as the clean source to pick the fields from. See the filter
4196 introduction for more details. It is similar to the @option{clip2} feature from
4197 VFM/TFM.
4198
4199 Default value is @code{0} (disabled).
4200
4201 @item field
4202 Set the field to match from. It is recommended to set this to the same value as
4203 @option{order} unless you experience matching failures with that setting. In
4204 certain circumstances changing the field that is used to match from can have a
4205 large impact on matching performance. Available values are:
4206
4207 @table @samp
4208 @item auto
4209 Automatic (same value as @option{order}).
4210 @item bottom
4211 Match from the bottom field.
4212 @item top
4213 Match from the top field.
4214 @end table
4215
4216 Default value is @var{auto}.
4217
4218 @item mchroma
4219 Set whether or not chroma is included during the match comparisons. In most
4220 cases it is recommended to leave this enabled. You should set this to @code{0}
4221 only if your clip has bad chroma problems such as heavy rainbowing or other
4222 artifacts. Setting this to @code{0} could also be used to speed things up at
4223 the cost of some accuracy.
4224