1 @chapter Filtering Introduction
2 @c man begin FILTERING INTRODUCTION
4 Filtering in FFmpeg is enabled through the libavfilter library.
6 Libavfilter is the filtering API of FFmpeg. It is the substitute of
7 the now deprecated 'vhooks' and started as a Google Summer of Code
10 Audio filtering integration into the main FFmpeg repository is a work in
11 progress, so audio API and ABI should not be considered stable yet.
13 In libavfilter, it is possible for filters to have multiple inputs and
15 To illustrate the sorts of things that are possible, we can
16 use a complex filter graph. For example, the following one:
19 input --> split --> fifo -----------------------> overlay --> output
22 +------> fifo --> crop --> vflip --------+
25 splits the stream in two streams, sends one stream through the crop filter
26 and the vflip filter before merging it back with the other stream by
27 overlaying it on top. You can use the following command to achieve this:
30 ffmpeg -i input -vf "[in] split [T1], fifo, [T2] overlay=0:H/2 [out]; [T1] fifo, crop=iw:ih/2:0:ih/2, vflip [T2]" output
33 The result will be that in output the top half of the video is mirrored
36 Filters are loaded using the @var{-vf} or @var{-af} option passed to
37 @command{ffmpeg} or to @command{ffplay}. Filters in the same linear
38 chain are separated by commas. In our example, @var{split, fifo,
39 overlay} are in one linear chain, and @var{fifo, crop, vflip} are in
40 another. The points where the linear chains join are labeled by names
41 enclosed in square brackets. In our example, that is @var{[T1]} and
42 @var{[T2]}. The special labels @var{[in]} and @var{[out]} are the points
43 where video is input and output.
45 Some filters take in input a list of parameters: they are specified
46 after the filter name and an equal sign, and are separated from each other
49 There exist so-called @var{source filters} that do not have an
50 audio/video input, and @var{sink filters} that will not have audio/video
53 @c man end FILTERING INTRODUCTION
56 @c man begin GRAPH2DOT
58 The @file{graph2dot} program included in the FFmpeg @file{tools}
59 directory can be used to parse a filter graph description and issue a
60 corresponding textual representation in the dot language.
67 to see how to use @file{graph2dot}.
69 You can then pass the dot description to the @file{dot} program (from
70 the graphviz suite of programs) and obtain a graphical representation
73 For example the sequence of commands:
75 echo @var{GRAPH_DESCRIPTION} | \
76 tools/graph2dot -o graph.tmp && \
77 dot -Tpng graph.tmp -o graph.png && \
81 can be used to create and display an image representing the graph
82 described by the @var{GRAPH_DESCRIPTION} string. Note that this string must be
83 a complete self-contained graph, with its inputs and outputs explicitly defined.
84 For example if your command line is of the form:
86 ffmpeg -i infile -vf scale=640:360 outfile
88 your @var{GRAPH_DESCRIPTION} string will need to be of the form:
90 nullsrc,scale=640:360,nullsink
92 you may also need to set the @var{nullsrc} parameters and add a @var{format}
93 filter in order to simulate a specific input file.
97 @chapter Filtergraph description
98 @c man begin FILTERGRAPH DESCRIPTION
100 A filtergraph is a directed graph of connected filters. It can contain
101 cycles, and there can be multiple links between a pair of
102 filters. Each link has one input pad on one side connecting it to one
103 filter from which it takes its input, and one output pad on the other
104 side connecting it to the one filter accepting its output.
106 Each filter in a filtergraph is an instance of a filter class
107 registered in the application, which defines the features and the
108 number of input and output pads of the filter.
110 A filter with no input pads is called a "source", a filter with no
111 output pads is called a "sink".
113 @anchor{Filtergraph syntax}
114 @section Filtergraph syntax
116 A filtergraph can be represented using a textual representation, which is
117 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
118 options in @command{ffmpeg} and @option{-vf} in @command{ffplay}, and by the
119 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
120 @file{libavfilter/avfiltergraph.h}.
122 A filterchain consists of a sequence of connected filters, each one
123 connected to the previous one in the sequence. A filterchain is
124 represented by a list of ","-separated filter descriptions.
126 A filtergraph consists of a sequence of filterchains. A sequence of
127 filterchains is represented by a list of ";"-separated filterchain
130 A filter is represented by a string of the form:
131 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
133 @var{filter_name} is the name of the filter class of which the
134 described filter is an instance of, and has to be the name of one of
135 the filter classes registered in the program.
136 The name of the filter class is optionally followed by a string
139 @var{arguments} is a string which contains the parameters used to
140 initialize the filter instance, and are described in the filter
143 The list of arguments can be quoted using the character "'" as initial
144 and ending mark, and the character '\' for escaping the characters
145 within the quoted text; otherwise the argument string is considered
146 terminated when the next special character (belonging to the set
147 "[]=;,") is encountered.
149 The name and arguments of the filter are optionally preceded and
150 followed by a list of link labels.
151 A link label allows to name a link and associate it to a filter output
152 or input pad. The preceding labels @var{in_link_1}
153 ... @var{in_link_N}, are associated to the filter input pads,
154 the following labels @var{out_link_1} ... @var{out_link_M}, are
155 associated to the output pads.
157 When two link labels with the same name are found in the
158 filtergraph, a link between the corresponding input and output pad is
161 If an output pad is not labelled, it is linked by default to the first
162 unlabelled input pad of the next filter in the filterchain.
163 For example in the filterchain:
165 nullsrc, split[L1], [L2]overlay, nullsink
167 the split filter instance has two output pads, and the overlay filter
168 instance two input pads. The first output pad of split is labelled
169 "L1", the first input pad of overlay is labelled "L2", and the second
170 output pad of split is linked to the second input pad of overlay,
171 which are both unlabelled.
173 In a complete filterchain all the unlabelled filter input and output
174 pads must be connected. A filtergraph is considered valid if all the
175 filter input and output pads of all the filterchains are connected.
177 Libavfilter will automatically insert scale filters where format
178 conversion is required. It is possible to specify swscale flags
179 for those automatically inserted scalers by prepending
180 @code{sws_flags=@var{flags};}
181 to the filtergraph description.
183 Follows a BNF description for the filtergraph syntax:
185 @var{NAME} ::= sequence of alphanumeric characters and '_'
186 @var{LINKLABEL} ::= "[" @var{NAME} "]"
187 @var{LINKLABELS} ::= @var{LINKLABEL} [@var{LINKLABELS}]
188 @var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
189 @var{FILTER} ::= [@var{LINKNAMES}] @var{NAME} ["=" @var{ARGUMENTS}] [@var{LINKNAMES}]
190 @var{FILTERCHAIN} ::= @var{FILTER} [,@var{FILTERCHAIN}]
191 @var{FILTERGRAPH} ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
194 @c man end FILTERGRAPH DESCRIPTION
196 @chapter Audio Filters
197 @c man begin AUDIO FILTERS
199 When you configure your FFmpeg build, you can disable any of the
200 existing filters using @code{--disable-filters}.
201 The configure output will show the audio filters included in your
204 Below is a description of the currently available audio filters.
208 Convert the input audio format to the specified formats.
210 The filter accepts a string of the form:
211 "@var{sample_format}:@var{channel_layout}".
213 @var{sample_format} specifies the sample format, and can be a string or the
214 corresponding numeric value defined in @file{libavutil/samplefmt.h}. Use 'p'
215 suffix for a planar sample format.
217 @var{channel_layout} specifies the channel layout, and can be a string
218 or the corresponding number value defined in @file{libavutil/audioconvert.h}.
220 The special parameter "auto", signifies that the filter will
221 automatically select the output format depending on the output filter.
223 Some examples follow.
227 Convert input to float, planar, stereo:
233 Convert input to unsigned 8-bit, automatically select out channel layout:
241 Convert the input audio to one of the specified formats. The framework will
242 negotiate the most appropriate format to minimize conversions.
244 The filter accepts the following named parameters:
248 A comma-separated list of requested sample formats.
251 A comma-separated list of requested sample rates.
253 @item channel_layouts
254 A comma-separated list of requested channel layouts.
258 If a parameter is omitted, all values are allowed.
260 For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
262 aformat=sample_fmts\=u8\,s16:channel_layouts\=stereo
267 Merge two or more audio streams into a single multi-channel stream.
269 The filter accepts the following named options:
274 Set the number of inputs. Default is 2.
278 If the channel layouts of the inputs are disjoint, and therefore compatible,
279 the channel layout of the output will be set accordingly and the channels
280 will be reordered as necessary. If the channel layouts of the inputs are not
281 disjoint, the output will have all the channels of the first input then all
282 the channels of the second input, in that order, and the channel layout of
283 the output will be the default value corresponding to the total number of
286 For example, if the first input is in 2.1 (FL+FR+LF) and the second input
287 is FC+BL+BR, then the output will be in 5.1, with the channels in the
288 following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
289 first input, b1 is the first channel of the second input).
291 On the other hand, if both input are in stereo, the output channels will be
292 in the default order: a1, a2, b1, b2, and the channel layout will be
293 arbitrarily set to 4.0, which may or may not be the expected value.
295 All inputs must have the same sample rate, and format.
297 If inputs do not have the same duration, the output will stop with the
300 Example: merge two mono files into a stereo stream:
302 amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
305 Example: multiple merges:
308 amovie=input.mkv:si=0 [a0];
309 amovie=input.mkv:si=1 [a1];
310 amovie=input.mkv:si=2 [a2];
311 amovie=input.mkv:si=3 [a3];
312 amovie=input.mkv:si=4 [a4];
313 amovie=input.mkv:si=5 [a5];
314 [a0][a1][a2][a3][a4][a5] amerge=inputs=6" -c:a pcm_s16le output.mkv
319 Mixes multiple audio inputs into a single output.
323 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
325 will mix 3 input audio streams to a single output with the same duration as the
326 first input and a dropout transition time of 3 seconds.
328 The filter accepts the following named parameters:
332 Number of inputs. If unspecified, it defaults to 2.
335 How to determine the end-of-stream.
339 Duration of longest input. (default)
342 Duration of shortest input.
345 Duration of first input.
349 @item dropout_transition
350 Transition time, in seconds, for volume renormalization when an input
351 stream ends. The default value is 2 seconds.
357 Pass the audio source unchanged to the output.
361 Resample the input audio to the specified sample rate.
363 The filter accepts exactly one parameter, the output sample rate. If not
364 specified then the filter will automatically convert between its input
365 and output sample rates.
367 For example, to resample the input audio to 44100Hz:
372 @section asetnsamples
374 Set the number of samples per each output audio frame.
376 The last output packet may contain a different number of samples, as
377 the filter will flush all the remaining samples when the input audio
380 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
385 @item nb_out_samples, n
386 Set the number of frames per each output audio frame. The number is
387 intended as the number of samples @emph{per each channel}.
388 Default value is 1024.
391 If set to 1, the filter will pad the last audio frame with zeroes, so
392 that the last frame will contain the same number of samples as the
393 previous ones. Default value is 1.
396 For example, to set the number of per-frame samples to 1234 and
397 disable padding for the last frame, use:
399 asetnsamples=n=1234:p=0
404 Show a line containing various information for each input audio frame.
405 The input audio is not modified.
407 The shown line contains a sequence of key/value pairs of the form
408 @var{key}:@var{value}.
410 A description of each shown parameter follows:
414 sequential number of the input frame, starting from 0
417 Presentation timestamp of the input frame, in time base units; the time base
418 depends on the filter input pad, and is usually 1/@var{sample_rate}.
421 presentation timestamp of the input frame in seconds
424 position of the frame in the input stream, -1 if this information in
425 unavailable and/or meaningless (for example in case of synthetic audio)
434 sample rate for the audio frame
437 number of samples (per channel) in the frame
440 Adler-32 checksum (printed in hexadecimal) of the audio data. For planar audio
441 the data is treated as if all the planes were concatenated.
443 @item plane_checksums
444 A list of Adler-32 checksums for each data plane.
449 Split input audio into several identical outputs.
451 The filter accepts a single parameter which specifies the number of outputs. If
452 unspecified, it defaults to 2.
456 [in] asplit [out0][out1]
459 will create two separate outputs from the same input.
461 To create 3 or more outputs, you need to specify the number of
464 [in] asplit=3 [out0][out1][out2]
468 ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
470 will create 5 copies of the input audio.
475 Forward two audio streams and control the order the buffers are forwarded.
477 The argument to the filter is an expression deciding which stream should be
478 forwarded next: if the result is negative, the first stream is forwarded; if
479 the result is positive or zero, the second stream is forwarded. It can use
480 the following variables:
484 number of buffers forwarded so far on each stream
486 number of samples forwarded so far on each stream
488 current timestamp of each stream
491 The default value is @code{t1-t2}, which means to always forward the stream
492 that has a smaller timestamp.
494 Example: stress-test @code{amerge} by randomly sending buffers on the wrong
495 input, while avoiding too much of a desynchronization:
497 amovie=file.ogg [a] ; amovie=file.mp3 [b] ;
498 [a] [b] astreamsync=(2*random(1))-1+tanh(5*(t1-t2)) [a2] [b2] ;
506 The filter accepts exactly one parameter, the audio tempo. If not
507 specified then the filter will assume nominal 1.0 tempo. Tempo must
508 be in the [0.5, 2.0] range.
510 For example, to slow down audio to 80% tempo:
515 For example, to speed up audio to 125% tempo:
522 Make audio easier to listen to on headphones.
524 This filter adds `cues' to 44.1kHz stereo (i.e. audio CD format) audio
525 so that when listened to on headphones the stereo image is moved from
526 inside your head (standard for headphones) to outside and in front of
527 the listener (standard for speakers).
533 Mix channels with specific gain levels. The filter accepts the output
534 channel layout followed by a set of channels definitions.
536 This filter is also designed to remap efficiently the channels of an audio
539 The filter accepts parameters of the form:
540 "@var{l}:@var{outdef}:@var{outdef}:..."
544 output channel layout or number of channels
547 output channel specification, of the form:
548 "@var{out_name}=[@var{gain}*]@var{in_name}[+[@var{gain}*]@var{in_name}...]"
551 output channel to define, either a channel name (FL, FR, etc.) or a channel
552 number (c0, c1, etc.)
555 multiplicative coefficient for the channel, 1 leaving the volume unchanged
558 input channel to use, see out_name for details; it is not possible to mix
559 named and numbered input channels
562 If the `=' in a channel specification is replaced by `<', then the gains for
563 that specification will be renormalized so that the total is 1, thus
564 avoiding clipping noise.
566 @subsection Mixing examples
568 For example, if you want to down-mix from stereo to mono, but with a bigger
569 factor for the left channel:
571 pan=1:c0=0.9*c0+0.1*c1
574 A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
577 pan=stereo: FL < FL + 0.5*FC + 0.6*BL + 0.6*SL : FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
580 Note that @command{ffmpeg} integrates a default down-mix (and up-mix) system
581 that should be preferred (see "-ac" option) unless you have very specific
584 @subsection Remapping examples
586 The channel remapping will be effective if, and only if:
589 @item gain coefficients are zeroes or ones,
590 @item only one input per channel output,
593 If all these conditions are satisfied, the filter will notify the user ("Pure
594 channel mapping detected"), and use an optimized and lossless method to do the
597 For example, if you have a 5.1 source and want a stereo audio stream by
598 dropping the extra channels:
600 pan="stereo: c0=FL : c1=FR"
603 Given the same source, you can also switch front left and front right channels
604 and keep the input channel layout:
606 pan="5.1: c0=c1 : c1=c0 : c2=c2 : c3=c3 : c4=c4 : c5=c5"
609 If the input is a stereo audio stream, you can mute the front left channel (and
610 still keep the stereo channel layout) with:
615 Still with a stereo audio stream input, you can copy the right channel in both
616 front left and right:
618 pan="stereo: c0=FR : c1=FR"
621 @section silencedetect
623 Detect silence in an audio stream.
625 This filter logs a message when it detects that the input audio volume is less
626 or equal to a noise tolerance value for a duration greater or equal to the
627 minimum detected noise duration.
629 The printed times and duration are expressed in seconds.
633 Set silence duration until notification (default is 2 seconds).
636 Set noise tolerance. Can be specified in dB (in case "dB" is appended to the
637 specified value) or amplitude ratio. Default is -60dB, or 0.001.
640 Detect 5 seconds of silence with -50dB noise tolerance:
642 silencedetect=n=-50dB:d=5
645 Complete example with @command{ffmpeg} to detect silence with 0.0001 noise
646 tolerance in @file{silence.mp3}:
648 ffmpeg -f lavfi -i amovie=silence.mp3,silencedetect=noise=0.0001 -f null -
653 Adjust the input audio volume.
655 The filter accepts exactly one parameter @var{vol}, which expresses
656 how the audio volume will be increased or decreased.
658 Output values are clipped to the maximum value.
660 If @var{vol} is expressed as a decimal number, the output audio
661 volume is given by the relation:
663 @var{output_volume} = @var{vol} * @var{input_volume}
666 If @var{vol} is expressed as a decimal number followed by the string
667 "dB", the value represents the requested change in decibels of the
668 input audio power, and the output audio volume is given by the
671 @var{output_volume} = 10^(@var{vol}/20) * @var{input_volume}
674 Otherwise @var{vol} is considered an expression and its evaluated
675 value is used for computing the output audio volume according to the
678 Default value for @var{vol} is 1.0.
684 Half the input audio volume:
689 The above example is equivalent to:
695 Decrease input audio power by 12 decibels:
701 @section volumedetect
703 Detect the volume of the input video.
705 The filter has no parameters. The input is not modified. Statistics about
706 the volume will be printed in the log when the input stream end is reached.
708 In particular it will show the mean volume (root mean square), maximum
709 volume (on a per-sample basis), and the beginning of an histogram of the
710 registered volume values (from the maximum value to a cumulated 1/1000 of
713 All volumes are in decibels relative to the maximum PCM value.
715 Here is an excerpt of the output:
717 [Parsed_volumedetect_0 @ 0xa23120] mean_volume: -27 dB
718 [Parsed_volumedetect_0 @ 0xa23120] max_volume: -4 dB
719 [Parsed_volumedetect_0 @ 0xa23120] histogram_4db: 6
720 [Parsed_volumedetect_0 @ 0xa23120] histogram_5db: 62
721 [Parsed_volumedetect_0 @ 0xa23120] histogram_6db: 286
722 [Parsed_volumedetect_0 @ 0xa23120] histogram_7db: 1042
723 [Parsed_volumedetect_0 @ 0xa23120] histogram_8db: 2551
724 [Parsed_volumedetect_0 @ 0xa23120] histogram_9db: 4609
725 [Parsed_volumedetect_0 @ 0xa23120] histogram_10db: 8409
731 The mean square energy is approximately -27 dB, or 10^-2.7.
733 The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
735 There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
738 In other words, raising the volume by +4 dB does not cause any clipping,
739 raising it by +5 dB causes clipping for 6 samples, etc.
742 Synchronize audio data with timestamps by squeezing/stretching it and/or
743 dropping samples/adding silence when needed.
745 The filter accepts the following named parameters:
749 Enable stretching/squeezing the data to make it match the timestamps. Disabled
750 by default. When disabled, time gaps are covered with silence.
753 Minimum difference between timestamps and audio data (in seconds) to trigger
754 adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
755 this filter, try setting this parameter to 0.
758 Maximum compensation in samples per second. Relevant only with compensate=1.
762 Assume the first pts should be this value.
763 This allows for padding/trimming at the start of stream. By default, no
764 assumption is made about the first frame's expected pts, so no padding or
765 trimming is done. For example, this could be set to 0 to pad the beginning with
766 silence if an audio stream starts after the video stream.
770 @section channelsplit
771 Split each channel in input audio stream into a separate output stream.
773 This filter accepts the following named parameters:
776 Channel layout of the input stream. Default is "stereo".
779 For example, assuming a stereo input MP3 file
781 ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
783 will create an output Matroska file with two audio streams, one containing only
784 the left channel and the other the right channel.
786 To split a 5.1 WAV file into per-channel files
788 ffmpeg -i in.wav -filter_complex
789 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
790 -map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
791 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
796 Remap input channels to new locations.
798 This filter accepts the following named parameters:
801 Channel layout of the output stream.
804 Map channels from input to output. The argument is a comma-separated list of
805 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
806 @var{in_channel} form. @var{in_channel} can be either the name of the input
807 channel (e.g. FL for front left) or its index in the input channel layout.
808 @var{out_channel} is the name of the output channel or its index in the output
809 channel layout. If @var{out_channel} is not given then it is implicitly an
810 index, starting with zero and increasing by one for each mapping.
813 If no mapping is present, the filter will implicitly map input channels to
814 output channels preserving index.
816 For example, assuming a 5.1+downmix input MOV file
818 ffmpeg -i in.mov -filter 'channelmap=map=DL-FL\,DR-FR' out.wav
820 will create an output WAV file tagged as stereo from the downmix channels of
823 To fix a 5.1 WAV improperly encoded in AAC's native channel order
825 ffmpeg -i in.wav -filter 'channelmap=1\,2\,0\,5\,3\,4:channel_layout=5.1' out.wav
829 Join multiple input streams into one multi-channel stream.
831 The filter accepts the following named parameters:
835 Number of input streams. Defaults to 2.
838 Desired output channel layout. Defaults to stereo.
841 Map channels from inputs to output. The argument is a comma-separated list of
842 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
843 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
844 can be either the name of the input channel (e.g. FL for front left) or its
845 index in the specified input stream. @var{out_channel} is the name of the output
849 The filter will attempt to guess the mappings when those are not specified
850 explicitly. It does so by first trying to find an unused matching input channel
851 and if that fails it picks the first unused input channel.
853 E.g. to join 3 inputs (with properly set channel layouts)
855 ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
858 To build a 5.1 output from 6 single-channel streams:
860 ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
861 'join=inputs=6:channel_layout=5.1:map=0.0-FL\,1.0-FR\,2.0-FC\,3.0-SL\,4.0-SR\,5.0-LFE'
866 Convert the audio sample format, sample rate and channel layout. This filter is
867 not meant to be used directly.
869 @c man end AUDIO FILTERS
871 @chapter Audio Sources
872 @c man begin AUDIO SOURCES
874 Below is a description of the currently available audio sources.
878 Buffer audio frames, and make them available to the filter chain.
880 This source is mainly intended for a programmatic use, in particular
881 through the interface defined in @file{libavfilter/asrc_abuffer.h}.
883 It accepts the following mandatory parameters:
884 @var{sample_rate}:@var{sample_fmt}:@var{channel_layout}
889 The sample rate of the incoming audio buffers.
892 The sample format of the incoming audio buffers.
893 Either a sample format name or its corresponging integer representation from
894 the enum AVSampleFormat in @file{libavutil/samplefmt.h}
897 The channel layout of the incoming audio buffers.
898 Either a channel layout name from channel_layout_map in
899 @file{libavutil/audioconvert.c} or its corresponding integer representation
900 from the AV_CH_LAYOUT_* macros in @file{libavutil/audioconvert.h}
906 abuffer=44100:s16p:stereo
909 will instruct the source to accept planar 16bit signed stereo at 44100Hz.
910 Since the sample format with name "s16p" corresponds to the number
911 6 and the "stereo" channel layout corresponds to the value 0x3, this is
919 Generate an audio signal specified by an expression.
921 This source accepts in input one or more expressions (one for each
922 channel), which are evaluated and used to generate a corresponding
925 It accepts the syntax: @var{exprs}[::@var{options}].
926 @var{exprs} is a list of expressions separated by ":", one for each
927 separate channel. In case the @var{channel_layout} is not
928 specified, the selected channel layout depends on the number of
929 provided expressions.
931 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
934 The description of the accepted options follows.
938 @item channel_layout, c
939 Set the channel layout. The number of channels in the specified layout
940 must be equal to the number of specified expressions.
943 Set the minimum duration of the sourced audio. See the function
944 @code{av_parse_time()} for the accepted format.
945 Note that the resulting duration may be greater than the specified
946 duration, as the generated audio is always cut at the end of a
949 If not specified, or the expressed duration is negative, the audio is
950 supposed to be generated forever.
953 Set the number of samples per channel per each output frame,
957 Specify the sample rate, default to 44100.
960 Each expression in @var{exprs} can contain the following constants:
964 number of the evaluated sample, starting from 0
967 time of the evaluated sample expressed in seconds, starting from 0
986 Generate a sin signal with frequency of 440 Hz, set sample rate to
989 aevalsrc="sin(440*2*PI*t)::s=8000"
993 Generate a two channels signal, specify the channel layout (Front
994 Center + Back Center) explicitly:
996 aevalsrc="sin(420*2*PI*t):cos(430*2*PI*t)::c=FC|BC"
1000 Generate white noise:
1002 aevalsrc="-2+random(0)"
1006 Generate an amplitude modulated signal:
1008 aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
1012 Generate 2.5 Hz binaural beats on a 360 Hz carrier:
1014 aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) : 0.1*sin(2*PI*(360+2.5/2)*t)"
1021 Null audio source, return unprocessed audio frames. It is mainly useful
1022 as a template and to be employed in analysis / debugging tools, or as
1023 the source for filters which ignore the input data (for example the sox
1026 It accepts an optional sequence of @var{key}=@var{value} pairs,
1029 The description of the accepted options follows.
1033 @item sample_rate, s
1034 Specify the sample rate, and defaults to 44100.
1036 @item channel_layout, cl
1038 Specify the channel layout, and can be either an integer or a string
1039 representing a channel layout. The default value of @var{channel_layout}
1042 Check the channel_layout_map definition in
1043 @file{libavcodec/audioconvert.c} for the mapping between strings and
1044 channel layout values.
1047 Set the number of samples per requested frames.
1051 Follow some examples:
1053 # set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
1054 anullsrc=r=48000:cl=4
1057 anullsrc=r=48000:cl=mono
1061 Buffer audio frames, and make them available to the filter chain.
1063 This source is not intended to be part of user-supplied graph descriptions but
1064 for insertion by calling programs through the interface defined in
1065 @file{libavfilter/buffersrc.h}.
1067 It accepts the following named parameters:
1071 Timebase which will be used for timestamps of submitted frames. It must be
1072 either a floating-point number or in @var{numerator}/@var{denominator} form.
1078 Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
1080 @item channel_layout
1081 Channel layout of the audio data, in the form that can be accepted by
1082 @code{av_get_channel_layout()}.
1085 All the parameters need to be explicitly defined.
1089 Synthesize a voice utterance using the libflite library.
1091 To enable compilation of this filter you need to configure FFmpeg with
1092 @code{--enable-libflite}.
1094 Note that the flite library is not thread-safe.
1096 The source accepts parameters as a list of @var{key}=@var{value} pairs,
1099 The description of the accepted parameters follows.
1104 If set to 1, list the names of the available voices and exit
1105 immediately. Default value is 0.
1108 Set the maximum number of samples per frame. Default value is 512.
1111 Set the filename containing the text to speak.
1114 Set the text to speak.
1117 Set the voice to use for the speech synthesis. Default value is
1118 @code{kal}. See also the @var{list_voices} option.
1121 @subsection Examples
1125 Read from file @file{speech.txt}, and synthetize the text using the
1126 standard flite voice:
1128 flite=textfile=speech.txt
1132 Read the specified text selecting the @code{slt} voice:
1134 flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1138 Input text to ffmpeg:
1140 ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
1144 Make @file{ffplay} speak the specified text, using @code{flite} and
1145 the @code{lavfi} device:
1147 ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
1151 For more information about libflite, check:
1152 @url{http://www.speech.cs.cmu.edu/flite/}
1154 @c man end AUDIO SOURCES
1156 @chapter Audio Sinks
1157 @c man begin AUDIO SINKS
1159 Below is a description of the currently available audio sinks.
1161 @section abuffersink
1163 Buffer audio frames, and make them available to the end of filter chain.
1165 This sink is mainly intended for programmatic use, in particular
1166 through the interface defined in @file{libavfilter/buffersink.h}.
1168 It requires a pointer to an AVABufferSinkContext structure, which
1169 defines the incoming buffers' formats, to be passed as the opaque
1170 parameter to @code{avfilter_init_filter} for initialization.
1174 Null audio sink, do absolutely nothing with the input audio. It is
1175 mainly useful as a template and to be employed in analysis / debugging
1178 @section abuffersink
1179 This sink is intended for programmatic use. Frames that arrive on this sink can
1180 be retrieved by the calling program using the interface defined in
1181 @file{libavfilter/buffersink.h}.
1183 This filter accepts no parameters.
1185 @c man end AUDIO SINKS
1187 @chapter Video Filters
1188 @c man begin VIDEO FILTERS
1190 When you configure your FFmpeg build, you can disable any of the
1191 existing filters using @code{--disable-filters}.
1192 The configure output will show the video filters included in your
1195 Below is a description of the currently available video filters.
1197 @section alphaextract
1199 Extract the alpha component from the input as a grayscale video. This
1200 is especially useful with the @var{alphamerge} filter.
1204 Add or replace the alpha component of the primary input with the
1205 grayscale value of a second input. This is intended for use with
1206 @var{alphaextract} to allow the transmission or storage of frame
1207 sequences that have alpha in a format that doesn't support an alpha
1210 For example, to reconstruct full frames from a normal YUV-encoded video
1211 and a separate video created with @var{alphaextract}, you might use:
1213 movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
1216 Since this filter is designed for reconstruction, it operates on frame
1217 sequences without considering timestamps, and terminates when either
1218 input reaches end of stream. This will cause problems if your encoding
1219 pipeline drops frames. If you're trying to apply an image as an
1220 overlay to a video stream, consider the @var{overlay} filter instead.
1224 Draw ASS (Advanced Substation Alpha) subtitles on top of input video
1225 using the libass library.
1227 To enable compilation of this filter you need to configure FFmpeg with
1228 @code{--enable-libass}.
1230 This filter accepts the following named options, expressed as a
1231 sequence of @var{key}=@var{value} pairs, separated by ":".
1235 Set the filename of the ASS file to read. It must be specified.
1238 Specify the size of the original video, the video for which the ASS file
1239 was composed. Due to a misdesign in ASS aspect ratio arithmetic, this is
1240 necessary to correctly scale the fonts if the aspect ratio has been changed.
1243 If the first key is not specified, it is assumed that the first value
1244 specifies the @option{filename}.
1246 For example, to render the file @file{sub.ass} on top of the input
1247 video, use the command:
1252 which is equivalent to:
1254 ass=filename=sub.ass
1259 Compute the bounding box for the non-black pixels in the input frame
1262 This filter computes the bounding box containing all the pixels with a
1263 luminance value greater than the minimum allowed value.
1264 The parameters describing the bounding box are printed on the filter
1267 @section blackdetect
1269 Detect video intervals that are (almost) completely black. Can be
1270 useful to detect chapter transitions, commercials, or invalid
1271 recordings. Output lines contains the time for the start, end and
1272 duration of the detected black interval expressed in seconds.
1274 In order to display the output lines, you need to set the loglevel at
1275 least to the AV_LOG_INFO value.
1277 This filter accepts a list of options in the form of
1278 @var{key}=@var{value} pairs separated by ":". A description of the
1279 accepted options follows.
1282 @item black_min_duration, d
1283 Set the minimum detected black duration expressed in seconds. It must
1284 be a non-negative floating point number.
1286 Default value is 2.0.
1288 @item picture_black_ratio_th, pic_th
1289 Set the threshold for considering a picture "black".
1290 Express the minimum value for the ratio:
1292 @var{nb_black_pixels} / @var{nb_pixels}
1295 for which a picture is considered black.
1296 Default value is 0.98.
1298 @item pixel_black_th, pix_th
1299 Set the threshold for considering a pixel "black".
1301 The threshold expresses the maximum pixel luminance value for which a
1302 pixel is considered "black". The provided value is scaled according to
1303 the following equation:
1305 @var{absolute_threshold} = @var{luminance_minimum_value} + @var{pixel_black_th} * @var{luminance_range_size}
1308 @var{luminance_range_size} and @var{luminance_minimum_value} depend on
1309 the input video format, the range is [0-255] for YUV full-range
1310 formats and [16-235] for YUV non full-range formats.
1312 Default value is 0.10.
1315 The following example sets the maximum pixel threshold to the minimum
1316 value, and detects only black intervals of 2 or more seconds:
1318 blackdetect=d=2:pix_th=0.00
1323 Detect frames that are (almost) completely black. Can be useful to
1324 detect chapter transitions or commercials. Output lines consist of
1325 the frame number of the detected frame, the percentage of blackness,
1326 the position in the file if known or -1 and the timestamp in seconds.
1328 In order to display the output lines, you need to set the loglevel at
1329 least to the AV_LOG_INFO value.
1331 The filter accepts the syntax:
1333 blackframe[=@var{amount}:[@var{threshold}]]
1336 @var{amount} is the percentage of the pixels that have to be below the
1337 threshold, and defaults to 98.
1339 @var{threshold} is the threshold below which a pixel value is
1340 considered black, and defaults to 32.
1344 Apply boxblur algorithm to the input video.
1346 This filter accepts the parameters:
1347 @var{luma_radius}:@var{luma_power}:@var{chroma_radius}:@var{chroma_power}:@var{alpha_radius}:@var{alpha_power}
1349 Chroma and alpha parameters are optional, if not specified they default
1350 to the corresponding values set for @var{luma_radius} and
1353 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
1354 the radius in pixels of the box used for blurring the corresponding
1355 input plane. They are expressions, and can contain the following
1359 the input width and height in pixels
1362 the input chroma image width and height in pixels
1365 horizontal and vertical chroma subsample values. For example for the
1366 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1369 The radius must be a non-negative number, and must not be greater than
1370 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
1371 and of @code{min(cw,ch)/2} for the chroma planes.
1373 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
1374 how many times the boxblur filter is applied to the corresponding
1377 Some examples follow:
1382 Apply a boxblur filter with luma, chroma, and alpha radius
1389 Set luma radius to 2, alpha and chroma radius to 0
1395 Set luma and chroma radius to a fraction of the video dimension
1397 boxblur=min(h\,w)/10:1:min(cw\,ch)/10:1
1402 @section colormatrix
1404 The colormatrix filter allows conversion between any of the following color
1405 space: BT.709 (@var{bt709}), BT.601 (@var{bt601}), SMPTE-240M (@var{smpte240m})
1406 and FCC (@var{fcc}).
1408 The syntax of the parameters is @var{source}:@var{destination}:
1411 colormatrix=bt601:smpte240m
1416 Copy the input source unchanged to the output. Mainly useful for
1421 Crop the input video to @var{out_w}:@var{out_h}:@var{x}:@var{y}:@var{keep_aspect}
1423 The @var{keep_aspect} parameter is optional, if specified and set to a
1424 non-zero value will force the output display aspect ratio to be the
1425 same of the input, by changing the output sample aspect ratio.
1427 The @var{out_w}, @var{out_h}, @var{x}, @var{y} parameters are
1428 expressions containing the following constants:
1432 the computed values for @var{x} and @var{y}. They are evaluated for
1436 the input width and height
1439 same as @var{in_w} and @var{in_h}
1442 the output (cropped) width and height
1445 same as @var{out_w} and @var{out_h}
1448 same as @var{iw} / @var{ih}
1451 input sample aspect ratio
1454 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1457 horizontal and vertical chroma subsample values. For example for the
1458 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1461 the number of input frame, starting from 0
1464 the position in the file of the input frame, NAN if unknown
1467 timestamp expressed in seconds, NAN if the input timestamp is unknown
1471 The @var{out_w} and @var{out_h} parameters specify the expressions for
1472 the width and height of the output (cropped) video. They are
1473 evaluated just at the configuration of the filter.
1475 The default value of @var{out_w} is "in_w", and the default value of
1476 @var{out_h} is "in_h".
1478 The expression for @var{out_w} may depend on the value of @var{out_h},
1479 and the expression for @var{out_h} may depend on @var{out_w}, but they
1480 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
1481 evaluated after @var{out_w} and @var{out_h}.
1483 The @var{x} and @var{y} parameters specify the expressions for the
1484 position of the top-left corner of the output (non-cropped) area. They
1485 are evaluated for each frame. If the evaluated value is not valid, it
1486 is approximated to the nearest valid value.
1488 The default value of @var{x} is "(in_w-out_w)/2", and the default
1489 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
1490 the center of the input image.
1492 The expression for @var{x} may depend on @var{y}, and the expression
1493 for @var{y} may depend on @var{x}.
1495 Follow some examples:
1497 # crop the central input area with size 100x100
1500 # crop the central input area with size 2/3 of the input video
1501 "crop=2/3*in_w:2/3*in_h"
1503 # crop the input video central square
1506 # delimit the rectangle with the top-left corner placed at position
1507 # 100:100 and the right-bottom corner corresponding to the right-bottom
1508 # corner of the input image.
1509 crop=in_w-100:in_h-100:100:100
1511 # crop 10 pixels from the left and right borders, and 20 pixels from
1512 # the top and bottom borders
1513 "crop=in_w-2*10:in_h-2*20"
1515 # keep only the bottom right quarter of the input image
1516 "crop=in_w/2:in_h/2:in_w/2:in_h/2"
1518 # crop height for getting Greek harmony
1519 "crop=in_w:1/PHI*in_w"
1522 "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)"
1524 # erratic camera effect depending on timestamp
1525 "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)"
1527 # set x depending on the value of y
1528 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
1533 Auto-detect crop size.
1535 Calculate necessary cropping parameters and prints the recommended
1536 parameters through the logging system. The detected dimensions
1537 correspond to the non-black area of the input video.
1539 It accepts the syntax:
1541 cropdetect[=@var{limit}[:@var{round}[:@var{reset}]]]
1547 Threshold, which can be optionally specified from nothing (0) to
1548 everything (255), defaults to 24.
1551 Value which the width/height should be divisible by, defaults to
1552 16. The offset is automatically adjusted to center the video. Use 2 to
1553 get only even dimensions (needed for 4:2:2 video). 16 is best when
1554 encoding to most video codecs.
1557 Counter that determines after how many frames cropdetect will reset
1558 the previously detected largest video area and start over to detect
1559 the current optimal crop area. Defaults to 0.
1561 This can be useful when channel logos distort the video area. 0
1562 indicates never reset and return the largest area encountered during
1568 This filter drops frames that do not differ greatly from the previous
1569 frame in order to reduce framerate. The main use of this filter is
1570 for very-low-bitrate encoding (e.g. streaming over dialup modem), but
1571 it could in theory be used for fixing movies that were
1572 inverse-telecined incorrectly.
1574 It accepts the following parameters:
1575 @var{max}:@var{hi}:@var{lo}:@var{frac}.
1580 Set the maximum number of consecutive frames which can be dropped (if
1581 positive), or the minimum interval between dropped frames (if
1582 negative). If the value is 0, the frame is dropped unregarding the
1583 number of previous sequentially dropped frames.
1588 Set the dropping threshold values.
1590 Values for @var{hi} and @var{lo} are for 8x8 pixel blocks and
1591 represent actual pixel value differences, so a threshold of 64
1592 corresponds to 1 unit of difference for each pixel, or the same spread
1593 out differently over the block.
1595 A frame is a candidate for dropping if no 8x8 blocks differ by more
1596 than a threshold of @var{hi}, and if no more than @var{frac} blocks (1
1597 meaning the whole image) differ by more than a threshold of @var{lo}.
1599 Default value for @var{hi} is 64*12, default value for @var{lo} is
1600 64*5, and default value for @var{frac} is 0.33.
1605 Suppress a TV station logo by a simple interpolation of the surrounding
1606 pixels. Just set a rectangle covering the logo and watch it disappear
1607 (and sometimes something even uglier appear - your mileage may vary).
1609 The filter accepts parameters as a string of the form
1610 "@var{x}:@var{y}:@var{w}:@var{h}:@var{band}", or as a list of
1611 @var{key}=@var{value} pairs, separated by ":".
1613 The description of the accepted parameters follows.
1618 Specify the top left corner coordinates of the logo. They must be
1622 Specify the width and height of the logo to clear. They must be
1626 Specify the thickness of the fuzzy edge of the rectangle (added to
1627 @var{w} and @var{h}). The default value is 4.
1630 When set to 1, a green rectangle is drawn on the screen to simplify
1631 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
1632 @var{band} is set to 4. The default value is 0.
1636 Some examples follow.
1641 Set a rectangle covering the area with top left corner coordinates 0,0
1642 and size 100x77, setting a band of size 10:
1644 delogo=0:0:100:77:10
1648 As the previous example, but use named options:
1650 delogo=x=0:y=0:w=100:h=77:band=10
1657 Attempt to fix small changes in horizontal and/or vertical shift. This
1658 filter helps remove camera shake from hand-holding a camera, bumping a
1659 tripod, moving on a vehicle, etc.
1661 The filter accepts parameters as a string of the form
1662 "@var{x}:@var{y}:@var{w}:@var{h}:@var{rx}:@var{ry}:@var{edge}:@var{blocksize}:@var{contrast}:@var{search}:@var{filename}"
1664 A description of the accepted parameters follows.
1669 Specify a rectangular area where to limit the search for motion
1671 If desired the search for motion vectors can be limited to a
1672 rectangular area of the frame defined by its top left corner, width
1673 and height. These parameters have the same meaning as the drawbox
1674 filter which can be used to visualise the position of the bounding
1677 This is useful when simultaneous movement of subjects within the frame
1678 might be confused for camera motion by the motion vector search.
1680 If any or all of @var{x}, @var{y}, @var{w} and @var{h} are set to -1
1681 then the full frame is used. This allows later options to be set
1682 without specifying the bounding box for the motion vector search.
1684 Default - search the whole frame.
1687 Specify the maximum extent of movement in x and y directions in the
1688 range 0-64 pixels. Default 16.
1691 Specify how to generate pixels to fill blanks at the edge of the
1692 frame. An integer from 0 to 3 as follows:
1695 Fill zeroes at blank locations
1697 Original image at blank locations
1699 Extruded edge value at blank locations
1701 Mirrored edge at blank locations
1704 The default setting is mirror edge at blank locations.
1707 Specify the blocksize to use for motion search. Range 4-128 pixels,
1711 Specify the contrast threshold for blocks. Only blocks with more than
1712 the specified contrast (difference between darkest and lightest
1713 pixels) will be considered. Range 1-255, default 125.
1716 Specify the search strategy 0 = exhaustive search, 1 = less exhaustive
1717 search. Default - exhaustive search.
1720 If set then a detailed log of the motion search is written to the
1727 Draw a colored box on the input image.
1729 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
1732 The description of the accepted parameters follows.
1736 Specify the top left corner coordinates of the box. Default to 0.
1739 Specify the width and height of the box, if 0 they are interpreted as
1740 the input width and height. Default to 0.
1743 Specify the color of the box to write, it can be the name of a color
1744 (case insensitive match) or a 0xRRGGBB[AA] sequence. If the special
1745 value @code{invert} is used, the box edge color is the same as the
1746 video with inverted luma.
1749 If the key of the first options is omitted, the arguments are
1750 interpreted according to the following syntax:
1752 drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
1755 Some examples follow:
1758 Draw a black box around the edge of the input image:
1764 Draw a box with color red and an opacity of 50%:
1766 drawbox=10:20:200:60:red@@0.5
1769 The previous example can be specified as:
1771 drawbox=x=10:y=20:w=200:h=60:color=red@@0.5
1777 Draw text string or text from specified file on top of video using the
1778 libfreetype library.
1780 To enable compilation of this filter you need to configure FFmpeg with
1781 @code{--enable-libfreetype}.
1783 The filter also recognizes strftime() sequences in the provided text
1784 and expands them accordingly. Check the documentation of strftime().
1786 The filter accepts parameters as a list of @var{key}=@var{value} pairs,
1789 The description of the accepted parameters follows.
1794 Used to draw a box around text using background color.
1795 Value should be either 1 (enable) or 0 (disable).
1796 The default value of @var{box} is 0.
1799 The color to be used for drawing box around text.
1800 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
1801 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1802 The default value of @var{boxcolor} is "white".
1805 Set an expression which specifies if the text should be drawn. If the
1806 expression evaluates to 0, the text is not drawn. This is useful for
1807 specifying that the text should be drawn only when specific conditions
1810 Default value is "1".
1812 See below for the list of accepted constants and functions.
1815 If true, check and fix text coords to avoid clipping.
1818 The color to be used for drawing fonts.
1819 Either a string (e.g. "red") or in 0xRRGGBB[AA] format
1820 (e.g. "0xff000033"), possibly followed by an alpha specifier.
1821 The default value of @var{fontcolor} is "black".
1824 The font file to be used for drawing text. Path must be included.
1825 This parameter is mandatory.
1828 The font size to be used for drawing text.
1829 The default value of @var{fontsize} is 16.
1832 Flags to be used for loading the fonts.
1834 The flags map the corresponding flags supported by libfreetype, and are
1835 a combination of the following values:
1842 @item vertical_layout
1843 @item force_autohint
1846 @item ignore_global_advance_width
1848 @item ignore_transform
1855 Default value is "render".
1857 For more information consult the documentation for the FT_LOAD_*
1861 The color to be used for drawing a shadow behind the drawn text. It
1862 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
1863 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1864 The default value of @var{shadowcolor} is "black".
1866 @item shadowx, shadowy
1867 The x and y offsets for the text shadow position with respect to the
1868 position of the text. They can be either positive or negative
1869 values. Default value for both is "0".
1872 The size in number of spaces to use for rendering the tab.
1876 Set the initial timecode representation in "hh:mm:ss[:;.]ff"
1877 format. It can be used with or without text parameter. @var{timecode_rate}
1878 option must be specified.
1880 @item timecode_rate, rate, r
1881 Set the timecode frame rate (timecode only).
1884 The text string to be drawn. The text must be a sequence of UTF-8
1886 This parameter is mandatory if no file is specified with the parameter
1890 A text file containing text to be drawn. The text must be a sequence
1891 of UTF-8 encoded characters.
1893 This parameter is mandatory if no text string is specified with the
1894 parameter @var{text}.
1896 If both @var{text} and @var{textfile} are specified, an error is thrown.
1899 The expressions which specify the offsets where text will be drawn
1900 within the video frame. They are relative to the top/left border of the
1903 The default value of @var{x} and @var{y} is "0".
1905 See below for the list of accepted constants and functions.
1908 The parameters for @var{x} and @var{y} are expressions containing the
1909 following constants and functions:
1913 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
1916 horizontal and vertical chroma subsample values. For example for the
1917 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1920 the height of each text line
1928 @item max_glyph_a, ascent
1929 the maximum distance from the baseline to the highest/upper grid
1930 coordinate used to place a glyph outline point, for all the rendered
1932 It is a positive value, due to the grid's orientation with the Y axis
1935 @item max_glyph_d, descent
1936 the maximum distance from the baseline to the lowest grid coordinate
1937 used to place a glyph outline point, for all the rendered glyphs.
1938 This is a negative value, due to the grid's orientation, with the Y axis
1942 maximum glyph height, that is the maximum height for all the glyphs
1943 contained in the rendered text, it is equivalent to @var{ascent} -
1947 maximum glyph width, that is the maximum width for all the glyphs
1948 contained in the rendered text
1951 the number of input frame, starting from 0
1953 @item rand(min, max)
1954 return a random number included between @var{min} and @var{max}
1957 input sample aspect ratio
1960 timestamp expressed in seconds, NAN if the input timestamp is unknown
1963 the height of the rendered text
1966 the width of the rendered text
1969 the x and y offset coordinates where the text is drawn.
1971 These parameters allow the @var{x} and @var{y} expressions to refer
1972 each other, so you can for example specify @code{y=x/dar}.
1975 If libavfilter was built with @code{--enable-fontconfig}, then
1976 @option{fontfile} can be a fontconfig pattern or omitted.
1978 Some examples follow.
1983 Draw "Test Text" with font FreeSerif, using the default values for the
1984 optional parameters.
1987 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1991 Draw 'Test Text' with font FreeSerif of size 24 at position x=100
1992 and y=50 (counting from the top-left corner of the screen), text is
1993 yellow with a red box around it. Both the text and the box have an
1997 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1998 x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
2001 Note that the double quotes are not necessary if spaces are not used
2002 within the parameter list.
2005 Show the text at the center of the video frame:
2007 drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h-line_h)/2"
2011 Show a text line sliding from right to left in the last row of the video
2012 frame. The file @file{LONG_LINE} is assumed to contain a single line
2015 drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
2019 Show the content of file @file{CREDITS} off the bottom of the frame and scroll up.
2021 drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
2025 Draw a single green letter "g", at the center of the input video.
2026 The glyph baseline is placed at half screen height.
2028 drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
2032 Show text for 1 second every 3 seconds:
2034 drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:draw=lt(mod(t\,3)\,1):text='blink'"
2038 Use fontconfig to set the font. Note that the colons need to be escaped.
2040 drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
2045 For more information about libfreetype, check:
2046 @url{http://www.freetype.org/}.
2048 For more information about fontconfig, check:
2049 @url{http://freedesktop.org/software/fontconfig/fontconfig-user.html}.
2053 Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
2055 This filter accepts the following optional named parameters:
2059 Set low and high threshold values used by the Canny thresholding
2062 The high threshold selects the "strong" edge pixels, which are then
2063 connected through 8-connectivity with the "weak" edge pixels selected
2064 by the low threshold.
2066 @var{low} and @var{high} threshold values must be choosen in the range
2067 [0,1], and @var{low} should be lesser or equal to @var{high}.
2069 Default value for @var{low} is @code{20/255}, and default value for @var{high}
2075 edgedetect=low=0.1:high=0.4
2080 Apply fade-in/out effect to input video.
2082 It accepts the parameters:
2083 @var{type}:@var{start_frame}:@var{nb_frames}[:@var{options}]
2085 @var{type} specifies if the effect type, can be either "in" for
2086 fade-in, or "out" for a fade-out effect.
2088 @var{start_frame} specifies the number of the start frame for starting
2089 to apply the fade effect.
2091 @var{nb_frames} specifies the number of frames for which the fade
2092 effect has to last. At the end of the fade-in effect the output video
2093 will have the same intensity as the input video, at the end of the
2094 fade-out transition the output video will be completely black.
2096 @var{options} is an optional sequence of @var{key}=@var{value} pairs,
2097 separated by ":". The description of the accepted options follows.
2104 @item start_frame, s
2105 See @var{start_frame}.
2108 See @var{nb_frames}.
2111 If set to 1, fade only alpha channel, if one exists on the input.
2115 A few usage examples follow, usable too as test scenarios.
2117 # fade in first 30 frames of video
2120 # fade out last 45 frames of a 200-frame video
2123 # fade in first 25 frames and fade out last 25 frames of a 1000-frame video
2124 fade=in:0:25, fade=out:975:25
2126 # make first 5 frames black, then fade in from frame 5-24
2129 # fade in alpha over first 25 frames of video
2130 fade=in:0:25:alpha=1
2135 Extract a single field from an interlaced image using stride
2136 arithmetic to avoid wasting CPU time. The output frames are marked as
2139 This filter accepts the following named options:
2142 Specify whether to extract the top (if the value is @code{0} or
2143 @code{top}) or the bottom field (if the value is @code{1} or
2147 If the option key is not specified, the first value sets the @var{type}
2148 option. For example:
2160 Transform the field order of the input video.
2162 It accepts one parameter which specifies the required field order that
2163 the input interlaced video will be transformed to. The parameter can
2164 assume one of the following values:
2168 output bottom field first
2170 output top field first
2173 Default value is "tff".
2175 Transformation is achieved by shifting the picture content up or down
2176 by one line, and filling the remaining line with appropriate picture content.
2177 This method is consistent with most broadcast field order converters.
2179 If the input video is not flagged as being interlaced, or it is already
2180 flagged as being of the required output field order then this filter does
2181 not alter the incoming video.
2183 This filter is very useful when converting to or from PAL DV material,
2184 which is bottom field first.
2188 ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
2193 Buffer input images and send them when they are requested.
2195 This filter is mainly useful when auto-inserted by the libavfilter
2198 The filter does not take parameters.
2202 Convert the input video to one of the specified pixel formats.
2203 Libavfilter will try to pick one that is supported for the input to
2206 The filter accepts a list of pixel format names, separated by ":",
2207 for example "yuv420p:monow:rgb24".
2209 Some examples follow:
2211 # convert the input video to the format "yuv420p"
2214 # convert the input video to any of the formats in the list
2215 format=yuv420p:yuv444p:yuv410p
2220 Convert the video to specified constant framerate by duplicating or dropping
2221 frames as necessary.
2223 This filter accepts the following named parameters:
2227 Desired output framerate.
2230 Rounding method. The default is @code{near}.
2236 Select one frame every N.
2238 This filter accepts in input a string representing a positive
2239 integer. Default argument is @code{1}.
2244 Apply a frei0r effect to the input video.
2246 To enable compilation of this filter you need to install the frei0r
2247 header and configure FFmpeg with @code{--enable-frei0r}.
2249 The filter supports the syntax:
2251 @var{filter_name}[@{:|=@}@var{param1}:@var{param2}:...:@var{paramN}]
2254 @var{filter_name} is the name to the frei0r effect to load. If the
2255 environment variable @env{FREI0R_PATH} is defined, the frei0r effect
2256 is searched in each one of the directories specified by the colon (or
2257 semicolon on Windows platforms) separated list in @env{FREIOR_PATH},
2258 otherwise in the standard frei0r paths, which are in this order:
2259 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
2260 @file{/usr/lib/frei0r-1/}.
2262 @var{param1}, @var{param2}, ... , @var{paramN} specify the parameters
2263 for the frei0r effect.
2265 A frei0r effect parameter can be a boolean (whose values are specified
2266 with "y" and "n"), a double, a color (specified by the syntax
2267 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
2268 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
2269 description), a position (specified by the syntax @var{X}/@var{Y},
2270 @var{X} and @var{Y} being float numbers) and a string.
2272 The number and kind of parameters depend on the loaded effect. If an
2273 effect parameter is not specified the default value is set.
2275 Some examples follow:
2279 Apply the distort0r effect, set the first two double parameters:
2281 frei0r=distort0r:0.5:0.01
2285 Apply the colordistance effect, takes a color as first parameter:
2287 frei0r=colordistance:0.2/0.3/0.4
2288 frei0r=colordistance:violet
2289 frei0r=colordistance:0x112233
2293 Apply the perspective effect, specify the top left and top right image
2296 frei0r=perspective:0.2/0.2:0.8/0.2
2300 For more information see:
2301 @url{http://frei0r.dyne.org}
2305 Fix the banding artifacts that are sometimes introduced into nearly flat
2306 regions by truncation to 8bit color depth.
2307 Interpolate the gradients that should go where the bands are, and
2310 This filter is designed for playback only. Do not use it prior to
2311 lossy compression, because compression tends to lose the dither and
2312 bring back the bands.
2314 The filter takes two optional parameters, separated by ':':
2315 @var{strength}:@var{radius}
2317 @var{strength} is the maximum amount by which the filter will change
2318 any one pixel. Also the threshold for detecting nearly flat
2319 regions. Acceptable values range from .51 to 255, default value is
2320 1.2, out-of-range values will be clipped to the valid range.
2322 @var{radius} is the neighborhood to fit the gradient to. A larger
2323 radius makes for smoother gradients, but also prevents the filter from
2324 modifying the pixels near detailed regions. Acceptable values are
2325 8-32, default value is 16, out-of-range values will be clipped to the
2329 # default parameters
2338 Flip the input video horizontally.
2340 For example to horizontally flip the input video with @command{ffmpeg}:
2342 ffmpeg -i in.avi -vf "hflip" out.avi
2347 High precision/quality 3d denoise filter. This filter aims to reduce
2348 image noise producing smooth images and making still images really
2349 still. It should enhance compressibility.
2351 It accepts the following optional parameters:
2352 @var{luma_spatial}:@var{chroma_spatial}:@var{luma_tmp}:@var{chroma_tmp}
2356 a non-negative float number which specifies spatial luma strength,
2359 @item chroma_spatial
2360 a non-negative float number which specifies spatial chroma strength,
2361 defaults to 3.0*@var{luma_spatial}/4.0
2364 a float number which specifies luma temporal strength, defaults to
2365 6.0*@var{luma_spatial}/4.0
2368 a float number which specifies chroma temporal strength, defaults to
2369 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
2374 Modify the hue and/or the saturation of the input.
2376 This filter accepts the following optional named options:
2380 Specify the hue angle as a number of degrees. It accepts a float
2381 number or an expression, and defaults to 0.0.
2384 Specify the hue angle as a number of degrees. It accepts a float
2385 number or an expression, and defaults to 0.0.
2388 Specify the saturation in the [-10,10] range. It accepts a float number and
2392 The @var{h}, @var{H} and @var{s} parameters are expressions containing the
2393 following constants:
2397 frame count of the input frame starting from 0
2400 presentation timestamp of the input frame expressed in time base units
2403 frame rate of the input video, NAN if the input frame rate is unknown
2406 timestamp expressed in seconds, NAN if the input timestamp is unknown
2409 time base of the input video
2412 The options can also be set using the syntax: @var{hue}:@var{saturation}
2414 In this case @var{hue} is expressed in degrees.
2416 Some examples follow:
2419 Set the hue to 90 degrees and the saturation to 1.0:
2425 Same command but expressing the hue in radians:
2431 Same command without named options, hue must be expressed in degrees:
2437 Note that "h:s" syntax does not support expressions for the values of
2438 h and s, so the following example will issue an error:
2444 Rotate hue and make the saturation swing between 0
2445 and 2 over a period of 1 second:
2447 hue="H=2*PI*t: s=sin(2*PI*t)+1"
2451 Apply a 3 seconds saturation fade-in effect starting at 0:
2456 The general fade-in expression can be written as:
2458 hue="s=min(0\, max((t-START)/DURATION\, 1))"
2462 Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
2464 hue="s=max(0\, min(1\, (8-t)/3))"
2467 The general fade-out expression can be written as:
2469 hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
2474 @subsection Commands
2476 This filter supports the following command:
2479 Modify the hue and/or the saturation of the input video.
2480 The command accepts the same named options and syntax than when calling the
2481 filter from the command-line.
2483 If a parameter is omitted, it is kept at its current value.
2488 Interlaceing detect filter. This filter tries to detect if the input is
2489 interlaced or progressive. Top or bottom field first.
2491 @section lut, lutrgb, lutyuv
2493 Compute a look-up table for binding each pixel component input value
2494 to an output value, and apply it to input video.
2496 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
2497 to an RGB input video.
2499 These filters accept in input a ":"-separated list of options, which
2500 specify the expressions used for computing the lookup table for the
2501 corresponding pixel component values.
2503 The @var{lut} filter requires either YUV or RGB pixel formats in
2504 input, and accepts the options:
2506 @item @var{c0} (first pixel component)
2507 @item @var{c1} (second pixel component)
2508 @item @var{c2} (third pixel component)
2509 @item @var{c3} (fourth pixel component, corresponds to the alpha component)
2512 The exact component associated to each option depends on the format in
2515 The @var{lutrgb} filter requires RGB pixel formats in input, and
2516 accepts the options:
2518 @item @var{r} (red component)
2519 @item @var{g} (green component)
2520 @item @var{b} (blue component)
2521 @item @var{a} (alpha component)
2524 The @var{lutyuv} filter requires YUV pixel formats in input, and
2525 accepts the options:
2527 @item @var{y} (Y/luminance component)
2528 @item @var{u} (U/Cb component)
2529 @item @var{v} (V/Cr component)
2530 @item @var{a} (alpha component)
2533 The expressions can contain the following constants and functions:
2537 the input width and height
2540 input value for the pixel component
2543 the input value clipped in the @var{minval}-@var{maxval} range
2546 maximum value for the pixel component
2549 minimum value for the pixel component
2552 the negated value for the pixel component value clipped in the
2553 @var{minval}-@var{maxval} range , it corresponds to the expression
2554 "maxval-clipval+minval"
2557 the computed value in @var{val} clipped in the
2558 @var{minval}-@var{maxval} range
2560 @item gammaval(gamma)
2561 the computed gamma correction value of the pixel component value
2562 clipped in the @var{minval}-@var{maxval} range, corresponds to the
2564 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
2568 All expressions default to "val".
2570 Some examples follow:
2572 # negate input video
2573 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
2574 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
2576 # the above is the same as
2577 lutrgb="r=negval:g=negval:b=negval"
2578 lutyuv="y=negval:u=negval:v=negval"
2583 # remove chroma components, turns the video into a graytone image
2584 lutyuv="u=128:v=128"
2586 # apply a luma burning effect
2589 # remove green and blue components
2592 # set a constant alpha channel value on input
2593 format=rgba,lutrgb=a="maxval-minval/2"
2595 # correct luminance gamma by a 0.5 factor
2596 lutyuv=y=gammaval(0.5)
2601 Apply an MPlayer filter to the input video.
2603 This filter provides a wrapper around most of the filters of
2606 This wrapper is considered experimental. Some of the wrapped filters
2607 may not work properly and we may drop support for them, as they will
2608 be implemented natively into FFmpeg. Thus you should avoid
2609 depending on them when writing portable scripts.
2611 The filters accepts the parameters:
2612 @var{filter_name}[:=]@var{filter_params}
2614 @var{filter_name} is the name of a supported MPlayer filter,
2615 @var{filter_params} is a string containing the parameters accepted by
2618 The list of the currently supported filters follows:
2658 The parameter syntax and behavior for the listed filters are the same
2659 of the corresponding MPlayer filters. For detailed instructions check
2660 the "VIDEO FILTERS" section in the MPlayer manual.
2662 Some examples follow:
2665 Adjust gamma, brightness, contrast:
2671 Add temporal noise to input video:
2677 See also mplayer(1), @url{http://www.mplayerhq.hu/}.
2683 This filter accepts an integer in input, if non-zero it negates the
2684 alpha component (if available). The default value in input is 0.
2688 Force libavfilter not to use any of the specified pixel formats for the
2689 input to the next filter.
2691 The filter accepts a list of pixel format names, separated by ":",
2692 for example "yuv420p:monow:rgb24".
2694 Some examples follow:
2696 # force libavfilter to use a format different from "yuv420p" for the
2697 # input to the vflip filter
2698 noformat=yuv420p,vflip
2700 # convert the input video to any of the formats not contained in the list
2701 noformat=yuv420p:yuv444p:yuv410p
2706 Pass the video source unchanged to the output.
2710 Apply video transform using libopencv.
2712 To enable this filter install libopencv library and headers and
2713 configure FFmpeg with @code{--enable-libopencv}.
2715 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
2717 @var{filter_name} is the name of the libopencv filter to apply.
2719 @var{filter_params} specifies the parameters to pass to the libopencv
2720 filter. If not specified the default values are assumed.
2722 Refer to the official libopencv documentation for more precise
2724 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
2726 Follows the list of supported libopencv filters.
2731 Dilate an image by using a specific structuring element.
2732 This filter corresponds to the libopencv function @code{cvDilate}.
2734 It accepts the parameters: @var{struct_el}:@var{nb_iterations}.
2736 @var{struct_el} represents a structuring element, and has the syntax:
2737 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
2739 @var{cols} and @var{rows} represent the number of columns and rows of
2740 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
2741 point, and @var{shape} the shape for the structuring element, and
2742 can be one of the values "rect", "cross", "ellipse", "custom".
2744 If the value for @var{shape} is "custom", it must be followed by a
2745 string of the form "=@var{filename}". The file with name
2746 @var{filename} is assumed to represent a binary image, with each
2747 printable character corresponding to a bright pixel. When a custom
2748 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
2749 or columns and rows of the read file are assumed instead.
2751 The default value for @var{struct_el} is "3x3+0x0/rect".
2753 @var{nb_iterations} specifies the number of times the transform is
2754 applied to the image, and defaults to 1.
2756 Follow some example:
2758 # use the default values
2761 # dilate using a structuring element with a 5x5 cross, iterate two times
2762 ocv=dilate=5x5+2x2/cross:2
2764 # read the shape from the file diamond.shape, iterate two times
2765 # the file diamond.shape may contain a pattern of characters like this:
2771 # the specified cols and rows are ignored (but not the anchor point coordinates)
2772 ocv=0x0+2x2/custom=diamond.shape:2
2777 Erode an image by using a specific structuring element.
2778 This filter corresponds to the libopencv function @code{cvErode}.
2780 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
2781 with the same syntax and semantics as the @ref{dilate} filter.
2785 Smooth the input video.
2787 The filter takes the following parameters:
2788 @var{type}:@var{param1}:@var{param2}:@var{param3}:@var{param4}.
2790 @var{type} is the type of smooth filter to apply, and can be one of
2791 the following values: "blur", "blur_no_scale", "median", "gaussian",
2792 "bilateral". The default value is "gaussian".
2794 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
2795 parameters whose meanings depend on smooth type. @var{param1} and
2796 @var{param2} accept integer positive values or 0, @var{param3} and
2797 @var{param4} accept float values.
2799 The default value for @var{param1} is 3, the default value for the
2800 other parameters is 0.
2802 These parameters correspond to the parameters assigned to the
2803 libopencv function @code{cvSmooth}.
2808 Overlay one video on top of another.
2810 It takes two inputs and one output, the first input is the "main"
2811 video on which the second input is overlayed.
2813 It accepts the parameters: @var{x}:@var{y}[:@var{options}].
2815 @var{x} is the x coordinate of the overlayed video on the main video,
2816 @var{y} is the y coordinate. @var{x} and @var{y} are expressions containing
2817 the following parameters:
2820 @item main_w, main_h
2821 main input width and height
2824 same as @var{main_w} and @var{main_h}
2826 @item overlay_w, overlay_h
2827 overlay input width and height
2830 same as @var{overlay_w} and @var{overlay_h}
2833 @var{options} is an optional list of @var{key}=@var{value} pairs,
2836 The description of the accepted options follows.
2840 If set to 1, force the filter to accept inputs in the RGB
2841 color space. Default value is 0.
2844 Be aware that frames are taken from each input video in timestamp
2845 order, hence, if their initial timestamps differ, it is a a good idea
2846 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
2847 have them begin in the same zero timestamp, as it does the example for
2848 the @var{movie} filter.
2850 Follow some examples:
2852 # draw the overlay at 10 pixels from the bottom right
2853 # corner of the main video.
2854 overlay=main_w-overlay_w-10:main_h-overlay_h-10
2856 # insert a transparent PNG logo in the bottom left corner of the input
2857 ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
2859 # insert 2 different transparent PNG logos (second logo on bottom
2861 ffmpeg -i input -i logo1 -i logo2 -filter_complex
2862 'overlay=10:H-h-10,overlay=W-w-10:H-h-10' output
2864 # add a transparent color layer on top of the main video,
2865 # WxH specifies the size of the main input to the overlay filter
2866 color=red@@.3:WxH [over]; [in][over] overlay [out]
2868 # play an original video and a filtered version (here with the deshake filter)
2870 ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
2872 # the previous example is the same as:
2873 ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
2876 You can chain together more overlays but the efficiency of such
2877 approach is yet to be tested.
2881 Add paddings to the input image, and places the original input at the
2882 given coordinates @var{x}, @var{y}.
2884 It accepts the following parameters:
2885 @var{width}:@var{height}:@var{x}:@var{y}:@var{color}.
2887 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
2888 expressions containing the following constants:
2892 the input video width and height
2895 same as @var{in_w} and @var{in_h}
2898 the output width and height, that is the size of the padded area as
2899 specified by the @var{width} and @var{height} expressions
2902 same as @var{out_w} and @var{out_h}
2905 x and y offsets as specified by the @var{x} and @var{y}
2906 expressions, or NAN if not yet specified
2909 same as @var{iw} / @var{ih}
2912 input sample aspect ratio
2915 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
2918 horizontal and vertical chroma subsample values. For example for the
2919 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2922 Follows the description of the accepted parameters.
2927 Specify the size of the output image with the paddings added. If the
2928 value for @var{width} or @var{height} is 0, the corresponding input size
2929 is used for the output.
2931 The @var{width} expression can reference the value set by the
2932 @var{height} expression, and vice versa.
2934 The default value of @var{width} and @var{height} is 0.
2938 Specify the offsets where to place the input image in the padded area
2939 with respect to the top/left border of the output image.
2941 The @var{x} expression can reference the value set by the @var{y}
2942 expression, and vice versa.
2944 The default value of @var{x} and @var{y} is 0.
2948 Specify the color of the padded area, it can be the name of a color
2949 (case insensitive match) or a 0xRRGGBB[AA] sequence.
2951 The default value of @var{color} is "black".
2955 @subsection Examples
2959 Add paddings with color "violet" to the input video. Output video
2960 size is 640x480, the top-left corner of the input video is placed at
2963 pad=640:480:0:40:violet
2967 Pad the input to get an output with dimensions increased by 3/2,
2968 and put the input video at the center of the padded area:
2970 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
2974 Pad the input to get a squared output with size equal to the maximum
2975 value between the input width and height, and put the input video at
2976 the center of the padded area:
2978 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
2982 Pad the input to get a final w/h ratio of 16:9:
2984 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
2988 In case of anamorphic video, in order to set the output display aspect
2989 correctly, it is necessary to use @var{sar} in the expression,
2990 according to the relation:
2992 (ih * X / ih) * sar = output_dar
2993 X = output_dar / sar
2996 Thus the previous example needs to be modified to:
2998 pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
3002 Double output size and put the input video in the bottom-right
3003 corner of the output padded area:
3005 pad="2*iw:2*ih:ow-iw:oh-ih"
3009 @section pixdesctest
3011 Pixel format descriptor test filter, mainly useful for internal
3012 testing. The output video should be equal to the input video.
3016 format=monow, pixdesctest
3019 can be used to test the monowhite pixel format descriptor definition.
3023 Suppress a TV station logo, using an image file to determine which
3024 pixels comprise the logo. It works by filling in the pixels that
3025 comprise the logo with neighboring pixels.
3027 This filter requires one argument which specifies the filter bitmap
3028 file, which can be any image format supported by libavformat. The
3029 width and height of the image file must match those of the video
3030 stream being processed.
3032 Pixels in the provided bitmap image with a value of zero are not
3033 considered part of the logo, non-zero pixels are considered part of
3034 the logo. If you use white (255) for the logo and black (0) for the
3035 rest, you will be safe. For making the filter bitmap, it is
3036 recommended to take a screen capture of a black frame with the logo
3037 visible, and then using a threshold filter followed by the erode
3038 filter once or twice.
3040 If needed, little splotches can be fixed manually. Remember that if
3041 logo pixels are not covered, the filter quality will be much
3042 reduced. Marking too many pixels as part of the logo does not hurt as
3043 much, but it will increase the amount of blurring needed to cover over
3044 the image and will destroy more information than necessary, and extra
3045 pixels will slow things down on a large logo.
3049 Scale (resize) the input video, using the libswscale library.
3051 The scale filter forces the output display aspect ratio to be the same
3052 of the input, by changing the output sample aspect ratio.
3054 This filter accepts a list of named options in the form of
3055 @var{key}=@var{value} pairs separated by ":". If the key for the first
3056 two options is not specified, the assumed keys for the first two
3057 values are @code{w} and @code{h}. If the first option has no key and
3058 can be interpreted like a video size specification, it will be used
3059 to set the video size.
3061 A description of the accepted options follows.
3065 Set the video width expression, default value is @code{iw}. See below
3066 for the list of accepted constants.
3069 Set the video heiht expression, default value is @code{ih}.
3070 See below for the list of accepted constants.
3073 Set the interlacing. It accepts the following values:
3077 force interlaced aware scaling
3080 do not apply interlaced scaling
3083 select interlaced aware scaling depending on whether the source frames
3084 are flagged as interlaced or not
3087 Default value is @code{0}.
3090 Set libswscale scaling flags. If not explictly specified the filter
3091 applies a bilinear scaling algorithm.
3094 Set the video size, the value must be a valid abbreviation or in the
3095 form @var{width}x@var{height}.
3098 The values of the @var{w} and @var{h} options are expressions
3099 containing the following constants:
3103 the input width and height
3106 same as @var{in_w} and @var{in_h}
3109 the output (cropped) width and height
3112 same as @var{out_w} and @var{out_h}
3115 same as @var{iw} / @var{ih}
3118 input sample aspect ratio
3121 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
3124 horizontal and vertical chroma subsample values. For example for the
3125 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
3128 If the input image format is different from the format requested by
3129 the next filter, the scale filter will convert the input to the
3132 If the value for @var{width} or @var{height} is 0, the respective input
3133 size is used for the output.
3135 If the value for @var{width} or @var{height} is -1, the scale filter will
3136 use, for the respective output size, a value that maintains the aspect
3137 ratio of the input image.
3139 @subsection Examples
3143 Scale the input video to a size of 200x100:
3148 This is equivalent to:
3159 Specify a size abbreviation for the output size:
3164 which can also be written as:
3170 Scale the input to 2x:
3176 The above is the same as:
3182 Scale the input to 2x with forced interlaced scaling:
3184 scale=2*iw:2*ih:interl=1
3188 Scale the input to half size:
3194 Increase the width, and set the height to the same size:
3200 Seek for Greek harmony:
3207 Increase the height, and set the width to 3/2 of the height:
3213 Increase the size, but make the size a multiple of the chroma:
3215 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
3219 Increase the width to a maximum of 500 pixels, keep the same input
3222 scale='min(500\, iw*3/2):-1'
3227 Select frames to pass in output.
3229 It accepts in input an expression, which is evaluated for each input
3230 frame. If the expression is evaluated to a non-zero value, the frame
3231 is selected and passed to the output, otherwise it is discarded.
3233 The expression can contain the following constants:
3237 the sequential number of the filtered frame, starting from 0
3240 the sequential number of the selected frame, starting from 0
3242 @item prev_selected_n
3243 the sequential number of the last selected frame, NAN if undefined
3246 timebase of the input timestamps
3249 the PTS (Presentation TimeStamp) of the filtered video frame,
3250 expressed in @var{TB} units, NAN if undefined
3253 the PTS (Presentation TimeStamp) of the filtered video frame,
3254 expressed in seconds, NAN if undefined
3257 the PTS of the previously filtered video frame, NAN if undefined
3259 @item prev_selected_pts
3260 the PTS of the last previously filtered video frame, NAN if undefined
3262 @item prev_selected_t
3263 the PTS of the last previously selected video frame, NAN if undefined
3266 the PTS of the first video frame in the video, NAN if undefined
3269 the time of the first video frame in the video, NAN if undefined
3272 the type of the filtered frame, can assume one of the following
3284 @item interlace_type
3285 the frame interlace type, can assume one of the following values:
3288 the frame is progressive (not interlaced)
3290 the frame is top-field-first
3292 the frame is bottom-field-first
3296 1 if the filtered frame is a key-frame, 0 otherwise
3299 the position in the file of the filtered frame, -1 if the information
3300 is not available (e.g. for synthetic video)
3303 value between 0 and 1 to indicate a new scene; a low value reflects a low
3304 probability for the current frame to introduce a new scene, while a higher
3305 value means the current frame is more likely to be one (see the example below)
3309 The default value of the select expression is "1".
3311 Some examples follow:
3314 # select all frames in input
3317 # the above is the same as:
3323 # select only I-frames
3324 select='eq(pict_type\,I)'
3326 # select one frame every 100
3327 select='not(mod(n\,100))'
3329 # select only frames contained in the 10-20 time interval
3330 select='gte(t\,10)*lte(t\,20)'
3332 # select only I frames contained in the 10-20 time interval
3333 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
3335 # select frames with a minimum distance of 10 seconds
3336 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
3339 Complete example to create a mosaic of the first scenes:
3342 ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
3345 Comparing @var{scene} against a value between 0.3 and 0.5 is generally a sane
3348 @section setdar, setsar
3350 The @code{setdar} filter sets the Display Aspect Ratio for the filter
3353 This is done by changing the specified Sample (aka Pixel) Aspect
3354 Ratio, according to the following equation:
3356 @var{DAR} = @var{HORIZONTAL_RESOLUTION} / @var{VERTICAL_RESOLUTION} * @var{SAR}
3359 Keep in mind that the @code{setdar} filter does not modify the pixel
3360 dimensions of the video frame. Also the display aspect ratio set by
3361 this filter may be changed by later filters in the filterchain,
3362 e.g. in case of scaling or if another "setdar" or a "setsar" filter is
3365 The @code{setsar} filter sets the Sample (aka Pixel) Aspect Ratio for
3366 the filter output video.
3368 Note that as a consequence of the application of this filter, the
3369 output display aspect ratio will change according to the equation
3372 Keep in mind that the sample aspect ratio set by the @code{setsar}
3373 filter may be changed by later filters in the filterchain, e.g. if
3374 another "setsar" or a "setdar" filter is applied.
3376 The @code{setdar} and @code{setsar} filters accept a string in the
3377 form @var{num}:@var{den} expressing an aspect ratio, or the following
3378 named options, expressed as a sequence of @var{key}=@var{value} pairs,
3383 Set the maximum integer value to use for expressing numerator and
3384 denominator when reducing the expressed aspect ratio to a rational.
3385 Default value is @code{100}.
3388 Set the aspect ratio used by the filter.
3390 The parameter can be a floating point number string, an expression, or
3391 a string of the form @var{num}:@var{den}, where @var{num} and
3392 @var{den} are the numerator and denominator of the aspect ratio. If
3393 the parameter is not specified, it is assumed the value "0".
3394 In case the form "@var{num}:@var{den}" the @code{:} character should
3398 If the keys are omitted in the named options list, the specifed values
3399 are assumed to be @var{ratio} and @var{max} in that order.
3401 For example to change the display aspect ratio to 16:9, specify:
3406 The example above is equivalent to:
3411 To change the sample aspect ratio to 10:11, specify:
3416 To set a display aspect ratio of 16:9, and specify a maximum integer value of
3417 1000 in the aspect ratio reduction, use the command:
3419 setdar=ratio='16:9':max=1000
3424 Force field for the output video frame.
3426 The @code{setfield} filter marks the interlace type field for the
3427 output frames. It does not change the input frame, but only sets the
3428 corresponding property, which affects how the frame is treated by
3429 following filters (e.g. @code{fieldorder} or @code{yadif}).
3431 It accepts a string parameter, which can assume the following values:
3434 Keep the same field property.
3437 Mark the frame as bottom-field-first.
3440 Mark the frame as top-field-first.
3443 Mark the frame as progressive.
3448 Show a line containing various information for each input video frame.
3449 The input video is not modified.
3451 The shown line contains a sequence of key/value pairs of the form
3452 @var{key}:@var{value}.
3454 A description of each shown parameter follows:
3458 sequential number of the input frame, starting from 0
3461 Presentation TimeStamp of the input frame, expressed as a number of
3462 time base units. The time base unit depends on the filter input pad.
3465 Presentation TimeStamp of the input frame, expressed as a number of
3469 position of the frame in the input stream, -1 if this information in
3470 unavailable and/or meaningless (for example in case of synthetic video)
3476 sample aspect ratio of the input frame, expressed in the form
3480 size of the input frame, expressed in the form
3481 @var{width}x@var{height}
3484 interlaced mode ("P" for "progressive", "T" for top field first, "B"
3485 for bottom field first)
3488 1 if the frame is a key frame, 0 otherwise
3491 picture type of the input frame ("I" for an I-frame, "P" for a
3492 P-frame, "B" for a B-frame, "?" for unknown type).
3493 Check also the documentation of the @code{AVPictureType} enum and of
3494 the @code{av_get_picture_type_char} function defined in
3495 @file{libavutil/avutil.h}.
3498 Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame
3500 @item plane_checksum
3501 Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
3502 expressed in the form "[@var{c0} @var{c1} @var{c2} @var{c3}]"
3507 Pass the images of input video on to next video filter as multiple
3511 ffmpeg -i in.avi -vf "slicify=32" out.avi
3514 The filter accepts the slice height as parameter. If the parameter is
3515 not specified it will use the default value of 16.
3517 Adding this in the beginning of filter chains should make filtering
3518 faster due to better use of the memory cache.
3522 Blur the input video without impacting the outlines.
3524 The filter accepts the following parameters:
3525 @var{luma_radius}:@var{luma_strength}:@var{luma_threshold}[:@var{chroma_radius}:@var{chroma_strength}:@var{chroma_threshold}]
3527 Parameters prefixed by @var{luma} indicate that they work on the
3528 luminance of the pixels whereas parameters prefixed by @var{chroma}
3529 refer to the chrominance of the pixels.
3531 If the chroma parameters are not set, the luma parameters are used for
3532 either the luminance and the chrominance of the pixels.
3534 @var{luma_radius} or @var{chroma_radius} must be a float number in the
3535 range [0.1,5.0] that specifies the variance of the gaussian filter
3536 used to blur the image (slower if larger).
3538 @var{luma_strength} or @var{chroma_strength} must be a float number in
3539 the range [-1.0,1.0] that configures the blurring. A value included in
3540 [0.0,1.0] will blur the image whereas a value included in [-1.0,0.0]
3541 will sharpen the image.
3543 @var{luma_threshold} or @var{chroma_threshold} must be an integer in
3544 the range [-30,30] that is used as a coefficient to determine whether
3545 a pixel should be blurred or not. A value of 0 will filter all the
3546 image, a value included in [0,30] will filter flat areas and a value
3547 included in [-30,0] will filter edges.
3551 Split input video into several identical outputs.
3553 The filter accepts a single parameter which specifies the number of outputs. If
3554 unspecified, it defaults to 2.
3558 ffmpeg -i INPUT -filter_complex split=5 OUTPUT
3560 will create 5 copies of the input video.
3564 [in] split [splitout1][splitout2];
3565 [splitout1] crop=100:100:0:0 [cropout];
3566 [splitout2] pad=200:200:100:100 [padout];
3569 will create two separate outputs from the same input, one cropped and
3574 Scale the input by 2x and smooth using the Super2xSaI (Scale and
3575 Interpolate) pixel art scaling algorithm.
3577 Useful for enlarging pixel art images without reducing sharpness.
3583 Select the most representative frame in a given sequence of consecutive frames.
3585 It accepts as argument the frames batch size to analyze (default @var{N}=100);
3586 in a set of @var{N} frames, the filter will pick one of them, and then handle
3587 the next batch of @var{N} frames until the end.
3589 Since the filter keeps track of the whole frames sequence, a bigger @var{N}
3590 value will result in a higher memory usage, so a high value is not recommended.
3592 The following example extract one picture each 50 frames:
3597 Complete example of a thumbnail creation with @command{ffmpeg}:
3599 ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
3604 Tile several successive frames together.
3606 It accepts as argument the tile size (i.e. the number of lines and columns)
3607 in the form "@var{w}x@var{h}".
3609 For example, produce 8×8 PNG tiles of all keyframes (@option{-skip_frame
3612 ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
3614 The @option{-vsync 0} is necessary to prevent @command{ffmpeg} from
3615 duplicating each output frame to accomodate the originally detected frame
3620 Perform various types of temporal field interlacing.
3622 Frames are counted starting from 1, so the first input frame is
3625 This filter accepts a single parameter specifying the mode. Available
3630 Move odd frames into the upper field, even into the lower field,
3631 generating a double height frame at half framerate.
3634 Only output even frames, odd frames are dropped, generating a frame with
3635 unchanged height at half framerate.
3638 Only output odd frames, even frames are dropped, generating a frame with
3639 unchanged height at half framerate.
3642 Expand each frame to full height, but pad alternate lines with black,
3643 generating a frame with double height at the same input framerate.
3645 @item interleave_top, 4
3646 Interleave the upper field from odd frames with the lower field from
3647 even frames, generating a frame with unchanged height at half framerate.
3649 @item interleave_bottom, 5
3650 Interleave the lower field from odd frames with the upper field from
3651 even frames, generating a frame with unchanged height at half framerate.
3653 @item interlacex2, 6
3654 Double frame rate with unchanged height. Frames are inserted each
3655 containing the second temporal field from the previous input frame and
3656 the first temporal field from the next input frame. This mode relies on
3657 the top_field_first flag. Useful for interlaced video displays with no
3658 field synchronisation.
3661 Numeric values are deprecated but are accepted for backward
3662 compatibility reasons.
3664 Default mode is @code{merge}.
3668 Transpose rows with columns in the input video and optionally flip it.
3670 This filter accepts the following named parameters:
3674 Specify the transposition direction. Can assume the following values:
3678 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
3686 Rotate by 90 degrees clockwise, that is:
3694 Rotate by 90 degrees counterclockwise, that is:
3702 Rotate by 90 degrees clockwise and vertically flip, that is:
3710 For values between 4-7, the transposition is only done if the input
3711 video geometry is portrait and not landscape. These values are
3712 deprecated, the @code{passthrough} option should be used instead.
3715 Do not apply the transposition if the input geometry matches the one
3716 specified by the specified value. It accepts the following values:
3719 Always apply transposition.
3721 Preserve portrait geometry (when @var{height} >= @var{width}).
3723 Preserve landscape geometry (when @var{width} >= @var{height}).
3726 Default value is @code{none}.
3731 Sharpen or blur the input video.
3733 It accepts the following parameters:
3734 @var{luma_msize_x}:@var{luma_msize_y}:@var{luma_amount}:@var{chroma_msize_x}:@var{chroma_msize_y}:@var{chroma_amount}
3736 Negative values for the amount will blur the input video, while positive
3737 values will sharpen. All parameters are optional and default to the
3738 equivalent of the string '5:5:1.0:5:5:0.0'.
3743 Set the luma matrix horizontal size. It can be an integer between 3
3744 and 13, default value is 5.
3747 Set the luma matrix vertical size. It can be an integer between 3
3748 and 13, default value is 5.
3751 Set the luma effect strength. It can be a float number between -2.0
3752 and 5.0, default value is 1.0.
3754 @item chroma_msize_x
3755 Set the chroma matrix horizontal size. It can be an integer between 3
3756 and 13, default value is 5.
3758 @item chroma_msize_y
3759 Set the chroma matrix vertical size. It can be an integer between 3
3760 and 13, default value is 5.
3763 Set the chroma effect strength. It can be a float number between -2.0
3764 and 5.0, default value is 0.0.
3769 # Strong luma sharpen effect parameters
3772 # Strong blur of both luma and chroma parameters
3773 unsharp=7:7:-2:7:7:-2
3775 # Use the default values with @command{ffmpeg}
3776 ffmpeg -i in.avi -vf "unsharp" out.mp4
3781 Flip the input video vertically.
3784 ffmpeg -i in.avi -vf "vflip" out.avi
3789 Deinterlace the input video ("yadif" means "yet another deinterlacing
3792 It accepts the optional parameters: @var{mode}:@var{parity}:@var{auto}.
3794 @var{mode} specifies the interlacing mode to adopt, accepts one of the
3799 output 1 frame for each frame
3801 output 1 frame for each field
3803 like 0 but skips spatial interlacing check
3805 like 1 but skips spatial interlacing check
3810 @var{parity} specifies the picture field parity assumed for the input
3811 interlaced video, accepts one of the following values:
3815 assume top field first
3817 assume bottom field first
3819 enable automatic detection
3822 Default value is -1.
3823 If interlacing is unknown or decoder does not export this information,
3824 top field first will be assumed.
3826 @var{auto} specifies if deinterlacer should trust the interlaced flag
3827 and only deinterlace frames marked as interlaced
3831 deinterlace all frames
3833 only deinterlace frames marked as interlaced
3838 @c man end VIDEO FILTERS
3840 @chapter Video Sources
3841 @c man begin VIDEO SOURCES
3843 Below is a description of the currently available video sources.
3847 Buffer video frames, and make them available to the filter chain.
3849 This source is mainly intended for a programmatic use, in particular
3850 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
3852 It accepts a list of options in the form of @var{key}=@var{value} pairs
3853 separated by ":". A description of the accepted options follows.
3858 Specify the size (width and height) of the buffered video frames.
3861 A string representing the pixel format of the buffered video frames.
3862 It may be a number corresponding to a pixel format, or a pixel format
3866 Specify the timebase assumed by the timestamps of the buffered frames.
3869 Specify the frame rate expected for the video stream.
3872 Specify the sample aspect ratio assumed by the video frames.
3875 Specify the optional parameters to be used for the scale filter which
3876 is automatically inserted when an input change is detected in the
3877 input size or format.
3882 buffer=size=320x240:pix_fmt=yuv410p:time_base=1/24:pixel_aspect=1/1
3885 will instruct the source to accept video frames with size 320x240 and
3886 with format "yuv410p", assuming 1/24 as the timestamps timebase and
3887 square pixels (1:1 sample aspect ratio).
3888 Since the pixel format with name "yuv410p" corresponds to the number 6
3889 (check the enum AVPixelFormat definition in @file{libavutil/pixfmt.h}),
3890 this example corresponds to:
3892 buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
3895 Alternatively, the options can be specified as a flat string, but this
3896 syntax is deprecated:
3898 @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}]
3902 Create a pattern generated by an elementary cellular automaton.
3904 The initial state of the cellular automaton can be defined through the
3905 @option{filename}, and @option{pattern} options. If such options are
3906 not specified an initial state is created randomly.
3908 At each new frame a new row in the video is filled with the result of
3909 the cellular automaton next generation. The behavior when the whole
3910 frame is filled is defined by the @option{scroll} option.
3912 This source accepts a list of options in the form of
3913 @var{key}=@var{value} pairs separated by ":". A description of the
3914 accepted options follows.
3918 Read the initial cellular automaton state, i.e. the starting row, from
3920 In the file, each non-whitespace character is considered an alive
3921 cell, a newline will terminate the row, and further characters in the
3922 file will be ignored.
3925 Read the initial cellular automaton state, i.e. the starting row, from
3926 the specified string.
3928 Each non-whitespace character in the string is considered an alive
3929 cell, a newline will terminate the row, and further characters in the
3930 string will be ignored.
3933 Set the video rate, that is the number of frames generated per second.
3936 @item random_fill_ratio, ratio
3937 Set the random fill ratio for the initial cellular automaton row. It
3938 is a floating point number value ranging from 0 to 1, defaults to
3941 This option is ignored when a file or a pattern is specified.
3943 @item random_seed, seed
3944 Set the seed for filling randomly the initial row, must be an integer
3945 included between 0 and UINT32_MAX. If not specified, or if explicitly
3946 set to -1, the filter will try to use a good random seed on a best
3950 Set the cellular automaton rule, it is a number ranging from 0 to 255.
3951 Default value is 110.
3954 Set the size of the output video.
3956 If @option{filename} or @option{pattern} is specified, the size is set
3957 by default to the width of the specified initial state row, and the
3958 height is set to @var{width} * PHI.
3960 If @option{size} is set, it must contain the width of the specified
3961 pattern string, and the specified pattern will be centered in the
3964 If a filename or a pattern string is not specified, the size value
3965 defaults to "320x518" (used for a randomly generated initial state).
3968 If set to 1, scroll the output upward when all the rows in the output
3969 have been already filled. If set to 0, the new generated row will be
3970 written over the top row just after the bottom row is filled.
3973 @item start_full, full
3974 If set to 1, completely fill the output with generated rows before
3975 outputting the first frame.
3976 This is the default behavior, for disabling set the value to 0.
3979 If set to 1, stitch the left and right row edges together.
3980 This is the default behavior, for disabling set the value to 0.
3983 @subsection Examples
3987 Read the initial state from @file{pattern}, and specify an output of
3990 cellauto=f=pattern:s=200x400
3994 Generate a random initial row with a width of 200 cells, with a fill
3997 cellauto=ratio=2/3:s=200x200
4001 Create a pattern generated by rule 18 starting by a single alive cell
4002 centered on an initial row with width 100:
4004 cellauto=p=@@:s=100x400:full=0:rule=18
4008 Specify a more elaborated initial pattern:
4010 cellauto=p='@@@@ @@ @@@@':s=100x400:full=0:rule=18
4017 Generate a Mandelbrot set fractal, and progressively zoom towards the
4018 point specified with @var{start_x} and @var{start_y}.
4020 This source accepts a list of options in the form of
4021 @var{key}=@var{value} pairs separated by ":". A description of the
4022 accepted options follows.
4027 Set the terminal pts value. Default value is 400.
4030 Set the terminal scale value.
4031 Must be a floating point value. Default value is 0.3.
4034 Set the inner coloring mode, that is the algorithm used to draw the
4035 Mandelbrot fractal internal region.
4037 It shall assume one of the following values:
4042 Show time until convergence.
4044 Set color based on point closest to the origin of the iterations.
4049 Default value is @var{mincol}.
4052 Set the bailout value. Default value is 10.0.
4055 Set the maximum of iterations performed by the rendering
4056 algorithm. Default value is 7189.
4059 Set outer coloring mode.
4060 It shall assume one of following values:
4062 @item iteration_count
4063 Set iteration cound mode.
4064 @item normalized_iteration_count
4065 set normalized iteration count mode.
4067 Default value is @var{normalized_iteration_count}.
4070 Set frame rate, expressed as number of frames per second. Default
4074 Set frame size. Default value is "640x480".
4077 Set the initial scale value. Default value is 3.0.
4080 Set the initial x position. Must be a floating point value between
4081 -100 and 100. Default value is -0.743643887037158704752191506114774.
4084 Set the initial y position. Must be a floating point value between
4085 -100 and 100. Default value is -0.131825904205311970493132056385139.
4090 Generate various test patterns, as generated by the MPlayer test filter.
4092 The size of the generated video is fixed, and is 256x256.
4093 This source is useful in particular for testing encoding features.
4095 This source accepts an optional sequence of @var{key}=@var{value} pairs,
4096 separated by ":". The description of the accepted options follows.
4101 Specify the frame rate of the sourced video, as the number of frames
4102 generated per second. It has to be a string in the format
4103 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
4104 number or a valid video frame rate abbreviation. The default value is
4108 Set the video duration of the sourced video. The accepted syntax is:
4113 See also the function @code{av_parse_time()}.
4115 If not specified, or the expressed duration is negative, the video is
4116 supposed to be generated forever.
4120 Set the number or the name of the test to perform. Supported tests are:
4135 Default value is "all", which will cycle through the list of all tests.
4138 For example the following:
4143 will generate a "dc_luma" test pattern.
4147 Provide a frei0r source.
4149 To enable compilation of this filter you need to install the frei0r
4150 header and configure FFmpeg with @code{--enable-frei0r}.
4152 The source supports the syntax:
4154 @var{size}:@var{rate}:@var{src_name}[@{=|:@}@var{param1}:@var{param2}:...:@var{paramN}]
4157 @var{size} is the size of the video to generate, may be a string of the
4158 form @var{width}x@var{height} or a frame size abbreviation.
4159 @var{rate} is the rate of the video to generate, may be a string of
4160 the form @var{num}/@var{den} or a frame rate abbreviation.
4161 @var{src_name} is the name to the frei0r source to load. For more
4162 information regarding frei0r and how to set the parameters read the
4163 section @ref{frei0r} in the description of the video filters.
4165 For example, to generate a frei0r partik0l source with size 200x200
4166 and frame rate 10 which is overlayed on the overlay filter main input:
4168 frei0r_src=200x200:10:partik0l=1234 [overlay]; [in][overlay] overlay
4173 Generate a life pattern.
4175 This source is based on a generalization of John Conway's life game.
4177 The sourced input represents a life grid, each pixel represents a cell
4178 which can be in one of two possible states, alive or dead. Every cell
4179 interacts with its eight neighbours, which are the cells that are
4180 horizontally, vertically, or diagonally adjacent.
4182 At each interaction the grid evolves according to the adopted rule,
4183 which specifies the number of neighbor alive cells which will make a
4184 cell stay alive or born. The @option{rule} option allows to specify
4187 This source accepts a list of options in the form of
4188 @var{key}=@var{value} pairs separated by ":". A description of the
4189 accepted options follows.
4193 Set the file from which to read the initial grid state. In the file,
4194 each non-whitespace character is considered an alive cell, and newline
4195 is used to delimit the end of each row.
4197 If this option is not specified, the initial grid is generated
4201 Set the video rate, that is the number of frames generated per second.
4204 @item random_fill_ratio, ratio
4205 Set the random fill ratio for the initial random grid. It is a
4206 floating point number value ranging from 0 to 1, defaults to 1/PHI.
4207 It is ignored when a file is specified.
4209 @item random_seed, seed
4210 Set the seed for filling the initial random grid, must be an integer
4211 included between 0 and UINT32_MAX. If not specified, or if explicitly
4212 set to -1, the filter will try to use a good random seed on a best
4218 A rule can be specified with a code of the kind "S@var{NS}/B@var{NB}",
4219 where @var{NS} and @var{NB} are sequences of numbers in the range 0-8,
4220 @var{NS} specifies the number of alive neighbor cells which make a
4221 live cell stay alive, and @var{NB} the number of alive neighbor cells
4222 which make a dead cell to become alive (i.e. to "born").
4223 "s" and "b" can be used in place of "S" and "B", respectively.
4225 Alternatively a rule can be specified by an 18-bits integer. The 9
4226 high order bits are used to encode the next cell state if it is alive
4227 for each number of neighbor alive cells, the low order bits specify
4228 the rule for "borning" new cells. Higher order bits encode for an
4229 higher number of neighbor cells.
4230 For example the number 6153 = @code{(12<<9)+9} specifies a stay alive
4231 rule of 12 and a born rule of 9, which corresponds to "S23/B03".
4233 Default value is "S23/B3", which is the original Conway's game of life
4234 rule, and will keep a cell alive if it has 2 or 3 neighbor alive
4235 cells, and will born a new cell if there are three alive cells around
4239 Set the size of the output video.
4241 If @option{filename} is specified, the size is set by default to the
4242 same size of the input file. If @option{size} is set, it must contain
4243 the size specified in the input file, and the initial grid defined in
4244 that file is centered in the larger resulting area.
4246 If a filename is not specified, the size value defaults to "320x240"
4247 (used for a randomly generated initial grid).
4250 If set to 1, stitch the left and right grid edges together, and the
4251 top and bottom edges also. Defaults to 1.
4254 Set cell mold speed. If set, a dead cell will go from @option{death_color} to
4255 @option{mold_color} with a step of @option{mold}. @option{mold} can have a
4256 value from 0 to 255.
4259 Set the color of living (or new born) cells.
4262 Set the color of dead cells. If @option{mold} is set, this is the first color
4263 used to represent a dead cell.
4266 Set mold color, for definitely dead and moldy cells.
4269 @subsection Examples
4273 Read a grid from @file{pattern}, and center it on a grid of size
4276 life=f=pattern:s=300x300
4280 Generate a random grid of size 200x200, with a fill ratio of 2/3:
4282 life=ratio=2/3:s=200x200
4286 Specify a custom rule for evolving a randomly generated grid:
4292 Full example with slow death effect (mold) using @command{ffplay}:
4294 ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
4298 @section color, nullsrc, rgbtestsrc, smptebars, testsrc
4300 The @code{color} source provides an uniformly colored input.
4302 The @code{nullsrc} source returns unprocessed video frames. It is
4303 mainly useful to be employed in analysis / debugging tools, or as the
4304 source for filters which ignore the input data.
4306 The @code{rgbtestsrc} source generates an RGB test pattern useful for
4307 detecting RGB vs BGR issues. You should see a red, green and blue
4308 stripe from top to bottom.
4310 The @code{smptebars} source generates a color bars pattern, based on
4311 the SMPTE Engineering Guideline EG 1-1990.
4313 The @code{testsrc} source generates a test video pattern, showing a
4314 color pattern, a scrolling gradient and a timestamp. This is mainly
4315 intended for testing purposes.
4317 These sources accept an optional sequence of @var{key}=@var{value} pairs,
4318 separated by ":". The description of the accepted options follows.
4323 Specify the color of the source, only used in the @code{color}
4324 source. It can be the name of a color (case insensitive match) or a
4325 0xRRGGBB[AA] sequence, possibly followed by an alpha specifier. The
4326 default value is "black".
4329 Specify the size of the sourced video, it may be a string of the form
4330 @var{width}x@var{height}, or the name of a size abbreviation. The
4331 default value is "320x240".
4334 Specify the frame rate of the sourced video, as the number of frames
4335 generated per second. It has to be a string in the format
4336 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
4337 number or a valid video frame rate abbreviation. The default value is
4341 Set the sample aspect ratio of the sourced video.
4344 Set the video duration of the sourced video. The accepted syntax is:
4346 [-]HH[:MM[:SS[.m...]]]
4349 See also the function @code{av_parse_time()}.
4351 If not specified, or the expressed duration is negative, the video is
4352 supposed to be generated forever.
4355 Set the number of decimals to show in the timestamp, only used in the
4356 @code{testsrc} source.
4358 The displayed timestamp value will correspond to the original
4359 timestamp value multiplied by the power of 10 of the specified
4360 value. Default value is 0.
4363 For example the following:
4365 testsrc=duration=5.3:size=qcif:rate=10
4368 will generate a video with a duration of 5.3 seconds, with size
4369 176x144 and a frame rate of 10 frames per second.
4371 The following graph description will generate a red source
4372 with an opacity of 0.2, with size "qcif" and a frame rate of 10
4375 color=c=red@@0.2:s=qcif:r=10
4378 If the input content is to be ignored, @code{nullsrc} can be used. The
4379 following command generates noise in the luminance plane by employing
4380 the @code{mp=geq} filter:
4382 nullsrc=s=256x256, mp=geq=random(1)*255:128:128
4385 @c man end VIDEO SOURCES
4387 @chapter Video Sinks
4388 @c man begin VIDEO SINKS
4390 Below is a description of the currently available video sinks.
4394 Buffer video frames, and make them available to the end of the filter
4397 This sink is mainly intended for a programmatic use, in particular
4398 through the interface defined in @file{libavfilter/buffersink.h}.
4400 It does not require a string parameter in input, but you need to
4401 specify a pointer to a list of supported pixel formats terminated by
4402 -1 in the opaque parameter provided to @code{avfilter_init_filter}
4403 when initializing this sink.
4407 Null video sink, do absolutely nothing with the input video. It is
4408 mainly useful as a template and to be employed in analysis / debugging
4411 @c man end VIDEO SINKS
4413 @chapter Multimedia Filters
4414 @c man begin MULTIMEDIA FILTERS
4416 Below is a description of the currently available multimedia filters.
4418 @section asendcmd, sendcmd
4420 Send commands to filters in the filtergraph.
4422 These filters read commands to be sent to other filters in the
4425 @code{asendcmd} must be inserted between two audio filters,
4426 @code{sendcmd} must be inserted between two video filters, but apart
4427 from that they act the same way.
4429 The specification of commands can be provided in the filter arguments
4430 with the @var{commands} option, or in a file specified by the
4431 @var{filename} option.
4433 These filters accept the following options:
4436 Set the commands to be read and sent to the other filters.
4438 Set the filename of the commands to be read and sent to the other
4442 @subsection Commands syntax
4444 A commands description consists of a sequence of interval
4445 specifications, comprising a list of commands to be executed when a
4446 particular event related to that interval occurs. The occurring event
4447 is typically the current frame time entering or leaving a given time
4450 An interval is specified by the following syntax:
4452 @var{START}[-@var{END}] @var{COMMANDS};
4455 The time interval is specified by the @var{START} and @var{END} times.
4456 @var{END} is optional and defaults to the maximum time.
4458 The current frame time is considered within the specified interval if
4459 it is included in the interval [@var{START}, @var{END}), that is when
4460 the time is greater or equal to @var{START} and is lesser than
4463 @var{COMMANDS} consists of a sequence of one or more command
4464 specifications, separated by ",", relating to that interval. The
4465 syntax of a command specification is given by:
4467 [@var{FLAGS}] @var{TARGET} @var{COMMAND} @var{ARG}
4470 @var{FLAGS} is optional and specifies the type of events relating to
4471 the time interval which enable sending the specified command, and must
4472 be a non-null sequence of identifier flags separated by "+" or "|" and
4473 enclosed between "[" and "]".
4475 The following flags are recognized:
4478 The command is sent when the current frame timestamp enters the
4479 specified interval. In other words, the command is sent when the
4480 previous frame timestamp was not in the given interval, and the
4484 The command is sent when the current frame timestamp leaves the
4485 specified interval. In other words, the command is sent when the
4486 previous frame timestamp was in the given interval, and the
4490 If @var{FLAGS} is not specified, a default value of @code{[enter]} is
4493 @var{TARGET} specifies the target of the command, usually the name of
4494 the filter class or a specific filter instance name.
4496 @var{COMMAND} specifies the name of the command for the target filter.
4498 @var{ARG} is optional and specifies the optional list of argument for
4499 the given @var{COMMAND}.
4501 Between one interval specification and another, whitespaces, or
4502 sequences of characters starting with @code{#} until the end of line,
4503 are ignored and can be used to annotate comments.
4505 A simplified BNF description of the commands specification syntax
4508 @var{COMMAND_FLAG} ::= "enter" | "leave"
4509 @var{COMMAND_FLAGS} ::= @var{COMMAND_FLAG} [(+|"|")@var{COMMAND_FLAG}]
4510 @var{COMMAND} ::= ["[" @var{COMMAND_FLAGS} "]"] @var{TARGET} @var{COMMAND} [@var{ARG}]
4511 @var{COMMANDS} ::= @var{COMMAND} [,@var{COMMANDS}]
4512 @var{INTERVAL} ::= @var{START}[-@var{END}] @var{COMMANDS}
4513 @var{INTERVALS} ::= @var{INTERVAL}[;@var{INTERVALS}]
4516 @subsection Examples
4520 Specify audio tempo change at second 4:
4522 asendcmd=c='4.0 atempo tempo 1.5',atempo
4526 Specify a list of drawtext and hue commands in a file.
4528 # show text in the interval 5-10
4529 5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
4530 [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
4532 # desaturate the image in the interval 15-20
4533 15.0-20.0 [enter] hue reinit s=0,
4534 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
4535 [leave] hue reinit s=1,
4536 [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
4538 # apply an exponential saturation fade-out effect, starting from time 25
4539 25 [enter] hue s=exp(t-25)
4542 A filtergraph allowing to read and process the above command list
4543 stored in a file @file{test.cmd}, can be specified with:
4545 sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
4549 @section asetpts, setpts
4551 Change the PTS (presentation timestamp) of the input frames.
4553 @code{asetpts} works on audio frames, @code{setpts} on video frames.
4555 Accept in input an expression evaluated through the eval API, which
4556 can contain the following constants:
4560 frame rate, only defined for constant frame-rate video
4563 the presentation timestamp in input
4566 the count of the input frame, starting from 0.
4568 @item NB_CONSUMED_SAMPLES
4569 the number of consumed samples, not including the current frame (only
4573 the number of samples in the current frame (only audio)
4579 the PTS of the first frame
4582 the time in seconds of the first frame
4585 tell if the current frame is interlaced
4588 the time in seconds of the current frame
4594 original position in the file of the frame, or undefined if undefined
4595 for the current frame
4601 previous input time in seconds
4607 previous output time in seconds
4610 @subsection Examples
4614 Start counting PTS from zero
4620 Apply fast motion effect:
4626 Apply slow motion effect:
4632 Set fixed rate of 25 frames per second:
4638 Set fixed rate 25 fps with some jitter:
4640 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
4644 Apply an offset of 10 seconds to the input PTS:
4652 EBU R128 scanner filter. This filter takes an audio stream as input and outputs
4653 it unchanged. By default, it logs a message at a frequency of 10Hz with the
4654 Momentary loudness (identified by @code{M}), Short-term loudness (@code{S}),
4655 Integrated loudness (@code{I}) and Loudness Range (@code{LRA}).
4657 The filter also has a video output (see the @var{video} option) with a real
4658 time graph to observe the loudness evolution. The graphic contains the logged
4659 message mentioned above, so it is not printed anymore when this option is set,
4660 unless the verbose logging is set. The main graphing area contains the
4661 short-term loudness (3 seconds of analysis), and the gauge on the right is for
4662 the momentary loudness (400 milliseconds).
4664 More information about the Loudness Recommendation EBU R128 on
4665 @url{http://tech.ebu.ch/loudness}.
4667 The filter accepts the following named parameters:
4672 Activate the video output. The audio stream is passed unchanged whether this
4673 option is set or no. The video stream will be the first output stream if
4674 activated. Default is @code{0}.
4677 Set the video size. This option is for video only. Default and minimum
4678 resolution is @code{640x480}.
4681 Set the EBU scale meter. Default is @code{9}. Common values are @code{9} and
4682 @code{18}, respectively for EBU scale meter +9 and EBU scale meter +18. Any
4683 other integer value between this range is allowed.
4687 Example of real-time graph using @command{ffplay}, with a EBU scale meter +18:
4689 ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
4692 Run an analysis with @command{ffmpeg}:
4694 ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
4697 @section settb, asettb
4699 Set the timebase to use for the output frames timestamps.
4700 It is mainly useful for testing timebase configuration.
4702 It accepts in input an arithmetic expression representing a rational.
4703 The expression can contain the constants "AVTB" (the
4704 default timebase), "intb" (the input timebase) and "sr" (the sample rate,
4707 The default value for the input is "intb".
4709 @subsection Examples
4713 Set the timebase to 1/25:
4719 Set the timebase to 1/10:
4725 Set the timebase to 1001/1000:
4731 Set the timebase to 2*intb:
4737 Set the default timebase value:
4745 Concatenate audio and video streams, joining them together one after the
4748 The filter works on segments of synchronized video and audio streams. All
4749 segments must have the same number of streams of each type, and that will
4750 also be the number of streams at output.
4752 The filter accepts the following named parameters:
4756 Set the number of segments. Default is 2.
4759 Set the number of output video streams, that is also the number of video
4760 streams in each segment. Default is 1.
4763 Set the number of output audio streams, that is also the number of video
4764 streams in each segment. Default is 0.
4767 Activate unsafe mode: do not fail if segments have a different format.
4771 The filter has @var{v}+@var{a} outputs: first @var{v} video outputs, then
4772 @var{a} audio outputs.
4774 There are @var{n}×(@var{v}+@var{a}) inputs: first the inputs for the first
4775 segment, in the same order as the outputs, then the inputs for the second
4778 Related streams do not always have exactly the same duration, for various
4779 reasons including codec frame size or sloppy authoring. For that reason,
4780 related synchronized streams (e.g. a video and its audio track) should be
4781 concatenated at once. The concat filter will use the duration of the longest
4782 stream in each segment (except the last one), and if necessary pad shorter
4783 audio streams with silence.
4785 For this filter to work correctly, all segments must start at timestamp 0.
4787 All corresponding streams must have the same parameters in all segments; the
4788 filtering system will automatically select a common pixel format for video
4789 streams, and a common sample format, sample rate and channel layout for
4790 audio streams, but other settings, such as resolution, must be converted
4791 explicitly by the user.
4793 Different frame rates are acceptable but will result in variable frame rate
4794 at output; be sure to configure the output file to handle it.
4799 Concatenate an opening, an episode and an ending, all in bilingual version
4800 (video in stream 0, audio in streams 1 and 2):
4802 ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
4803 '[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
4804 concat=n=3:v=1:a=2 [v] [a1] [a2]' \
4805 -map '[v]' -map '[a1]' -map '[a2]' output.mkv
4809 Concatenate two parts, handling audio and video separately, using the
4810 (a)movie sources, and adjusting the resolution:
4812 movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
4813 movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
4814 [v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
4816 Note that a desync will happen at the stitch if the audio and video streams
4817 do not have exactly the same duration in the first file.
4821 @section showspectrum
4823 Convert input audio to a video output, representing the audio frequency
4826 The filter accepts the following named parameters:
4829 Specify the video size for the output. Default value is @code{640x480}.
4831 Specify if the spectrum should slide along the window. Default value is
4835 The usage is very similar to the showwaves filter; see the examples in that
4840 Convert input audio to a video output, representing the samples waves.
4842 The filter accepts the following named parameters:
4846 Set the number of samples which are printed on the same column. A
4847 larger value will decrease the frame rate. Must be a positive
4848 integer. This option can be set only if the value for @var{rate}
4849 is not explicitly specified.
4852 Set the (approximate) output frame rate. This is done by setting the
4853 option @var{n}. Default value is "25".
4856 Specify the video size for the output. Default value is "600x240".
4859 Some examples follow.
4862 Output the input file audio and the corresponding video representation
4865 amovie=a.mp3,asplit[out0],showwaves[out1]
4869 Create a synthetic signal and show it with showwaves, forcing a
4870 framerate of 30 frames per second:
4872 aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
4876 @c man end MULTIMEDIA FILTERS
4878 @chapter Multimedia Sources
4879 @c man begin MULTIMEDIA SOURCES
4881 Below is a description of the currently available multimedia sources.
4885 This is the same as @ref{src_movie} source, except it selects an audio
4891 Read audio and/or video stream(s) from a movie container.
4893 It accepts the syntax: @var{movie_name}[:@var{options}] where
4894 @var{movie_name} is the name of the resource to read (not necessarily
4895 a file but also a device or a stream accessed through some protocol),
4896 and @var{options} is an optional sequence of @var{key}=@var{value}
4897 pairs, separated by ":".
4899 The description of the accepted options follows.
4903 @item format_name, f
4904 Specifies the format assumed for the movie to read, and can be either
4905 the name of a container or an input device. If not specified the
4906 format is guessed from @var{movie_name} or by probing.
4908 @item seek_point, sp
4909 Specifies the seek point in seconds, the frames will be output
4910 starting from this seek point, the parameter is evaluated with
4911 @code{av_strtod} so the numerical value may be suffixed by an IS
4912 postfix. Default value is "0".
4915 Specifies the streams to read. Several streams can be specified, separated
4916 by "+". The source will then have as many outputs, in the same order. The
4917 syntax is explained in the @ref{Stream specifiers} chapter. Two special
4918 names, "dv" and "da" specify respectively the default (best suited) video
4919 and audio stream. Default is "dv", or "da" if the filter is called as
4922 @item stream_index, si
4923 Specifies the index of the video stream to read. If the value is -1,
4924 the best suited video stream will be automatically selected. Default
4925 value is "-1". Deprecated. If the filter is called "amovie", it will select
4926 audio instead of video.
4929 Specifies how many times to read the stream in sequence.
4930 If the value is less than 1, the stream will be read again and again.
4931 Default value is "1".
4933 Note that when the movie is looped the source timestamps are not
4934 changed, so it will generate non monotonically increasing timestamps.
4937 This filter allows to overlay a second video on top of main input of
4938 a filtergraph as shown in this graph:
4940 input -----------> deltapts0 --> overlay --> output
4943 movie --> scale--> deltapts1 -------+
4946 Some examples follow.
4950 Skip 3.2 seconds from the start of the avi file in.avi, and overlay it
4951 on top of the input labelled as "in":
4953 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
4954 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
4958 Read from a video4linux2 device, and overlay it on top of the input
4961 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
4962 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
4966 Read the first video stream and the audio stream with id 0x81 from
4967 dvd.vob; the video is connected to the pad named "video" and the audio is
4968 connected to the pad named "audio":
4970 movie=dvd.vob:s=v:0+#0x81 [video] [audio]
4974 @c man end MULTIMEDIA SOURCES