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