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