asvenc: use the AVFrame API properly.
[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 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 @section fps
1234
1235 Convert the video to specified constant framerate by duplicating or dropping
1236 frames as necessary.
1237
1238 This filter accepts the following named parameters:
1239 @table @option
1240
1241 @item fps
1242 Desired output framerate.
1243
1244 @item start_time
1245 Assume the first PTS should be the given value, in seconds. This allows for
1246 padding/trimming at the start of stream. By default, no assumption is made
1247 about the first frame's expected PTS, so no padding or trimming is done.
1248 For example, this could be set to 0 to pad the beginning with duplicates of
1249 the first frame if a video stream starts after the audio stream or to trim any
1250 frames with a negative PTS.
1251
1252 @end table
1253
1254 @anchor{frei0r}
1255 @section frei0r
1256
1257 Apply a frei0r effect to the input video.
1258
1259 To enable compilation of this filter you need to install the frei0r
1260 header and configure Libav with --enable-frei0r.
1261
1262 This filter accepts the following options:
1263
1264 @table @option
1265
1266 @item filter_name
1267 The name to the frei0r effect to load. If the environment variable
1268 @env{FREI0R_PATH} is defined, the frei0r effect is searched in each one of the
1269 directories specified by the colon separated list in @env{FREIOR_PATH},
1270 otherwise in the standard frei0r paths, which are in this order:
1271 @file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
1272 @file{/usr/lib/frei0r-1/}.
1273
1274 @item filter_params
1275 A '|'-separated list of parameters to pass to the frei0r effect.
1276
1277 @end table
1278
1279 A frei0r effect parameter can be a boolean (whose values are specified
1280 with "y" and "n"), a double, a color (specified by the syntax
1281 @var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
1282 numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
1283 description), a position (specified by the syntax @var{X}/@var{Y},
1284 @var{X} and @var{Y} being float numbers) and a string.
1285
1286 The number and kind of parameters depend on the loaded effect. If an
1287 effect parameter is not specified the default value is set.
1288
1289 Some examples follow:
1290 @example
1291 # apply the distort0r effect, set the first two double parameters
1292 frei0r=filter_name=distort0r:filter_params=0.5|0.01
1293
1294 # apply the colordistance effect, takes a color as first parameter
1295 frei0r=colordistance:0.2/0.3/0.4
1296 frei0r=colordistance:violet
1297 frei0r=colordistance:0x112233
1298
1299 # apply the perspective effect, specify the top left and top right
1300 # image positions
1301 frei0r=perspective:0.2/0.2|0.8/0.2
1302 @end example
1303
1304 For more information see:
1305 @url{http://piksel.org/frei0r}
1306
1307 @section gradfun
1308
1309 Fix the banding artifacts that are sometimes introduced into nearly flat
1310 regions by truncation to 8bit colordepth.
1311 Interpolate the gradients that should go where the bands are, and
1312 dither them.
1313
1314 This filter is designed for playback only.  Do not use it prior to
1315 lossy compression, because compression tends to lose the dither and
1316 bring back the bands.
1317
1318 This filter accepts the following options:
1319
1320 @table @option
1321
1322 @item strength
1323 The maximum amount by which the filter will change any one pixel. Also the
1324 threshold for detecting nearly flat regions. Acceptable values range from .51 to
1325 64, default value is 1.2, out-of-range values will be clipped to the valid
1326 range.
1327
1328 @item radius
1329 The neighborhood to fit the gradient to. A larger radius makes for smoother
1330 gradients, but also prevents the filter from modifying the pixels near detailed
1331 regions. Acceptable values are 8-32, default value is 16, out-of-range values
1332 will be clipped to the valid range.
1333
1334 @end table
1335
1336 @example
1337 # default parameters
1338 gradfun=strength=1.2:radius=16
1339
1340 # omitting radius
1341 gradfun=1.2
1342 @end example
1343
1344 @section hflip
1345
1346 Flip the input video horizontally.
1347
1348 For example to horizontally flip the input video with @command{avconv}:
1349 @example
1350 avconv -i in.avi -vf "hflip" out.avi
1351 @end example
1352
1353 @section hqdn3d
1354
1355 High precision/quality 3d denoise filter. This filter aims to reduce
1356 image noise producing smooth images and making still images really
1357 still. It should enhance compressibility.
1358
1359 It accepts the following optional parameters:
1360
1361 @table @option
1362 @item luma_spatial
1363 a non-negative float number which specifies spatial luma strength,
1364 defaults to 4.0
1365
1366 @item chroma_spatial
1367 a non-negative float number which specifies spatial chroma strength,
1368 defaults to 3.0*@var{luma_spatial}/4.0
1369
1370 @item luma_tmp
1371 a float number which specifies luma temporal strength, defaults to
1372 6.0*@var{luma_spatial}/4.0
1373
1374 @item chroma_tmp
1375 a float number which specifies chroma temporal strength, defaults to
1376 @var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
1377 @end table
1378
1379 @section interlace
1380
1381 Simple interlacing filter from progressive contents. This interleaves upper (or
1382 lower) lines from odd frames with lower (or upper) lines from even frames,
1383 halving the frame rate and preserving image height.
1384
1385 @example
1386    Original        Original             New Frame
1387    Frame 'j'      Frame 'j+1'             (tff)
1388   ==========      ===========       ==================
1389     Line 0  -------------------->    Frame 'j' Line 0
1390     Line 1          Line 1  ---->   Frame 'j+1' Line 1
1391     Line 2 --------------------->    Frame 'j' Line 2
1392     Line 3          Line 3  ---->   Frame 'j+1' Line 3
1393      ...             ...                   ...
1394 New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
1395 @end example
1396
1397 It accepts the following optional parameters:
1398
1399 @table @option
1400 @item scan
1401 determines whether the interlaced frame is taken from the even (tff - default)
1402 or odd (bff) lines of the progressive frame.
1403
1404 @item lowpass
1405 Enable (default) or disable the vertical lowpass filter to avoid twitter
1406 interlacing and reduce moire patterns.
1407 @end table
1408
1409 @section lut, lutrgb, lutyuv
1410
1411 Compute a look-up table for binding each pixel component input value
1412 to an output value, and apply it to input video.
1413
1414 @var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
1415 to an RGB input video.
1416
1417 These filters accept the following options:
1418 @table @option
1419 @item @var{c0} (first  pixel component)
1420 @item @var{c1} (second pixel component)
1421 @item @var{c2} (third  pixel component)
1422 @item @var{c3} (fourth pixel component, corresponds to the alpha component)
1423
1424 @item @var{r} (red component)
1425 @item @var{g} (green component)
1426 @item @var{b} (blue component)
1427 @item @var{a} (alpha component)
1428
1429 @item @var{y} (Y/luminance component)
1430 @item @var{u} (U/Cb component)
1431 @item @var{v} (V/Cr component)
1432 @end table
1433
1434 Each of them specifies the expression to use for computing the lookup table for
1435 the corresponding pixel component values.
1436
1437 The exact component associated to each of the @var{c*} options depends on the
1438 format in input.
1439
1440 The @var{lut} filter requires either YUV or RGB pixel formats in input,
1441 @var{lutrgb} requires RGB pixel formats in input, and @var{lutyuv} requires YUV.
1442
1443 The expressions can contain the following constants and functions:
1444
1445 @table @option
1446 @item E, PI, PHI
1447 the corresponding mathematical approximated values for e
1448 (euler number), pi (greek PI), PHI (golden ratio)
1449
1450 @item w, h
1451 the input width and height
1452
1453 @item val
1454 input value for the pixel component
1455
1456 @item clipval
1457 the input value clipped in the @var{minval}-@var{maxval} range
1458
1459 @item maxval
1460 maximum value for the pixel component
1461
1462 @item minval
1463 minimum value for the pixel component
1464
1465 @item negval
1466 the negated value for the pixel component value clipped in the
1467 @var{minval}-@var{maxval} range , it corresponds to the expression
1468 "maxval-clipval+minval"
1469
1470 @item clip(val)
1471 the computed value in @var{val} clipped in the
1472 @var{minval}-@var{maxval} range
1473
1474 @item gammaval(gamma)
1475 the computed gamma correction value of the pixel component value
1476 clipped in the @var{minval}-@var{maxval} range, corresponds to the
1477 expression
1478 "pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"
1479
1480 @end table
1481
1482 All expressions default to "val".
1483
1484 Some examples follow:
1485 @example
1486 # negate input video
1487 lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
1488 lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
1489
1490 # the above is the same as
1491 lutrgb="r=negval:g=negval:b=negval"
1492 lutyuv="y=negval:u=negval:v=negval"
1493
1494 # negate luminance
1495 lutyuv=negval
1496
1497 # remove chroma components, turns the video into a graytone image
1498 lutyuv="u=128:v=128"
1499
1500 # apply a luma burning effect
1501 lutyuv="y=2*val"
1502
1503 # remove green and blue components
1504 lutrgb="g=0:b=0"
1505
1506 # set a constant alpha channel value on input
1507 format=rgba,lutrgb=a="maxval-minval/2"
1508
1509 # correct luminance gamma by a 0.5 factor
1510 lutyuv=y=gammaval(0.5)
1511 @end example
1512
1513 @section negate
1514
1515 Negate input video.
1516
1517 This filter accepts an integer in input, if non-zero it negates the
1518 alpha component (if available). The default value in input is 0.
1519
1520 @section noformat
1521
1522 Force libavfilter not to use any of the specified pixel formats for the
1523 input to the next filter.
1524
1525 This filter accepts the following parameters:
1526 @table @option
1527
1528 @item pix_fmts
1529 A '|'-separated list of pixel format names, for example
1530 "pix_fmts=yuv420p|monow|rgb24".
1531
1532 @end table
1533
1534 Some examples follow:
1535 @example
1536 # force libavfilter to use a format different from "yuv420p" for the
1537 # input to the vflip filter
1538 noformat=pix_fmts=yuv420p,vflip
1539
1540 # convert the input video to any of the formats not contained in the list
1541 noformat=yuv420p|yuv444p|yuv410p
1542 @end example
1543
1544 @section null
1545
1546 Pass the video source unchanged to the output.
1547
1548 @section ocv
1549
1550 Apply video transform using libopencv.
1551
1552 To enable this filter install libopencv library and headers and
1553 configure Libav with --enable-libopencv.
1554
1555 This filter accepts the following parameters:
1556
1557 @table @option
1558
1559 @item filter_name
1560 The name of the libopencv filter to apply.
1561
1562 @item filter_params
1563 The parameters to pass to the libopencv filter. If not specified the default
1564 values are assumed.
1565
1566 @end table
1567
1568 Refer to the official libopencv documentation for more precise
1569 information:
1570 @url{http://opencv.willowgarage.com/documentation/c/image_filtering.html}
1571
1572 Follows the list of supported libopencv filters.
1573
1574 @anchor{dilate}
1575 @subsection dilate
1576
1577 Dilate an image by using a specific structuring element.
1578 This filter corresponds to the libopencv function @code{cvDilate}.
1579
1580 It accepts the parameters: @var{struct_el}|@var{nb_iterations}.
1581
1582 @var{struct_el} represents a structuring element, and has the syntax:
1583 @var{cols}x@var{rows}+@var{anchor_x}x@var{anchor_y}/@var{shape}
1584
1585 @var{cols} and @var{rows} represent the number of columns and rows of
1586 the structuring element, @var{anchor_x} and @var{anchor_y} the anchor
1587 point, and @var{shape} the shape for the structuring element, and
1588 can be one of the values "rect", "cross", "ellipse", "custom".
1589
1590 If the value for @var{shape} is "custom", it must be followed by a
1591 string of the form "=@var{filename}". The file with name
1592 @var{filename} is assumed to represent a binary image, with each
1593 printable character corresponding to a bright pixel. When a custom
1594 @var{shape} is used, @var{cols} and @var{rows} are ignored, the number
1595 or columns and rows of the read file are assumed instead.
1596
1597 The default value for @var{struct_el} is "3x3+0x0/rect".
1598
1599 @var{nb_iterations} specifies the number of times the transform is
1600 applied to the image, and defaults to 1.
1601
1602 Follow some example:
1603 @example
1604 # use the default values
1605 ocv=dilate
1606
1607 # dilate using a structuring element with a 5x5 cross, iterate two times
1608 ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
1609
1610 # read the shape from the file diamond.shape, iterate two times
1611 # the file diamond.shape may contain a pattern of characters like this:
1612 #   *
1613 #  ***
1614 # *****
1615 #  ***
1616 #   *
1617 # the specified cols and rows are ignored (but not the anchor point coordinates)
1618 ocv=dilate:0x0+2x2/custom=diamond.shape|2
1619 @end example
1620
1621 @subsection erode
1622
1623 Erode an image by using a specific structuring element.
1624 This filter corresponds to the libopencv function @code{cvErode}.
1625
1626 The filter accepts the parameters: @var{struct_el}:@var{nb_iterations},
1627 with the same syntax and semantics as the @ref{dilate} filter.
1628
1629 @subsection smooth
1630
1631 Smooth the input video.
1632
1633 The filter takes the following parameters:
1634 @var{type}|@var{param1}|@var{param2}|@var{param3}|@var{param4}.
1635
1636 @var{type} is the type of smooth filter to apply, and can be one of
1637 the following values: "blur", "blur_no_scale", "median", "gaussian",
1638 "bilateral". The default value is "gaussian".
1639
1640 @var{param1}, @var{param2}, @var{param3}, and @var{param4} are
1641 parameters whose meanings depend on smooth type. @var{param1} and
1642 @var{param2} accept integer positive values or 0, @var{param3} and
1643 @var{param4} accept float values.
1644
1645 The default value for @var{param1} is 3, the default value for the
1646 other parameters is 0.
1647
1648 These parameters correspond to the parameters assigned to the
1649 libopencv function @code{cvSmooth}.
1650
1651 @anchor{overlay}
1652 @section overlay
1653
1654 Overlay one video on top of another.
1655
1656 It takes two inputs and one output, the first input is the "main"
1657 video on which the second input is overlayed.
1658
1659 This filter accepts the following parameters:
1660
1661 @table @option
1662
1663 @item x
1664 The horizontal position of the left edge of the overlaid video on the main video.
1665
1666 @item y
1667 The vertical position of the top edge of the overlaid video on the main video.
1668
1669 @end table
1670
1671 The parameters are expressions containing the following parameters:
1672
1673 @table @option
1674 @item main_w, main_h
1675 main input width and height
1676
1677 @item W, H
1678 same as @var{main_w} and @var{main_h}
1679
1680 @item overlay_w, overlay_h
1681 overlay input width and height
1682
1683 @item w, h
1684 same as @var{overlay_w} and @var{overlay_h}
1685 @end table
1686
1687 Be aware that frames are taken from each input video in timestamp
1688 order, hence, if their initial timestamps differ, it is a a good idea
1689 to pass the two inputs through a @var{setpts=PTS-STARTPTS} filter to
1690 have them begin in the same zero timestamp, as it does the example for
1691 the @var{movie} filter.
1692
1693 Follow some examples:
1694 @example
1695 # draw the overlay at 10 pixels from the bottom right
1696 # corner of the main video.
1697 overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
1698
1699 # insert a transparent PNG logo in the bottom left corner of the input
1700 avconv -i input -i logo -filter_complex 'overlay=x=10:y=main_h-overlay_h-10' output
1701
1702 # insert 2 different transparent PNG logos (second logo on bottom
1703 # right corner):
1704 avconv -i input -i logo1 -i logo2 -filter_complex
1705 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
1706
1707 # add a transparent color layer on top of the main video,
1708 # WxH specifies the size of the main input to the overlay filter
1709 color=red@.3:WxH [over]; [in][over] overlay [out]
1710 @end example
1711
1712 You can chain together more overlays but the efficiency of such
1713 approach is yet to be tested.
1714
1715 @section pad
1716
1717 Add paddings to the input image, and places the original input at the
1718 given coordinates @var{x}, @var{y}.
1719
1720 This filter accepts the following parameters:
1721
1722 @table @option
1723 @item width, height
1724
1725 Specify the size of the output image with the paddings added. If the
1726 value for @var{width} or @var{height} is 0, the corresponding input size
1727 is used for the output.
1728
1729 The @var{width} expression can reference the value set by the
1730 @var{height} expression, and vice versa.
1731
1732 The default value of @var{width} and @var{height} is 0.
1733
1734 @item x, y
1735
1736 Specify the offsets where to place the input image in the padded area
1737 with respect to the top/left border of the output image.
1738
1739 The @var{x} expression can reference the value set by the @var{y}
1740 expression, and vice versa.
1741
1742 The default value of @var{x} and @var{y} is 0.
1743
1744 @item color
1745
1746 Specify the color of the padded area, it can be the name of a color
1747 (case insensitive match) or a 0xRRGGBB[AA] sequence.
1748
1749 The default value of @var{color} is "black".
1750
1751 @end table
1752
1753 The parameters @var{width}, @var{height}, @var{x}, and @var{y} are
1754 expressions containing the following constants:
1755
1756 @table @option
1757 @item E, PI, PHI
1758 the corresponding mathematical approximated values for e
1759 (euler number), pi (greek PI), phi (golden ratio)
1760
1761 @item in_w, in_h
1762 the input video width and height
1763
1764 @item iw, ih
1765 same as @var{in_w} and @var{in_h}
1766
1767 @item out_w, out_h
1768 the output width and height, that is the size of the padded area as
1769 specified by the @var{width} and @var{height} expressions
1770
1771 @item ow, oh
1772 same as @var{out_w} and @var{out_h}
1773
1774 @item x, y
1775 x and y offsets as specified by the @var{x} and @var{y}
1776 expressions, or NAN if not yet specified
1777
1778 @item a
1779 input display aspect ratio, same as @var{iw} / @var{ih}
1780
1781 @item hsub, vsub
1782 horizontal and vertical chroma subsample values. For example for the
1783 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1784 @end table
1785
1786 Some examples follow:
1787
1788 @example
1789 # Add paddings with color "violet" to the input video. Output video
1790 # size is 640x480, the top-left corner of the input video is placed at
1791 # column 0, row 40.
1792 pad=width=640:height=480:x=0:y=40:color=violet
1793
1794 # pad the input to get an output with dimensions increased bt 3/2,
1795 # and put the input video at the center of the padded area
1796 pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
1797
1798 # pad the input to get a squared output with size equal to the maximum
1799 # value between the input width and height, and put the input video at
1800 # the center of the padded area
1801 pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
1802
1803 # pad the input to get a final w/h ratio of 16:9
1804 pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
1805
1806 # double output size and put the input video in the bottom-right
1807 # corner of the output padded area
1808 pad="2*iw:2*ih:ow-iw:oh-ih"
1809 @end example
1810
1811 @section pixdesctest
1812
1813 Pixel format descriptor test filter, mainly useful for internal
1814 testing. The output video should be equal to the input video.
1815
1816 For example:
1817 @example
1818 format=monow, pixdesctest
1819 @end example
1820
1821 can be used to test the monowhite pixel format descriptor definition.
1822
1823 @section scale
1824
1825 Scale the input video and/or convert the image format.
1826
1827 This filter accepts the following options:
1828
1829 @table @option
1830
1831 @item w
1832 Output video width.
1833
1834 @item h
1835 Output video height.
1836
1837 @end table
1838
1839 The parameters @var{w} and @var{h} are expressions containing
1840 the following constants:
1841
1842 @table @option
1843 @item E, PI, PHI
1844 the corresponding mathematical approximated values for e
1845 (euler number), pi (greek PI), phi (golden ratio)
1846
1847 @item in_w, in_h
1848 the input width and height
1849
1850 @item iw, ih
1851 same as @var{in_w} and @var{in_h}
1852
1853 @item out_w, out_h
1854 the output (cropped) width and height
1855
1856 @item ow, oh
1857 same as @var{out_w} and @var{out_h}
1858
1859 @item a
1860 same as @var{iw} / @var{ih}
1861
1862 @item sar
1863 input sample aspect ratio
1864
1865 @item dar
1866 input display aspect ratio, it is the same as (@var{iw} / @var{ih}) * @var{sar}
1867
1868 @item hsub, vsub
1869 horizontal and vertical chroma subsample values. For example for the
1870 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
1871 @end table
1872
1873 If the input image format is different from the format requested by
1874 the next filter, the scale filter will convert the input to the
1875 requested format.
1876
1877 If the value for @var{w} or @var{h} is 0, the respective input
1878 size is used for the output.
1879
1880 If the value for @var{w} or @var{h} is -1, the scale filter will use, for the
1881 respective output size, a value that maintains the aspect ratio of the input
1882 image.
1883
1884 The default value of @var{w} and @var{h} is 0.
1885
1886 Some examples follow:
1887 @example
1888 # scale the input video to a size of 200x100.
1889 scale=w=200:h=100
1890
1891 # scale the input to 2x
1892 scale=w=2*iw:h=2*ih
1893 # the above is the same as
1894 scale=2*in_w:2*in_h
1895
1896 # scale the input to half size
1897 scale=w=iw/2:h=ih/2
1898
1899 # increase the width, and set the height to the same size
1900 scale=3/2*iw:ow
1901
1902 # seek for Greek harmony
1903 scale=iw:1/PHI*iw
1904 scale=ih*PHI:ih
1905
1906 # increase the height, and set the width to 3/2 of the height
1907 scale=w=3/2*oh:h=3/5*ih
1908
1909 # increase the size, but make the size a multiple of the chroma
1910 scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
1911
1912 # increase the width to a maximum of 500 pixels, keep the same input aspect ratio
1913 scale=w='min(500\, iw*3/2):h=-1'
1914 @end example
1915
1916 @section select
1917 Select frames to pass in output.
1918
1919 This filter accepts the following options:
1920
1921 @table @option
1922
1923 @item expr
1924 An expression, which is evaluated for each input frame. If the expression is
1925 evaluated to a non-zero value, the frame is selected and passed to the output,
1926 otherwise it is discarded.
1927
1928 @end table
1929
1930 The expression can contain the following constants:
1931
1932 @table @option
1933 @item PI
1934 Greek PI
1935
1936 @item PHI
1937 golden ratio
1938
1939 @item E
1940 Euler number
1941
1942 @item n
1943 the sequential number of the filtered frame, starting from 0
1944
1945 @item selected_n
1946 the sequential number of the selected frame, starting from 0
1947
1948 @item prev_selected_n
1949 the sequential number of the last selected frame, NAN if undefined
1950
1951 @item TB
1952 timebase of the input timestamps
1953
1954 @item pts
1955 the PTS (Presentation TimeStamp) of the filtered video frame,
1956 expressed in @var{TB} units, NAN if undefined
1957
1958 @item t
1959 the PTS (Presentation TimeStamp) of the filtered video frame,
1960 expressed in seconds, NAN if undefined
1961
1962 @item prev_pts
1963 the PTS of the previously filtered video frame, NAN if undefined
1964
1965 @item prev_selected_pts
1966 the PTS of the last previously filtered video frame, NAN if undefined
1967
1968 @item prev_selected_t
1969 the PTS of the last previously selected video frame, NAN if undefined
1970
1971 @item start_pts
1972 the PTS of the first video frame in the video, NAN if undefined
1973
1974 @item start_t
1975 the time of the first video frame in the video, NAN if undefined
1976
1977 @item pict_type
1978 the type of the filtered frame, can assume one of the following
1979 values:
1980 @table @option
1981 @item I
1982 @item P
1983 @item B
1984 @item S
1985 @item SI
1986 @item SP
1987 @item BI
1988 @end table
1989
1990 @item interlace_type
1991 the frame interlace type, can assume one of the following values:
1992 @table @option
1993 @item PROGRESSIVE
1994 the frame is progressive (not interlaced)
1995 @item TOPFIRST
1996 the frame is top-field-first
1997 @item BOTTOMFIRST
1998 the frame is bottom-field-first
1999 @end table
2000
2001 @item key
2002 1 if the filtered frame is a key-frame, 0 otherwise
2003
2004 @end table
2005
2006 The default value of the select expression is "1".
2007
2008 Some examples follow:
2009
2010 @example
2011 # select all frames in input
2012 select
2013
2014 # the above is the same as:
2015 select=expr=1
2016
2017 # skip all frames:
2018 select=expr=0
2019
2020 # select only I-frames
2021 select='expr=eq(pict_type\,I)'
2022
2023 # select one frame every 100
2024 select='not(mod(n\,100))'
2025
2026 # select only frames contained in the 10-20 time interval
2027 select='gte(t\,10)*lte(t\,20)'
2028
2029 # select only I frames contained in the 10-20 time interval
2030 select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
2031
2032 # select frames with a minimum distance of 10 seconds
2033 select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
2034 @end example
2035
2036 @anchor{setdar}
2037 @section setdar
2038
2039 Set the Display Aspect Ratio for the filter output video.
2040
2041 This is done by changing the specified Sample (aka Pixel) Aspect
2042 Ratio, according to the following equation:
2043 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2044
2045 Keep in mind that this filter does not modify the pixel dimensions of
2046 the video frame. Also the display aspect ratio set by this filter may
2047 be changed by later filters in the filterchain, e.g. in case of
2048 scaling or if another "setdar" or a "setsar" filter is applied.
2049
2050 This filter accepts the following options:
2051
2052 @table @option
2053
2054 @item dar
2055 Output display aspect ratio.
2056
2057 @end table
2058
2059 The parameter @var{dar} is an expression containing
2060 the following constants:
2061
2062 @table @option
2063 @item E, PI, PHI
2064 the corresponding mathematical approximated values for e
2065 (euler number), pi (greek PI), phi (golden ratio)
2066
2067 @item w, h
2068 the input width and height
2069
2070 @item a
2071 same as @var{w} / @var{h}
2072
2073 @item sar
2074 input sample aspect ratio
2075
2076 @item dar
2077 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
2078
2079 @item hsub, vsub
2080 horizontal and vertical chroma subsample values. For example for the
2081 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2082 @end table
2083
2084 For example to change the display aspect ratio to 16:9, specify:
2085 @example
2086 setdar=dar=16/9
2087 # the above is equivalent to
2088 setdar=dar=1.77777
2089 @end example
2090
2091 See also the @ref{setsar} filter documentation.
2092
2093 @section setpts
2094
2095 Change the PTS (presentation timestamp) of the input video frames.
2096
2097 This filter accepts the following options:
2098
2099 @table @option
2100
2101 @item expr
2102 The expression which is evaluated for each frame to construct its timestamp.
2103
2104 @end table
2105
2106 The expression is evaluated through the eval API and can contain the following
2107 constants:
2108
2109 @table @option
2110 @item PTS
2111 the presentation timestamp in input
2112
2113 @item PI
2114 Greek PI
2115
2116 @item PHI
2117 golden ratio
2118
2119 @item E
2120 Euler number
2121
2122 @item N
2123 the count of the input frame, starting from 0.
2124
2125 @item STARTPTS
2126 the PTS of the first video frame
2127
2128 @item INTERLACED
2129 tell if the current frame is interlaced
2130
2131 @item PREV_INPTS
2132 previous input PTS
2133
2134 @item PREV_OUTPTS
2135 previous output PTS
2136
2137 @item RTCTIME
2138 wallclock (RTC) time in microseconds
2139
2140 @item RTCSTART
2141 wallclock (RTC) time at the start of the movie in microseconds
2142
2143 @item TB
2144 timebase of the input timestamps
2145
2146 @end table
2147
2148 Some examples follow:
2149
2150 @example
2151 # start counting PTS from zero
2152 setpts=expr=PTS-STARTPTS
2153
2154 # fast motion
2155 setpts=expr=0.5*PTS
2156
2157 # slow motion
2158 setpts=2.0*PTS
2159
2160 # fixed rate 25 fps
2161 setpts=N/(25*TB)
2162
2163 # fixed rate 25 fps with some jitter
2164 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
2165
2166 # generate timestamps from a "live source" and rebase onto the current timebase
2167 setpts='(RTCTIME - RTCSTART) / (TB * 1000000)"
2168 @end example
2169
2170 @anchor{setsar}
2171 @section setsar
2172
2173 Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
2174
2175 Note that as a consequence of the application of this filter, the
2176 output display aspect ratio will change according to the following
2177 equation:
2178 @math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
2179
2180 Keep in mind that the sample aspect ratio set by this filter may be
2181 changed by later filters in the filterchain, e.g. if another "setsar"
2182 or a "setdar" filter is applied.
2183
2184 This filter accepts the following options:
2185
2186 @table @option
2187
2188 @item sar
2189 Output sample aspect ratio.
2190
2191 @end table
2192
2193 The parameter @var{sar} is an expression containing
2194 the following constants:
2195
2196 @table @option
2197 @item E, PI, PHI
2198 the corresponding mathematical approximated values for e
2199 (euler number), pi (greek PI), phi (golden ratio)
2200
2201 @item w, h
2202 the input width and height
2203
2204 @item a
2205 same as @var{w} / @var{h}
2206
2207 @item sar
2208 input sample aspect ratio
2209
2210 @item dar
2211 input display aspect ratio, it is the same as (@var{w} / @var{h}) * @var{sar}
2212
2213 @item hsub, vsub
2214 horizontal and vertical chroma subsample values. For example for the
2215 pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
2216 @end table
2217
2218 For example to change the sample aspect ratio to 10:11, specify:
2219 @example
2220 setsar=sar=10/11
2221 @end example
2222
2223 @section settb
2224
2225 Set the timebase to use for the output frames timestamps.
2226 It is mainly useful for testing timebase configuration.
2227
2228 This filter accepts the following options:
2229
2230 @table @option
2231
2232 @item expr
2233 The expression which is evaluated into the output timebase.
2234
2235 @end table
2236
2237 The expression can contain the constants "PI", "E", "PHI", "AVTB" (the
2238 default timebase), and "intb" (the input timebase).
2239
2240 The default value for the input is "intb".
2241
2242 Follow some examples.
2243
2244 @example
2245 # set the timebase to 1/25
2246 settb=expr=1/25
2247
2248 # set the timebase to 1/10
2249 settb=expr=0.1
2250
2251 #set the timebase to 1001/1000
2252 settb=1+0.001
2253
2254 #set the timebase to 2*intb
2255 settb=2*intb
2256
2257 #set the default timebase value
2258 settb=AVTB
2259 @end example
2260
2261 @section showinfo
2262
2263 Show a line containing various information for each input video frame.
2264 The input video is not modified.
2265
2266 The shown line contains a sequence of key/value pairs of the form
2267 @var{key}:@var{value}.
2268
2269 A description of each shown parameter follows:
2270
2271 @table @option
2272 @item n
2273 sequential number of the input frame, starting from 0
2274
2275 @item pts
2276 Presentation TimeStamp of the input frame, expressed as a number of
2277 time base units. The time base unit depends on the filter input pad.
2278
2279 @item pts_time
2280 Presentation TimeStamp of the input frame, expressed as a number of
2281 seconds
2282
2283 @item pos
2284 position of the frame in the input stream, -1 if this information in
2285 unavailable and/or meaningless (for example in case of synthetic video)
2286
2287 @item fmt
2288 pixel format name
2289
2290 @item sar
2291 sample aspect ratio of the input frame, expressed in the form
2292 @var{num}/@var{den}
2293
2294 @item s
2295 size of the input frame, expressed in the form
2296 @var{width}x@var{height}
2297
2298 @item i
2299 interlaced mode ("P" for "progressive", "T" for top field first, "B"
2300 for bottom field first)
2301
2302 @item iskey
2303 1 if the frame is a key frame, 0 otherwise
2304
2305 @item type
2306 picture type of the input frame ("I" for an I-frame, "P" for a
2307 P-frame, "B" for a B-frame, "?" for unknown type).
2308 Check also the documentation of the @code{AVPictureType} enum and of
2309 the @code{av_get_picture_type_char} function defined in
2310 @file{libavutil/avutil.h}.
2311
2312 @item checksum
2313 Adler-32 checksum of all the planes of the input frame
2314
2315 @item plane_checksum
2316 Adler-32 checksum of each plane of the input frame, expressed in the form
2317 "[@var{c0} @var{c1} @var{c2} @var{c3}]"
2318 @end table
2319
2320 @section split
2321
2322 Split input video into several identical outputs.
2323
2324 The filter accepts a single parameter which specifies the number of outputs. If
2325 unspecified, it defaults to 2.
2326
2327 For example
2328 @example
2329 avconv -i INPUT -filter_complex split=5 OUTPUT
2330 @end example
2331 will create 5 copies of the input video.
2332
2333 @section transpose
2334
2335 Transpose rows with columns in the input video and optionally flip it.
2336
2337 This filter accepts the following options:
2338
2339 @table @option
2340
2341 @item dir
2342 The direction of the transpose.
2343
2344 @end table
2345
2346 The direction can assume the following values:
2347
2348 @table @samp
2349 @item cclock_flip
2350 Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
2351 @example
2352 L.R     L.l
2353 . . ->  . .
2354 l.r     R.r
2355 @end example
2356
2357 @item clock
2358 Rotate by 90 degrees clockwise, that is:
2359 @example
2360 L.R     l.L
2361 . . ->  . .
2362 l.r     r.R
2363 @end example
2364
2365 @item cclock
2366 Rotate by 90 degrees counterclockwise, that is:
2367 @example
2368 L.R     R.r
2369 . . ->  . .
2370 l.r     L.l
2371 @end example
2372
2373 @item clock_flip
2374 Rotate by 90 degrees clockwise and vertically flip, that is:
2375 @example
2376 L.R     r.R
2377 . . ->  . .
2378 l.r     l.L
2379 @end example
2380 @end table
2381
2382 @section trim
2383 Trim the input so that the output contains one continuous subpart of the input.
2384
2385 This filter accepts the following options:
2386 @table @option
2387 @item start
2388 Timestamp (in seconds) of the start of the kept section. I.e. the frame with the
2389 timestamp @var{start} will be the first frame in the output.
2390
2391 @item end
2392 Timestamp (in seconds) of the first frame that will be dropped. I.e. the frame
2393 immediately preceding the one with the timestamp @var{end} will be the last
2394 frame in the output.
2395
2396 @item start_pts
2397 Same as @var{start}, except this option sets the start timestamp in timebase
2398 units instead of seconds.
2399
2400 @item end_pts
2401 Same as @var{end}, except this option sets the end timestamp in timebase units
2402 instead of seconds.
2403
2404 @item duration
2405 Maximum duration of the output in seconds.
2406
2407 @item start_frame
2408 Number of the first frame that should be passed to output.
2409
2410 @item end_frame
2411 Number of the first frame that should be dropped.
2412 @end table
2413
2414 Note that the first two sets of the start/end options and the @option{duration}
2415 option look at the frame timestamp, while the _frame variants simply count the
2416 frames that pass through the filter. Also note that this filter does not modify
2417 the timestamps. If you wish that the output timestamps start at zero, insert a
2418 setpts filter after the trim filter.
2419
2420 If multiple start or end options are set, this filter tries to be greedy and
2421 keep all the frames that match at least one of the specified constraints. To keep
2422 only the part that matches all the constraints at once, chain multiple trim
2423 filters.
2424
2425 The defaults are such that all the input is kept. So it is possible to set e.g.
2426 just the end values to keep everything before the specified time.
2427
2428 Examples:
2429 @itemize
2430 @item
2431 drop everything except the second minute of input
2432 @example
2433 avconv -i INPUT -vf trim=60:120
2434 @end example
2435
2436 @item
2437 keep only the first second
2438 @example
2439 avconv -i INPUT -vf trim=duration=1
2440 @end example
2441
2442 @end itemize
2443 @section unsharp
2444
2445 Sharpen or blur the input video.
2446
2447 It accepts the following parameters:
2448
2449 @table @option
2450
2451 @item luma_msize_x
2452 Set the luma matrix horizontal size. It can be an integer between 3
2453 and 13, default value is 5.
2454
2455 @item luma_msize_y
2456 Set the luma matrix vertical size. It can be an integer between 3
2457 and 13, default value is 5.
2458
2459 @item luma_amount
2460 Set the luma effect strength. It can be a float number between -2.0
2461 and 5.0, default value is 1.0.
2462
2463 @item chroma_msize_x
2464 Set the chroma matrix horizontal size. It can be an integer between 3
2465 and 13, default value is 5.
2466
2467 @item chroma_msize_y
2468 Set the chroma matrix vertical size. It can be an integer between 3
2469 and 13, default value is 5.
2470
2471 @item chroma_amount
2472 Set the chroma effect strength. It can be a float number between -2.0
2473 and 5.0, default value is 0.0.
2474
2475 @end table
2476
2477 Negative values for the amount will blur the input video, while positive
2478 values will sharpen. All parameters are optional and default to the
2479 equivalent of the string '5:5:1.0:5:5:0.0'.
2480
2481 @example
2482 # Strong luma sharpen effect parameters
2483 unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
2484
2485 # Strong blur of both luma and chroma parameters
2486 unsharp=7:7:-2:7:7:-2
2487
2488 # Use the default values with @command{avconv}
2489 ./avconv -i in.avi -vf "unsharp" out.mp4
2490 @end example
2491
2492 @section vflip
2493
2494 Flip the input video vertically.
2495
2496 @example
2497 ./avconv -i in.avi -vf "vflip" out.avi
2498 @end example
2499
2500 @section yadif
2501
2502 Deinterlace the input video ("yadif" means "yet another deinterlacing
2503 filter").
2504
2505 This filter accepts the following options:
2506
2507 @table @option
2508
2509 @item mode
2510 The interlacing mode to adopt, accepts one of the following values:
2511
2512 @table @option
2513 @item 0
2514 output 1 frame for each frame
2515 @item 1
2516 output 1 frame for each field
2517 @item 2
2518 like 0 but skips spatial interlacing check
2519 @item 3
2520 like 1 but skips spatial interlacing check
2521 @end table
2522
2523 Default value is 0.
2524
2525 @item parity
2526 The picture field parity assumed for the input interlaced video, accepts one of
2527 the following values:
2528
2529 @table @option
2530 @item 0
2531 assume top field first
2532 @item 1
2533 assume bottom field first
2534 @item -1
2535 enable automatic detection
2536 @end table
2537
2538 Default value is -1.
2539 If interlacing is unknown or decoder does not export this information,
2540 top field first will be assumed.
2541
2542 @item auto
2543 Whether deinterlacer should trust the interlaced flag and only deinterlace
2544 frames marked as interlaced
2545
2546 @table @option
2547 @item 0
2548 deinterlace all frames
2549 @item 1
2550 only deinterlace frames marked as interlaced
2551 @end table
2552
2553 Default value is 0.
2554
2555 @end table
2556
2557 @c man end VIDEO FILTERS
2558
2559 @chapter Video Sources
2560 @c man begin VIDEO SOURCES
2561
2562 Below is a description of the currently available video sources.
2563
2564 @section buffer
2565
2566 Buffer video frames, and make them available to the filter chain.
2567
2568 This source is mainly intended for a programmatic use, in particular
2569 through the interface defined in @file{libavfilter/vsrc_buffer.h}.
2570
2571 This filter accepts the following parameters:
2572
2573 @table @option
2574
2575 @item width
2576 Input video width.
2577
2578 @item height
2579 Input video height.
2580
2581 @item pix_fmt
2582 Name of the input video pixel format.
2583
2584 @item time_base
2585 The time base used for input timestamps.
2586
2587 @item sar
2588 Sample (pixel) aspect ratio of the input video.
2589
2590 @end table
2591
2592 For example:
2593 @example
2594 buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
2595 @end example
2596
2597 will instruct the source to accept video frames with size 320x240 and
2598 with format "yuv410p", assuming 1/24 as the timestamps timebase and
2599 square pixels (1:1 sample aspect ratio).
2600
2601 @section color
2602
2603 Provide an uniformly colored input.
2604
2605 It accepts the following parameters:
2606
2607 @table @option
2608
2609 @item color
2610 Specify the color of the source. It can be the name of a color (case
2611 insensitive match) or a 0xRRGGBB[AA] sequence, possibly followed by an
2612 alpha specifier. The default value is "black".
2613
2614 @item size
2615 Specify the size of the sourced video, it may be a string of the form
2616 @var{width}x@var{height}, or the name of a size abbreviation. The
2617 default value is "320x240".
2618
2619 @item framerate
2620 Specify the frame rate of the sourced video, as the number of frames
2621 generated per second. It has to be a string in the format
2622 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2623 number or a valid video frame rate abbreviation. The default value is
2624 "25".
2625
2626 @end table
2627
2628 For example the following graph description will generate a red source
2629 with an opacity of 0.2, with size "qcif" and a frame rate of 10
2630 frames per second, which will be overlayed over the source connected
2631 to the pad with identifier "in".
2632
2633 @example
2634 "color=red@@0.2:qcif:10 [color]; [in][color] overlay [out]"
2635 @end example
2636
2637 @section movie
2638
2639 Read a video stream from a movie container.
2640
2641 Note that this source is a hack that bypasses the standard input path. It can be
2642 useful in applications that do not support arbitrary filter graphs, but its use
2643 is discouraged in those that do. Specifically in @command{avconv} this filter
2644 should never be used, the @option{-filter_complex} option fully replaces it.
2645
2646 This filter accepts the following options:
2647
2648 @table @option
2649
2650 @item filename
2651 The name of the resource to read (not necessarily a file but also a device or a
2652 stream accessed through some protocol).
2653
2654 @item format_name, f
2655 Specifies the format assumed for the movie to read, and can be either
2656 the name of a container or an input device. If not specified the
2657 format is guessed from @var{movie_name} or by probing.
2658
2659 @item seek_point, sp
2660 Specifies the seek point in seconds, the frames will be output
2661 starting from this seek point, the parameter is evaluated with
2662 @code{av_strtod} so the numerical value may be suffixed by an IS
2663 postfix. Default value is "0".
2664
2665 @item stream_index, si
2666 Specifies the index of the video stream to read. If the value is -1,
2667 the best suited video stream will be automatically selected. Default
2668 value is "-1".
2669
2670 @end table
2671
2672 This filter allows to overlay a second video on top of main input of
2673 a filtergraph as shown in this graph:
2674 @example
2675 input -----------> deltapts0 --> overlay --> output
2676                                     ^
2677                                     |
2678 movie --> scale--> deltapts1 -------+
2679 @end example
2680
2681 Some examples follow:
2682 @example
2683 # skip 3.2 seconds from the start of the avi file in.avi, and overlay it
2684 # on top of the input labelled as "in".
2685 movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2686 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2687
2688 # read from a video4linux2 device, and overlay it on top of the input
2689 # labelled as "in"
2690 movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [movie];
2691 [in] setpts=PTS-STARTPTS, [movie] overlay=16:16 [out]
2692
2693 @end example
2694
2695 @section nullsrc
2696
2697 Null video source, never return images. It is mainly useful as a
2698 template and to be employed in analysis / debugging tools.
2699
2700 It accepts as optional parameter a string of the form
2701 @var{width}:@var{height}:@var{timebase}.
2702
2703 @var{width} and @var{height} specify the size of the configured
2704 source. The default values of @var{width} and @var{height} are
2705 respectively 352 and 288 (corresponding to the CIF size format).
2706
2707 @var{timebase} specifies an arithmetic expression representing a
2708 timebase. The expression can contain the constants "PI", "E", "PHI",
2709 "AVTB" (the default timebase), and defaults to the value "AVTB".
2710
2711 @section frei0r_src
2712
2713 Provide a frei0r source.
2714
2715 To enable compilation of this filter you need to install the frei0r
2716 header and configure Libav with --enable-frei0r.
2717
2718 This source accepts the following options:
2719
2720 @table @option
2721
2722 @item size
2723 The size of the video to generate, may be a string of the form
2724 @var{width}x@var{height} or a frame size abbreviation.
2725
2726 @item framerate
2727 Framerate of the generated video, may be a string of the form
2728 @var{num}/@var{den} or a frame rate abbreviation.
2729
2730 @item filter_name
2731 The name to the frei0r source to load. For more information regarding frei0r and
2732 how to set the parameters read the section @ref{frei0r} in the description of
2733 the video filters.
2734
2735 @item filter_params
2736 A '|'-separated list of parameters to pass to the frei0r source.
2737
2738 @end table
2739
2740 Some examples follow:
2741 @example
2742 # generate a frei0r partik0l source with size 200x200 and framerate 10
2743 # which is overlayed on the overlay filter main input
2744 frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
2745 @end example
2746
2747 @section rgbtestsrc, testsrc
2748
2749 The @code{rgbtestsrc} source generates an RGB test pattern useful for
2750 detecting RGB vs BGR issues. You should see a red, green and blue
2751 stripe from top to bottom.
2752
2753 The @code{testsrc} source generates a test video pattern, showing a
2754 color pattern, a scrolling gradient and a timestamp. This is mainly
2755 intended for testing purposes.
2756
2757 The sources accept the following options:
2758
2759 @table @option
2760
2761 @item size, s
2762 Specify the size of the sourced video, it may be a string of the form
2763 @var{width}x@var{height}, or the name of a size abbreviation. The
2764 default value is "320x240".
2765
2766 @item rate, r
2767 Specify the frame rate of the sourced video, as the number of frames
2768 generated per second. It has to be a string in the format
2769 @var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
2770 number or a valid video frame rate abbreviation. The default value is
2771 "25".
2772
2773 @item sar
2774 Set the sample aspect ratio of the sourced video.
2775
2776 @item duration
2777 Set the video duration of the sourced video. The accepted syntax is:
2778 @example
2779 [-]HH[:MM[:SS[.m...]]]
2780 [-]S+[.m...]
2781 @end example
2782 See also the function @code{av_parse_time()}.
2783
2784 If not specified, or the expressed duration is negative, the video is
2785 supposed to be generated forever.
2786 @end table
2787
2788 For example the following:
2789 @example
2790 testsrc=duration=5.3:size=qcif:rate=10
2791 @end example
2792
2793 will generate a video with a duration of 5.3 seconds, with size
2794 176x144 and a framerate of 10 frames per second.
2795
2796 @c man end VIDEO SOURCES
2797
2798 @chapter Video Sinks
2799 @c man begin VIDEO SINKS
2800
2801 Below is a description of the currently available video sinks.
2802
2803 @section buffersink
2804
2805 Buffer video frames, and make them available to the end of the filter
2806 graph.
2807
2808 This sink is intended for a programmatic use through the interface defined in
2809 @file{libavfilter/buffersink.h}.
2810
2811 @section nullsink
2812
2813 Null video sink, do absolutely nothing with the input video. It is
2814 mainly useful as a template and to be employed in analysis / debugging
2815 tools.
2816
2817 @c man end VIDEO SINKS