1 /*
2  * Mesa 3-D graphics library
3  *
4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
5  * Copyright (c) 2008-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 #include "errors.h"
28 
29 #include "formats.h"
30 #include "macros.h"
31 #include "glformats.h"
32 #include "c11/threads.h"
33 #include "util/hash_table.h"
34 
35 /**
36  * Information about texture formats.
37  */
38 struct mesa_format_info
39 {
40    mesa_format Name;
41 
42    /** text name for debugging */
43    const char *StrName;
44 
45    enum mesa_format_layout Layout;
46 
47    /**
48     * Base format is one of GL_RED, GL_RG, GL_RGB, GL_RGBA, GL_ALPHA,
49     * GL_LUMINANCE, GL_LUMINANCE_ALPHA, GL_INTENSITY, GL_YCBCR_MESA,
50     * GL_DEPTH_COMPONENT, GL_STENCIL_INDEX, GL_DEPTH_STENCIL.
51     */
52    GLenum BaseFormat;
53 
54    /**
55     * Logical data type: one of  GL_UNSIGNED_NORMALIZED, GL_SIGNED_NORMALIZED,
56     * GL_UNSIGNED_INT, GL_INT, GL_FLOAT.
57     */
58    GLenum DataType;
59 
60    uint8_t RedBits;
61    uint8_t GreenBits;
62    uint8_t BlueBits;
63    uint8_t AlphaBits;
64    uint8_t LuminanceBits;
65    uint8_t IntensityBits;
66    uint8_t DepthBits;
67    uint8_t StencilBits;
68 
69    bool IsSRGBFormat;
70 
71    /**
72     * To describe compressed formats.  If not compressed, Width=Height=Depth=1.
73     */
74    uint8_t BlockWidth, BlockHeight, BlockDepth;
75    uint8_t BytesPerBlock;
76 
77    uint8_t Swizzle[4];
78    mesa_array_format ArrayFormat;
79 };
80 
81 #include "format_info.h"
82 
83 static const struct mesa_format_info *
_mesa_get_format_info(mesa_format format)84 _mesa_get_format_info(mesa_format format)
85 {
86    const struct mesa_format_info *info = &format_info[format];
87    STATIC_ASSERT(ARRAY_SIZE(format_info) == MESA_FORMAT_COUNT);
88 
89    /* The MESA_FORMAT_* enums are sparse, don't return a format info
90     * for empty entries.
91     */
92    if (info->Name == MESA_FORMAT_NONE && format != MESA_FORMAT_NONE)
93       return NULL;
94 
95    assert(info->Name == format);
96    return info;
97 }
98 
99 
100 /** Return string name of format (for debugging) */
101 const char *
_mesa_get_format_name(mesa_format format)102 _mesa_get_format_name(mesa_format format)
103 {
104    const struct mesa_format_info *info = _mesa_get_format_info(format);
105    if (!info)
106       return NULL;
107    return info->StrName;
108 }
109 
110 
111 
112 /**
113  * Return bytes needed to store a block of pixels in the given format.
114  * Normally, a block is 1x1 (a single pixel).  But for compressed formats
115  * a block may be 4x4 or 8x4, etc.
116  *
117  * Note: return is signed, so as not to coerce math to unsigned. cf. fdo #37351
118  */
119 int
_mesa_get_format_bytes(mesa_format format)120 _mesa_get_format_bytes(mesa_format format)
121 {
122    if (_mesa_format_is_mesa_array_format(format)) {
123       return _mesa_array_format_get_type_size(format) *
124              _mesa_array_format_get_num_channels(format);
125    }
126 
127    const struct mesa_format_info *info = _mesa_get_format_info(format);
128    assert(info->BytesPerBlock);
129    assert(info->BytesPerBlock <= MAX_PIXEL_BYTES ||
130           _mesa_is_format_compressed(format));
131    return info->BytesPerBlock;
132 }
133 
134 
135 /**
136  * Return bits per component for the given format.
137  * \param format  one of MESA_FORMAT_x
138  * \param pname  the component, such as GL_RED_BITS, GL_TEXTURE_BLUE_BITS, etc.
139  */
140 GLint
_mesa_get_format_bits(mesa_format format,GLenum pname)141 _mesa_get_format_bits(mesa_format format, GLenum pname)
142 {
143    const struct mesa_format_info *info = _mesa_get_format_info(format);
144 
145    switch (pname) {
146    case GL_RED_BITS:
147    case GL_TEXTURE_RED_SIZE:
148    case GL_RENDERBUFFER_RED_SIZE_EXT:
149    case GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE:
150    case GL_INTERNALFORMAT_RED_SIZE:
151       return info->RedBits;
152    case GL_GREEN_BITS:
153    case GL_TEXTURE_GREEN_SIZE:
154    case GL_RENDERBUFFER_GREEN_SIZE_EXT:
155    case GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE:
156    case GL_INTERNALFORMAT_GREEN_SIZE:
157       return info->GreenBits;
158    case GL_BLUE_BITS:
159    case GL_TEXTURE_BLUE_SIZE:
160    case GL_RENDERBUFFER_BLUE_SIZE_EXT:
161    case GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE:
162    case GL_INTERNALFORMAT_BLUE_SIZE:
163       return info->BlueBits;
164    case GL_ALPHA_BITS:
165    case GL_TEXTURE_ALPHA_SIZE:
166    case GL_RENDERBUFFER_ALPHA_SIZE_EXT:
167    case GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE:
168    case GL_INTERNALFORMAT_ALPHA_SIZE:
169       return info->AlphaBits;
170    case GL_TEXTURE_INTENSITY_SIZE:
171       return info->IntensityBits;
172    case GL_TEXTURE_LUMINANCE_SIZE:
173       return info->LuminanceBits;
174    case GL_INDEX_BITS:
175       return 0;
176    case GL_DEPTH_BITS:
177    case GL_TEXTURE_DEPTH_SIZE_ARB:
178    case GL_RENDERBUFFER_DEPTH_SIZE_EXT:
179    case GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE:
180    case GL_INTERNALFORMAT_DEPTH_SIZE:
181       return info->DepthBits;
182    case GL_STENCIL_BITS:
183    case GL_TEXTURE_STENCIL_SIZE_EXT:
184    case GL_RENDERBUFFER_STENCIL_SIZE_EXT:
185    case GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE:
186    case GL_INTERNALFORMAT_STENCIL_SIZE:
187       return info->StencilBits;
188    default:
189       _mesa_problem(NULL, "bad pname in _mesa_get_format_bits()");
190       return 0;
191    }
192 }
193 
194 
195 unsigned int
_mesa_get_format_max_bits(mesa_format format)196 _mesa_get_format_max_bits(mesa_format format)
197 {
198    const struct mesa_format_info *info = _mesa_get_format_info(format);
199    unsigned int max = MAX2(info->RedBits, info->GreenBits);
200    max = MAX2(max, info->BlueBits);
201    max = MAX2(max, info->AlphaBits);
202    max = MAX2(max, info->LuminanceBits);
203    max = MAX2(max, info->IntensityBits);
204    max = MAX2(max, info->DepthBits);
205    max = MAX2(max, info->StencilBits);
206    return max;
207 }
208 
209 
210 /**
211  * Return the layout type of the given format.
212  */
213 extern enum mesa_format_layout
_mesa_get_format_layout(mesa_format format)214 _mesa_get_format_layout(mesa_format format)
215 {
216    const struct mesa_format_info *info = _mesa_get_format_info(format);
217    return info->Layout;
218 }
219 
220 
221 /**
222  * Return the data type (or more specifically, the data representation)
223  * for the given format.
224  * The return value will be one of:
225  *    GL_UNSIGNED_NORMALIZED = unsigned int representing [0,1]
226  *    GL_SIGNED_NORMALIZED = signed int representing [-1, 1]
227  *    GL_UNSIGNED_INT = an ordinary unsigned integer
228  *    GL_INT = an ordinary signed integer
229  *    GL_FLOAT = an ordinary float
230  */
231 GLenum
_mesa_get_format_datatype(mesa_format format)232 _mesa_get_format_datatype(mesa_format format)
233 {
234    const struct mesa_format_info *info = _mesa_get_format_info(format);
235    return info->DataType;
236 }
237 
238 static GLenum
get_base_format_for_array_format(mesa_array_format format)239 get_base_format_for_array_format(mesa_array_format format)
240 {
241    uint8_t swizzle[4];
242    int num_channels;
243 
244    switch (_mesa_array_format_get_base_format(format)) {
245    case MESA_ARRAY_FORMAT_BASE_FORMAT_DEPTH:
246       return GL_DEPTH_COMPONENT;
247    case MESA_ARRAY_FORMAT_BASE_FORMAT_STENCIL:
248       return GL_STENCIL_INDEX;
249    case MESA_ARRAY_FORMAT_BASE_FORMAT_RGBA_VARIANTS:
250       break;
251    }
252 
253    _mesa_array_format_get_swizzle(format, swizzle);
254    num_channels = _mesa_array_format_get_num_channels(format);
255 
256    switch (num_channels) {
257    case 4:
258       /* FIXME: RGBX formats have 4 channels, but their base format is GL_RGB.
259        * This is not really a problem for now because we only create array
260        * formats from GL format/type combinations, and these cannot specify
261        * RGBX formats.
262        */
263       return GL_RGBA;
264    case 3:
265       return GL_RGB;
266    case 2:
267       if (swizzle[0] == 0 &&
268           swizzle[1] == 0 &&
269           swizzle[2] == 0 &&
270           swizzle[3] == 1)
271          return GL_LUMINANCE_ALPHA;
272       if (swizzle[0] == 1 &&
273           swizzle[1] == 1 &&
274           swizzle[2] == 1 &&
275           swizzle[3] == 0)
276          return GL_LUMINANCE_ALPHA;
277       if (swizzle[0] == 0 &&
278           swizzle[1] == 1 &&
279           swizzle[2] == 4 &&
280           swizzle[3] == 5)
281          return GL_RG;
282       if (swizzle[0] == 1 &&
283           swizzle[1] == 0 &&
284           swizzle[2] == 4 &&
285           swizzle[3] == 5)
286          return GL_RG;
287       break;
288    case 1:
289       if (swizzle[0] == 0 &&
290           swizzle[1] == 0 &&
291           swizzle[2] == 0 &&
292           swizzle[3] == 5)
293          return GL_LUMINANCE;
294       if (swizzle[0] == 0 &&
295           swizzle[1] == 0 &&
296           swizzle[2] == 0 &&
297           swizzle[3] == 0)
298          return GL_INTENSITY;
299       if (swizzle[0] <= MESA_FORMAT_SWIZZLE_W)
300          return GL_RED;
301       if (swizzle[1] <= MESA_FORMAT_SWIZZLE_W)
302          return GL_GREEN;
303       if (swizzle[2] <= MESA_FORMAT_SWIZZLE_W)
304          return GL_BLUE;
305       if (swizzle[3] <= MESA_FORMAT_SWIZZLE_W)
306          return GL_ALPHA;
307       break;
308    }
309 
310    unreachable("Unsupported format");
311 }
312 
313 /**
314  * Return the basic format for the given type.  The result will be one of
315  * GL_RGB, GL_RGBA, GL_ALPHA, GL_LUMINANCE, GL_LUMINANCE_ALPHA, GL_INTENSITY,
316  * GL_YCBCR_MESA, GL_DEPTH_COMPONENT, GL_STENCIL_INDEX, GL_DEPTH_STENCIL.
317  * This functions accepts a mesa_format or a mesa_array_format.
318  */
319 GLenum
_mesa_get_format_base_format(uint32_t format)320 _mesa_get_format_base_format(uint32_t format)
321 {
322    if (!_mesa_format_is_mesa_array_format(format)) {
323       const struct mesa_format_info *info = _mesa_get_format_info(format);
324       return info->BaseFormat;
325    } else {
326       return get_base_format_for_array_format(format);
327    }
328 }
329 
330 
331 /**
332  * Return the block size (in pixels) for the given format.  Normally
333  * the block size is 1x1.  But compressed formats will have block sizes
334  * of 4x4 or 8x4 pixels, etc.
335  * \param bw  returns block width in pixels
336  * \param bh  returns block height in pixels
337  */
338 void
_mesa_get_format_block_size(mesa_format format,unsigned int * bw,unsigned int * bh)339 _mesa_get_format_block_size(mesa_format format,
340                             unsigned int *bw, unsigned int *bh)
341 {
342    const struct mesa_format_info *info = _mesa_get_format_info(format);
343    /* Use _mesa_get_format_block_size_3d() for 3D blocks. */
344    assert(info->BlockDepth == 1);
345 
346    *bw = info->BlockWidth;
347    *bh = info->BlockHeight;
348 }
349 
350 
351 /**
352  * Return the block size (in pixels) for the given format. Normally
353  * the block size is 1x1x1. But compressed formats will have block
354  * sizes of 4x4x4, 3x3x3 pixels, etc.
355  * \param bw  returns block width in pixels
356  * \param bh  returns block height in pixels
357  * \param bd  returns block depth in pixels
358  */
359 void
_mesa_get_format_block_size_3d(mesa_format format,unsigned int * bw,unsigned int * bh,unsigned int * bd)360 _mesa_get_format_block_size_3d(mesa_format format,
361                                unsigned int *bw,
362                                unsigned int *bh,
363                                unsigned int *bd)
364 {
365    const struct mesa_format_info *info = _mesa_get_format_info(format);
366    *bw = info->BlockWidth;
367    *bh = info->BlockHeight;
368    *bd = info->BlockDepth;
369 }
370 
371 
372 /**
373  * Returns the an array of four numbers representing the transformation
374  * from the RGBA or SZ colorspace to the given format.  For array formats,
375  * the i'th RGBA component is given by:
376  *
377  * if (swizzle[i] <= MESA_FORMAT_SWIZZLE_W)
378  *    comp = data[swizzle[i]];
379  * else if (swizzle[i] == MESA_FORMAT_SWIZZLE_ZERO)
380  *    comp = 0;
381  * else if (swizzle[i] == MESA_FORMAT_SWIZZLE_ONE)
382  *    comp = 1;
383  * else if (swizzle[i] == MESA_FORMAT_SWIZZLE_NONE)
384  *    // data does not contain a channel of this format
385  *
386  * For packed formats, the swizzle gives the number of components left of
387  * the least significant bit.
388  *
389  * Compressed formats have no swizzle.
390  */
391 void
_mesa_get_format_swizzle(mesa_format format,uint8_t swizzle_out[4])392 _mesa_get_format_swizzle(mesa_format format, uint8_t swizzle_out[4])
393 {
394    const struct mesa_format_info *info = _mesa_get_format_info(format);
395    memcpy(swizzle_out, info->Swizzle, sizeof(info->Swizzle));
396 }
397 
398 mesa_array_format
_mesa_array_format_flip_channels(mesa_array_format format)399 _mesa_array_format_flip_channels(mesa_array_format format)
400 {
401    int num_channels;
402    uint8_t swizzle[4];
403 
404    num_channels = _mesa_array_format_get_num_channels(format);
405    _mesa_array_format_get_swizzle(format, swizzle);
406 
407    if (num_channels == 1 || num_channels == 3)
408       return format;
409 
410    if (num_channels == 2) {
411       /* Assert that the swizzle makes sense for 2 channels */
412       for (unsigned i = 0; i < 4; i++)
413          assert(swizzle[i] != 2 && swizzle[i] != 3);
414 
415       static const uint8_t flip_xy[6] = { 1, 0, 2, 3, 4, 5 };
416       _mesa_array_format_set_swizzle(&format,
417                                      flip_xy[swizzle[0]], flip_xy[swizzle[1]],
418                                      flip_xy[swizzle[2]], flip_xy[swizzle[3]]);
419       return format;
420    }
421 
422    if (num_channels == 4) {
423       static const uint8_t flip[6] = { 3, 2, 1, 0, 4, 5 };
424       _mesa_array_format_set_swizzle(&format,
425                                      flip[swizzle[0]], flip[swizzle[1]],
426                                      flip[swizzle[2]], flip[swizzle[3]]);
427       return format;
428    }
429 
430    unreachable("Invalid array format");
431 }
432 
433 uint32_t
_mesa_format_to_array_format(mesa_format format)434 _mesa_format_to_array_format(mesa_format format)
435 {
436    const struct mesa_format_info *info = _mesa_get_format_info(format);
437 #if UTIL_ARCH_BIG_ENDIAN
438    if (info->ArrayFormat && info->Layout == MESA_FORMAT_LAYOUT_PACKED)
439       return _mesa_array_format_flip_channels(info->ArrayFormat);
440    else
441 #endif
442       return info->ArrayFormat;
443 }
444 
445 static struct hash_table *format_array_format_table;
446 static once_flag format_array_format_table_exists = ONCE_FLAG_INIT;
447 
448 static void
format_array_format_table_destroy(void)449 format_array_format_table_destroy(void)
450 {
451    _mesa_hash_table_destroy(format_array_format_table, NULL);
452 }
453 
454 static bool
array_formats_equal(const void * a,const void * b)455 array_formats_equal(const void *a, const void *b)
456 {
457    return (intptr_t)a == (intptr_t)b;
458 }
459 
460 static void
format_array_format_table_init(void)461 format_array_format_table_init(void)
462 {
463    const struct mesa_format_info *info;
464    mesa_array_format array_format;
465    unsigned f;
466 
467    format_array_format_table = _mesa_hash_table_create(NULL, NULL,
468                                                        array_formats_equal);
469 
470    if (!format_array_format_table) {
471       _mesa_error_no_memory(__func__);
472       return;
473    }
474 
475    for (f = 1; f < MESA_FORMAT_COUNT; ++f) {
476       info = _mesa_get_format_info(f);
477       if (!info || !info->ArrayFormat)
478          continue;
479 
480       /* All sRGB formats should have an equivalent UNORM format, and that's
481        * the one we want in the table.
482        */
483       if (_mesa_is_format_srgb(f))
484          continue;
485 
486 #if UTIL_ARCH_LITTLE_ENDIAN
487          array_format = info->ArrayFormat;
488 #else
489          array_format = _mesa_array_format_flip_channels(info->ArrayFormat);
490 #endif
491 
492       _mesa_hash_table_insert_pre_hashed(format_array_format_table,
493                                          array_format,
494                                          (void *)(intptr_t)array_format,
495                                          (void *)(intptr_t)f);
496    }
497 
498    atexit(format_array_format_table_destroy);
499 }
500 
501 mesa_format
_mesa_format_from_array_format(uint32_t array_format)502 _mesa_format_from_array_format(uint32_t array_format)
503 {
504    struct hash_entry *entry;
505 
506    assert(_mesa_format_is_mesa_array_format(array_format));
507 
508    call_once(&format_array_format_table_exists, format_array_format_table_init);
509 
510    if (!format_array_format_table) {
511       static const once_flag once_flag_init = ONCE_FLAG_INIT;
512       format_array_format_table_exists = once_flag_init;
513       return MESA_FORMAT_NONE;
514    }
515 
516    entry = _mesa_hash_table_search_pre_hashed(format_array_format_table,
517                                               array_format,
518                                               (void *)(intptr_t)array_format);
519    if (entry)
520       return (intptr_t)entry->data;
521    else
522       return MESA_FORMAT_NONE;
523 }
524 
525 /** Is the given format a compressed format? */
526 bool
_mesa_is_format_compressed(mesa_format format)527 _mesa_is_format_compressed(mesa_format format)
528 {
529    const struct mesa_format_info *info = _mesa_get_format_info(format);
530    return info->BlockWidth > 1 || info->BlockHeight > 1;
531 }
532 
533 
534 /**
535  * Determine if the given format represents a packed depth/stencil buffer.
536  */
537 bool
_mesa_is_format_packed_depth_stencil(mesa_format format)538 _mesa_is_format_packed_depth_stencil(mesa_format format)
539 {
540    const struct mesa_format_info *info = _mesa_get_format_info(format);
541 
542    return info->BaseFormat == GL_DEPTH_STENCIL;
543 }
544 
545 
546 /**
547  * Is the given format a signed/unsigned integer color format?
548  */
549 bool
_mesa_is_format_integer_color(mesa_format format)550 _mesa_is_format_integer_color(mesa_format format)
551 {
552    const struct mesa_format_info *info = _mesa_get_format_info(format);
553    return (info->DataType == GL_INT || info->DataType == GL_UNSIGNED_INT) &&
554       info->BaseFormat != GL_DEPTH_COMPONENT &&
555       info->BaseFormat != GL_DEPTH_STENCIL &&
556       info->BaseFormat != GL_STENCIL_INDEX;
557 }
558 
559 
560 /**
561  * Is the given format an unsigned integer format?
562  */
563 bool
_mesa_is_format_unsigned(mesa_format format)564 _mesa_is_format_unsigned(mesa_format format)
565 {
566    const struct mesa_format_info *info = _mesa_get_format_info(format);
567    return _mesa_is_type_unsigned(info->DataType);
568 }
569 
570 
571 /**
572  * Does the given format store signed values?
573  */
574 bool
_mesa_is_format_signed(mesa_format format)575 _mesa_is_format_signed(mesa_format format)
576 {
577    if (format == MESA_FORMAT_R11G11B10_FLOAT ||
578        format == MESA_FORMAT_R9G9B9E5_FLOAT) {
579       /* these packed float formats only store unsigned values */
580       return false;
581    }
582    else {
583       const struct mesa_format_info *info = _mesa_get_format_info(format);
584       return (info->DataType == GL_SIGNED_NORMALIZED ||
585               info->DataType == GL_INT ||
586               info->DataType == GL_FLOAT);
587    }
588 }
589 
590 /**
591  * Is the given format an integer format?
592  */
593 bool
_mesa_is_format_integer(mesa_format format)594 _mesa_is_format_integer(mesa_format format)
595 {
596    const struct mesa_format_info *info = _mesa_get_format_info(format);
597    return (info->DataType == GL_INT || info->DataType == GL_UNSIGNED_INT);
598 }
599 
600 
601 /**
602  * Return true if the given format is a color format.
603  */
604 bool
_mesa_is_format_color_format(mesa_format format)605 _mesa_is_format_color_format(mesa_format format)
606 {
607    const struct mesa_format_info *info = _mesa_get_format_info(format);
608    switch (info->BaseFormat) {
609    case GL_DEPTH_COMPONENT:
610    case GL_STENCIL_INDEX:
611    case GL_DEPTH_STENCIL:
612       return false;
613    default:
614       return true;
615    }
616 }
617 
618 bool
_mesa_is_format_srgb(mesa_format format)619 _mesa_is_format_srgb(mesa_format format)
620 {
621    const struct mesa_format_info *info = _mesa_get_format_info(format);
622    return info->IsSRGBFormat;
623 }
624 
625 /**
626  * Return TRUE if format is an ETC2 compressed format specified
627  * by GL_ARB_ES3_compatibility.
628  */
629 bool
_mesa_is_format_etc2(mesa_format format)630 _mesa_is_format_etc2(mesa_format format)
631 {
632    switch (format) {
633    case MESA_FORMAT_ETC2_RGB8:
634    case MESA_FORMAT_ETC2_SRGB8:
635    case MESA_FORMAT_ETC2_RGBA8_EAC:
636    case MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC:
637    case MESA_FORMAT_ETC2_R11_EAC:
638    case MESA_FORMAT_ETC2_RG11_EAC:
639    case MESA_FORMAT_ETC2_SIGNED_R11_EAC:
640    case MESA_FORMAT_ETC2_SIGNED_RG11_EAC:
641    case MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1:
642    case MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1:
643       return true;
644    default:
645       return false;
646    }
647 }
648 
649 
650 /**
651  * Return TRUE if format is an ASTC 2D compressed format.
652  */
653 bool
_mesa_is_format_astc_2d(mesa_format format)654 _mesa_is_format_astc_2d(mesa_format format)
655 {
656    switch (format) {
657    case MESA_FORMAT_RGBA_ASTC_4x4:
658    case MESA_FORMAT_RGBA_ASTC_5x4:
659    case MESA_FORMAT_RGBA_ASTC_5x5:
660    case MESA_FORMAT_RGBA_ASTC_6x5:
661    case MESA_FORMAT_RGBA_ASTC_6x6:
662    case MESA_FORMAT_RGBA_ASTC_8x5:
663    case MESA_FORMAT_RGBA_ASTC_8x6:
664    case MESA_FORMAT_RGBA_ASTC_8x8:
665    case MESA_FORMAT_RGBA_ASTC_10x5:
666    case MESA_FORMAT_RGBA_ASTC_10x6:
667    case MESA_FORMAT_RGBA_ASTC_10x8:
668    case MESA_FORMAT_RGBA_ASTC_10x10:
669    case MESA_FORMAT_RGBA_ASTC_12x10:
670    case MESA_FORMAT_RGBA_ASTC_12x12:
671    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_4x4:
672    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x4:
673    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x5:
674    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x5:
675    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x6:
676    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_8x5:
677    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_8x6:
678    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_8x8:
679    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x5:
680    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x6:
681    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x8:
682    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x10:
683    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_12x10:
684    case MESA_FORMAT_SRGB8_ALPHA8_ASTC_12x12:
685       return true;
686    default:
687       return false;
688    }
689 }
690 
691 
692 /**
693  * If the given format is a compressed format, return a corresponding
694  * uncompressed format.
695  */
696 mesa_format
_mesa_get_uncompressed_format(mesa_format format)697 _mesa_get_uncompressed_format(mesa_format format)
698 {
699    switch (format) {
700    case MESA_FORMAT_RGB_FXT1:
701       return MESA_FORMAT_BGR_UNORM8;
702    case MESA_FORMAT_RGBA_FXT1:
703       return MESA_FORMAT_A8B8G8R8_UNORM;
704    case MESA_FORMAT_RGB_DXT1:
705    case MESA_FORMAT_SRGB_DXT1:
706       return MESA_FORMAT_BGR_UNORM8;
707    case MESA_FORMAT_RGBA_DXT1:
708    case MESA_FORMAT_SRGBA_DXT1:
709       return MESA_FORMAT_A8B8G8R8_UNORM;
710    case MESA_FORMAT_RGBA_DXT3:
711    case MESA_FORMAT_SRGBA_DXT3:
712       return MESA_FORMAT_A8B8G8R8_UNORM;
713    case MESA_FORMAT_RGBA_DXT5:
714    case MESA_FORMAT_SRGBA_DXT5:
715       return MESA_FORMAT_A8B8G8R8_UNORM;
716    case MESA_FORMAT_R_RGTC1_UNORM:
717       return MESA_FORMAT_R_UNORM8;
718    case MESA_FORMAT_R_RGTC1_SNORM:
719       return MESA_FORMAT_R_SNORM8;
720    case MESA_FORMAT_RG_RGTC2_UNORM:
721       return MESA_FORMAT_RG_UNORM8;
722    case MESA_FORMAT_RG_RGTC2_SNORM:
723       return MESA_FORMAT_RG_SNORM8;
724    case MESA_FORMAT_L_LATC1_UNORM:
725       return MESA_FORMAT_L_UNORM8;
726    case MESA_FORMAT_L_LATC1_SNORM:
727       return MESA_FORMAT_L_SNORM8;
728    case MESA_FORMAT_LA_LATC2_UNORM:
729       return MESA_FORMAT_LA_UNORM8;
730    case MESA_FORMAT_LA_LATC2_SNORM:
731       return MESA_FORMAT_LA_SNORM8;
732    case MESA_FORMAT_ETC1_RGB8:
733    case MESA_FORMAT_ETC2_RGB8:
734    case MESA_FORMAT_ETC2_SRGB8:
735    case MESA_FORMAT_ATC_RGB:
736       return MESA_FORMAT_BGR_UNORM8;
737    case MESA_FORMAT_ETC2_RGBA8_EAC:
738    case MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC:
739    case MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1:
740    case MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1:
741    case MESA_FORMAT_ATC_RGBA_EXPLICIT:
742    case MESA_FORMAT_ATC_RGBA_INTERPOLATED:
743       return MESA_FORMAT_A8B8G8R8_UNORM;
744    case MESA_FORMAT_ETC2_R11_EAC:
745    case MESA_FORMAT_ETC2_SIGNED_R11_EAC:
746       return MESA_FORMAT_R_UNORM16;
747    case MESA_FORMAT_ETC2_RG11_EAC:
748    case MESA_FORMAT_ETC2_SIGNED_RG11_EAC:
749       return MESA_FORMAT_RG_UNORM16;
750    case MESA_FORMAT_BPTC_RGBA_UNORM:
751    case MESA_FORMAT_BPTC_SRGB_ALPHA_UNORM:
752       return MESA_FORMAT_A8B8G8R8_UNORM;
753    case MESA_FORMAT_BPTC_RGB_UNSIGNED_FLOAT:
754    case MESA_FORMAT_BPTC_RGB_SIGNED_FLOAT:
755       return MESA_FORMAT_RGB_FLOAT32;
756    default:
757       assert(!_mesa_is_format_compressed(format));
758       return format;
759    }
760 }
761 
762 
763 unsigned int
_mesa_format_num_components(mesa_format format)764 _mesa_format_num_components(mesa_format format)
765 {
766    const struct mesa_format_info *info = _mesa_get_format_info(format);
767    return ((info->RedBits > 0) +
768            (info->GreenBits > 0) +
769            (info->BlueBits > 0) +
770            (info->AlphaBits > 0) +
771            (info->LuminanceBits > 0) +
772            (info->IntensityBits > 0) +
773            (info->DepthBits > 0) +
774            (info->StencilBits > 0));
775 }
776 
777 
778 /**
779  * Returns true if a color format has data stored in the R/G/B/A channels,
780  * given an index from 0 to 3.
781  */
782 bool
_mesa_format_has_color_component(mesa_format format,int component)783 _mesa_format_has_color_component(mesa_format format, int component)
784 {
785    const struct mesa_format_info *info = _mesa_get_format_info(format);
786 
787    assert(info->BaseFormat != GL_DEPTH_COMPONENT &&
788           info->BaseFormat != GL_DEPTH_STENCIL &&
789           info->BaseFormat != GL_STENCIL_INDEX);
790 
791    switch (component) {
792    case 0:
793       return (info->RedBits + info->IntensityBits + info->LuminanceBits) > 0;
794    case 1:
795       return (info->GreenBits + info->IntensityBits + info->LuminanceBits) > 0;
796    case 2:
797       return (info->BlueBits + info->IntensityBits + info->LuminanceBits) > 0;
798    case 3:
799       return (info->AlphaBits + info->IntensityBits) > 0;
800    default:
801       assert(!"Invalid color component: must be 0..3");
802       return false;
803    }
804 }
805 
806 
807 /**
808  * Return number of bytes needed to store an image of the given size
809  * in the given format.
810  */
811 uint32_t
_mesa_format_image_size(mesa_format format,int width,int height,int depth)812 _mesa_format_image_size(mesa_format format, int width,
813                         int height, int depth)
814 {
815    const struct mesa_format_info *info = _mesa_get_format_info(format);
816    uint32_t sz;
817    /* Strictly speaking, a conditional isn't needed here */
818    if (info->BlockWidth > 1 || info->BlockHeight > 1 || info->BlockDepth > 1) {
819       /* compressed format (2D only for now) */
820       const uint32_t bw = info->BlockWidth;
821       const uint32_t bh = info->BlockHeight;
822       const uint32_t bd = info->BlockDepth;
823       const uint32_t wblocks = (width + bw - 1) / bw;
824       const uint32_t hblocks = (height + bh - 1) / bh;
825       const uint32_t dblocks = (depth + bd - 1) / bd;
826       sz = wblocks * hblocks * dblocks * info->BytesPerBlock;
827    } else
828       /* non-compressed */
829       sz = width * height * depth * info->BytesPerBlock;
830 
831    return sz;
832 }
833 
834 
835 /**
836  * Same as _mesa_format_image_size() but returns a 64-bit value to
837  * accommodate very large textures.
838  */
839 uint64_t
_mesa_format_image_size64(mesa_format format,int width,int height,int depth)840 _mesa_format_image_size64(mesa_format format, int width,
841                           int height, int depth)
842 {
843    const struct mesa_format_info *info = _mesa_get_format_info(format);
844    uint64_t sz;
845    /* Strictly speaking, a conditional isn't needed here */
846    if (info->BlockWidth > 1 || info->BlockHeight > 1 || info->BlockDepth > 1) {
847       /* compressed format (2D only for now) */
848       const uint64_t bw = info->BlockWidth;
849       const uint64_t bh = info->BlockHeight;
850       const uint64_t bd = info->BlockDepth;
851       const uint64_t wblocks = (width + bw - 1) / bw;
852       const uint64_t hblocks = (height + bh - 1) / bh;
853       const uint64_t dblocks = (depth + bd - 1) / bd;
854       sz = wblocks * hblocks * dblocks * info->BytesPerBlock;
855    } else
856       /* non-compressed */
857       sz = ((uint64_t) width * (uint64_t) height *
858             (uint64_t) depth * info->BytesPerBlock);
859 
860    return sz;
861 }
862 
863 
864 
865 int32_t
_mesa_format_row_stride(mesa_format format,int width)866 _mesa_format_row_stride(mesa_format format, int width)
867 {
868    const struct mesa_format_info *info = _mesa_get_format_info(format);
869    /* Strictly speaking, a conditional isn't needed here */
870    if (info->BlockWidth > 1 || info->BlockHeight > 1) {
871       /* compressed format */
872       const uint32_t bw = info->BlockWidth;
873       const uint32_t wblocks = (width + bw - 1) / bw;
874       const int32_t stride = wblocks * info->BytesPerBlock;
875       return stride;
876    }
877    else {
878       const int32_t stride = width * info->BytesPerBlock;
879       return stride;
880    }
881 }
882 
883 
884 
885 /**
886  * Return datatype and number of components per texel for the given
887  * uncompressed mesa_format. Only used for mipmap generation code.
888  */
889 void
_mesa_uncompressed_format_to_type_and_comps(mesa_format format,GLenum * datatype,GLuint * comps)890 _mesa_uncompressed_format_to_type_and_comps(mesa_format format,
891                                GLenum *datatype, GLuint *comps)
892 {
893    switch (format) {
894    case MESA_FORMAT_A8B8G8R8_UNORM:
895    case MESA_FORMAT_R8G8B8A8_UNORM:
896    case MESA_FORMAT_B8G8R8A8_UNORM:
897    case MESA_FORMAT_A8R8G8B8_UNORM:
898    case MESA_FORMAT_X8B8G8R8_UNORM:
899    case MESA_FORMAT_R8G8B8X8_UNORM:
900    case MESA_FORMAT_B8G8R8X8_UNORM:
901    case MESA_FORMAT_X8R8G8B8_UNORM:
902    case MESA_FORMAT_A8B8G8R8_UINT:
903    case MESA_FORMAT_R8G8B8A8_UINT:
904    case MESA_FORMAT_B8G8R8A8_UINT:
905    case MESA_FORMAT_A8R8G8B8_UINT:
906       *datatype = GL_UNSIGNED_BYTE;
907       *comps = 4;
908       return;
909    case MESA_FORMAT_BGR_UNORM8:
910    case MESA_FORMAT_RGB_UNORM8:
911       *datatype = GL_UNSIGNED_BYTE;
912       *comps = 3;
913       return;
914    case MESA_FORMAT_B5G6R5_UNORM:
915    case MESA_FORMAT_R5G6B5_UNORM:
916    case MESA_FORMAT_B5G6R5_UINT:
917    case MESA_FORMAT_R5G6B5_UINT:
918       *datatype = GL_UNSIGNED_SHORT_5_6_5;
919       *comps = 3;
920       return;
921 
922    case MESA_FORMAT_B4G4R4A4_UNORM:
923    case MESA_FORMAT_A4R4G4B4_UNORM:
924    case MESA_FORMAT_B4G4R4X4_UNORM:
925    case MESA_FORMAT_B4G4R4A4_UINT:
926    case MESA_FORMAT_A4R4G4B4_UINT:
927       *datatype = GL_UNSIGNED_SHORT_4_4_4_4;
928       *comps = 4;
929       return;
930 
931    case MESA_FORMAT_B5G5R5A1_UNORM:
932    case MESA_FORMAT_A1R5G5B5_UNORM:
933    case MESA_FORMAT_B5G5R5X1_UNORM:
934    case MESA_FORMAT_B5G5R5A1_UINT:
935    case MESA_FORMAT_A1R5G5B5_UINT:
936       *datatype = GL_UNSIGNED_SHORT_1_5_5_5_REV;
937       *comps = 4;
938       return;
939 
940    case MESA_FORMAT_B10G10R10A2_UNORM:
941       *datatype = GL_UNSIGNED_INT_2_10_10_10_REV;
942       *comps = 4;
943       return;
944 
945    case MESA_FORMAT_A1B5G5R5_UNORM:
946    case MESA_FORMAT_A1B5G5R5_UINT:
947    case MESA_FORMAT_X1B5G5R5_UNORM:
948       *datatype = GL_UNSIGNED_SHORT_5_5_5_1;
949       *comps = 4;
950       return;
951 
952    case MESA_FORMAT_L4A4_UNORM:
953       *datatype = MESA_UNSIGNED_BYTE_4_4;
954       *comps = 2;
955       return;
956 
957    case MESA_FORMAT_LA_UNORM8:
958    case MESA_FORMAT_RG_UNORM8:
959       *datatype = GL_UNSIGNED_BYTE;
960       *comps = 2;
961       return;
962 
963    case MESA_FORMAT_LA_UNORM16:
964    case MESA_FORMAT_RG_UNORM16:
965       *datatype = GL_UNSIGNED_SHORT;
966       *comps = 2;
967       return;
968 
969    case MESA_FORMAT_R_UNORM16:
970    case MESA_FORMAT_A_UNORM16:
971    case MESA_FORMAT_L_UNORM16:
972    case MESA_FORMAT_I_UNORM16:
973       *datatype = GL_UNSIGNED_SHORT;
974       *comps = 1;
975       return;
976 
977    case MESA_FORMAT_R3G3B2_UNORM:
978    case MESA_FORMAT_R3G3B2_UINT:
979       *datatype = GL_UNSIGNED_BYTE_2_3_3_REV;
980       *comps = 3;
981       return;
982    case MESA_FORMAT_A4B4G4R4_UNORM:
983    case MESA_FORMAT_A4B4G4R4_UINT:
984       *datatype = GL_UNSIGNED_SHORT_4_4_4_4;
985       *comps = 4;
986       return;
987 
988    case MESA_FORMAT_R4G4B4A4_UNORM:
989    case MESA_FORMAT_R4G4B4A4_UINT:
990       *datatype = GL_UNSIGNED_SHORT_4_4_4_4;
991       *comps = 4;
992       return;
993    case MESA_FORMAT_R5G5B5A1_UNORM:
994    case MESA_FORMAT_R5G5B5A1_UINT:
995       *datatype = GL_UNSIGNED_SHORT_1_5_5_5_REV;
996       *comps = 4;
997       return;
998    case MESA_FORMAT_A2B10G10R10_UNORM:
999    case MESA_FORMAT_A2B10G10R10_UINT:
1000       *datatype = GL_UNSIGNED_INT_10_10_10_2;
1001       *comps = 4;
1002       return;
1003    case MESA_FORMAT_A2R10G10B10_UNORM:
1004    case MESA_FORMAT_A2R10G10B10_UINT:
1005       *datatype = GL_UNSIGNED_INT_10_10_10_2;
1006       *comps = 4;
1007       return;
1008 
1009    case MESA_FORMAT_B2G3R3_UNORM:
1010    case MESA_FORMAT_B2G3R3_UINT:
1011       *datatype = GL_UNSIGNED_BYTE_3_3_2;
1012       *comps = 3;
1013       return;
1014 
1015    case MESA_FORMAT_A_UNORM8:
1016    case MESA_FORMAT_L_UNORM8:
1017    case MESA_FORMAT_I_UNORM8:
1018    case MESA_FORMAT_R_UNORM8:
1019    case MESA_FORMAT_S_UINT8:
1020       *datatype = GL_UNSIGNED_BYTE;
1021       *comps = 1;
1022       return;
1023 
1024    case MESA_FORMAT_YCBCR:
1025    case MESA_FORMAT_YCBCR_REV:
1026       *datatype = GL_UNSIGNED_SHORT;
1027       *comps = 2;
1028       return;
1029 
1030    case MESA_FORMAT_S8_UINT_Z24_UNORM:
1031       *datatype = GL_UNSIGNED_INT_24_8_MESA;
1032       *comps = 2;
1033       return;
1034 
1035    case MESA_FORMAT_Z24_UNORM_S8_UINT:
1036       *datatype = GL_UNSIGNED_INT_8_24_REV_MESA;
1037       *comps = 2;
1038       return;
1039 
1040    case MESA_FORMAT_Z_UNORM16:
1041       *datatype = GL_UNSIGNED_SHORT;
1042       *comps = 1;
1043       return;
1044 
1045    case MESA_FORMAT_Z24_UNORM_X8_UINT:
1046       *datatype = GL_UNSIGNED_INT;
1047       *comps = 1;
1048       return;
1049 
1050    case MESA_FORMAT_X8_UINT_Z24_UNORM:
1051       *datatype = GL_UNSIGNED_INT;
1052       *comps = 1;
1053       return;
1054 
1055    case MESA_FORMAT_Z_UNORM32:
1056       *datatype = GL_UNSIGNED_INT;
1057       *comps = 1;
1058       return;
1059 
1060    case MESA_FORMAT_Z_FLOAT32:
1061       *datatype = GL_FLOAT;
1062       *comps = 1;
1063       return;
1064 
1065    case MESA_FORMAT_Z32_FLOAT_S8X24_UINT:
1066       *datatype = GL_FLOAT_32_UNSIGNED_INT_24_8_REV;
1067       *comps = 1;
1068       return;
1069 
1070    case MESA_FORMAT_R_SNORM8:
1071    case MESA_FORMAT_A_SNORM8:
1072    case MESA_FORMAT_L_SNORM8:
1073    case MESA_FORMAT_I_SNORM8:
1074       *datatype = GL_BYTE;
1075       *comps = 1;
1076       return;
1077    case MESA_FORMAT_RG_SNORM8:
1078    case MESA_FORMAT_LA_SNORM8:
1079       *datatype = GL_BYTE;
1080       *comps = 2;
1081       return;
1082    case MESA_FORMAT_A8B8G8R8_SNORM:
1083    case MESA_FORMAT_R8G8B8A8_SNORM:
1084    case MESA_FORMAT_X8B8G8R8_SNORM:
1085       *datatype = GL_BYTE;
1086       *comps = 4;
1087       return;
1088 
1089    case MESA_FORMAT_RGBA_UNORM16:
1090       *datatype = GL_UNSIGNED_SHORT;
1091       *comps = 4;
1092       return;
1093 
1094    case MESA_FORMAT_R_SNORM16:
1095    case MESA_FORMAT_A_SNORM16:
1096    case MESA_FORMAT_L_SNORM16:
1097    case MESA_FORMAT_I_SNORM16:
1098       *datatype = GL_SHORT;
1099       *comps = 1;
1100       return;
1101    case MESA_FORMAT_RG_SNORM16:
1102    case MESA_FORMAT_LA_SNORM16:
1103       *datatype = GL_SHORT;
1104       *comps = 2;
1105       return;
1106    case MESA_FORMAT_RGB_SNORM16:
1107       *datatype = GL_SHORT;
1108       *comps = 3;
1109       return;
1110    case MESA_FORMAT_RGBA_SNORM16:
1111       *datatype = GL_SHORT;
1112       *comps = 4;
1113       return;
1114 
1115    case MESA_FORMAT_BGR_SRGB8:
1116       *datatype = GL_UNSIGNED_BYTE;
1117       *comps = 3;
1118       return;
1119    case MESA_FORMAT_A8B8G8R8_SRGB:
1120    case MESA_FORMAT_B8G8R8A8_SRGB:
1121    case MESA_FORMAT_A8R8G8B8_SRGB:
1122    case MESA_FORMAT_R8G8B8A8_SRGB:
1123       *datatype = GL_UNSIGNED_BYTE;
1124       *comps = 4;
1125       return;
1126    case MESA_FORMAT_L_SRGB8:
1127    case MESA_FORMAT_R_SRGB8:
1128       *datatype = GL_UNSIGNED_BYTE;
1129       *comps = 1;
1130       return;
1131    case MESA_FORMAT_LA_SRGB8:
1132       *datatype = GL_UNSIGNED_BYTE;
1133       *comps = 2;
1134       return;
1135 
1136    case MESA_FORMAT_RGBA_FLOAT32:
1137       *datatype = GL_FLOAT;
1138       *comps = 4;
1139       return;
1140    case MESA_FORMAT_RGBA_FLOAT16:
1141       *datatype = GL_HALF_FLOAT_ARB;
1142       *comps = 4;
1143       return;
1144    case MESA_FORMAT_RGB_FLOAT32:
1145       *datatype = GL_FLOAT;
1146       *comps = 3;
1147       return;
1148    case MESA_FORMAT_RGB_FLOAT16:
1149       *datatype = GL_HALF_FLOAT_ARB;
1150       *comps = 3;
1151       return;
1152    case MESA_FORMAT_LA_FLOAT32:
1153    case MESA_FORMAT_RG_FLOAT32:
1154       *datatype = GL_FLOAT;
1155       *comps = 2;
1156       return;
1157    case MESA_FORMAT_LA_FLOAT16:
1158    case MESA_FORMAT_RG_FLOAT16:
1159       *datatype = GL_HALF_FLOAT_ARB;
1160       *comps = 2;
1161       return;
1162    case MESA_FORMAT_A_FLOAT32:
1163    case MESA_FORMAT_L_FLOAT32:
1164    case MESA_FORMAT_I_FLOAT32:
1165    case MESA_FORMAT_R_FLOAT32:
1166       *datatype = GL_FLOAT;
1167       *comps = 1;
1168       return;
1169    case MESA_FORMAT_A_FLOAT16:
1170    case MESA_FORMAT_L_FLOAT16:
1171    case MESA_FORMAT_I_FLOAT16:
1172    case MESA_FORMAT_R_FLOAT16:
1173       *datatype = GL_HALF_FLOAT_ARB;
1174       *comps = 1;
1175       return;
1176 
1177    case MESA_FORMAT_A_UINT8:
1178    case MESA_FORMAT_L_UINT8:
1179    case MESA_FORMAT_I_UINT8:
1180       *datatype = GL_UNSIGNED_BYTE;
1181       *comps = 1;
1182       return;
1183    case MESA_FORMAT_LA_UINT8:
1184       *datatype = GL_UNSIGNED_BYTE;
1185       *comps = 2;
1186       return;
1187 
1188    case MESA_FORMAT_A_UINT16:
1189    case MESA_FORMAT_L_UINT16:
1190    case MESA_FORMAT_I_UINT16:
1191       *datatype = GL_UNSIGNED_SHORT;
1192       *comps = 1;
1193       return;
1194    case MESA_FORMAT_LA_UINT16:
1195       *datatype = GL_UNSIGNED_SHORT;
1196       *comps = 2;
1197       return;
1198    case MESA_FORMAT_A_UINT32:
1199    case MESA_FORMAT_L_UINT32:
1200    case MESA_FORMAT_I_UINT32:
1201       *datatype = GL_UNSIGNED_INT;
1202       *comps = 1;
1203       return;
1204    case MESA_FORMAT_LA_UINT32:
1205       *datatype = GL_UNSIGNED_INT;
1206       *comps = 2;
1207       return;
1208    case MESA_FORMAT_A_SINT8:
1209    case MESA_FORMAT_L_SINT8:
1210    case MESA_FORMAT_I_SINT8:
1211       *datatype = GL_BYTE;
1212       *comps = 1;
1213       return;
1214    case MESA_FORMAT_LA_SINT8:
1215       *datatype = GL_BYTE;
1216       *comps = 2;
1217       return;
1218 
1219    case MESA_FORMAT_A_SINT16:
1220    case MESA_FORMAT_L_SINT16:
1221    case MESA_FORMAT_I_SINT16:
1222       *datatype = GL_SHORT;
1223       *comps = 1;
1224       return;
1225    case MESA_FORMAT_LA_SINT16:
1226       *datatype = GL_SHORT;
1227       *comps = 2;
1228       return;
1229 
1230    case MESA_FORMAT_A_SINT32:
1231    case MESA_FORMAT_L_SINT32:
1232    case MESA_FORMAT_I_SINT32:
1233       *datatype = GL_INT;
1234       *comps = 1;
1235       return;
1236    case MESA_FORMAT_LA_SINT32:
1237       *datatype = GL_INT;
1238       *comps = 2;
1239       return;
1240 
1241    case MESA_FORMAT_R_SINT8:
1242       *datatype = GL_BYTE;
1243       *comps = 1;
1244       return;
1245    case MESA_FORMAT_RG_SINT8:
1246       *datatype = GL_BYTE;
1247       *comps = 2;
1248       return;
1249    case MESA_FORMAT_RGB_SINT8:
1250       *datatype = GL_BYTE;
1251       *comps = 3;
1252       return;
1253    case MESA_FORMAT_RGBA_SINT8:
1254       *datatype = GL_BYTE;
1255       *comps = 4;
1256       return;
1257    case MESA_FORMAT_R_SINT16:
1258       *datatype = GL_SHORT;
1259       *comps = 1;
1260       return;
1261    case MESA_FORMAT_RG_SINT16:
1262       *datatype = GL_SHORT;
1263       *comps = 2;
1264       return;
1265    case MESA_FORMAT_RGB_SINT16:
1266       *datatype = GL_SHORT;
1267       *comps = 3;
1268       return;
1269    case MESA_FORMAT_RGBA_SINT16:
1270       *datatype = GL_SHORT;
1271       *comps = 4;
1272       return;
1273    case MESA_FORMAT_R_SINT32:
1274       *datatype = GL_INT;
1275       *comps = 1;
1276       return;
1277    case MESA_FORMAT_RG_SINT32:
1278       *datatype = GL_INT;
1279       *comps = 2;
1280       return;
1281    case MESA_FORMAT_RGB_SINT32:
1282       *datatype = GL_INT;
1283       *comps = 3;
1284       return;
1285    case MESA_FORMAT_RGBA_SINT32:
1286       *datatype = GL_INT;
1287       *comps = 4;
1288       return;
1289 
1290    /**
1291     * \name Non-normalized unsigned integer formats.
1292     */
1293    case MESA_FORMAT_R_UINT8:
1294       *datatype = GL_UNSIGNED_BYTE;
1295       *comps = 1;
1296       return;
1297    case MESA_FORMAT_RG_UINT8:
1298       *datatype = GL_UNSIGNED_BYTE;
1299       *comps = 2;
1300       return;
1301    case MESA_FORMAT_RGB_UINT8:
1302       *datatype = GL_UNSIGNED_BYTE;
1303       *comps = 3;
1304       return;
1305    case MESA_FORMAT_R_UINT16:
1306       *datatype = GL_UNSIGNED_SHORT;
1307       *comps = 1;
1308       return;
1309    case MESA_FORMAT_RG_UINT16:
1310       *datatype = GL_UNSIGNED_SHORT;
1311       *comps = 2;
1312       return;
1313    case MESA_FORMAT_RGB_UINT16:
1314       *datatype = GL_UNSIGNED_SHORT;
1315       *comps = 3;
1316       return;
1317    case MESA_FORMAT_RGBA_UINT16:
1318       *datatype = GL_UNSIGNED_SHORT;
1319       *comps = 4;
1320       return;
1321    case MESA_FORMAT_R_UINT32:
1322       *datatype = GL_UNSIGNED_INT;
1323       *comps = 1;
1324       return;
1325    case MESA_FORMAT_RG_UINT32:
1326       *datatype = GL_UNSIGNED_INT;
1327       *comps = 2;
1328       return;
1329    case MESA_FORMAT_RGB_UINT32:
1330       *datatype = GL_UNSIGNED_INT;
1331       *comps = 3;
1332       return;
1333    case MESA_FORMAT_RGBA_UINT32:
1334       *datatype = GL_UNSIGNED_INT;
1335       *comps = 4;
1336       return;
1337 
1338    case MESA_FORMAT_R9G9B9E5_FLOAT:
1339       *datatype = GL_UNSIGNED_INT_5_9_9_9_REV;
1340       *comps = 3;
1341       return;
1342 
1343    case MESA_FORMAT_R11G11B10_FLOAT:
1344       *datatype = GL_UNSIGNED_INT_10F_11F_11F_REV;
1345       *comps = 3;
1346       return;
1347 
1348    case MESA_FORMAT_B10G10R10A2_UINT:
1349    case MESA_FORMAT_R10G10B10A2_UINT:
1350       *datatype = GL_UNSIGNED_INT_2_10_10_10_REV;
1351       *comps = 4;
1352       return;
1353 
1354    case MESA_FORMAT_R8G8B8X8_SRGB:
1355    case MESA_FORMAT_X8B8G8R8_SRGB:
1356    case MESA_FORMAT_RGBX_UINT8:
1357       *datatype = GL_UNSIGNED_BYTE;
1358       *comps = 4;
1359       return;
1360 
1361    case MESA_FORMAT_R8G8B8X8_SNORM:
1362    case MESA_FORMAT_RGBX_SINT8:
1363       *datatype = GL_BYTE;
1364       *comps = 4;
1365       return;
1366 
1367    case MESA_FORMAT_B10G10R10X2_UNORM:
1368    case MESA_FORMAT_R10G10B10X2_UNORM:
1369       *datatype = GL_UNSIGNED_INT_2_10_10_10_REV;
1370       *comps = 4;
1371       return;
1372 
1373    case MESA_FORMAT_RGBX_UNORM16:
1374    case MESA_FORMAT_RGBX_UINT16:
1375       *datatype = GL_UNSIGNED_SHORT;
1376       *comps = 4;
1377       return;
1378 
1379    case MESA_FORMAT_RGBX_SNORM16:
1380    case MESA_FORMAT_RGBX_SINT16:
1381       *datatype = GL_SHORT;
1382       *comps = 4;
1383       return;
1384 
1385    case MESA_FORMAT_RGBX_FLOAT16:
1386       *datatype = GL_HALF_FLOAT;
1387       *comps = 4;
1388       return;
1389 
1390    case MESA_FORMAT_RGBX_FLOAT32:
1391       *datatype = GL_FLOAT;
1392       *comps = 4;
1393       return;
1394 
1395    case MESA_FORMAT_RGBX_UINT32:
1396       *datatype = GL_UNSIGNED_INT;
1397       *comps = 4;
1398       return;
1399 
1400    case MESA_FORMAT_RGBX_SINT32:
1401       *datatype = GL_INT;
1402       *comps = 4;
1403       return;
1404 
1405    case MESA_FORMAT_R10G10B10A2_UNORM:
1406       *datatype = GL_UNSIGNED_INT_2_10_10_10_REV;
1407       *comps = 4;
1408       return;
1409 
1410    case MESA_FORMAT_B8G8R8X8_SRGB:
1411    case MESA_FORMAT_X8R8G8B8_SRGB:
1412       *datatype = GL_UNSIGNED_BYTE;
1413       *comps = 4;
1414       return;
1415 
1416    case MESA_FORMAT_COUNT:
1417       assert(0);
1418       return;
1419    default: {
1420       const char *name = _mesa_get_format_name(format);
1421       /* Warn if any formats are not handled */
1422       _mesa_problem(NULL, "bad format %s in _mesa_uncompressed_format_to_type_and_comps",
1423                     name ? name : "???");
1424       assert(format == MESA_FORMAT_NONE ||
1425              _mesa_is_format_compressed(format));
1426       *datatype = 0;
1427       *comps = 1;
1428    }
1429    }
1430 }
1431 
1432 /**
1433  * Check if a mesa_format exactly matches a GL format/type combination
1434  * such that we can use memcpy() from one to the other.
1435  * \param mesa_format  a MESA_FORMAT_x value
1436  * \param format  the user-specified image format
1437  * \param type  the user-specified image datatype
1438  * \param swapBytes  typically the current pixel pack/unpack byteswap state
1439  * \param[out] error GL_NO_ERROR if format is an expected input.
1440  *                   GL_INVALID_ENUM if format is an unexpected input.
1441  * \return true if the formats match, false otherwise.
1442  */
1443 bool
_mesa_format_matches_format_and_type(mesa_format mformat,GLenum format,GLenum type,bool swapBytes,GLenum * error)1444 _mesa_format_matches_format_and_type(mesa_format mformat,
1445 				     GLenum format, GLenum type,
1446 				     bool swapBytes, GLenum *error)
1447 {
1448    if (error)
1449       *error = GL_NO_ERROR;
1450 
1451    if (_mesa_is_format_compressed(mformat)) {
1452       if (error)
1453          *error = GL_INVALID_ENUM;
1454       return false;
1455    }
1456 
1457    if (swapBytes && !_mesa_swap_bytes_in_type_enum(&type))
1458       return false;
1459 
1460    /* format/type don't include srgb and should match regardless of it. */
1461    mformat = _mesa_get_srgb_format_linear(mformat);
1462 
1463    /* intensity formats are uploaded with GL_RED, and we want to find
1464     * memcpy matches for them.
1465     */
1466    mformat = _mesa_get_intensity_format_red(mformat);
1467 
1468    if (format == GL_COLOR_INDEX)
1469       return false;
1470 
1471    mesa_format other_format = _mesa_format_from_format_and_type(format, type);
1472    if (_mesa_format_is_mesa_array_format(other_format))
1473       other_format = _mesa_format_from_array_format(other_format);
1474 
1475    return other_format == mformat;
1476 }
1477 
1478