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