lavfi: add asetnsamples audio filter
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtergraph description
2 @c man begin FILTERGRAPH DESCRIPTION
3
4 A filtergraph is a directed graph of connected filters. It can contain
5 cycles, and there can be multiple links between a pair of
6 filters. Each link has one input pad on one side connecting it to one
7 filter from which it takes its input, and one output pad on the other
8 side connecting it to the one filter accepting its output.
9
10 Each filter in a filtergraph is an instance of a filter class
11 registered in the application, which defines the features and the
12 number of input and output pads of the filter.
13
14 A filter with no input pads is called a "source", a filter with no
15 output pads is called a "sink".
16
17 @anchor{Filtergraph syntax}
18 @section Filtergraph syntax
19
20 A filtergraph can be represented using a textual representation, which is
21 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
22 options in @command{ffmpeg} and @option{-vf} in @command{ffplay}, and by the
23 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
24 @file{libavfilter/avfiltergraph.h}.
25
26 A filterchain consists of a sequence of connected filters, each one
27 connected to the previous one in the sequence. A filterchain is
28 represented by a list of ","-separated filter descriptions.
29
30 A filtergraph consists of a sequence of filterchains. A sequence of
31 filterchains is represented by a list of ";"-separated filterchain
32 descriptions.
33
34 A filter is represented by a string of the form:
35 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
36
37 @var{filter_name} is the name of the filter class of which the
38 described filter is an instance of, and has to be the name of one of
39 the filter classes registered in the program.
40 The name of the filter class is optionally followed by a string
41 "=@var{arguments}".
42
43 @var{arguments} is a string which contains the parameters used to
44 initialize the filter instance, and are described in the filter
45 descriptions below.
46
47 The list of arguments can be quoted using the character "'" as initial
48 and ending mark, and the character '\' for escaping the characters
49 within the quoted text; otherwise the argument string is considered
50 terminated when the next special character (belonging to the set
51 "[]=;,") is encountered.
52
53 The name and arguments of the filter are optionally preceded and
54 followed by a list of link labels.
55 A link label allows to name a link and associate it to a filter output
56 or input pad. The preceding labels @var{in_link_1}
57 ... @var{in_link_N}, are associated to the filter input pads,
58 the following labels @var{out_link_1} ... @var{out_link_M}, are
59 associated to the output pads.
60
61 When two link labels with the same name are found in the
62 filtergraph, a link between the corresponding input and output pad is
63 created.
64
65 If an output pad is not labelled, it is linked by default to the first
66 unlabelled input pad of the next filter in the filterchain.
67 For example in the filterchain:
68 @example
69 nullsrc, split[L1], [L2]overlay, nullsink
70 @end example
71 the split filter instance has two output pads, and the overlay filter
72 instance two input pads. The first output pad of split is labelled
73 "L1", the first input pad of overlay is labelled "L2", and the second
74 output pad of split is linked to the second input pad of overlay,
75 which are both unlabelled.
76
77 In a complete filterchain all the unlabelled filter input and output
78 pads must be connected. A filtergraph is considered valid if all the
79 filter input and output pads of all the filterchains are connected.
80
81 Libavfilter will automatically insert scale filters where format
82 conversion is required. It is possible to specify swscale flags
83 for those automatically inserted scalers by prepending
84 @code{sws_flags=@var{flags};}
85 to the filtergraph description.
86
87 Follows a BNF description for the filtergraph syntax:
88 @example
89 @var{NAME}             ::= sequence of alphanumeric characters and '_'
90 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
91 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
92 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
93 @var{FILTER}           ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
94 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
95 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
96 @end example
97
98 @c man end FILTERGRAPH DESCRIPTION
99
100 @chapter Audio Filters
101 @c man begin AUDIO FILTERS
102
103 When you configure your FFmpeg build, you can disable any of the
104 existing filters using @code{--disable-filters}.
105 The configure output will show the audio filters included in your
106 build.
107
108 Below is a description of the currently available audio filters.
109
110 @section aconvert
111
112 Convert the input audio format to the specified formats.
113
114 The filter accepts a string of the form:
115 "@var{sample_format}:@var{channel_layout}".
116
117 @var{sample_format} specifies the sample format, and can be a string or the
118 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
119 suffix for a planar sample format.
120
121 @var{channel_layout} specifies the channel layout, and can be a string
122 or the corresponding number value defined in @file{libavutil/audioconvert.h}.
123
124 The special parameter "auto", signifies that the filter will
125 automatically select the output format depending on the output filter.
126
127 Some examples follow.
128
129 @itemize
130 @item
131 Convert input to float, planar, stereo:
132 @example
133 aconvert=fltp:stereo
134 @end example
135
136 @item
137 Convert input to unsigned 8-bit, automatically select out channel layout:
138 @example
139 aconvert=u8:auto
140 @end example
141 @end itemize
142
143 @section aformat
144
145 Convert the input audio to one of the specified formats. The framework will
146 negotiate the most appropriate format to minimize conversions.
147
148 The filter accepts the following named parameters:
149 @table @option
150
151 @item sample_fmts
152 A comma-separated list of requested sample formats.
153
154 @item sample_rates
155 A comma-separated list of requested sample rates.
156
157 @item channel_layouts
158 A comma-separated list of requested channel layouts.
159
160 @end table
161
162 If a parameter is omitted, all values are allowed.
163
164 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
165 @example
166 aformat=sample_fmts\=u8\,s16:channel_layouts\=stereo
167 @end example
168
169 @section amerge
170
171 Merge two or more audio streams into a single multi-channel stream.
172
173 The filter accepts the following named options:
174
175 @table @option
176
177 @item inputs
178 Set the number of inputs. Default is 2.
179
180 @end table
181
182 If the channel layouts of the inputs are disjoint, and therefore compatible,
183 the channel layout of the output will be set accordingly and the channels
184 will be reordered as necessary. If the channel layouts of the inputs are not
185 disjoint, the output will have all the channels of the first input then all
186 the channels of the second input, in that order, and the channel layout of
187 the output will be the default value corresponding to the total number of
188 channels.
189
190 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
191 is FC+BL+BR, then the output will be in 5.1, with the channels in the
192 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
193 first input, b1 is the first channel of the second input).
194
195 On the other hand, if both input are in stereo, the output channels will be
196 in the default order: a1, a2, b1, b2, and the channel layout will be
197 arbitrarily set to 4.0, which may or may not be the expected value.
198
199 All inputs must have the same sample rate, and format.
200
201 If inputs do not have the same duration, the output will stop with the
202 shortest.
203
204 Example: merge two mono files into a stereo stream:
205 @example
206 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
207 @end example
208
209 Example: multiple merges:
210 @example
211 ffmpeg -f lavfi -i "
212 amovie=input.mkv:si=0 [a0];
213 amovie=input.mkv:si=1 [a1];
214 amovie=input.mkv:si=2 [a2];
215 amovie=input.mkv:si=3 [a3];
216 amovie=input.mkv:si=4 [a4];
217 amovie=input.mkv:si=5 [a5];
218 [a0][a1][a2][a3][a4][a5] amerge=inputs=6" -c:a pcm_s16le output.mkv
219 @end example
220
221 @section amix
222
223 Mixes multiple audio inputs into a single output.
224
225 For example
226 @example
227 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
228 @end example
229 will mix 3 input audio streams to a single output with the same duration as the
230 first input and a dropout transition time of 3 seconds.
231
232 The filter accepts the following named parameters:
233 @table @option
234
235 @item inputs
236 Number of inputs. If unspecified, it defaults to 2.
237
238 @item duration
239 How to determine the end-of-stream.
240 @table @option
241
242 @item longest
243 Duration of longest input. (default)
244
245 @item shortest
246 Duration of shortest input.
247
248 @item first
249 Duration of first input.
250
251 @end table
252
253 @item dropout_transition
254 Transition time, in seconds, for volume renormalization when an input
255 stream ends. The default value is 2 seconds.
256
257 @end table
258
259 @section anull
260
261 Pass the audio source unchanged to the output.
262
263 @section aresample
264
265 Resample the input audio to the specified sample rate.
266
267 The filter accepts exactly one parameter, the output sample rate. If not
268 specified then the filter will automatically convert between its input
269 and output sample rates.
270
271 For example, to resample the input audio to 44100Hz:
272 @example
273 aresample=44100
274 @end example
275
276 @section asetnsamples
277
278 Set the number of samples per each output audio frame.
279
280 The last output packet may contain a different number of samples, as
281 the filter will flush all the remaining samples when the input audio
282 signal its end.
283
284 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
285 separated by ":".
286
287 @table @option
288
289 @item nb_out_samples, n
290 Set the number of frames per each output audio frame. The number is
291 intended as the number of samples @emph{per each channel}.
292 Default value is 1024.
293
294 @item pad, p
295 If set to 1, the filter will pad the last audio frame with zeroes, so
296 that the last frame will contain the same number of samples as the
297 previous ones. Default value is 1.
298 @end table
299
300 For example, to set the number of per-frame samples to 1234 and
301 disable padding for the last frame, use:
302 @example
303 asetnsamples=n=1234:p=0
304 @end example
305
306 @section ashowinfo
307
308 Show a line containing various information for each input audio frame.
309 The input audio is not modified.
310
311 The shown line contains a sequence of key/value pairs of the form
312 @var{key}:@var{value}.
313
314 A description of each shown parameter follows:
315
316 @table @option
317 @item n
318 sequential number of the input frame, starting from 0
319
320 @item pts
321 presentation TimeStamp of the input frame, expressed as a number of
322 time base units. The time base unit depends on the filter input pad, and
323 is usually 1/@var{sample_rate}.
324
325 @item pts_time
326 presentation TimeStamp of the input frame, expressed as a number of
327 seconds
328
329 @item pos
330 position of the frame in the input stream, -1 if this information in
331 unavailable and/or meaningless (for example in case of synthetic audio)
332
333 @item fmt
334 sample format name
335
336 @item chlayout
337 channel layout description
338
339 @item nb_samples
340 number of samples (per each channel) contained in the filtered frame
341
342 @item rate
343 sample rate for the audio frame
344
345 @item checksum
346 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
347
348 @item plane_checksum
349 Adler-32 checksum (printed in hexadecimal) for each input frame plane,
350 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3} @var{c4} @var{c5}
351 @var{c6} @var{c7}]"
352 @end table
353
354 @section asplit
355
356 Split input audio into several identical outputs.
357
358 The filter accepts a single parameter which specifies the number of outputs. If
359 unspecified, it defaults to 2.
360
361 For example:
362 @example
363 [in] asplit [out0][out1]
364 @end example
365
366 will create two separate outputs from the same input.
367
368 To create 3 or more outputs, you need to specify the number of
369 outputs, like in:
370 @example
371 [in] asplit=3 [out0][out1][out2]
372 @end example
373
374 @example
375 ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
376 @end example
377 will create 5 copies of the input audio.
378
379
380 @section astreamsync
381
382 Forward two audio streams and control the order the buffers are forwarded.
383
384 The argument to the filter is an expression deciding which stream should be
385 forwarded next: if the result is negative, the first stream is forwarded; if
386 the result is positive or zero, the second stream is forwarded. It can use
387 the following variables:
388
389 @table @var
390 @item b1 b2
391 number of buffers forwarded so far on each stream
392 @item s1 s2
393 number of samples forwarded so far on each stream
394 @item t1 t2
395 current timestamp of each stream
396 @end table
397
398 The default value is @code{t1-t2}, which means to always forward the stream
399 that has a smaller timestamp.
400
401 Example: stress-test @code{amerge} by randomly sending buffers on the wrong
402 input, while avoiding too much of a desynchronization:
403 @example
404 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
405 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
406 [a2] [b2] amerge
407 @end example
408
409 @section earwax
410
411 Make audio easier to listen to on headphones.
412
413 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
414 so that when listened to on headphones the stereo image is moved from
415 inside your head (standard for headphones) to outside and in front of
416 the listener (standard for speakers).
417
418 Ported from SoX.
419
420 @section pan
421
422 Mix channels with specific gain levels. The filter accepts the output
423 channel layout followed by a set of channels definitions.
424
425 This filter is also designed to remap efficiently the channels of an audio
426 stream.
427
428 The filter accepts parameters of the form:
429 "@var{l}:@var{outdef}:@var{outdef}:..."
430
431 @table @option
432 @item l
433 output channel layout or number of channels
434
435 @item outdef
436 output channel specification, of the form:
437 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
438
439 @item out_name
440 output channel to define, either a channel name (FL, FR, etc.) or a channel
441 number (c0, c1, etc.)
442
443 @item gain
444 multiplicative coefficient for the channel, 1 leaving the volume unchanged
445
446 @item in_name
447 input channel to use, see out_name for details; it is not possible to mix
448 named and numbered input channels
449 @end table
450
451 If the `=' in a channel specification is replaced by `<', then the gains for
452 that specification will be renormalized so that the total is 1, thus
453 avoiding clipping noise.
454
455 @subsection Mixing examples
456
457 For example, if you want to down-mix from stereo to mono, but with a bigger
458 factor for the left channel:
459 @example
460 pan=1:c0=0.9*c0+0.1*c1
461 @end example
462
463 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
464 7-channels surround:
465 @example
466 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
467 @end example
468
469 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
470 that should be preferred (see "-ac" option) unless you have very specific
471 needs.
472
473 @subsection Remapping examples
474
475 The channel remapping will be effective if, and only if:
476
477 @itemize
478 @item gain coefficients are zeroes or ones,
479 @item only one input per channel output,
480 @end itemize
481
482 If all these conditions are satisfied, the filter will notify the user ("Pure
483 channel mapping detected"), and use an optimized and lossless method to do the
484 remapping.
485
486 For example, if you have a 5.1 source and want a stereo audio stream by
487 dropping the extra channels:
488 @example
489 pan="stereo: c0=FL : c1=FR"
490 @end example
491
492 Given the same source, you can also switch front left and front right channels
493 and keep the input channel layout:
494 @example
495 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
496 @end example
497
498 If the input is a stereo audio stream, you can mute the front left channel (and
499 still keep the stereo channel layout) with:
500 @example
501 pan="stereo:c1=c1"
502 @end example
503
504 Still with a stereo audio stream input, you can copy the right channel in both
505 front left and right:
506 @example
507 pan="stereo: c0=FR : c1=FR"
508 @end example
509
510 @section silencedetect
511
512 Detect silence in an audio stream.
513
514 This filter logs a message when it detects that the input audio volume is less
515 or equal to a noise tolerance value for a duration greater or equal to the
516 minimum detected noise duration.
517
518 The printed times and duration are expressed in seconds.
519
520 @table @option
521 @item duration, d
522 Set silence duration until notification (default is 2 seconds).
523
524 @item noise, n
525 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
526 specified value) or amplitude ratio. Default is -60dB, or 0.001.
527 @end table
528
529 Detect 5 seconds of silence with -50dB noise tolerance:
530 @example
531 silencedetect=n=-50dB:d=5
532 @end example
533
534 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
535 tolerance in @file{silence.mp3}:
536 @example
537 ffmpeg -f lavfi -i amovie=silence.mp3,silencedetect=noise=0.0001 -f null -
538 @end example
539
540 @section volume
541
542 Adjust the input audio volume.
543
544 The filter accepts exactly one parameter @var{vol}, which expresses
545 how the audio volume will be increased or decreased.
546
547 Output values are clipped to the maximum value.
548
549 If @var{vol} is expressed as a decimal number, the output audio
550 volume is given by the relation:
551 @example
552 @var{output_volume} = @var{vol} * @var{input_volume}
553 @end example
554
555 If @var{vol} is expressed as a decimal number followed by the string
556 "dB", the value represents the requested change in decibels of the
557 input audio power, and the output audio volume is given by the
558 relation:
559 @example
560 @var{output_volume} = 10^(@var{vol}/20) * @var{input_volume}
561 @end example
562
563 Otherwise @var{vol} is considered an expression and its evaluated
564 value is used for computing the output audio volume according to the
565 first relation.
566
567 Default value for @var{vol} is 1.0.
568
569 @subsection Examples
570
571 @itemize
572 @item
573 Half the input audio volume:
574 @example
575 volume=0.5
576 @end example
577
578 The above example is equivalent to:
579 @example
580 volume=1/2
581 @end example
582
583 @item
584 Decrease input audio power by 12 decibels:
585 @example
586 volume=-12dB
587 @end example
588 @end itemize
589
590 @section asyncts
591 Synchronize audio data with timestamps by squeezing/stretching it and/or
592 dropping samples/adding silence when needed.
593
594 The filter accepts the following named parameters:
595 @table @option
596
597 @item compensate
598 Enable stretching/squeezing the data to make it match the timestamps.
599
600 @item min_delta
601 Minimum difference between timestamps and audio data (in seconds) to trigger
602 adding/dropping samples.
603
604 @item max_comp
605 Maximum compensation in samples per second.
606
607 @end table
608
609 @section channelsplit
610 Split each channel in input audio stream into a separate output stream.
611
612 This filter accepts the following named parameters:
613 @table @option
614 @item channel_layout
615 Channel layout of the input stream. Default is "stereo".
616 @end table
617
618 For example, assuming a stereo input MP3 file
619 @example
620 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
621 @end example
622 will create an output Matroska file with two audio streams, one containing only
623 the left channel and the other the right channel.
624
625 To split a 5.1 WAV file into per-channel files
626 @example
627 ffmpeg -i in.wav -filter_complex
628 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
629 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
630 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
631 side_right.wav
632 @end example
633
634 @section resample
635 Convert the audio sample format, sample rate and channel layout. This filter is
636 not meant to be used directly.
637
638 @c man end AUDIO FILTERS
639
640 @chapter Audio Sources
641 @c man begin AUDIO SOURCES
642
643 Below is a description of the currently available audio sources.
644
645 @section abuffer
646
647 Buffer audio frames, and make them available to the filter chain.
648
649 This source is mainly intended for a programmatic use, in particular
650 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
651
652 It accepts the following mandatory parameters:
653 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}
654
655 @table @option
656
657 @item sample_rate
658 The sample rate of the incoming audio buffers.
659
660 @item sample_fmt
661 The sample format of the incoming audio buffers.
662 Either a sample format name or its corresponging integer representation from
663 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
664
665 @item channel_layout
666 The channel layout of the incoming audio buffers.
667 Either a channel layout name from channel_layout_map in
668 @file{libavutil/audioconvert.c} or its corresponding integer representation
669 from the AV_CH_LAYOUT_* macros in @file{libavutil/audioconvert.h}
670
671 @end table
672
673 For example:
674 @example
675 abuffer=44100:s16p:stereo
676 @end example
677
678 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
679 Since the sample format with name "s16p" corresponds to the number
680 6 and the "stereo" channel layout corresponds to the value 0x3, this is
681 equivalent to:
682 @example
683 abuffer=44100:6:0x3
684 @end example
685
686 @section aevalsrc
687
688 Generate an audio signal specified by an expression.
689
690 This source accepts in input one or more expressions (one for each
691 channel), which are evaluated and used to generate a corresponding
692 audio signal.
693
694 It accepts the syntax: @var{exprs}[::@var{options}].
695 @var{exprs} is a list of expressions separated by ":", one for each
696 separate channel. In case the @var{channel_layout} is not
697 specified, the selected channel layout depends on the number of
698 provided expressions.
699
700 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
701 separated by ":".
702
703 The description of the accepted options follows.
704
705 @table @option
706
707 @item channel_layout, c
708 Set the channel layout. The number of channels in the specified layout
709 must be equal to the number of specified expressions.
710
711 @item duration, d
712 Set the minimum duration of the sourced audio. See the function
713 @code{av_parse_time()} for the accepted format.
714 Note that the resulting duration may be greater than the specified
715 duration, as the generated audio is always cut at the end of a
716 complete frame.
717
718 If not specified, or the expressed duration is negative, the audio is
719 supposed to be generated forever.
720
721 @item nb_samples, n
722 Set the number of samples per channel per each output frame,
723 default to 1024.
724
725 @item sample_rate, s
726 Specify the sample rate, default to 44100.
727 @end table
728
729 Each expression in @var{exprs} can contain the following constants:
730
731 @table @option
732 @item n
733 number of the evaluated sample, starting from 0
734
735 @item t
736 time of the evaluated sample expressed in seconds, starting from 0
737
738 @item s
739 sample rate
740
741 @end table
742
743 @subsection Examples
744
745 @itemize
746
747 @item
748 Generate silence:
749 @example
750 aevalsrc=0
751 @end example
752
753 @item
754
755 Generate a sin signal with frequency of 440 Hz, set sample rate to
756 8000 Hz:
757 @example
758 aevalsrc="sin(440*2*PI*t)::s=8000"
759 @end example
760
761 @item
762 Generate a two channels signal, specify the channel layout (Front
763 Center + Back Center) explicitly:
764 @example
765 aevalsrc="sin(420*2*PI*t):cos(430*2*PI*t)::c=FC|BC"
766 @end example
767
768 @item
769 Generate white noise:
770 @example
771 aevalsrc="-2+random(0)"
772 @end example
773
774 @item
775 Generate an amplitude modulated signal:
776 @example
777 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
778 @end example
779
780 @item
781 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
782 @example
783 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"
784 @end example
785
786 @end itemize
787
788 @section amovie
789
790 Read an audio stream from a movie container.
791
792 It accepts the syntax: @var{movie_name}[:@var{options}] where
793 @var{movie_name} is the name of the resource to read (not necessarily
794 a file but also a device or a stream accessed through some protocol),
795 and @var{options} is an optional sequence of @var{key}=@var{value}
796 pairs, separated by ":".
797
798 The description of the accepted options follows.
799
800 @table @option
801
802 @item format_name, f
803 Specify the format assumed for the movie to read, and can be either
804 the name of a container or an input device. If not specified the
805 format is guessed from @var{movie_name} or by probing.
806
807 @item seek_point, sp
808 Specify the seek point in seconds, the frames will be output
809 starting from this seek point, the parameter is evaluated with
810 @code{av_strtod} so the numerical value may be suffixed by an IS
811 postfix. Default value is "0".
812
813 @item stream_index, si
814 Specify the index of the audio stream to read. If the value is -1,
815 the best suited audio stream will be automatically selected. Default
816 value is "-1".
817
818 @end table
819
820 @section anullsrc
821
822 Null audio source, return unprocessed audio frames. It is mainly useful
823 as a template and to be employed in analysis / debugging tools, or as
824 the source for filters which ignore the input data (for example the sox
825 synth filter).
826
827 It accepts an optional sequence of @var{key}=@var{value} pairs,
828 separated by ":".
829
830 The description of the accepted options follows.
831
832 @table @option
833
834 @item sample_rate, s
835 Specify the sample rate, and defaults to 44100.
836
837 @item channel_layout, cl
838
839 Specify the channel layout, and can be either an integer or a string
840 representing a channel layout. The default value of @var{channel_layout}
841 is "stereo".
842
843 Check the channel_layout_map definition in
844 @file{libavcodec/audioconvert.c} for the mapping between strings and
845 channel layout values.
846
847 @item nb_samples, n
848 Set the number of samples per requested frames.
849
850 @end table
851
852 Follow some examples:
853 @example
854 #  set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
855 anullsrc=r=48000:cl=4
856
857 # same as
858 anullsrc=r=48000:cl=mono
859 @end example
860
861 @section abuffer
862 Buffer audio frames, and make them available to the filter chain.
863
864 This source is not intended to be part of user-supplied graph descriptions but
865 for insertion by calling programs through the interface defined in
866 @file{libavfilter/buffersrc.h}.
867
868 It accepts the following named parameters:
869 @table @option
870
871 @item time_base
872 Timebase which will be used for timestamps of submitted frames. It must be
873 either a floating-point number or in @var{numerator}/@var{denominator} form.
874
875 @item sample_rate
876 Audio sample rate.
877
878 @item sample_fmt
879 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
880
881 @item channel_layout
882 Channel layout of the audio data, in the form that can be accepted by
883 @code{av_get_channel_layout()}.
884 @end table
885
886 All the parameters need to be explicitly defined.
887
888 @c man end AUDIO SOURCES
889
890 @chapter Audio Sinks
891 @c man begin AUDIO SINKS
892
893 Below is a description of the currently available audio sinks.
894
895 @section abuffersink
896
897 Buffer audio frames, and make them available to the end of filter chain.
898
899 This sink is mainly intended for programmatic use, in particular
900 through the interface defined in @file{libavfilter/buffersink.h}.
901
902 It requires a pointer to an AVABufferSinkContext structure, which
903 defines the incoming buffers' formats, to be passed as the opaque
904 parameter to @code{avfilter_init_filter} for initialization.
905
906 @section anullsink
907
908 Null audio sink, do absolutely nothing with the input audio. It is
909 mainly useful as a template and to be employed in analysis / debugging
910 tools.
911
912 @section abuffersink
913 This sink is intended for programmatic use. Frames that arrive on this sink can
914 be retrieved by the calling program using the interface defined in
915 @file{libavfilter/buffersink.h}.
916
917 This filter accepts no parameters.
918
919 @c man end AUDIO SINKS
920
921 @chapter Video Filters
922 @c man begin VIDEO FILTERS
923
924 When you configure your FFmpeg build, you can disable any of the
925 existing filters using @code{--disable-filters}.
926 The configure output will show the video filters included in your
927 build.
928
929 Below is a description of the currently available video filters.
930
931 @section ass
932
933 Draw ASS (Advanced Substation Alpha) subtitles on top of input video
934 using the libass library.
935
936 To enable compilation of this filter you need to configure FFmpeg with
937 @code{--enable-libass}.
938
939 This filter accepts the syntax: @var{ass_filename}[:@var{options}],
940 where @var{ass_filename} is the filename of the ASS file to read, and
941 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
942 separated by ":".
943
944 A description of the accepted options follows.
945
946 @table @option
947 @item original_size
948 Specifies the size of the original video, the video for which the ASS file
949 was composed. Due to a misdesign in ASS aspect ratio arithmetic, this is
950 necessary to correctly scale the fonts if the aspect ratio has been changed.
951 @end table
952
953 For example, to render the file @file{sub.ass} on top of the input
954 video, use the command:
955 @example
956 ass=sub.ass
957 @end example
958
959 @section bbox
960
961 Compute the bounding box for the non-black pixels in the input frame
962 luminance plane.
963
964 This filter computes the bounding box containing all the pixels with a
965 luminance value greater than the minimum allowed value.
966 The parameters describing the bounding box are printed on the filter
967 log.
968
969 @section blackdetect
970
971 Detect video intervals that are (almost) completely black. Can be
972 useful to detect chapter transitions, commercials, or invalid
973 recordings. Output lines contains the time for the start, end and
974 duration of the detected black interval expressed in seconds.
975
976 In order to display the output lines, you need to set the loglevel at
977 least to the AV_LOG_INFO value.
978
979 This filter accepts a list of options in the form of
980 @var{key}=@var{value} pairs separated by ":". A description of the
981 accepted options follows.
982
983 @table @option
984 @item black_min_duration, d
985 Set the minimum detected black duration expressed in seconds. It must
986 be a non-negative floating point number.
987
988 Default value is 2.0.
989
990 @item picture_black_ratio_th, pic_th
991 Set the threshold for considering a picture "black".
992 Express the minimum value for the ratio:
993 @example
994 @var{nb_black_pixels} / @var{nb_pixels}
995 @end example
996
997 for which a picture is considered black.
998 Default value is 0.98.
999
1000 @item pixel_black_th, pix_th
1001 Set the threshold for considering a pixel "black".
1002
1003 The threshold expresses the maximum pixel luminance value for which a
1004 pixel is considered "black". The provided value is scaled according to
1005 the following equation:
1006 @example
1007 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1008 @end example
1009
1010 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1011 the input video format, the range is [0-255] for YUV full-range
1012 formats and [16-235] for YUV non full-range formats.
1013
1014 Default value is 0.10.
1015 @end table
1016
1017 The following example sets the maximum pixel threshold to the minimum
1018 value, and detects only black intervals of 2 or more seconds:
1019 @example
1020 blackdetect=d=2:pix_th=0.00
1021 @end example
1022
1023 @section blackframe
1024
1025 Detect frames that are (almost) completely black. Can be useful to
1026 detect chapter transitions or commercials. Output lines consist of
1027 the frame number of the detected frame, the percentage of blackness,
1028 the position in the file if known or -1 and the timestamp in seconds.
1029
1030 In order to display the output lines, you need to set the loglevel at
1031 least to the AV_LOG_INFO value.
1032
1033 The filter accepts the syntax:
1034 @example
1035 blackframe[=@var{amount}:[@var{threshold}]]
1036 @end example
1037
1038 @var{amount} is the percentage of the pixels that have to be below the
1039 threshold, and defaults to 98.
1040
1041 @var{threshold} is the threshold below which a pixel value is
1042 considered black, and defaults to 32.
1043
1044 @section boxblur
1045
1046 Apply boxblur algorithm to the input video.
1047
1048 This filter accepts the parameters:
1049 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
1050
1051 Chroma and alpha parameters are optional, if not specified they default
1052 to the corresponding values set for @var{luma_radius} and
1053 @var{luma_power}.
1054
1055 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
1056 the radius in pixels of the box used for blurring the corresponding
1057 input plane. They are expressions, and can contain the following
1058 constants:
1059 @table @option
1060 @item w, h
1061 the input width and height in pixels
1062
1063 @item cw, ch
1064 the input chroma image width and height in pixels
1065
1066 @item hsub, vsub
1067 horizontal and vertical chroma subsample values. For example for the
1068 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1069 @end table
1070
1071 The radius must be a non-negative number, and must not be greater than
1072 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
1073 and of @code{min(cw,ch)/2} for the chroma planes.
1074
1075 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
1076 how many times the boxblur filter is applied to the corresponding
1077 plane.
1078
1079 Some examples follow:
1080
1081 @itemize
1082
1083 @item
1084 Apply a boxblur filter with luma, chroma, and alpha radius
1085 set to 2:
1086 @example
1087 boxblur=2:1
1088 @end example
1089
1090 @item
1091 Set luma radius to 2, alpha and chroma radius to 0
1092 @example
1093 boxblur=2:1:0:0:0:0
1094 @end example
1095
1096 @item
1097 Set luma and chroma radius to a fraction of the video dimension
1098 @example
1099 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
1100 @end example
1101
1102 @end itemize
1103
1104 @section colormatrix
1105
1106 The colormatrix filter allows conversion between any of the following color
1107 space: BT.709 (@var{bt709}), BT.601 (@var{bt601}), SMPTE-240M (@var{smpte240m})
1108 and FCC (@var{fcc}).
1109
1110 The syntax of the parameters is @var{source}:@var{destination}:
1111
1112 @example
1113 colormatrix=bt601:smpte240m
1114 @end example
1115
1116 @section copy
1117
1118 Copy the input source unchanged to the output. Mainly useful for
1119 testing purposes.
1120
1121 @section crop
1122
1123 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}:@var{keep_aspect}
1124
1125 The @var{keep_aspect} parameter is optional, if specified and set to a
1126 non-zero value will force the output display aspect ratio to be the
1127 same of the input, by changing the output sample aspect ratio.
1128
1129 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
1130 expressions containing the following constants:
1131
1132 @table @option
1133 @item x, y
1134 the computed values for @var{x} and @var{y}. They are evaluated for
1135 each new frame.
1136
1137 @item in_w, in_h
1138 the input width and height
1139
1140 @item iw, ih
1141 same as @var{in_w} and @var{in_h}
1142
1143 @item out_w, out_h
1144 the output (cropped) width and height
1145
1146 @item ow, oh
1147 same as @var{out_w} and @var{out_h}
1148
1149 @item a
1150 same as @var{iw} / @var{ih}
1151
1152 @item sar
1153 input sample aspect ratio
1154
1155 @item dar
1156 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1157
1158 @item hsub, vsub
1159 horizontal and vertical chroma subsample values. For example for the
1160 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1161
1162 @item n
1163 the number of input frame, starting from 0
1164
1165 @item pos
1166 the position in the file of the input frame, NAN if unknown
1167
1168 @item t
1169 timestamp expressed in seconds, NAN if the input timestamp is unknown
1170
1171 @end table
1172
1173 The @var{out_w} and @var{out_h} parameters specify the expressions for
1174 the width and height of the output (cropped) video. They are
1175 evaluated just at the configuration of the filter.
1176
1177 The default value of @var{out_w} is "in_w", and the default value of
1178 @var{out_h} is "in_h".
1179
1180 The expression for @var{out_w} may depend on the value of @var{out_h},
1181 and the expression for @var{out_h} may depend on @var{out_w}, but they
1182 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
1183 evaluated after @var{out_w} and @var{out_h}.
1184
1185 The @var{x} and @var{y} parameters specify the expressions for the
1186 position of the top-left corner of the output (non-cropped) area. They
1187 are evaluated for each frame. If the evaluated value is not valid, it
1188 is approximated to the nearest valid value.
1189
1190 The default value of @var{x} is "(in_w-out_w)/2", and the default
1191 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
1192 the center of the input image.
1193
1194 The expression for @var{x} may depend on @var{y}, and the expression
1195 for @var{y} may depend on @var{x}.
1196
1197 Follow some examples:
1198 @example
1199 # crop the central input area with size 100x100
1200 crop=100:100
1201
1202 # crop the central input area with size 2/3 of the input video
1203 "crop=2/3*in_w:2/3*in_h"
1204
1205 # crop the input video central square
1206 crop=in_h
1207
1208 # delimit the rectangle with the top-left corner placed at position
1209 # 100:100 and the right-bottom corner corresponding to the right-bottom
1210 # corner of the input image.
1211 crop=in_w-100:in_h-100:100:100
1212
1213 # crop 10 pixels from the left and right borders, and 20 pixels from
1214 # the top and bottom borders
1215 "crop=in_w-2*10:in_h-2*20"
1216
1217 # keep only the bottom right quarter of the input image
1218 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
1219
1220 # crop height for getting Greek harmony
1221 "crop=in_w:1/PHI*in_w"
1222
1223 # trembling effect
1224 "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)"
1225
1226 # erratic camera effect depending on timestamp
1227 "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)"
1228
1229 # set x depending on the value of y
1230 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
1231 @end example
1232
1233 @section cropdetect
1234
1235 Auto-detect crop size.
1236
1237 Calculate necessary cropping parameters and prints the recommended
1238 parameters through the logging system. The detected dimensions
1239 correspond to the non-black area of the input video.
1240
1241 It accepts the syntax:
1242 @example
1243 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
1244 @end example
1245
1246 @table @option
1247
1248 @item limit
1249 Threshold, which can be optionally specified from nothing (0) to
1250 everything (255), defaults to 24.
1251
1252 @item round
1253 Value which the width/height should be divisible by, defaults to
1254 16. The offset is automatically adjusted to center the video. Use 2 to
1255 get only even dimensions (needed for 4:2:2 video). 16 is best when
1256 encoding to most video codecs.
1257
1258 @item reset
1259 Counter that determines after how many frames cropdetect will reset
1260 the previously detected largest video area and start over to detect
1261 the current optimal crop area. Defaults to 0.
1262
1263 This can be useful when channel logos distort the video area. 0
1264 indicates never reset and return the largest area encountered during
1265 playback.
1266 @end table
1267
1268 @section delogo
1269
1270 Suppress a TV station logo by a simple interpolation of the surrounding
1271 pixels. Just set a rectangle covering the logo and watch it disappear
1272 (and sometimes something even uglier appear - your mileage may vary).
1273
1274 The filter accepts parameters as a string of the form
1275 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
1276 @var{key}=@var{value} pairs, separated by ":".
1277
1278 The description of the accepted parameters follows.
1279
1280 @table @option
1281
1282 @item x, y
1283 Specify the top left corner coordinates of the logo. They must be
1284 specified.
1285
1286 @item w, h
1287 Specify the width and height of the logo to clear. They must be
1288 specified.
1289
1290 @item band, t
1291 Specify the thickness of the fuzzy edge of the rectangle (added to
1292 @var{w} and @var{h}). The default value is 4.
1293
1294 @item show
1295 When set to 1, a green rectangle is drawn on the screen to simplify
1296 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
1297 @var{band} is set to 4. The default value is 0.
1298
1299 @end table
1300
1301 Some examples follow.
1302
1303 @itemize
1304
1305 @item
1306 Set a rectangle covering the area with top left corner coordinates 0,0
1307 and size 100x77, setting a band of size 10:
1308 @example
1309 delogo=0:0:100:77:10
1310 @end example
1311
1312 @item
1313 As the previous example, but use named options:
1314 @example
1315 delogo=x=0:y=0:w=100:h=77:band=10
1316 @end example
1317
1318 @end itemize
1319
1320 @section deshake
1321
1322 Attempt to fix small changes in horizontal and/or vertical shift. This
1323 filter helps remove camera shake from hand-holding a camera, bumping a
1324 tripod, moving on a vehicle, etc.
1325
1326 The filter accepts parameters as a string of the form
1327 "@var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}"
1328
1329 A description of the accepted parameters follows.
1330
1331 @table @option
1332
1333 @item x, y, w, h
1334 Specify a rectangular area where to limit the search for motion
1335 vectors.
1336 If desired the search for motion vectors can be limited to a
1337 rectangular area of the frame defined by its top left corner, width
1338 and height. These parameters have the same meaning as the drawbox
1339 filter which can be used to visualise the position of the bounding
1340 box.
1341
1342 This is useful when simultaneous movement of subjects within the frame
1343 might be confused for camera motion by the motion vector search.
1344
1345 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
1346 then the full frame is used. This allows later options to be set
1347 without specifying the bounding box for the motion vector search.
1348
1349 Default - search the whole frame.
1350
1351 @item rx, ry
1352 Specify the maximum extent of movement in x and y directions in the
1353 range 0-64 pixels. Default 16.
1354
1355 @item edge
1356 Specify how to generate pixels to fill blanks at the edge of the
1357 frame. An integer from 0 to 3 as follows:
1358 @table @option
1359 @item 0
1360 Fill zeroes at blank locations
1361 @item 1
1362 Original image at blank locations
1363 @item 2
1364 Extruded edge value at blank locations
1365 @item 3
1366 Mirrored edge at blank locations
1367 @end table
1368
1369 The default setting is mirror edge at blank locations.
1370
1371 @item blocksize
1372 Specify the blocksize to use for motion search. Range 4-128 pixels,
1373 default 8.
1374
1375 @item contrast
1376 Specify the contrast threshold for blocks. Only blocks with more than
1377 the specified contrast (difference between darkest and lightest
1378 pixels) will be considered. Range 1-255, default 125.
1379
1380 @item search
1381 Specify the search strategy 0 = exhaustive search, 1 = less exhaustive
1382 search. Default - exhaustive search.
1383
1384 @item filename
1385 If set then a detailed log of the motion search is written to the
1386 specified file.
1387
1388 @end table
1389
1390 @section drawbox
1391
1392 Draw a colored box on the input image.
1393
1394 It accepts the syntax:
1395 @example
1396 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
1397 @end example
1398
1399 @table @option
1400
1401 @item x, y
1402 Specify the top left corner coordinates of the box. Default to 0.
1403
1404 @item width, height
1405 Specify the width and height of the box, if 0 they are interpreted as
1406 the input width and height. Default to 0.
1407
1408 @item color
1409 Specify the color of the box to write, it can be the name of a color
1410 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1411 @end table
1412
1413 Follow some examples:
1414 @example
1415 # draw a black box around the edge of the input image
1416 drawbox
1417
1418 # draw a box with color red and an opacity of 50%
1419 drawbox=10:20:200:60:red@@0.5"
1420 @end example
1421
1422 @section drawtext
1423
1424 Draw text string or text from specified file on top of video using the
1425 libfreetype library.
1426
1427 To enable compilation of this filter you need to configure FFmpeg with
1428 @code{--enable-libfreetype}.
1429
1430 The filter also recognizes strftime() sequences in the provided text
1431 and expands them accordingly. Check the documentation of strftime().
1432
1433 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
1434 separated by ":".
1435
1436 The description of the accepted parameters follows.
1437
1438 @table @option
1439
1440 @item box
1441 Used to draw a box around text using background color.
1442 Value should be either 1 (enable) or 0 (disable).
1443 The default value of @var{box} is 0.
1444
1445 @item boxcolor
1446 The color to be used for drawing box around text.
1447 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
1448 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1449 The default value of @var{boxcolor} is "white".
1450
1451 @item draw
1452 Set an expression which specifies if the text should be drawn. If the
1453 expression evaluates to 0, the text is not drawn. This is useful for
1454 specifying that the text should be drawn only when specific conditions
1455 are met.
1456
1457 Default value is "1".
1458
1459 See below for the list of accepted constants and functions.
1460
1461 @item fix_bounds
1462 If true, check and fix text coords to avoid clipping.
1463
1464 @item fontcolor
1465 The color to be used for drawing fonts.
1466 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
1467 (e.g. "0xff000033"), possibly followed by an alpha specifier.
1468 The default value of @var{fontcolor} is "black".
1469
1470 @item fontfile
1471 The font file to be used for drawing text. Path must be included.
1472 This parameter is mandatory.
1473
1474 @item fontsize
1475 The font size to be used for drawing text.
1476 The default value of @var{fontsize} is 16.
1477
1478 @item ft_load_flags
1479 Flags to be used for loading the fonts.
1480
1481 The flags map the corresponding flags supported by libfreetype, and are
1482 a combination of the following values:
1483 @table @var
1484 @item default
1485 @item no_scale
1486 @item no_hinting
1487 @item render
1488 @item no_bitmap
1489 @item vertical_layout
1490 @item force_autohint
1491 @item crop_bitmap
1492 @item pedantic
1493 @item ignore_global_advance_width
1494 @item no_recurse
1495 @item ignore_transform
1496 @item monochrome
1497 @item linear_design
1498 @item no_autohint
1499 @item end table
1500 @end table
1501
1502 Default value is "render".
1503
1504 For more information consult the documentation for the FT_LOAD_*
1505 libfreetype flags.
1506
1507 @item shadowcolor
1508 The color to be used for drawing a shadow behind the drawn text.  It
1509 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
1510 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1511 The default value of @var{shadowcolor} is "black".
1512
1513 @item shadowx, shadowy
1514 The x and y offsets for the text shadow position with respect to the
1515 position of the text. They can be either positive or negative
1516 values. Default value for both is "0".
1517
1518 @item tabsize
1519 The size in number of spaces to use for rendering the tab.
1520 Default value is 4.
1521
1522 @item timecode
1523 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
1524 format. It can be used with or without text parameter. @var{timecode_rate}
1525 option must be specified.
1526
1527 @item timecode_rate, rate, r
1528 Set the timecode frame rate (timecode only).
1529
1530 @item text
1531 The text string to be drawn. The text must be a sequence of UTF-8
1532 encoded characters.
1533 This parameter is mandatory if no file is specified with the parameter
1534 @var{textfile}.
1535
1536 @item textfile
1537 A text file containing text to be drawn. The text must be a sequence
1538 of UTF-8 encoded characters.
1539
1540 This parameter is mandatory if no text string is specified with the
1541 parameter @var{text}.
1542
1543 If both @var{text} and @var{textfile} are specified, an error is thrown.
1544
1545 @item x, y
1546 The expressions which specify the offsets where text will be drawn
1547 within the video frame. They are relative to the top/left border of the
1548 output image.
1549
1550 The default value of @var{x} and @var{y} is "0".
1551
1552 See below for the list of accepted constants and functions.
1553 @end table
1554
1555 The parameters for @var{x} and @var{y} are expressions containing the
1556 following constants and functions:
1557
1558 @table @option
1559 @item dar
1560 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
1561
1562 @item hsub, vsub
1563 horizontal and vertical chroma subsample values. For example for the
1564 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1565
1566 @item line_h, lh
1567 the height of each text line
1568
1569 @item main_h, h, H
1570 the input height
1571
1572 @item main_w, w, W
1573 the input width
1574
1575 @item max_glyph_a, ascent
1576 the maximum distance from the baseline to the highest/upper grid
1577 coordinate used to place a glyph outline point, for all the rendered
1578 glyphs.
1579 It is a positive value, due to the grid's orientation with the Y axis
1580 upwards.
1581
1582 @item max_glyph_d, descent
1583 the maximum distance from the baseline to the lowest grid coordinate
1584 used to place a glyph outline point, for all the rendered glyphs.
1585 This is a negative value, due to the grid's orientation, with the Y axis
1586 upwards.
1587
1588 @item max_glyph_h
1589 maximum glyph height, that is the maximum height for all the glyphs
1590 contained in the rendered text, it is equivalent to @var{ascent} -
1591 @var{descent}.
1592
1593 @item max_glyph_w
1594 maximum glyph width, that is the maximum width for all the glyphs
1595 contained in the rendered text
1596
1597 @item n
1598 the number of input frame, starting from 0
1599
1600 @item rand(min, max)
1601 return a random number included between @var{min} and @var{max}
1602
1603 @item sar
1604 input sample aspect ratio
1605
1606 @item t
1607 timestamp expressed in seconds, NAN if the input timestamp is unknown
1608
1609 @item text_h, th
1610 the height of the rendered text
1611
1612 @item text_w, tw
1613 the width of the rendered text
1614
1615 @item x, y
1616 the x and y offset coordinates where the text is drawn.
1617
1618 These parameters allow the @var{x} and @var{y} expressions to refer
1619 each other, so you can for example specify @code{y=x/dar}.
1620 @end table
1621
1622 If libavfilter was built with @code{--enable-fontconfig}, then
1623 @option{fontfile} can be a fontconfig pattern or omitted.
1624
1625 Some examples follow.
1626
1627 @itemize
1628
1629 @item
1630 Draw "Test Text" with font FreeSerif, using the default values for the
1631 optional parameters.
1632
1633 @example
1634 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1635 @end example
1636
1637 @item
1638 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
1639 and y=50 (counting from the top-left corner of the screen), text is
1640 yellow with a red box around it. Both the text and the box have an
1641 opacity of 20%.
1642
1643 @example
1644 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1645           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
1646 @end example
1647
1648 Note that the double quotes are not necessary if spaces are not used
1649 within the parameter list.
1650
1651 @item
1652 Show the text at the center of the video frame:
1653 @example
1654 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
1655 @end example
1656
1657 @item
1658 Show a text line sliding from right to left in the last row of the video
1659 frame. The file @file{LONG_LINE} is assumed to contain a single line
1660 with no newlines.
1661 @example
1662 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
1663 @end example
1664
1665 @item
1666 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
1667 @example
1668 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
1669 @end example
1670
1671 @item
1672 Draw a single green letter "g", at the center of the input video.
1673 The glyph baseline is placed at half screen height.
1674 @example
1675 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
1676 @end example
1677
1678 @item
1679 Show text for 1 second every 3 seconds:
1680 @example
1681 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\\,3)\\,1):text='blink'"
1682 @end example
1683
1684 @item
1685 Use fontconfig to set the font. Note that the colons need to be escaped.
1686 @example
1687 drawtext='fontfile=Linux Libertine O-40\\:style=Semibold:text=FFmpeg'
1688 @end example
1689
1690 @end itemize
1691
1692 For more information about libfreetype, check:
1693 @url{http://www.freetype.org/}.
1694
1695 For more information about fontconfig, check:
1696 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
1697
1698 @section fade
1699
1700 Apply fade-in/out effect to input video.
1701
1702 It accepts the parameters:
1703 @var{type}:@var{start_frame}:@var{nb_frames}[:@var{options}]
1704
1705 @var{type} specifies if the effect type, can be either "in" for
1706 fade-in, or "out" for a fade-out effect.
1707
1708 @var{start_frame} specifies the number of the start frame for starting
1709 to apply the fade effect.
1710
1711 @var{nb_frames} specifies the number of frames for which the fade
1712 effect has to last. At the end of the fade-in effect the output video
1713 will have the same intensity as the input video, at the end of the
1714 fade-out transition the output video will be completely black.
1715
1716 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
1717 separated by ":". The description of the accepted options follows.
1718
1719 @table @option
1720
1721 @item type, t
1722 See @var{type}.
1723
1724 @item start_frame, s
1725 See @var{start_frame}.
1726
1727 @item nb_frames, n
1728 See @var{nb_frames}.
1729
1730 @item alpha
1731 If set to 1, fade only alpha channel, if one exists on the input.
1732 Default value is 0.
1733 @end table
1734
1735 A few usage examples follow, usable too as test scenarios.
1736 @example
1737 # fade in first 30 frames of video
1738 fade=in:0:30
1739
1740 # fade out last 45 frames of a 200-frame video
1741 fade=out:155:45
1742
1743 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
1744 fade=in:0:25, fade=out:975:25
1745
1746 # make first 5 frames black, then fade in from frame 5-24
1747 fade=in:5:20
1748
1749 # fade in alpha over first 25 frames of video
1750 fade=in:0:25:alpha=1
1751 @end example
1752
1753 @section fieldorder
1754
1755 Transform the field order of the input video.
1756
1757 It accepts one parameter which specifies the required field order that
1758 the input interlaced video will be transformed to. The parameter can
1759 assume one of the following values:
1760
1761 @table @option
1762 @item 0 or bff
1763 output bottom field first
1764 @item 1 or tff
1765 output top field first
1766 @end table
1767
1768 Default value is "tff".
1769
1770 Transformation is achieved by shifting the picture content up or down
1771 by one line, and filling the remaining line with appropriate picture content.
1772 This method is consistent with most broadcast field order converters.
1773
1774 If the input video is not flagged as being interlaced, or it is already
1775 flagged as being of the required output field order then this filter does
1776 not alter the incoming video.
1777
1778 This filter is very useful when converting to or from PAL DV material,
1779 which is bottom field first.
1780
1781 For example:
1782 @example
1783 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
1784 @end example
1785
1786 @section fifo
1787
1788 Buffer input images and send them when they are requested.
1789
1790 This filter is mainly useful when auto-inserted by the libavfilter
1791 framework.
1792
1793 The filter does not take parameters.
1794
1795 @section format
1796
1797 Convert the input video to one of the specified pixel formats.
1798 Libavfilter will try to pick one that is supported for the input to
1799 the next filter.
1800
1801 The filter accepts a list of pixel format names, separated by ":",
1802 for example "yuv420p:monow:rgb24".
1803
1804 Some examples follow:
1805 @example
1806 # convert the input video to the format "yuv420p"
1807 format=yuv420p
1808
1809 # convert the input video to any of the formats in the list
1810 format=yuv420p:yuv444p:yuv410p
1811 @end example
1812
1813 @section fps
1814
1815 Convert the video to specified constant framerate by duplicating or dropping
1816 frames as necessary.
1817
1818 This filter accepts the following named parameters:
1819 @table @option
1820
1821 @item fps
1822 Desired output framerate.
1823
1824 @end table
1825
1826 @anchor{frei0r}
1827 @section frei0r
1828
1829 Apply a frei0r effect to the input video.
1830
1831 To enable compilation of this filter you need to install the frei0r
1832 header and configure FFmpeg with @code{--enable-frei0r}.
1833
1834 The filter supports the syntax:
1835 @example
1836 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
1837 @end example
1838
1839 @var{filter_name} is the name to the frei0r effect to load. If the
1840 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
1841 is searched in each one of the directories specified by the colon
1842 separated list in @env{FREIOR_PATH}, otherwise in the standard frei0r
1843 paths, which are in this order: @file{HOME/.frei0r-1/lib/},
1844 @file{/usr/local/lib/frei0r-1/}, @file{/usr/lib/frei0r-1/}.
1845
1846 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
1847 for the frei0r effect.
1848
1849 A frei0r effect parameter can be a boolean (whose values are specified
1850 with "y" and "n"), a double, a color (specified by the syntax
1851 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1852 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1853 description), a position (specified by the syntax @var{X}/@var{Y},
1854 @var{X} and @var{Y} being float numbers) and a string.
1855
1856 The number and kind of parameters depend on the loaded effect. If an
1857 effect parameter is not specified the default value is set.
1858
1859 Some examples follow:
1860
1861 @itemize
1862 @item
1863 Apply the distort0r effect, set the first two double parameters:
1864 @example
1865 frei0r=distort0r:0.5:0.01
1866 @end example
1867
1868 @item
1869 Apply the colordistance effect, takes a color as first parameter:
1870 @example
1871 frei0r=colordistance:0.2/0.3/0.4
1872 frei0r=colordistance:violet
1873 frei0r=colordistance:0x112233
1874 @end example
1875
1876 @item
1877 Apply the perspective effect, specify the top left and top right image
1878 positions:
1879 @example
1880 frei0r=perspective:0.2/0.2:0.8/0.2
1881 @end example
1882 @end itemize
1883
1884 For more information see:
1885 @url{http://frei0r.dyne.org}
1886
1887 @section gradfun
1888
1889 Fix the banding artifacts that are sometimes introduced into nearly flat
1890 regions by truncation to 8bit color depth.
1891 Interpolate the gradients that should go where the bands are, and
1892 dither them.
1893
1894 This filter is designed for playback only.  Do not use it prior to
1895 lossy compression, because compression tends to lose the dither and
1896 bring back the bands.
1897
1898 The filter takes two optional parameters, separated by ':':
1899 @var{strength}:@var{radius}
1900
1901 @var{strength} is the maximum amount by which the filter will change
1902 any one pixel. Also the threshold for detecting nearly flat
1903 regions. Acceptable values range from .51 to 255, default value is
1904 1.2, out-of-range values will be clipped to the valid range.
1905
1906 @var{radius} is the neighborhood to fit the gradient to. A larger
1907 radius makes for smoother gradients, but also prevents the filter from
1908 modifying the pixels near detailed regions. Acceptable values are
1909 8-32, default value is 16, out-of-range values will be clipped to the
1910 valid range.
1911
1912 @example
1913 # default parameters
1914 gradfun=1.2:16
1915
1916 # omitting radius
1917 gradfun=1.2
1918 @end example
1919
1920 @section hflip
1921
1922 Flip the input video horizontally.
1923
1924 For example to horizontally flip the input video with @command{ffmpeg}:
1925 @example
1926 ffmpeg -i in.avi -vf "hflip" out.avi
1927 @end example
1928
1929 @section hqdn3d
1930
1931 High precision/quality 3d denoise filter. This filter aims to reduce
1932 image noise producing smooth images and making still images really
1933 still. It should enhance compressibility.
1934
1935 It accepts the following optional parameters:
1936 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
1937
1938 @table @option
1939 @item luma_spatial
1940 a non-negative float number which specifies spatial luma strength,
1941 defaults to 4.0
1942
1943 @item chroma_spatial
1944 a non-negative float number which specifies spatial chroma strength,
1945 defaults to 3.0*@var{luma_spatial}/4.0
1946
1947 @item luma_tmp
1948 a float number which specifies luma temporal strength, defaults to
1949 6.0*@var{luma_spatial}/4.0
1950
1951 @item chroma_tmp
1952 a float number which specifies chroma temporal strength, defaults to
1953 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1954 @end table
1955
1956 @section idet
1957
1958 Interlaceing detect filter. This filter tries to detect if the input is
1959 interlaced or progressive. Top or bottom field first.
1960
1961 @section lut, lutrgb, lutyuv
1962
1963 Compute a look-up table for binding each pixel component input value
1964 to an output value, and apply it to input video.
1965
1966 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1967 to an RGB input video.
1968
1969 These filters accept in input a ":"-separated list of options, which
1970 specify the expressions used for computing the lookup table for the
1971 corresponding pixel component values.
1972
1973 The @var{lut} filter requires either YUV or RGB pixel formats in
1974 input, and accepts the options:
1975 @table @option
1976 @item c0
1977 first  pixel component
1978 @item c1
1979 second pixel component
1980 @item c2
1981 third  pixel component
1982 @item c3
1983 fourth pixel component, corresponds to the alpha component
1984 @end table
1985
1986 The exact component associated to each option depends on the format in
1987 input.
1988
1989 The @var{lutrgb} filter requires RGB pixel formats in input, and
1990 accepts the options:
1991 @table @option
1992 @item r
1993 red component
1994 @item g
1995 green component
1996 @item b
1997 blue component
1998 @item a
1999 alpha component
2000 @end table
2001
2002 The @var{lutyuv} filter requires YUV pixel formats in input, and
2003 accepts the options:
2004 @table @option
2005 @item y
2006 Y/luminance component
2007 @item u
2008 U/Cb component
2009 @item v
2010 V/Cr component
2011 @item a
2012 alpha component
2013 @end table
2014
2015 The expressions can contain the following constants and functions:
2016
2017 @table @option
2018 @item w, h
2019 the input width and height
2020
2021 @item val
2022 input value for the pixel component
2023
2024 @item clipval
2025 the input value clipped in the @var{minval}-@var{maxval} range
2026
2027 @item maxval
2028 maximum value for the pixel component
2029
2030 @item minval
2031 minimum value for the pixel component
2032
2033 @item negval
2034 the negated value for the pixel component value clipped in the
2035 @var{minval}-@var{maxval} range , it corresponds to the expression
2036 "maxval-clipval+minval"
2037
2038 @item clip(val)
2039 the computed value in @var{val} clipped in the
2040 @var{minval}-@var{maxval} range
2041
2042 @item gammaval(gamma)
2043 the computed gamma correction value of the pixel component value
2044 clipped in the @var{minval}-@var{maxval} range, corresponds to the
2045 expression
2046 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
2047
2048 @end table
2049
2050 All expressions default to "val".
2051
2052 Some examples follow:
2053 @example
2054 # negate input video
2055 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
2056 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
2057
2058 # the above is the same as
2059 lutrgb="r=negval:g=negval:b=negval"
2060 lutyuv="y=negval:u=negval:v=negval"
2061
2062 # negate luminance
2063 lutyuv=y=negval
2064
2065 # remove chroma components, turns the video into a graytone image
2066 lutyuv="u=128:v=128"
2067
2068 # apply a luma burning effect
2069 lutyuv="y=2*val"
2070
2071 # remove green and blue components
2072 lutrgb="g=0:b=0"
2073
2074 # set a constant alpha channel value on input
2075 format=rgba,lutrgb=a="maxval-minval/2"
2076
2077 # correct luminance gamma by a 0.5 factor
2078 lutyuv=y=gammaval(0.5)
2079 @end example
2080
2081 @section mp
2082
2083 Apply an MPlayer filter to the input video.
2084
2085 This filter provides a wrapper around most of the filters of
2086 MPlayer/MEncoder.
2087
2088 This wrapper is considered experimental. Some of the wrapped filters
2089 may not work properly and we may drop support for them, as they will
2090 be implemented natively into FFmpeg. Thus you should avoid
2091 depending on them when writing portable scripts.
2092
2093 The filters accepts the parameters:
2094 @var{filter_name}[:=]@var{filter_params}
2095
2096 @var{filter_name} is the name of a supported MPlayer filter,
2097 @var{filter_params} is a string containing the parameters accepted by
2098 the named filter.
2099
2100 The list of the currently supported filters follows:
2101 @table @var
2102 @item decimate
2103 @item denoise3d
2104 @item detc
2105 @item dint
2106 @item divtc
2107 @item down3dright
2108 @item dsize
2109 @item eq2
2110 @item eq
2111 @item field
2112 @item fil
2113 @item fixpts
2114 @item framestep
2115 @item fspp
2116 @item geq
2117 @item harddup
2118 @item hqdn3d
2119 @item hue
2120 @item il
2121 @item ilpack
2122 @item ivtc
2123 @item kerndeint
2124 @item mcdeint
2125 @item noise
2126 @item ow
2127 @item palette
2128 @item perspective
2129 @item phase
2130 @item pp7
2131 @item pullup
2132 @item qp
2133 @item rectangle
2134 @item rotate
2135 @item sab
2136 @item smartblur
2137 @item softpulldown
2138 @item softskip
2139 @item spp
2140 @item telecine
2141 @item tile
2142 @item tinterlace
2143 @item unsharp
2144 @item uspp
2145 @item yuvcsp
2146 @item yvu9
2147 @end table
2148
2149 The parameter syntax and behavior for the listed filters are the same
2150 of the corresponding MPlayer filters. For detailed instructions check
2151 the "VIDEO FILTERS" section in the MPlayer manual.
2152
2153 Some examples follow:
2154 @example
2155 # adjust gamma, brightness, contrast
2156 mp=eq2=1.0:2:0.5
2157
2158 # tweak hue and saturation
2159 mp=hue=100:-10
2160 @end example
2161
2162 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
2163
2164 @section negate
2165
2166 Negate input video.
2167
2168 This filter accepts an integer in input, if non-zero it negates the
2169 alpha component (if available). The default value in input is 0.
2170
2171 @section noformat
2172
2173 Force libavfilter not to use any of the specified pixel formats for the
2174 input to the next filter.
2175
2176 The filter accepts a list of pixel format names, separated by ":",
2177 for example "yuv420p:monow:rgb24".
2178
2179 Some examples follow:
2180 @example
2181 # force libavfilter to use a format different from "yuv420p" for the
2182 # input to the vflip filter
2183 noformat=yuv420p,vflip
2184
2185 # convert the input video to any of the formats not contained in the list
2186 noformat=yuv420p:yuv444p:yuv410p
2187 @end example
2188
2189 @section null
2190
2191 Pass the video source unchanged to the output.
2192
2193 @section ocv
2194
2195 Apply video transform using libopencv.
2196
2197 To enable this filter install libopencv library and headers and
2198 configure FFmpeg with @code{--enable-libopencv}.
2199
2200 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
2201
2202 @var{filter_name} is the name of the libopencv filter to apply.
2203
2204 @var{filter_params} specifies the parameters to pass to the libopencv
2205 filter. If not specified the default values are assumed.
2206
2207 Refer to the official libopencv documentation for more precise
2208 information:
2209 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
2210
2211 Follows the list of supported libopencv filters.
2212
2213 @anchor{dilate}
2214 @subsection dilate
2215
2216 Dilate an image by using a specific structuring element.
2217 This filter corresponds to the libopencv function @code{cvDilate}.
2218
2219 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
2220
2221 @var{struct_el} represents a structuring element, and has the syntax:
2222 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
2223
2224 @var{cols} and @var{rows} represent the number of columns and rows of
2225 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
2226 point, and @var{shape} the shape for the structuring element, and
2227 can be one of the values "rect", "cross", "ellipse", "custom".
2228
2229 If the value for @var{shape} is "custom", it must be followed by a
2230 string of the form "=@var{filename}". The file with name
2231 @var{filename} is assumed to represent a binary image, with each
2232 printable character corresponding to a bright pixel. When a custom
2233 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
2234 or columns and rows of the read file are assumed instead.
2235
2236 The default value for @var{struct_el} is "3x3+0x0/rect".
2237
2238 @var{nb_iterations} specifies the number of times the transform is
2239 applied to the image, and defaults to 1.
2240
2241 Follow some example:
2242 @example
2243 # use the default values
2244 ocv=dilate
2245
2246 # dilate using a structuring element with a 5x5 cross, iterate two times
2247 ocv=dilate=5x5+2x2/cross:2
2248
2249 # read the shape from the file diamond.shape, iterate two times
2250 # the file diamond.shape may contain a pattern of characters like this:
2251 #   *
2252 #  ***
2253 # *****
2254 #  ***
2255 #   *
2256 # the specified cols and rows are ignored (but not the anchor point coordinates)
2257 ocv=0x0+2x2/custom=diamond.shape:2
2258 @end example
2259
2260 @subsection erode
2261
2262 Erode an image by using a specific structuring element.
2263 This filter corresponds to the libopencv function @code{cvErode}.
2264
2265 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
2266 with the same syntax and semantics as the @ref{dilate} filter.
2267
2268 @subsection smooth
2269
2270 Smooth the input video.
2271
2272 The filter takes the following parameters:
2273 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
2274
2275 @var{type} is the type of smooth filter to apply, and can be one of
2276 the following values: "blur", "blur_no_scale", "median", "gaussian",
2277 "bilateral". The default value is "gaussian".
2278
2279 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
2280 parameters whose meanings depend on smooth type. @var{param1} and
2281 @var{param2} accept integer positive values or 0, @var{param3} and
2282 @var{param4} accept float values.
2283
2284 The default value for @var{param1} is 3, the default value for the
2285 other parameters is 0.
2286
2287 These parameters correspond to the parameters assigned to the
2288 libopencv function @code{cvSmooth}.
2289
2290 @anchor{overlay}
2291 @section overlay
2292
2293 Overlay one video on top of another.
2294
2295 It takes two inputs and one output, the first input is the "main"
2296 video on which the second input is overlayed.
2297
2298 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
2299
2300 @var{x} is the x coordinate of the overlayed video on the main video,
2301 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
2302 the following parameters:
2303
2304 @table @option
2305 @item main_w, main_h
2306 main input width and height
2307
2308 @item W, H
2309 same as @var{main_w} and @var{main_h}
2310
2311 @item overlay_w, overlay_h
2312 overlay input width and height
2313
2314 @item w, h
2315 same as @var{overlay_w} and @var{overlay_h}
2316 @end table
2317
2318 @var{options} is an optional list of @var{key}=@var{value} pairs,
2319 separated by ":".
2320
2321 The description of the accepted options follows.
2322
2323 @table @option
2324 @item rgb
2325 If set to 1, force the filter to accept inputs in the RGB
2326 color space. Default value is 0.
2327 @end table
2328
2329 Be aware that frames are taken from each input video in timestamp
2330 order, hence, if their initial timestamps differ, it is a a good idea
2331 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
2332 have them begin in the same zero timestamp, as it does the example for
2333 the @var{movie} filter.
2334
2335 Follow some examples:
2336 @example
2337 # draw the overlay at 10 pixels from the bottom right
2338 # corner of the main video.
2339 overlay=main_w-overlay_w-10:main_h-overlay_h-10
2340
2341 # insert a transparent PNG logo in the bottom left corner of the input
2342 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
2343
2344 # insert 2 different transparent PNG logos (second logo on bottom
2345 # right corner):
2346 ffmpeg -i input -i logo1 -i logo2 -filter_complex
2347 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
2348
2349 # add a transparent color layer on top of the main video,
2350 # WxH specifies the size of the main input to the overlay filter
2351 color=red@.3:WxH [over]; [in][over] overlay [out]
2352 @end example
2353
2354 You can chain together more overlays but the efficiency of such
2355 approach is yet to be tested.
2356
2357 @section pad
2358
2359 Add paddings to the input image, and places the original input at the
2360 given coordinates @var{x}, @var{y}.
2361
2362 It accepts the following parameters:
2363 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
2364
2365 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
2366 expressions containing the following constants:
2367
2368 @table @option
2369 @item in_w, in_h
2370 the input video width and height
2371
2372 @item iw, ih
2373 same as @var{in_w} and @var{in_h}
2374
2375 @item out_w, out_h
2376 the output width and height, that is the size of the padded area as
2377 specified by the @var{width} and @var{height} expressions
2378
2379 @item ow, oh
2380 same as @var{out_w} and @var{out_h}
2381
2382 @item x, y
2383 x and y offsets as specified by the @var{x} and @var{y}
2384 expressions, or NAN if not yet specified
2385
2386 @item a
2387 same as @var{iw} / @var{ih}
2388
2389 @item sar
2390 input sample aspect ratio
2391
2392 @item dar
2393 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2394
2395 @item hsub, vsub
2396 horizontal and vertical chroma subsample values. For example for the
2397 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2398 @end table
2399
2400 Follows the description of the accepted parameters.
2401
2402 @table @option
2403 @item width, height
2404
2405 Specify the size of the output image with the paddings added. If the
2406 value for @var{width} or @var{height} is 0, the corresponding input size
2407 is used for the output.
2408
2409 The @var{width} expression can reference the value set by the
2410 @var{height} expression, and vice versa.
2411
2412 The default value of @var{width} and @var{height} is 0.
2413
2414 @item x, y
2415
2416 Specify the offsets where to place the input image in the padded area
2417 with respect to the top/left border of the output image.
2418
2419 The @var{x} expression can reference the value set by the @var{y}
2420 expression, and vice versa.
2421
2422 The default value of @var{x} and @var{y} is 0.
2423
2424 @item color
2425
2426 Specify the color of the padded area, it can be the name of a color
2427 (case insensitive match) or a 0xRRGGBB[AA] sequence.
2428
2429 The default value of @var{color} is "black".
2430
2431 @end table
2432
2433 Some examples follow:
2434
2435 @example
2436 # Add paddings with color "violet" to the input video. Output video
2437 # size is 640x480, the top-left corner of the input video is placed at
2438 # column 0, row 40.
2439 pad=640:480:0:40:violet
2440
2441 # pad the input to get an output with dimensions increased bt 3/2,
2442 # and put the input video at the center of the padded area
2443 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
2444
2445 # pad the input to get a squared output with size equal to the maximum
2446 # value between the input width and height, and put the input video at
2447 # the center of the padded area
2448 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
2449
2450 # pad the input to get a final w/h ratio of 16:9
2451 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
2452
2453 # for anamorphic video, in order to set the output display aspect ratio,
2454 # it is necessary to use sar in the expression, according to the relation:
2455 # (ih * X / ih) * sar = output_dar
2456 # X = output_dar / sar
2457 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
2458
2459 # double output size and put the input video in the bottom-right
2460 # corner of the output padded area
2461 pad="2*iw:2*ih:ow-iw:oh-ih"
2462 @end example
2463
2464 @section pixdesctest
2465
2466 Pixel format descriptor test filter, mainly useful for internal
2467 testing. The output video should be equal to the input video.
2468
2469 For example:
2470 @example
2471 format=monow, pixdesctest
2472 @end example
2473
2474 can be used to test the monowhite pixel format descriptor definition.
2475
2476 @section removelogo
2477
2478 Suppress a TV station logo, using an image file to determine which
2479 pixels comprise the logo. It works by filling in the pixels that
2480 comprise the logo with neighboring pixels.
2481
2482 This filter requires one argument which specifies the filter bitmap
2483 file, which can be any image format supported by libavformat. The
2484 width and height of the image file must match those of the video
2485 stream being processed.
2486
2487 Pixels in the provided bitmap image with a value of zero are not
2488 considered part of the logo, non-zero pixels are considered part of
2489 the logo. If you use white (255) for the logo and black (0) for the
2490 rest, you will be safe. For making the filter bitmap, it is
2491 recommended to take a screen capture of a black frame with the logo
2492 visible, and then using a threshold filter followed by the erode
2493 filter once or twice.
2494
2495 If needed, little splotches can be fixed manually. Remember that if
2496 logo pixels are not covered, the filter quality will be much
2497 reduced. Marking too many pixels as part of the logo does not hurt as
2498 much, but it will increase the amount of blurring needed to cover over
2499 the image and will destroy more information than necessary, and extra
2500 pixels will slow things down on a large logo.
2501
2502 @section scale
2503
2504 Scale the input video to @var{width}:@var{height}[:@var{interl}=@{1|-1@}] and/or convert the image format.
2505
2506 The scale filter forces the output display aspect ratio to be the same
2507 of the input, by changing the output sample aspect ratio.
2508
2509 The parameters @var{width} and @var{height} are expressions containing
2510 the following constants:
2511
2512 @table @option
2513 @item in_w, in_h
2514 the input width and height
2515
2516 @item iw, ih
2517 same as @var{in_w} and @var{in_h}
2518
2519 @item out_w, out_h
2520 the output (cropped) width and height
2521
2522 @item ow, oh
2523 same as @var{out_w} and @var{out_h}
2524
2525 @item a
2526 same as @var{iw} / @var{ih}
2527
2528 @item sar
2529 input sample aspect ratio
2530
2531 @item dar
2532 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2533
2534 @item hsub, vsub
2535 horizontal and vertical chroma subsample values. For example for the
2536 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2537 @end table
2538
2539 If the input image format is different from the format requested by
2540 the next filter, the scale filter will convert the input to the
2541 requested format.
2542
2543 If the value for @var{width} or @var{height} is 0, the respective input
2544 size is used for the output.
2545
2546 If the value for @var{width} or @var{height} is -1, the scale filter will
2547 use, for the respective output size, a value that maintains the aspect
2548 ratio of the input image.
2549
2550 The default value of @var{width} and @var{height} is 0.
2551
2552 Valid values for the optional parameter @var{interl} are:
2553
2554 @table @option
2555 @item 1
2556 force interlaced aware scaling
2557
2558 @item -1
2559 select interlaced aware scaling depending on whether the source frames
2560 are flagged as interlaced or not
2561 @end table
2562
2563 Unless @var{interl} is set to one of the above options, interlaced scaling will not be used.
2564
2565 Some examples follow:
2566 @example
2567 # scale the input video to a size of 200x100.
2568 scale=200:100
2569
2570 # scale the input to 2x
2571 scale=2*iw:2*ih
2572 # the above is the same as
2573 scale=2*in_w:2*in_h
2574
2575 # scale the input to 2x with forced interlaced scaling
2576 scale=2*iw:2*ih:interl=1
2577
2578 # scale the input to half size
2579 scale=iw/2:ih/2
2580
2581 # increase the width, and set the height to the same size
2582 scale=3/2*iw:ow
2583
2584 # seek for Greek harmony
2585 scale=iw:1/PHI*iw
2586 scale=ih*PHI:ih
2587
2588 # increase the height, and set the width to 3/2 of the height
2589 scale=3/2*oh:3/5*ih
2590
2591 # increase the size, but make the size a multiple of the chroma
2592 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
2593
2594 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
2595 scale='min(500\, iw*3/2):-1'
2596 @end example
2597
2598 @section select
2599 Select frames to pass in output.
2600
2601 It accepts in input an expression, which is evaluated for each input
2602 frame. If the expression is evaluated to a non-zero value, the frame
2603 is selected and passed to the output, otherwise it is discarded.
2604
2605 The expression can contain the following constants:
2606
2607 @table @option
2608 @item n
2609 the sequential number of the filtered frame, starting from 0
2610
2611 @item selected_n
2612 the sequential number of the selected frame, starting from 0
2613
2614 @item prev_selected_n
2615 the sequential number of the last selected frame, NAN if undefined
2616
2617 @item TB
2618 timebase of the input timestamps
2619
2620 @item pts
2621 the PTS (Presentation TimeStamp) of the filtered video frame,
2622 expressed in @var{TB} units, NAN if undefined
2623
2624 @item t
2625 the PTS (Presentation TimeStamp) of the filtered video frame,
2626 expressed in seconds, NAN if undefined
2627
2628 @item prev_pts
2629 the PTS of the previously filtered video frame, NAN if undefined
2630
2631 @item prev_selected_pts
2632 the PTS of the last previously filtered video frame, NAN if undefined
2633
2634 @item prev_selected_t
2635 the PTS of the last previously selected video frame, NAN if undefined
2636
2637 @item start_pts
2638 the PTS of the first video frame in the video, NAN if undefined
2639
2640 @item start_t
2641 the time of the first video frame in the video, NAN if undefined
2642
2643 @item pict_type
2644 the type of the filtered frame, can assume one of the following
2645 values:
2646 @table @option
2647 @item I
2648 @item P
2649 @item B
2650 @item S
2651 @item SI
2652 @item SP
2653 @item BI
2654 @end table
2655
2656 @item interlace_type
2657 the frame interlace type, can assume one of the following values:
2658 @table @option
2659 @item PROGRESSIVE
2660 the frame is progressive (not interlaced)
2661 @item TOPFIRST
2662 the frame is top-field-first
2663 @item BOTTOMFIRST
2664 the frame is bottom-field-first
2665 @end table
2666
2667 @item key
2668 1 if the filtered frame is a key-frame, 0 otherwise
2669
2670 @item pos
2671 the position in the file of the filtered frame, -1 if the information
2672 is not available (e.g. for synthetic video)
2673
2674 @item scene
2675 value between 0 and 1 to indicate a new scene; a low value reflects a low
2676 probability for the current frame to introduce a new scene, while a higher
2677 value means the current frame is more likely to be one (see the example below)
2678
2679 @end table
2680
2681 The default value of the select expression is "1".
2682
2683 Some examples follow:
2684
2685 @example
2686 # select all frames in input
2687 select
2688
2689 # the above is the same as:
2690 select=1
2691
2692 # skip all frames:
2693 select=0
2694
2695 # select only I-frames
2696 select='eq(pict_type\,I)'
2697
2698 # select one frame every 100
2699 select='not(mod(n\,100))'
2700
2701 # select only frames contained in the 10-20 time interval
2702 select='gte(t\,10)*lte(t\,20)'
2703
2704 # select only I frames contained in the 10-20 time interval
2705 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2706
2707 # select frames with a minimum distance of 10 seconds
2708 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2709 @end example
2710
2711 Complete example to create a mosaic of the first scenes:
2712
2713 @example
2714 ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
2715 @end example
2716
2717 Comparing @var{scene} against a value between 0.3 and 0.5 is generally a sane
2718 choice.
2719
2720 @section setdar, setsar
2721
2722 The @code{setdar} filter sets the Display Aspect Ratio for the filter
2723 output video.
2724
2725 This is done by changing the specified Sample (aka Pixel) Aspect
2726 Ratio, according to the following equation:
2727 @example
2728 @var{DAR} = @var{HORIZONTAL_RESOLUTION} / @var{VERTICAL_RESOLUTION} * @var{SAR}
2729 @end example
2730
2731 Keep in mind that the @code{setdar} filter does not modify the pixel
2732 dimensions of the video frame. Also the display aspect ratio set by
2733 this filter may be changed by later filters in the filterchain,
2734 e.g. in case of scaling or if another "setdar" or a "setsar" filter is
2735 applied.
2736
2737 The @code{setsar} filter sets the Sample (aka Pixel) Aspect Ratio for
2738 the filter output video.
2739
2740 Note that as a consequence of the application of this filter, the
2741 output display aspect ratio will change according to the equation
2742 above.
2743
2744 Keep in mind that the sample aspect ratio set by the @code{setsar}
2745 filter may be changed by later filters in the filterchain, e.g. if
2746 another "setsar" or a "setdar" filter is applied.
2747
2748 The @code{setdar} and @code{setsar} filters accept a parameter string
2749 which represents the wanted aspect ratio.  The parameter can
2750 be a floating point number string, an expression, or a string of the form
2751 @var{num}:@var{den}, where @var{num} and @var{den} are the numerator
2752 and denominator of the aspect ratio. If the parameter is not
2753 specified, it is assumed the value "0:1".
2754
2755 For example to change the display aspect ratio to 16:9, specify:
2756 @example
2757 setdar=16:9
2758 @end example
2759
2760 The example above is equivalent to:
2761 @example
2762 setdar=1.77777
2763 @end example
2764
2765 To change the sample aspect ratio to 10:11, specify:
2766 @example
2767 setsar=10:11
2768 @end example
2769
2770 @section setfield
2771
2772 Force field for the output video frame.
2773
2774 The @code{setfield} filter marks the interlace type field for the
2775 output frames. It does not change the input frame, but only sets the
2776 corresponding property, which affects how the frame is treated by
2777 following filters (e.g. @code{fieldorder} or @code{yadif}).
2778
2779 It accepts a string parameter, which can assume the following values:
2780 @table @samp
2781 @item auto
2782 Keep the same field property.
2783
2784 @item bff
2785 Mark the frame as bottom-field-first.
2786
2787 @item tff
2788 Mark the frame as top-field-first.
2789
2790 @item prog
2791 Mark the frame as progressive.
2792 @end table
2793
2794 @section setpts
2795
2796 Change the PTS (presentation timestamp) of the input video frames.
2797
2798 Accept in input an expression evaluated through the eval API, which
2799 can contain the following constants:
2800
2801 @table @option
2802 @item PTS
2803 the presentation timestamp in input
2804
2805 @item N
2806 the count of the input frame, starting from 0.
2807
2808 @item STARTPTS
2809 the PTS of the first video frame
2810
2811 @item INTERLACED
2812 tell if the current frame is interlaced
2813
2814 @item POS
2815 original position in the file of the frame, or undefined if undefined
2816 for the current frame
2817
2818 @item PREV_INPTS
2819 previous input PTS
2820
2821 @item PREV_OUTPTS
2822 previous output PTS
2823
2824 @end table
2825
2826 Some examples follow:
2827
2828 @example
2829 # start counting PTS from zero
2830 setpts=PTS-STARTPTS
2831
2832 # fast motion
2833 setpts=0.5*PTS
2834
2835 # slow motion
2836 setpts=2.0*PTS
2837
2838 # fixed rate 25 fps
2839 setpts=N/(25*TB)
2840
2841 # fixed rate 25 fps with some jitter
2842 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2843 @end example
2844
2845 @section settb
2846
2847 Set the timebase to use for the output frames timestamps.
2848 It is mainly useful for testing timebase configuration.
2849
2850 It accepts in input an arithmetic expression representing a rational.
2851 The expression can contain the constants "AVTB" (the
2852 default timebase), and "intb" (the input timebase).
2853
2854 The default value for the input is "intb".
2855
2856 Follow some examples.
2857
2858 @example
2859 # set the timebase to 1/25
2860 settb=1/25
2861
2862 # set the timebase to 1/10
2863 settb=0.1
2864
2865 #set the timebase to 1001/1000
2866 settb=1+0.001
2867
2868 #set the timebase to 2*intb
2869 settb=2*intb
2870
2871 #set the default timebase value
2872 settb=AVTB
2873 @end example
2874
2875 @section showinfo
2876
2877 Show a line containing various information for each input video frame.
2878 The input video is not modified.
2879
2880 The shown line contains a sequence of key/value pairs of the form
2881 @var{key}:@var{value}.
2882
2883 A description of each shown parameter follows:
2884
2885 @table @option
2886 @item n
2887 sequential number of the input frame, starting from 0
2888
2889 @item pts
2890 Presentation TimeStamp of the input frame, expressed as a number of
2891 time base units. The time base unit depends on the filter input pad.
2892
2893 @item pts_time
2894 Presentation TimeStamp of the input frame, expressed as a number of
2895 seconds
2896
2897 @item pos
2898 position of the frame in the input stream, -1 if this information in
2899 unavailable and/or meaningless (for example in case of synthetic video)
2900
2901 @item fmt
2902 pixel format name
2903
2904 @item sar
2905 sample aspect ratio of the input frame, expressed in the form
2906 @var{num}/@var{den}
2907
2908 @item s
2909 size of the input frame, expressed in the form
2910 @var{width}x@var{height}
2911
2912 @item i
2913 interlaced mode ("P" for "progressive", "T" for top field first, "B"
2914 for bottom field first)
2915
2916 @item iskey
2917 1 if the frame is a key frame, 0 otherwise
2918
2919 @item type
2920 picture type of the input frame ("I" for an I-frame, "P" for a
2921 P-frame, "B" for a B-frame, "?" for unknown type).
2922 Check also the documentation of the @code{AVPictureType} enum and of
2923 the @code{av_get_picture_type_char} function defined in
2924 @file{libavutil/avutil.h}.
2925
2926 @item checksum
2927 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
2928
2929 @item plane_checksum
2930 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
2931 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
2932 @end table
2933
2934 @section slicify
2935
2936 Pass the images of input video on to next video filter as multiple
2937 slices.
2938
2939 @example
2940 ffmpeg -i in.avi -vf "slicify=32" out.avi
2941 @end example
2942
2943 The filter accepts the slice height as parameter. If the parameter is
2944 not specified it will use the default value of 16.
2945
2946 Adding this in the beginning of filter chains should make filtering
2947 faster due to better use of the memory cache.
2948
2949 @section split
2950
2951 Split input video into several identical outputs.
2952
2953 The filter accepts a single parameter which specifies the number of outputs. If
2954 unspecified, it defaults to 2.
2955
2956 For example
2957 @example
2958 ffmpeg -i INPUT -filter_complex split=5 OUTPUT
2959 @end example
2960 will create 5 copies of the input video.
2961
2962 For example:
2963 @example
2964 [in] split [splitout1][splitout2];
2965 [splitout1] crop=100:100:0:0    [cropout];
2966 [splitout2] pad=200:200:100:100 [padout];
2967 @end example
2968
2969 will create two separate outputs from the same input, one cropped and
2970 one padded.
2971
2972 @section super2xsai
2973
2974 Scale the input by 2x and smooth using the Super2xSaI (Scale and
2975 Interpolate) pixel art scaling algorithm.
2976
2977 Useful for enlarging pixel art images without reducing sharpness.
2978
2979 @section swapuv
2980 Swap U & V plane.
2981
2982 @section thumbnail
2983 Select the most representative frame in a given sequence of consecutive frames.
2984
2985 It accepts as argument the frames batch size to analyze (default @var{N}=100);
2986 in a set of @var{N} frames, the filter will pick one of them, and then handle
2987 the next batch of @var{N} frames until the end.
2988
2989 Since the filter keeps track of the whole frames sequence, a bigger @var{N}
2990 value will result in a higher memory usage, so a high value is not recommended.
2991
2992 The following example extract one picture each 50 frames:
2993 @example
2994 thumbnail=50
2995 @end example
2996
2997 Complete example of a thumbnail creation with @command{ffmpeg}:
2998 @example
2999 ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
3000 @end example
3001
3002 @section tile
3003
3004 Tile several successive frames together.
3005
3006 It accepts as argument the tile size (i.e. the number of lines and columns)
3007 in the form "@var{w}x@var{h}".
3008
3009 For example, produce 8×8 PNG tiles of all keyframes (@option{-skip_frame
3010 nokey}) in a movie:
3011 @example
3012 ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
3013 @end example
3014 The @option{-vsync 0} is necessary to prevent @command{ffmpeg} from
3015 duplicating each output frame to accomodate the originally detected frame
3016 rate.
3017
3018 @section tinterlace
3019
3020 Perform various types of temporal field interlacing.
3021
3022 Frames are counted starting from 1, so the first input frame is
3023 considered odd.
3024
3025 This filter accepts a single parameter specifying the mode. Available
3026 modes are:
3027
3028 @table @samp
3029 @item merge, 0
3030 Move odd frames into the upper field, even into the lower field,
3031 generating a double height frame at half framerate.
3032
3033 @item drop_odd, 1
3034 Only output even frames, odd frames are dropped, generating a frame with
3035 unchanged height at half framerate.
3036
3037 @item drop_even, 2
3038 Only output odd frames, even frames are dropped, generating a frame with
3039 unchanged height at half framerate.
3040
3041 @item pad, 3
3042 Expand each frame to full height, but pad alternate lines with black,
3043 generating a frame with double height at the same input framerate.
3044
3045 @item interleave_top, 4
3046 Interleave the upper field from odd frames with the lower field from
3047 even frames, generating a frame with unchanged height at half framerate.
3048
3049 @item interleave_bottom, 5
3050 Interleave the lower field from odd frames with the upper field from
3051 even frames, generating a frame with unchanged height at half framerate.
3052
3053 @item interlacex2, 6
3054 Double frame rate with unchanged height. Frames are inserted each
3055 containing the second temporal field from the previous input frame and
3056 the first temporal field from the next input frame. This mode relies on
3057 the top_field_first flag. Useful for interlaced video displays with no
3058 field synchronisation.
3059 @end table
3060
3061 Numeric values are deprecated but are accepted for backward
3062 compatibility reasons.
3063
3064 Default mode is @code{merge}.
3065
3066 @section transpose
3067
3068 Transpose rows with columns in the input video and optionally flip it.
3069
3070 It accepts a parameter representing an integer, which can assume the
3071 values:
3072
3073 @table @samp
3074 @item 0
3075 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
3076 @example
3077 L.R     L.l
3078 . . ->  . .
3079 l.r     R.r
3080 @end example
3081
3082 @item 1
3083 Rotate by 90 degrees clockwise, that is:
3084 @example
3085 L.R     l.L
3086 . . ->  . .
3087 l.r     r.R
3088 @end example
3089
3090 @item 2
3091 Rotate by 90 degrees counterclockwise, that is:
3092 @example
3093 L.R     R.r
3094 . . ->  . .
3095 l.r     L.l
3096 @end example
3097
3098 @item 3
3099 Rotate by 90 degrees clockwise and vertically flip, that is:
3100 @example
3101 L.R     r.R
3102 . . ->  . .
3103 l.r     l.L
3104 @end example
3105 @end table
3106
3107 @section unsharp
3108
3109 Sharpen or blur the input video.
3110
3111 It accepts the following parameters:
3112 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
3113
3114 Negative values for the amount will blur the input video, while positive
3115 values will sharpen. All parameters are optional and default to the
3116 equivalent of the string '5:5:1.0:5:5:0.0'.
3117
3118 @table @option
3119
3120 @item luma_msize_x
3121 Set the luma matrix horizontal size. It can be an integer between 3
3122 and 13, default value is 5.
3123
3124 @item luma_msize_y
3125 Set the luma matrix vertical size. It can be an integer between 3
3126 and 13, default value is 5.
3127
3128 @item luma_amount
3129 Set the luma effect strength. It can be a float number between -2.0
3130 and 5.0, default value is 1.0.
3131
3132 @item chroma_msize_x
3133 Set the chroma matrix horizontal size. It can be an integer between 3
3134 and 13, default value is 5.
3135
3136 @item chroma_msize_y
3137 Set the chroma matrix vertical size. It can be an integer between 3
3138 and 13, default value is 5.
3139
3140 @item chroma_amount
3141 Set the chroma effect strength. It can be a float number between -2.0
3142 and 5.0, default value is 0.0.
3143
3144 @end table
3145
3146 @example
3147 # Strong luma sharpen effect parameters
3148 unsharp=7:7:2.5
3149
3150 # Strong blur of both luma and chroma parameters
3151 unsharp=7:7:-2:7:7:-2
3152
3153 # Use the default values with @command{ffmpeg}
3154 ffmpeg -i in.avi -vf "unsharp" out.mp4
3155 @end example
3156
3157 @section vflip
3158
3159 Flip the input video vertically.
3160
3161 @example
3162 ffmpeg -i in.avi -vf "vflip" out.avi
3163 @end example
3164
3165 @section yadif
3166
3167 Deinterlace the input video ("yadif" means "yet another deinterlacing
3168 filter").
3169
3170 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
3171
3172 @var{mode} specifies the interlacing mode to adopt, accepts one of the
3173 following values:
3174
3175 @table @option
3176 @item 0
3177 output 1 frame for each frame
3178 @item 1
3179 output 1 frame for each field
3180 @item 2
3181 like 0 but skips spatial interlacing check
3182 @item 3
3183 like 1 but skips spatial interlacing check
3184 @end table
3185
3186 Default value is 0.
3187
3188 @var{parity} specifies the picture field parity assumed for the input
3189 interlaced video, accepts one of the following values:
3190
3191 @table @option
3192 @item 0
3193 assume top field first
3194 @item 1
3195 assume bottom field first
3196 @item -1
3197 enable automatic detection
3198 @end table
3199
3200 Default value is -1.
3201 If interlacing is unknown or decoder does not export this information,
3202 top field first will be assumed.
3203
3204 @var{auto} specifies if deinterlacer should trust the interlaced flag
3205 and only deinterlace frames marked as interlaced
3206
3207 @table @option
3208 @item 0
3209 deinterlace all frames
3210 @item 1
3211 only deinterlace frames marked as interlaced
3212 @end table
3213
3214 Default value is 0.
3215
3216 @c man end VIDEO FILTERS
3217
3218 @chapter Video Sources
3219 @c man begin VIDEO SOURCES
3220
3221 Below is a description of the currently available video sources.
3222
3223 @section buffer
3224
3225 Buffer video frames, and make them available to the filter chain.
3226
3227 This source is mainly intended for a programmatic use, in particular
3228 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
3229
3230 It accepts a list of options in the form of @var{key}=@var{value} pairs
3231 separated by ":". A descroption of the accepted options follows.
3232
3233 @table @option
3234
3235 @item video_size
3236 Specify the size (width and height) of the buffered video frames.
3237
3238 @item pix_fmt
3239 A string representing the pixel format of the buffered video frames.
3240 It may be a number corresponding to a pixel format, or a pixel format
3241 name.
3242
3243 @item time_base
3244 Specify the timebase assumed by the timestamps of the buffered frames.
3245
3246 @item time_base
3247 Specify the frame rate expected for the video stream.
3248
3249 @item pixel_aspect
3250 Specify the sample aspect ratio assumed by the video frames.
3251
3252 @item sws_param
3253 Specify the optional parameters to be used for the scale filter which
3254 is automatically inserted when an input change is detected in the
3255 input size or format.
3256 @end table
3257
3258 For example:
3259 @example
3260 buffer=size=320x240:pix_fmt=yuv410p:time_base=1/24:pixel_aspect=1/1
3261 @end example
3262
3263 will instruct the source to accept video frames with size 320x240 and
3264 with format "yuv410p", assuming 1/24 as the timestamps timebase and
3265 square pixels (1:1 sample aspect ratio).
3266 Since the pixel format with name "yuv410p" corresponds to the number 6
3267 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}),
3268 this example corresponds to:
3269 @example
3270 buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
3271 @end example
3272
3273 Alternatively, the options can be specified as a flat string, but this
3274 syntax is deprecated:
3275
3276 @var{width}:@var{height}:@var{pix_fmt}:@var{time_base.num}:@var{time_base.den}:@var{pixel_aspect.num}:@var{pixel_aspect.den}[:@var{sws_param}]
3277
3278 @section cellauto
3279
3280 Create a pattern generated by an elementary cellular automaton.
3281
3282 The initial state of the cellular automaton can be defined through the
3283 @option{filename}, and @option{pattern} options. If such options are
3284 not specified an initial state is created randomly.
3285
3286 At each new frame a new row in the video is filled with the result of
3287 the cellular automaton next generation. The behavior when the whole
3288 frame is filled is defined by the @option{scroll} option.
3289
3290 This source accepts a list of options in the form of
3291 @var{key}=@var{value} pairs separated by ":". A description of the
3292 accepted options follows.
3293
3294 @table @option
3295 @item filename, f
3296 Read the initial cellular automaton state, i.e. the starting row, from
3297 the specified file.
3298 In the file, each non-whitespace character is considered an alive
3299 cell, a newline will terminate the row, and further characters in the
3300 file will be ignored.
3301
3302 @item pattern, p
3303 Read the initial cellular automaton state, i.e. the starting row, from
3304 the specified string.
3305
3306 Each non-whitespace character in the string is considered an alive
3307 cell, a newline will terminate the row, and further characters in the
3308 string will be ignored.
3309
3310 @item rate, r
3311 Set the video rate, that is the number of frames generated per second.
3312 Default is 25.
3313
3314 @item random_fill_ratio, ratio
3315 Set the random fill ratio for the initial cellular automaton row. It
3316 is a floating point number value ranging from 0 to 1, defaults to
3317 1/PHI.
3318
3319 This option is ignored when a file or a pattern is specified.
3320
3321 @item random_seed, seed
3322 Set the seed for filling randomly the initial row, must be an integer
3323 included between 0 and UINT32_MAX. If not specified, or if explicitly
3324 set to -1, the filter will try to use a good random seed on a best
3325 effort basis.
3326
3327 @item rule
3328 Set the cellular automaton rule, it is a number ranging from 0 to 255.
3329 Default value is 110.
3330
3331 @item size, s
3332 Set the size of the output video.
3333
3334 If @option{filename} or @option{pattern} is specified, the size is set
3335 by default to the width of the specified initial state row, and the
3336 height is set to @var{width} * PHI.
3337
3338 If @option{size} is set, it must contain the width of the specified
3339 pattern string, and the specified pattern will be centered in the
3340 larger row.
3341
3342 If a filename or a pattern string is not specified, the size value
3343 defaults to "320x518" (used for a randomly generated initial state).
3344
3345 @item scroll
3346 If set to 1, scroll the output upward when all the rows in the output
3347 have been already filled. If set to 0, the new generated row will be
3348 written over the top row just after the bottom row is filled.
3349 Defaults to 1.
3350
3351 @item start_full, full
3352 If set to 1, completely fill the output with generated rows before
3353 outputting the first frame.
3354 This is the default behavior, for disabling set the value to 0.
3355
3356 @item stitch
3357 If set to 1, stitch the left and right row edges together.
3358 This is the default behavior, for disabling set the value to 0.
3359 @end table
3360
3361 @subsection Examples
3362
3363 @itemize
3364 @item
3365 Read the initial state from @file{pattern}, and specify an output of
3366 size 200x400.
3367 @example
3368 cellauto=f=pattern:s=200x400
3369 @end example
3370
3371 @item
3372 Generate a random initial row with a width of 200 cells, with a fill
3373 ratio of 2/3:
3374 @example
3375 cellauto=ratio=2/3:s=200x200
3376 @end example
3377
3378 @item
3379 Create a pattern generated by rule 18 starting by a single alive cell
3380 centered on an initial row with width 100:
3381 @example
3382 cellauto=p=@@:s=100x400:full=0:rule=18
3383 @end example
3384
3385 @item
3386 Specify a more elaborated initial pattern:
3387 @example
3388 cellauto=p='@@@@ @@ @@@@':s=100x400:full=0:rule=18
3389 @end example
3390
3391 @end itemize
3392
3393 @section color
3394
3395 Provide an uniformly colored input.
3396
3397 It accepts the following parameters:
3398 @var{color}:@var{frame_size}:@var{frame_rate}
3399
3400 Follows the description of the accepted parameters.
3401
3402 @table @option
3403
3404 @item color
3405 Specify the color of the source. It can be the name of a color (case
3406 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
3407 alpha specifier. The default value is "black".
3408
3409 @item frame_size
3410 Specify the size of the sourced video, it may be a string of the form
3411 @var{width}x@var{height}, or the name of a size abbreviation. The
3412 default value is "320x240".
3413
3414 @item frame_rate
3415 Specify the frame rate of the sourced video, as the number of frames
3416 generated per second. It has to be a string in the format
3417 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
3418 number or a valid video frame rate abbreviation. The default value is
3419 "25".
3420
3421 @end table
3422
3423 For example the following graph description will generate a red source
3424 with an opacity of 0.2, with size "qcif" and a frame rate of 10
3425 frames per second, which will be overlayed over the source connected
3426 to the pad with identifier "in".
3427
3428 @example
3429 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
3430 @end example
3431
3432 @section movie
3433
3434 Read a video stream from a movie container.
3435
3436 It accepts the syntax: @var{movie_name}[:@var{options}] where
3437 @var{movie_name} is the name of the resource to read (not necessarily
3438 a file but also a device or a stream accessed through some protocol),
3439 and @var{options} is an optional sequence of @var{key}=@var{value}
3440 pairs, separated by ":".
3441
3442 The description of the accepted options follows.
3443
3444 @table @option
3445
3446 @item format_name, f
3447 Specifies the format assumed for the movie to read, and can be either
3448 the name of a container or an input device. If not specified the
3449 format is guessed from @var{movie_name} or by probing.
3450
3451 @item seek_point, sp
3452 Specifies the seek point in seconds, the frames will be output
3453 starting from this seek point, the parameter is evaluated with
3454 @code{av_strtod} so the numerical value may be suffixed by an IS
3455 postfix. Default value is "0".
3456
3457 @item stream_index, si
3458 Specifies the index of the video stream to read. If the value is -1,
3459 the best suited video stream will be automatically selected. Default
3460 value is "-1".
3461
3462 @item loop
3463 Specifies how many times to read the video stream in sequence.
3464 If the value is less than 1, the stream will be read again and again.
3465 Default value is "1".
3466
3467 Note that when the movie is looped the source timestamps are not
3468 changed, so it will generate non monotonically increasing timestamps.
3469 @end table
3470
3471 This filter allows to overlay a second video on top of main input of
3472 a filtergraph as shown in this graph:
3473 @example
3474 input -----------> deltapts0 --> overlay --> output
3475                                     ^
3476                                     |
3477 movie --> scale--> deltapts1 -------+
3478 @end example
3479
3480 Some examples follow:
3481 @example
3482 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
3483 # on top of the input labelled as "in".
3484 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
3485 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
3486
3487 # read from a video4linux2 device, and overlay it on top of the input
3488 # labelled as "in"
3489 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
3490 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
3491
3492 @end example
3493
3494 @section mptestsrc
3495
3496 Generate various test patterns, as generated by the MPlayer test filter.
3497
3498 The size of the generated video is fixed, and is 256x256.
3499 This source is useful in particular for testing encoding features.
3500
3501 This source accepts an optional sequence of @var{key}=@var{value} pairs,
3502 separated by ":". The description of the accepted options follows.
3503
3504 @table @option
3505
3506 @item rate, r
3507 Specify the frame rate of the sourced video, as the number of frames
3508 generated per second. It has to be a string in the format
3509 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
3510 number or a valid video frame rate abbreviation. The default value is
3511 "25".
3512
3513 @item duration, d
3514 Set the video duration of the sourced video. The accepted syntax is:
3515 @example
3516 [-]HH:MM:SS[.m...]
3517 [-]S+[.m...]
3518 @end example
3519 See also the function @code{av_parse_time()}.
3520
3521 If not specified, or the expressed duration is negative, the video is
3522 supposed to be generated forever.
3523
3524 @item test, t
3525
3526 Set the number or the name of the test to perform. Supported tests are:
3527 @table @option
3528 @item dc_luma
3529 @item dc_chroma
3530 @item freq_luma
3531 @item freq_chroma
3532 @item amp_luma
3533 @item amp_chroma
3534 @item cbp
3535 @item mv
3536 @item ring1
3537 @item ring2
3538 @item all
3539 @end table
3540
3541 Default value is "all", which will cycle through the list of all tests.
3542 @end table
3543
3544 For example the following:
3545 @example
3546 testsrc=t=dc_luma
3547 @end example
3548
3549 will generate a "dc_luma" test pattern.
3550
3551 @section frei0r_src
3552
3553 Provide a frei0r source.
3554
3555 To enable compilation of this filter you need to install the frei0r
3556 header and configure FFmpeg with @code{--enable-frei0r}.
3557
3558 The source supports the syntax:
3559 @example
3560 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
3561 @end example
3562
3563 @var{size} is the size of the video to generate, may be a string of the
3564 form @var{width}x@var{height} or a frame size abbreviation.
3565 @var{rate} is the rate of the video to generate, may be a string of
3566 the form @var{num}/@var{den} or a frame rate abbreviation.
3567 @var{src_name} is the name to the frei0r source to load. For more
3568 information regarding frei0r and how to set the parameters read the
3569 section @ref{frei0r} in the description of the video filters.
3570
3571 For example, to generate a frei0r partik0l source with size 200x200
3572 and frame rate 10 which is overlayed on the overlay filter main input:
3573 @example
3574 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
3575 @end example
3576
3577 @section life
3578
3579 Generate a life pattern.
3580
3581 This source is based on a generalization of John Conway's life game.
3582
3583 The sourced input represents a life grid, each pixel represents a cell
3584 which can be in one of two possible states, alive or dead. Every cell
3585 interacts with its eight neighbours, which are the cells that are
3586 horizontally, vertically, or diagonally adjacent.
3587
3588 At each interaction the grid evolves according to the adopted rule,
3589 which specifies the number of neighbor alive cells which will make a
3590 cell stay alive or born. The @option{rule} option allows to specify
3591 the rule to adopt.
3592
3593 This source accepts a list of options in the form of
3594 @var{key}=@var{value} pairs separated by ":". A description of the
3595 accepted options follows.
3596
3597 @table @option
3598 @item filename, f
3599 Set the file from which to read the initial grid state. In the file,
3600 each non-whitespace character is considered an alive cell, and newline
3601 is used to delimit the end of each row.
3602
3603 If this option is not specified, the initial grid is generated
3604 randomly.
3605
3606 @item rate, r
3607 Set the video rate, that is the number of frames generated per second.
3608 Default is 25.
3609
3610 @item random_fill_ratio, ratio
3611 Set the random fill ratio for the initial random grid. It is a
3612 floating point number value ranging from 0 to 1, defaults to 1/PHI.
3613 It is ignored when a file is specified.
3614
3615 @item random_seed, seed
3616 Set the seed for filling the initial random grid, must be an integer
3617 included between 0 and UINT32_MAX. If not specified, or if explicitly
3618 set to -1, the filter will try to use a good random seed on a best
3619 effort basis.
3620
3621 @item rule
3622 Set the life rule.
3623
3624 A rule can be specified with a code of the kind "S@var{NS}/B@var{NB}",
3625 where @var{NS} and @var{NB} are sequences of numbers in the range 0-8,
3626 @var{NS} specifies the number of alive neighbor cells which make a
3627 live cell stay alive, and @var{NB} the number of alive neighbor cells
3628 which make a dead cell to become alive (i.e. to "born").
3629 "s" and "b" can be used in place of "S" and "B", respectively.
3630
3631 Alternatively a rule can be specified by an 18-bits integer. The 9
3632 high order bits are used to encode the next cell state if it is alive
3633 for each number of neighbor alive cells, the low order bits specify
3634 the rule for "borning" new cells. Higher order bits encode for an
3635 higher number of neighbor cells.
3636 For example the number 6153 = @code{(12<<9)+9} specifies a stay alive
3637 rule of 12 and a born rule of 9, which corresponds to "S23/B03".
3638
3639 Default value is "S23/B3", which is the original Conway's game of life
3640 rule, and will keep a cell alive if it has 2 or 3 neighbor alive
3641 cells, and will born a new cell if there are three alive cells around
3642 a dead cell.
3643
3644 @item size, s
3645 Set the size of the output video.
3646
3647 If @option{filename} is specified, the size is set by default to the
3648 same size of the input file. If @option{size} is set, it must contain
3649 the size specified in the input file, and the initial grid defined in
3650 that file is centered in the larger resulting area.
3651
3652 If a filename is not specified, the size value defaults to "320x240"
3653 (used for a randomly generated initial grid).
3654
3655 @item stitch
3656 If set to 1, stitch the left and right grid edges together, and the
3657 top and bottom edges also. Defaults to 1.
3658
3659 @item mold
3660 Set cell mold speed. If set, a dead cell will go from @option{death_color} to
3661 @option{mold_color} with a step of @option{mold}. @option{mold} can have a
3662 value from 0 to 255.
3663
3664 @item life_color
3665 Set the color of living (or new born) cells.
3666
3667 @item death_color
3668 Set the color of dead cells. If @option{mold} is set, this is the first color
3669 used to represent a dead cell.
3670
3671 @item mold_color
3672 Set mold color, for definitely dead and moldy cells.
3673 @end table
3674
3675 @subsection Examples
3676
3677 @itemize
3678 @item
3679 Read a grid from @file{pattern}, and center it on a grid of size
3680 300x300 pixels:
3681 @example
3682 life=f=pattern:s=300x300
3683 @end example
3684
3685 @item
3686 Generate a random grid of size 200x200, with a fill ratio of 2/3:
3687 @example
3688 life=ratio=2/3:s=200x200
3689 @end example
3690
3691 @item
3692 Specify a custom rule for evolving a randomly generated grid:
3693 @example
3694 life=rule=S14/B34
3695 @end example
3696
3697 @item
3698 Full example with slow death effect (mold) using @command{ffplay}:
3699 @example
3700 ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
3701 @end example
3702 @end itemize
3703
3704 @section nullsrc, rgbtestsrc, testsrc
3705
3706 The @code{nullsrc} source returns unprocessed video frames. It is
3707 mainly useful to be employed in analysis / debugging tools, or as the
3708 source for filters which ignore the input data.
3709
3710 The @code{rgbtestsrc} source generates an RGB test pattern useful for
3711 detecting RGB vs BGR issues. You should see a red, green and blue
3712 stripe from top to bottom.
3713
3714 The @code{testsrc} source generates a test video pattern, showing a
3715 color pattern, a scrolling gradient and a timestamp. This is mainly
3716 intended for testing purposes.
3717
3718 These sources accept an optional sequence of @var{key}=@var{value} pairs,
3719 separated by ":". The description of the accepted options follows.
3720
3721 @table @option
3722
3723 @item size, s
3724 Specify the size of the sourced video, it may be a string of the form
3725 @var{width}x@var{height}, or the name of a size abbreviation. The
3726 default value is "320x240".
3727
3728 @item rate, r
3729 Specify the frame rate of the sourced video, as the number of frames
3730 generated per second. It has to be a string in the format
3731 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
3732 number or a valid video frame rate abbreviation. The default value is
3733 "25".
3734
3735 @item sar
3736 Set the sample aspect ratio of the sourced video.
3737
3738 @item duration, d
3739 Set the video duration of the sourced video. The accepted syntax is:
3740 @example
3741 [-]HH[:MM[:SS[.m...]]]
3742 [-]S+[.m...]
3743 @end example
3744 See also the function @code{av_parse_time()}.
3745
3746 If not specified, or the expressed duration is negative, the video is
3747 supposed to be generated forever.
3748
3749 @item decimals, n
3750 Set the number of decimals to show in the timestamp, only used in the
3751 @code{testsrc} source.
3752
3753 The displayed timestamp value will correspond to the original
3754 timestamp value multiplied by the power of 10 of the specified
3755 value. Default value is 0.
3756 @end table
3757
3758 For example the following:
3759 @example
3760 testsrc=duration=5.3:size=qcif:rate=10
3761 @end example
3762
3763 will generate a video with a duration of 5.3 seconds, with size
3764 176x144 and a frame rate of 10 frames per second.
3765
3766 If the input content is to be ignored, @code{nullsrc} can be used. The
3767 following command generates noise in the luminance plane by employing
3768 the @code{mp=geq} filter:
3769 @example
3770 nullsrc=s=256x256, mp=geq=random(1)*255:128:128
3771 @end example
3772
3773 @c man end VIDEO SOURCES
3774
3775 @chapter Video Sinks
3776 @c man begin VIDEO SINKS
3777
3778 Below is a description of the currently available video sinks.
3779
3780 @section buffersink
3781
3782 Buffer video frames, and make them available to the end of the filter
3783 graph.
3784
3785 This sink is mainly intended for a programmatic use, in particular
3786 through the interface defined in @file{libavfilter/buffersink.h}.
3787
3788 It does not require a string parameter in input, but you need to
3789 specify a pointer to a list of supported pixel formats terminated by
3790 -1 in the opaque parameter provided to @code{avfilter_init_filter}
3791 when initializing this sink.
3792
3793 @section nullsink
3794
3795 Null video sink, do absolutely nothing with the input video. It is
3796 mainly useful as a template and to be employed in analysis / debugging
3797 tools.
3798
3799 @c man end VIDEO SINKS