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