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