util: (Almost) universal format translation function.
[mesa.git] / src / gallium / auxiliary / util / u_format.c
1 /**************************************************************************
2 *
3 * Copyright 2010 VMware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 /**
29 * @file
30 * Pixel format accessor functions.
31 *
32 * @author Jose Fonseca <jfonseca@vmware.com>
33 */
34
35 #include "u_math.h"
36 #include "u_memory.h"
37 #include "u_rect.h"
38 #include "u_format.h"
39
40
41 void
42 util_format_read_4f(enum pipe_format format,
43 float *dst, unsigned dst_stride,
44 const void *src, unsigned src_stride,
45 unsigned x, unsigned y, unsigned w, unsigned h)
46 {
47 const struct util_format_description *format_desc;
48 const uint8_t *src_row;
49 float *dst_row;
50
51 format_desc = util_format_description(format);
52
53 assert(x % format_desc->block.width == 0);
54 assert(y % format_desc->block.height == 0);
55
56 src_row = (const uint8_t *)src + y*src_stride + x*(format_desc->block.bits/8);
57 dst_row = dst;
58
59 format_desc->unpack_float(dst_row, dst_stride, src_row, src_stride, w, h);
60 }
61
62
63 void
64 util_format_write_4f(enum pipe_format format,
65 const float *src, unsigned src_stride,
66 void *dst, unsigned dst_stride,
67 unsigned x, unsigned y, unsigned w, unsigned h)
68 {
69 const struct util_format_description *format_desc;
70 uint8_t *dst_row;
71 const float *src_row;
72
73 format_desc = util_format_description(format);
74
75 assert(x % format_desc->block.width == 0);
76 assert(y % format_desc->block.height == 0);
77
78 dst_row = (uint8_t *)dst + y*dst_stride + x*(format_desc->block.bits/8);
79 src_row = src;
80
81 format_desc->pack_float(dst_row, dst_stride, src_row, src_stride, w, h);
82 }
83
84
85 void
86 util_format_read_4ub(enum pipe_format format, uint8_t *dst, unsigned dst_stride, const void *src, unsigned src_stride, unsigned x, unsigned y, unsigned w, unsigned h)
87 {
88 const struct util_format_description *format_desc;
89 const uint8_t *src_row;
90 uint8_t *dst_row;
91
92 format_desc = util_format_description(format);
93
94 assert(x % format_desc->block.width == 0);
95 assert(y % format_desc->block.height == 0);
96
97 src_row = (const uint8_t *)src + y*src_stride + x*(format_desc->block.bits/8);
98 dst_row = dst;
99
100 format_desc->unpack_8unorm(dst_row, dst_stride, src_row, src_stride, w, h);
101 }
102
103
104 void
105 util_format_write_4ub(enum pipe_format format, const uint8_t *src, unsigned src_stride, void *dst, unsigned dst_stride, unsigned x, unsigned y, unsigned w, unsigned h)
106 {
107 const struct util_format_description *format_desc;
108 uint8_t *dst_row;
109 const uint8_t *src_row;
110
111 format_desc = util_format_description(format);
112
113 assert(x % format_desc->block.width == 0);
114 assert(y % format_desc->block.height == 0);
115
116 dst_row = (uint8_t *)dst + y*dst_stride + x*(format_desc->block.bits/8);
117 src_row = src;
118
119 format_desc->pack_8unorm(dst_row, dst_stride, src_row, src_stride, w, h);
120 }
121
122
123 static INLINE boolean
124 util_format_fits_8unorm(const struct util_format_description *format_desc)
125 {
126 unsigned chan;
127
128 switch (format_desc->layout) {
129
130 case UTIL_FORMAT_LAYOUT_S3TC:
131 case UTIL_FORMAT_LAYOUT_RGTC:
132 /*
133 * These are straight forward.
134 */
135
136 return TRUE;
137
138 case UTIL_FORMAT_LAYOUT_PLAIN:
139 /*
140 * For these we can find a generic rule.
141 */
142
143 for (chan = 0; chan < format_desc->nr_channels; ++chan) {
144 switch (format_desc->channel[chan].type) {
145 case UTIL_FORMAT_TYPE_VOID:
146 break;
147 case UTIL_FORMAT_TYPE_UNSIGNED:
148 if (!format_desc->channel[chan].normalized ||
149 format_desc->channel[chan].size > 8) {
150 return FALSE;
151 }
152 default:
153 return FALSE;
154 }
155 }
156 return TRUE;
157
158 default:
159 /*
160 * Handle all others on a case by case basis.
161 */
162
163 switch (format_desc->format) {
164 case PIPE_FORMAT_R1_UNORM:
165 case PIPE_FORMAT_UYVY:
166 case PIPE_FORMAT_YUYV:
167 case PIPE_FORMAT_R8G8_B8G8_UNORM:
168 case PIPE_FORMAT_G8R8_G8B8_UNORM:
169 return TRUE;
170
171 default:
172 return FALSE;
173 }
174 }
175 }
176
177
178 void
179 util_format_translate(enum pipe_format dst_format,
180 void *dst, unsigned dst_stride,
181 unsigned dst_x, unsigned dst_y,
182 enum pipe_format src_format,
183 const void *src, unsigned src_stride,
184 unsigned src_x, unsigned src_y,
185 unsigned width, unsigned height)
186 {
187 const struct util_format_description *dst_format_desc;
188 const struct util_format_description *src_format_desc;
189 uint8_t *dst_row;
190 const uint8_t *src_row;
191 unsigned y_step;
192 unsigned dst_step;
193 unsigned src_step;
194
195 if (dst_format == src_format) {
196 /*
197 * Trivial case.
198 */
199
200 util_copy_rect(dst, dst_format, dst_stride, dst_x, dst_y,
201 width, height, src, (int)src_stride,
202 src_x, src_y);
203 return;
204 }
205
206 dst_format_desc = util_format_description(dst_format);
207 src_format_desc = util_format_description(src_format);
208
209 assert(dst_x % dst_format_desc->block.width == 0);
210 assert(dst_y % dst_format_desc->block.height == 0);
211 assert(src_x % src_format_desc->block.width == 0);
212 assert(src_y % src_format_desc->block.height == 0);
213
214 dst_row = (uint8_t *)dst + dst_y*dst_stride + dst_x*(dst_format_desc->block.bits/8);
215 src_row = (const uint8_t *)src + src_y*src_stride + src_x*(src_format_desc->block.bits/8);
216
217 /*
218 * This works because all pixel formats have pixel blocks with power of two
219 * sizes.
220 */
221
222 y_step = MAX2(dst_format_desc->block.height, src_format_desc->block.height);
223 assert(y_step % dst_format_desc->block.height == 0);
224 assert(y_step % src_format_desc->block.height == 0);
225
226 dst_step = y_step / dst_format_desc->block.height * dst_stride;
227 src_step = y_step / src_format_desc->block.height * src_stride;
228
229 /*
230 * TODO: double formats will loose precision
231 * TODO: Add a special case for formats that are mere swizzles of each other
232 */
233
234 if (util_format_fits_8unorm(src_format_desc) ||
235 util_format_fits_8unorm(dst_format_desc)) {
236 unsigned tmp_stride;
237 uint8_t *tmp_row;
238
239 tmp_stride = width * 4 * sizeof *tmp_row;
240 tmp_row = MALLOC(y_step * tmp_stride);
241 if (!tmp_row)
242 return;
243
244 while (height >= y_step) {
245 src_format_desc->unpack_8unorm(tmp_row, tmp_stride, src_row, src_stride, width, y_step);
246 dst_format_desc->pack_8unorm(dst_row, dst_stride, tmp_row, tmp_stride, width, y_step);
247
248 dst_row += dst_step;
249 src_row += src_step;
250 height -= y_step;
251 }
252
253 if (height) {
254 src_format_desc->unpack_8unorm(tmp_row, tmp_stride, src_row, src_stride, width, height);
255 dst_format_desc->pack_8unorm(dst_row, dst_stride, tmp_row, tmp_stride, width, height);
256 }
257
258 FREE(tmp_row);
259 }
260 else {
261 unsigned tmp_stride;
262 float *tmp_row;
263
264 tmp_stride = width * 4 * sizeof *tmp_row;
265 tmp_row = MALLOC(y_step * tmp_stride);
266 if (!tmp_row)
267 return;
268
269 while (height >= y_step) {
270 src_format_desc->unpack_float(tmp_row, tmp_stride, src_row, src_stride, width, y_step);
271 dst_format_desc->pack_float(dst_row, dst_stride, tmp_row, tmp_stride, width, y_step);
272
273 dst_row += dst_step;
274 src_row += src_step;
275 height -= y_step;
276 }
277
278 if (height) {
279 src_format_desc->unpack_float(tmp_row, tmp_stride, src_row, src_stride, width, height);
280 dst_format_desc->pack_float(dst_row, dst_stride, tmp_row, tmp_stride, width, height);
281 }
282
283 FREE(tmp_row);
284 }
285 }