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