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