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