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