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