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