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