src/mesa/pipe/p_format.h

   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 #ifndef PIPE_FORMAT_H
  29 #define PIPE_FORMAT_H
  30
  31 #include "p_compiler.h"
  32
  33 /**
  34  * The PIPE_FORMAT is a 32-bit wide bitfield that encodes all the information
  35  * needed to uniquely describe a pixel format.
  36  */
  37
  38 /**
  39  * Possible format layouts -- occupy first 2 bits. The interpretation of
  40  * the remaining 30 bits depends on a particual format layout.
  41  */
  42 #define PIPE_FORMAT_LAYOUT_RGBAZS   0
  43 #define PIPE_FORMAT_LAYOUT_YCBCR    1
  44
  45 static INLINE uint pf_layout(uint f)  /**< PIPE_FORMAT_LAYOUT_ */
  46 {
  47    return f & 0x3;
  48 }
  49
  50 /**
  51  * RGBAZS Format Layout.
  52  */
  53
  54 /**
  55  * Format component selectors for RGBAZS layout.
  56  */
  57 #define PIPE_FORMAT_COMP_R    0
  58 #define PIPE_FORMAT_COMP_G    1
  59 #define PIPE_FORMAT_COMP_B    2
  60 #define PIPE_FORMAT_COMP_A    3
  61 #define PIPE_FORMAT_COMP_0    4
  62 #define PIPE_FORMAT_COMP_1    5
  63 #define PIPE_FORMAT_COMP_Z    6
  64 #define PIPE_FORMAT_COMP_S    7
  65
  66 /**
  67  * Format types for RGBAZS layout.
  68  */
  69 #define PIPE_FORMAT_TYPE_UNKNOWN 0
  70 #define PIPE_FORMAT_TYPE_FLOAT   1
  71 #define PIPE_FORMAT_TYPE_UNORM   2
  72 #define PIPE_FORMAT_TYPE_SNORM   3
  73 #define PIPE_FORMAT_TYPE_USCALED 4
  74 #define PIPE_FORMAT_TYPE_SSCALED 5
  75
  76 /**
  77  * Because the destination vector is assumed to be RGBA FLOAT, we
  78  * need to know how to swizzle and expand components from the source
  79  * vector.
  80  * Let's take U_A1_R5_G5_B5 as an example. X swizzle is A, X size
  81  * is 1 bit and type is UNORM. So we take the most significant bit
  82  * from source vector, convert 0 to 0.0 and 1 to 1.0 and save it
  83  * in the last component of the destination RGBA component.
  84  * Next, Y swizzle is R, Y size is 5 and type is UNORM. We normalize
  85  * those 5 bits into [0.0; 1.0] range and put it into second
  86  * component of the destination vector. Rinse and repeat for
  87  * components Z and W.
  88  * If any of size fields is zero, it means the source format contains
  89  * less than four components.
  90  * If any swizzle is 0 or 1, the corresponding destination component
  91  * should be filled with 0.0 and 1.0, respectively.
  92  */
  93 typedef uint pipe_format_rgbazs_t;
  94
  95 static INLINE uint pf_get(pipe_format_rgbazs_t f, uint shift, uint mask)
  96 {
  97    return (f >> shift) & mask;
  98 }
  99
 100 /* XXX: The bit layout needs to be revised, can't currently encode 10-bit components. */
 101
 102 #define pf_swizzle_x(f)       pf_get(f, 2, 0x7)  /**< PIPE_FORMAT_COMP_ */
 103 #define pf_swizzle_y(f)       pf_get(f, 5, 0x7)  /**< PIPE_FORMAT_COMP_ */
 104 #define pf_swizzle_z(f)       pf_get(f, 8, 0x7)  /**< PIPE_FORMAT_COMP_ */
 105 #define pf_swizzle_w(f)       pf_get(f, 11, 0x7) /**< PIPE_FORMAT_COMP_ */
 106 #define pf_swizzle_xyzw(f,i)  pf_get(f, 2+((i)*3), 0x7)
 107 #define pf_size_x(f)          pf_get(f, 14, 0x7) /**< Size of X */
 108 #define pf_size_y(f)          pf_get(f, 17, 0x7) /**< Size of Y */
 109 #define pf_size_z(f)          pf_get(f, 20, 0x7) /**< Size of Z */
 110 #define pf_size_w(f)          pf_get(f, 23, 0x7) /**< Size of W */
 111 #define pf_size_xyzw(f,i)     pf_get(f, 14+((i)*3), 0x7)
 112 #define pf_exp8(f)            pf_get(f, 26, 0x3) /**< Scale size by 8 ^ exp8 */
 113 #define pf_type(f)            pf_get(f, 28, 0xf) /**< PIPE_FORMAT_TYPE_ */
 114
 115 /**
 116  * Helper macro to encode the above structure into a 32-bit value.
 117  */
 118 #define _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, EXP8, TYPE ) (\
 119    (PIPE_FORMAT_LAYOUT_RGBAZS << 0) |\
 120    ((SWZ) << 2) |\
 121    ((SIZEX) << 14) |\
 122    ((SIZEY) << 17) |\
 123    ((SIZEZ) << 20) |\
 124    ((SIZEW) << 23) |\
 125    ((EXP8) << 26) |\
 126    ((TYPE) << 28) )
 127
 128 /**
 129  * Helper macro to encode the swizzle part of the structure above.
 130  */
 131 #define _PIPE_FORMAT_SWZ( SWZX, SWZY, SWZZ, SWZW ) (((SWZX) << 0) | ((SWZY) << 3) | ((SWZZ) << 6) | ((SWZW) << 9))
 132
 133 /**
 134  * Shorthand macro for RGBAZS layout with component sizes in 1-bit units.
 135  */
 136 #define _PIPE_FORMAT_RGBAZS_1( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
 137    _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 0, TYPE )
 138
 139 /**
 140  * Shorthand macro for RGBAZS layout with component sizes in 8-bit units.
 141  */
 142 #define _PIPE_FORMAT_RGBAZS_8( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
 143    _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 1, TYPE )
 144
 145 /**
 146  * Shorthand macro for RGBAZS layout with component sizes in 64-bit units.
 147  */
 148 #define _PIPE_FORMAT_RGBAZS_64( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
 149    _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 2, TYPE )
 150
 151 /**
 152  * Shorthand macro for common format swizzles.
 153  */
 154 #define _PIPE_FORMAT_R000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 155 #define _PIPE_FORMAT_RG00 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 156 #define _PIPE_FORMAT_RGB0 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_0 )
 157 #define _PIPE_FORMAT_RGBA _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_A )
 158 #define _PIPE_FORMAT_ARGB _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_A, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B )
 159 #define _PIPE_FORMAT_BGRA _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_A )
 160 #define _PIPE_FORMAT_0000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 161 #define _PIPE_FORMAT_000R _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_R )
 162 #define _PIPE_FORMAT_RRR1 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_1 )
 163 #define _PIPE_FORMAT_RRRR _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R )
 164 #define _PIPE_FORMAT_RRRG _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G )
 165 #define _PIPE_FORMAT_Z000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 166 #define _PIPE_FORMAT_SZ00 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_S, PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 167 #define _PIPE_FORMAT_ZS00 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_S, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 168 #define _PIPE_FORMAT_S000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_S, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
 169
 170 /**
 171  * YCBCR Format Layout.
 172  */
 173
 174 /**
 175  * This only contains a flag that indicates whether the format is reversed or
 176  * not.
 177  */
 178 typedef uint pipe_format_ycbcr_t;
 179
 180 /**
 181  * Helper macro to encode the above structure into a 32-bit value.
 182  */
 183 #define _PIPE_FORMAT_YCBCR( REV ) (\
 184    (PIPE_FORMAT_LAYOUT_YCBCR << 0) |\
 185    ((REV) << 2) )
 186
 187 static INLINE uint pf_rev(pipe_format_ycbcr_t f)
 188 {
 189    return (f >> 2) & 0x1;
 190 }
 191
 192 /**
 193  * Texture/surface image formats (preliminary)
 194  */
 195
 196 /* KW: Added lots of surface formats to support vertex element layout
 197  * definitions, and eventually render-to-vertex-buffer.  Could
 198  * consider making float/int/uint/scaled/normalized a separate
 199  * parameter, but on the other hand there are special cases like
 200  * z24s8, compressed textures, ycbcr, etc that won't fit that model.
 201  */
 202
 203 enum pipe_format {
 204    PIPE_FORMAT_NONE                  = _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_0000, 0, 0, 0, 0, PIPE_FORMAT_TYPE_UNKNOWN ),
 205    PIPE_FORMAT_A8R8G8B8_UNORM        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_ARGB, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ),
 206    PIPE_FORMAT_B8G8R8A8_UNORM        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGRA, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ),
 207    PIPE_FORMAT_A1R5G5B5_UNORM        = _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_ARGB, 1, 5, 5, 5, PIPE_FORMAT_TYPE_UNORM ),
 208    PIPE_FORMAT_A4R4G4B4_UNORM        = _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_ARGB, 4, 4, 4, 4, PIPE_FORMAT_TYPE_UNORM ),
 209    PIPE_FORMAT_R5G6B5_UNORM          = _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_RGB0, 5, 6, 5, 0, PIPE_FORMAT_TYPE_UNORM ),
 210    PIPE_FORMAT_U_L8                  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRR1, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ), /**< ubyte luminance */
 211    PIPE_FORMAT_U_A8                  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_000R, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ), /**< ubyte alpha */
 212    PIPE_FORMAT_U_I8                  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRRR, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ), /**< ubyte intensity */
 213    PIPE_FORMAT_U_A8_L8               = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRRG, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ), /**< ubyte alpha, luminance */
 214    PIPE_FORMAT_YCBCR                 = _PIPE_FORMAT_YCBCR( 0 ),
 215    PIPE_FORMAT_YCBCR_REV             = _PIPE_FORMAT_YCBCR( 1 ),
 216    PIPE_FORMAT_Z16_UNORM             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000, 2, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 217    PIPE_FORMAT_Z32_UNORM             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 218    PIPE_FORMAT_Z32_FLOAT             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_FLOAT ),
 219    PIPE_FORMAT_S8Z24_UNORM           = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_SZ00, 1, 3, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 220    PIPE_FORMAT_Z24S8_UNORM           = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_ZS00, 3, 1, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 221    PIPE_FORMAT_S8_UNORM              = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_S000, 1, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM ), /**< ubyte stencil */
 222    PIPE_FORMAT_R64_FLOAT             = _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_R000, 1, 0, 0, 0, PIPE_FORMAT_TYPE_FLOAT ),
 223    PIPE_FORMAT_R64G64_FLOAT          = _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_RG00, 1, 1, 0, 0, PIPE_FORMAT_TYPE_FLOAT ),
 224    PIPE_FORMAT_R64G64B64_FLOAT       = _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_RGB0, 1, 1, 1, 0, PIPE_FORMAT_TYPE_FLOAT ),
 225    PIPE_FORMAT_R64G64B64A64_FLOAT    = _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_RGBA, 1, 1, 1, 1, PIPE_FORMAT_TYPE_FLOAT ),
 226    PIPE_FORMAT_R32_FLOAT             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_FLOAT ),
 227    PIPE_FORMAT_R32G32_FLOAT          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 4, 4, 0, 0, PIPE_FORMAT_TYPE_FLOAT ),
 228    PIPE_FORMAT_R32G32B32_FLOAT       = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 4, 4, 4, 0, PIPE_FORMAT_TYPE_FLOAT ),
 229    PIPE_FORMAT_R32G32B32A32_FLOAT    = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 4, 4, 4, 4, PIPE_FORMAT_TYPE_FLOAT ),
 230    PIPE_FORMAT_R32_UNORM             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 231    PIPE_FORMAT_R32G32_UNORM          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 4, 4, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 232    PIPE_FORMAT_R32G32B32_UNORM       = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 4, 4, 4, 0, PIPE_FORMAT_TYPE_UNORM ),
 233    PIPE_FORMAT_R32G32B32A32_UNORM    = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 4, 4, 4, 4, PIPE_FORMAT_TYPE_UNORM ),
 234    PIPE_FORMAT_R32_USCALED           = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_USCALED ),
 235    PIPE_FORMAT_R32G32_USCALED        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 4, 4, 0, 0, PIPE_FORMAT_TYPE_USCALED ),
 236    PIPE_FORMAT_R32G32B32_USCALED     = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 4, 4, 4, 0, PIPE_FORMAT_TYPE_USCALED ),
 237    PIPE_FORMAT_R32G32B32A32_USCALED  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 4, 4, 4, 4, PIPE_FORMAT_TYPE_USCALED ),
 238    PIPE_FORMAT_R32_SNORM             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_SNORM ),
 239    PIPE_FORMAT_R32G32_SNORM          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 4, 4, 0, 0, PIPE_FORMAT_TYPE_SNORM ),
 240    PIPE_FORMAT_R32G32B32_SNORM       = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 4, 4, 4, 0, PIPE_FORMAT_TYPE_SNORM ),
 241    PIPE_FORMAT_R32G32B32A32_SNORM    = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 4, 4, 4, 4, PIPE_FORMAT_TYPE_SNORM ),
 242    PIPE_FORMAT_R32_SSCALED           = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 4, 0, 0, 0, PIPE_FORMAT_TYPE_SSCALED ),
 243    PIPE_FORMAT_R32G32_SSCALED        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 4, 4, 0, 0, PIPE_FORMAT_TYPE_SSCALED ),
 244    PIPE_FORMAT_R32G32B32_SSCALED     = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 4, 4, 4, 0, PIPE_FORMAT_TYPE_SSCALED ),
 245    PIPE_FORMAT_R32G32B32A32_SSCALED  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 4, 4, 4, 4, PIPE_FORMAT_TYPE_SSCALED ),
 246    PIPE_FORMAT_R16_UNORM             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 2, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 247    PIPE_FORMAT_R16G16_UNORM          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 2, 2, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 248    PIPE_FORMAT_R16G16B16_UNORM       = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 2, 2, 2, 0, PIPE_FORMAT_TYPE_UNORM ),
 249    PIPE_FORMAT_R16G16B16A16_UNORM    = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 2, 2, 2, 2, PIPE_FORMAT_TYPE_UNORM ),
 250    PIPE_FORMAT_R16_USCALED           = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 2, 0, 0, 0, PIPE_FORMAT_TYPE_USCALED ),
 251    PIPE_FORMAT_R16G16_USCALED        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 2, 2, 0, 0, PIPE_FORMAT_TYPE_USCALED ),
 252    PIPE_FORMAT_R16G16B16_USCALED     = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 2, 2, 2, 0, PIPE_FORMAT_TYPE_USCALED ),
 253    PIPE_FORMAT_R16G16B16A16_USCALED  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 2, 2, 2, 2, PIPE_FORMAT_TYPE_USCALED ),
 254    PIPE_FORMAT_R16_SNORM             = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 2, 0, 0, 0, PIPE_FORMAT_TYPE_SNORM ),
 255    PIPE_FORMAT_R16G16_SNORM          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 2, 2, 0, 0, PIPE_FORMAT_TYPE_SNORM ),
 256    PIPE_FORMAT_R16G16B16_SNORM       = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 2, 2, 2, 0, PIPE_FORMAT_TYPE_SNORM ),
 257    PIPE_FORMAT_R16G16B16A16_SNORM    = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 2, 2, 2, 2, PIPE_FORMAT_TYPE_SNORM ),
 258    PIPE_FORMAT_R16_SSCALED           = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 2, 0, 0, 0, PIPE_FORMAT_TYPE_SSCALED ),
 259    PIPE_FORMAT_R16G16_SSCALED        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 2, 2, 0, 0, PIPE_FORMAT_TYPE_SSCALED ),
 260    PIPE_FORMAT_R16G16B16_SSCALED     = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 2, 2, 2, 0, PIPE_FORMAT_TYPE_SSCALED ),
 261    PIPE_FORMAT_R16G16B16A16_SSCALED  = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 2, 2, 2, 2, PIPE_FORMAT_TYPE_SSCALED ),
 262    PIPE_FORMAT_R8_UNORM              = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 1, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 263    PIPE_FORMAT_R8G8_UNORM            = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 1, 1, 0, 0, PIPE_FORMAT_TYPE_UNORM ),
 264    PIPE_FORMAT_R8G8B8_UNORM          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 1, 1, 1, 0, PIPE_FORMAT_TYPE_UNORM ),
 265    PIPE_FORMAT_R8G8B8A8_UNORM        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM ),
 266    PIPE_FORMAT_R8_USCALED            = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 1, 0, 0, 0, PIPE_FORMAT_TYPE_USCALED ),
 267    PIPE_FORMAT_R8G8_USCALED          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 1, 1, 0, 0, PIPE_FORMAT_TYPE_USCALED ),
 268    PIPE_FORMAT_R8G8B8_USCALED        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 1, 1, 1, 0, PIPE_FORMAT_TYPE_USCALED ),
 269    PIPE_FORMAT_R8G8B8A8_USCALED      = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 1, 1, 1, 1, PIPE_FORMAT_TYPE_USCALED ),
 270    PIPE_FORMAT_R8_SNORM              = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 1, 0, 0, 0, PIPE_FORMAT_TYPE_SNORM ),
 271    PIPE_FORMAT_R8G8_SNORM            = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 1, 1, 0, 0, PIPE_FORMAT_TYPE_SNORM ),
 272    PIPE_FORMAT_R8G8B8_SNORM          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 1, 1, 1, 0, PIPE_FORMAT_TYPE_SNORM ),
 273    PIPE_FORMAT_R8G8B8A8_SNORM        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SNORM ),
 274    PIPE_FORMAT_R8_SSCALED            = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R000, 1, 0, 0, 0, PIPE_FORMAT_TYPE_SSCALED ),
 275    PIPE_FORMAT_R8G8_SSCALED          = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG00, 1, 1, 0, 0, PIPE_FORMAT_TYPE_SSCALED ),
 276    PIPE_FORMAT_R8G8B8_SSCALED        = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB0, 1, 1, 1, 0, PIPE_FORMAT_TYPE_SSCALED ),
 277    PIPE_FORMAT_R8G8B8A8_SSCALED      = _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SSCALED )
 278 };
 279
 280
 281 /**
 282  * XXX should remove this, but S8_UNORM is a poor name
 283  */
 284 #define PIPE_FORMAT_U_S8                  PIPE_FORMAT_S8_UNORM
 285
 286
 287 /**
 288  * Builds pipe format name from format token.
 289  */
 290 static INLINE char *pf_sprint_name( char *str, uint format )
 291 {
 292    strcpy( str, "PIPE_FORMAT_" );
 293    switch (pf_layout( format )) {
 294    case PIPE_FORMAT_LAYOUT_RGBAZS: {
 295          pipe_format_rgbazs_t rgbazs = (pipe_format_rgbazs_t) format;
 296          uint                 i;
 297          uint                 scale = 1 << (pf_exp8( rgbazs ) * 3);
 298
 299          for (i = 0; i < 4; i++) {
 300             uint  size = pf_size_xyzw( rgbazs, i );
 301
 302             if (size == 0) {
 303                break;
 304             }
 305             switch (pf_swizzle_xyzw( rgbazs, i )) {
 306             case PIPE_FORMAT_COMP_R:
 307                strcat( str, "R" );
 308                break;
 309             case PIPE_FORMAT_COMP_G:
 310                strcat( str, "G" );
 311                break;
 312             case PIPE_FORMAT_COMP_B:
 313                strcat( str, "B" );
 314                break;
 315             case PIPE_FORMAT_COMP_A:
 316                strcat( str, "A" );
 317                break;
 318             case PIPE_FORMAT_COMP_0:
 319                strcat( str, "0" );
 320                break;
 321             case PIPE_FORMAT_COMP_1:
 322                strcat( str, "1" );
 323                break;
 324             case PIPE_FORMAT_COMP_Z:
 325                strcat( str, "Z" );
 326                break;
 327             case PIPE_FORMAT_COMP_S:
 328                strcat( str, "S" );
 329                break;
 330             }
 331             sprintf( &str[strlen( str )], "%u", size * scale );
 332          }
 333          if (i != 0) {
 334             strcat( str, "_" );
 335          }
 336          switch (pf_type( rgbazs )) {
 337          case PIPE_FORMAT_TYPE_UNKNOWN:
 338             strcat( str, "NONE" );
 339             break;
 340          case PIPE_FORMAT_TYPE_FLOAT:
 341             strcat( str, "FLOAT" );
 342             break;
 343          case PIPE_FORMAT_TYPE_UNORM:
 344             strcat( str, "UNORM" );
 345             break;
 346          case PIPE_FORMAT_TYPE_SNORM:
 347             strcat( str, "SNORM" );
 348             break;
 349          case PIPE_FORMAT_TYPE_USCALED:
 350             strcat( str, "USCALED" );
 351             break;
 352          case PIPE_FORMAT_TYPE_SSCALED:
 353             strcat( str, "SSCALED" );
 354             break;
 355          }
 356       }
 357       break;
 358    case PIPE_FORMAT_LAYOUT_YCBCR: {
 359          pipe_format_ycbcr_t  ycbcr = (pipe_format_ycbcr_t) format;
 360
 361          strcat( str, "YCBCR" );
 362          if (pf_rev( ycbcr )) {
 363             strcat( str, "_REV" );
 364          }
 365       }
 366       break;
 367    }
 368    return str;
 369 }
 370
 371 static INLINE uint pf_get_component_bits( enum pipe_format format, uint comp )
 372 {
 373    uint size;
 374
 375    if (pf_swizzle_x(format) == comp) {
 376       size = pf_size_x(format);
 377    }
 378    else if (pf_swizzle_y(format) == comp) {
 379       size = pf_size_y(format);
 380    }
 381    else if (pf_swizzle_z(format) == comp) {
 382       size = pf_size_z(format);
 383    }
 384    else if (pf_swizzle_w(format) == comp) {
 385       size = pf_size_w(format);
 386    }
 387    else {
 388       size = 0;
 389    }
 390    return size << (pf_exp8(format) * 3);
 391 }
 392
 393 static INLINE uint pf_get_bits( enum pipe_format format )
 394 {
 395    if (pf_layout(format) == PIPE_FORMAT_LAYOUT_RGBAZS) {
 396       return
 397          pf_get_component_bits( format, PIPE_FORMAT_COMP_R ) +
 398          pf_get_component_bits( format, PIPE_FORMAT_COMP_G ) +
 399          pf_get_component_bits( format, PIPE_FORMAT_COMP_B ) +
 400          pf_get_component_bits( format, PIPE_FORMAT_COMP_A ) +
 401          pf_get_component_bits( format, PIPE_FORMAT_COMP_Z ) +
 402          pf_get_component_bits( format, PIPE_FORMAT_COMP_S );
 403    }
 404    else {
 405       assert( pf_layout(format) == PIPE_FORMAT_LAYOUT_YCBCR );
 406
 407       /* TODO */
 408       assert( 0 );
 409       return 0;
 410    }
 411 }
 412
 413 static INLINE uint pf_get_size( enum pipe_format format ) {
 414    assert(pf_get_bits(format) % 8 == 0);
 415    return pf_get_bits(format) / 8;
 416 }
 417
 418 #endif