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