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