src/gallium/state_trackers/wgl/stw_pixelformat.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 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 #include "main/mtypes.h"
  29 #include "main/context.h"
  30
  31 #include "pipe/p_format.h"
  32 #include "pipe/p_defines.h"
  33 #include "pipe/p_screen.h"
  34
  35 #include "util/u_format.h"
  36 #include "util/u_debug.h"
  37
  38 #include "stw_icd.h"
  39 #include "stw_device.h"
  40 #include "stw_pixelformat.h"
  41 #include "stw_tls.h"
  42
  43
  44 struct stw_pf_color_info
  45 {
  46    enum pipe_format format;
  47    struct {
  48       unsigned char red;
  49       unsigned char green;
  50       unsigned char blue;
  51       unsigned char alpha;
  52    } bits;
  53    struct {
  54       unsigned char red;
  55       unsigned char green;
  56       unsigned char blue;
  57       unsigned char alpha;
  58    } shift;
  59 };
  60
  61 struct stw_pf_depth_info
  62 {
  63    enum pipe_format format;
  64    struct {
  65       unsigned char depth;
  66       unsigned char stencil;
  67    } bits;
  68 };
  69
  70
  71 /* NOTE: order matters, since in otherwise equal circumstances the first
  72  * format listed will get chosen */
  73
  74 static const struct stw_pf_color_info
  75 stw_pf_color[] = {
  76    /* no-alpha */
  77    { PIPE_FORMAT_B8G8R8X8_UNORM,    { 8,  8,  8,  0}, {16,  8,  0,  0} },
  78    { PIPE_FORMAT_X8R8G8B8_UNORM,    { 8,  8,  8,  0}, { 8, 16, 24,  0} },
  79    { PIPE_FORMAT_B5G6R5_UNORM,      { 5,  6,  5,  0}, {11,  5,  0,  0} },
  80    /* alpha */
  81    { PIPE_FORMAT_B8G8R8A8_UNORM,    { 8,  8,  8,  8}, {16,  8,  0, 24} },
  82    { PIPE_FORMAT_A8R8G8B8_UNORM,    { 8,  8,  8,  8}, { 8, 16, 24,  0} },
  83 #if 0
  84    { PIPE_FORMAT_R10G10B10A2_UNORM, {10, 10, 10,  2}, { 0, 10, 20, 30} },
  85 #endif
  86    { PIPE_FORMAT_B5G5R5A1_UNORM,    { 5,  5,  5,  1}, {10,  5,  0, 15} },
  87    { PIPE_FORMAT_B4G4R4A4_UNORM,    { 4,  4,  4,  4}, {16,  4,  0, 12} }
  88 };
  89
  90
  91 static const struct stw_pf_depth_info
  92 stw_pf_depth_stencil[] = {
  93    /* pure depth */
  94    { PIPE_FORMAT_Z32_UNORM,   {32, 0} },
  95    { PIPE_FORMAT_X8Z24_UNORM, {24, 0} },
  96    { PIPE_FORMAT_Z24X8_UNORM, {24, 0} },
  97    { PIPE_FORMAT_Z16_UNORM,   {16, 0} },
  98    /* combined depth-stencil */
  99    { PIPE_FORMAT_Z24_UNORM_S8_USCALED, {24, 8} },
 100    { PIPE_FORMAT_S8_USCALED_Z24_UNORM, {24, 8} }
 101 };
 102
 103
 104 static const boolean
 105 stw_pf_doublebuffer[] = {
 106    FALSE,
 107    TRUE,
 108 };
 109
 110
 111 const unsigned
 112 stw_pf_multisample[] = {
 113    0,
 114    4
 115 };
 116
 117
 118 static void
 119 stw_pixelformat_add(
 120    struct stw_device *stw_dev,
 121    const struct stw_pf_color_info *color,
 122    const struct stw_pf_depth_info *depth,
 123    unsigned accum,
 124    boolean doublebuffer,
 125    unsigned samples )
 126 {
 127    boolean extended = FALSE;
 128    struct stw_pixelformat_info *pfi;
 129
 130    assert(stw_dev->pixelformat_extended_count < STW_MAX_PIXELFORMATS);
 131    if(stw_dev->pixelformat_extended_count >= STW_MAX_PIXELFORMATS)
 132       return;
 133
 134    assert(util_format_get_component_bits(color->format, UTIL_FORMAT_COLORSPACE_RGB, 0) == color->bits.red);
 135    assert(util_format_get_component_bits(color->format, UTIL_FORMAT_COLORSPACE_RGB, 1) == color->bits.green);
 136    assert(util_format_get_component_bits(color->format, UTIL_FORMAT_COLORSPACE_RGB, 2) == color->bits.blue);
 137    assert(util_format_get_component_bits(color->format, UTIL_FORMAT_COLORSPACE_RGB, 3) == color->bits.alpha);
 138    assert(util_format_get_component_bits(depth->format, UTIL_FORMAT_COLORSPACE_ZS, 0) == depth->bits.depth);
 139    assert(util_format_get_component_bits(depth->format, UTIL_FORMAT_COLORSPACE_ZS, 1) == depth->bits.stencil);
 140
 141    pfi = &stw_dev->pixelformats[stw_dev->pixelformat_extended_count];
 142
 143    memset(pfi, 0, sizeof *pfi);
 144
 145    pfi->pfd.nSize = sizeof pfi->pfd;
 146    pfi->pfd.nVersion = 1;
 147
 148    pfi->pfd.dwFlags = PFD_SUPPORT_OPENGL;
 149
 150    /* TODO: also support non-native pixel formats */
 151    pfi->pfd.dwFlags |= PFD_DRAW_TO_WINDOW;
 152
 153    /* See http://www.opengl.org/pipeline/article/vol003_7/ */
 154    pfi->pfd.dwFlags |= PFD_SUPPORT_COMPOSITION;
 155
 156    if (doublebuffer)
 157       pfi->pfd.dwFlags |= PFD_DOUBLEBUFFER | PFD_SWAP_COPY;
 158
 159    pfi->pfd.iPixelType = PFD_TYPE_RGBA;
 160
 161    pfi->pfd.cColorBits = color->bits.red + color->bits.green + color->bits.blue + color->bits.alpha;
 162    pfi->pfd.cRedBits = color->bits.red;
 163    pfi->pfd.cRedShift = color->shift.red;
 164    pfi->pfd.cGreenBits = color->bits.green;
 165    pfi->pfd.cGreenShift = color->shift.green;
 166    pfi->pfd.cBlueBits = color->bits.blue;
 167    pfi->pfd.cBlueShift = color->shift.blue;
 168    pfi->pfd.cAlphaBits = color->bits.alpha;
 169    pfi->pfd.cAlphaShift = color->shift.alpha;
 170    pfi->pfd.cAccumBits = 4*accum;
 171    pfi->pfd.cAccumRedBits = accum;
 172    pfi->pfd.cAccumGreenBits = accum;
 173    pfi->pfd.cAccumBlueBits = accum;
 174    pfi->pfd.cAccumAlphaBits = accum;
 175    pfi->pfd.cDepthBits = depth->bits.depth;
 176    pfi->pfd.cStencilBits = depth->bits.stencil;
 177    pfi->pfd.cAuxBuffers = 0;
 178    pfi->pfd.iLayerType = 0;
 179    pfi->pfd.bReserved = 0;
 180    pfi->pfd.dwLayerMask = 0;
 181    pfi->pfd.dwVisibleMask = 0;
 182    pfi->pfd.dwDamageMask = 0;
 183
 184    /*
 185     * since state trackers can allocate depth/stencil/accum buffers, we provide
 186     * only color buffers here
 187     */
 188    pfi->stvis.buffer_mask = ST_ATTACHMENT_FRONT_LEFT_MASK;
 189    if (doublebuffer)
 190       pfi->stvis.buffer_mask = ST_ATTACHMENT_BACK_LEFT_MASK;
 191
 192    pfi->stvis.color_format = color->format;
 193    pfi->stvis.depth_stencil_format = depth->format;
 194
 195    pfi->stvis.accum_format = (accum) ?
 196       PIPE_FORMAT_R16G16B16A16_SNORM : PIPE_FORMAT_NONE;
 197
 198    pfi->stvis.samples = samples;
 199    pfi->stvis.render_buffer = ST_ATTACHMENT_INVALID;
 200
 201    ++stw_dev->pixelformat_extended_count;
 202
 203    if(!extended) {
 204       ++stw_dev->pixelformat_count;
 205       assert(stw_dev->pixelformat_count == stw_dev->pixelformat_extended_count);
 206    }
 207 }
 208
 209 void
 210 stw_pixelformat_init( void )
 211 {
 212    struct pipe_screen *screen = stw_dev->screen;
 213    unsigned i, j, k, l;
 214
 215    assert( !stw_dev->pixelformat_count );
 216    assert( !stw_dev->pixelformat_extended_count );
 217
 218    for(i = 0; i < Elements(stw_pf_multisample); ++i) {
 219       unsigned samples = stw_pf_multisample[i];
 220
 221       /* FIXME: re-enabled MSAA when we can query it */
 222       if(samples)
 223          continue;
 224
 225       for(j = 0; j < Elements(stw_pf_color); ++j) {
 226          const struct stw_pf_color_info *color = &stw_pf_color[j];
 227
 228          if(!screen->is_format_supported(screen, color->format, PIPE_TEXTURE_2D,
 229                                          0, PIPE_BIND_RENDER_TARGET |
 230                                          PIPE_BIND_DISPLAY_TARGET, 0))
 231             continue;
 232
 233          for(k = 0; k < Elements(stw_pf_doublebuffer); ++k) {
 234             unsigned doublebuffer = stw_pf_doublebuffer[k];
 235
 236             for(l = 0; l < Elements(stw_pf_depth_stencil); ++l) {
 237                const struct stw_pf_depth_info *depth = &stw_pf_depth_stencil[l];
 238
 239                if(!screen->is_format_supported(screen, depth->format, PIPE_TEXTURE_2D,
 240                                                0, PIPE_BIND_DEPTH_STENCIL, 0))
 241                   continue;
 242
 243                stw_pixelformat_add( stw_dev, color, depth,  0, doublebuffer, samples );
 244                stw_pixelformat_add( stw_dev, color, depth, 16, doublebuffer, samples );
 245             }
 246          }
 247       }
 248    }
 249
 250    assert( stw_dev->pixelformat_count <= stw_dev->pixelformat_extended_count );
 251    assert( stw_dev->pixelformat_extended_count <= STW_MAX_PIXELFORMATS );
 252 }
 253
 254 uint
 255 stw_pixelformat_get_count( void )
 256 {
 257    return stw_dev->pixelformat_count;
 258 }
 259
 260 uint
 261 stw_pixelformat_get_extended_count( void )
 262 {
 263    return stw_dev->pixelformat_extended_count;
 264 }
 265
 266 const struct stw_pixelformat_info *
 267 stw_pixelformat_get_info( uint index )
 268 {
 269    assert( index < stw_dev->pixelformat_extended_count );
 270
 271    return &stw_dev->pixelformats[index];
 272 }
 273
 274
 275 LONG APIENTRY
 276 DrvDescribePixelFormat(
 277    HDC hdc,
 278    INT iPixelFormat,
 279    ULONG cjpfd,
 280    PIXELFORMATDESCRIPTOR *ppfd )
 281 {
 282    uint count;
 283    uint index;
 284    const struct stw_pixelformat_info *pfi;
 285
 286    (void) hdc;
 287
 288    if (!stw_dev)
 289       return 0;
 290
 291    count = stw_pixelformat_get_extended_count();
 292    index = (uint) iPixelFormat - 1;
 293
 294    if (ppfd == NULL)
 295       return count;
 296    if (index >= count || cjpfd != sizeof( PIXELFORMATDESCRIPTOR ))
 297       return 0;
 298
 299    pfi = stw_pixelformat_get_info( index );
 300
 301    memcpy(ppfd, &pfi->pfd, sizeof( PIXELFORMATDESCRIPTOR ));
 302
 303    return count;
 304 }
 305
 306 BOOL APIENTRY
 307 DrvDescribeLayerPlane(
 308    HDC hdc,
 309    INT iPixelFormat,
 310    INT iLayerPlane,
 311    UINT nBytes,
 312    LPLAYERPLANEDESCRIPTOR plpd )
 313 {
 314    assert(0);
 315    return FALSE;
 316 }
 317
 318 int APIENTRY
 319 DrvGetLayerPaletteEntries(
 320    HDC hdc,
 321    INT iLayerPlane,
 322    INT iStart,
 323    INT cEntries,
 324    COLORREF *pcr )
 325 {
 326    assert(0);
 327    return 0;
 328 }
 329
 330 int APIENTRY
 331 DrvSetLayerPaletteEntries(
 332    HDC hdc,
 333    INT iLayerPlane,
 334    INT iStart,
 335    INT cEntries,
 336    CONST COLORREF *pcr )
 337 {
 338    assert(0);
 339    return 0;
 340 }
 341
 342 BOOL APIENTRY
 343 DrvRealizeLayerPalette(
 344    HDC hdc,
 345    INT iLayerPlane,
 346    BOOL bRealize )
 347 {
 348    assert(0);
 349    return FALSE;
 350 }
 351
 352 /* Only used by the wgl code, but have it here to avoid exporting the
 353  * pixelformat.h functionality.
 354  */
 355 int stw_pixelformat_choose( HDC hdc,
 356                             CONST PIXELFORMATDESCRIPTOR *ppfd )
 357 {
 358    uint count;
 359    uint index;
 360    uint bestindex;
 361    uint bestdelta;
 362
 363    (void) hdc;
 364
 365    count = stw_pixelformat_get_count();
 366    bestindex = count;
 367    bestdelta = ~0U;
 368
 369    for (index = 0; index < count; index++) {
 370       uint delta = 0;
 371       const struct stw_pixelformat_info *pfi = stw_pixelformat_get_info( index );
 372
 373       if (!(ppfd->dwFlags & PFD_DOUBLEBUFFER_DONTCARE) &&
 374           !!(ppfd->dwFlags & PFD_DOUBLEBUFFER) !=
 375           !!(pfi->pfd.dwFlags & PFD_DOUBLEBUFFER))
 376          continue;
 377
 378       /* FIXME: Take in account individual channel bits */
 379       if (ppfd->cColorBits != pfi->pfd.cColorBits)
 380          delta += 8;
 381
 382       if (ppfd->cDepthBits != pfi->pfd.cDepthBits)
 383          delta += 4;
 384
 385       if (ppfd->cStencilBits != pfi->pfd.cStencilBits)
 386          delta += 2;
 387
 388       if (ppfd->cAlphaBits != pfi->pfd.cAlphaBits)
 389          delta++;
 390
 391       if (delta < bestdelta) {
 392          bestindex = index;
 393          bestdelta = delta;
 394          if (bestdelta == 0)
 395             break;
 396       }
 397    }
 398
 399    if (bestindex == count)
 400       return 0;
 401
 402    return bestindex + 1;
 403 }