mesa: Add a rebase_swizzle parameter to _mesa_format_convert
[mesa.git] / src / mesa / main / format_utils.h
1 /**
2 * \file format_utils.h
3 * A collection of format conversion utility functions.
4 */
5
6 /*
7 * Mesa 3-D graphics library
8 *
9 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
10 * Copyright (C) 2014 Intel Corporation All Rights Reserved.
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28 * OTHER DEALINGS IN THE SOFTWARE.
29 */
30
31 #ifndef FORMAT_UTILS_H
32 #define FORMAT_UTILS_H
33
34 #include "imports.h"
35 #include "macros.h"
36
37 extern const mesa_array_format RGBA8888_FLOAT;
38 extern const mesa_array_format RGBA8888_UBYTE;
39 extern const mesa_array_format RGBA8888_UINT;
40 extern const mesa_array_format RGBA8888_INT;
41
42 /* Only guaranteed to work for BITS <= 32 */
43 #define MAX_UINT(BITS) ((BITS) == 32 ? UINT32_MAX : ((1u << (BITS)) - 1))
44 #define MAX_INT(BITS) ((int)MAX_UINT((BITS) - 1))
45 #define MIN_INT(BITS) ((BITS) == 32 ? INT32_MIN : (-(1 << (BITS - 1))))
46
47 /* Extends an integer of size SRC_BITS to one of size DST_BITS linearly */
48 #define EXTEND_NORMALIZED_INT(X, SRC_BITS, DST_BITS) \
49 (((X) * (int)(MAX_UINT(DST_BITS) / MAX_UINT(SRC_BITS))) + \
50 ((DST_BITS % SRC_BITS) ? ((X) >> (SRC_BITS - DST_BITS % SRC_BITS)) : 0))
51
52 static inline float
53 _mesa_unorm_to_float(unsigned x, unsigned src_bits)
54 {
55 return x * (1.0f / (float)MAX_UINT(src_bits));
56 }
57
58 static inline float
59 _mesa_snorm_to_float(int x, unsigned src_bits)
60 {
61 if (x <= -MAX_INT(src_bits))
62 return -1.0f;
63 else
64 return x * (1.0f / (float)MAX_INT(src_bits));
65 }
66
67 static inline uint16_t
68 _mesa_unorm_to_half(unsigned x, unsigned src_bits)
69 {
70 return _mesa_float_to_half(_mesa_unorm_to_float(x, src_bits));
71 }
72
73 static inline uint16_t
74 _mesa_snorm_to_half(int x, unsigned src_bits)
75 {
76 return _mesa_float_to_half(_mesa_snorm_to_float(x, src_bits));
77 }
78
79 static inline unsigned
80 _mesa_float_to_unorm(float x, unsigned dst_bits)
81 {
82 if (x < 0.0f)
83 return 0;
84 else if (x > 1.0f)
85 return MAX_UINT(dst_bits);
86 else
87 return F_TO_I(x * MAX_UINT(dst_bits));
88 }
89
90 static inline unsigned
91 _mesa_half_to_unorm(uint16_t x, unsigned dst_bits)
92 {
93 return _mesa_float_to_unorm(_mesa_half_to_float(x), dst_bits);
94 }
95
96 static inline unsigned
97 _mesa_unorm_to_unorm(unsigned x, unsigned src_bits, unsigned dst_bits)
98 {
99 if (src_bits < dst_bits)
100 return EXTEND_NORMALIZED_INT(x, src_bits, dst_bits);
101 else
102 return x >> (src_bits - dst_bits);
103 }
104
105 static inline unsigned
106 _mesa_snorm_to_unorm(int x, unsigned src_bits, unsigned dst_bits)
107 {
108 if (x < 0)
109 return 0;
110 else
111 return _mesa_unorm_to_unorm(x, src_bits - 1, dst_bits);
112 }
113
114 static inline int
115 _mesa_float_to_snorm(float x, unsigned dst_bits)
116 {
117 if (x < -1.0f)
118 return -MAX_INT(dst_bits);
119 else if (x > 1.0f)
120 return MAX_INT(dst_bits);
121 else
122 return F_TO_I(x * MAX_INT(dst_bits));
123 }
124
125 static inline int
126 _mesa_half_to_snorm(uint16_t x, unsigned dst_bits)
127 {
128 return _mesa_float_to_snorm(_mesa_half_to_float(x), dst_bits);
129 }
130
131 static inline int
132 _mesa_unorm_to_snorm(unsigned x, unsigned src_bits, unsigned dst_bits)
133 {
134 return _mesa_unorm_to_unorm(x, src_bits, dst_bits - 1);
135 }
136
137 static inline int
138 _mesa_snorm_to_snorm(int x, unsigned src_bits, unsigned dst_bits)
139 {
140 if (x < -MAX_INT(src_bits))
141 return -MAX_INT(dst_bits);
142 else if (src_bits < dst_bits)
143 return EXTEND_NORMALIZED_INT(x, src_bits - 1, dst_bits - 1);
144 else
145 return x >> (src_bits - dst_bits);
146 }
147
148 static inline unsigned
149 _mesa_unsigned_to_unsigned(unsigned src, unsigned dst_size)
150 {
151 return MIN2(src, MAX_UINT(dst_size));
152 }
153
154 static inline int
155 _mesa_unsigned_to_signed(unsigned src, unsigned dst_size)
156 {
157 return MIN2(src, MAX_INT(dst_size));
158 }
159
160 static inline int
161 _mesa_signed_to_signed(int src, unsigned dst_size)
162 {
163 return CLAMP(src, MIN_INT(dst_size), MAX_INT(dst_size));
164 }
165
166 static inline unsigned
167 _mesa_signed_to_unsigned(int src, unsigned dst_size)
168 {
169 return CLAMP(src, 0, MAX_UINT(dst_size));
170 }
171
172 static inline unsigned
173 _mesa_float_to_unsigned(float src, unsigned dst_bits)
174 {
175 if (src < 0.0f)
176 return 0;
177 if (src > (float)MAX_UINT(dst_bits))
178 return MAX_UINT(dst_bits);
179 return _mesa_signed_to_unsigned(src, dst_bits);
180 }
181
182 static inline unsigned
183 _mesa_float_to_signed(float src, unsigned dst_bits)
184 {
185 if (src < (float)(-MAX_INT(dst_bits)))
186 return -MAX_INT(dst_bits);
187 if (src > (float)MAX_INT(dst_bits))
188 return MAX_INT(dst_bits);
189 return _mesa_signed_to_signed(src, dst_bits);
190 }
191
192 static inline unsigned
193 _mesa_half_to_unsigned(uint16_t src, unsigned dst_bits)
194 {
195 if (_mesa_half_is_negative(src))
196 return 0;
197 return _mesa_unsigned_to_unsigned(_mesa_float_to_half(src), dst_bits);
198 }
199
200 static inline unsigned
201 _mesa_half_to_signed(uint16_t src, unsigned dst_bits)
202 {
203 return _mesa_float_to_signed(_mesa_half_to_float(src), dst_bits);
204 }
205
206 bool
207 _mesa_format_to_array(mesa_format, GLenum *type, int *num_components,
208 uint8_t swizzle[4], bool *normalized);
209
210 void
211 _mesa_swizzle_and_convert(void *dst, GLenum dst_type, int num_dst_channels,
212 const void *src, GLenum src_type, int num_src_channels,
213 const uint8_t swizzle[4], bool normalized, int count);
214
215 void
216 _mesa_format_convert(void *void_dst, uint32_t dst_format, size_t dst_stride,
217 void *void_src, uint32_t src_format, size_t src_stride,
218 size_t width, size_t height, uint8_t *rebase_swizzle);
219
220 #endif