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