filters.texi 77.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
@chapter Filtergraph description
@c man begin FILTERGRAPH DESCRIPTION

A filtergraph is a directed graph of connected filters. It can contain
cycles, and there can be multiple links between a pair of
filters. Each link has one input pad on one side connecting it to one
filter from which it takes its input, and one output pad on the other
side connecting it to the one filter accepting its output.

Each filter in a filtergraph is an instance of a filter class
registered in the application, which defines the features and the
number of input and output pads of the filter.

A filter with no input pads is called a "source", a filter with no
output pads is called a "sink".

17
@anchor{Filtergraph syntax}
18 19
@section Filtergraph syntax

20 21 22 23
A filtergraph can be represented using a textual representation, which is
recognized by the @option{-filter}/@option{-vf} and @option{-filter_complex}
options in @command{avconv} and @option{-vf} in @command{avplay}, and by the
@code{avfilter_graph_parse()}/@code{avfilter_graph_parse2()} function defined in
24
@file{libavfilter/avfilter.h}.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

A filterchain consists of a sequence of connected filters, each one
connected to the previous one in the sequence. A filterchain is
represented by a list of ","-separated filter descriptions.

A filtergraph consists of a sequence of filterchains. A sequence of
filterchains is represented by a list of ";"-separated filterchain
descriptions.

A filter is represented by a string of the form:
[@var{in_link_1}]...[@var{in_link_N}]@var{filter_name}=@var{arguments}[@var{out_link_1}]...[@var{out_link_M}]

@var{filter_name} is the name of the filter class of which the
described filter is an instance of, and has to be the name of one of
the filter classes registered in the program.
The name of the filter class is optionally followed by a string
"=@var{arguments}".

@var{arguments} is a string which contains the parameters used to
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
initialize the filter instance. It may have one of the two allowed forms:
@itemize

@item
A ':'-separated list of @var{key=value} pairs.

@item
A ':'-separated list of @var{value}. In this case, the keys are assumed to be
the option names in the order they are declared. E.g. the @code{fade} filter
declares three options in this order -- @option{type}, @option{start_frame} and
@option{nb_frames}. Then the parameter list @var{in:0:30} means that the value
@var{in} is assigned to the option @option{type}, @var{0} to
@option{start_frame} and @var{30} to @option{nb_frames}.

@end itemize

If the option value itself is a list of items (e.g. the @code{format} filter
takes a list of pixel formats), the items in the list are usually separated by
'|'.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

The list of arguments can be quoted using the character "'" as initial
and ending mark, and the character '\' for escaping the characters
within the quoted text; otherwise the argument string is considered
terminated when the next special character (belonging to the set
"[]=;,") is encountered.

The name and arguments of the filter are optionally preceded and
followed by a list of link labels.
A link label allows to name a link and associate it to a filter output
or input pad. The preceding labels @var{in_link_1}
... @var{in_link_N}, are associated to the filter input pads,
the following labels @var{out_link_1} ... @var{out_link_M}, are
associated to the output pads.

When two link labels with the same name are found in the
filtergraph, a link between the corresponding input and output pad is
created.

If an output pad is not labelled, it is linked by default to the first
unlabelled input pad of the next filter in the filterchain.
For example in the filterchain:
@example
nullsrc, split[L1], [L2]overlay, nullsink
@end example
the split filter instance has two output pads, and the overlay filter
instance two input pads. The first output pad of split is labelled
"L1", the first input pad of overlay is labelled "L2", and the second
output pad of split is linked to the second input pad of overlay,
which are both unlabelled.

In a complete filterchain all the unlabelled filter input and output
pads must be connected. A filtergraph is considered valid if all the
filter input and output pads of all the filterchains are connected.

98
Libavfilter will automatically insert @ref{scale} filters where format
99 100 101 102 103
conversion is required. It is possible to specify swscale flags
for those automatically inserted scalers by prepending
@code{sws_flags=@var{flags};}
to the filtergraph description.

104 105 106 107 108 109
Follows a BNF description for the filtergraph syntax:
@example
@var{NAME}             ::= sequence of alphanumeric characters and '_'
@var{LINKLABEL}        ::= "[" @var{NAME} "]"
@var{LINKLABELS}       ::= @var{LINKLABEL} [@var{LINKLABELS}]
@var{FILTER_ARGUMENTS} ::= sequence of chars (eventually quoted)
110
@var{FILTER}           ::= [@var{LINKLABELS}] @var{NAME} ["=" @var{FILTER_ARGUMENTS}] [@var{LINKLABELS}]
111
@var{FILTERCHAIN}      ::= @var{FILTER} [,@var{FILTERCHAIN}]
112
@var{FILTERGRAPH}      ::= [sws_flags=@var{flags};] @var{FILTERCHAIN} [;@var{FILTERGRAPH}]
113 114 115 116
@end example

@c man end FILTERGRAPH DESCRIPTION

Stefano Sabatini's avatar
Stefano Sabatini committed
117 118 119
@chapter Audio Filters
@c man begin AUDIO FILTERS

120
When you configure your Libav build, you can disable any of the
Stefano Sabatini's avatar
Stefano Sabatini committed
121 122 123 124 125 126
existing filters using --disable-filters.
The configure output will show the audio filters included in your
build.

Below is a description of the currently available audio filters.

Anton Khirnov's avatar
Anton Khirnov committed
127 128 129 130 131 132 133 134 135
@section aformat

Convert the input audio to one of the specified formats. The framework will
negotiate the most appropriate format to minimize conversions.

The filter accepts the following named parameters:
@table @option

@item sample_fmts
136
A '|'-separated list of requested sample formats.
Anton Khirnov's avatar
Anton Khirnov committed
137 138

@item sample_rates
139
A '|'-separated list of requested sample rates.
Anton Khirnov's avatar
Anton Khirnov committed
140 141

@item channel_layouts
142
A '|'-separated list of requested channel layouts.
Anton Khirnov's avatar
Anton Khirnov committed
143 144 145 146 147 148 149

@end table

If a parameter is omitted, all values are allowed.

For example to force the output to either unsigned 8-bit or signed 16-bit stereo:
@example
150
aformat=sample_fmts=u8|s16:channel_layouts=stereo
Anton Khirnov's avatar
Anton Khirnov committed
151 152
@end example

Justin Ruggles's avatar
Justin Ruggles committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
@section amix

Mixes multiple audio inputs into a single output.

For example
@example
avconv -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
@end example
will mix 3 input audio streams to a single output with the same duration as the
first input and a dropout transition time of 3 seconds.

The filter accepts the following named parameters:
@table @option

@item inputs
Number of inputs. If unspecified, it defaults to 2.

@item duration
How to determine the end-of-stream.
@table @option

@item longest
Duration of longest input. (default)

@item shortest
Duration of shortest input.

@item first
Duration of first input.

@end table

@item dropout_transition
Transition time, in seconds, for volume renormalization when an input
stream ends. The default value is 2 seconds.

@end table

191 192 193 194
@section anull

Pass the audio source unchanged to the output.

Anton Khirnov's avatar
Anton Khirnov committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
@section asetpts

Change the PTS (presentation timestamp) of the input audio frames.

This filter accepts the following options:

@table @option

@item expr
The expression which is evaluated for each frame to construct its timestamp.

@end table

The expression is evaluated through the eval API and can contain the following
constants:

@table @option
@item PTS
the presentation timestamp in input

@item PI
Greek PI

@item PHI
golden ratio

@item E
Euler number

@item N
Number of the audio samples pass through the filter so far, starting at 0.

@item S
Number of the audio samples in the current frame.

@item SR
Audio sample rate.

@item STARTPTS
the PTS of the first frame

@item PREV_INPTS
previous input PTS

@item PREV_OUTPTS
previous output PTS

@item RTCTIME
wallclock (RTC) time in microseconds

@item RTCSTART
wallclock (RTC) time at the start of the movie in microseconds

@end table

Some examples follow:

@example
# start counting PTS from zero
asetpts=expr=PTS-STARTPTS

#generate timestamps by counting samples
asetpts=expr=N/SR/TB

# generate timestamps from a "live source" and rebase onto the current timebase
asetpts='(RTCTIME - RTCSTART) / (TB * 1000000)"
@end example


Anton Khirnov's avatar
Anton Khirnov committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
@section ashowinfo

Show a line containing various information for each input audio frame.
The input audio is not modified.

The shown line contains a sequence of key/value pairs of the form
@var{key}:@var{value}.

A description of each shown parameter follows:

@table @option
@item n
sequential number of the input frame, starting from 0

@item pts
Presentation timestamp of the input frame, in time base units; the time base
depends on the filter input pad, and is usually 1/@var{sample_rate}.

@item pts_time
presentation timestamp of the input frame in seconds

@item fmt
sample format

@item chlayout
channel layout

@item rate
sample rate for the audio frame

@item nb_samples
number of samples (per channel) in the frame

@item checksum
Adler-32 checksum (printed in hexadecimal) of the audio data. For planar audio
the data is treated as if all the planes were concatenated.

@item plane_checksums
A list of Adler-32 checksums for each data plane.
@end table

305 306 307 308 309 310 311 312 313 314 315 316 317
@section asplit

Split input audio into several identical outputs.

The filter accepts a single parameter which specifies the number of outputs. If
unspecified, it defaults to 2.

For example
@example
avconv -i INPUT -filter_complex asplit=5 OUTPUT
@end example
will create 5 copies of the input audio.

Anton Khirnov's avatar
Anton Khirnov committed
318 319 320 321 322 323 324 325
@section asyncts
Synchronize audio data with timestamps by squeezing/stretching it and/or
dropping samples/adding silence when needed.

The filter accepts the following named parameters:
@table @option

@item compensate
326 327
Enable stretching/squeezing the data to make it match the timestamps. Disabled
by default. When disabled, time gaps are covered with silence.
Anton Khirnov's avatar
Anton Khirnov committed
328 329 330

@item min_delta
Minimum difference between timestamps and audio data (in seconds) to trigger
331 332
adding/dropping samples. Default value is 0.1. If you get non-perfect sync with
this filter, try setting this parameter to 0.
Anton Khirnov's avatar
Anton Khirnov committed
333 334

@item max_comp
335 336
Maximum compensation in samples per second. Relevant only with compensate=1.
Default value 500.
Anton Khirnov's avatar
Anton Khirnov committed
337

338
@item first_pts
339
Assume the first pts should be this value. The time base is 1 / sample rate.
340 341 342
This allows for padding/trimming at the start of stream. By default, no
assumption is made about the first frame's expected pts, so no padding or
trimming is done. For example, this could be set to 0 to pad the beginning with
343 344
silence if an audio stream starts after the video stream or to trim any samples
with a negative pts due to encoder delay.
345

Anton Khirnov's avatar
Anton Khirnov committed
346 347
@end table

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
@section atrim
Trim the input so that the output contains one continuous subpart of the input.

This filter accepts the following options:
@table @option
@item start
Timestamp (in seconds) of the start of the kept section. I.e. the audio sample
with the timestamp @var{start} will be the first sample in the output.

@item end
Timestamp (in seconds) of the first audio sample that will be dropped. I.e. the
audio sample immediately preceding the one with the timestamp @var{end} will be
the last sample in the output.

@item start_pts
Same as @var{start}, except this option sets the start timestamp in samples
instead of seconds.

@item end_pts
Same as @var{end}, except this option sets the end timestamp in samples instead
of seconds.

@item duration
Maximum duration of the output in seconds.

@item start_sample
Number of the first sample that should be passed to output.

@item end_sample
Number of the first sample that should be dropped.
@end table

Note that the first two sets of the start/end options and the @option{duration}
option look at the frame timestamp, while the _sample options simply count the
samples that pass through the filter. So start/end_pts and start/end_sample will
give different results when the timestamps are wrong, inexact or do not start at
zero. Also note that this filter does not modify the timestamps. If you wish
that the output timestamps start at zero, insert the asetpts filter after the
atrim filter.

If multiple start or end options are set, this filter tries to be greedy and
keep all samples that match at least one of the specified constraints. To keep
only the part that matches all the constraints at once, chain multiple atrim
filters.

The defaults are such that all the input is kept. So it is possible to set e.g.
just the end values to keep everything before the specified time.

Examples:
@itemize
@item
drop everything except the second minute of input
@example
avconv -i INPUT -af atrim=60:120
@end example

@item
keep only the first 1000 samples
@example
avconv -i INPUT -af atrim=end_sample=1000
@end example

@end itemize

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
@section channelsplit
Split each channel in input audio stream into a separate output stream.

This filter accepts the following named parameters:
@table @option
@item channel_layout
Channel layout of the input stream. Default is "stereo".
@end table

For example, assuming a stereo input MP3 file
@example
avconv -i in.mp3 -filter_complex channelsplit out.mkv
@end example
will create an output Matroska file with two audio streams, one containing only
the left channel and the other the right channel.

To split a 5.1 WAV file into per-channel files
@example
avconv -i in.wav -filter_complex
'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
-map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
side_right.wav
@end example

437 438 439 440 441 442 443 444 445
@section channelmap
Remap input channels to new locations.

This filter accepts the following named parameters:
@table @option
@item channel_layout
Channel layout of the output stream.

@item map
446
Map channels from input to output. The argument is a '|'-separated list of
447 448 449 450 451 452 453 454 455 456 457 458 459
mappings, each in the @code{@var{in_channel}-@var{out_channel}} or
@var{in_channel} form. @var{in_channel} can be either the name of the input
channel (e.g. FL for front left) or its index in the input channel layout.
@var{out_channel} is the name of the output channel or its index in the output
channel layout. If @var{out_channel} is not given then it is implicitly an
index, starting with zero and increasing by one for each mapping.
@end table

If no mapping is present, the filter will implicitly map input channels to
output channels preserving index.

For example, assuming a 5.1+downmix input MOV file
@example
460
avconv -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
461 462 463 464 465 466
@end example
will create an output WAV file tagged as stereo from the downmix channels of
the input.

To fix a 5.1 WAV improperly encoded in AAC's native channel order
@example
467
avconv -i in.wav -filter 'channelmap=1|2|0|5|3|4:channel_layout=5.1' out.wav
468 469
@end example

Anton Khirnov's avatar
Anton Khirnov committed
470 471 472 473 474 475 476 477 478 479 480 481 482
@section join
Join multiple input streams into one multi-channel stream.

The filter accepts the following named parameters:
@table @option

@item inputs
Number of input streams. Defaults to 2.

@item channel_layout
Desired output channel layout. Defaults to stereo.

@item map
483
Map channels from inputs to output. The argument is a '|'-separated list of
Anton Khirnov's avatar
Anton Khirnov committed
484 485
mappings, each in the @code{@var{input_idx}.@var{in_channel}-@var{out_channel}}
form. @var{input_idx} is the 0-based index of the input stream. @var{in_channel}
Anton Khirnov's avatar
Anton Khirnov committed
486
can be either the name of the input channel (e.g. FL for front left) or its
Anton Khirnov's avatar
Anton Khirnov committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
index in the specified input stream. @var{out_channel} is the name of the output
channel.
@end table

The filter will attempt to guess the mappings when those are not specified
explicitly. It does so by first trying to find an unused matching input channel
and if that fails it picks the first unused input channel.

E.g. to join 3 inputs (with properly set channel layouts)
@example
avconv -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
@end example

To build a 5.1 output from 6 single-channel streams:
@example
avconv -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
503
'join=inputs=6:channel_layout=5.1:map=0.0-FL|1.0-FR|2.0-FC|3.0-SL|4.0-SR|5.0-LFE'
Anton Khirnov's avatar
Anton Khirnov committed
504 505 506
out
@end example

507 508 509 510 511 512
@section resample
Convert the audio sample format, sample rate and channel layout. This filter is
not meant to be used directly, it is inserted automatically by libavfilter
whenever conversion is needed. Use the @var{aformat} filter to force a specific
conversion.

Justin Ruggles's avatar
Justin Ruggles committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
@section volume

Adjust the input audio volume.

The filter accepts the following named parameters:
@table @option

@item volume
Expresses how the audio volume will be increased or decreased.

Output values are clipped to the maximum value.

The output audio volume is given by the relation:
@example
@var{output_volume} = @var{volume} * @var{input_volume}
@end example

Default value for @var{volume} is 1.0.

@item precision
Mathematical precision.

This determines which input sample formats will be allowed, which affects the
precision of the volume scaling.

@table @option
@item fixed
8-bit fixed-point; limits input sample format to U8, S16, and S32.
@item float
32-bit floating-point; limits input sample format to FLT. (default)
@item double
64-bit floating-point; limits input sample format to DBL.
@end table
@end table

@subsection Examples

@itemize
@item
Halve the input audio volume:
@example
volume=volume=0.5
volume=volume=1/2
volume=volume=-6.0206dB
@end example

@item
Increase input audio power by 6 decibels using fixed-point precision:
@example
volume=volume=6dB:precision=fixed
@end example
@end itemize

Stefano Sabatini's avatar
Stefano Sabatini committed
566 567
@c man end AUDIO FILTERS

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
@chapter Audio Sources
@c man begin AUDIO SOURCES

Below is a description of the currently available audio sources.

@section anullsrc

Null audio source, never return audio frames. It is mainly useful as a
template and to be employed in analysis / debugging tools.

It accepts as optional parameter a string of the form
@var{sample_rate}:@var{channel_layout}.

@var{sample_rate} specify the sample rate, and defaults to 44100.

@var{channel_layout} specify the channel layout, and can be either an
integer or a string representing a channel layout. The default value
of @var{channel_layout} is 3, which corresponds to CH_LAYOUT_STEREO.

Check the channel_layout_map definition in
588
@file{libavutil/channel_layout.c} for the mapping between strings and
589
channel layout values.
590 591 592 593 594 595 596 597 598 599

Follow some examples:
@example
#  set the sample rate to 48000 Hz and the channel layout to CH_LAYOUT_MONO.
anullsrc=48000:4

# same as
anullsrc=48000:mono
@end example

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
@section abuffer
Buffer audio frames, and make them available to the filter chain.

This source is not intended to be part of user-supplied graph descriptions but
for insertion by calling programs through the interface defined in
@file{libavfilter/buffersrc.h}.

It accepts the following named parameters:
@table @option

@item time_base
Timebase which will be used for timestamps of submitted frames. It must be
either a floating-point number or in @var{numerator}/@var{denominator} form.

@item sample_rate
Audio sample rate.

@item sample_fmt
Name of the sample format, as returned by @code{av_get_sample_fmt_name()}.

@item channel_layout
Channel layout of the audio data, in the form that can be accepted by
@code{av_get_channel_layout()}.
@end table

All the parameters need to be explicitly defined.

627 628
@c man end AUDIO SOURCES

629 630 631 632 633 634 635 636 637 638 639
@chapter Audio Sinks
@c man begin AUDIO SINKS

Below is a description of the currently available audio sinks.

@section anullsink

Null audio sink, do absolutely nothing with the input audio. It is
mainly useful as a template and to be employed in analysis / debugging
tools.

640 641 642 643 644 645 646
@section abuffersink
This sink is intended for programmatic use. Frames that arrive on this sink can
be retrieved by the calling program using the interface defined in
@file{libavfilter/buffersink.h}.

This filter accepts no parameters.

647 648
@c man end AUDIO SINKS

649 650 651
@chapter Video Filters
@c man begin VIDEO FILTERS

652
When you configure your Libav build, you can disable any of the
653 654 655 656 657 658
existing filters using --disable-filters.
The configure output will show the video filters included in your
build.

Below is a description of the currently available video filters.

659 660 661 662 663 664 665 666 667 668
@section blackframe

Detect frames that are (almost) completely black. Can be useful to
detect chapter transitions or commercials. Output lines consist of
the frame number of the detected frame, the percentage of blackness,
the position in the file if known or -1 and the timestamp in seconds.

In order to display the output lines, you need to set the loglevel at
least to the AV_LOG_INFO value.

669 670 671 672 673 674 675
The filter accepts the following options:

@table @option

@item amount
The percentage of the pixels that have to be below the threshold, defaults to
98.
676

677 678
@item threshold
Threshold below which a pixel value is considered black, defaults to 32.
679

680
@end table
681

682 683 684 685
@section boxblur

Apply boxblur algorithm to the input video.

686 687 688 689 690 691 692 693 694 695 696 697
This filter accepts the following options:

@table @option

@item luma_radius
@item luma_power
@item chroma_radius
@item chroma_power
@item alpha_radius
@item alpha_power

@end table
698 699 700 701 702 703 704 705 706 707 708

Chroma and alpha parameters are optional, if not specified they default
to the corresponding values set for @var{luma_radius} and
@var{luma_power}.

@var{luma_radius}, @var{chroma_radius}, and @var{alpha_radius} represent
the radius in pixels of the box used for blurring the corresponding
input plane. They are expressions, and can contain the following
constants:
@table @option
@item w, h
Diego Biurrun's avatar
Diego Biurrun committed
709
the input width and height in pixels
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734

@item cw, ch
the input chroma image width and height in pixels

@item hsub, vsub
horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" @var{hsub} is 2 and @var{vsub} is 1.
@end table

The radius must be a non-negative number, and must not be greater than
the value of the expression @code{min(w,h)/2} for the luma and alpha planes,
and of @code{min(cw,ch)/2} for the chroma planes.

@var{luma_power}, @var{chroma_power}, and @var{alpha_power} represent
how many times the boxblur filter is applied to the corresponding
plane.

Some examples follow:

@itemize

@item
Apply a boxblur filter with luma, chroma, and alpha radius
set to 2:
@example
735
boxblur=luma_radius=2:luma_power=1
736 737 738 739 740 741 742 743 744 745 746
@end example

@item
Set luma radius to 2, alpha and chroma radius to 0
@example
boxblur=2:1:0:0:0:0
@end example

@item
Set luma and chroma radius to a fraction of the video dimension
@example
747
boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
748 749 750 751
@end example

@end itemize

752 753 754 755 756
@section copy

Copy the input source unchanged to the output. Mainly useful for
testing purposes.

757 758
@section crop

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
Crop the input video to given dimensions.

This filter accepts the following options:

@table @option

@item out_w
Width of the output video.

@item out_h
Height of the output video.

@item x
Horizontal position, in the input video, of the left edge of the output video.

@item y
Vertical position, in the input video, of the top edge of the output video.

@end table
778

779 780 781 782 783 784 785 786 787 788 789 790
The parameters are expressions containing the following constants:

@table @option
@item E, PI, PHI
the corresponding mathematical approximated values for e
(euler number), pi (greek PI), PHI (golden ratio)

@item x, y
the computed values for @var{x} and @var{y}. They are evaluated for
each new frame.

@item in_w, in_h
791
the input width and height
792 793 794 795 796

@item iw, ih
same as @var{in_w} and @var{in_h}

@item out_w, out_h
797
the output (cropped) width and height
798 799 800 801 802 803 804 805 806

@item ow, oh
same as @var{out_w} and @var{out_h}

@item n
the number of input frame, starting from 0

@item t
timestamp expressed in seconds, NAN if the input timestamp is unknown
807

808
@end table
809

810 811 812
The @var{out_w} and @var{out_h} parameters specify the expressions for
the width and height of the output (cropped) video. They are
evaluated just at the configuration of the filter.
813

814 815
The default value of @var{out_w} is "in_w", and the default value of
@var{out_h} is "in_h".
816

817 818 819 820
The expression for @var{out_w} may depend on the value of @var{out_h},
and the expression for @var{out_h} may depend on @var{out_w}, but they
cannot depend on @var{x} and @var{y}, as @var{x} and @var{y} are
evaluated after @var{out_w} and @var{out_h}.
821

822 823 824 825
The @var{x} and @var{y} parameters specify the expressions for the
position of the top-left corner of the output (non-cropped) area. They
are evaluated for each frame. If the evaluated value is not valid, it
is approximated to the nearest valid value.
826

827 828 829 830 831 832 833 834
The default value of @var{x} is "(in_w-out_w)/2", and the default
value for @var{y} is "(in_h-out_h)/2", which set the cropped area at
the center of the input image.

The expression for @var{x} may depend on @var{y}, and the expression
for @var{y} may depend on @var{x}.

Follow some examples:
835
@example
836
# crop the central input area with size 100x100
837
crop=out_w=100:out_h=100
838 839

# crop the central input area with size 2/3 of the input video
840
"crop=out_w=2/3*in_w:out_h=2/3*in_h"
841 842

# crop the input video central square
843
crop=out_w=in_h
844 845 846 847

# delimit the rectangle with the top-left corner placed at position
# 100:100 and the right-bottom corner corresponding to the right-bottom
# corner of the input image.
848
crop=out_w=in_w-100:out_h=in_h-100:x=100:y=100
849

850
# crop 10 pixels from the left and right borders, and 20 pixels from
851
# the top and bottom borders
852
"crop=out_w=in_w-2*10:out_h=in_h-2*20"
853

854
# keep only the bottom right quarter of the input image
855
"crop=out_w=in_w/2:out_h=in_h/2:x=in_w/2:y=in_h/2"
856 857

# crop height for getting Greek harmony
858
"crop=out_w=in_w:out_h=1/PHI*in_w"
859 860 861 862

# trembling effect
"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)"

863
# erratic camera effect depending on timestamp
864
"crop=out_w=in_w/2:out_h=in_h/2:x=(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):y=(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
865 866 867 868

# set x depending on the value of y
"crop=in_w/2:in_h/2:y:10+10*sin(n/10)"
@end example
869

870 871 872 873 874 875 876 877
@section cropdetect

Auto-detect crop size.

Calculate necessary cropping parameters and prints the recommended
parameters through the logging system. The detected dimensions
correspond to the non-black area of the input video.

878
This filter accepts the following options:
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901

@table @option

@item limit
Threshold, which can be optionally specified from nothing (0) to
everything (255), defaults to 24.

@item round
Value which the width/height should be divisible by, defaults to
16. The offset is automatically adjusted to center the video. Use 2 to
get only even dimensions (needed for 4:2:2 video). 16 is best when
encoding to most video codecs.

@item reset
Counter that determines after how many frames cropdetect will reset
the previously detected largest video area and start over to detect
the current optimal crop area. Defaults to 0.

This can be useful when channel logos distort the video area. 0
indicates never reset and return the largest area encountered during
playback.
@end table

902 903 904 905 906 907
@section delogo

Suppress a TV station logo by a simple interpolation of the surrounding
pixels. Just set a rectangle covering the logo and watch it disappear
(and sometimes something even uglier appear - your mileage may vary).

908
This filter accepts the following options:
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
@table @option

@item x, y
Specify the top left corner coordinates of the logo. They must be
specified.

@item w, h
Specify the width and height of the logo to clear. They must be
specified.

@item band, t
Specify the thickness of the fuzzy edge of the rectangle (added to
@var{w} and @var{h}). The default value is 4.

@item show
When set to 1, a green rectangle is drawn on the screen to simplify
finding the right @var{x}, @var{y}, @var{w}, @var{h} parameters, and
@var{band} is set to 4. The default value is 0.

@end table

Some examples follow.

@itemize

@item
Set a rectangle covering the area with top left corner coordinates 0,0
and size 100x77, setting a band of size 10:
@example
delogo=x=0:y=0:w=100:h=77:band=10
@end example

@end itemize

943 944 945 946
@section drawbox

Draw a colored box on the input image.

947
This filter accepts the following options:
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968

@table @option

@item x, y
Specify the top left corner coordinates of the box. Default to 0.

@item width, height
Specify the width and height of the box, if 0 they are interpreted as
the input width and height. Default to 0.

@item color
Specify the color of the box to write, it can be the name of a color
(case insensitive match) or a 0xRRGGBB[AA] sequence.
@end table

Follow some examples:
@example
# draw a black box around the edge of the input image
drawbox

# draw a box with color red and an opacity of 50%
969
drawbox=x=10:y=20:width=200:height=60:color=red@@0.5"
970 971
@end example

972 973 974 975 976
@section drawtext

Draw text string or text from specified file on top of video using the
libfreetype library.

977
To enable compilation of this filter you need to configure Libav with
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
@code{--enable-libfreetype}.

The filter also recognizes strftime() sequences in the provided text
and expands them accordingly. Check the documentation of strftime().

The description of the accepted parameters follows.

@table @option

@item fontfile
The font file to be used for drawing text. Path must be included.
This parameter is mandatory.

@item text
The text string to be drawn. The text must be a sequence of UTF-8
encoded characters.
This parameter is mandatory if no file is specified with the parameter
@var{textfile}.

@item textfile
A text file containing text to be drawn. The text must be a sequence
of UTF-8 encoded characters.

This parameter is mandatory if no text string is specified with the
parameter @var{text}.

If both text and textfile are specified, an error is thrown.

@item x, y
The offsets where text will be drawn within the video frame.
Relative to the top/left border of the output image.
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
They accept expressions similar to the @ref{overlay} filter:
@table @option

@item x, y
the computed values for @var{x} and @var{y}. They are evaluated for
each new frame.

@item main_w, main_h
main input width and height

@item W, H
same as @var{main_w} and @var{main_h}

@item text_w, text_h
rendered text width and height

@item w, h
same as @var{text_w} and @var{text_h}

@item n
the number of frames processed, starting from 0

@item t
timestamp expressed in seconds, NAN if the input timestamp is unknown

@end table
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

The default value of @var{x} and @var{y} is 0.

@item fontsize
The font size to be used for drawing text.
The default value of @var{fontsize} is 16.

@item fontcolor
The color to be used for drawing fonts.
Either a string (e.g. "red") or in 0xRRGGBB[AA] format
(e.g. "0xff000033"), possibly followed by an alpha specifier.
The default value of @var{fontcolor} is "black".

@item boxcolor
The color to be used for drawing box around text.
Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
(e.g. "0xff00ff"), possibly followed by an alpha specifier.
The default value of @var{boxcolor} is "white".

@item box
Used to draw a box around text using background color.
Value should be either 1 (enable) or 0 (disable).
The default value of @var{box} is 0.

1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
@item shadowx, shadowy
The x and y offsets for the text shadow position with respect to the
position of the text. They can be either positive or negative
values. Default value for both is "0".

@item shadowcolor
The color to be used for drawing a shadow behind the drawn text.  It
can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
The default value of @var{shadowcolor} is "black".

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
@item ft_load_flags
Flags to be used for loading the fonts.

The flags map the corresponding flags supported by libfreetype, and are
a combination of the following values:
@table @var
@item default
@item no_scale
@item no_hinting
@item render
@item no_bitmap
@item vertical_layout
@item force_autohint
@item crop_bitmap
@item pedantic
@item ignore_global_advance_width
@item no_recurse
@item ignore_transform
@item monochrome
@item linear_design
@item no_autohint
@item end table
@end table

Default value is "render".

For more information consult the documentation for the FT_LOAD_*
libfreetype flags.

@item tabsize
The size in number of spaces to use for rendering the tab.
Default value is 4.
1102 1103 1104

@item fix_bounds
If true, check and fix text coords to avoid clipping.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
@end table

For example the command:
@example
drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
@end example

will draw "Test Text" with font FreeSerif, using the default values
for the optional parameters.

The command:
@example
drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
          x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
@end example

will draw 'Test Text' with font FreeSerif of size 24 at position x=100
and y=50 (counting from the top-left corner of the screen), text is
yellow with a red box around it. Both the text and the box have an
opacity of 20%.

Note that the double quotes are not necessary if spaces are not used
within the parameter list.

For more information about libfreetype, check:
@url{http://www.freetype.org/}.

Brandon Mintern's avatar
Brandon Mintern committed
1132 1133 1134 1135
@section fade

Apply fade-in/out effect to input video.

1136 1137 1138
This filter accepts the following options:

@table @option
Brandon Mintern's avatar
Brandon Mintern committed
1139

1140 1141 1142
@item type
The effect type -- can be either "in" for fade-in, or "out" for a fade-out
effect.
Brandon Mintern's avatar
Brandon Mintern committed
1143

1144 1145
@item start_frame
The number of the start frame for starting to apply the fade effect.
Brandon Mintern's avatar
Brandon Mintern committed
1146

1147 1148 1149 1150 1151 1152
@item nb_frames
The number of frames for which the fade effect has to last. At the end of the
fade-in effect the output video will have the same intensity as the input video,
at the end of the fade-out transition the output video will be completely black.

@end table
Brandon Mintern's avatar
Brandon Mintern committed
1153 1154 1155 1156

A few usage examples follow, usable too as test scenarios.
@example
# fade in first 30 frames of video
1157
fade=type=in:nb_frames=30
Brandon Mintern's avatar
Brandon Mintern committed
1158 1159

# fade out last 45 frames of a 200-frame video
1160
fade=type=out:start_frame=155:nb_frames=45
Brandon Mintern's avatar
Brandon Mintern committed
1161 1162

# fade in first 25 frames and fade out last 25 frames of a 1000-frame video
1163
fade=type=in:start_frame=0:nb_frames=25, fade=type=out:start_frame=975:nb_frames=25
Brandon Mintern's avatar
Brandon Mintern committed
1164 1165

# make first 5 frames black, then fade in from frame 5-24
1166
fade=type=in:start_frame=5:nb_frames=20
Brandon Mintern's avatar
Brandon Mintern committed
1167 1168
@end example

Mark Himsley's avatar
Mark Himsley committed
1169 1170 1171 1172
@section fieldorder

Transform the field order of the input video.

1173
This filter accepts the following options:
Mark Himsley's avatar
Mark Himsley committed
1174 1175

@table @option
1176 1177 1178 1179

@item order
Output field order. Valid values are @var{tff} for top field first or @var{bff}
for bottom field first.
Mark Himsley's avatar
Mark Himsley committed
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
@end table

Default value is "tff".

Transformation is achieved by shifting the picture content up or down
by one line, and filling the remaining line with appropriate picture content.
This method is consistent with most broadcast field order converters.

If the input video is not flagged as being interlaced, or it is already
flagged as being of the required output field order then this filter does
not alter the incoming video.

This filter is very useful when converting to or from PAL DV material,
which is bottom field first.

For example:
@example
1197
./avconv -i in.vob -vf "fieldorder=order=bff" out.dv
Mark Himsley's avatar
Mark Himsley committed
1198 1199
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1200 1201 1202 1203 1204 1205 1206 1207 1208
@section fifo

Buffer input images and send them when they are requested.

This filter is mainly useful when auto-inserted by the libavfilter
framework.

The filter does not take parameters.

1209 1210 1211 1212 1213 1214
@section format

Convert the input video to one of the specified pixel formats.
Libavfilter will try to pick one that is supported for the input to
the next filter.

1215 1216 1217 1218 1219 1220 1221 1222
This filter accepts the following parameters:
@table @option

@item pix_fmts
A '|'-separated list of pixel format names, for example
"pix_fmts=yuv420p|monow|rgb24".

@end table
1223

1224
Some examples follow:
1225
@example
1226
# convert the input video to the format "yuv420p"
1227
format=pix_fmts=yuv420p
1228

1229
# convert the input video to any of the formats in the list
1230
format=pix_fmts=yuv420p|yuv444p|yuv410p
1231
@end example
1232

1233
@anchor{fps}
Anton Khirnov's avatar
Anton Khirnov committed
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
@section fps

Convert the video to specified constant framerate by duplicating or dropping
frames as necessary.

This filter accepts the following named parameters:
@table @option

@item fps
Desired output framerate.

1245 1246 1247 1248 1249 1250 1251 1252
@item start_time
Assume the first PTS should be the given value, in seconds. This allows for
padding/trimming at the start of stream. By default, no assumption is made
about the first frame's expected PTS, so no padding or trimming is done.
For example, this could be set to 0 to pad the beginning with duplicates of
the first frame if a video stream starts after the audio stream or to trim any
frames with a negative PTS.

Anton Khirnov's avatar
Anton Khirnov committed
1253 1254
@end table

Vittorio Giovara's avatar
Vittorio Giovara committed
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
@section framepack

Pack two different video streams into a stereoscopic video, setting proper
metadata on supported codecs. The two views should have the same size and
framerate and processing will stop when the shorter video ends. Please note
that you may conveniently adjust view properties with the @ref{scale} and
@ref{fps} filters.

This filter accepts the following named parameters:
@table @option

@item format
Desired packing format. Supported values are:

@table @option

@item sbs
Views are next to each other (default).

@item tab
Views are on top of each other.

@item lines
Views are packed by line.

@item columns
Views are eacked by column.

@item frameseq
Views are temporally interleaved.

@end table

@end table

Some examples follow:

@example
# Convert left and right views into a frame sequential video.
avconv -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT

# Convert views into a side-by-side video with the same output resolution as the input.
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
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1300
@anchor{frei0r}
Stefano Sabatini's avatar
Stefano Sabatini committed
1301 1302 1303 1304 1305
@section frei0r

Apply a frei0r effect to the input video.

To enable compilation of this filter you need to install the frei0r
1306
header and configure Libav with --enable-frei0r.
Stefano Sabatini's avatar
Stefano Sabatini committed
1307

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
This filter accepts the following options:

@table @option

@item filter_name
The name to the frei0r effect to load. If the environment variable
@env{FREI0R_PATH} is defined, the frei0r effect is searched in each one of the
directories specified by the colon separated list in @env{FREIOR_PATH},
otherwise in the standard frei0r paths, which are in this order:
@file{HOME/.frei0r-1/lib/}, @file{/usr/local/lib/frei0r-1/},
@file{/usr/lib/frei0r-1/}.
Stefano Sabatini's avatar
Stefano Sabatini committed
1319

1320 1321
@item filter_params
A '|'-separated list of parameters to pass to the frei0r effect.
Stefano Sabatini's avatar
Stefano Sabatini committed
1322

1323
@end table
Stefano Sabatini's avatar
Stefano Sabatini committed
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337

A frei0r effect parameter can be a boolean (whose values are specified
with "y" and "n"), a double, a color (specified by the syntax
@var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float
numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color
description), a position (specified by the syntax @var{X}/@var{Y},
@var{X} and @var{Y} being float numbers) and a string.

The number and kind of parameters depend on the loaded effect. If an
effect parameter is not specified the default value is set.

Some examples follow:
@example
# apply the distort0r effect, set the first two double parameters
1338
frei0r=filter_name=distort0r:filter_params=0.5|0.01
Stefano Sabatini's avatar
Stefano Sabatini committed
1339 1340 1341 1342 1343 1344 1345 1346

# apply the colordistance effect, takes a color as first parameter
frei0r=colordistance:0.2/0.3/0.4
frei0r=colordistance:violet
frei0r=colordistance:0x112233

# apply the perspective effect, specify the top left and top right
# image positions
1347
frei0r=perspective:0.2/0.2|0.8/0.2
Stefano Sabatini's avatar
Stefano Sabatini committed
1348 1349 1350 1351 1352
@end example

For more information see:
@url{http://piksel.org/frei0r}

1353 1354 1355 1356 1357 1358 1359
@section gradfun

Fix the banding artifacts that are sometimes introduced into nearly flat
regions by truncation to 8bit colordepth.
Interpolate the gradients that should go where the bands are, and
dither them.

1360 1361 1362 1363
This filter is designed for playback only.  Do not use it prior to
lossy compression, because compression tends to lose the dither and
bring back the bands.

1364 1365 1366
This filter accepts the following options:

@table @option
1367

1368 1369 1370 1371 1372
@item strength
The maximum amount by which the filter will change any one pixel. Also the
threshold for detecting nearly flat regions. Acceptable values range from .51 to
64, default value is 1.2, out-of-range values will be clipped to the valid
range.
1373

1374 1375 1376 1377 1378 1379 1380
@item radius
The neighborhood to fit the gradient to. A larger radius makes for smoother
gradients, but also prevents the filter from modifying the pixels near detailed
regions. Acceptable values are 8-32, default value is 16, out-of-range values
will be clipped to the valid range.

@end table
1381 1382 1383

@example
# default parameters
1384
gradfun=strength=1.2:radius=16
1385 1386 1387 1388 1389

# omitting radius
gradfun=1.2
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1390 1391 1392 1393
@section hflip

Flip the input video horizontally.

Luca Barbato's avatar
Luca Barbato committed
1394
For example to horizontally flip the input video with @command{avconv}:
Stefano Sabatini's avatar
Stefano Sabatini committed
1395
@example
Luca Barbato's avatar
Luca Barbato committed
1396
avconv -i in.avi -vf "hflip" out.avi
Stefano Sabatini's avatar
Stefano Sabatini committed
1397 1398
@end example

1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
@section hqdn3d

High precision/quality 3d denoise filter. This filter aims to reduce
image noise producing smooth images and making still images really
still. It should enhance compressibility.

It accepts the following optional parameters:

@table @option
@item luma_spatial
a non-negative float number which specifies spatial luma strength,
defaults to 4.0

@item chroma_spatial
a non-negative float number which specifies spatial chroma strength,
defaults to 3.0*@var{luma_spatial}/4.0

@item luma_tmp
a float number which specifies luma temporal strength, defaults to
6.0*@var{luma_spatial}/4.0

@item chroma_tmp
a float number which specifies chroma temporal strength, defaults to
@var{luma_tmp}*@var{chroma_spatial}/@var{luma_spatial}
@end table

Vittorio Giovara's avatar
Vittorio Giovara committed
1425 1426 1427 1428
@section interlace

Simple interlacing filter from progressive contents. This interleaves upper (or
lower) lines from odd frames with lower (or upper) lines from even frames,
1429 1430
halving the frame rate and preserving image height. A vertical lowpass filter
is always applied in order to avoid twitter effects and reduce moire patterns.
Vittorio Giovara's avatar
Vittorio Giovara committed
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451

@example
   Original        Original             New Frame
   Frame 'j'      Frame 'j+1'             (tff)
  ==========      ===========       ==================
    Line 0  -------------------->    Frame 'j' Line 0
    Line 1          Line 1  ---->   Frame 'j+1' Line 1
    Line 2 --------------------->    Frame 'j' Line 2
    Line 3          Line 3  ---->   Frame 'j+1' Line 3
     ...             ...                   ...
New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
@end example

It accepts the following optional parameters:

@table @option
@item scan
determines whether the interlaced frame is taken from the even (tff - default)
or odd (bff) lines of the progressive frame.
@end table

1452 1453 1454 1455 1456 1457 1458 1459
@section lut, lutrgb, lutyuv

Compute a look-up table for binding each pixel component input value
to an output value, and apply it to input video.

@var{lutyuv} applies a lookup table to a YUV input video, @var{lutrgb}
to an RGB input video.

1460
These filters accept the following options:
1461
@table @option
1462 1463 1464 1465
@item @var{c0} (first  pixel component)
@item @var{c1} (second pixel component)
@item @var{c2} (third  pixel component)
@item @var{c3} (fourth pixel component, corresponds to the alpha component)
1466

1467 1468 1469 1470
@item @var{r} (red component)
@item @var{g} (green component)
@item @var{b} (blue component)
@item @var{a} (alpha component)
1471

1472 1473 1474
@item @var{y} (Y/luminance component)
@item @var{u} (U/Cb component)
@item @var{v} (V/Cr component)
1475 1476
@end table

1477 1478 1479 1480 1481 1482 1483 1484 1485
Each of them specifies the expression to use for computing the lookup table for
the corresponding pixel component values.

The exact component associated to each of the @var{c*} options depends on the
format in input.

The @var{lut} filter requires either YUV or RGB pixel formats in input,
@var{lutrgb} requires RGB pixel formats in input, and @var{lutyuv} requires YUV.

1486 1487 1488 1489 1490 1491 1492 1493
The expressions can contain the following constants and functions:

@table @option
@item E, PI, PHI
the corresponding mathematical approximated values for e
(euler number), pi (greek PI), PHI (golden ratio)

@item w, h
Diego Biurrun's avatar
Diego Biurrun committed
1494
the input width and height
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555

@item val
input value for the pixel component

@item clipval
the input value clipped in the @var{minval}-@var{maxval} range

@item maxval
maximum value for the pixel component

@item minval
minimum value for the pixel component

@item negval
the negated value for the pixel component value clipped in the
@var{minval}-@var{maxval} range , it corresponds to the expression
"maxval-clipval+minval"

@item clip(val)
the computed value in @var{val} clipped in the
@var{minval}-@var{maxval} range

@item gammaval(gamma)
the computed gamma correction value of the pixel component value
clipped in the @var{minval}-@var{maxval} range, corresponds to the
expression
"pow((clipval-minval)/(maxval-minval)\,@var{gamma})*(maxval-minval)+minval"

@end table

All expressions default to "val".

Some examples follow:
@example
# negate input video
lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"

# the above is the same as
lutrgb="r=negval:g=negval:b=negval"
lutyuv="y=negval:u=negval:v=negval"

# negate luminance
lutyuv=negval

# remove chroma components, turns the video into a graytone image
lutyuv="u=128:v=128"

# apply a luma burning effect
lutyuv="y=2*val"

# remove green and blue components
lutrgb="g=0:b=0"

# set a constant alpha channel value on input
format=rgba,lutrgb=a="maxval-minval/2"

# correct luminance gamma by a 0.5 factor
lutyuv=y=gammaval(0.5)
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1556 1557 1558 1559 1560 1561
@section negate

Negate input video.

This filter accepts an integer in input, if non-zero it negates the
alpha component (if available). The default value in input is 0.
1562

1563 1564
@section noformat

1565 1566 1567
Force libavfilter not to use any of the specified pixel formats for the
input to the next filter.

1568 1569 1570 1571 1572 1573 1574 1575
This filter accepts the following parameters:
@table @option

@item pix_fmts
A '|'-separated list of pixel format names, for example
"pix_fmts=yuv420p|monow|rgb24".

@end table
1576

1577
Some examples follow:
1578
@example
1579 1580
# force libavfilter to use a format different from "yuv420p" for the
# input to the vflip filter
1581
noformat=pix_fmts=yuv420p,vflip
1582

1583
# convert the input video to any of the formats not contained in the list
1584
noformat=yuv420p|yuv444p|yuv410p
1585
@end example
1586 1587