Merge commit '936f0d98f864f9f6bb4f9e5458b78537e146bacd'
[ffmpeg.git] / doc / scaler.texi
1 @anchor{scaler_options}
2 @chapter Scaler Options
3 @c man begin SCALER OPTIONS
4
5 The video scaler supports the following named options.
6
7 Options may be set by specifying -@var{option} @var{value} in the
8 FFmpeg tools. For programmatic use, they can be set explicitly in the
9 @code{SwsContext} options or through the @file{libavutil/opt.h} API.
10
11 @table @option
12
13 @anchor{sws_flags}
14 @item sws_flags
15 Set the scaler flags. This is also used to set the scaling
16 algorithm. Only a single algorithm should be selected.
17
18 It accepts the following values:
19 @table @samp
20 @item fast_bilinear
21 Select fast bilinear scaling algorithm.
22
23 @item bilinear
24 Select bilinear scaling algorithm.
25
26 @item bicubic
27 Select bicubic scaling algorithm.
28
29 @item experimental
30 Select experimental scaling algorithm.
31
32 @item neighbor
33 Select nearest neighbor rescaling algorithm.
34
35 @item area
36 Select averaging area rescaling algorithm.
37
38 @item bicublin
39 Select bicubic scaling algorithm for the luma component, bilinear for
40 chroma components.
41
42 @item gauss
43 Select Gaussian rescaling algorithm.
44
45 @item sinc
46 Select sinc rescaling algorithm.
47
48 @item lanczos
49 Select Lanczos rescaling algorithm.
50
51 @item spline
52 Select natural bicubic spline rescaling algorithm.
53
54 @item print_info
55 Enable printing/debug logging.
56
57 @item accurate_rnd
58 Enable accurate rounding.
59
60 @item full_chroma_int
61 Enable full chroma interpolation.
62
63 @item full_chroma_inp
64 Select full chroma input.
65
66 @item bitexact
67 Enable bitexact output.
68 @end table
69
70 @item srcw
71 Set source width.
72
73 @item srch
74 Set source height.
75
76 @item dstw
77 Set destination width.
78
79 @item dsth
80 Set destination height.
81
82 @item src_format
83 Set source pixel format (must be expressed as an integer).
84
85 @item dst_format
86 Set destination pixel format (must be expressed as an integer).
87
88 @item src_range
89 Select source range.
90
91 @item dst_range
92 Select destination range.
93
94 @anchor{sws_params}
95 @item param0, param1
96 Set scaling algorithm parameters. The specified values are specific of
97 some scaling algorithms and ignored by others. The specified values
98 are floating point number values.
99
100 @item sws_dither
101 Set the dithering algorithm. Accepts one of the following
102 values. Default value is @samp{auto}.
103
104 @table @samp
105 @item auto
106 automatic choice
107
108 @item none
109 no dithering
110
111 @item bayer
112 bayer dither
113
114 @item ed
115 error diffusion dither
116
117 @item a_dither
118 arithmetic dither, based using addition
119
120 @item x_dither
121 arithmetic dither, based using xor (more random/less apparent patterning that
122 a_dither).
123
124 @end table
125
126 @item alphablend
127 Set the alpha blending to use when the input has alpha but the output does not.
128 Default value is @samp{none}.
129
130 @table @samp
131 @item uniform_color
132 Blend onto a uniform background color
133
134 @item checkerboard
135 Blend onto a checkerboard
136
137 @item none
138 No blending
139
140 @end table
141
142 @end table
143
144 @c man end SCALER OPTIONS