doc/filters: add tmix examples
[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. Default
17 value is @samp{bicubic}.
18
19 It accepts the following values:
20 @table @samp
21 @item fast_bilinear
22 Select fast bilinear scaling algorithm.
23
24 @item bilinear
25 Select bilinear scaling algorithm.
26
27 @item bicubic
28 Select bicubic scaling algorithm.
29
30 @item experimental
31 Select experimental scaling algorithm.
32
33 @item neighbor
34 Select nearest neighbor rescaling algorithm.
35
36 @item area
37 Select averaging area rescaling algorithm.
38
39 @item bicublin
40 Select bicubic scaling algorithm for the luma component, bilinear for
41 chroma components.
42
43 @item gauss
44 Select Gaussian rescaling algorithm.
45
46 @item sinc
47 Select sinc rescaling algorithm.
48
49 @item lanczos
50 Select Lanczos rescaling algorithm.
51
52 @item spline
53 Select natural bicubic spline rescaling algorithm.
54
55 @item print_info
56 Enable printing/debug logging.
57
58 @item accurate_rnd
59 Enable accurate rounding.
60
61 @item full_chroma_int
62 Enable full chroma interpolation.
63
64 @item full_chroma_inp
65 Select full chroma input.
66
67 @item bitexact
68 Enable bitexact output.
69 @end table
70
71 @item srcw
72 Set source width.
73
74 @item srch
75 Set source height.
76
77 @item dstw
78 Set destination width.
79
80 @item dsth
81 Set destination height.
82
83 @item src_format
84 Set source pixel format (must be expressed as an integer).
85
86 @item dst_format
87 Set destination pixel format (must be expressed as an integer).
88
89 @item src_range
90 Select source range.
91
92 @item dst_range
93 Select destination range.
94
95 @anchor{sws_params}
96 @item param0, param1
97 Set scaling algorithm parameters. The specified values are specific of
98 some scaling algorithms and ignored by others. The specified values
99 are floating point number values.
100
101 @item sws_dither
102 Set the dithering algorithm. Accepts one of the following
103 values. Default value is @samp{auto}.
104
105 @table @samp
106 @item auto
107 automatic choice
108
109 @item none
110 no dithering
111
112 @item bayer
113 bayer dither
114
115 @item ed
116 error diffusion dither
117
118 @item a_dither
119 arithmetic dither, based using addition
120
121 @item x_dither
122 arithmetic dither, based using xor (more random/less apparent patterning that
123 a_dither).
124
125 @end table
126
127 @item alphablend
128 Set the alpha blending to use when the input has alpha but the output does not.
129 Default value is @samp{none}.
130
131 @table @samp
132 @item uniform_color
133 Blend onto a uniform background color
134
135 @item checkerboard
136 Blend onto a checkerboard
137
138 @item none
139 No blending
140
141 @end table
142
143 @end table
144
145 @c man end SCALER OPTIONS