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