setpts: add FRAME_RATE constant
[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 -map '[FC]'
502 front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
503 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 resample
651 Convert the audio sample format, sample rate and channel layout. It is
652 not meant to be used directly; it is inserted automatically by libavfilter
653 whenever conversion is needed. Use the @var{aformat} filter to force a specific
654 conversion.
655
656 @section volume
657
658 Adjust the input audio volume.
659
660 It accepts the following parameters:
661 @table @option
662
663 @item volume
664 This expresses how the audio volume will be increased or decreased.
665
666 Output values are clipped to the maximum value.
667
668 The output audio volume is given by the relation:
669 @example
670 @var{output_volume} = @var{volume} * @var{input_volume}
671 @end example
672
673 The default value for @var{volume} is 1.0.
674
675 @item precision
676 This parameter represents the mathematical precision.
677
678 It determines which input sample formats will be allowed, which affects the
679 precision of the volume scaling.
680
681 @table @option
682 @item fixed
683 8-bit fixed-point; this limits input sample format to U8, S16, and S32.
684 @item float
685 32-bit floating-point; this limits input sample format to FLT. (default)
686 @item double
687 64-bit floating-point; this limits input sample format to DBL.
688 @end table
689
690 @item replaygain
691 Choose the behaviour on encountering ReplayGain side data in input frames.
692
693 @table @option
694 @item drop
695 Remove ReplayGain side data, ignoring its contents (the default).
696
697 @item ignore
698 Ignore ReplayGain side data, but leave it in the frame.
699
700 @item track
701 Prefer the track gain, if present.
702
703 @item album
704 Prefer the album gain, if present.
705 @end table
706
707 @item replaygain_preamp
708 Pre-amplification gain in dB to apply to the selected replaygain gain.
709
710 Default value for @var{replaygain_preamp} is 0.0.
711
712 @item replaygain_noclip
713 Prevent clipping by limiting the gain applied.
714
715 Default value for @var{replaygain_noclip} is 1.
716
717 @end table
718
719 @subsection Examples
720
721 @itemize
722 @item
723 Halve the input audio volume:
724 @example
725 volume=volume=0.5
726 volume=volume=1/2
727 volume=volume=-6.0206dB
728 @end example
729
730 @item
731 Increase input audio power by 6 decibels using fixed-point precision:
732 @example
733 volume=volume=6dB:precision=fixed
734 @end example
735 @end itemize
736
737 @c man end AUDIO FILTERS
738
739 @chapter Audio Sources
740 @c man begin AUDIO SOURCES
741
742 Below is a description of the currently available audio sources.
743
744 @section anullsrc
745
746 The null audio source; it never returns audio frames. It is mainly useful as a
747 template and for use in analysis / debugging tools.
748
749 It accepts, as an optional parameter, a string of the form
750 @var{sample_rate}:@var{channel_layout}.
751
752 @var{sample_rate} specifies the sample rate, and defaults to 44100.
753
754 @var{channel_layout} specifies the channel layout, and can be either an
755 integer or a string representing a channel layout. The default value
756 of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.
757
758 Check the channel_layout_map definition in
759 @file{libavutil/channel_layout.c} for the mapping between strings and
760 channel layout values.
761
762 Some examples:
763 @example
764 # Set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO
765 anullsrc=48000:4
766
767 # The same as above
768 anullsrc=48000:mono
769 @end example
770
771 @section abuffer
772 Buffer audio frames, and make them available to the filter chain.
773
774 This source is not intended to be part of user-supplied graph descriptions; it
775 is for insertion by calling programs, through the interface defined in
776 @file{libavfilter/buffersrc.h}.
777
778 It accepts the following parameters:
779 @table @option
780
781 @item time_base
782 The timebase which will be used for timestamps of submitted frames. It must be
783 either a floating-point number or in @var{numerator}/@var{denominator} form.
784
785 @item sample_rate
786 The audio sample rate.
787
788 @item sample_fmt
789 The name of the sample format, as returned by @code{av_get_sample_fmt_name()}.
790
791 @item channel_layout
792 The channel layout of the audio data, in the form that can be accepted by
793 @code{av_get_channel_layout()}.
794 @end table
795
796 All the parameters need to be explicitly defined.
797
798 @c man end AUDIO SOURCES
799
800 @chapter Audio Sinks
801 @c man begin AUDIO SINKS
802
803 Below is a description of the currently available audio sinks.
804
805 @section anullsink
806
807 Null audio sink; do absolutely nothing with the input audio. It is
808 mainly useful as a template and for use in analysis / debugging
809 tools.
810
811 @section abuffersink
812 This sink is intended for programmatic use. Frames that arrive on this sink can
813 be retrieved by the calling program, using the interface defined in
814 @file{libavfilter/buffersink.h}.
815
816 It does not accept any parameters.
817
818 @c man end AUDIO SINKS
819
820 @chapter Video Filters
821 @c man begin VIDEO FILTERS
822
823 When you configure your Libav build, you can disable any of the
824 existing filters using --disable-filters.
825 The configure output will show the video filters included in your
826 build.
827
828 Below is a description of the currently available video filters.
829
830 @section blackframe
831
832 Detect frames that are (almost) completely black. Can be useful to
833 detect chapter transitions or commercials. Output lines consist of
834 the frame number of the detected frame, the percentage of blackness,
835 the position in the file if known or -1 and the timestamp in seconds.
836
837 In order to display the output lines, you need to set the loglevel at
838 least to the AV_LOG_INFO value.
839
840 It accepts the following parameters:
841
842 @table @option
843
844 @item amount
845 The percentage of the pixels that have to be below the threshold; it defaults to
846 98.
847
848 @item threshold
849 The threshold below which a pixel value is considered black; it defaults to 32.
850
851 @end table
852
853 @section boxblur
854
855 Apply a boxblur algorithm to the input video.
856
857 It accepts the following parameters:
858
859 @table @option
860
861 @item luma_radius
862 @item luma_power
863 @item chroma_radius
864 @item chroma_power
865 @item alpha_radius
866 @item alpha_power
867
868 @end table
869
870 The chroma and alpha parameters are optional. If not specified, they default
871 to the corresponding values set for @var{luma_radius} and
872 @var{luma_power}.
873
874 @var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
875 the radius in pixels of the box used for blurring the corresponding
876 input plane. They are expressions, and can contain the following
877 constants:
878 @table @option
879 @item w, h
880 The input width and height in pixels.
881
882 @item cw, ch
883 The input chroma image width and height in pixels.
884
885 @item hsub, vsub
886 The horizontal and vertical chroma subsample values. For example, for the
887 pixel format "yuv422p", @var{hsub} is 2 and @var{vsub} is 1.
888 @end table
889
890 The radius must be a non-negative number, and must not be greater than
891 the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
892 and of @code{min(cw,ch)/2} for the chroma planes.
893
894 @var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
895 how many times the boxblur filter is applied to the corresponding
896 plane.
897
898 Some examples:
899
900 @itemize
901
902 @item
903 Apply a boxblur filter with the luma, chroma, and alpha radii
904 set to 2:
905 @example
906 boxblur=luma_radius=2:luma_power=1
907 @end example
908
909 @item
910 Set the luma radius to 2, and alpha and chroma radius to 0:
911 @example
912 boxblur=2:1:0:0:0:0
913 @end example
914
915 @item
916 Set the luma and chroma radii to a fraction of the video dimension:
917 @example
918 boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
919 @end example
920
921 @end itemize
922
923 @section copy
924
925 Copy the input source unchanged to the output. This is mainly useful for
926 testing purposes.
927
928 @section crop
929
930 Crop the input video to given dimensions.
931
932 It accepts the following parameters:
933
934 @table @option
935
936 @item out_w
937 The width of the output video.
938
939 @item out_h
940 The height of the output video.
941
942 @item x
943 The horizontal position, in the input video, of the left edge of the output
944 video.
945
946 @item y
947 The vertical position, in the input video, of the top edge of the output video.
948
949 @end table
950
951 The parameters are expressions containing the following constants:
952
953 @table @option
954 @item E, PI, PHI
955 These are approximated values for the mathematical constants e
956 (Euler's number), pi (Greek pi), and phi (the golden ratio).
957
958 @item x, y
959 The computed values for @var{x} and @var{y}. They are evaluated for
960 each new frame.
961
962 @item in_w, in_h
963 The input width and height.
964
965 @item iw, ih
966 These are the same as @var{in_w} and @var{in_h}.
967
968 @item out_w, out_h
969 The output (cropped) width and height.
970
971 @item ow, oh
972 These are the same as @var{out_w} and @var{out_h}.
973
974 @item n
975 The number of the input frame, starting from 0.
976
977 @item t
978 The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
979
980 @end table
981
982 The @var{out_w} and @var{out_h} parameters specify the expressions for
983 the width and height of the output (cropped) video. They are only
984 evaluated during the configuration of the filter.
985
986 The default value of @var{out_w} is "in_w", and the default value of
987 @var{out_h} is "in_h".
988
989 The expression for @var{out_w} may depend on the value of @var{out_h},
990 and the expression for @var{out_h} may depend on @var{out_w}, but they
991 cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
992 evaluated after @var{out_w} and @var{out_h}.
993
994 The @var{x} and @var{y} parameters specify the expressions for the
995 position of the top-left corner of the output (non-cropped) area. They
996 are evaluated for each frame. If the evaluated value is not valid, it
997 is approximated to the nearest valid value.
998
999 The default value of @var{x} is "(in_w-out_w)/2", and the default
1000 value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
1001 the center of the input image.
1002
1003 The expression for @var{x} may depend on @var{y}, and the expression
1004 for @var{y} may depend on @var{x}.
1005
1006 Some examples:
1007 @example
1008 # Crop the central input area with size 100x100
1009 crop=out_w=100:out_h=100
1010
1011 # Crop the central input area with size 2/3 of the input video
1012 "crop=out_w=2/3*in_w:out_h=2/3*in_h"
1013
1014 # Crop the input video central square
1015 crop=out_w=in_h
1016
1017 # Delimit the rectangle with the top-left corner placed at position
1018 # 100:100 and the right-bottom corner corresponding to the right-bottom
1019 # corner of the input image
1020 crop=out_w=in_w-100:out_h=in_h-100:x=100:y=100
1021
1022 # Crop 10 pixels from the left and right borders, and 20 pixels from
1023 # the top and bottom borders
1024 "crop=out_w=in_w-2*10:out_h=in_h-2*20"
1025
1026 # Keep only the bottom right quarter of the input image
1027 "crop=out_w=in_w/2:out_h=in_h/2:x=in_w/2:y=in_h/2"
1028
1029 # Crop height for getting Greek harmony
1030 "crop=out_w=in_w:out_h=1/PHI*in_w"
1031
1032 # Trembling effect
1033 "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)"
1034
1035 # Erratic camera effect depending on timestamp
1036 "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)"
1037
1038 # Set x depending on the value of y
1039 "crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
1040 @end example
1041
1042 @section cropdetect
1043
1044 Auto-detect the crop size.
1045
1046 It calculates the necessary cropping parameters and prints the
1047 recommended parameters via the logging system. The detected dimensions
1048 correspond to the non-black area of the input video.
1049
1050 It accepts the following parameters:
1051
1052 @table @option
1053
1054 @item limit
1055 The threshold, an optional parameter between nothing (0) and
1056 everything (255). It defaults to 24.
1057
1058 @item round
1059 The value which the width/height should be divisible by. It defaults to
1060 16. The offset is automatically adjusted to center the video. Use 2 to
1061 get only even dimensions (needed for 4:2:2 video). 16 is best when
1062 encoding to most video codecs.
1063
1064 @item reset
1065 A counter that determines how many frames cropdetect will reset
1066 the previously detected largest video area after. It will then start over
1067 and detect the current optimal crop area. It defaults to 0.
1068
1069 This can be useful when channel logos distort the video area. 0
1070 indicates 'never reset', and returns the largest area encountered during
1071 playback.
1072 @end table
1073
1074 @section delogo
1075
1076 Suppress a TV station logo by a simple interpolation of the surrounding
1077 pixels. Just set a rectangle covering the logo and watch it disappear
1078 (and sometimes something even uglier appear - your mileage may vary).
1079
1080 It accepts the following parameters:
1081 @table @option
1082
1083 @item x, y
1084 Specify the top left corner coordinates of the logo. They must be
1085 specified.
1086
1087 @item w, h
1088 Specify the width and height of the logo to clear. They must be
1089 specified.
1090
1091 @item band, t
1092 Specify the thickness of the fuzzy edge of the rectangle (added to
1093 @var{w} and @var{h}). The default value is 4.
1094
1095 @item show
1096 When set to 1, a green rectangle is drawn on the screen to simplify
1097 finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
1098 @var{band} is set to 4. The default value is 0.
1099
1100 @end table
1101
1102 An example:
1103
1104 @itemize
1105
1106 @item
1107 Set a rectangle covering the area with top left corner coordinates 0,0
1108 and size 100x77, and a band of size 10:
1109 @example
1110 delogo=x=0:y=0:w=100:h=77:band=10
1111 @end example
1112
1113 @end itemize
1114
1115 @section drawbox
1116
1117 Draw a colored box on the input image.
1118
1119 It accepts the following parameters:
1120
1121 @table @option
1122
1123 @item x, y
1124 Specify the top left corner coordinates of the box. It defaults to 0.
1125
1126 @item width, height
1127 Specify the width and height of the box; if 0 they are interpreted as
1128 the input width and height. It defaults to 0.
1129
1130 @item color
1131 Specify the color of the box to write. It can be the name of a color
1132 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1133 @end table
1134
1135 Some examples:
1136 @example
1137 # Draw a black box around the edge of the input image
1138 drawbox
1139
1140 # Draw a box with color red and an opacity of 50%
1141 drawbox=x=10:y=20:width=200:height=60:color=red@@0.5"
1142 @end example
1143
1144 @section drawtext
1145
1146 Draw a text string or text from a specified file on top of a video, using the
1147 libfreetype library.
1148
1149 To enable compilation of this filter, you need to configure Libav with
1150 @code{--enable-libfreetype}.
1151 To enable default font fallback and the @var{font} option you need to
1152 configure Libav with @code{--enable-libfontconfig}.
1153
1154 The filter also recognizes strftime() sequences in the provided text
1155 and expands them accordingly. Check the documentation of strftime().
1156
1157 It accepts the following parameters:
1158
1159 @table @option
1160
1161 @item font
1162 The font family to be used for drawing text. By default Sans.
1163
1164 @item fontfile
1165 The font file to be used for drawing text. The path must be included.
1166 This parameter is mandatory if the fontconfig support is disabled.
1167
1168 @item text
1169 The text string to be drawn. The text must be a sequence of UTF-8
1170 encoded characters.
1171 This parameter is mandatory if no file is specified with the parameter
1172 @var{textfile}.
1173
1174 @item textfile
1175 A text file containing text to be drawn. The text must be a sequence
1176 of UTF-8 encoded characters.
1177
1178 This parameter is mandatory if no text string is specified with the
1179 parameter @var{text}.
1180
1181 If both text and textfile are specified, an error is thrown.
1182
1183 @item x, y
1184 The offsets where text will be drawn within the video frame.
1185 It is relative to the top/left border of the output image.
1186 They accept expressions similar to the @ref{overlay} filter:
1187 @table @option
1188
1189 @item x, y
1190 The computed values for @var{x} and @var{y}. They are evaluated for
1191 each new frame.
1192
1193 @item main_w, main_h
1194 The main input width and height.
1195
1196 @item W, H
1197 These are the same as @var{main_w} and @var{main_h}.
1198
1199 @item text_w, text_h
1200 The rendered text's width and height.
1201
1202 @item w, h
1203 These are the same as @var{text_w} and @var{text_h}.
1204
1205 @item n
1206 The number of frames processed, starting from 0.
1207
1208 @item t
1209 The timestamp, expressed in seconds. It's NAN if the input timestamp is unknown.
1210
1211 @end table
1212
1213 The default value of @var{x} and @var{y} is 0.
1214
1215 @item draw
1216 Draw the text only if the expression evaluates as non-zero.
1217 The expression accepts the same variables @var{x, y} do.
1218 The default value is 1.
1219
1220 @item alpha
1221 Draw the text applying alpha blending. The value can
1222 be either a number between 0.0 and 1.0
1223 The expression accepts the same variables @var{x, y} do.
1224 The default value is 1.
1225
1226 @item fontsize
1227 The font size to be used for drawing text.
1228 The default value of @var{fontsize} is 16.
1229
1230 @item fontcolor
1231 The color to be used for drawing fonts.
1232 It is either a string (e.g. "red"), or in 0xRRGGBB[AA] format
1233 (e.g. "0xff000033"), possibly followed by an alpha specifier.
1234 The default value of @var{fontcolor} is "black".
1235
1236 @item boxcolor
1237 The color to be used for drawing box around text.
1238 It is either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
1239 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1240 The default value of @var{boxcolor} is "white".
1241
1242 @item box
1243 Used to draw a box around text using the background color.
1244 The value must be either 1 (enable) or 0 (disable).
1245 The default value of @var{box} is 0.
1246
1247 @item shadowx, shadowy
1248 The x and y offsets for the text shadow position with respect to the
1249 position of the text. They can be either positive or negative
1250 values. The default value for both is "0".
1251
1252 @item shadowcolor
1253 The color to be used for drawing a shadow behind the drawn text.  It
1254 can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
1255 form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
1256 The default value of @var{shadowcolor} is "black".
1257
1258 @item ft_load_flags
1259 The flags to be used for loading the fonts.
1260
1261 The flags map the corresponding flags supported by libfreetype, and are
1262 a combination of the following values:
1263 @table @var
1264 @item default
1265 @item no_scale
1266 @item no_hinting
1267 @item render
1268 @item no_bitmap
1269 @item vertical_layout
1270 @item force_autohint
1271 @item crop_bitmap
1272 @item pedantic
1273 @item ignore_global_advance_width
1274 @item no_recurse
1275 @item ignore_transform
1276 @item monochrome
1277 @item linear_design
1278 @item no_autohint
1279 @item end table
1280 @end table
1281
1282 Default value is "render".
1283
1284 For more information consult the documentation for the FT_LOAD_*
1285 libfreetype flags.
1286
1287 @item tabsize
1288 The size in number of spaces to use for rendering the tab.
1289 Default value is 4.
1290
1291 @item fix_bounds
1292 If true, check and fix text coords to avoid clipping.
1293 @end table
1294
1295 For example the command:
1296 @example
1297 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
1298 @end example
1299
1300 will draw "Test Text" with font FreeSerif, using the default values
1301 for the optional parameters.
1302
1303 The command:
1304 @example
1305 drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
1306           x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
1307 @end example
1308
1309 will draw 'Test Text' with font FreeSerif of size 24 at position x=100
1310 and y=50 (counting from the top-left corner of the screen), text is
1311 yellow with a red box around it. Both the text and the box have an
1312 opacity of 20%.
1313
1314 Note that the double quotes are not necessary if spaces are not used
1315 within the parameter list.
1316
1317 For more information about libfreetype, check:
1318 @url{http://www.freetype.org/}.
1319
1320 @section fade
1321
1322 Apply a fade-in/out effect to the input video.
1323
1324 It accepts the following parameters:
1325
1326 @table @option
1327
1328 @item type
1329 The effect type can be either "in" for a fade-in, or "out" for a fade-out
1330 effect.
1331
1332 @item start_frame
1333 The number of the frame to start applying the fade effect at.
1334
1335 @item nb_frames
1336 The number of frames that the fade effect lasts. At the end of the
1337 fade-in effect, the output video will have the same intensity as the input video.
1338 At the end of the fade-out transition, the output video will be completely black.
1339
1340 @end table
1341
1342 Some examples:
1343 @example
1344 # Fade in the first 30 frames of video
1345 fade=type=in:nb_frames=30
1346
1347 # Fade out the last 45 frames of a 200-frame video
1348 fade=type=out:start_frame=155:nb_frames=45
1349
1350 # Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video
1351 fade=type=in:start_frame=0:nb_frames=25, fade=type=out:start_frame=975:nb_frames=25
1352
1353 # Make the first 5 frames black, then fade in from frame 5-24
1354 fade=type=in:start_frame=5:nb_frames=20
1355 @end example
1356
1357 @section fieldorder
1358
1359 Transform the field order of the input video.
1360
1361 It accepts the following parameters:
1362
1363 @table @option
1364
1365 @item order
1366 The output field order. Valid values are @var{tff} for top field first or @var{bff}
1367 for bottom field first.
1368 @end table
1369
1370 The default value is "tff".
1371
1372 The transformation is done by shifting the picture content up or down
1373 by one line, and filling the remaining line with appropriate picture content.
1374 This method is consistent with most broadcast field order converters.
1375
1376 If the input video is not flagged as being interlaced, or it is already
1377 flagged as being of the required output field order, then this filter does
1378 not alter the incoming video.
1379
1380 It is very useful when converting to or from PAL DV material,
1381 which is bottom field first.
1382
1383 For example:
1384 @example
1385 ./avconv -i in.vob -vf "fieldorder=order=bff" out.dv
1386 @end example
1387
1388 @section fifo
1389
1390 Buffer input images and send them when they are requested.
1391
1392 It is mainly useful when auto-inserted by the libavfilter
1393 framework.
1394
1395 It does not take parameters.
1396
1397 @section format
1398
1399 Convert the input video to one of the specified pixel formats.
1400 Libavfilter will try to pick one that is suitable as input to
1401 the next filter.
1402
1403 It accepts the following parameters:
1404 @table @option
1405
1406 @item pix_fmts
1407 A '|'-separated list of pixel format names, such as
1408 "pix_fmts=yuv420p|monow|rgb24".
1409
1410 @end table
1411
1412 Some examples:
1413 @example
1414 # Convert the input video to the "yuv420p" format
1415 format=pix_fmts=yuv420p
1416
1417 # Convert the input video to any of the formats in the list
1418 format=pix_fmts=yuv420p|yuv444p|yuv410p
1419 @end example
1420
1421 @anchor{fps}
1422 @section fps
1423
1424 Convert the video to specified constant framerate by duplicating or dropping
1425 frames as necessary.
1426
1427 It accepts the following parameters:
1428 @table @option
1429
1430 @item fps
1431 The desired output framerate.
1432
1433 @item start_time
1434 Assume the first PTS should be the given value, in seconds. This allows for
1435 padding/trimming at the start of stream. By default, no assumption is made
1436 about the first frame's expected PTS, so no padding or trimming is done.
1437 For example, this could be set to 0 to pad the beginning with duplicates of
1438 the first frame if a video stream starts after the audio stream or to trim any
1439 frames with a negative PTS.
1440
1441 @end table
1442
1443 @section framepack
1444
1445 Pack two different video streams into a stereoscopic video, setting proper
1446 metadata on supported codecs. The two views should have the same size and
1447 framerate and processing will stop when the shorter video ends. Please note
1448 that you may conveniently adjust view properties with the @ref{scale} and
1449 @ref{fps} filters.
1450
1451 It accepts the following parameters:
1452 @table @option
1453
1454 @item format
1455 The desired packing format. Supported values are:
1456
1457 @table @option
1458
1459 @item sbs
1460 The views are next to each other (default).
1461
1462 @item tab
1463 The views are on top of each other.
1464
1465 @item lines
1466 The views are packed by line.
1467
1468 @item columns
1469 The views are packed by column.
1470
1471 @item frameseq
1472 The views are temporally interleaved.
1473
1474 @end table
1475
1476 @end table
1477
1478 Some examples:
1479
1480 @example
1481 # Convert left and right views into a frame-sequential video
1482 avconv -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
1483
1484 # Convert views into a side-by-side video with the same output resolution as the input
1485 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
1486 @end example
1487
1488 @anchor{frei0r}
1489 @section frei0r
1490
1491 Apply a frei0r effect to the input video.
1492
1493 To enable the compilation of this filter, you need to install the frei0r
1494 header and configure Libav with --enable-frei0r.
1495
1496 It accepts the following parameters:
1497
1498 @table @option
1499
1500 @item filter_name
1501 The name of the frei0r effect to load. If the environment variable
1502 @env{FREI0R_PATH} is defined, the frei0r effect is searched for in each of the
1503 directories specified by the colon-separated list in @env{FREIOR_PATH}.
1504 Otherwise, the standard frei0r paths are searched, in this order:
1505 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
1506 @file{/usr/lib/frei0r-1/}.
1507
1508 @item filter_params
1509 A '|'-separated list of parameters to pass to the frei0r effect.
1510
1511 @end table
1512
1513 A frei0r effect parameter can be a boolean (its value is either
1514 "y" or "n"), a double, a color (specified as
1515 @var{R}/@var{G}/@var{B}, where @var{R}, @var{G}, and @var{B} are floating point
1516 numbers between 0.0 and 1.0, inclusive) or by an @code{av_parse_color()} color
1517 description), a position (specified as @var{X}/@var{Y}, where
1518 @var{X} and @var{Y} are floating point numbers) and/or a string.
1519
1520 The number and types of parameters depend on the loaded effect. If an
1521 effect parameter is not specified, the default value is set.
1522
1523 Some examples:
1524 @example
1525 # Apply the distort0r effect, setting the first two double parameters
1526 frei0r=filter_name=distort0r:filter_params=0.5|0.01
1527
1528 # Apply the colordistance effect, taking a color as the first parameter
1529 frei0r=colordistance:0.2/0.3/0.4
1530 frei0r=colordistance:violet
1531 frei0r=colordistance:0x112233
1532
1533 # Apply the perspective effect, specifying the top left and top right
1534 # image positions
1535 frei0r=perspective:0.2/0.2|0.8/0.2
1536 @end example
1537
1538 For more information, see
1539 @url{http://piksel.org/frei0r}
1540
1541 @section gradfun
1542
1543 Fix the banding artifacts that are sometimes introduced into nearly flat
1544 regions by truncation to 8bit colordepth.
1545 Interpolate the gradients that should go where the bands are, and
1546 dither them.
1547
1548 It is designed for playback only.  Do not use it prior to
1549 lossy compression, because compression tends to lose the dither and
1550 bring back the bands.
1551
1552 It accepts the following parameters:
1553
1554 @table @option
1555
1556 @item strength
1557 The maximum amount by which the filter will change any one pixel. This is also
1558 the threshold for detecting nearly flat regions. Acceptable values range from
1559 .51 to 64; the default value is 1.2. Out-of-range values will be clipped to the
1560 valid range.
1561
1562 @item radius
1563 The neighborhood to fit the gradient to. A larger radius makes for smoother
1564 gradients, but also prevents the filter from modifying the pixels near detailed
1565 regions. Acceptable values are 8-32; the default value is 16. Out-of-range
1566 values will be clipped to the valid range.
1567
1568 @end table
1569
1570 @example
1571 # Default parameters
1572 gradfun=strength=1.2:radius=16
1573
1574 # Omitting the radius
1575 gradfun=1.2
1576 @end example
1577
1578 @section hflip
1579
1580 Flip the input video horizontally.
1581
1582 For example, to horizontally flip the input video with @command{avconv}:
1583 @example
1584 avconv -i in.avi -vf "hflip" out.avi
1585 @end example
1586
1587 @section hqdn3d
1588
1589 This is a high precision/quality 3d denoise filter. It aims to reduce
1590 image noise, producing smooth images and making still images really
1591 still. It should enhance compressibility.
1592
1593 It accepts the following optional parameters:
1594
1595 @table @option
1596 @item luma_spatial
1597 A non-negative floating point number which specifies spatial luma strength.
1598 It defaults to 4.0.
1599
1600 @item chroma_spatial
1601 A non-negative floating point number which specifies spatial chroma strength.
1602 It defaults to 3.0*@var{luma_spatial}/4.0.
1603
1604 @item luma_tmp
1605 A floating point number which specifies luma temporal strength. It defaults to
1606 6.0*@var{luma_spatial}/4.0.
1607
1608 @item chroma_tmp
1609 A floating point number which specifies chroma temporal strength. It defaults to
1610 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}.
1611 @end table
1612
1613 @section interlace
1614
1615 Simple interlacing filter from progressive contents. This interleaves upper (or
1616 lower) lines from odd frames with lower (or upper) lines from even frames,
1617 halving the frame rate and preserving image height.
1618
1619 @example
1620    Original        Original             New Frame
1621    Frame 'j'      Frame 'j+1'             (tff)
1622   ==========      ===========       ==================
1623     Line 0  -------------------->    Frame 'j' Line 0
1624     Line 1          Line 1  ---->   Frame 'j+1' Line 1
1625     Line 2 --------------------->    Frame 'j' Line 2
1626     Line 3          Line 3  ---->   Frame 'j+1' Line 3
1627      ...             ...                   ...
1628 New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
1629 @end example
1630
1631 It accepts the following optional parameters:
1632
1633 @table @option
1634 @item scan
1635 This determines whether the interlaced frame is taken from the even
1636 (tff - default) or odd (bff) lines of the progressive frame.
1637
1638 @item lowpass
1639 Enable (default) or disable the vertical lowpass filter to avoid twitter
1640 interlacing and reduce moire patterns.
1641 @end table
1642
1643 @section lut, lutrgb, lutyuv
1644
1645 Compute a look-up table for binding each pixel component input value
1646 to an output value, and apply it to the input video.
1647
1648 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1649 to an RGB input video.
1650
1651 These filters accept the following parameters:
1652 @table @option
1653 @item @var{c0} (first  pixel component)
1654 @item @var{c1} (second pixel component)
1655 @item @var{c2} (third  pixel component)
1656 @item @var{c3} (fourth pixel component, corresponds to the alpha component)
1657
1658 @item @var{r} (red component)
1659 @item @var{g} (green component)
1660 @item @var{b} (blue component)
1661 @item @var{a} (alpha component)
1662
1663 @item @var{y} (Y/luminance component)
1664 @item @var{u} (U/Cb component)
1665 @item @var{v} (V/Cr component)
1666 @end table
1667
1668 Each of them specifies the expression to use for computing the lookup table for
1669 the corresponding pixel component values.
1670
1671 The exact component associated to each of the @var{c*} options depends on the
1672 format in input.
1673
1674 The @var{lut} filter requires either YUV or RGB pixel formats in input,
1675 @var{lutrgb} requires RGB pixel formats in input, and @var{lutyuv} requires YUV.
1676
1677 The expressions can contain the following constants and functions:
1678
1679 @table @option
1680 @item E, PI, PHI
1681 These are approximated values for the mathematical constants e
1682 (Euler's number), pi (Greek pi), and phi (the golden ratio).
1683
1684 @item w, h
1685 The input width and height.
1686
1687 @item val
1688 The input value for the pixel component.
1689
1690 @item clipval
1691 The input value, clipped to the @var{minval}-@var{maxval} range.
1692
1693 @item maxval
1694 The maximum value for the pixel component.
1695
1696 @item minval
1697 The minimum value for the pixel component.
1698
1699 @item negval
1700 The negated value for the pixel component value, clipped to the
1701 @var{minval}-@var{maxval} range; it corresponds to the expression
1702 "maxval-clipval+minval".
1703
1704 @item clip(val)
1705 The computed value in @var{val}, clipped to the
1706 @var{minval}-@var{maxval} range.
1707
1708 @item gammaval(gamma)
1709 The computed gamma correction value of the pixel component value,
1710 clipped to the @var{minval}-@var{maxval} range. It corresponds to the
1711 expression
1712 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1713
1714 @end table
1715
1716 All expressions default to "val".
1717
1718 Some examples:
1719 @example
1720 # Negate input video
1721 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1722 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1723
1724 # The above is the same as
1725 lutrgb="r=negval:g=negval:b=negval"
1726 lutyuv="y=negval:u=negval:v=negval"
1727
1728 # Negate luminance
1729 lutyuv=negval
1730
1731 # Remove chroma components, turning the video into a graytone image
1732 lutyuv="u=128:v=128"
1733
1734 # Apply a luma burning effect
1735 lutyuv="y=2*val"
1736
1737 # Remove green and blue components
1738 lutrgb="g=0:b=0"
1739
1740 # Set a constant alpha channel value on input
1741 format=rgba,lutrgb=a="maxval-minval/2"
1742
1743 # Correct luminance gamma by a factor of 0.5
1744 lutyuv=y=gammaval(0.5)
1745 @end example
1746
1747 @section negate
1748
1749 Negate input video.
1750
1751 It accepts an integer in input; if non-zero it negates the
1752 alpha component (if available). The default value in input is 0.
1753
1754 @section noformat
1755
1756 Force libavfilter not to use any of the specified pixel formats for the
1757 input to the next filter.
1758
1759 It accepts the following parameters:
1760 @table @option
1761
1762 @item pix_fmts
1763 A '|'-separated list of pixel format names, such as
1764 apix_fmts=yuv420p|monow|rgb24".
1765
1766 @end table
1767
1768 Some examples:
1769 @example
1770 # Force libavfilter to use a format different from "yuv420p" for the
1771 # input to the vflip filter
1772 noformat=pix_fmts=yuv420p,vflip
1773
1774 # Convert the input video to any of the formats not contained in the list
1775 noformat=yuv420p|yuv444p|yuv410p
1776 @end example
1777
1778 @section null
1779
1780 Pass the video source unchanged to the output.
1781
1782 @section ocv
1783
1784 Apply a video transform using libopencv.
1785
1786 To enable this filter, install the libopencv library and headers and
1787 configure Libav with --enable-libopencv.
1788
1789 It accepts the following parameters:
1790
1791 @table @option
1792
1793 @item filter_name
1794 The name of the libopencv filter to apply.
1795
1796 @item filter_params
1797 The parameters to pass to the libopencv filter. If not specified, the default
1798 values are assumed.
1799
1800 @end table
1801
1802 Refer to the official libopencv documentation for more precise
1803 information:
1804 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1805
1806 Several libopencv filters are supported; see the following subsections.
1807
1808 @anchor{dilate}
1809 @subsection dilate
1810
1811 Dilate an image by using a specific structuring element.
1812 It corresponds to the libopencv function @code{cvDilate}.
1813
1814 It accepts the parameters: @var{struct_el}|@var{nb_iterations}.
1815
1816 @var{struct_el} represents a structuring element, and has the syntax:
1817 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1818
1819 @var{cols} and @var{rows} represent the number of columns and rows of
1820 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1821 point, and @var{shape} the shape for the structuring element. @var{shape}
1822 must be "rect", "cross", "ellipse", or "custom".
1823
1824 If the value for @var{shape} is "custom", it must be followed by a
1825 string of the form "=@var{filename}". The file with name
1826 @var{filename} is assumed to represent a binary image, with each
1827 printable character corresponding to a bright pixel. When a custom
1828 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1829 or columns and rows of the read file are assumed instead.
1830
1831 The default value for @var{struct_el} is "3x3+0x0/rect".
1832
1833 @var{nb_iterations} specifies the number of times the transform is
1834 applied to the image, and defaults to 1.
1835
1836 Some examples:
1837 @example
1838 # Use the default values
1839 ocv=dilate
1840
1841 # Dilate using a structuring element with a 5x5 cross, iterating two times
1842 ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
1843
1844 # Read the shape from the file diamond.shape, iterating two times.
1845 # The file diamond.shape may contain a pattern of characters like this
1846 #   *
1847 #  ***
1848 # *****
1849 #  ***
1850 #   *
1851 # The specified columns and rows are ignored
1852 # but the anchor point coordinates are not
1853 ocv=dilate:0x0+2x2/custom=diamond.shape|2
1854 @end example
1855
1856 @subsection erode
1857
1858 Erode an image by using a specific structuring element.
1859 It corresponds to the libopencv function @code{cvErode}.
1860
1861 It accepts the parameters: @var{struct_el}:@var{nb_iterations},
1862 with the same syntax and semantics as the @ref{dilate} filter.
1863
1864 @subsection smooth
1865
1866 Smooth the input video.
1867
1868 The filter takes the following parameters:
1869 @var{type}|@var{param1}|@var{param2}|@var{param3}|@var{param4}.
1870
1871 @var{type} is the type of smooth filter to apply, and must be one of
1872 the following values: "blur", "blur_no_scale", "median", "gaussian",
1873 or "bilateral". The default value is "gaussian".
1874
1875 The meaning of @var{param1}, @var{param2}, @var{param3}, and @var{param4}
1876 depend on the smooth type. @var{param1} and
1877 @var{param2} accept integer positive values or 0. @var{param3} and
1878 @var{param4} accept floating point values.
1879
1880 The default value for @var{param1} is 3. The default value for the
1881 other parameters is 0.
1882
1883 These parameters correspond to the parameters assigned to the
1884 libopencv function @code{cvSmooth}.
1885
1886 @anchor{overlay}
1887 @section overlay
1888
1889 Overlay one video on top of another.
1890
1891 It takes two inputs and has one output. The first input is the "main"
1892 video on which the second input is overlayed.
1893
1894 It accepts the following parameters:
1895
1896 @table @option
1897
1898 @item x
1899 The horizontal position of the left edge of the overlaid video on the main video.
1900
1901 @item y
1902 The vertical position of the top edge of the overlaid video on the main video.
1903
1904 @end table
1905
1906 The parameters are expressions containing the following parameters:
1907
1908 @table @option
1909 @item main_w, main_h
1910 The main input width and height.
1911
1912 @item W, H
1913 These are the same as @var{main_w} and @var{main_h}.
1914
1915 @item overlay_w, overlay_h
1916 The overlay input width and height.
1917
1918 @item w, h
1919 These are the same as @var{overlay_w} and @var{overlay_h}.
1920
1921 @item eof_action
1922 The action to take when EOF is encountered on the secondary input; it accepts
1923 one of the following values:
1924
1925 @table @option
1926 @item repeat
1927 Repeat the last frame (the default).
1928 @item endall
1929 End both streams.
1930 @item pass
1931 Pass the main input through.
1932 @end table
1933
1934 @end table
1935
1936 Be aware that frames are taken from each input video in timestamp
1937 order, hence, if their initial timestamps differ, it is a a good idea
1938 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1939 have them begin in the same zero timestamp, as the example for
1940 the @var{movie} filter does.
1941
1942 Some examples:
1943 @example
1944 # Draw the overlay at 10 pixels from the bottom right
1945 # corner of the main video
1946 overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
1947
1948 # Insert a transparent PNG logo in the bottom left corner of the input
1949 avconv -i input -i logo -filter_complex 'overlay=x=10:y=main_h-overlay_h-10' output
1950
1951 # Insert 2 different transparent PNG logos (second logo on bottom
1952 # right corner)
1953 avconv -i input -i logo1 -i logo2 -filter_complex
1954 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
1955
1956 # Add a transparent color layer on top of the main video;
1957 # WxH specifies the size of the main input to the overlay filter
1958 color=red@.3:WxH [over]; [in][over] overlay [out]
1959
1960 # Mask 10-20 seconds of a video by applying the delogo filter to a section
1961 avconv -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
1962 -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]'
1963 masked.avi
1964 @end example
1965
1966 You can chain together more overlays but the efficiency of such
1967 approach is yet to be tested.
1968
1969 @section pad
1970
1971 Add paddings to the input image, and place the original input at the
1972 provided @var{x}, @var{y} coordinates.
1973
1974 It accepts the following parameters:
1975
1976 @table @option
1977 @item width, height
1978
1979 Specify the size of the output image with the paddings added. If the
1980 value for @var{width} or @var{height} is 0, the corresponding input size
1981 is used for the output.
1982
1983 The @var{width} expression can reference the value set by the
1984 @var{height} expression, and vice versa.
1985
1986 The default value of @var{width} and @var{height} is 0.
1987
1988 @item x, y
1989
1990 Specify the offsets to place the input image at within the padded area,
1991 with respect to the top/left border of the output image.
1992
1993 The @var{x} expression can reference the value set by the @var{y}
1994 expression, and vice versa.
1995
1996 The default value of @var{x} and @var{y} is 0.
1997
1998 @item color
1999
2000 Specify the color of the padded area. It can be the name of a color
2001 (case insensitive match) or an 0xRRGGBB[AA] sequence.
2002
2003 The default value of @var{color} is "black".
2004
2005 @end table
2006
2007 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
2008 expressions containing the following constants:
2009
2010 @table @option
2011 @item E, PI, PHI
2012 These are approximated values for the mathematical constants e
2013 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2014
2015 @item in_w, in_h
2016 The input video width and height.
2017
2018 @item iw, ih
2019 These are the same as @var{in_w} and @var{in_h}.
2020
2021 @item out_w, out_h
2022 The output width and height (the size of the padded area), as
2023 specified by the @var{width} and @var{height} expressions.
2024
2025 @item ow, oh
2026 These are the same as @var{out_w} and @var{out_h}.
2027
2028 @item x, y
2029 The x and y offsets as specified by the @var{x} and @var{y}
2030 expressions, or NAN if not yet specified.
2031
2032 @item a
2033 The input display aspect ratio, same as @var{iw} / @var{ih}.
2034
2035 @item hsub, vsub
2036 The horizontal and vertical chroma subsample values. For example for the
2037 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2038 @end table
2039
2040 Some examples:
2041
2042 @example
2043 # Add paddings with the color "violet" to the input video. The output video
2044 # size is 640x480, and the top-left corner of the input video is placed at
2045 # column 0, row 40
2046 pad=width=640:height=480:x=0:y=40:color=violet
2047
2048 # Pad the input to get an output with dimensions increased by 3/2,
2049 # and put the input video at the center of the padded area
2050 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
2051
2052 # Pad the input to get a squared output with size equal to the maximum
2053 # value between the input width and height, and put the input video at
2054 # the center of the padded area
2055 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
2056
2057 # Pad the input to get a final w/h ratio of 16:9
2058 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
2059
2060 # Double the output size and put the input video in the bottom-right
2061 # corner of the output padded area
2062 pad="2*iw:2*ih:ow-iw:oh-ih"
2063 @end example
2064
2065 @section pixdesctest
2066
2067 Pixel format descriptor test filter, mainly useful for internal
2068 testing. The output video should be equal to the input video.
2069
2070 For example:
2071 @example
2072 format=monow, pixdesctest
2073 @end example
2074
2075 can be used to test the monowhite pixel format descriptor definition.
2076
2077 @anchor{scale}
2078 @section scale
2079
2080 Scale the input video and/or convert the image format.
2081
2082 It accepts the following parameters:
2083
2084 @table @option
2085
2086 @item w
2087 The output video width.
2088
2089 @item h
2090 The output video height.
2091
2092 @end table
2093
2094 The parameters @var{w} and @var{h} are expressions containing
2095 the following constants:
2096
2097 @table @option
2098 @item E, PI, PHI
2099 These are approximated values for the mathematical constants e
2100 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2101
2102 @item in_w, in_h
2103 The input width and height.
2104
2105 @item iw, ih
2106 These are the same as @var{in_w} and @var{in_h}.
2107
2108 @item out_w, out_h
2109 The output (cropped) width and height.
2110
2111 @item ow, oh
2112 These are the same as @var{out_w} and @var{out_h}.
2113
2114 @item a
2115 This is the same as @var{iw} / @var{ih}.
2116
2117 @item sar
2118 input sample aspect ratio
2119
2120 @item dar
2121 The input display aspect ratio; it is the same as
2122 (@var{iw} / @var{ih}) * @var{sar}.
2123
2124 @item hsub, vsub
2125 The horizontal and vertical chroma subsample values. For example, for the
2126 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2127 @end table
2128
2129 If the input image format is different from the format requested by
2130 the next filter, the scale filter will convert the input to the
2131 requested format.
2132
2133 If the value for @var{w} or @var{h} is 0, the respective input
2134 size is used for the output.
2135
2136 If the value for @var{w} or @var{h} is -1, the scale filter will use, for the
2137 respective output size, a value that maintains the aspect ratio of the input
2138 image.
2139
2140 The default value of @var{w} and @var{h} is 0.
2141
2142 Some examples:
2143 @example
2144 # Scale the input video to a size of 200x100
2145 scale=w=200:h=100
2146
2147 # Scale the input to 2x
2148 scale=w=2*iw:h=2*ih
2149 # The above is the same as
2150 scale=2*in_w:2*in_h
2151
2152 # Scale the input to half the original size
2153 scale=w=iw/2:h=ih/2
2154
2155 # Increase the width, and set the height to the same size
2156 scale=3/2*iw:ow
2157
2158 # Seek Greek harmony
2159 scale=iw:1/PHI*iw
2160 scale=ih*PHI:ih
2161
2162 # Increase the height, and set the width to 3/2 of the height
2163 scale=w=3/2*oh:h=3/5*ih
2164
2165 # Increase the size, making the size a multiple of the chroma
2166 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
2167
2168 # Increase the width to a maximum of 500 pixels,
2169 # keeping the same aspect ratio as the input
2170 scale=w='min(500\, iw*3/2):h=-1'
2171 @end example
2172
2173 @section select
2174 Select frames to pass in output.
2175
2176 It accepts the following parameters:
2177
2178 @table @option
2179
2180 @item expr
2181 An expression, which is evaluated for each input frame. If the expression is
2182 evaluated to a non-zero value, the frame is selected and passed to the output,
2183 otherwise it is discarded.
2184
2185 @end table
2186
2187 The expression can contain the following constants:
2188
2189 @table @option
2190 @item E, PI, PHI
2191 These are approximated values for the mathematical constants e
2192 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2193
2194 @item n
2195 The (sequential) number of the filtered frame, starting from 0.
2196
2197 @item selected_n
2198 The (sequential) number of the selected frame, starting from 0.
2199
2200 @item prev_selected_n
2201 The sequential number of the last selected frame. It's NAN if undefined.
2202
2203 @item TB
2204 The timebase of the input timestamps.
2205
2206 @item pts
2207 The PTS (Presentation TimeStamp) of the filtered video frame,
2208 expressed in @var{TB} units. It's NAN if undefined.
2209
2210 @item t
2211 The PTS of the filtered video frame,
2212 expressed in seconds. It's NAN if undefined.
2213
2214 @item prev_pts
2215 The PTS of the previously filtered video frame. It's NAN if undefined.
2216
2217 @item prev_selected_pts
2218 The PTS of the last previously filtered video frame. It's NAN if undefined.
2219
2220 @item prev_selected_t
2221 The PTS of the last previously selected video frame. It's NAN if undefined.
2222
2223 @item start_pts
2224 The PTS of the first video frame in the video. It's NAN if undefined.
2225
2226 @item start_t
2227 The time of the first video frame in the video. It's NAN if undefined.
2228
2229 @item pict_type
2230 The type of the filtered frame. It can assume one of the following
2231 values:
2232 @table @option
2233 @item I
2234 @item P
2235 @item B
2236 @item S
2237 @item SI
2238 @item SP
2239 @item BI
2240 @end table
2241
2242 @item interlace_type
2243 The frame interlace type. It can assume one of the following values:
2244 @table @option
2245 @item PROGRESSIVE
2246 The frame is progressive (not interlaced).
2247 @item TOPFIRST
2248 The frame is top-field-first.
2249 @item BOTTOMFIRST
2250 The frame is bottom-field-first.
2251 @end table
2252
2253 @item key
2254 This is 1 if the filtered frame is a key-frame, 0 otherwise.
2255
2256 @end table
2257
2258 The default value of the select expression is "1".
2259
2260 Some examples:
2261
2262 @example
2263 # Select all the frames in input
2264 select
2265
2266 # The above is the same as
2267 select=expr=1
2268
2269 # Skip all frames
2270 select=expr=0
2271
2272 # Select only I-frames
2273 select='expr=eq(pict_type\,I)'
2274
2275 # Select one frame per 100
2276 select='not(mod(n\,100))'
2277
2278 # Select only frames contained in the 10-20 time interval
2279 select='gte(t\,10)*lte(t\,20)'
2280
2281 # Select only I frames contained in the 10-20 time interval
2282 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2283
2284 # Select frames with a minimum distance of 10 seconds
2285 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2286 @end example
2287
2288 @anchor{setdar}
2289 @section setdar
2290
2291 Set the Display Aspect Ratio for the filter output video.
2292
2293 This is done by changing the specified Sample (aka Pixel) Aspect
2294 Ratio, according to the following equation:
2295 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2296
2297 Keep in mind that this filter does not modify the pixel dimensions of
2298 the video frame. Also, the display aspect ratio set by this filter may
2299 be changed by later filters in the filterchain, e.g. in case of
2300 scaling or if another "setdar" or a "setsar" filter is applied.
2301
2302 It accepts the following parameters:
2303
2304 @table @option
2305
2306 @item dar
2307 The output display aspect ratio.
2308
2309 @end table
2310
2311 The parameter @var{dar} is an expression containing
2312 the following constants:
2313
2314 @table @option
2315 @item E, PI, PHI
2316 These are approximated values for the mathematical constants e
2317 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2318
2319 @item w, h
2320 The input width and height.
2321
2322 @item a
2323 This is the same as @var{w} / @var{h}.
2324
2325 @item sar
2326 The input sample aspect ratio.
2327
2328 @item dar
2329 The input display aspect ratio. It is the same as
2330 (@var{w} / @var{h}) * @var{sar}.
2331
2332 @item hsub, vsub
2333 The horizontal and vertical chroma subsample values. For example, for the
2334 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2335 @end table
2336
2337 To change the display aspect ratio to 16:9, specify:
2338 @example
2339 setdar=dar=16/9
2340 # The above is equivalent to
2341 setdar=dar=1.77777
2342 @end example
2343
2344 Also see the the @ref{setsar} filter documentation.
2345
2346 @section setpts
2347
2348 Change the PTS (presentation timestamp) of the input video frames.
2349
2350 It accepts the following parameters:
2351
2352 @table @option
2353
2354 @item expr
2355 The expression which is evaluated for each frame to construct its timestamp.
2356
2357 @end table
2358
2359 The expression is evaluated through the eval API and can contain the following
2360 constants:
2361
2362 @table @option
2363 @item PTS
2364 The presentation timestamp in input.
2365
2366 @item E, PI, PHI
2367 These are approximated values for the mathematical constants e
2368 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2369
2370 @item N
2371 The count of the input frame, starting from 0.
2372
2373 @item STARTPTS
2374 The PTS of the first video frame.
2375
2376 @item INTERLACED
2377 State whether the current frame is interlaced.
2378
2379 @item PREV_INPTS
2380 The previous input PTS.
2381
2382 @item PREV_OUTPTS
2383 The previous output PTS.
2384
2385 @item RTCTIME
2386 The wallclock (RTC) time in microseconds.
2387
2388 @item RTCSTART
2389 The wallclock (RTC) time at the start of the movie in microseconds.
2390
2391 @item TB
2392 The timebase of the input timestamps.
2393
2394 @end table
2395
2396 Some examples:
2397
2398 @example
2399 # Start counting the PTS from zero
2400 setpts=expr=PTS-STARTPTS
2401
2402 # Fast motion
2403 setpts=expr=0.5*PTS
2404
2405 # Slow motion
2406 setpts=2.0*PTS
2407
2408 # Fixed rate 25 fps
2409 setpts=N/(25*TB)
2410
2411 # Fixed rate 25 fps with some jitter
2412 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2413
2414 # Generate timestamps from a "live source" and rebase onto the current timebase
2415 setpts='(RTCTIME - RTCSTART) / (TB * 1000000)"
2416 @end example
2417
2418 @anchor{setsar}
2419 @section setsar
2420
2421 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
2422
2423 Note that as a consequence of the application of this filter, the
2424 output display aspect ratio will change according to the following
2425 equation:
2426 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2427
2428 Keep in mind that the sample aspect ratio set by this filter may be
2429 changed by later filters in the filterchain, e.g. if another "setsar"
2430 or a "setdar" filter is applied.
2431
2432 It accepts the following parameters:
2433
2434 @table @option
2435
2436 @item sar
2437 The output sample aspect ratio.
2438
2439 @end table
2440
2441 The parameter @var{sar} is an expression containing
2442 the following constants:
2443
2444 @table @option
2445 @item E, PI, PHI
2446 These are approximated values for the mathematical constants e
2447 (Euler's number), pi (Greek pi), and phi (the golden ratio).
2448
2449 @item w, h
2450 The input width and height.
2451
2452 @item a
2453 These are the same as @var{w} / @var{h}.
2454
2455 @item sar
2456 The input sample aspect ratio.
2457
2458 @item dar
2459 The input display aspect ratio. It is the same as
2460 (@var{w} / @var{h}) * @var{sar}.
2461
2462 @item hsub, vsub
2463 Horizontal and vertical chroma subsample values. For example, for the
2464 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2465 @end table
2466
2467 To change the sample aspect ratio to 10:11, specify:
2468 @example
2469 setsar=sar=10/11
2470 @end example
2471
2472 @section settb
2473
2474 Set the timebase to use for the output frames timestamps.
2475 It is mainly useful for testing timebase configuration.
2476
2477 It accepts the following parameters:
2478
2479 @table @option
2480
2481 @item expr
2482 The expression which is evaluated into the output timebase.
2483
2484 @end table
2485
2486 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
2487 default timebase), and "intb" (the input timebase).
2488
2489 The default value for the input is "intb".
2490
2491 Some examples:
2492
2493 @example
2494 # Set the timebase to 1/25
2495 settb=expr=1/25
2496
2497 # Set the timebase to 1/10
2498 settb=expr=0.1
2499
2500 # Set the timebase to 1001/1000
2501 settb=1+0.001
2502
2503 #Set the timebase to 2*intb
2504 settb=2*intb
2505
2506 #Set the default timebase value
2507 settb=AVTB
2508 @end example
2509
2510 @section showinfo
2511
2512 Show a line containing various information for each input video frame.
2513 The input video is not modified.
2514
2515 The shown line contains a sequence of key/value pairs of the form
2516 @var{key}:@var{value}.
2517
2518 It accepts the following parameters:
2519
2520 @table @option
2521 @item n
2522 The (sequential) number of the input frame, starting from 0.
2523
2524 @item pts
2525 The Presentation TimeStamp of the input frame, expressed as a number of
2526 time base units. The time base unit depends on the filter input pad.
2527
2528 @item pts_time
2529 The Presentation TimeStamp of the input frame, expressed as a number of
2530 seconds.
2531
2532 @item pos
2533 The position of the frame in the input stream, or -1 if this information is
2534 unavailable and/or meaningless (for example in case of synthetic video).
2535
2536 @item fmt
2537 The pixel format name.
2538
2539 @item sar
2540 The sample aspect ratio of the input frame, expressed in the form
2541 @var{num}/@var{den}.
2542
2543 @item s
2544 The size of the input frame, expressed in the form
2545 @var{width}x@var{height}.
2546
2547 @item i
2548 The type of interlaced mode ("P" for "progressive", "T" for top field first, "B"
2549 for bottom field first).
2550
2551 @item iskey
2552 This is 1 if the frame is a key frame, 0 otherwise.
2553
2554 @item type
2555 The picture type of the input frame ("I" for an I-frame, "P" for a
2556 P-frame, "B" for a B-frame, or "?" for an unknown type).
2557 Also refer to the documentation of the @code{AVPictureType} enum and of
2558 the @code{av_get_picture_type_char} function defined in
2559 @file{libavutil/avutil.h}.
2560
2561 @item checksum
2562 The Adler-32 checksum of all the planes of the input frame.
2563
2564 @item plane_checksum
2565 The Adler-32 checksum of each plane of the input frame, expressed in the form
2566 "[@var{c0} @var{c1} @var{c2} @var{c3}]".
2567 @end table
2568
2569 @section shuffleplanes
2570
2571 Reorder and/or duplicate video planes.
2572
2573 It accepts the following parameters:
2574
2575 @table @option
2576
2577 @item map0
2578 The index of the input plane to be used as the first output plane.
2579
2580 @item map1
2581 The index of the input plane to be used as the second output plane.
2582
2583 @item map2
2584 The index of the input plane to be used as the third output plane.
2585
2586 @item map3
2587 The index of the input plane to be used as the fourth output plane.
2588
2589 @end table
2590
2591 The first plane has the index 0. The default is to keep the input unchanged.
2592
2593 Swap the second and third planes of the input:
2594 @example
2595 avconv -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
2596 @end example
2597
2598 @section split
2599
2600 Split input video into several identical outputs.
2601
2602 It accepts a single parameter, which specifies the number of outputs. If
2603 unspecified, it defaults to 2.
2604
2605 Create 5 copies of the input video:
2606 @example
2607 avconv -i INPUT -filter_complex split=5 OUTPUT
2608 @end example
2609
2610 @section transpose
2611
2612 Transpose rows with columns in the input video and optionally flip it.
2613
2614 It accepts the following parameters:
2615
2616 @table @option
2617
2618 @item dir
2619 The direction of the transpose.
2620
2621 @end table
2622
2623 The direction can assume the following values:
2624
2625 @table @samp
2626 @item cclock_flip
2627 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2628 @example
2629 L.R     L.l
2630 . . ->  . .
2631 l.r     R.r
2632 @end example
2633
2634 @item clock
2635 Rotate by 90 degrees clockwise, that is:
2636 @example
2637 L.R     l.L
2638 . . ->  . .
2639 l.r     r.R
2640 @end example
2641
2642 @item cclock
2643 Rotate by 90 degrees counterclockwise, that is:
2644 @example
2645 L.R     R.r
2646 . . ->  . .
2647 l.r     L.l
2648 @end example
2649
2650 @item clock_flip
2651 Rotate by 90 degrees clockwise and vertically flip, that is:
2652 @example
2653 L.R     r.R
2654 . . ->  . .
2655 l.r     l.L
2656 @end example
2657 @end table
2658
2659 @section trim
2660 Trim the input so that the output contains one continuous subpart of the input.
2661
2662 It accepts the following parameters:
2663 @table @option
2664 @item start
2665 The timestamp (in seconds) of the start of the kept section. The frame with the
2666 timestamp @var{start} will be the first frame in the output.
2667
2668 @item end
2669 The timestamp (in seconds) of the first frame that will be dropped. The frame
2670 immediately preceding the one with the timestamp @var{end} will be the last
2671 frame in the output.
2672
2673 @item start_pts
2674 This is the same as @var{start}, except this option sets the start timestamp
2675 in timebase units instead of seconds.
2676
2677 @item end_pts
2678 This is the same as @var{end}, except this option sets the end timestamp
2679 in timebase units instead of seconds.
2680
2681 @item duration
2682 The maximum duration of the output in seconds.
2683
2684 @item start_frame
2685 The number of the first frame that should be passed to the output.
2686
2687 @item end_frame
2688 The number of the first frame that should be dropped.
2689 @end table
2690
2691 Note that the first two sets of the start/end options and the @option{duration}
2692 option look at the frame timestamp, while the _frame variants simply count the
2693 frames that pass through the filter. Also note that this filter does not modify
2694 the timestamps. If you wish for the output timestamps to start at zero, insert a
2695 setpts filter after the trim filter.
2696
2697 If multiple start or end options are set, this filter tries to be greedy and
2698 keep all the frames that match at least one of the specified constraints. To keep
2699 only the part that matches all the constraints at once, chain multiple trim
2700 filters.
2701
2702 The defaults are such that all the input is kept. So it is possible to set e.g.
2703 just the end values to keep everything before the specified time.
2704
2705 Examples:
2706 @itemize
2707 @item
2708 Drop everything except the second minute of input:
2709 @example
2710 avconv -i INPUT -vf trim=60:120
2711 @end example
2712
2713 @item
2714 Keep only the first second:
2715 @example
2716 avconv -i INPUT -vf trim=duration=1
2717 @end example
2718
2719 @end itemize
2720 @section unsharp
2721
2722 Sharpen or blur the input video.
2723
2724 It accepts the following parameters:
2725
2726 @table @option
2727
2728 @item luma_msize_x
2729 Set the luma matrix horizontal size. It must be an integer between 3
2730 and 13. The default value is 5.
2731
2732 @item luma_msize_y
2733 Set the luma matrix vertical size. It must be an integer between 3
2734 and 13. The default value is 5.
2735
2736 @item luma_amount
2737 Set the luma effect strength. It must be a floating point number between -2.0
2738 and 5.0. The default value is 1.0.
2739
2740 @item chroma_msize_x
2741 Set the chroma matrix horizontal size. It must be an integer between 3
2742 and 13. The default value is 5.
2743
2744 @item chroma_msize_y
2745 Set the chroma matrix vertical size. It must be an integer between 3
2746 and 13. The default value is 5.
2747
2748 @item chroma_amount
2749 Set the chroma effect strength. It must be a floating point number between -2.0
2750 and 5.0. The default value is 0.0.
2751
2752 @end table
2753
2754 Negative values for the amount will blur the input video, while positive
2755 values will sharpen. All parameters are optional and default to the
2756 equivalent of the string '5:5:1.0:5:5:0.0'.
2757
2758 @example
2759 # Strong luma sharpen effect parameters
2760 unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
2761
2762 # A strong blur of both luma and chroma parameters
2763 unsharp=7:7:-2:7:7:-2
2764
2765 # Use the default values with @command{avconv}
2766 ./avconv -i in.avi -vf "unsharp" out.mp4
2767 @end example
2768
2769 @section vflip
2770
2771 Flip the input video vertically.
2772
2773 @example
2774 ./avconv -i in.avi -vf "vflip" out.avi
2775 @end example
2776
2777 @section yadif
2778
2779 Deinterlace the input video ("yadif" means "yet another deinterlacing
2780 filter").
2781
2782 It accepts the following parameters:
2783
2784 @table @option
2785
2786 @item mode
2787 The interlacing mode to adopt. It accepts one of the following values:
2788
2789 @table @option
2790 @item 0
2791 Output one frame for each frame.
2792 @item 1
2793 Output one frame for each field.
2794 @item 2
2795 Like 0, but it skips the spatial interlacing check.
2796 @item 3
2797 Like 1, but it skips the spatial interlacing check.
2798 @end table
2799
2800 The default value is 0.
2801
2802 @item parity
2803 The picture field parity assumed for the input interlaced video. It accepts one
2804 of the following values:
2805
2806 @table @option
2807 @item 0
2808 Assume the top field is first.
2809 @item 1
2810 Assume the bottom field is first.
2811 @item -1
2812 Enable automatic detection of field parity.
2813 @end table
2814
2815 The default value is -1.
2816 If the interlacing is unknown or the decoder does not export this information,
2817 top field first will be assumed.
2818
2819 @item auto
2820 Whether the deinterlacer should trust the interlaced flag and only deinterlace
2821 frames marked as interlaced.
2822
2823 @table @option
2824 @item 0
2825 Deinterlace all frames.
2826 @item 1
2827 Only deinterlace frames marked as interlaced.
2828 @end table
2829
2830 The default value is 0.
2831
2832 @end table
2833
2834 @c man end VIDEO FILTERS
2835
2836 @chapter Video Sources
2837 @c man begin VIDEO SOURCES
2838
2839 Below is a description of the currently available video sources.
2840
2841 @section buffer
2842
2843 Buffer video frames, and make them available to the filter chain.
2844
2845 This source is mainly intended for a programmatic use, in particular
2846 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2847
2848 It accepts the following parameters:
2849
2850 @table @option
2851
2852 @item width
2853 The input video width.
2854
2855 @item height
2856 The input video height.
2857
2858 @item pix_fmt
2859 The name of the input video pixel format.
2860
2861 @item time_base
2862 The time base used for input timestamps.
2863
2864 @item sar
2865 The sample (pixel) aspect ratio of the input video.
2866
2867 @end table
2868
2869 For example:
2870 @example
2871 buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
2872 @end example
2873
2874 will instruct the source to accept video frames with size 320x240 and
2875 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2876 square pixels (1:1 sample aspect ratio).
2877
2878 @section color
2879
2880 Provide an uniformly colored input.
2881
2882 It accepts the following parameters:
2883
2884 @table @option
2885
2886 @item color
2887 Specify the color of the source. It can be the name of a color (case
2888 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2889 alpha specifier. The default value is "black".
2890
2891 @item size
2892 Specify the size of the sourced video, it may be a string of the form
2893 @var{width}x@var{height}, or the name of a size abbreviation. The
2894 default value is "320x240".
2895
2896 @item framerate
2897 Specify the frame rate of the sourced video, as the number of frames
2898 generated per second. It has to be a string in the format
2899 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a floating point
2900 number or a valid video frame rate abbreviation. The default value is
2901 "25".
2902
2903 @end table
2904
2905 The following graph description will generate a red source
2906 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2907 frames per second, which will be overlayed over the source connected
2908 to the pad with identifier "in":
2909
2910 @example
2911 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2912 @end example
2913
2914 @section movie
2915
2916 Read a video stream from a movie container.
2917
2918 Note that this source is a hack that bypasses the standard input path. It can be
2919 useful in applications that do not support arbitrary filter graphs, but its use
2920 is discouraged in those that do. It should never be used with
2921 @command{avconv}; the @option{-filter_complex} option fully replaces it.
2922
2923 It accepts the following parameters:
2924
2925 @table @option
2926
2927 @item filename
2928 The name of the resource to read (not necessarily a file; it can also be a
2929 device or a stream accessed through some protocol).
2930
2931 @item format_name, f
2932 Specifies the format assumed for the movie to read, and can be either
2933 the name of a container or an input device. If not specified, the
2934 format is guessed from @var{movie_name} or by probing.
2935
2936 @item seek_point, sp
2937 Specifies the seek point in seconds. The frames will be output
2938 starting from this seek point. The parameter is evaluated with
2939 @code{av_strtod}, so the numerical value may be suffixed by an IS
2940 postfix. The default value is "0".
2941
2942 @item stream_index, si
2943 Specifies the index of the video stream to read. If the value is -1,
2944 the most suitable video stream will be automatically selected. The default
2945 value is "-1".
2946
2947 @end table
2948
2949 It allows overlaying a second video on top of the main input of
2950 a filtergraph, as shown in this graph:
2951 @example
2952 input -----------> deltapts0 --> overlay --> output
2953                                     ^
2954                                     |
2955 movie --> scale--> deltapts1 -------+
2956 @end example
2957
2958 Some examples:
2959 @example
2960 # Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it
2961 # on top of the input labelled "in"
2962 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2963 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2964
2965 # Read from a video4linux2 device, and overlay it on top of the input
2966 # labelled "in"
2967 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2968 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2969
2970 @end example
2971
2972 @section nullsrc
2973
2974 Null video source: never return images. It is mainly useful as a
2975 template and to be employed in analysis / debugging tools.
2976
2977 It accepts a string of the form
2978 @var{width}:@var{height}:@var{timebase} as an optional parameter.
2979
2980 @var{width} and @var{height} specify the size of the configured
2981 source. The default values of @var{width} and @var{height} are
2982 respectively 352 and 288 (corresponding to the CIF size format).
2983
2984 @var{timebase} specifies an arithmetic expression representing a
2985 timebase. The expression can contain the constants "PI", "E", "PHI", and
2986 "AVTB" (the default timebase), and defaults to the value "AVTB".
2987
2988 @section frei0r_src
2989
2990 Provide a frei0r source.
2991
2992 To enable compilation of this filter you need to install the frei0r
2993 header and configure Libav with --enable-frei0r.
2994
2995 This source accepts the following parameters:
2996
2997 @table @option
2998
2999 @item size
3000 The size of the video to generate. It may be a string of the form
3001 @var{width}x@var{height} or a frame size abbreviation.
3002
3003 @item framerate
3004 The framerate of the generated video. It may be a string of the form
3005 @var{num}/@var{den} or a frame rate abbreviation.
3006
3007 @item filter_name
3008 The name to the frei0r source to load. For more information regarding frei0r and
3009 how to set the parameters, read the @ref{frei0r} section in the video filters
3010 documentation.
3011
3012 @item filter_params
3013 A '|'-separated list of parameters to pass to the frei0r source.
3014
3015 @end table
3016
3017 An example:
3018 @example
3019 # Generate a frei0r partik0l source with size 200x200 and framerate 10
3020 # which is overlayed on the overlay filter main input
3021 frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
3022 @end example
3023
3024 @section rgbtestsrc, testsrc
3025
3026 The @code{rgbtestsrc} source generates an RGB test pattern useful for
3027 detecting RGB vs BGR issues. You should see a red, green and blue
3028 stripe from top to bottom.
3029
3030 The @code{testsrc} source generates a test video pattern, showing a
3031 color pattern, a scrolling gradient and a timestamp. This is mainly
3032 intended for testing purposes.
3033
3034 The sources accept the following parameters:
3035
3036 @table @option
3037
3038 @item size, s
3039 Specify the size of the sourced video, it may be a string of the form
3040 @var{width}x@var{height}, or the name of a size abbreviation. The
3041 default value is "320x240".
3042
3043 @item rate, r
3044 Specify the frame rate of the sourced video, as the number of frames
3045 generated per second. It has to be a string in the format
3046 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a floating point
3047 number or a valid video frame rate abbreviation. The default value is
3048 "25".
3049
3050 @item sar
3051 Set the sample aspect ratio of the sourced video.
3052
3053 @item duration
3054 Set the video duration of the sourced video. The accepted syntax is:
3055 @example
3056 [-]HH[:MM[:SS[.m...]]]
3057 [-]S+[.m...]
3058 @end example
3059 Also see the the @code{av_parse_time()} function.
3060
3061 If not specified, or the expressed duration is negative, the video is
3062 supposed to be generated forever.
3063 @end table
3064
3065 For example the following:
3066 @example
3067 testsrc=duration=5.3:size=qcif:rate=10
3068 @end example
3069
3070 will generate a video with a duration of 5.3 seconds, with size
3071 176x144 and a framerate of 10 frames per second.
3072
3073 @c man end VIDEO SOURCES
3074
3075 @chapter Video Sinks
3076 @c man begin VIDEO SINKS
3077
3078 Below is a description of the currently available video sinks.
3079
3080 @section buffersink
3081
3082 Buffer video frames, and make them available to the end of the filter
3083 graph.
3084
3085 This sink is intended for programmatic use through the interface defined in
3086 @file{libavfilter/buffersink.h}.
3087
3088 @section nullsink
3089
3090 Null video sink: do absolutely nothing with the input video. It is
3091 mainly useful as a template and for use in analysis / debugging
3092 tools.
3093
3094 @c man end VIDEO SINKS