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