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