swrast: use macros to initialize texfetch_funcs[] table
[mesa.git] / src / mesa / swrast / s_texfetch.c
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * Copyright (c) 2009 VMware, Inc.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26
27 /**
28 * \file s_texfetch.c
29 *
30 * Texel fetch/store functions
31 *
32 * \author Gareth Hughes
33 */
34
35
36 #include "main/colormac.h"
37 #include "main/macros.h"
38 #include "main/texcompress.h"
39 #include "main/texcompress_fxt1.h"
40 #include "main/texcompress_s3tc.h"
41 #include "main/texcompress_rgtc.h"
42 #include "main/texcompress_etc.h"
43 #include "main/teximage.h"
44 #include "main/samplerobj.h"
45 #include "s_context.h"
46 #include "s_texfetch.h"
47 #include "../../gallium/auxiliary/util/u_format_rgb9e5.h"
48 #include "../../gallium/auxiliary/util/u_format_r11g11b10f.h"
49
50
51 /**
52 * Convert an 8-bit sRGB value from non-linear space to a
53 * linear RGB value in [0, 1].
54 * Implemented with a 256-entry lookup table.
55 */
56 static inline GLfloat
57 nonlinear_to_linear(GLubyte cs8)
58 {
59 static GLfloat table[256];
60 static GLboolean tableReady = GL_FALSE;
61 if (!tableReady) {
62 /* compute lookup table now */
63 GLuint i;
64 for (i = 0; i < 256; i++) {
65 const GLfloat cs = UBYTE_TO_FLOAT(i);
66 if (cs <= 0.04045) {
67 table[i] = cs / 12.92f;
68 }
69 else {
70 table[i] = (GLfloat) pow((cs + 0.055) / 1.055, 2.4);
71 }
72 }
73 tableReady = GL_TRUE;
74 }
75 return table[cs8];
76 }
77
78
79
80 /* Texel fetch routines for all supported formats
81 */
82 #define DIM 1
83 #include "s_texfetch_tmp.h"
84
85 #define DIM 2
86 #include "s_texfetch_tmp.h"
87
88 #define DIM 3
89 #include "s_texfetch_tmp.h"
90
91
92 /**
93 * All compressed texture texel fetching is done though this function.
94 * Basically just call a core-Mesa texel fetch function.
95 */
96 static void
97 fetch_compressed(const struct swrast_texture_image *swImage,
98 GLint i, GLint j, GLint k, GLfloat *texel)
99 {
100 /* The FetchCompressedTexel function takes an integer pixel rowstride,
101 * while the image's rowstride is bytes per row of blocks.
102 */
103 GLuint bw, bh;
104 GLuint texelBytes = _mesa_get_format_bytes(swImage->Base.TexFormat);
105 _mesa_get_format_block_size(swImage->Base.TexFormat, &bw, &bh);
106 assert(swImage->RowStride * bw % texelBytes == 0);
107
108 swImage->FetchCompressedTexel(swImage->ImageSlices[k],
109 swImage->RowStride * bw / texelBytes,
110 i, j, texel);
111 }
112
113
114
115 /**
116 * Null texel fetch function.
117 *
118 * Have to have this so the FetchTexel function pointer is never NULL.
119 */
120 static void fetch_null_texelf( const struct swrast_texture_image *texImage,
121 GLint i, GLint j, GLint k, GLfloat *texel )
122 {
123 (void) texImage; (void) i; (void) j; (void) k;
124 texel[RCOMP] = 0.0;
125 texel[GCOMP] = 0.0;
126 texel[BCOMP] = 0.0;
127 texel[ACOMP] = 0.0;
128 _mesa_warning(NULL, "fetch_null_texelf() called!");
129 }
130
131
132 #define FETCH_FUNCS(NAME) \
133 { \
134 MESA_FORMAT_ ## NAME, \
135 fetch_texel_1d_ ## NAME, \
136 fetch_texel_2d_ ## NAME, \
137 fetch_texel_3d_ ## NAME, \
138 }
139
140 #define FETCH_NULL(NAME) \
141 { \
142 MESA_FORMAT_ ## NAME, \
143 NULL, \
144 NULL, \
145 NULL \
146 }
147
148 /**
149 * Table to map MESA_FORMAT_ to texel fetch/store funcs.
150 */
151 static struct {
152 mesa_format Name;
153 FetchTexelFunc Fetch1D;
154 FetchTexelFunc Fetch2D;
155 FetchTexelFunc Fetch3D;
156 }
157 texfetch_funcs[] =
158 {
159 {
160 MESA_FORMAT_NONE,
161 fetch_null_texelf,
162 fetch_null_texelf,
163 fetch_null_texelf
164 },
165
166 /* Packed unorm formats */
167 FETCH_FUNCS(A8B8G8R8_UNORM),
168 FETCH_FUNCS(X8B8G8R8_UNORM),
169 FETCH_FUNCS(R8G8B8A8_UNORM),
170 FETCH_FUNCS(R8G8B8X8_UNORM),
171 FETCH_FUNCS(B8G8R8A8_UNORM),
172 FETCH_FUNCS(B8G8R8X8_UNORM),
173 FETCH_FUNCS(A8R8G8B8_UNORM),
174 FETCH_FUNCS(X8R8G8B8_UNORM),
175 FETCH_FUNCS(L16A16_UNORM),
176 FETCH_FUNCS(A16L16_UNORM),
177 FETCH_FUNCS(B5G6R5_UNORM),
178 FETCH_FUNCS(R5G6B5_UNORM),
179 FETCH_FUNCS(B4G4R4A4_UNORM),
180 FETCH_NULL(B4G4R4X4_UNORM),
181 FETCH_FUNCS(A4R4G4B4_UNORM),
182 FETCH_FUNCS(A1B5G5R5_UNORM),
183 FETCH_FUNCS(B5G5R5A1_UNORM),
184 FETCH_NULL(B5G5R5X1_UNORM),
185 FETCH_FUNCS(A1R5G5B5_UNORM),
186 FETCH_FUNCS(L8A8_UNORM),
187 FETCH_FUNCS(A8L8_UNORM),
188 FETCH_FUNCS(R8G8_UNORM),
189 FETCH_FUNCS(G8R8_UNORM),
190 FETCH_FUNCS(L4A4_UNORM),
191 FETCH_FUNCS(B2G3R3_UNORM),
192 FETCH_FUNCS(R16G16_UNORM),
193 FETCH_FUNCS(G16R16_UNORM),
194 FETCH_FUNCS(B10G10R10A2_UNORM),
195 FETCH_NULL(B10G10R10X2_UNORM),
196 FETCH_FUNCS(R10G10B10A2_UNORM),
197 FETCH_FUNCS(S8_UINT_Z24_UNORM),
198 {
199 MESA_FORMAT_X8_UINT_Z24_UNORM,
200 fetch_texel_1d_S8_UINT_Z24_UNORM,
201 fetch_texel_2d_S8_UINT_Z24_UNORM,
202 fetch_texel_3d_S8_UINT_Z24_UNORM
203 },
204 FETCH_FUNCS(Z24_UNORM_S8_UINT),
205 {
206 MESA_FORMAT_Z24_UNORM_X8_UINT,
207 fetch_texel_1d_Z24_UNORM_S8_UINT,
208 fetch_texel_2d_Z24_UNORM_S8_UINT,
209 fetch_texel_3d_Z24_UNORM_S8_UINT
210 },
211 FETCH_FUNCS(YCBCR),
212 FETCH_FUNCS(YCBCR_REV),
213 FETCH_FUNCS(DUDV8),
214
215 /* Array unorm formats */
216 FETCH_FUNCS(A_UNORM8),
217 FETCH_FUNCS(A_UNORM16),
218 FETCH_FUNCS(L_UNORM8),
219 FETCH_FUNCS(L_UNORM16),
220 FETCH_FUNCS(I_UNORM8),
221 FETCH_FUNCS(I_UNORM16),
222 FETCH_FUNCS(R_UNORM8),
223 FETCH_FUNCS(R_UNORM16),
224 FETCH_FUNCS(BGR_UNORM8),
225 FETCH_FUNCS(RGB_UNORM8),
226 FETCH_FUNCS(RGBA_UNORM16),
227 FETCH_FUNCS(RGBX_UNORM16),
228 FETCH_FUNCS(Z_UNORM16),
229 FETCH_FUNCS(Z_UNORM32),
230 FETCH_NULL(S_UINT8),
231
232 /* Packed signed/normalized formats */
233 FETCH_FUNCS(A8B8G8R8_SNORM),
234 FETCH_FUNCS(X8B8G8R8_SNORM),
235 FETCH_FUNCS(R8G8B8A8_SNORM),
236 FETCH_NULL(R8G8B8X8_SNORM),
237 FETCH_FUNCS(R16G16_SNORM),
238 FETCH_NULL(G16R16_SNORM),
239 FETCH_FUNCS(R8G8_SNORM),
240 FETCH_NULL(G8R8_SNORM),
241 FETCH_FUNCS(L8A8_SNORM),
242
243 /* Array signed/normalized formats */
244 FETCH_FUNCS(A_SNORM8),
245 FETCH_FUNCS(A_SNORM16),
246 FETCH_FUNCS(L_SNORM8),
247 FETCH_FUNCS(L_SNORM16),
248 FETCH_FUNCS(I_SNORM8),
249 FETCH_FUNCS(I_SNORM16),
250 FETCH_FUNCS(R_SNORM8),
251 FETCH_FUNCS(R_SNORM16),
252 FETCH_FUNCS(LA_SNORM16),
253 FETCH_FUNCS(RGB_SNORM16),
254 FETCH_FUNCS(RGBA_SNORM16),
255 FETCH_NULL(RGBX_SNORM16),
256
257 /* Packed sRGB formats */
258 FETCH_FUNCS(A8B8G8R8_SRGB),
259 FETCH_FUNCS(B8G8R8A8_SRGB),
260 FETCH_NULL(B8G8R8X8_SRGB),
261 FETCH_FUNCS(R8G8B8A8_SRGB),
262 FETCH_FUNCS(R8G8B8X8_SRGB),
263 FETCH_FUNCS(L8A8_SRGB),
264
265 /* Array sRGB formats */
266 FETCH_FUNCS(L_SRGB8),
267 FETCH_FUNCS(BGR_SRGB8),
268
269 /* Packed float formats */
270 FETCH_FUNCS(R9G9B9E5_FLOAT),
271 FETCH_FUNCS(R11G11B10_FLOAT),
272 FETCH_FUNCS(Z32_FLOAT_S8X24_UINT),
273
274 /* Array float formats */
275 FETCH_FUNCS(A_FLOAT16),
276 FETCH_FUNCS(A_FLOAT32),
277 FETCH_FUNCS(L_FLOAT16),
278 FETCH_FUNCS(L_FLOAT32),
279 FETCH_FUNCS(LA_FLOAT16),
280 FETCH_FUNCS(LA_FLOAT32),
281 FETCH_FUNCS(I_FLOAT16),
282 FETCH_FUNCS(I_FLOAT32),
283 FETCH_FUNCS(R_FLOAT16),
284 FETCH_FUNCS(R_FLOAT32),
285 FETCH_FUNCS(RG_FLOAT16),
286 FETCH_FUNCS(RG_FLOAT32),
287 FETCH_FUNCS(RGB_FLOAT16),
288 FETCH_FUNCS(RGB_FLOAT32),
289 FETCH_FUNCS(RGBA_FLOAT16),
290 FETCH_FUNCS(RGBA_FLOAT32),
291 FETCH_FUNCS(RGBX_FLOAT16),
292 FETCH_FUNCS(RGBX_FLOAT32),
293 {
294 MESA_FORMAT_Z_FLOAT32,
295 fetch_texel_1d_R_FLOAT32, /* Reuse the R32F functions. */
296 fetch_texel_2d_R_FLOAT32,
297 fetch_texel_3d_R_FLOAT32
298 },
299
300 /* Packed signed/unsigned non-normalized integer formats */
301 FETCH_NULL(B10G10R10A2_UINT),
302 FETCH_NULL(R10G10B10A2_UINT),
303
304 /* Array signed/unsigned non-normalized integer formats */
305 FETCH_NULL(A_UINT8),
306 FETCH_NULL(A_UINT16),
307 FETCH_NULL(A_UINT32),
308 FETCH_NULL(A_SINT8),
309 FETCH_NULL(A_SINT16),
310 FETCH_NULL(A_SINT32),
311 FETCH_NULL(I_UINT8),
312 FETCH_NULL(I_UINT16),
313 FETCH_NULL(I_UINT32),
314 FETCH_NULL(I_SINT8),
315 FETCH_NULL(I_SINT16),
316 FETCH_NULL(I_SINT32),
317 FETCH_NULL(L_UINT8),
318 FETCH_NULL(L_UINT16),
319 FETCH_NULL(L_UINT32),
320 FETCH_NULL(L_SINT8),
321 FETCH_NULL(L_SINT16),
322 FETCH_NULL(L_SINT32),
323 FETCH_NULL(LA_UINT8),
324 FETCH_NULL(LA_UINT16),
325 FETCH_NULL(LA_UINT32),
326 FETCH_NULL(LA_SINT8),
327 FETCH_NULL(LA_SINT16),
328 FETCH_NULL(LA_SINT32),
329 FETCH_NULL(R_UINT8),
330 FETCH_NULL(R_UINT16),
331 FETCH_NULL(R_UINT32),
332 FETCH_NULL(R_SINT8),
333 FETCH_NULL(R_SINT16),
334 FETCH_NULL(R_SINT32),
335 FETCH_NULL(RG_UINT8),
336 FETCH_NULL(RG_UINT16),
337 FETCH_NULL(RG_UINT32),
338 FETCH_NULL(RG_SINT8),
339 FETCH_NULL(RG_SINT16),
340 FETCH_NULL(RG_SINT32),
341 FETCH_NULL(RGB_UINT8),
342 FETCH_NULL(RGB_UINT16),
343 FETCH_NULL(RGB_UINT32),
344 FETCH_NULL(RGB_SINT8),
345 FETCH_NULL(RGB_SINT16),
346 FETCH_NULL(RGB_SINT32),
347 FETCH_FUNCS(RGBA_UINT8),
348 FETCH_FUNCS(RGBA_UINT16),
349 FETCH_FUNCS(RGBA_UINT32),
350 FETCH_FUNCS(RGBA_SINT8),
351 FETCH_FUNCS(RGBA_SINT16),
352 FETCH_FUNCS(RGBA_SINT32),
353 FETCH_NULL(RGBX_UINT8),
354 FETCH_NULL(RGBX_UINT16),
355 FETCH_NULL(RGBX_UINT32),
356 FETCH_NULL(RGBX_SINT8),
357 FETCH_NULL(RGBX_SINT16),
358 FETCH_NULL(RGBX_SINT32),
359
360 /* DXT compressed formats */
361 {
362 MESA_FORMAT_RGB_DXT1,
363 fetch_compressed,
364 fetch_compressed,
365 fetch_compressed
366 },
367 {
368 MESA_FORMAT_RGBA_DXT1,
369 fetch_compressed,
370 fetch_compressed,
371 fetch_compressed
372 },
373 {
374 MESA_FORMAT_RGBA_DXT3,
375 fetch_compressed,
376 fetch_compressed,
377 fetch_compressed
378 },
379 {
380 MESA_FORMAT_RGBA_DXT5,
381 fetch_compressed,
382 fetch_compressed,
383 fetch_compressed
384 },
385
386 /* DXT sRGB compressed formats */
387 {
388 MESA_FORMAT_SRGB_DXT1,
389 fetch_compressed,
390 fetch_compressed,
391 fetch_compressed
392 },
393 {
394 MESA_FORMAT_SRGBA_DXT1,
395 fetch_compressed,
396 fetch_compressed,
397 fetch_compressed
398 },
399 {
400 MESA_FORMAT_SRGBA_DXT3,
401 fetch_compressed,
402 fetch_compressed,
403 fetch_compressed
404 },
405 {
406 MESA_FORMAT_SRGBA_DXT5,
407 fetch_compressed,
408 fetch_compressed,
409 fetch_compressed
410 },
411
412 /* FXT1 compressed formats */
413 {
414 MESA_FORMAT_RGB_FXT1,
415 fetch_compressed,
416 fetch_compressed,
417 fetch_compressed
418 },
419 {
420 MESA_FORMAT_RGBA_FXT1,
421 fetch_compressed,
422 fetch_compressed,
423 fetch_compressed
424 },
425
426 /* RGTC compressed formats */
427 {
428 MESA_FORMAT_R_RGTC1_UNORM,
429 fetch_compressed,
430 fetch_compressed,
431 fetch_compressed
432 },
433 {
434 MESA_FORMAT_R_RGTC1_SNORM,
435 fetch_compressed,
436 fetch_compressed,
437 fetch_compressed
438 },
439 {
440 MESA_FORMAT_RG_RGTC2_UNORM,
441 fetch_compressed,
442 fetch_compressed,
443 fetch_compressed
444 },
445 {
446 MESA_FORMAT_RG_RGTC2_SNORM,
447 fetch_compressed,
448 fetch_compressed,
449 fetch_compressed
450 },
451
452 /* LATC1/2 compressed formats */
453 {
454 MESA_FORMAT_L_LATC1_UNORM,
455 fetch_compressed,
456 fetch_compressed,
457 fetch_compressed
458 },
459 {
460 MESA_FORMAT_L_LATC1_SNORM,
461 fetch_compressed,
462 fetch_compressed,
463 fetch_compressed
464 },
465 {
466 MESA_FORMAT_LA_LATC2_UNORM,
467 fetch_compressed,
468 fetch_compressed,
469 fetch_compressed
470 },
471 {
472 MESA_FORMAT_LA_LATC2_SNORM,
473 fetch_compressed,
474 fetch_compressed,
475 fetch_compressed
476 },
477
478 /* ETC1/2 compressed formats */
479 {
480 MESA_FORMAT_ETC1_RGB8,
481 fetch_compressed,
482 fetch_compressed,
483 fetch_compressed
484 },
485 {
486 MESA_FORMAT_ETC2_RGB8,
487 fetch_compressed,
488 fetch_compressed,
489 fetch_compressed
490 },
491 {
492 MESA_FORMAT_ETC2_SRGB8,
493 fetch_compressed,
494 fetch_compressed,
495 fetch_compressed
496 },
497 {
498 MESA_FORMAT_ETC2_RGBA8_EAC,
499 fetch_compressed,
500 fetch_compressed,
501 fetch_compressed
502 },
503 {
504 MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
505 fetch_compressed,
506 fetch_compressed,
507 fetch_compressed
508 },
509 {
510 MESA_FORMAT_ETC2_R11_EAC,
511 fetch_compressed,
512 fetch_compressed,
513 fetch_compressed
514 },
515 {
516 MESA_FORMAT_ETC2_RG11_EAC,
517 fetch_compressed,
518 fetch_compressed,
519 fetch_compressed
520 },
521 {
522 MESA_FORMAT_ETC2_SIGNED_R11_EAC,
523 fetch_compressed,
524 fetch_compressed,
525 fetch_compressed
526 },
527 {
528 MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
529 fetch_compressed,
530 fetch_compressed,
531 fetch_compressed
532 },
533 {
534 MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
535 fetch_compressed,
536 fetch_compressed,
537 fetch_compressed
538 },
539 {
540 MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
541 fetch_compressed,
542 fetch_compressed,
543 fetch_compressed
544 }
545 };
546
547
548 /**
549 * Initialize the texture image's FetchTexel methods.
550 */
551 static void
552 set_fetch_functions(const struct gl_sampler_object *samp,
553 struct swrast_texture_image *texImage, GLuint dims)
554 {
555 mesa_format format = texImage->Base.TexFormat;
556
557 #ifdef DEBUG
558 /* check that the table entries are sorted by format name */
559 mesa_format fmt;
560 for (fmt = 0; fmt < MESA_FORMAT_COUNT; fmt++) {
561 assert(texfetch_funcs[fmt].Name == fmt);
562 }
563 #endif
564
565 STATIC_ASSERT(Elements(texfetch_funcs) == MESA_FORMAT_COUNT);
566
567 if (samp->sRGBDecode == GL_SKIP_DECODE_EXT &&
568 _mesa_get_format_color_encoding(format) == GL_SRGB) {
569 format = _mesa_get_srgb_format_linear(format);
570 }
571
572 assert(format < MESA_FORMAT_COUNT);
573
574 switch (dims) {
575 case 1:
576 texImage->FetchTexel = texfetch_funcs[format].Fetch1D;
577 break;
578 case 2:
579 texImage->FetchTexel = texfetch_funcs[format].Fetch2D;
580 break;
581 case 3:
582 texImage->FetchTexel = texfetch_funcs[format].Fetch3D;
583 break;
584 default:
585 assert(!"Bad dims in set_fetch_functions()");
586 }
587
588 texImage->FetchCompressedTexel = _mesa_get_compressed_fetch_func(format);
589
590 ASSERT(texImage->FetchTexel);
591 }
592
593 void
594 _mesa_update_fetch_functions(struct gl_context *ctx, GLuint unit)
595 {
596 struct gl_texture_object *texObj = ctx->Texture.Unit[unit]._Current;
597 struct gl_sampler_object *samp;
598 GLuint face, i;
599 GLuint dims;
600
601 if (!texObj)
602 return;
603
604 samp = _mesa_get_samplerobj(ctx, unit);
605
606 dims = _mesa_get_texture_dimensions(texObj->Target);
607
608 for (face = 0; face < 6; face++) {
609 for (i = 0; i < MAX_TEXTURE_LEVELS; i++) {
610 if (texObj->Image[face][i]) {
611 set_fetch_functions(samp,
612 swrast_texture_image(texObj->Image[face][i]),
613 dims);
614 }
615 }
616 }
617 }