Merge commit '64034849dad8410bedbe1def4c533490fb85cc4a'
[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 @item param0, param1
95 Set scaling algorithm parameters. The specified values are specific of
96 some scaling algorithms and ignored by others. The specified values
97 are floating point number values.
98
99 @item sws_dither
100 Set the dithering algorithm. Accepts one of the following
101 values. Default value is @samp{auto}.
102
103 @table @samp
104 @item auto
105 automatic choice
106
107 @item none
108 no dithering
109
110 @item bayer
111 bayer dither
112
113 @item ed
114 error diffusion dither
115
116 @item a_dither
117 arithmetic dither, based using addition
118
119 @item x_dither
120 arithmetic dither, based using xor (more random/less apparent patterning that
121 a_dither).
122
123 @end table
124
125 @item alphablend
126 Set the alpha blending to use when the input has alpha but the output does not.
127 Default value is @samp{none}.
128
129 @table @samp
130 @item uniform_color
131 Blend onto a uniform background color
132
133 @item checkerboard
134 Blend onto a checkerboard
135
136 @item none
137 No blending
138
139 @end table
140
141 @end table
142
143 @c man end SCALER OPTIONS