src/mesa/state_tracker/st_format.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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 /**
  30  * Texture Image-related functions.
  31  * \author Brian Paul
  32  */
  33
  34 #include "main/imports.h"
  35 #include "main/context.h"
  36 #include "main/texstore.h"
  37 #include "main/texformat.h"
  38 #include "main/enums.h"
  39 #include "main/macros.h"
  40
  41 #include "pipe/p_context.h"
  42 #include "pipe/p_defines.h"
  43 #include "pipe/p_screen.h"
  44 #include "st_context.h"
  45 #include "st_format.h"
  46
  47 static GLuint
  48 format_bits(
  49    pipe_format_rgbazs_t  info,
  50    GLuint comp )
  51 {
  52    GLuint   size;
  53
  54    if (pf_swizzle_x(info) == comp) {
  55       size = pf_size_x(info);
  56    }
  57    else if (pf_swizzle_y(info) == comp) {
  58       size = pf_size_y(info);
  59    }
  60    else if (pf_swizzle_z(info) == comp) {
  61       size = pf_size_z(info);
  62    }
  63    else if (pf_swizzle_w(info) == comp) {
  64       size = pf_size_w(info);
  65    }
  66    else {
  67       size = 0;
  68    }
  69    return size << (pf_exp8(info) * 3);
  70 }
  71
  72 static GLuint
  73 format_max_bits(
  74    pipe_format_rgbazs_t  info )
  75 {
  76    GLuint   size = format_bits( info, PIPE_FORMAT_COMP_R );
  77
  78    size = MAX2( size, format_bits( info, PIPE_FORMAT_COMP_G ) );
  79    size = MAX2( size, format_bits( info, PIPE_FORMAT_COMP_B ) );
  80    size = MAX2( size, format_bits( info, PIPE_FORMAT_COMP_A ) );
  81    size = MAX2( size, format_bits( info, PIPE_FORMAT_COMP_Z ) );
  82    size = MAX2( size, format_bits( info, PIPE_FORMAT_COMP_S ) );
  83    return size;
  84 }
  85
  86 static GLuint
  87 format_size(
  88    pipe_format_rgbazs_t  info )
  89 {
  90    return
  91       format_bits( info, PIPE_FORMAT_COMP_R ) +
  92       format_bits( info, PIPE_FORMAT_COMP_G ) +
  93       format_bits( info, PIPE_FORMAT_COMP_B ) +
  94       format_bits( info, PIPE_FORMAT_COMP_A ) +
  95       format_bits( info, PIPE_FORMAT_COMP_Z ) +
  96       format_bits( info, PIPE_FORMAT_COMP_S );
  97 }
  98
  99 /*
 100  * XXX temporary here
 101  */
 102 GLboolean
 103 st_get_format_info(enum pipe_format format, struct pipe_format_info *pinfo)
 104 {
 105    if (pf_layout(format) == PIPE_FORMAT_LAYOUT_RGBAZS) {
 106       pipe_format_rgbazs_t info;
 107
 108       info = format;
 109
 110 #if 0
 111       {
 112          char  fmtname[256];
 113
 114          pf_sprint_name( fmtname, format );
 115          printf(
 116             "%s\n",
 117             fmtname );
 118       }
 119 #endif
 120
 121       /* Data type */
 122       if (format == PIPE_FORMAT_A1R5G5B5_UNORM || format == PIPE_FORMAT_R5G6B5_UNORM) {
 123          pinfo->datatype = GL_UNSIGNED_SHORT;
 124       }
 125       else {
 126          GLuint size;
 127
 128          size = format_max_bits( info );
 129          if (size == 8) {
 130             if (pf_type(info) == PIPE_FORMAT_TYPE_UNORM)
 131                pinfo->datatype = GL_UNSIGNED_BYTE;
 132             else
 133                pinfo->datatype = GL_BYTE;
 134          }
 135          else if (size == 16) {
 136             if (pf_type(info) == PIPE_FORMAT_TYPE_UNORM)
 137                pinfo->datatype = GL_UNSIGNED_SHORT;
 138             else
 139                pinfo->datatype = GL_SHORT;
 140          }
 141          else {
 142             assert( size <= 32 );
 143             if (pf_type(info) == PIPE_FORMAT_TYPE_UNORM)
 144                pinfo->datatype = GL_UNSIGNED_INT;
 145             else
 146                pinfo->datatype = GL_INT;
 147          }
 148       }
 149
 150       /* Component bits */
 151       pinfo->red_bits = format_bits( info, PIPE_FORMAT_COMP_R );
 152       pinfo->green_bits = format_bits( info, PIPE_FORMAT_COMP_G );
 153       pinfo->blue_bits = format_bits( info, PIPE_FORMAT_COMP_B );
 154       pinfo->alpha_bits = format_bits( info, PIPE_FORMAT_COMP_A );
 155       pinfo->depth_bits = format_bits( info, PIPE_FORMAT_COMP_Z );
 156       pinfo->stencil_bits = format_bits( info, PIPE_FORMAT_COMP_S );
 157       pinfo->luminance_bits = 0;
 158       pinfo->intensity_bits = 0;
 159
 160       /* Format size */
 161       pinfo->size = format_size( info ) / 8;
 162
 163       /* Luminance & Intensity bits */
 164       if( pf_swizzle_x(info) == PIPE_FORMAT_COMP_R &&
 165           pf_swizzle_y(info) == PIPE_FORMAT_COMP_R &&
 166           pf_swizzle_z(info) == PIPE_FORMAT_COMP_R ) {
 167          if( pf_swizzle_w(info) == PIPE_FORMAT_COMP_R ) {
 168             pinfo->intensity_bits = pinfo->red_bits;
 169          }
 170          else {
 171             pinfo->luminance_bits = pinfo->red_bits;
 172          }
 173          pinfo->red_bits = 0;
 174       }
 175
 176       /* Base format */
 177       if (pinfo->depth_bits) {
 178          if (pinfo->stencil_bits) {
 179             pinfo->base_format = GL_DEPTH_STENCIL_EXT;
 180          }
 181          else {
 182             pinfo->base_format = GL_DEPTH_COMPONENT;
 183          }
 184       }
 185       else if (pinfo->stencil_bits) {
 186          pinfo->base_format = GL_STENCIL_INDEX;
 187       }
 188       else {
 189          pinfo->base_format = GL_RGBA;
 190       }
 191    }
 192    else {
 193       pipe_format_ycbcr_t info;
 194
 195       assert( pf_layout(format) == PIPE_FORMAT_LAYOUT_YCBCR );
 196
 197       info = format;
 198
 199       /* TODO */
 200       assert( 0 );
 201    }
 202
 203 #if 0
 204    printf(
 205       "ST_FORMAT: R(%u), G(%u), B(%u), A(%u), Z(%u), S(%u)\n",
 206       pinfo->red_bits,
 207       pinfo->green_bits,
 208       pinfo->blue_bits,
 209       pinfo->alpha_bits,
 210       pinfo->depth_bits,
 211       pinfo->stencil_bits );
 212 #endif
 213
 214    pinfo->format = format;
 215
 216    return GL_TRUE;
 217 }
 218
 219
 220 /**
 221  * Return bytes per pixel for the given format.
 222  */
 223 GLuint
 224 st_sizeof_format(enum pipe_format format)
 225 {
 226    struct pipe_format_info info;
 227    if (!st_get_format_info( format, &info )) {
 228       assert( 0 );
 229       return 0;
 230    }
 231    return info.size;
 232 }
 233
 234
 235 /**
 236  * Return bytes per pixel for the given format.
 237  */
 238 GLenum
 239 st_format_datatype(enum pipe_format format)
 240 {
 241    struct pipe_format_info info;
 242    if (!st_get_format_info( format, &info )) {
 243       assert( 0 );
 244       return 0;
 245    }
 246    return info.datatype;
 247 }
 248
 249
 250 enum pipe_format
 251 st_mesa_format_to_pipe_format(GLuint mesaFormat)
 252 {
 253    switch (mesaFormat) {
 254       /* fix this */
 255    case MESA_FORMAT_ARGB8888_REV:
 256    case MESA_FORMAT_ARGB8888:
 257       return PIPE_FORMAT_A8R8G8B8_UNORM;
 258    case MESA_FORMAT_ARGB1555:
 259       return PIPE_FORMAT_A1R5G5B5_UNORM;
 260    case MESA_FORMAT_ARGB4444:
 261       return PIPE_FORMAT_A4R4G4B4_UNORM;
 262    case MESA_FORMAT_RGB565:
 263       return PIPE_FORMAT_R5G6B5_UNORM;
 264    case MESA_FORMAT_AL88:
 265       return PIPE_FORMAT_U_A8_L8;
 266    case MESA_FORMAT_A8:
 267       return PIPE_FORMAT_U_A8;
 268    case MESA_FORMAT_L8:
 269       return PIPE_FORMAT_U_L8;
 270    case MESA_FORMAT_I8:
 271       return PIPE_FORMAT_U_I8;
 272    case MESA_FORMAT_Z16:
 273       return PIPE_FORMAT_Z16_UNORM;
 274    case MESA_FORMAT_Z32:
 275       return PIPE_FORMAT_Z32_UNORM;
 276    case MESA_FORMAT_Z24_S8:
 277       return PIPE_FORMAT_Z24S8_UNORM;
 278    default:
 279       assert(0);
 280       return 0;
 281    }
 282 }
 283
 284 /**
 285  * Find an RGBA format supported by the context/winsys.
 286  */
 287 static GLuint
 288 default_rgba_format(struct pipe_screen *screen, uint type)
 289 {
 290    static const enum pipe_format colorFormats[] = {
 291       PIPE_FORMAT_A8R8G8B8_UNORM,
 292       PIPE_FORMAT_B8G8R8A8_UNORM,
 293       PIPE_FORMAT_R8G8B8A8_UNORM,
 294       PIPE_FORMAT_R5G6B5_UNORM
 295    };
 296    uint i;
 297    for (i = 0; i < Elements(colorFormats); i++) {
 298       if (screen->is_format_supported( screen, colorFormats[i], type )) {
 299          return colorFormats[i];
 300       }
 301    }
 302    return PIPE_FORMAT_NONE;
 303 }
 304
 305
 306 /**
 307  * Search list of formats for first RGBA format with >8 bits/channel.
 308  */
 309 static GLuint
 310 default_deep_rgba_format(struct pipe_screen *screen, uint type)
 311 {
 312    if (screen->is_format_supported(screen, PIPE_FORMAT_R16G16B16A16_SNORM, type)) {
 313       return PIPE_FORMAT_R16G16B16A16_SNORM;
 314    }
 315    return PIPE_FORMAT_NONE;
 316 }
 317
 318
 319 /**
 320  * Find an Z format supported by the context/winsys.
 321  */
 322 static GLuint
 323 default_depth_format(struct pipe_screen *screen, uint type)
 324 {
 325    static const enum pipe_format zFormats[] = {
 326       PIPE_FORMAT_Z16_UNORM,
 327       PIPE_FORMAT_Z32_UNORM,
 328       PIPE_FORMAT_S8Z24_UNORM,
 329       PIPE_FORMAT_Z24S8_UNORM
 330    };
 331    uint i;
 332    for (i = 0; i < Elements(zFormats); i++) {
 333       if (screen->is_format_supported( screen, zFormats[i], type )) {
 334          return zFormats[i];
 335       }
 336    }
 337    return PIPE_FORMAT_NONE;
 338 }
 339
 340
 341 /**
 342  * Given an OpenGL internalFormat value for a texture or surface, return
 343  * the best matching PIPE_FORMAT_x, or PIPE_FORMAT_NONE if there's no match.
 344  */
 345 static enum pipe_format
 346 choose_format(struct pipe_context *pipe, GLint internalFormat, uint surfType)
 347 {
 348    struct pipe_screen *screen = pipe->screen;
 349
 350    assert(surfType == PIPE_SURFACE ||
 351           surfType == PIPE_TEXTURE);
 352
 353    switch (internalFormat) {
 354    case 4:
 355    case GL_RGBA:
 356    case GL_COMPRESSED_RGBA:
 357    case 3:
 358    case GL_RGB:
 359    case GL_COMPRESSED_RGB:
 360    case GL_RGBA8:
 361    case GL_RGB10_A2:
 362    case GL_RGBA12:
 363       return default_rgba_format( screen, surfType );
 364    case GL_RGBA16:
 365       return default_deep_rgba_format( screen, surfType );
 366
 367    case GL_RGBA4:
 368    case GL_RGBA2:
 369       if (screen->is_format_supported( screen, PIPE_FORMAT_A4R4G4B4_UNORM, surfType ))
 370          return PIPE_FORMAT_A4R4G4B4_UNORM;
 371       return default_rgba_format( screen, surfType );
 372
 373    case GL_RGB5_A1:
 374       if (screen->is_format_supported( screen, PIPE_FORMAT_A1R5G5B5_UNORM, surfType ))
 375          return PIPE_FORMAT_A1R5G5B5_UNORM;
 376       return default_rgba_format( screen, surfType );
 377
 378    case GL_RGB8:
 379    case GL_RGB10:
 380    case GL_RGB12:
 381    case GL_RGB16:
 382       return default_rgba_format( screen, surfType );
 383
 384    case GL_RGB5:
 385    case GL_RGB4:
 386    case GL_R3_G3_B2:
 387       if (screen->is_format_supported( screen, PIPE_FORMAT_A1R5G5B5_UNORM, surfType ))
 388          return PIPE_FORMAT_A1R5G5B5_UNORM;
 389       if (screen->is_format_supported( screen, PIPE_FORMAT_R5G6B5_UNORM, surfType ))
 390          return PIPE_FORMAT_R5G6B5_UNORM;
 391       return default_rgba_format( screen, surfType );
 392
 393    case GL_ALPHA:
 394    case GL_ALPHA4:
 395    case GL_ALPHA8:
 396    case GL_ALPHA12:
 397    case GL_ALPHA16:
 398    case GL_COMPRESSED_ALPHA:
 399       if (screen->is_format_supported( screen, PIPE_FORMAT_U_A8, surfType ))
 400          return PIPE_FORMAT_U_A8;
 401       return default_rgba_format( screen, surfType );
 402
 403    case 1:
 404    case GL_LUMINANCE:
 405    case GL_LUMINANCE4:
 406    case GL_LUMINANCE8:
 407    case GL_LUMINANCE12:
 408    case GL_LUMINANCE16:
 409    case GL_COMPRESSED_LUMINANCE:
 410       if (screen->is_format_supported( screen, PIPE_FORMAT_U_L8, surfType ))
 411          return PIPE_FORMAT_U_L8;
 412       return default_rgba_format( screen, surfType );
 413
 414    case 2:
 415    case GL_LUMINANCE_ALPHA:
 416    case GL_LUMINANCE4_ALPHA4:
 417    case GL_LUMINANCE6_ALPHA2:
 418    case GL_LUMINANCE8_ALPHA8:
 419    case GL_LUMINANCE12_ALPHA4:
 420    case GL_LUMINANCE12_ALPHA12:
 421    case GL_LUMINANCE16_ALPHA16:
 422    case GL_COMPRESSED_LUMINANCE_ALPHA:
 423       if (screen->is_format_supported( screen, PIPE_FORMAT_U_A8_L8, surfType ))
 424          return PIPE_FORMAT_U_A8_L8;
 425       return default_rgba_format( screen, surfType );
 426
 427    case GL_INTENSITY:
 428    case GL_INTENSITY4:
 429    case GL_INTENSITY8:
 430    case GL_INTENSITY12:
 431    case GL_INTENSITY16:
 432    case GL_COMPRESSED_INTENSITY:
 433       if (screen->is_format_supported( screen, PIPE_FORMAT_U_I8, surfType ))
 434          return PIPE_FORMAT_U_I8;
 435       return default_rgba_format( screen, surfType );
 436
 437    case GL_YCBCR_MESA:
 438       return PIPE_FORMAT_NONE;
 439
 440    case GL_RGB_S3TC:
 441    case GL_RGB4_S3TC:
 442    case GL_COMPRESSED_RGB_S3TC_DXT1_EXT:
 443       return PIPE_FORMAT_DXT1_RGB;
 444
 445    case GL_COMPRESSED_RGBA_S3TC_DXT1_EXT:
 446       return PIPE_FORMAT_DXT1_RGBA;
 447
 448    case GL_RGBA_S3TC:
 449    case GL_RGBA4_S3TC:
 450    case GL_COMPRESSED_RGBA_S3TC_DXT3_EXT:
 451       return PIPE_FORMAT_DXT3_RGBA;
 452
 453    case GL_COMPRESSED_RGBA_S3TC_DXT5_EXT:
 454       return PIPE_FORMAT_DXT5_RGBA;
 455
 456 #if 0
 457    case GL_COMPRESSED_RGB_FXT1_3DFX:
 458       return PIPE_FORMAT_RGB_FXT1;
 459    case GL_COMPRESSED_RGBA_FXT1_3DFX:
 460       return PIPE_FORMAT_RGB_FXT1;
 461 #endif
 462
 463    case GL_DEPTH_COMPONENT16:
 464       if (screen->is_format_supported( screen, PIPE_FORMAT_Z16_UNORM, surfType ))
 465          return PIPE_FORMAT_Z16_UNORM;
 466       /* fall-through */
 467    case GL_DEPTH_COMPONENT24:
 468       if (screen->is_format_supported( screen, PIPE_FORMAT_S8Z24_UNORM, surfType ))
 469          return PIPE_FORMAT_S8Z24_UNORM;
 470       if (screen->is_format_supported( screen, PIPE_FORMAT_Z24S8_UNORM, surfType ))
 471          return PIPE_FORMAT_Z24S8_UNORM;
 472       /* fall-through */
 473    case GL_DEPTH_COMPONENT32:
 474       if (screen->is_format_supported( screen, PIPE_FORMAT_Z32_UNORM, surfType ))
 475          return PIPE_FORMAT_Z32_UNORM;
 476       /* fall-through */
 477    case GL_DEPTH_COMPONENT:
 478       return default_depth_format( screen, surfType );
 479
 480    case GL_STENCIL_INDEX:
 481    case GL_STENCIL_INDEX1_EXT:
 482    case GL_STENCIL_INDEX4_EXT:
 483    case GL_STENCIL_INDEX8_EXT:
 484    case GL_STENCIL_INDEX16_EXT:
 485       if (screen->is_format_supported( screen, PIPE_FORMAT_U_S8, surfType ))
 486          return PIPE_FORMAT_U_S8;
 487       if (screen->is_format_supported( screen, PIPE_FORMAT_S8Z24_UNORM, surfType ))
 488          return PIPE_FORMAT_S8Z24_UNORM;
 489       if (screen->is_format_supported( screen, PIPE_FORMAT_Z24S8_UNORM, surfType ))
 490          return PIPE_FORMAT_Z24S8_UNORM;
 491       return PIPE_FORMAT_NONE;
 492
 493    case GL_DEPTH_STENCIL_EXT:
 494    case GL_DEPTH24_STENCIL8_EXT:
 495       if (screen->is_format_supported( screen, PIPE_FORMAT_S8Z24_UNORM, surfType ))
 496          return PIPE_FORMAT_S8Z24_UNORM;
 497       if (screen->is_format_supported( screen, PIPE_FORMAT_Z24S8_UNORM, surfType ))
 498          return PIPE_FORMAT_Z24S8_UNORM;
 499       return PIPE_FORMAT_NONE;
 500
 501    default:
 502       return PIPE_FORMAT_NONE;
 503    }
 504 }
 505
 506
 507 /**
 508  * Called by FBO code to choose a PIPE_FORMAT_ for drawing surfaces.
 509  */
 510 enum pipe_format
 511 st_choose_renderbuffer_format(struct pipe_context *pipe, GLint internalFormat)
 512 {
 513    return choose_format(pipe, internalFormat, PIPE_SURFACE);
 514 }
 515
 516
 517 static const struct gl_texture_format *
 518 translate_gallium_format_to_mesa_format(enum pipe_format format)
 519 {
 520    switch (format) {
 521    case PIPE_FORMAT_A8R8G8B8_UNORM:
 522       return &_mesa_texformat_argb8888;
 523    case PIPE_FORMAT_A1R5G5B5_UNORM:
 524       return &_mesa_texformat_argb1555;
 525    case PIPE_FORMAT_A4R4G4B4_UNORM:
 526       return &_mesa_texformat_argb4444;
 527    case PIPE_FORMAT_R5G6B5_UNORM:
 528       return &_mesa_texformat_rgb565;
 529    case PIPE_FORMAT_U_A8_L8:
 530       return &_mesa_texformat_al88;
 531    case PIPE_FORMAT_U_A8:
 532       return &_mesa_texformat_a8;
 533    case PIPE_FORMAT_U_L8:
 534       return &_mesa_texformat_l8;
 535    case PIPE_FORMAT_U_I8:
 536       return &_mesa_texformat_i8;
 537    case PIPE_FORMAT_Z16_UNORM:
 538       return &_mesa_texformat_z16;
 539    case PIPE_FORMAT_Z32_UNORM:
 540       return &_mesa_texformat_z32;
 541    case PIPE_FORMAT_S8Z24_UNORM:
 542       /* XXX fallthrough OK? */
 543    case PIPE_FORMAT_Z24S8_UNORM:
 544       return &_mesa_texformat_z24_s8;
 545    case PIPE_FORMAT_YCBCR:
 546       return &_mesa_texformat_ycbcr;
 547    case PIPE_FORMAT_YCBCR_REV:
 548       return &_mesa_texformat_ycbcr_rev;
 549    case PIPE_FORMAT_DXT1_RGB:
 550       return &_mesa_texformat_rgb_dxt1;
 551    case PIPE_FORMAT_DXT1_RGBA:
 552       return &_mesa_texformat_rgba_dxt1;
 553    case PIPE_FORMAT_DXT3_RGBA:
 554       return &_mesa_texformat_rgba_dxt3;
 555    case PIPE_FORMAT_DXT5_RGBA:
 556       return &_mesa_texformat_rgba_dxt5;
 557    /* XXX add additional cases */
 558    default:
 559       assert(0);
 560       return NULL;
 561    }
 562 }
 563
 564
 565 /**
 566  * Called via ctx->Driver.chooseTextureFormat().
 567  */
 568 const struct gl_texture_format *
 569 st_ChooseTextureFormat(GLcontext *ctx, GLint internalFormat,
 570                        GLenum format, GLenum type)
 571 {
 572    enum pipe_format pFormat;
 573
 574    (void) format;
 575    (void) type;
 576
 577    pFormat = choose_format(ctx->st->pipe, internalFormat, PIPE_TEXTURE);
 578    if (pFormat == PIPE_FORMAT_NONE)
 579       return NULL;
 580
 581    return translate_gallium_format_to_mesa_format(pFormat);
 582 }