scaler.texi 3.19 KB
Newer Older
1
@anchor{scaler_options}
2 3 4 5 6 7
@chapter Scaler Options
@c man begin SCALER OPTIONS

The video scaler supports the following named options.

Options may be set by specifying -@var{option} @var{value} in the
8 9
FFmpeg tools, with a few API-only exceptions noted below.
For programmatic use, they can be set explicitly in the
10 11 12 13
@code{SwsContext} options or through the @file{libavutil/opt.h} API.

@table @option

14
@anchor{sws_flags}
15 16
@item sws_flags
Set the scaler flags. This is also used to set the scaling
17 18
algorithm. Only a single algorithm should be selected. Default
value is @samp{bicubic}.
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

It accepts the following values:
@table @samp
@item fast_bilinear
Select fast bilinear scaling algorithm.

@item bilinear
Select bilinear scaling algorithm.

@item bicubic
Select bicubic scaling algorithm.

@item experimental
Select experimental scaling algorithm.

@item neighbor
Select nearest neighbor rescaling algorithm.

@item area
Select averaging area rescaling algorithm.

40
@item bicublin
41 42 43 44 45 46 47 48 49 50
Select bicubic scaling algorithm for the luma component, bilinear for
chroma components.

@item gauss
Select Gaussian rescaling algorithm.

@item sinc
Select sinc rescaling algorithm.

@item lanczos
51 52
Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be
changed by setting @code{param0}.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

@item spline
Select natural bicubic spline rescaling algorithm.

@item print_info
Enable printing/debug logging.

@item accurate_rnd
Enable accurate rounding.

@item full_chroma_int
Enable full chroma interpolation.

@item full_chroma_inp
Select full chroma input.

@item bitexact
Enable bitexact output.
@end table

73
@item srcw @var{(API only)}
74 75
Set source width.

76
@item srch @var{(API only)}
77 78
Set source height.

79
@item dstw @var{(API only)}
80 81
Set destination width.

82
@item dsth @var{(API only)}
83 84
Set destination height.

85
@item src_format @var{(API only)}
86 87
Set source pixel format (must be expressed as an integer).

88
@item dst_format @var{(API only)}
89 90
Set destination pixel format (must be expressed as an integer).

91 92 93
@item src_range @var{(boolean)}
If value is set to @code{1}, indicates source is full range. Default value is
@code{0}, which indicates source is limited range.
94

95 96 97
@item dst_range @var{(boolean)}
If value is set to @code{1}, enable full range for destination. Default value
is @code{0}, which enables limited range.
98

99
@anchor{sws_params}
100 101 102 103 104
@item param0, param1
Set scaling algorithm parameters. The specified values are specific of
some scaling algorithms and ignored by others. The specified values
are floating point number values.

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
@item sws_dither
Set the dithering algorithm. Accepts one of the following
values. Default value is @samp{auto}.

@table @samp
@item auto
automatic choice

@item none
no dithering

@item bayer
bayer dither

@item ed
error diffusion dither
121 122 123 124 125 126 127 128

@item a_dither
arithmetic dither, based using addition

@item x_dither
arithmetic dither, based using xor (more random/less apparent patterning that
a_dither).

129 130
@end table

131 132 133 134 135 136 137 138
@item alphablend
Set the alpha blending to use when the input has alpha but the output does not.
Default value is @samp{none}.

@table @samp
@item uniform_color
Blend onto a uniform background color

139 140 141
@item checkerboard
Blend onto a checkerboard

142 143 144 145 146
@item none
No blending

@end table

147 148 149
@end table

@c man end SCALER OPTIONS