src/gallium/auxiliary/util/u_format.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009-2010 Vmware, Inc.
   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 VMWARE 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 #ifndef U_FORMAT_H
  30 #define U_FORMAT_H
  31
  32
  33 #include "pipe/p_format.h"
  34 #include "util/u_debug.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40
  41 /**
  42  * Describe how to pack/unpack pixels into/from the prescribed format.
  43  *
  44  * XXX: This could be renamed to something like util_format_pack, or broke down
  45  * in flags inside util_format_block that said exactly what we want.
  46  */
  47 enum util_format_layout {
  48    /**
  49     * Formats with util_format_block::width == util_format_block::height == 1
  50     * that can be described as an ordinary data structure.
  51     */
  52    UTIL_FORMAT_LAYOUT_PLAIN = 0,
  53
  54    /**
  55     * Formats with sub-sampled channels.
  56     *
  57     * This is for formats like YV12 where there is less than one sample per
  58     * pixel.
  59     */
  60    UTIL_FORMAT_LAYOUT_SUBSAMPLED = 3,
  61
  62    /**
  63     * S3 Texture Compression formats.
  64     */
  65    UTIL_FORMAT_LAYOUT_S3TC = 4,
  66
  67    /**
  68     * Red-Green Texture Compression formats.
  69     */
  70    UTIL_FORMAT_LAYOUT_RGTC = 5,
  71
  72    /**
  73     * Everything else that doesn't fit in any of the above layouts.
  74     */
  75    UTIL_FORMAT_LAYOUT_OTHER = 6
  76 };
  77
  78
  79 struct util_format_block
  80 {
  81    /** Block width in pixels */
  82    unsigned width;
  83
  84    /** Block height in pixels */
  85    unsigned height;
  86
  87    /** Block size in bits */
  88    unsigned bits;
  89 };
  90
  91
  92 enum util_format_type {
  93    UTIL_FORMAT_TYPE_VOID = 0,
  94    UTIL_FORMAT_TYPE_UNSIGNED = 1,
  95    UTIL_FORMAT_TYPE_SIGNED = 2,
  96    UTIL_FORMAT_TYPE_FIXED = 3,
  97    UTIL_FORMAT_TYPE_FLOAT = 4
  98 };
  99
 100
 101 enum util_format_swizzle {
 102    UTIL_FORMAT_SWIZZLE_X = 0,
 103    UTIL_FORMAT_SWIZZLE_Y = 1,
 104    UTIL_FORMAT_SWIZZLE_Z = 2,
 105    UTIL_FORMAT_SWIZZLE_W = 3,
 106    UTIL_FORMAT_SWIZZLE_0 = 4,
 107    UTIL_FORMAT_SWIZZLE_1 = 5,
 108    UTIL_FORMAT_SWIZZLE_NONE = 6
 109 };
 110
 111
 112 enum util_format_colorspace {
 113    UTIL_FORMAT_COLORSPACE_RGB = 0,
 114    UTIL_FORMAT_COLORSPACE_SRGB = 1,
 115    UTIL_FORMAT_COLORSPACE_YUV = 2,
 116    UTIL_FORMAT_COLORSPACE_ZS = 3
 117 };
 118
 119
 120 struct util_format_channel_description
 121 {
 122    unsigned type:6;
 123    unsigned normalized:1;
 124    unsigned size:9;
 125 };
 126
 127
 128 struct util_format_description
 129 {
 130    enum pipe_format format;
 131
 132    const char *name;
 133
 134    /**
 135     * Short name, striped of the prefix, lower case.
 136     */
 137    const char *short_name;
 138
 139    /**
 140     * Pixel block dimensions.
 141     */
 142    struct util_format_block block;
 143
 144    enum util_format_layout layout;
 145
 146    /**
 147     * The number of channels.
 148     */
 149    unsigned nr_channels:3;
 150
 151    /**
 152     * Whether all channels have the same number of (whole) bytes.
 153     */
 154    unsigned is_array:1;
 155
 156    /**
 157     * Whether the pixel format can be described as a bitfield structure.
 158     *
 159     * In particular:
 160     * - pixel depth must be 8, 16, or 32 bits;
 161     * - all channels must be unsigned, signed, or void
 162     */
 163    unsigned is_bitmask:1;
 164
 165    /**
 166     * Whether channels have mixed types (ignoring UTIL_FORMAT_TYPE_VOID).
 167     */
 168    unsigned is_mixed:1;
 169
 170    /**
 171     * Input channel description.
 172     *
 173     * Only valid for UTIL_FORMAT_LAYOUT_PLAIN formats.
 174     */
 175    struct util_format_channel_description channel[4];
 176
 177    /**
 178     * Output channel swizzle.
 179     *
 180     * The order is either:
 181     * - RGBA
 182     * - YUV(A)
 183     * - ZS
 184     * depending on the colorspace.
 185     */
 186    unsigned char swizzle[4];
 187
 188    /**
 189     * Colorspace transformation.
 190     */
 191    enum util_format_colorspace colorspace;
 192
 193    /**
 194     * Unpack pixel blocks to R8G8B8A8_UNORM.
 195     * Note: strides are in bytes.
 196     *
 197     * Only defined for non-depth-stencil formats.
 198     */
 199    void
 200    (*unpack_rgba_8unorm)(uint8_t *dst, unsigned dst_stride,
 201                          const uint8_t *src, unsigned src_stride,
 202                          unsigned width, unsigned height);
 203
 204    /**
 205     * Pack pixel blocks from R8G8B8A8_UNORM.
 206     * Note: strides are in bytes.
 207     *
 208     * Only defined for non-depth-stencil formats.
 209     */
 210    void
 211    (*pack_rgba_8unorm)(uint8_t *dst, unsigned dst_stride,
 212                        const uint8_t *src, unsigned src_stride,
 213                        unsigned width, unsigned height);
 214
 215    /**
 216     * Unpack pixel blocks to R32G32B32A32_FLOAT.
 217     * Note: strides are in bytes.
 218     *
 219     * Only defined for non-depth-stencil formats.
 220     */
 221    void
 222    (*unpack_rgba_float)(float *dst, unsigned dst_stride,
 223                         const uint8_t *src, unsigned src_stride,
 224                         unsigned width, unsigned height);
 225
 226    /**
 227     * Pack pixel blocks from R32G32B32A32_FLOAT.
 228     * Note: strides are in bytes.
 229     *
 230     * Only defined for non-depth-stencil formats.
 231     */
 232    void
 233    (*pack_rgba_float)(uint8_t *dst, unsigned dst_stride,
 234                       const float *src, unsigned src_stride,
 235                       unsigned width, unsigned height);
 236
 237    /**
 238     * Fetch a single pixel (i, j) from a block.
 239     *
 240     * Only defined for non-depth-stencil formats.
 241     */
 242    void
 243    (*fetch_rgba_float)(float *dst,
 244                        const uint8_t *src,
 245                        unsigned i, unsigned j);
 246
 247    /**
 248     * Unpack pixels to Z32_UNORM.
 249     * Note: strides are in bytes.
 250     *
 251     * Only defined for depth formats.
 252     */
 253    void
 254    (*unpack_z_32unorm)(uint32_t *dst, unsigned dst_stride,
 255                        const uint8_t *src, unsigned src_stride,
 256                        unsigned width, unsigned height);
 257
 258    /**
 259     * Pack pixels from Z32_FLOAT.
 260     * Note: strides are in bytes.
 261     *
 262     * Only defined for depth formats.
 263     */
 264    void
 265    (*pack_z_32unorm)(uint8_t *dst, unsigned dst_stride,
 266                      const uint32_t *src, unsigned src_stride,
 267                      unsigned width, unsigned height);
 268
 269    /**
 270     * Unpack pixels to Z32_FLOAT.
 271     * Note: strides are in bytes.
 272     *
 273     * Only defined for depth formats.
 274     */
 275    void
 276    (*unpack_z_float)(float *dst, unsigned dst_stride,
 277                      const uint8_t *src, unsigned src_stride,
 278                      unsigned width, unsigned height);
 279
 280    /**
 281     * Pack pixels from Z32_FLOAT.
 282     * Note: strides are in bytes.
 283     *
 284     * Only defined for depth formats.
 285     */
 286    void
 287    (*pack_z_float)(uint8_t *dst, unsigned dst_stride,
 288                    const float *src, unsigned src_stride,
 289                    unsigned width, unsigned height);
 290
 291    /**
 292     * Unpack pixels to S8_USCALED.
 293     * Note: strides are in bytes.
 294     *
 295     * Only defined for stencil formats.
 296     */
 297    void
 298    (*unpack_s_8uscaled)(uint8_t *dst, unsigned dst_stride,
 299                         const uint8_t *src, unsigned src_stride,
 300                         unsigned width, unsigned height);
 301
 302    /**
 303     * Pack pixels from S8_USCALED.
 304     * Note: strides are in bytes.
 305     *
 306     * Only defined for stencil formats.
 307     */
 308    void
 309    (*pack_s_8uscaled)(uint8_t *dst, unsigned dst_stride,
 310                       const uint8_t *src, unsigned src_stride,
 311                       unsigned width, unsigned height);
 312
 313 };
 314
 315
 316 extern const struct util_format_description
 317 util_format_description_table[];
 318
 319
 320 const struct util_format_description *
 321 util_format_description(enum pipe_format format);
 322
 323
 324 /*
 325  * Format query functions.
 326  */
 327
 328 static INLINE const char *
 329 util_format_name(enum pipe_format format)
 330 {
 331    const struct util_format_description *desc = util_format_description(format);
 332
 333    assert(desc);
 334    if (!desc) {
 335       return "???";
 336    }
 337
 338    return desc->name;
 339 }
 340
 341 static INLINE boolean
 342 util_format_is_s3tc(enum pipe_format format)
 343 {
 344    const struct util_format_description *desc = util_format_description(format);
 345
 346    assert(desc);
 347    if (!desc) {
 348       return FALSE;
 349    }
 350
 351    return desc->layout == UTIL_FORMAT_LAYOUT_S3TC ? TRUE : FALSE;
 352 }
 353
 354 static INLINE boolean
 355 util_format_is_depth_or_stencil(enum pipe_format format)
 356 {
 357    const struct util_format_description *desc = util_format_description(format);
 358
 359    assert(desc);
 360    if (!desc) {
 361       return FALSE;
 362    }
 363
 364    return desc->colorspace == UTIL_FORMAT_COLORSPACE_ZS ? TRUE : FALSE;
 365 }
 366
 367 static INLINE boolean
 368 util_format_is_depth_and_stencil(enum pipe_format format)
 369 {
 370    const struct util_format_description *desc = util_format_description(format);
 371
 372    assert(desc);
 373    if (!desc) {
 374       return FALSE;
 375    }
 376
 377    if (desc->colorspace != UTIL_FORMAT_COLORSPACE_ZS) {
 378       return FALSE;
 379    }
 380
 381    return (desc->swizzle[0] != UTIL_FORMAT_SWIZZLE_NONE &&
 382            desc->swizzle[1] != UTIL_FORMAT_SWIZZLE_NONE) ? TRUE : FALSE;
 383 }
 384
 385 /**
 386  * Whether this format is a rgab8 variant.
 387  *
 388  * That is, any format that matches the
 389  *
 390  *   PIPE_FORMAT_?8?8?8?8_UNORM
 391  */
 392 static INLINE boolean
 393 util_format_is_rgba8_variant(const struct util_format_description *desc)
 394 {
 395    unsigned chan;
 396
 397    if(desc->block.width != 1 ||
 398       desc->block.height != 1 ||
 399       desc->block.bits != 32)
 400       return FALSE;
 401
 402    for(chan = 0; chan < 4; ++chan) {
 403       if(desc->channel[chan].type != UTIL_FORMAT_TYPE_UNSIGNED &&
 404          desc->channel[chan].type != UTIL_FORMAT_TYPE_VOID)
 405          return FALSE;
 406       if(desc->channel[chan].size != 8)
 407          return FALSE;
 408    }
 409
 410    return TRUE;
 411 }
 412
 413
 414 /**
 415  * Return total bits needed for the pixel format per block.
 416  */
 417 static INLINE uint
 418 util_format_get_blocksizebits(enum pipe_format format)
 419 {
 420    const struct util_format_description *desc = util_format_description(format);
 421
 422    assert(desc);
 423    if (!desc) {
 424       return 0;
 425    }
 426
 427    return desc->block.bits;
 428 }
 429
 430 /**
 431  * Return bytes per block (not pixel) for the given format.
 432  */
 433 static INLINE uint
 434 util_format_get_blocksize(enum pipe_format format)
 435 {
 436    uint bits = util_format_get_blocksizebits(format);
 437
 438    assert(bits % 8 == 0);
 439
 440    return bits / 8;
 441 }
 442
 443 static INLINE uint
 444 util_format_get_blockwidth(enum pipe_format format)
 445 {
 446    const struct util_format_description *desc = util_format_description(format);
 447
 448    assert(desc);
 449    if (!desc) {
 450       return 1;
 451    }
 452
 453    return desc->block.width;
 454 }
 455
 456 static INLINE uint
 457 util_format_get_blockheight(enum pipe_format format)
 458 {
 459    const struct util_format_description *desc = util_format_description(format);
 460
 461    assert(desc);
 462    if (!desc) {
 463       return 1;
 464    }
 465
 466    return desc->block.height;
 467 }
 468
 469 static INLINE unsigned
 470 util_format_get_nblocksx(enum pipe_format format,
 471                          unsigned x)
 472 {
 473    unsigned blockwidth = util_format_get_blockwidth(format);
 474    return (x + blockwidth - 1) / blockwidth;
 475 }
 476
 477 static INLINE unsigned
 478 util_format_get_nblocksy(enum pipe_format format,
 479                          unsigned y)
 480 {
 481    unsigned blockheight = util_format_get_blockheight(format);
 482    return (y + blockheight - 1) / blockheight;
 483 }
 484
 485 static INLINE unsigned
 486 util_format_get_nblocks(enum pipe_format format,
 487                         unsigned width,
 488                         unsigned height)
 489 {
 490    return util_format_get_nblocksx(format, width) * util_format_get_nblocksy(format, height);
 491 }
 492
 493 static INLINE size_t
 494 util_format_get_stride(enum pipe_format format,
 495                        unsigned width)
 496 {
 497    return util_format_get_nblocksx(format, width) * util_format_get_blocksize(format);
 498 }
 499
 500 static INLINE size_t
 501 util_format_get_2d_size(enum pipe_format format,
 502                         size_t stride,
 503                         unsigned height)
 504 {
 505    return util_format_get_nblocksy(format, height) * stride;
 506 }
 507
 508 static INLINE uint
 509 util_format_get_component_bits(enum pipe_format format,
 510                                enum util_format_colorspace colorspace,
 511                                uint component)
 512 {
 513    const struct util_format_description *desc = util_format_description(format);
 514    enum util_format_colorspace desc_colorspace;
 515
 516    assert(format);
 517    if (!format) {
 518       return 0;
 519    }
 520
 521    assert(component < 4);
 522
 523    /* Treat RGB and SRGB as equivalent. */
 524    if (colorspace == UTIL_FORMAT_COLORSPACE_SRGB) {
 525       colorspace = UTIL_FORMAT_COLORSPACE_RGB;
 526    }
 527    if (desc->colorspace == UTIL_FORMAT_COLORSPACE_SRGB) {
 528       desc_colorspace = UTIL_FORMAT_COLORSPACE_RGB;
 529    } else {
 530       desc_colorspace = desc->colorspace;
 531    }
 532
 533    if (desc_colorspace != colorspace) {
 534       return 0;
 535    }
 536
 537    switch (desc->swizzle[component]) {
 538    case UTIL_FORMAT_SWIZZLE_X:
 539       return desc->channel[0].size;
 540    case UTIL_FORMAT_SWIZZLE_Y:
 541       return desc->channel[1].size;
 542    case UTIL_FORMAT_SWIZZLE_Z:
 543       return desc->channel[2].size;
 544    case UTIL_FORMAT_SWIZZLE_W:
 545       return desc->channel[3].size;
 546    default:
 547       return 0;
 548    }
 549 }
 550
 551 static INLINE boolean
 552 util_format_has_alpha(enum pipe_format format)
 553 {
 554    const struct util_format_description *desc = util_format_description(format);
 555
 556    assert(format);
 557    if (!format) {
 558       return FALSE;
 559    }
 560
 561    switch (desc->colorspace) {
 562    case UTIL_FORMAT_COLORSPACE_RGB:
 563    case UTIL_FORMAT_COLORSPACE_SRGB:
 564       return desc->swizzle[3] != UTIL_FORMAT_SWIZZLE_1;
 565    case UTIL_FORMAT_COLORSPACE_YUV:
 566       return FALSE;
 567    case UTIL_FORMAT_COLORSPACE_ZS:
 568       return FALSE;
 569    default:
 570       assert(0);
 571       return FALSE;
 572    }
 573 }
 574
 575 /**
 576  * Return the number of components stored.
 577  * Formats with block size != 1x1 will always have 1 component (the block).
 578  */
 579 static INLINE unsigned
 580 util_format_get_nr_components(enum pipe_format format)
 581 {
 582    const struct util_format_description *desc = util_format_description(format);
 583    return desc->nr_channels;
 584 }
 585
 586 /*
 587  * Format access functions.
 588  */
 589
 590 void
 591 util_format_read_4f(enum pipe_format format,
 592                     float *dst, unsigned dst_stride,
 593                     const void *src, unsigned src_stride,
 594                     unsigned x, unsigned y, unsigned w, unsigned h);
 595
 596 void
 597 util_format_write_4f(enum pipe_format format,
 598                      const float *src, unsigned src_stride,
 599                      void *dst, unsigned dst_stride,
 600                      unsigned x, unsigned y, unsigned w, unsigned h);
 601
 602 void
 603 util_format_read_4ub(enum pipe_format format,
 604                      uint8_t *dst, unsigned dst_stride,
 605                      const void *src, unsigned src_stride,
 606                      unsigned x, unsigned y, unsigned w, unsigned h);
 607
 608 void
 609 util_format_write_4ub(enum pipe_format format,
 610                       const uint8_t *src, unsigned src_stride,
 611                       void *dst, unsigned dst_stride,
 612                       unsigned x, unsigned y, unsigned w, unsigned h);
 613
 614 /*
 615  * Generic format conversion;
 616  */
 617
 618 void
 619 util_format_translate(enum pipe_format dst_format,
 620                       void *dst, unsigned dst_stride,
 621                       unsigned dst_x, unsigned dst_y,
 622                       enum pipe_format src_format,
 623                       const void *src, unsigned src_stride,
 624                       unsigned src_x, unsigned src_y,
 625                       unsigned width, unsigned height);
 626
 627 #ifdef __cplusplus
 628 } // extern "C" {
 629 #endif
 630
 631 #endif /* ! U_FORMAT_H */