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