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