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