Use modern avconv syntax for codec selection in documentation and tests
[ffmpeg.git] / doc / filters.texi
1 @chapter Filtergraph description
2 @c man begin FILTERGRAPH DESCRIPTION
3
4 A filtergraph is a directed graph of connected filters. It can contain
5 cycles, and there can be multiple links between a pair of
6 filters. Each link has one input pad on one side connecting it to one
7 filter from which it takes its input, and one output pad on the other
8 side connecting it to one filter accepting its output.
9
10 Each filter in a filtergraph is an instance of a filter class
11 registered in the application, which defines the features and the
12 number of input and output pads of the filter.
13
14 A filter with no input pads is called a "source", and a filter with no
15 output pads is called a "sink".
16
17 @anchor{Filtergraph syntax}
18 @section Filtergraph syntax
19
20 A filtergraph has a textual representation, which is
21 recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
22 options in @command{avconv} and @option{-vf} in @command{avplay}, and by the
23 @code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} functions defined in
24 @file{libavfilter/avfilter.h}.
25
26 A filterchain consists of a sequence of connected filters, each one
27 connected to the previous one in the sequence. A filterchain is
28 represented by a list of ","-separated filter descriptions.
29
30 A filtergraph consists of a sequence of filterchains. A sequence of
31 filterchains is represented by a list of ";"-separated filterchain
32 descriptions.
33
34 A filter is represented by a string of the form:
35 [@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]
36
37 @var{filter_name} is the name of the filter class of which the
38 described filter is an instance of, and has to be the name of one of
39 the filter classes registered in the program.
40 The name of the filter class is optionally followed by a string
41 "=@var{arguments}".
42
43 @var{arguments} is a string which contains the parameters used to
44 initialize the filter instance. It may have one of two forms:
45 @itemize
46
47 @item
48 A ':'-separated list of @var{key=value} pairs.
49
50 @item
51 A ':'-separated list of @var{value}. In this case, the keys are assumed to be
52 the option names in the order they are declared. E.g. the @code{fade} filter
53 declares three options in this order -- @option{type}, @option{start_frame} and
54 @option{nb_frames}. Then the parameter list @var{in:0:30} means that the value
55 @var{in} is assigned to the option @option{type}, @var{0} to
56 @option{start_frame} and @var{30} to @option{nb_frames}.
57
58 @end itemize
59
60 If the option value itself is a list of items (e.g. the @code{format} filter
61 takes a list of pixel formats), the items in the list are usually separated by
62 '|'.
63
64 The list of arguments can be quoted using the character "'" as initial
65 and ending mark, and the character '\' for escaping the characters
66 within the quoted text; otherwise the argument string is considered
67 terminated when the next special character (belonging to the set
68 "[]=;,") is encountered.
69
70 The name and arguments of the filter are optionally preceded and
71 followed by a list of link labels.
72 A link label allows to name a link and associate it to a filter output
73 or input pad. The preceding labels @var{in_link_1}
74 ... @var{in_link_N}, are associated to the filter input pads,
75 the following labels @var{out_link_1} ... @var{out_link_M}, are
76 associated to the output pads.
77
78 When two link labels with the same name are found in the
79 filtergraph, a link between the corresponding input and output pad is
80 created.
81
82 If an output pad is not labelled, it is linked by default to the first
83 unlabelled input pad of the next filter in the filterchain.
84 For example in the filterchain
85 @example
86 nullsrc, split[L1], [L2]overlay, nullsink
87 @end example
88 the split filter instance has two output pads, and the overlay filter
89 instance two input pads. The first output pad of split is labelled
90 "L1", the first input pad of overlay is labelled "L2", and the second
91 output pad of split is linked to the second input pad of overlay,
92 which are both unlabelled.
93
94 In a complete filterchain all the unlabelled filter input and output
95 pads must be connected. A filtergraph is considered valid if all the
96 filter input and output pads of all the filterchains are connected.
97
98 Libavfilter will automatically insert @ref{scale} filters where format
99 conversion is required. It is possible to specify swscale flags
100 for those automatically inserted scalers by prepending
101 @code{sws_flags=@var{flags};}
102 to the filtergraph description.
103
104 Here is a BNF description of the filtergraph syntax:
105 @example
106 @var{NAME}             ::= sequence of alphanumeric characters and '_'
107 @var{LINKLABEL}        ::= "[" @var{NAME} "]"
108 @var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
109 @var{FILTER_ARGUMENTS} ::= sequence of chars (possibly quoted)
110 @var{FILTER}           ::= [@var{LINKLABELS}] @var{NAME} ["=" @var{FILTER_ARGUMENTS}] [@var{LINKLABELS}]
111 @var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
112 @var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
113 @end example
114
115 @c man end FILTERGRAPH DESCRIPTION
116
117 @chapter Audio Filters
118 @c man begin AUDIO FILTERS
119
120 When you configure your Libav build, you can disable any of the
121 existing filters using --disable-filters.
122 The configure output will show the audio filters included in your
123 build.
124
125 Below is a description of the currently available audio filters.
126
127 @section aformat
128
129 Convert the input audio to one of the specified formats. The framework will
130 negotiate the most appropriate format to minimize conversions.
131
132 It accepts the following parameters:
133 @table @option
134
135 @item sample_fmts
136 A '|'-separated list of requested sample formats.
137
138 @item sample_rates
139 A '|'-separated list of requested sample rates.
140
141 @item channel_layouts
142 A '|'-separated list of requested channel layouts.
143
144 @end table
145
146 If a parameter is omitted, all values are allowed.
147
148 Force the output to either unsigned 8-bit or signed 16-bit stereo
149 @example
150 aformat=sample_fmts=u8|s16:channel_layouts=stereo
151 @end example
152
153 @section amix
154
155 Mixes multiple audio inputs into a single output.
156
157 For example
158 @example
159 avconv -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
160 @end example
161 will mix 3 input audio streams to a single output with the same duration as the
162 first input and a dropout transition time of 3 seconds.
163
164 It accepts the following parameters:
165 @table @option
166
167 @item inputs
168 The number of inputs. If unspecified, it defaults to 2.
169
170 @item duration
171 How to determine the end-of-stream.
172 @table @option
173
174 @item longest
175 The duration of the longest input. (default)
176
177 @item shortest
178 The duration of the shortest input.
179
180 @item first
181 The duration of the first input.
182
183 @end table
184
185 @item dropout_transition
186 The transition time, in seconds, for volume renormalization when an input
187 stream ends. The default value is 2 seconds.
188
189 @end table
190
191 @section anull
192
193 Pass the audio source unchanged to the output.
194
195 @section asetpts
196
197 Change the PTS (presentation timestamp) of the input audio frames.
198
199 It accepts the following parameters:
200
201 @table @option
202
203 @item expr
204 The expression which is evaluated for each frame to construct its timestamp.
205
206 @end table
207
208 The expression is evaluated through the eval API and can contain the following
209 constants:
210
211 @table @option
212 @item FRAME_RATE
213 frame rate, only defined for constant frame-rate video
214
215 @item PTS
216 the presentation timestamp in input
217
218 @item E, PI, PHI
219 These are approximated values for the mathematical constants e
220 (Euler's number), pi (Greek pi), and phi (the golden ratio).
221
222 @item N
223 The number of audio samples passed through the filter so far, starting at 0.
224
225 @item S
226 The number of audio samples in the current frame.
227
228 @item SR
229 The audio sample rate.
230
231 @item STARTPTS
232 The PTS of the first frame.
233
234 @item PREV_INPTS
235 The previous input PTS.
236
237 @item PREV_OUTPTS
238 The previous output PTS.
239
240 @item RTCTIME
241 The wallclock (RTC) time in microseconds.
242
243 @item RTCSTART
244 The wallclock (RTC) time at the start of the movie in microseconds.
245
246 @end table
247
248 Some examples:
249
250 @example
251 # Start counting PTS from zero
252 asetpts=expr=PTS-STARTPTS
253
254 # Generate timestamps by counting samples
255 asetpts=expr=N/SR/TB
256
257 # Generate timestamps from a "live source" and rebase onto the current timebase
258 asetpts='(RTCTIME - RTCSTART) / (TB * 1000000)"
259 @end example
260
261 @section asettb
262
263 Set the timebase to use for the output frames timestamps.
264 It is mainly useful for testing timebase configuration.
265
266 This filter accepts the following parameters:
267
268 @table @option
269
270 @item expr
271 The expression which is evaluated into the output timebase.
272
273 @end table
274
275 The expression can contain the constants @var{PI}, @var{E}, @var{PHI}, @var{AVTB} (the
276 default timebase), @var{intb} (the input timebase), and @var{sr} (the sample rate,
277 audio only).
278
279 The default value for the input is @var{intb}.
280
281 Some examples:
282
283 @example
284 # Set the timebase to 1/25:
285 settb=1/25
286
287 # Set the timebase to 1/10:
288 settb=0.1
289
290 # Set the timebase to 1001/1000:
291 settb=1+0.001
292
293 # Set the timebase to 2*intb:
294 settb=2*intb
295
296 # Set the default timebase value:
297 settb=AVTB
298
299 # Set the timebase to twice the sample rate:
300 asettb=sr*2
301 @end example
302
303 @section ashowinfo
304
305 Show a line containing various information for each input audio frame.
306 The input audio is not modified.
307
308 The shown line contains a sequence of key/value pairs of the form
309 @var{key}:@var{value}.
310
311 It accepts the following parameters:
312
313 @table @option
314 @item n
315 The (sequential) number of the input frame, starting from 0.
316
317 @item pts
318 The presentation timestamp of the input frame, in time base units; the time base
319 depends on the filter input pad, and is usually 1/@var{sample_rate}.
320
321 @item pts_time
322 The presentation timestamp of the input frame in seconds.
323
324 @item fmt
325 The sample format.
326
327 @item chlayout
328 The channel layout.
329
330 @item rate
331 The sample rate for the audio frame.
332
333 @item nb_samples
334 The number of samples (per channel) in the frame.
335
336 @item checksum
337 The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
338 audio, the data is treated as if all the planes were concatenated.
339
340 @item plane_checksums
341 A list of Adler-32 checksums for each data plane.
342 @end table
343
344 @section asplit
345
346 Split input audio into several identical outputs.
347
348 It accepts a single parameter, which specifies the number of outputs. If
349 unspecified, it defaults to 2.
350
351 For example,
352 @example
353 avconv -i INPUT -filter_complex asplit=5 OUTPUT
354 @end example
355 will create 5 copies of the input audio.
356
357 @section asyncts
358 Synchronize audio data with timestamps by squeezing/stretching it and/or
359 dropping samples/adding silence when needed.
360
361 It accepts the following parameters:
362 @table @option
363
364 @item compensate
365 Enable stretching/squeezing the data to make it match the timestamps. Disabled
366 by default. When disabled, time gaps are covered with silence.
367
368 @item min_delta
369 The minimum difference between timestamps and audio data (in seconds) to trigger
370 adding/dropping samples. The default value is 0.1. If you get an imperfect
371 sync with this filter, try setting this parameter to 0.
372
373 @item max_comp
374 The maximum compensation in samples per second. Only relevant with compensate=1.
375 The default value is 500.
376
377 @item first_pts
378 Assume that the first PTS should be this value. The time base is 1 / sample
379 rate. This allows for padding/trimming at the start of the stream. By default,
380 no assumption is made about the first frame's expected PTS, so no padding or
381 trimming is done. For example, this could be set to 0 to pad the beginning with
382 silence if an audio stream starts after the video stream or to trim any samples
383 with a negative PTS due to encoder delay.
384
385 @end table
386
387 @section atrim
388 Trim the input so that the output contains one continuous subpart of the input.
389
390 It accepts the following parameters:
391 @table @option
392 @item start
393 Timestamp (in seconds) of the start of the section to keep. I.e. the audio
394 sample with the timestamp @var{start} will be the first sample in the output.
395
396 @item end
397 Timestamp (in seconds) of the first audio sample that will be dropped. I.e. the
398 audio sample immediately preceding the one with the timestamp @var{end} will be
399 the last sample in the output.
400
401 @item start_pts
402 Same as @var{start}, except this option sets the start timestamp in samples
403 instead of seconds.
404
405 @item end_pts
406 Same as @var{end}, except this option sets the end timestamp in samples instead
407 of seconds.
408
409 @item duration
410 The maximum duration of the output in seconds.
411
412 @item start_sample
413 The number of the first sample that should be output.
414
415 @item end_sample
416 The number of the first sample that should be dropped.
417 @end table
418
419 Note that the first two sets of the start/end options and the @option{duration}
420 option look at the frame timestamp, while the _sample options simply count the
421 samples that pass through the filter. So start/end_pts and start/end_sample will
422 give different results when the timestamps are wrong, inexact or do not start at
423 zero. Also note that this filter does not modify the timestamps. If you wish
424 to have the output timestamps start at zero, insert the asetpts filter after the
425 atrim filter.
426
427 If multiple start or end options are set, this filter tries to be greedy and
428 keep all samples that match at least one of the specified constraints. To keep
429 only the part that matches all the constraints at once, chain multiple atrim
430 filters.
431
432 The defaults are such that all the input is kept. So it is possible to set e.g.
433 just the end values to keep everything before the specified time.
434
435 Examples:
436 @itemize
437 @item
438 Drop everything except the second minute of input:
439 @example
440 avconv -i INPUT -af atrim=60:120
441 @end example
442
443 @item
444 Keep only the first 1000 samples:
445 @example
446 avconv -i INPUT -af atrim=end_sample=1000
447 @end example
448
449 @end itemize
450
451 @section bs2b
452 Bauer stereo to binaural transformation, which improves headphone listening of
453 stereo audio records.
454
455 It accepts the following parameters:
456 @table @option
457
458 @item profile
459 Pre-defined crossfeed level.
460 @table @option
461
462 @item default
463 Default level (fcut=700, feed=50).
464
465 @item cmoy
466 Chu Moy circuit (fcut=700, feed=60).
467
468 @item jmeier
469 Jan Meier circuit (fcut=650, feed=95).
470
471 @end table
472
473 @item fcut
474 Cut frequency (in Hz).
475
476 @item feed
477 Feed level (in Hz).
478
479 @end table
480
481 @section channelsplit
482 Split each channel from an input audio stream into a separate output stream.
483
484 It accepts the following parameters:
485 @table @option
486 @item channel_layout
487 The channel layout of the input stream. The default is "stereo".
488 @end table
489
490 For example, assuming a stereo input MP3 file,
491 @example
492 avconv -i in.mp3 -filter_complex channelsplit out.mkv
493 @end example
494 will create an output Matroska file with two audio streams, one containing only
495 the left channel and the other the right channel.
496
497 Split a 5.1 WAV file into per-channel files:
498 @example
499 avconv -i in.wav -filter_complex
500 'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
501 -map '[FL]' front_left.wav -map '[FR]' front_right.wav
502 -map '[FC]' front_center.wav -map '[LFE]' low_frequency_effects.wav
503 -map '[SL]' side_left.wav -map '[SR]' side_right.wav
504 @end example
505
506 @section channelmap
507 Remap input channels to new locations.
508
509 It accepts the following parameters:
510 @table @option
511 @item channel_layout
512 The channel layout of the output stream.
513
514 @item map
515 Map channels from input to output. The argument is a '|'-separated list of
516 mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
517 @var{in_channel} form. @var{in_channel} can be either the name of the input
518 channel (e.g. FL for front left) or its index in the input channel layout.
519 @var{out_channel} is the name of the output channel or its index in the output
520 channel layout. If @var{out_channel} is not given then it is implicitly an
521 index, starting with zero and increasing by one for each mapping.
522 @end table
523
524 If no mapping is present, the filter will implicitly map input channels to
525 output channels, preserving indices.
526
527 For example, assuming a 5.1+downmix input MOV file,
528 @example
529 avconv -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
530 @end example
531 will create an output WAV file tagged as stereo from the downmix channels of
532 the input.
533
534 To fix a 5.1 WAV improperly encoded in AAC's native channel order
535 @example
536 avconv -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
537 @end example
538
539 @section compand
540 Compress or expand the audio's dynamic range.
541
542 It accepts the following parameters:
543
544 @table @option
545
546 @item attacks
547 @item decays
548 A list of times in seconds for each channel over which the instantaneous level
549 of the input signal is averaged to determine its volume. @var{attacks} refers to
550 increase of volume and @var{decays} refers to decrease of volume. For most
551 situations, the attack time (response to the audio getting louder) should be
552 shorter than the decay time, because the human ear is more sensitive to sudden
553 loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
554 a typical value for decay is 0.8 seconds.
555
556 @item points
557 A list of points for the transfer function, specified in dB relative to the
558 maximum possible signal amplitude. Each key points list must be defined using
559 the following syntax: @code{x0/y0|x1/y1|x2/y2|....}
560
561 The input values must be in strictly increasing order but the transfer function
562 does not have to be monotonically rising. The point @code{0/0} is assumed but
563 may be overridden (by @code{0/out-dBn}). Typical values for the transfer
564 function are @code{-70/-70|-60/-20}.
565
566 @item soft-knee
567 Set the curve radius in dB for all joints. It defaults to 0.01.
568
569 @item gain
570 Set the additional gain in dB to be applied at all points on the transfer
571 function. This allows for easy adjustment of the overall gain.
572 It defaults to 0.
573
574 @item volume
575 Set an initial volume, in dB, to be assumed for each channel when filtering
576 starts. This permits the user to supply a nominal level initially, so that, for
577 example, a very large gain is not applied to initial signal levels before the
578 companding has begun to operate. A typical value for audio which is initially
579 quiet is -90 dB. It defaults to 0.
580
581 @item delay
582 Set a delay, in seconds. The input audio is analyzed immediately, but audio is
583 delayed before being fed to the volume adjuster. Specifying a delay
584 approximately equal to the attack/decay times allows the filter to effectively
585 operate in predictive rather than reactive mode. It defaults to 0.
586
587 @end table
588
589 @subsection Examples
590
591 @itemize
592 @item
593 Make music with both quiet and loud passages suitable for listening to in a
594 noisy environment:
595 @example
596 compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
597 @end example
598
599 @item
600 A noise gate for when the noise is at a lower level than the signal:
601 @example
602 compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
603 @end example
604
605 @item
606 Here is another noise gate, this time for when the noise is at a higher level
607 than the signal (making it, in some ways, similar to squelch):
608 @example
609 compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
610 @end example
611 @end itemize
612
613 @section join
614 Join multiple input streams into one multi-channel stream.
615
616 It accepts the following parameters:
617 @table @option
618
619 @item inputs
620 The number of input streams. It defaults to 2.
621
622 @item channel_layout
623 The desired output channel layout. It defaults to stereo.
624
625 @item map
626 Map channels from inputs to output. The argument is a '|'-separated list of
627 mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
628 form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
629 can be either the name of the input channel (e.g. FL for front left) or its
630 index in the specified input stream. @var{out_channel} is the name of the output
631 channel.
632 @end table
633
634 The filter will attempt to guess the mappings when they are not specified
635 explicitly. It does so by first trying to find an unused matching input channel
636 and if that fails it picks the first unused input channel.
637
638 Join 3 inputs (with properly set channel layouts):
639 @example
640 avconv -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
641 @end example
642
643 Build a 5.1 output from 6 single-channel streams:
644 @example
645 avconv -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
646 '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'
647 out
648 @end example
649
650 @section hdcd
651
652 Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with
653 embedded HDCD codes is expanded into a 20-bit PCM stream.
654
655 The filter supports the Peak Extend and Low-level Gain Adjustment features
656 of HDCD, and detects the Transient Filter flag.
657
658 @example
659 avconv -i HDCD16.flac -af hdcd OUT24.flac
660 @end example
661
662 When using the filter with WAV, note that the default encoding for WAV is 16-bit,
663 so the resulting 20-bit stream will be truncated back to 16-bit. Use something
664 like @command{-c:a pcm_s24le} after the filter to get 24-bit PCM output.
665 @example
666 avconv -i HDCD16.wav -af hdcd OUT16.wav
667 avconv -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
668 @end example
669
670 The filter accepts the following options:
671
672 @table @option
673 @item analyze_mode
674 Replace audio with a solid tone and adjust the amplitude to signal some
675 specific aspect of the decoding process. The output file can be loaded in
676 an audio editor alongside the original to aid analysis.
677
678 Modes are:
679 @table @samp
680 @item 0, off
681 Disabled
682 @item 1, lle
683 Gain adjustment level at each sample
684 @item 2, pe
685 Samples where peak extend occurs
686 @item 3, cdt
687 Samples where the code detect timer is active
688 @item 4, tgm
689 Samples where the target gain does not match between channels
690 @item 5, pel
691 Any samples above peak extend level
692 @item 6, ltgm
693 Gain adjustment level at each sample, in each channel
694 @end table
695 @end table
696
697 @section resample
698 Convert the audio sample format, sample rate and channel layout. It is
699 not meant to be used directly; it is inserted automatically by libavfilter
700 whenever conversion is needed. Use the @var{aformat} filter to force a specific
701 conversion.
702
703 @section volume
704
705 Adjust the input audio volume.
706
707 It accepts the following parameters:
708 @table @option
709
710 @item volume
711 This expresses how the audio volume will be increased or decreased.
712
713 Output values are clipped to the maximum value.
714
715 The output audio volume is given by the relation:
716 @example
717 @var{output_volume} = @var{volume} * @var{input_volume}
718 @end example
719
720 The default value for @var{volume} is 1.0.
721
722 @item precision
723 This parameter represents the mathematical precision.
724
725 It determines which input sample formats will be allowed, which affects the
726 precision of the volume scaling.
727
728 @table @option
729 @item fixed
730 8-bit fixed-point; this limits input sample format to U8, S16, and S32.
731 @item float
732 32-bit floating-point; this limits input sample format to FLT. (default)
733 @item double
734 64-bit floating-point; this limits input sample format to DBL.
735 @end table
736
737 @item replaygain
738 Choose the behaviour on encountering ReplayGain side data in input frames.
739
740 @table @option
741 @item drop
742 Remove ReplayGain side data, ignoring its contents (the default).
743
744 @item ignore
745 Ignore ReplayGain side data, but leave it in the frame.
746
747 @item track
748 Prefer the track gain, if present.
749
750 @item album
751 Prefer the album gain, if present.
752 @end table
753
754 @item replaygain_preamp
755 Pre-amplification gain in dB to apply to the selected replaygain gain.
756
757 Default value for @var{replaygain_preamp} is 0.0.
758
759 @item replaygain_noclip
760 Prevent clipping by limiting the gain applied.
761
762 Default value for @var{replaygain_noclip} is 1.
763
764 @end table
765
766 @subsection Examples
767
768 @itemize
769 @item
770 Halve the input audio volume:
771 @example
772 volume=volume=0.5
773 volume=volume=1/2
774 volume=volume=-6.0206dB
775 @end example
776
777 @item
778 Increase input audio power by 6 decibels using fixed-point precision:
779 @example
780 volume=volume=6dB:precision=fixed
781 @end example
782 @end itemize
783
784 @c man end AUDIO FILTERS
785
786 @chapter Audio Sources
787 @c man begin AUDIO SOURCES
788
789 Below is a description of the currently available audio sources.
790
791 @section anullsrc
792
793 The null audio source; it never returns audio frames. It is mainly useful as a
794 template and for use in analysis / debugging tools.
795
796 It accepts, as an optional parameter, a string of the form
797 @var{sample_rate}:@var{channel_layout}.
798
799 @var{sample_rate} specifies the sample rate, and defaults to 44100.
800
801 @var{channel_layout} specifies the channel layout, and can be either an
802 integer or a string representing a channel layout. The default value
803 of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
804
805 Check the channel_layout_map definition in
806 @file{libavutil/channel_layout.c} for the mapping between strings and
807 channel layout values.
808
809 Some examples:
810 @example
811 # Set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO
812 anullsrc=48000:4
813
814 # The same as above
815 anullsrc=48000:mono
816 @end example
817
818 @section abuffer
819 Buffer audio frames, and make them available to the filter chain.
820
821 This source is not intended to be part of user-supplied graph descriptions; it
822 is for insertion by calling programs, through the interface defined in
823 @file{libavfilter/buffersrc.h}.
824
825 It accepts the following parameters:
826 @table @option
827
828 @item time_base
829 The timebase which will be used for timestamps of submitted frames. It must be
830 either a floating-point number or in @var{numerator}/@var{denominator} form.
831
832 @item sample_rate
833 The audio sample rate.
834
835 @item sample_fmt
836 The name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
837
838 @item channel_layout
839 The channel layout of the audio data, in the form that can be accepted by
840 @code{av_get_channel_layout()}.
841 @end table
842
843 All the parameters need to be explicitly defined.
844
845 @c man end AUDIO SOURCES
846
847 @chapter Audio Sinks
848 @c man begin AUDIO SINKS
849
850 Below is a description of the currently available audio sinks.
851
852 @section anullsink
853
854 Null audio sink; do absolutely nothing with the input audio. It is
855 mainly useful as a template and for use in analysis / debugging
856 tools.
857
858 @section abuffersink
859 This sink is intended for programmatic use. Frames that arrive on this sink can
860 be retrieved by the calling program, using the interface defined in
861 @file{libavfilter/buffersink.h}.
862
863 It does not accept any parameters.
864
865 @c man end AUDIO SINKS
866
867 @chapter Video Filters
868 @c man begin VIDEO FILTERS
869
870 When you configure your Libav build, you can disable any of the
871 existing filters using --disable-filters.
872 The configure output will show the video filters included in your
873 build.
874
875 Below is a description of the currently available video filters.
876
877 @section blackframe
878
879 Detect frames that are (almost) completely black. Can be useful to
880 detect chapter transitions or commercials. Output lines consist of
881 the frame number of the detected frame, the percentage of blackness,
882 the position in the file if known or -1 and the timestamp in seconds.
883
884 In order to display the output lines, you need to set the loglevel at
885 least to the AV_LOG_INFO value.
886
887 It accepts the following parameters:
888
889 @table @option
890
891 @item amount
892 The percentage of the pixels that have to be below the threshold; it defaults to
893 98.
894
895 @item threshold
896 The threshold below which a pixel value is considered black; it defaults to 32.
897
898 @end table
899
900 @section boxblur
901
902 Apply a boxblur algorithm to the input video.
903
904 It accepts the following parameters:
905
906 @table @option
907
908 @item luma_radius
909 @item luma_power
910 @item chroma_radius
911 @item chroma_power
912 @item alpha_radius
913 @item alpha_power
914
915 @end table
916
917 The chroma and alpha parameters are optional. If not specified, they default
918 to the corresponding values set for @var{luma_radius} and
919 @var{luma_power}.
920
921 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
922 the radius in pixels of the box used for blurring the corresponding
923 input plane. They are expressions, and can contain the following
924 constants:
925 @table @option
926 @item w, h
927 The input width and height in pixels.
928
929 @item cw, ch
930 The input chroma image width and height in pixels.
931
932 @item hsub, vsub
933 The horizontal and vertical chroma subsample values. For example, for the
934 pixel format "yuv422p", @var{hsub} is 2 and @var{vsub} is 1.
935 @end table
936
937 The radius must be a non-negative number, and must not be greater than
938 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
939 and of @code{min(cw,ch)/2} for the chroma planes.
940
941 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
942 how many times the boxblur filter is applied to the corresponding
943 plane.
944
945 Some examples:
946
947 @itemize
948
949 @item
950 Apply a boxblur filter with the luma, chroma, and alpha radii
951 set to 2:
952 @example
953 boxblur=luma_radius=2:luma_power=1
954 @end example
955
956 @item
957 Set the luma radius to 2, and alpha and chroma radius to 0:
958 @example
959 boxblur=2:1:0:0:0:0
960 @end example
961
962 @item
963 Set the luma and chroma radii to a fraction of the video dimension:
964 @example
965 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
966 @end example
967
968 @end itemize
969
970 @section copy
971
972 Copy the input source unchanged to the output. This is mainly useful for
973 testing purposes.
974
975 @section crop
976
977 Crop the input video to given dimensions.
978
979 It accepts the following parameters:
980
981 @table @option
982
983 @item out_w
984 The width of the output video.
985
986 @item out_h
987 The height of the output video.
988
989 @item x
990 The horizontal position, in the input video, of the left edge of the output
991 video.
992
993 @item y
994 The vertical position, in the input video, of the top edge of the output video.
995
996 @end table
997
998 The parameters are expressions containing the following constants:
999
1000 @table @option
1001 @item E, PI, PHI
1002 These are approximated values for the mathematical constants e
1003 (Euler's number), pi (Greek pi), and phi (the golden ratio).
1004
1005 @item x, y
1006 The computed values for @var{x} and @var{y}. They are evaluated for
1007 each new frame.
1008
1009 @item in_w, in_h
1010 The input width and height.
1011
1012 @item iw, ih
1013 These are the same as @var{in_w} and @var{in_h}.
1014
1015 @item out_w, out_h
1016 The output (cropped) width and height.
1017
1018 @item ow, oh
1019 These are the same as @var{out_w} and @var{out_h}.
1020
1021 @item n
1022 The number of the input frame, starting from 0.
1023
1024 @item t
1025 The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
1026
1027 @end table
1028
1029 The @var{out_w} and @var{out_h} parameters specify the expressions for
1030 the width and height of the output (cropped) video. They are only
1031 evaluated during the configuration of the filter.
1032
1033 The default value of @var{out_w} is "in_w", and the default value of
1034 @var{out_h} is "in_h".
1035
1036 The expression for @var{out_w} may depend on the value of @var{out_h},
1037 and the expression for @var{out_h} may depend on @var{out_w}, but they
1038 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
1039 evaluated after @var{out_w} and @var{out_h}.
1040
1041 The @var{x} and @var{y} parameters specify the expressions for the
1042 position of the top-left corner of the output (non-cropped) area. They
1043 are evaluated for each frame. If the evaluated value is not valid, it
1044 is approximated to the nearest valid value.
1045
1046 The default value of @var{x} is "(in_w-out_w)/2", and the default
1047 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
1048 the center of the input image.
1049
1050 The expression for @var{x} may depend on @var{y}, and the expression
1051 for @var{y} may depend on @var{x}.
1052
1053 Some examples:
1054 @example
1055 # Crop the central input area with size 100x100
1056 crop=out_w=100:out_h=100
1057
1058 # Crop the central input area with size 2/3 of the input video
1059 "crop=out_w=2/3*in_w:out_h=2/3*in_h"
1060
1061 # Crop the input video central square
1062 crop=out_w=in_h
1063
1064 # Delimit the rectangle with the top-left corner placed at position
1065 # 100:100 and the right-bottom corner corresponding to the right-bottom
1066 # corner of the input image
1067 crop=out_w=in_w-100:out_h=in_h-100:x=100:y=100
1068
1069 # Crop 10 pixels from the left and right borders, and 20 pixels from
1070 # the top and bottom borders
1071 "crop=out_w=in_w-2*10:out_h=in_h-2*20"
1072
1073 # Keep only the bottom right quarter of the input image
1074 "crop=out_w=in_w/2:out_h=in_h/2:x=in_w/2:y=in_h/2"
1075
1076 # Crop height for getting Greek harmony
1077 "crop=out_w=in_w:out_h=1/PHI*in_w"
1078
1079 # Trembling effect
1080 "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)"
1081
1082 # Erratic camera effect depending on timestamp
1083 "crop=out_w=in_w/2:out_h=in_h/2:x=(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):y=(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
1084
1085 # Set x depending on the value of y
1086 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
1087 @end example
1088
1089 @section cropdetect
1090
1091 Auto-detect the crop size.
1092
1093 It calculates the necessary cropping parameters and prints the
1094 recommended parameters via the logging system. The detected dimensions
1095 correspond to the non-black area of the input video.
1096
1097 It accepts the following parameters:
1098
1099 @table @option
1100
1101 @item limit
1102 The threshold, an optional parameter between nothing (0) and
1103 everything (255). It defaults to 24.
1104
1105 @item round
1106 The value which the width/height should be divisible by. It defaults to
1107 16. The offset is automatically adjusted to center the video. Use 2 to
1108 get only even dimensions (needed for 4:2:2 video). 16 is best when
1109 encoding to most video codecs.
1110
1111 @item reset
1112 A counter that determines how many frames cropdetect will reset
1113 the previously detected largest video area after. It will then start over
1114 and detect the current optimal crop area. It defaults to 0.
1115
1116 This can be useful when channel logos distort the video area. 0
1117 indicates 'never reset', and returns the largest area encountered during
1118 playback.
1119 @end table
1120
1121 @section delogo
1122
1123 Suppress a TV station logo by a simple interpolation of the surrounding
1124 pixels. Just set a rectangle covering the logo and watch it disappear
1125 (and sometimes something even uglier appear - your mileage may vary).
1126
1127 It accepts the following parameters:
1128 @table @option
1129
1130 @item x, y
1131 Specify the top left corner coordinates of the logo. They must be
1132 specified.
1133
1134 @item w, h
1135 Specify the width and height of the logo to clear. They must be
1136 specified.
1137
1138 @item band, t
1139 Specify the thickness of the fuzzy edge of the rectangle (added to
1140 @var{w} and @var{h}). The default value is 4.
1141
1142 @item show
1143 When set to 1, a green rectangle is drawn on the screen to simplify
1144 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
1145 @var{band} is set to 4. The default value is 0.
1146
1147 @end table
1148
1149 An example:
1150
1151 @itemize
1152
1153 @item
1154 Set a rectangle covering the area with top left corner coordinates 0,0
1155 and size 100x77, and a band of size 10:
1156 @example
1157 delogo=x=0:y=0:w=100:h=77:band=10
1158 @end example
1159
1160 @end itemize
1161
1162 @section drawbox
1163
1164 Draw a colored box on the input image.
1165
1166 It accepts the following parameters:
1167
1168 @table @option
1169
1170 @item x, y
1171 Specify the top left corner coordinates of the box. It defaults to 0.
1172
1173 @item width, height
1174 Specify the width and height of the box; if 0 they are interpreted as
1175 the input width and height. It defaults to 0.
1176
1177 @item color
1178 Specify the color of the box to write. It can be the name of a color
1179 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1180 @end table
1181
1182 Some examples:
1183 @example
1184 # Draw a black box around the edge of the input image
1185 drawbox
1186
1187 # Draw a box with color red and an opacity of 50%
1188 drawbox=x=10:y=20:width=200:height=60:color=red@@0.5"
1189 @end example
1190
1191 @section drawtext
1192
1193 Draw a text string or text from a specified file on top of a video, using the
1194 libfreetype library.
1195
1196 To enable compilation of this filter, you need to configure Libav with
1197 @code{--enable-libfreetype}.
1198 To enable default font fallback and the @var{font} option you need to
1199 configure Libav with @code{--enable-libfontconfig}.
1200
1201 The filter also recognizes strftime() sequences in the provided text
1202 and expands them accordingly. Check the documentation of strftime().
1203
1204 It accepts the following parameters:
1205
1206 @table @option
1207
1208 @item font
1209 The font family to be used for drawing text. By default Sans.
1210
1211 @item fontfile
1212 The font file to be used for drawing text. The path must be included.
1213 This parameter is mandatory if the fontconfig support is disabled.
1214
1215 @item text
1216 The text string to be drawn. The text must be a sequence of UTF-8
1217 encoded characters.
1218 This parameter is mandatory if no file is specified with the parameter
1219 @var{textfile}.
1220
1221 @item textfile
1222 A text file containing text to be drawn. The text must be a sequence
1223 of UTF-8 encoded characters.
1224
1225 This parameter is mandatory if no text string is specified with the
1226 parameter @var{text}.
1227
1228 If both text and textfile are specified, an error is thrown.
1229
1230 @item x, y
1231 The offsets where text will be drawn within the video frame.
1232 It is relative to the top/left border of the output image.
1233 They accept expressions similar to the @ref{overlay} filter:
1234 @table @option
1235
1236 @item x, y
1237 The computed values for @var{x} and @var{y}. They are evaluated for
1238 each new frame.
1239
1240 @item main_w, main_h
1241 The main input width and height.
1242
1243 @item W, H
1244 These are the same as @var{main_w} and @var{main_h}.
1245
1246 @item text_w, text_h
1247 The rendered text's width and height.
1248
1249 @item w, h
1250 These are the same as @var{text_w} and @var{text_h}.
1251
1252 @item n
1253 The number of frames processed, starting from 0.
1254
1255 @item t
1256 The timestamp, expressed in seconds. It's NAN if the input timestamp is unknown.
1257
1258 @end table
1259
1260 The default value of @var{x} and @var{y} is 0.
1261
1262 @item draw
1263 Draw the text only if the expression evaluates as non-zero.
1264 The expression accepts the same variables @var{x, y} do.
1265 The default value is 1.
1266
1267 @item alpha
1268 Draw the text applying alpha blending. The value can
1269 be either a number between 0.0 and 1.0
1270 The expression accepts the same variables @var{x, y} do.
1271 The default value is 1.
1272
1273 @item fontsize
1274 The font size to be used for drawing text.
1275 The default value of @var{fontsize} is 16.
1276
1277 @item fontcolor
1278 The color to be used for drawing fonts.
1279 It is either a string (e.g. "red"), or in 0xRRGGBB[AA] format
1280 (e.g. "0xff000033"), possibly followed by an alpha specifier.
1281 The default value of @var{fontcolor} is "black".
1282
1283 @item boxcolor
1284 The color to be used for drawing box around text.
1285 It is either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
1286 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1287 The default value of @var{boxcolor} is "white".
1288
1289 @item box
1290 Used to draw a box around text using the background color.
1291 The value must be either 1 (enable) or 0 (disable).
1292 The default value of @var{box} is 0.
1293
1294 @item shadowx, shadowy
1295 The x and y offsets for the text shadow position with respect to the
1296 position of the text. They can be either positive or negative
1297 values. The default value for both is "0".
1298
1299 @item shadowcolor
1300 The color to be used for drawing a shadow behind the drawn text.  It
1301 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
1302 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1303 The default value of @var{shadowcolor} is "black".
1304
1305 @item ft_load_flags
1306 The flags to be used for loading the fonts.
1307
1308 The flags map the corresponding flags supported by libfreetype, and are
1309 a combination of the following values:
1310 @table @var
1311 @item default
1312 @item no_scale
1313 @item no_hinting
1314 @item render
1315 @item no_bitmap
1316 @item vertical_layout
1317 @item force_autohint
1318 @item crop_bitmap
1319 @item pedantic
1320 @item ignore_global_advance_width
1321 @item no_recurse
1322 @item ignore_transform
1323 @item monochrome
1324 @item linear_design
1325 @item no_autohint
1326 @item end table
1327 @end table
1328
1329 Default value is "render".
1330
1331 For more information consult the documentation for the FT_LOAD_*
1332 libfreetype flags.
1333
1334 @item tabsize
1335 The size in number of spaces to use for rendering the tab.
1336 Default value is 4.
1337
1338 @item fix_bounds
1339 If true, check and fix text coords to avoid clipping.
1340 @end table
1341
1342 For example the command:
1343 @example
1344 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1345 @end example
1346
1347 will draw "Test Text" with font FreeSerif, using the default values
1348 for the optional parameters.
1349
1350 The command:
1351 @example
1352 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1353           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
1354 @end example
1355
1356 will draw 'Test Text' with font FreeSerif of size 24 at position x=100
1357 and y=50 (counting from the top-left corner of the screen), text is
1358 yellow with a red box around it. Both the text and the box have an
1359 opacity of 20%.
1360
1361 Note that the double quotes are not necessary if spaces are not used
1362 within the parameter list.
1363
1364 For more information about libfreetype, check:
1365 @url{http://www.freetype.org/}.
1366
1367 @section fade
1368
1369 Apply a fade-in/out effect to the input video.
1370
1371 It accepts the following parameters:
1372
1373 @table @option
1374
1375 @item type
1376 The effect type can be either "in" for a fade-in, or "out" for a fade-out
1377 effect.
1378
1379 @item start_frame
1380 The number of the frame to start applying the fade effect at.
1381
1382 @item nb_frames
1383 The number of frames that the fade effect lasts. At the end of the
1384 fade-in effect, the output video will have the same intensity as the input video.
1385 At the end of the fade-out transition, the output video will be completely black.
1386
1387 @end table
1388
1389 Some examples:
1390 @example
1391 # Fade in the first 30 frames of video
1392 fade=type=in:nb_frames=30
1393
1394 # Fade out the last 45 frames of a 200-frame video
1395 fade=type=out:start_frame=155:nb_frames=45
1396
1397 # Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video
1398 fade=type=in:start_frame=0:nb_frames=25, fade=type=out:start_frame=975:nb_frames=25
1399
1400 # Make the first 5 frames black, then fade in from frame 5-24
1401 fade=type=in:start_frame=5:nb_frames=20
1402 @end example
1403
1404 @section fieldorder
1405
1406 Transform the field order of the input video.
1407
1408 It accepts the following parameters:
1409
1410 @table @option
1411
1412 @item order
1413 The output field order. Valid values are @var{tff} for top field first or @var{bff}
1414 for bottom field first.
1415 @end table
1416
1417 The default value is "tff".
1418
1419 The transformation is done by shifting the picture content up or down
1420 by one line, and filling the remaining line with appropriate picture content.
1421 This method is consistent with most broadcast field order converters.
1422
1423 If the input video is not flagged as being interlaced, or it is already
1424 flagged as being of the required output field order, then this filter does
1425 not alter the incoming video.
1426
1427 It is very useful when converting to or from PAL DV material,
1428 which is bottom field first.
1429
1430 For example:
1431 @example
1432 ./avconv -i in.vob -vf "fieldorder=order=bff" out.dv
1433 @end example
1434
1435 @section fifo
1436
1437 Buffer input images and send them when they are requested.
1438
1439 It is mainly useful when auto-inserted by the libavfilter
1440 framework.
1441
1442 It does not take parameters.
1443
1444 @section format
1445
1446 Convert the input video to one of the specified pixel formats.
1447 Libavfilter will try to pick one that is suitable as input to
1448 the next filter.
1449
1450 It accepts the following parameters:
1451 @table @option
1452
1453 @item pix_fmts
1454 A '|'-separated list of pixel format names, such as
1455 "pix_fmts=yuv420p|monow|rgb24".
1456
1457 @end table
1458
1459 Some examples:
1460 @example
1461 # Convert the input video to the "yuv420p" format
1462 format=pix_fmts=yuv420p
1463
1464 # Convert the input video to any of the formats in the list
1465 format=pix_fmts=yuv420p|yuv444p|yuv410p
1466 @end example
1467
1468 @anchor{fps}
1469 @section fps
1470
1471 Convert the video to specified constant framerate by duplicating or dropping
1472 frames as necessary.
1473
1474 It accepts the following parameters:
1475 @table @option
1476
1477 @item fps
1478 The desired output framerate.
1479
1480 @item start_time
1481 Assume the first PTS should be the given value, in seconds. This allows for
1482 padding/trimming at the start of stream. By default, no assumption is made
1483 about the first frame's expected PTS, so no padding or trimming is done.
1484 For example, this could be set to 0 to pad the beginning with duplicates of
1485 the first frame if a video stream starts after the audio stream or to trim any
1486 frames with a negative PTS.
1487
1488 @end table
1489
1490 @section framepack
1491
1492 Pack two different video streams into a stereoscopic video, setting proper
1493 metadata on supported codecs. The two views should have the same size and
1494 framerate and processing will stop when the shorter video ends. Please note
1495 that you may conveniently adjust view properties with the @ref{scale} and
1496 @ref{fps} filters.
1497
1498 It accepts the following parameters:
1499 @table @option
1500
1501 @item format
1502 The desired packing format. Supported values are:
1503
1504 @table @option
1505
1506 @item sbs
1507 The views are next to each other (default).
1508
1509 @item tab
1510 The views are on top of each other.
1511
1512 @item lines
1513 The views are packed by line.
1514
1515 @item columns
1516 The views are packed by column.
1517
1518 @item frameseq
1519 The views are temporally interleaved.
1520
1521 @end table
1522
1523 @end table
1524
1525 Some examples:
1526
1527 @example
1528 # Convert left and right views into a frame-sequential video
1529 avconv -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
1530
1531 # Convert views into a side-by-side video with the same output resolution as the input
1532 avconv -i LEFT -i RIGHT -filter_complex [0:v]scale=w=iw/2[left],[1:v]scale=w=iw/2[right],[left][right]framepack=sbs OUTPUT
1533 @end example
1534
1535 @anchor{frei0r}
1536 @section frei0r
1537
1538 Apply a frei0r effect to the input video.
1539
1540 To enable the compilation of this filter, you need to install the frei0r
1541 header and configure Libav with --enable-frei0r.
1542
1543 It accepts the following parameters:
1544
1545 @table @option
1546
1547 @item filter_name
1548 The name of the frei0r effect to load. If the environment variable
1549 @env{FREI0R_PATH} is defined, the frei0r effect is searched for in each of the
1550 directories specified by the colon-separated list in @env{FREIOR_PATH}.
1551 Otherwise, the standard frei0r paths are searched, in this order:
1552 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
1553 @file{/usr/lib/frei0r-1/}.
1554
1555 @item filter_params
1556 A '|'-separated list of parameters to pass to the frei0r effect.
1557
1558 @end table
1559
1560 A frei0r effect parameter can be a boolean (its value is either
1561 "y" or "n"), a double, a color (specified as
1562 @var{R}/@var{G}/@var{B}, where @var{R}, @var{G}, and @var{B} are floating point
1563 numbers between 0.0 and 1.0, inclusive) or by an @code{av_parse_color()} color
1564 description), a position (specified as @var{X}/@var{Y}, where
1565 @var{X} and @var{Y} are floating point numbers) and/or a string.
1566
1567 The number and types of parameters depend on the loaded effect. If an
1568 effect parameter is not specified, the default value is set.
1569
1570 Some examples:
1571 @example
1572 # Apply the distort0r effect, setting the first two double parameters
1573 frei0r=filter_name=distort0r:filter_params=0.5|0.01
1574
1575 # Apply the colordistance effect, taking a color as the first parameter
1576 frei0r=colordistance:0.2/0.3/0.4
1577 frei0r=colordistance:violet
1578 frei0r=colordistance:0x112233
1579
1580 # Apply the perspective effect, specifying the top left and top right
1581 # image positions
1582 frei0r=perspective:0.2/0.2|0.8/0.2
1583 @end example
1584
1585 For more information, see
1586 @url{http://piksel.org/frei0r}
1587
1588 @section gradfun
1589
1590 Fix the banding artifacts that are sometimes introduced into nearly flat
1591 regions by truncation to 8-bit colordepth.
1592 Interpolate the gradients that should go where the bands are, and
1593 dither them.
1594
1595 It is designed for playback only.  Do not use it prior to
1596 lossy compression, because compression tends to lose the dither and
1597 bring back the bands.
1598
1599 It accepts the following parameters:
1600
1601 @table @option
1602
1603 @item strength
1604 The maximum amount by which the filter will change any one pixel. This is also
1605 the threshold for detecting nearly flat regions. Acceptable values range from
1606 .51 to 64; the default value is 1.2. Out-of-range values will be clipped to the
1607 valid range.
1608
1609 @item radius
1610 The neighborhood to fit the gradient to. A larger radius makes for smoother
1611 gradients, but also prevents the filter from modifying the pixels near detailed
1612 regions. Acceptable values are 8-32; the default value is 16. Out-of-range
1613 values will be clipped to the valid range.
1614
1615 @end table
1616
1617 @example
1618 # Default parameters
1619 gradfun=strength=1.2:radius=16
1620
1621 # Omitting the radius
1622 gradfun=1.2
1623 @end example
1624
1625 @section hflip
1626
1627 Flip the input video horizontally.
1628
1629 For example, to horizontally flip the input video with @command{avconv}:
1630 @example
1631 avconv -i in.avi -vf "hflip" out.avi
1632 @end example
1633
1634 @section hqdn3d
1635
1636 This is a high precision/quality 3d denoise filter. It aims to reduce
1637 image noise, producing smooth images and making still images really
1638 still. It should enhance compressibility.
1639
1640 It accepts the following optional parameters:
1641
1642 @table @option
1643 @item luma_spatial
1644 A non-negative floating point number which specifies spatial luma strength.
1645 It defaults to 4.0.
1646
1647 @item chroma_spatial
1648 A non-negative floating point number which specifies spatial chroma strength.
1649 It defaults to 3.0*@var{luma_spatial}/4.0.
1650
1651 @item luma_tmp
1652 A floating point number which specifies luma temporal strength. It defaults to
1653 6.0*@var{luma_spatial}/4.0.
1654
1655 @item chroma_tmp
1656 A floating point number which specifies chroma temporal strength. It defaults to
1657 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}.
1658 @end table
1659
1660 @section hwupload_cuda
1661
1662 Upload system memory frames to a CUDA device.
1663
1664 It accepts the following optional parameters:
1665
1666 @table @option
1667 @item device
1668 The number of the CUDA device to use
1669 @end table
1670
1671 @section interlace
1672
1673 Simple interlacing filter from progressive contents. This interleaves upper (or
1674 lower) lines from odd frames with lower (or upper) lines from even frames,
1675 halving the frame rate and preserving image height.
1676
1677 @example
1678    Original        Original             New Frame
1679    Frame 'j'      Frame 'j+1'             (tff)
1680   ==========      ===========       ==================
1681     Line 0  -------------------->    Frame 'j' Line 0
1682     Line 1          Line 1  ---->   Frame 'j+1' Line 1
1683     Line 2 --------------------->    Frame 'j' Line 2
1684     Line 3          Line 3  ---->   Frame 'j+1' Line 3
1685      ...             ...                   ...
1686 New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
1687 @end example
1688
1689 It accepts the following optional parameters:
1690
1691 @table @option
1692 @item scan
1693 This determines whether the interlaced frame is taken from the even
1694 (tff - default) or odd (bff) lines of the progressive frame.
1695
1696 @item lowpass
1697 Enable (default) or disable the vertical lowpass filter to avoid twitter
1698 interlacing and reduce moire patterns.
1699 @end table
1700
1701 @section lut, lutrgb, lutyuv
1702
1703 Compute a look-up table for binding each pixel component input value
1704 to an output value, and apply it to the input video.
1705
1706 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1707 to an RGB input video.
1708
1709 These filters accept the following parameters:
1710 @table @option
1711 @item @var{c0} (first  pixel component)
1712 @item @var{c1} (second pixel component)
1713 @item @var{c2} (third  pixel component)
1714 @item @var{c3} (fourth pixel component, corresponds to the alpha component)
1715
1716 @item @var{r} (red component)
1717 @item @var{g} (green component)
1718 @item @var{b} (blue component)
1719 @item @var{a} (alpha component)
1720
1721 @item @var{y} (Y/luminance component)
1722 @item @var{u} (U/Cb component)
1723 @item @var{v} (V/Cr component)
1724 @end table
1725
1726 Each of them specifies the expression to use for computing the lookup table for
1727 the corresponding pixel component values.
1728
1729 The exact component associated to each of the @var{c*} options depends on the
1730 format in input.
1731
1732 The @var{lut} filter requires either YUV or RGB pixel formats in input,
1733 @var{lutrgb} requires RGB pixel formats in input, and @var{lutyuv} requires YUV.
1734
1735 The expressions can contain the following constants and functions:
1736
1737 @table @option
1738 @item E, PI, PHI
1739 These are approximated values for the mathematical constants e
1740 (Euler's number), pi (Greek pi), and phi (the golden ratio).
1741
1742 @item w, h
1743 The input width and height.
1744
1745 @item val
1746 The input value for the pixel component.
1747
1748 @item clipval
1749 The input value, clipped to the @var{minval}-@var{maxval} range.
1750
1751 @item maxval
1752 The maximum value for the pixel component.
1753
1754 @item minval
1755 The minimum value for the pixel component.
1756
1757 @item negval
1758 The negated value for the pixel component value, clipped to the
1759 @var{minval}-@var{maxval} range; it corresponds to the expression
1760 "maxval-clipval+minval".
1761
1762 @item clip(val)
1763 The computed value in @var{val}, clipped to the
1764 @var{minval}-@var{maxval} range.
1765
1766 @item gammaval(gamma)
1767 The computed gamma correction value of the pixel component value,
1768 clipped to the @var{minval}-@var{maxval} range. It corresponds to the
1769 expression
1770 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1771
1772 @end table
1773
1774 All expressions default to "val".
1775
1776 Some examples:
1777 @example
1778 # Negate input video
1779 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1780 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1781
1782 # The above is the same as
1783 lutrgb="r=negval:g=negval:b=negval"
1784 lutyuv="y=negval:u=negval:v=negval"
1785
1786 # Negate luminance
1787 lutyuv=negval
1788
1789 # Remove chroma components, turning the video into a graytone image
1790 lutyuv="u=128:v=128"
1791
1792 # Apply a luma burning effect
1793 lutyuv="y=2*val"
1794
1795 # Remove green and blue components
1796 lutrgb="g=0:b=0"
1797
1798 # Set a constant alpha channel value on input
1799 format=rgba,lutrgb=a="maxval-minval/2"
1800
1801 # Correct luminance gamma by a factor of 0.5
1802 lutyuv=y=gammaval(0.5)
1803 @end example
1804
1805 @section negate
1806
1807 Negate input video.
1808
1809 It accepts an integer in input; if non-zero it negates the
1810 alpha component (if available). The default value in input is 0.
1811
1812 @section noformat
1813
1814 Force libavfilter not to use any of the specified pixel formats for the
1815 input to the next filter.
1816
1817 It accepts the following parameters:
1818 @table @option
1819
1820 @item pix_fmts
1821 A '|'-separated list of pixel format names, such as
1822 apix_fmts=yuv420p|monow|rgb24".
1823
1824 @end table
1825
1826 Some examples:
1827 @example
1828 # Force libavfilter to use a format different from "yuv420p" for the
1829 # input to the vflip filter
1830 noformat=pix_fmts=yuv420p,vflip
1831
1832 # Convert the input video to any of the formats not contained in the list
1833 noformat=yuv420p|yuv444p|yuv410p
1834 @end example
1835
1836 @section null
1837
1838 Pass the video source unchanged to the output.
1839
1840 @section ocv
1841
1842 Apply a video transform using libopencv.
1843
1844 To enable this filter, install the libopencv library and headers and
1845 configure Libav with --enable-libopencv.
1846
1847 It accepts the following parameters:
1848
1849 @table @option
1850
1851 @item filter_name
1852 The name of the libopencv filter to apply.
1853
1854 @item filter_params
1855 The parameters to pass to the libopencv filter. If not specified, the default
1856 values are assumed.
1857
1858 @end table
1859
1860 Refer to the official libopencv documentation for more precise
1861 information:
1862 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1863
1864 Several libopencv filters are supported; see the following subsections.
1865
1866 @anchor{dilate}
1867 @subsection dilate
1868
1869 Dilate an image by using a specific structuring element.
1870 It corresponds to the libopencv function @code{cvDilate}.
1871
1872 It accepts the parameters: @var{struct_el}|@var{nb_iterations}.
1873
1874 @var{struct_el} represents a structuring element, and has the syntax:
1875 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1876
1877 @var{cols} and @var{rows} represent the number of columns and rows of
1878 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1879 point, and @var{shape} the shape for the structuring element. @var{shape}
1880 must be "rect", "cross", "ellipse", or "custom".
1881
1882 If the value for @var{shape} is "custom", it must be followed by a
1883 string of the form "=@var{filename}". The file with name
1884 @var{filename} is assumed to represent a binary image, with each
1885 printable character corresponding to a bright pixel. When a custom
1886 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1887 or columns and rows of the read file are assumed instead.
1888
1889 The default value for @var{struct_el} is "3x3+0x0/rect".
1890
1891 @var{nb_iterations} specifies the number of times the transform is
1892 applied to the image, and defaults to 1.
1893
1894 Some examples:
1895 @example
1896 # Use the default values
1897 ocv=dilate
1898
1899 # Dilate using a structuring element with a 5x5 cross, iterating two times
1900 ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
1901
1902 # Read the shape from the file diamond.shape, iterating two times.
1903 # The file diamond.shape may contain a pattern of characters like this
1904 #   *
1905 #  ***
1906 # *****
1907 #  ***
1908 #   *
1909 # The specified columns and rows are ignored
1910 # but the anchor point coordinates are not
1911 ocv=dilate:0x0+2x2/custom=diamond.shape|2
1912 @end example
1913
1914 @subsection erode
1915
1916 Erode an image by using a specific structuring element.
1917 It corresponds to the libopencv function @code{cvErode}.
1918
1919 It accepts the parameters: @var{struct_el}:@var{nb_iterations},
1920 with the same syntax and semantics as the @ref{dilate} filter.
1921
1922 @subsection smooth
1923
1924 Smooth the input video.
1925
1926 The filter takes the following parameters:
1927 @var{type}|@var{param1}|@var{param2}|@var{param3}|@var{param4}.
1928
1929 @var{type} is the type of smooth filter to apply, and must be one of
1930 the following values: "blur", "blur_no_scale", "median", "gaussian",
1931 or "bilateral". The default value is "gaussian".
1932
1933 The meaning of @var{param1}, @var{param2}, @var{param3}, and @var{param4}
1934 depend on the smooth type. @var{param1} and
1935 @var{param2} accept integer positive values or 0. @var{param3} and
1936 @var{param4} accept floating point values.
1937
1938 The default value for @var{param1} is 3. The default value for the
1939 other parameters is 0.
1940
1941 These parameters correspond to the parameters assigned to the
1942 libopencv function @code{cvSmooth}.
1943
1944 @anchor{overlay}
1945 @section overlay
1946
1947 Overlay one video on top of another.
1948
1949 It takes two inputs and has one output. The first input is the "main"
1950 video on which the second input is overlaid.
1951
1952 It accepts the following parameters:
1953
1954 @table @option
1955
1956 @item x
1957 The horizontal position of the left edge of the overlaid video on the main video.
1958
1959 @item y
1960 The vertical position of the top edge of the overlaid video on the main video.
1961
1962 @end table
1963
1964 The parameters are expressions containing the following parameters:
1965
1966 @table @option
1967 @item main_w, main_h
1968 The main input width and height.
1969
1970 @item W, H
1971 These are the same as @var{main_w} and @var{main_h}.
1972
1973 @item overlay_w, overlay_h
1974 The overlay input width and height.
1975
1976 @item w, h
1977 These are the same as @var{overlay_w} and @var{overlay_h}.
1978
1979 @item eof_action
1980 The action to take when EOF is encountered on the secondary input; it accepts
1981 one of the following values:
1982
1983 @table @option
1984 @item repeat
1985 Repeat the last frame (the default).
1986 @item endall
1987 End both streams.
1988 @item pass
1989 Pass the main input through.
1990 @end table
1991
1992 @end table
1993
1994 Be aware that frames are taken from each input video in timestamp
1995 order, hence, if their initial timestamps differ, it is a a good idea
1996 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1997 have them begin in the same zero timestamp, as the example for
1998 the @var{movie} filter does.
1999
2000 Some examples:
2001 @example
2002 # Draw the overlay at 10 pixels from the bottom right
2003 # corner of the main video
2004 overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
2005
2006 # Insert a transparent PNG logo in the bottom left corner of the input
2007 avconv -i input -i logo -filter_complex 'overlay=x=10:y=main_h-overlay_h-10' output
2008
2009 # Insert 2 different transparent PNG logos (second logo on bottom
2010 # right corner)
2011 avconv -i input -i logo1 -i logo2 -filter_complex
2012 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
2013
2014 # Add a transparent color layer on top of the main video;
2015 # WxH specifies the size of the main input to the overlay filter
2016 color=red@.3:WxH [over]; [in][over] overlay [out]
2017
2018 # Mask 10-20 seconds of a video by applying the delogo filter to a section
2019 avconv -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
2020 -vf '[in]split[split_main][split_delogo];[split_delogo]trim=start=360:end=371,delogo=0:0:640:480[delogoed];[split_main][delogoed]overlay=eof_action=pass[out]'
2021 masked.avi
2022 @end example
2023
2024 You can chain together more overlays but the efficiency of such
2025 approach is yet to be tested.
2026
2027 @section pad
2028
2029 Add paddings to the input image, and place the original input at the
2030 provided @var{x}, @var{y} coordinates.
2031
2032 It accepts the following parameters:
2033
2034 @table @option
2035 @item width, height
2036
2037 Specify the size of the output image with the paddings added. If the
2038 value for @var{width} or @var{height} is 0, the corresponding input size
2039 is used for the output.
2040
2041 The @var{width} expression can reference the value set by the
2042 @var{height} expression, and vice versa.
2043
2044 The default value of @var{width} and @var{height} is 0.
2045
2046 @item x, y
2047
2048 Specify the offsets to place the input image at within the padded area,
2049 with respect to the top/left border of the output image.
2050
2051 The @var{x} expression can reference the value set by the @var{y}
2052 expression, and vice versa.
2053
2054 The default value of @var{x} and @var{y} is 0.
2055
2056 @item color
2057
2058 Specify the color of the padded area. It can be the name of a color
2059 (case insensitive match) or an 0xRRGGBB[AA] sequence.
2060
2061 The default value of @var{color} is "black".
2062
2063 @end table
2064
2065 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
2066 expressions containing the following constants:
2067
2068 @table @option
2069 @item E, PI, PHI
2070 These are approximated values for the mathematical constants e
2071 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2072
2073 @item in_w, in_h
2074 The input video width and height.
2075
2076 @item iw, ih
2077 These are the same as @var{in_w} and @var{in_h}.
2078
2079 @item out_w, out_h
2080 The output width and height (the size of the padded area), as
2081 specified by the @var{width} and @var{height} expressions.
2082
2083 @item ow, oh
2084 These are the same as @var{out_w} and @var{out_h}.
2085
2086 @item x, y
2087 The x and y offsets as specified by the @var{x} and @var{y}
2088 expressions, or NAN if not yet specified.
2089
2090 @item a
2091 The input display aspect ratio, same as @var{iw} / @var{ih}.
2092
2093 @item hsub, vsub
2094 The horizontal and vertical chroma subsample values. For example for the
2095 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2096 @end table
2097
2098 Some examples:
2099
2100 @example
2101 # Add paddings with the color "violet" to the input video. The output video
2102 # size is 640x480, and the top-left corner of the input video is placed at
2103 # column 0, row 40
2104 pad=width=640:height=480:x=0:y=40:color=violet
2105
2106 # Pad the input to get an output with dimensions increased by 3/2,
2107 # and put the input video at the center of the padded area
2108 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
2109
2110 # Pad the input to get a squared output with size equal to the maximum
2111 # value between the input width and height, and put the input video at
2112 # the center of the padded area
2113 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
2114
2115 # Pad the input to get a final w/h ratio of 16:9
2116 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
2117
2118 # Double the output size and put the input video in the bottom-right
2119 # corner of the output padded area
2120 pad="2*iw:2*ih:ow-iw:oh-ih"
2121 @end example
2122
2123 @section pixdesctest
2124
2125 Pixel format descriptor test filter, mainly useful for internal
2126 testing. The output video should be equal to the input video.
2127
2128 For example:
2129 @example
2130 format=monow, pixdesctest
2131 @end example
2132
2133 can be used to test the monowhite pixel format descriptor definition.
2134
2135 @anchor{scale}
2136 @section scale
2137
2138 Scale the input video and/or convert the image format.
2139
2140 It accepts the following parameters:
2141
2142 @table @option
2143
2144 @item w
2145 The output video width.
2146
2147 @item h
2148 The output video height.
2149
2150 @end table
2151
2152 The parameters @var{w} and @var{h} are expressions containing
2153 the following constants:
2154
2155 @table @option
2156 @item E, PI, PHI
2157 These are approximated values for the mathematical constants e
2158 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2159
2160 @item in_w, in_h
2161 The input width and height.
2162
2163 @item iw, ih
2164 These are the same as @var{in_w} and @var{in_h}.
2165
2166 @item out_w, out_h
2167 The output (cropped) width and height.
2168
2169 @item ow, oh
2170 These are the same as @var{out_w} and @var{out_h}.
2171
2172 @item a
2173 This is the same as @var{iw} / @var{ih}.
2174
2175 @item sar
2176 input sample aspect ratio
2177
2178 @item dar
2179 The input display aspect ratio; it is the same as
2180 (@var{iw} / @var{ih}) * @var{sar}.
2181
2182 @item hsub, vsub
2183 The horizontal and vertical chroma subsample values. For example, for the
2184 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2185 @end table
2186
2187 If the input image format is different from the format requested by
2188 the next filter, the scale filter will convert the input to the
2189 requested format.
2190
2191 If the value for @var{w} or @var{h} is 0, the respective input
2192 size is used for the output.
2193
2194 If the value for @var{w} or @var{h} is -1, the scale filter will use, for the
2195 respective output size, a value that maintains the aspect ratio of the input
2196 image.
2197
2198 The default value of @var{w} and @var{h} is 0.
2199
2200 Some examples:
2201 @example
2202 # Scale the input video to a size of 200x100
2203 scale=w=200:h=100
2204
2205 # Scale the input to 2x
2206 scale=w=2*iw:h=2*ih
2207 # The above is the same as
2208 scale=2*in_w:2*in_h
2209
2210 # Scale the input to half the original size
2211 scale=w=iw/2:h=ih/2
2212
2213 # Increase the width, and set the height to the same size
2214 scale=3/2*iw:ow
2215
2216 # Seek Greek harmony
2217 scale=iw:1/PHI*iw
2218 scale=ih*PHI:ih
2219
2220 # Increase the height, and set the width to 3/2 of the height
2221 scale=w=3/2*oh:h=3/5*ih
2222
2223 # Increase the size, making the size a multiple of the chroma
2224 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
2225
2226 # Increase the width to a maximum of 500 pixels,
2227 # keeping the same aspect ratio as the input
2228 scale=w='min(500\, iw*3/2):h=-1'
2229 @end example
2230
2231 @section scale_npp
2232
2233 Use the NVIDIA Performance Primitives (libnpp) to perform scaling and/or pixel
2234 format conversion on CUDA video frames. Setting the output width and height
2235 works in the same way as for the @var{scale} filter.
2236
2237 The following additional options are accepted:
2238 @table @option
2239 @item format
2240 The pixel format of the output CUDA frames. If set to the string "same" (the
2241 default), the input format will be kept. Note that automatic format negotiation
2242 and conversion is not yet supported for hardware frames
2243
2244 @item interp_algo
2245 The interpolation algorithm used for resizing. One of the following:
2246 @table @option
2247 @item nn
2248 Nearest neighbour.
2249
2250 @item linear
2251 @item cubic
2252 @item cubic2p_bspline
2253 2-parameter cubic (B=1, C=0)
2254
2255 @item cubic2p_catmullrom
2256 2-parameter cubic (B=0, C=1/2)
2257
2258 @item cubic2p_b05c03
2259 2-parameter cubic (B=1/2, C=3/10)
2260
2261 @item super
2262 Supersampling
2263
2264 @item lanczos
2265 @end table
2266
2267 @end table
2268
2269 @section select
2270 Select frames to pass in output.
2271
2272 It accepts the following parameters:
2273
2274 @table @option
2275
2276 @item expr
2277 An expression, which is evaluated for each input frame. If the expression is
2278 evaluated to a non-zero value, the frame is selected and passed to the output,
2279 otherwise it is discarded.
2280
2281 @end table
2282
2283 The expression can contain the following constants:
2284
2285 @table @option
2286 @item E, PI, PHI
2287 These are approximated values for the mathematical constants e
2288 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2289
2290 @item n
2291 The (sequential) number of the filtered frame, starting from 0.
2292
2293 @item selected_n
2294 The (sequential) number of the selected frame, starting from 0.
2295
2296 @item prev_selected_n
2297 The sequential number of the last selected frame. It's NAN if undefined.
2298
2299 @item TB
2300 The timebase of the input timestamps.
2301
2302 @item pts
2303 The PTS (Presentation TimeStamp) of the filtered video frame,
2304 expressed in @var{TB} units. It's NAN if undefined.
2305
2306 @item t
2307 The PTS of the filtered video frame,
2308 expressed in seconds. It's NAN if undefined.
2309
2310 @item prev_pts
2311 The PTS of the previously filtered video frame. It's NAN if undefined.
2312
2313 @item prev_selected_pts
2314 The PTS of the last previously filtered video frame. It's NAN if undefined.
2315
2316 @item prev_selected_t
2317 The PTS of the last previously selected video frame. It's NAN if undefined.
2318
2319 @item start_pts
2320 The PTS of the first video frame in the video. It's NAN if undefined.
2321
2322 @item start_t
2323 The time of the first video frame in the video. It's NAN if undefined.
2324
2325 @item pict_type
2326 The type of the filtered frame. It can assume one of the following
2327 values:
2328 @table @option
2329 @item I
2330 @item P
2331 @item B
2332 @item S
2333 @item SI
2334 @item SP
2335 @item BI
2336 @end table
2337
2338 @item interlace_type
2339 The frame interlace type. It can assume one of the following values:
2340 @table @option
2341 @item PROGRESSIVE
2342 The frame is progressive (not interlaced).
2343 @item TOPFIRST
2344 The frame is top-field-first.
2345 @item BOTTOMFIRST
2346 The frame is bottom-field-first.
2347 @end table
2348
2349 @item key
2350 This is 1 if the filtered frame is a key-frame, 0 otherwise.
2351
2352 @end table
2353
2354 The default value of the select expression is "1".
2355
2356 Some examples:
2357
2358 @example
2359 # Select all the frames in input
2360 select
2361
2362 # The above is the same as
2363 select=expr=1
2364
2365 # Skip all frames
2366 select=expr=0
2367
2368 # Select only I-frames
2369 select='expr=eq(pict_type\,I)'
2370
2371 # Select one frame per 100
2372 select='not(mod(n\,100))'
2373
2374 # Select only frames contained in the 10-20 time interval
2375 select='gte(t\,10)*lte(t\,20)'
2376
2377 # Select only I-frames contained in the 10-20 time interval
2378 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2379
2380 # Select frames with a minimum distance of 10 seconds
2381 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2382 @end example
2383
2384 @anchor{setdar}
2385 @section setdar
2386
2387 Set the Display Aspect Ratio for the filter output video.
2388
2389 This is done by changing the specified Sample (aka Pixel) Aspect
2390 Ratio, according to the following equation:
2391 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2392
2393 Keep in mind that this filter does not modify the pixel dimensions of
2394 the video frame. Also, the display aspect ratio set by this filter may
2395 be changed by later filters in the filterchain, e.g. in case of
2396 scaling or if another "setdar" or a "setsar" filter is applied.
2397
2398 It accepts the following parameters:
2399
2400 @table @option
2401
2402 @item dar
2403 The output display aspect ratio.
2404
2405 @end table
2406
2407 The parameter @var{dar} is an expression containing
2408 the following constants:
2409
2410 @table @option
2411 @item E, PI, PHI
2412 These are approximated values for the mathematical constants e
2413 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2414
2415 @item w, h
2416 The input width and height.
2417
2418 @item a
2419 This is the same as @var{w} / @var{h}.
2420
2421 @item sar
2422 The input sample aspect ratio.
2423
2424 @item dar
2425 The input display aspect ratio. It is the same as
2426 (@var{w} / @var{h}) * @var{sar}.
2427
2428 @item hsub, vsub
2429 The horizontal and vertical chroma subsample values. For example, for the
2430 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2431 @end table
2432
2433 To change the display aspect ratio to 16:9, specify:
2434 @example
2435 setdar=dar=16/9
2436 # The above is equivalent to
2437 setdar=dar=1.77777
2438 @end example
2439
2440 Also see the the @ref{setsar} filter documentation.
2441
2442 @section setpts
2443
2444 Change the PTS (presentation timestamp) of the input video frames.
2445
2446 It accepts the following parameters:
2447
2448 @table @option
2449
2450 @item expr
2451 The expression which is evaluated for each frame to construct its timestamp.
2452
2453 @end table
2454
2455 The expression is evaluated through the eval API and can contain the following
2456 constants:
2457
2458 @table @option
2459 @item PTS
2460 The presentation timestamp in input.
2461
2462 @item E, PI, PHI
2463 These are approximated values for the mathematical constants e
2464 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2465
2466 @item N
2467 The count of the input frame, starting from 0.
2468
2469 @item STARTPTS
2470 The PTS of the first video frame.
2471
2472 @item INTERLACED
2473 State whether the current frame is interlaced.
2474
2475 @item PREV_INPTS
2476 The previous input PTS.
2477
2478 @item PREV_OUTPTS
2479 The previous output PTS.
2480
2481 @item RTCTIME
2482 The wallclock (RTC) time in microseconds.
2483
2484 @item RTCSTART
2485 The wallclock (RTC) time at the start of the movie in microseconds.
2486
2487 @item TB
2488 The timebase of the input timestamps.
2489
2490 @end table
2491
2492 Some examples:
2493
2494 @example
2495 # Start counting the PTS from zero
2496 setpts=expr=PTS-STARTPTS
2497
2498 # Fast motion
2499 setpts=expr=0.5*PTS
2500
2501 # Slow motion
2502 setpts=2.0*PTS
2503
2504 # Fixed rate 25 fps
2505 setpts=N/(25*TB)
2506
2507 # Fixed rate 25 fps with some jitter
2508 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2509
2510 # Generate timestamps from a "live source" and rebase onto the current timebase
2511 setpts='(RTCTIME - RTCSTART) / (TB * 1000000)"
2512 @end example
2513
2514 @anchor{setsar}
2515 @section setsar
2516
2517 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
2518
2519 Note that as a consequence of the application of this filter, the
2520 output display aspect ratio will change according to the following
2521 equation:
2522 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2523
2524 Keep in mind that the sample aspect ratio set by this filter may be
2525 changed by later filters in the filterchain, e.g. if another "setsar"
2526 or a "setdar" filter is applied.
2527
2528 It accepts the following parameters:
2529
2530 @table @option
2531
2532 @item sar
2533 The output sample aspect ratio.
2534
2535 @end table
2536
2537 The parameter @var{sar} is an expression containing
2538 the following constants:
2539
2540 @table @option
2541 @item E, PI, PHI
2542 These are approximated values for the mathematical constants e
2543 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2544
2545 @item w, h
2546 The input width and height.
2547
2548 @item a
2549 These are the same as @var{w} / @var{h}.
2550
2551 @item sar
2552 The input sample aspect ratio.
2553
2554 @item dar
2555 The input display aspect ratio. It is the same as
2556 (@var{w} / @var{h}) * @var{sar}.
2557
2558 @item hsub, vsub
2559 Horizontal and vertical chroma subsample values. For example, for the
2560 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2561 @end table
2562
2563 To change the sample aspect ratio to 10:11, specify:
2564 @example
2565 setsar=sar=10/11
2566 @end example
2567
2568 @section settb
2569
2570 Set the timebase to use for the output frames timestamps.
2571 It is mainly useful for testing timebase configuration.
2572
2573 It accepts the following parameters:
2574
2575 @table @option
2576
2577 @item expr
2578 The expression which is evaluated into the output timebase.
2579
2580 @end table
2581
2582 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
2583 default timebase), and "intb" (the input timebase).
2584
2585 The default value for the input is "intb".
2586
2587 Some examples:
2588
2589 @example
2590 # Set the timebase to 1/25
2591 settb=expr=1/25
2592
2593 # Set the timebase to 1/10
2594 settb=expr=0.1
2595
2596 # Set the timebase to 1001/1000
2597 settb=1+0.001
2598
2599 #Set the timebase to 2*intb
2600 settb=2*intb
2601
2602 #Set the default timebase value
2603 settb=AVTB
2604 @end example
2605
2606 @section showinfo
2607
2608 Show a line containing various information for each input video frame.
2609 The input video is not modified.
2610
2611 The shown line contains a sequence of key/value pairs of the form
2612 @var{key}:@var{value}.
2613
2614 It accepts the following parameters:
2615
2616 @table @option
2617 @item n
2618 The (sequential) number of the input frame, starting from 0.
2619
2620 @item pts
2621 The Presentation TimeStamp of the input frame, expressed as a number of
2622 time base units. The time base unit depends on the filter input pad.
2623
2624 @item pts_time
2625 The Presentation TimeStamp of the input frame, expressed as a number of
2626 seconds.
2627
2628 @item pos
2629 The position of the frame in the input stream, or -1 if this information is
2630 unavailable and/or meaningless (for example in case of synthetic video).
2631
2632 @item fmt
2633 The pixel format name.
2634
2635 @item sar
2636 The sample aspect ratio of the input frame, expressed in the form
2637 @var{num}/@var{den}.
2638
2639 @item s
2640 The size of the input frame, expressed in the form
2641 @var{width}x@var{height}.
2642
2643 @item i
2644 The type of interlaced mode ("P" for "progressive", "T" for top field first, "B"
2645 for bottom field first).
2646
2647 @item iskey
2648 This is 1 if the frame is a key frame, 0 otherwise.
2649
2650 @item type
2651 The picture type of the input frame ("I" for an I-frame, "P" for a
2652 P-frame, "B" for a B-frame, or "?" for an unknown type).
2653 Also refer to the documentation of the @code{AVPictureType} enum and of
2654 the @code{av_get_picture_type_char} function defined in
2655 @file{libavutil/avutil.h}.
2656
2657 @item checksum
2658 The Adler-32 checksum of all the planes of the input frame.
2659
2660 @item plane_checksum
2661 The Adler-32 checksum of each plane of the input frame, expressed in the form
2662 "[@var{c0} @var{c1} @var{c2} @var{c3}]".
2663 @end table
2664
2665 @section shuffleplanes
2666
2667 Reorder and/or duplicate video planes.
2668
2669 It accepts the following parameters:
2670
2671 @table @option
2672
2673 @item map0
2674 The index of the input plane to be used as the first output plane.
2675
2676 @item map1
2677 The index of the input plane to be used as the second output plane.
2678
2679 @item map2
2680 The index of the input plane to be used as the third output plane.
2681
2682 @item map3
2683 The index of the input plane to be used as the fourth output plane.
2684
2685 @end table
2686
2687 The first plane has the index 0. The default is to keep the input unchanged.
2688
2689 Swap the second and third planes of the input:
2690 @example
2691 avconv -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
2692 @end example
2693
2694 @section split
2695
2696 Split input video into several identical outputs.
2697
2698 It accepts a single parameter, which specifies the number of outputs. If
2699 unspecified, it defaults to 2.
2700
2701 Create 5 copies of the input video:
2702 @example
2703 avconv -i INPUT -filter_complex split=5 OUTPUT
2704 @end example
2705
2706 @section transpose
2707
2708 Transpose rows with columns in the input video and optionally flip it.
2709
2710 It accepts the following parameters:
2711
2712 @table @option
2713
2714 @item dir
2715 The direction of the transpose.
2716
2717 @end table
2718
2719 The direction can assume the following values:
2720
2721 @table @samp
2722 @item cclock_flip
2723 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2724 @example
2725 L.R     L.l
2726 . . ->  . .
2727 l.r     R.r
2728 @end example
2729
2730 @item clock
2731 Rotate by 90 degrees clockwise, that is:
2732 @example
2733 L.R     l.L
2734 . . ->  . .
2735 l.r     r.R
2736 @end example
2737
2738 @item cclock
2739 Rotate by 90 degrees counterclockwise, that is:
2740 @example
2741 L.R     R.r
2742 . . ->  . .
2743 l.r     L.l
2744 @end example
2745
2746 @item clock_flip
2747 Rotate by 90 degrees clockwise and vertically flip, that is:
2748 @example
2749 L.R     r.R
2750 . . ->  . .
2751 l.r     l.L
2752 @end example
2753 @end table
2754
2755 @section trim
2756 Trim the input so that the output contains one continuous subpart of the input.
2757
2758 It accepts the following parameters:
2759 @table @option
2760 @item start
2761 The timestamp (in seconds) of the start of the kept section. The frame with the
2762 timestamp @var{start} will be the first frame in the output.
2763
2764 @item end
2765 The timestamp (in seconds) of the first frame that will be dropped. The frame
2766 immediately preceding the one with the timestamp @var{end} will be the last
2767 frame in the output.
2768
2769 @item start_pts
2770 This is the same as @var{start}, except this option sets the start timestamp
2771 in timebase units instead of seconds.
2772
2773 @item end_pts
2774 This is the same as @var{end}, except this option sets the end timestamp
2775 in timebase units instead of seconds.
2776
2777 @item duration
2778 The maximum duration of the output in seconds.
2779
2780 @item start_frame
2781 The number of the first frame that should be passed to the output.
2782
2783 @item end_frame
2784 The number of the first frame that should be dropped.
2785 @end table
2786
2787 Note that the first two sets of the start/end options and the @option{duration}
2788 option look at the frame timestamp, while the _frame variants simply count the
2789 frames that pass through the filter. Also note that this filter does not modify
2790 the timestamps. If you wish for the output timestamps to start at zero, insert a
2791 setpts filter after the trim filter.
2792
2793 If multiple start or end options are set, this filter tries to be greedy and
2794 keep all the frames that match at least one of the specified constraints. To keep
2795 only the part that matches all the constraints at once, chain multiple trim
2796 filters.
2797
2798 The defaults are such that all the input is kept. So it is possible to set e.g.
2799 just the end values to keep everything before the specified time.
2800
2801 Examples:
2802 @itemize
2803 @item
2804 Drop everything except the second minute of input:
2805 @example
2806 avconv -i INPUT -vf trim=60:120
2807 @end example
2808
2809 @item
2810 Keep only the first second:
2811 @example
2812 avconv -i INPUT -vf trim=duration=1
2813 @end example
2814
2815 @end itemize
2816 @section unsharp
2817
2818 Sharpen or blur the input video.
2819
2820 It accepts the following parameters:
2821
2822 @table @option
2823
2824 @item luma_msize_x
2825 Set the luma matrix horizontal size. It must be an integer between 3
2826 and 13. The default value is 5.
2827
2828 @item luma_msize_y
2829 Set the luma matrix vertical size. It must be an integer between 3
2830 and 13. The default value is 5.
2831
2832 @item luma_amount
2833 Set the luma effect strength. It must be a floating point number between -2.0
2834 and 5.0. The default value is 1.0.
2835
2836 @item chroma_msize_x
2837 Set the chroma matrix horizontal size. It must be an integer between 3
2838 and 13. The default value is 5.
2839
2840 @item chroma_msize_y
2841 Set the chroma matrix vertical size. It must be an integer between 3
2842 and 13. The default value is 5.
2843
2844 @item chroma_amount
2845 Set the chroma effect strength. It must be a floating point number between -2.0
2846 and 5.0. The default value is 0.0.
2847
2848 @end table
2849
2850 Negative values for the amount will blur the input video, while positive
2851 values will sharpen. All parameters are optional and default to the
2852 equivalent of the string '5:5:1.0:5:5:0.0'.
2853
2854 @example
2855 # Strong luma sharpen effect parameters
2856 unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
2857
2858 # A strong blur of both luma and chroma parameters
2859 unsharp=7:7:-2:7:7:-2
2860
2861 # Use the default values with @command{avconv}
2862 ./avconv -i in.avi -vf "unsharp" out.mp4
2863 @end example
2864
2865 @section vflip
2866
2867 Flip the input video vertically.
2868
2869 @example
2870 ./avconv -i in.avi -vf "vflip" out.avi
2871 @end example
2872
2873 @section yadif
2874
2875 Deinterlace the input video ("yadif" means "yet another deinterlacing
2876 filter").
2877
2878 It accepts the following parameters:
2879
2880 @table @option
2881
2882 @item mode
2883 The interlacing mode to adopt. It accepts one of the following values:
2884
2885 @table @option
2886 @item 0
2887 Output one frame for each frame.
2888 @item 1
2889 Output one frame for each field.
2890 @item 2
2891 Like 0, but it skips the spatial interlacing check.
2892 @item 3
2893 Like 1, but it skips the spatial interlacing check.
2894 @end table
2895
2896 The default value is 0.
2897
2898 @item parity
2899 The picture field parity assumed for the input interlaced video. It accepts one
2900 of the following values:
2901
2902 @table @option
2903 @item 0
2904 Assume the top field is first.
2905 @item 1
2906 Assume the bottom field is first.
2907 @item -1
2908 Enable automatic detection of field parity.
2909 @end table
2910
2911 The default value is -1.
2912 If the interlacing is unknown or the decoder does not export this information,
2913 top field first will be assumed.
2914
2915 @item auto
2916 Whether the deinterlacer should trust the interlaced flag and only deinterlace
2917 frames marked as interlaced.
2918
2919 @table @option
2920 @item 0
2921 Deinterlace all frames.
2922 @item 1
2923 Only deinterlace frames marked as interlaced.
2924 @end table
2925
2926 The default value is 0.
2927
2928 @end table
2929
2930 @c man end VIDEO FILTERS
2931
2932 @chapter Video Sources
2933 @c man begin VIDEO SOURCES
2934
2935 Below is a description of the currently available video sources.
2936
2937 @section buffer
2938
2939 Buffer video frames, and make them available to the filter chain.
2940
2941 This source is mainly intended for a programmatic use, in particular
2942 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2943
2944 It accepts the following parameters:
2945
2946 @table @option
2947
2948 @item width
2949 The input video width.
2950
2951 @item height
2952 The input video height.
2953
2954 @item pix_fmt
2955 The name of the input video pixel format.
2956
2957 @item time_base
2958 The time base used for input timestamps.
2959
2960 @item sar
2961 The sample (pixel) aspect ratio of the input video.
2962
2963 @item hw_frames_ctx
2964 When using a hardware pixel format, this should be a reference to an
2965 AVHWFramesContext describing input frames.
2966
2967 @end table
2968
2969 For example:
2970 @example
2971 buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
2972 @end example
2973
2974 will instruct the source to accept video frames with size 320x240 and
2975 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2976 square pixels (1:1 sample aspect ratio).
2977
2978 @section color
2979
2980 Provide an uniformly colored input.
2981
2982 It accepts the following parameters:
2983
2984 @table @option
2985
2986 @item color
2987 Specify the color of the source. It can be the name of a color (case
2988 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2989 alpha specifier. The default value is "black".
2990
2991 @item size
2992 Specify the size of the sourced video, it may be a string of the form
2993 @var{width}x@var{height}, or the name of a size abbreviation. The
2994 default value is "320x240".
2995
2996 @item framerate
2997 Specify the frame rate of the sourced video, as the number of frames
2998 generated per second. It has to be a string in the format
2999 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a floating point
3000 number or a valid video frame rate abbreviation. The default value is
3001 "25".
3002
3003 @end table
3004
3005 The following graph description will generate a red source
3006 with an opacity of 0.2, with size "qcif" and a frame rate of 10
3007 frames per second, which will be overlaid over the source connected
3008 to the pad with identifier "in":
3009
3010 @example
3011 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
3012 @end example
3013
3014 @section movie
3015
3016 Read a video stream from a movie container.
3017
3018 Note that this source is a hack that bypasses the standard input path. It can be
3019 useful in applications that do not support arbitrary filter graphs, but its use
3020 is discouraged in those that do. It should never be used with
3021 @command{avconv}; the @option{-filter_complex} option fully replaces it.
3022
3023 It accepts the following parameters:
3024
3025 @table @option
3026
3027 @item filename
3028 The name of the resource to read (not necessarily a file; it can also be a
3029 device or a stream accessed through some protocol).
3030
3031 @item format_name, f
3032 Specifies the format assumed for the movie to read, and can be either
3033 the name of a container or an input device. If not specified, the
3034 format is guessed from @var{movie_name} or by probing.
3035
3036 @item seek_point, sp
3037 Specifies the seek point in seconds. The frames will be output
3038 starting from this seek point. The parameter is evaluated with
3039 @code{av_strtod}, so the numerical value may be suffixed by an IS
3040 postfix. The default value is "0".
3041
3042 @item stream_index, si
3043 Specifies the index of the video stream to read. If the value is -1,
3044 the most suitable video stream will be automatically selected. The default
3045 value is "-1".
3046
3047 @end table
3048
3049 It allows overlaying a second video on top of the main input of
3050 a filtergraph, as shown in this graph:
3051 @example
3052 input -----------> deltapts0 --> overlay --> output
3053                                     ^
3054                                     |
3055 movie --> scale--> deltapts1 -------+
3056 @end example
3057
3058 Some examples:
3059 @example
3060 # Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it
3061 # on top of the input labelled "in"
3062 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
3063 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
3064
3065 # Read from a video4linux2 device, and overlay it on top of the input
3066 # labelled "in"
3067 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
3068 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
3069
3070 @end example
3071
3072 @section nullsrc
3073
3074 Null video source: never return images. It is mainly useful as a
3075 template and to be employed in analysis / debugging tools.
3076
3077 It accepts a string of the form
3078 @var{width}:@var{height}:@var{timebase} as an optional parameter.
3079
3080 @var{width} and @var{height} specify the size of the configured
3081 source. The default values of @var{width} and @var{height} are
3082 respectively 352 and 288 (corresponding to the CIF size format).
3083
3084 @var{timebase} specifies an arithmetic expression representing a
3085 timebase. The expression can contain the constants "PI", "E", "PHI", and
3086 "AVTB" (the default timebase), and defaults to the value "AVTB".
3087
3088 @section frei0r_src
3089
3090 Provide a frei0r source.
3091
3092 To enable compilation of this filter you need to install the frei0r
3093 header and configure Libav with --enable-frei0r.
3094
3095 This source accepts the following parameters:
3096
3097 @table @option
3098
3099 @item size
3100 The size of the video to generate. It may be a string of the form
3101 @var{width}x@var{height} or a frame size abbreviation.
3102
3103 @item framerate
3104 The framerate of the generated video. It may be a string of the form
3105 @var{num}/@var{den} or a frame rate abbreviation.
3106
3107 @item filter_name
3108 The name to the frei0r source to load. For more information regarding frei0r and
3109 how to set the parameters, read the @ref{frei0r} section in the video filters
3110 documentation.
3111
3112 @item filter_params
3113 A '|'-separated list of parameters to pass to the frei0r source.
3114
3115 @end table
3116
3117 An example:
3118 @example
3119 # Generate a frei0r partik0l source with size 200x200 and framerate 10
3120 # which is overlaid on the overlay filter's main input
3121 frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
3122 @end example
3123
3124 @section rgbtestsrc, testsrc
3125
3126 The @code{rgbtestsrc} source generates an RGB test pattern useful for
3127 detecting RGB vs BGR issues. You should see a red, green and blue
3128 stripe from top to bottom.
3129
3130 The @code{testsrc} source generates a test video pattern, showing a
3131 color pattern, a scrolling gradient and a timestamp. This is mainly
3132 intended for testing purposes.
3133
3134 The sources accept the following parameters:
3135
3136 @table @option
3137
3138 @item size, s
3139 Specify the size of the sourced video, it may be a string of the form
3140 @var{width}x@var{height}, or the name of a size abbreviation. The
3141 default value is "320x240".
3142
3143 @item rate, r
3144 Specify the frame rate of the sourced video, as the number of frames
3145 generated per second. It has to be a string in the format
3146 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a floating point
3147 number or a valid video frame rate abbreviation. The default value is
3148 "25".
3149
3150 @item sar
3151 Set the sample aspect ratio of the sourced video.
3152
3153 @item duration
3154 Set the video duration of the sourced video. The accepted syntax is:
3155 @example
3156 [-]HH[:MM[:SS[.m...]]]
3157 [-]S+[.m...]
3158 @end example
3159 Also see the the @code{av_parse_time()} function.
3160
3161 If not specified, or the expressed duration is negative, the video is
3162 supposed to be generated forever.
3163 @end table
3164
3165 For example the following:
3166 @example
3167 testsrc=duration=5.3:size=qcif:rate=10
3168 @end example
3169
3170 will generate a video with a duration of 5.3 seconds, with size
3171 176x144 and a framerate of 10 frames per second.
3172
3173 @c man end VIDEO SOURCES
3174
3175 @chapter Video Sinks
3176 @c man begin VIDEO SINKS
3177
3178 Below is a description of the currently available video sinks.
3179
3180 @section buffersink
3181
3182 Buffer video frames, and make them available to the end of the filter
3183 graph.
3184
3185 This sink is intended for programmatic use through the interface defined in
3186 @file{libavfilter/buffersink.h}.
3187
3188 @section nullsink
3189
3190 Null video sink: do absolutely nothing with the input video. It is
3191 mainly useful as a template and for use in analysis / debugging
3192 tools.
3193
3194 @c man end VIDEO SINKS