src/mesa/main/texgetimage.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  * Copyright (c) 2009 VMware, Inc.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26
  27 /**
  28  * Code for glGetTexImage() and glGetCompressedTexImage().
  29  */
  30
  31
  32 #include "glheader.h"
  33 #include "bufferobj.h"
  34 #include "enums.h"
  35 #include "context.h"
  36 #include "formats.h"
  37 #include "format_unpack.h"
  38 #include "glformats.h"
  39 #include "image.h"
  40 #include "mtypes.h"
  41 #include "pack.h"
  42 #include "pbo.h"
  43 #include "pixelstore.h"
  44 #include "texcompress.h"
  45 #include "texgetimage.h"
  46 #include "teximage.h"
  47 #include "texobj.h"
  48 #include "texstore.h"
  49 #include "format_utils.h"
  50 #include "pixeltransfer.h"
  51
  52 /**
  53  * Can the given type represent negative values?
  54  */
  55 static inline GLboolean
  56 type_needs_clamping(GLenum type)
  57 {
  58    switch (type) {
  59    case GL_BYTE:
  60    case GL_SHORT:
  61    case GL_INT:
  62    case GL_FLOAT:
  63    case GL_HALF_FLOAT_ARB:
  64    case GL_UNSIGNED_INT_10F_11F_11F_REV:
  65    case GL_UNSIGNED_INT_5_9_9_9_REV:
  66       return GL_FALSE;
  67    default:
  68       return GL_TRUE;
  69    }
  70 }
  71
  72
  73 /**
  74  * glGetTexImage for depth/Z pixels.
  75  */
  76 static void
  77 get_tex_depth(struct gl_context *ctx, GLuint dimensions,
  78               GLint xoffset, GLint yoffset, GLint zoffset,
  79               GLsizei width, GLsizei height, GLint depth,
  80               GLenum format, GLenum type, GLvoid *pixels,
  81               struct gl_texture_image *texImage)
  82 {
  83    GLint img, row;
  84    GLfloat *depthRow = malloc(width * sizeof(GLfloat));
  85
  86    if (!depthRow) {
  87       _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
  88       return;
  89    }
  90
  91    if (texImage->TexObject->Target == GL_TEXTURE_1D_ARRAY) {
  92       depth = height;
  93       height = 1;
  94    }
  95
  96    assert(zoffset + depth <= texImage->Depth);
  97    for (img = 0; img < depth; img++) {
  98       GLubyte *srcMap;
  99       GLint srcRowStride;
 100
 101       /* map src texture buffer */
 102       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + img,
 103                                   xoffset, yoffset, width, height,
 104                                   GL_MAP_READ_BIT, &srcMap, &srcRowStride);
 105
 106       if (srcMap) {
 107          for (row = 0; row < height; row++) {
 108             void *dest = _mesa_image_address(dimensions, &ctx->Pack, pixels,
 109                                              width, height, format, type,
 110                                              img, row, 0);
 111             const GLubyte *src = srcMap + row * srcRowStride;
 112             _mesa_unpack_float_z_row(texImage->TexFormat, width, src, depthRow);
 113             _mesa_pack_depth_span(ctx, width, dest, type, depthRow, &ctx->Pack);
 114          }
 115
 116          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + img);
 117       }
 118       else {
 119          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 120          break;
 121       }
 122    }
 123
 124    free(depthRow);
 125 }
 126
 127
 128 /**
 129  * glGetTexImage for depth/stencil pixels.
 130  */
 131 static void
 132 get_tex_depth_stencil(struct gl_context *ctx, GLuint dimensions,
 133                       GLint xoffset, GLint yoffset, GLint zoffset,
 134                       GLsizei width, GLsizei height, GLint depth,
 135                       GLenum format, GLenum type, GLvoid *pixels,
 136                       struct gl_texture_image *texImage)
 137 {
 138    GLint img, row;
 139
 140    assert(format == GL_DEPTH_STENCIL);
 141    assert(type == GL_UNSIGNED_INT_24_8 ||
 142           type == GL_FLOAT_32_UNSIGNED_INT_24_8_REV);
 143
 144    assert(zoffset + depth <= texImage->Depth);
 145    for (img = 0; img < depth; img++) {
 146       GLubyte *srcMap;
 147       GLint rowstride;
 148
 149       /* map src texture buffer */
 150       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + img,
 151                                   xoffset, yoffset, width, height,
 152                                   GL_MAP_READ_BIT, &srcMap, &rowstride);
 153
 154       if (srcMap) {
 155          for (row = 0; row < height; row++) {
 156             const GLubyte *src = srcMap + row * rowstride;
 157             void *dest = _mesa_image_address(dimensions, &ctx->Pack, pixels,
 158                                              width, height, format, type,
 159                                              img, row, 0);
 160             _mesa_unpack_depth_stencil_row(texImage->TexFormat,
 161                                            width,
 162                                            (const GLuint *) src,
 163                                            type, dest);
 164             if (ctx->Pack.SwapBytes) {
 165                _mesa_swap4((GLuint *) dest, width);
 166             }
 167          }
 168
 169          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + img);
 170       }
 171       else {
 172          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 173          break;
 174       }
 175    }
 176 }
 177
 178 /**
 179  * glGetTexImage for stencil pixels.
 180  */
 181 static void
 182 get_tex_stencil(struct gl_context *ctx, GLuint dimensions,
 183                 GLint xoffset, GLint yoffset, GLint zoffset,
 184                 GLsizei width, GLsizei height, GLint depth,
 185                 GLenum format, GLenum type, GLvoid *pixels,
 186                 struct gl_texture_image *texImage)
 187 {
 188    GLint img, row;
 189
 190    assert(format == GL_STENCIL_INDEX);
 191
 192    for (img = 0; img < depth; img++) {
 193       GLubyte *srcMap;
 194       GLint rowstride;
 195
 196       /* map src texture buffer */
 197       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + img,
 198                                   xoffset, yoffset, width, height,
 199                                   GL_MAP_READ_BIT,
 200                                   &srcMap, &rowstride);
 201
 202       if (srcMap) {
 203          for (row = 0; row < height; row++) {
 204             const GLubyte *src = srcMap + row * rowstride;
 205             void *dest = _mesa_image_address(dimensions, &ctx->Pack, pixels,
 206                                              width, height, format, type,
 207                                              img, row, 0);
 208             _mesa_unpack_ubyte_stencil_row(texImage->TexFormat,
 209                                            width,
 210                                            (const GLuint *) src,
 211                                            dest);
 212          }
 213
 214          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + img);
 215       }
 216       else {
 217          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 218          break;
 219       }
 220    }
 221 }
 222
 223
 224 /**
 225  * glGetTexImage for YCbCr pixels.
 226  */
 227 static void
 228 get_tex_ycbcr(struct gl_context *ctx, GLuint dimensions,
 229               GLint xoffset, GLint yoffset, GLint zoffset,
 230               GLsizei width, GLsizei height, GLint depth,
 231               GLenum format, GLenum type, GLvoid *pixels,
 232               struct gl_texture_image *texImage)
 233 {
 234    GLint img, row;
 235
 236    assert(zoffset + depth <= texImage->Depth);
 237    for (img = 0; img < depth; img++) {
 238       GLubyte *srcMap;
 239       GLint rowstride;
 240
 241       /* map src texture buffer */
 242       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + img,
 243                                   xoffset, yoffset, width, height,
 244                                   GL_MAP_READ_BIT, &srcMap, &rowstride);
 245
 246       if (srcMap) {
 247          for (row = 0; row < height; row++) {
 248             const GLubyte *src = srcMap + row * rowstride;
 249             void *dest = _mesa_image_address(dimensions, &ctx->Pack, pixels,
 250                                              width, height, format, type,
 251                                              img, row, 0);
 252             memcpy(dest, src, width * sizeof(GLushort));
 253
 254             /* check for byte swapping */
 255             if ((texImage->TexFormat == MESA_FORMAT_YCBCR
 256                  && type == GL_UNSIGNED_SHORT_8_8_REV_MESA) ||
 257                 (texImage->TexFormat == MESA_FORMAT_YCBCR_REV
 258                  && type == GL_UNSIGNED_SHORT_8_8_MESA)) {
 259                if (!ctx->Pack.SwapBytes)
 260                   _mesa_swap2((GLushort *) dest, width);
 261             }
 262             else if (ctx->Pack.SwapBytes) {
 263                _mesa_swap2((GLushort *) dest, width);
 264             }
 265          }
 266
 267          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + img);
 268       }
 269       else {
 270          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 271          break;
 272       }
 273    }
 274 }
 275
 276
 277 /**
 278  * Get a color texture image with decompression.
 279  */
 280 static void
 281 get_tex_rgba_compressed(struct gl_context *ctx, GLuint dimensions,
 282                         GLint xoffset, GLint yoffset, GLint zoffset,
 283                         GLsizei width, GLsizei height, GLint depth,
 284                         GLenum format, GLenum type, GLvoid *pixels,
 285                         struct gl_texture_image *texImage,
 286                         GLbitfield transferOps)
 287 {
 288    /* don't want to apply sRGB -> RGB conversion here so override the format */
 289    const mesa_format texFormat =
 290       _mesa_get_srgb_format_linear(texImage->TexFormat);
 291    const GLenum baseFormat = _mesa_get_format_base_format(texFormat);
 292    GLfloat *tempImage, *tempSlice;
 293    GLuint slice;
 294    int srcStride, dstStride;
 295    uint32_t dstFormat;
 296    bool needsRebase;
 297    uint8_t rebaseSwizzle[4];
 298
 299    /* Decompress into temp float buffer, then pack into user buffer */
 300    tempImage = malloc(width * height * depth
 301                                   * 4 * sizeof(GLfloat));
 302    if (!tempImage) {
 303       _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage()");
 304       return;
 305    }
 306
 307    /* Decompress the texture image slices - results in 'tempImage' */
 308    for (slice = 0; slice < depth; slice++) {
 309       GLubyte *srcMap;
 310       GLint srcRowStride;
 311
 312       tempSlice = tempImage + slice * 4 * width * height;
 313
 314       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + slice,
 315                                   xoffset, yoffset, width, height,
 316                                   GL_MAP_READ_BIT,
 317                                   &srcMap, &srcRowStride);
 318       if (srcMap) {
 319          _mesa_decompress_image(texFormat, width, height,
 320                                 srcMap, srcRowStride, tempSlice);
 321
 322          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + slice);
 323       }
 324       else {
 325          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 326          free(tempImage);
 327          return;
 328       }
 329    }
 330
 331    /* Depending on the base format involved we may need to apply a rebase
 332     * transform (for example: if we download to a Luminance format we want
 333     * G=0 and B=0).
 334     */
 335    if (baseFormat == GL_LUMINANCE ||
 336        baseFormat == GL_INTENSITY) {
 337       needsRebase = true;
 338       rebaseSwizzle[0] = MESA_FORMAT_SWIZZLE_X;
 339       rebaseSwizzle[1] = MESA_FORMAT_SWIZZLE_ZERO;
 340       rebaseSwizzle[2] = MESA_FORMAT_SWIZZLE_ZERO;
 341       rebaseSwizzle[3] = MESA_FORMAT_SWIZZLE_ONE;
 342    } else if (baseFormat == GL_LUMINANCE_ALPHA) {
 343       needsRebase = true;
 344       rebaseSwizzle[0] = MESA_FORMAT_SWIZZLE_X;
 345       rebaseSwizzle[1] = MESA_FORMAT_SWIZZLE_ZERO;
 346       rebaseSwizzle[2] = MESA_FORMAT_SWIZZLE_ZERO;
 347       rebaseSwizzle[3] = MESA_FORMAT_SWIZZLE_W;
 348    } else {
 349       needsRebase = false;
 350    }
 351
 352    srcStride = 4 * width * sizeof(GLfloat);
 353    dstStride = _mesa_image_row_stride(&ctx->Pack, width, format, type);
 354    dstFormat = _mesa_format_from_format_and_type(format, type);
 355    tempSlice = tempImage;
 356    for (slice = 0; slice < depth; slice++) {
 357       void *dest = _mesa_image_address(dimensions, &ctx->Pack, pixels,
 358                                        width, height, format, type,
 359                                        slice, 0, 0);
 360       _mesa_format_convert(dest, dstFormat, dstStride,
 361                            tempSlice, RGBA32_FLOAT, srcStride,
 362                            width, height,
 363                            needsRebase ? rebaseSwizzle : NULL);
 364       tempSlice += 4 * width * height;
 365    }
 366
 367    free(tempImage);
 368 }
 369
 370
 371 /**
 372  * Return a base GL format given the user-requested format
 373  * for glGetTexImage().
 374  */
 375 GLenum
 376 _mesa_base_pack_format(GLenum format)
 377 {
 378    switch (format) {
 379    case GL_ABGR_EXT:
 380    case GL_BGRA:
 381    case GL_BGRA_INTEGER:
 382    case GL_RGBA_INTEGER:
 383       return GL_RGBA;
 384    case GL_BGR:
 385    case GL_BGR_INTEGER:
 386    case GL_RGB_INTEGER:
 387       return GL_RGB;
 388    case GL_RED_INTEGER:
 389       return GL_RED;
 390    case GL_GREEN_INTEGER:
 391       return GL_GREEN;
 392    case GL_BLUE_INTEGER:
 393       return GL_BLUE;
 394    case GL_ALPHA_INTEGER:
 395       return GL_ALPHA;
 396    case GL_LUMINANCE_INTEGER_EXT:
 397       return GL_LUMINANCE;
 398    case GL_LUMINANCE_ALPHA_INTEGER_EXT:
 399       return GL_LUMINANCE_ALPHA;
 400    default:
 401       return format;
 402    }
 403 }
 404
 405
 406 /**
 407  * Get an uncompressed color texture image.
 408  */
 409 static void
 410 get_tex_rgba_uncompressed(struct gl_context *ctx, GLuint dimensions,
 411                           GLint xoffset, GLint yoffset, GLint zoffset,
 412                           GLsizei width, GLsizei height, GLint depth,
 413                           GLenum format, GLenum type, GLvoid *pixels,
 414                           struct gl_texture_image *texImage,
 415                           GLbitfield transferOps)
 416 {
 417    /* don't want to apply sRGB -> RGB conversion here so override the format */
 418    const mesa_format texFormat =
 419       _mesa_get_srgb_format_linear(texImage->TexFormat);
 420    GLuint img;
 421    GLboolean dst_is_integer;
 422    uint32_t dst_format;
 423    int dst_stride;
 424    uint8_t rebaseSwizzle[4];
 425    bool needsRebase;
 426    void *rgba = NULL;
 427
 428    if (texImage->TexObject->Target == GL_TEXTURE_1D_ARRAY) {
 429       depth = height;
 430       height = 1;
 431       zoffset = yoffset;
 432       yoffset = 0;
 433    }
 434
 435    /* Depending on the base format involved we may need to apply a rebase
 436     * transform (for example: if we download to a Luminance format we want
 437     * G=0 and B=0).
 438     */
 439    if (texImage->_BaseFormat == GL_LUMINANCE ||
 440        texImage->_BaseFormat == GL_INTENSITY) {
 441       needsRebase = true;
 442       rebaseSwizzle[0] = MESA_FORMAT_SWIZZLE_X;
 443       rebaseSwizzle[1] = MESA_FORMAT_SWIZZLE_ZERO;
 444       rebaseSwizzle[2] = MESA_FORMAT_SWIZZLE_ZERO;
 445       rebaseSwizzle[3] = MESA_FORMAT_SWIZZLE_ONE;
 446    } else if (texImage->_BaseFormat == GL_LUMINANCE_ALPHA) {
 447       needsRebase = true;
 448       rebaseSwizzle[0] = MESA_FORMAT_SWIZZLE_X;
 449       rebaseSwizzle[1] = MESA_FORMAT_SWIZZLE_ZERO;
 450       rebaseSwizzle[2] = MESA_FORMAT_SWIZZLE_ZERO;
 451       rebaseSwizzle[3] = MESA_FORMAT_SWIZZLE_W;
 452     } else if (texImage->_BaseFormat !=
 453                _mesa_get_format_base_format(texFormat)) {
 454       needsRebase =
 455          _mesa_compute_rgba2base2rgba_component_mapping(texImage->_BaseFormat,
 456                                                         rebaseSwizzle);
 457     } else {
 458       needsRebase = false;
 459     }
 460
 461    /* Describe the dst format */
 462    dst_is_integer = _mesa_is_enum_format_integer(format);
 463    dst_format = _mesa_format_from_format_and_type(format, type);
 464    dst_stride = _mesa_image_row_stride(&ctx->Pack, width, format, type);
 465
 466    /* Since _mesa_format_convert does not handle transferOps we need to handle
 467     * them before we call the function. This requires to convert to RGBA float
 468     * first so we can call _mesa_apply_rgba_transfer_ops. If the dst format is
 469     * integer then transferOps do not apply.
 470     */
 471    assert(!transferOps || (transferOps && !dst_is_integer));
 472    (void) dst_is_integer; /* silence unused var warning */
 473
 474    for (img = 0; img < depth; img++) {
 475       GLubyte *srcMap;
 476       GLint rowstride;
 477       GLubyte *img_src;
 478       void *dest;
 479       void *src;
 480       int src_stride;
 481       uint32_t src_format;
 482
 483       /* map src texture buffer */
 484       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + img,
 485                                   xoffset, yoffset, width, height,
 486                                   GL_MAP_READ_BIT,
 487                                   &srcMap, &rowstride);
 488       if (!srcMap) {
 489          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 490          goto done;
 491       }
 492
 493       img_src = srcMap;
 494       dest = _mesa_image_address(dimensions, &ctx->Pack, pixels,
 495                                  width, height, format, type,
 496                                  img, 0, 0);
 497
 498       if (transferOps) {
 499          uint32_t rgba_format;
 500          int rgba_stride;
 501          bool need_convert = false;
 502
 503          /* We will convert to RGBA float */
 504          rgba_format = RGBA32_FLOAT;
 505          rgba_stride = width * 4 * sizeof(GLfloat);
 506
 507          /* If we are lucky and the dst format matches the RGBA format we need
 508           * to convert to, then we can convert directly into the dst buffer
 509           * and avoid the final conversion/copy from the rgba buffer to the dst
 510           * buffer.
 511           */
 512          if (format == rgba_format) {
 513             rgba = dest;
 514          } else if (rgba == NULL) { /* Allocate the RGBA buffer only once */
 515             need_convert = true;
 516             rgba = malloc(height * rgba_stride);
 517             if (!rgba) {
 518                _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage()");
 519                ctx->Driver.UnmapTextureImage(ctx, texImage, img);
 520                return;
 521             }
 522          }
 523
 524          _mesa_format_convert(rgba, rgba_format, rgba_stride,
 525                               img_src, texFormat, rowstride,
 526                               width, height,
 527                               needsRebase ? rebaseSwizzle : NULL);
 528
 529          /* Handle transfer ops now */
 530          _mesa_apply_rgba_transfer_ops(ctx, transferOps, width * height, rgba);
 531
 532          /* If we had to rebase, we have already handled that */
 533          needsRebase = false;
 534
 535          /* If we were lucky and our RGBA conversion matches the dst format,
 536           * then we are done.
 537           */
 538          if (!need_convert)
 539             goto do_swap;
 540
 541          /* Otherwise, we need to convert from RGBA to dst next */
 542          src = rgba;
 543          src_format = rgba_format;
 544          src_stride = rgba_stride;
 545       } else {
 546          /* No RGBA conversion needed, convert directly to dst */
 547          src = img_src;
 548          src_format = texFormat;
 549          src_stride = rowstride;
 550       }
 551
 552       /* Do the conversion to destination format */
 553       _mesa_format_convert(dest, dst_format, dst_stride,
 554                            src, src_format, src_stride,
 555                            width, height,
 556                            needsRebase ? rebaseSwizzle : NULL);
 557
 558    do_swap:
 559       /* Handle byte swapping if required */
 560       if (ctx->Pack.SwapBytes) {
 561          GLint swapSize = _mesa_sizeof_packed_type(type);
 562          if (swapSize == 2 || swapSize == 4) {
 563             int swapsPerPixel = _mesa_bytes_per_pixel(format, type) / swapSize;
 564             assert(_mesa_bytes_per_pixel(format, type) % swapSize == 0);
 565             if (swapSize == 2)
 566                _mesa_swap2((GLushort *) dest, width * height * swapsPerPixel);
 567             else if (swapSize == 4)
 568                _mesa_swap4((GLuint *) dest, width * height * swapsPerPixel);
 569          }
 570       }
 571
 572       /* Unmap the src texture buffer */
 573       ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + img);
 574    }
 575
 576 done:
 577    if (rgba)
 578       free(rgba);
 579 }
 580
 581
 582 /**
 583  * glGetTexImage for color formats (RGBA, RGB, alpha, LA, etc).
 584  * Compressed textures are handled here as well.
 585  */
 586 static void
 587 get_tex_rgba(struct gl_context *ctx, GLuint dimensions,
 588              GLint xoffset, GLint yoffset, GLint zoffset,
 589              GLsizei width, GLsizei height, GLint depth,
 590              GLenum format, GLenum type, GLvoid *pixels,
 591              struct gl_texture_image *texImage)
 592 {
 593    const GLenum dataType = _mesa_get_format_datatype(texImage->TexFormat);
 594    GLbitfield transferOps = 0x0;
 595
 596    /* In general, clamping does not apply to glGetTexImage, except when
 597     * the returned type of the image can't hold negative values.
 598     */
 599    if (type_needs_clamping(type)) {
 600       /* the returned image type can't have negative values */
 601       if (dataType == GL_FLOAT ||
 602           dataType == GL_HALF_FLOAT ||
 603           dataType == GL_SIGNED_NORMALIZED ||
 604           format == GL_LUMINANCE ||
 605           format == GL_LUMINANCE_ALPHA) {
 606          transferOps |= IMAGE_CLAMP_BIT;
 607       }
 608    }
 609
 610    if (_mesa_is_format_compressed(texImage->TexFormat)) {
 611       get_tex_rgba_compressed(ctx, dimensions,
 612                               xoffset, yoffset, zoffset,
 613                               width, height, depth,
 614                               format, type,
 615                               pixels, texImage, transferOps);
 616    }
 617    else {
 618       get_tex_rgba_uncompressed(ctx, dimensions,
 619                                 xoffset, yoffset, zoffset,
 620                                 width, height, depth,
 621                                 format, type,
 622                                 pixels, texImage, transferOps);
 623    }
 624 }
 625
 626
 627 /**
 628  * Try to do glGetTexImage() with simple memcpy().
 629  * \return GL_TRUE if done, GL_FALSE otherwise
 630  */
 631 static GLboolean
 632 get_tex_memcpy(struct gl_context *ctx,
 633                GLint xoffset, GLint yoffset, GLint zoffset,
 634                GLsizei width, GLsizei height, GLint depth,
 635                GLenum format, GLenum type, GLvoid *pixels,
 636                struct gl_texture_image *texImage)
 637 {
 638    const GLenum target = texImage->TexObject->Target;
 639    GLboolean memCopy = GL_FALSE;
 640    GLenum texBaseFormat = _mesa_get_format_base_format(texImage->TexFormat);
 641
 642    /*
 643     * Check if we can use memcpy to copy from the hardware texture
 644     * format to the user's format/type.
 645     * Note that GL's pixel transfer ops don't apply to glGetTexImage()
 646     */
 647    if ((target == GL_TEXTURE_1D ||
 648         target == GL_TEXTURE_2D ||
 649         target == GL_TEXTURE_RECTANGLE ||
 650         _mesa_is_cube_face(target)) &&
 651        texBaseFormat == texImage->_BaseFormat) {
 652       memCopy = _mesa_format_matches_format_and_type(texImage->TexFormat,
 653                                                      format, type,
 654                                                      ctx->Pack.SwapBytes);
 655    }
 656
 657    if (depth > 1) {
 658       /* only a single slice is supported at this time */
 659       memCopy = FALSE;
 660    }
 661
 662    if (memCopy) {
 663       const GLuint bpp = _mesa_get_format_bytes(texImage->TexFormat);
 664       const GLint bytesPerRow = width * bpp;
 665       GLubyte *dst =
 666          _mesa_image_address2d(&ctx->Pack, pixels, width, height,
 667                                format, type, 0, 0);
 668       const GLint dstRowStride =
 669          _mesa_image_row_stride(&ctx->Pack, width, format, type);
 670       GLubyte *src;
 671       GLint srcRowStride;
 672
 673       /* map src texture buffer */
 674       ctx->Driver.MapTextureImage(ctx, texImage, zoffset,
 675                                   xoffset, yoffset, width, height,
 676                                   GL_MAP_READ_BIT, &src, &srcRowStride);
 677
 678       if (src) {
 679          if (bytesPerRow == dstRowStride && bytesPerRow == srcRowStride) {
 680             memcpy(dst, src, bytesPerRow * texImage->Height);
 681          }
 682          else {
 683             GLuint row;
 684             for (row = 0; row < height; row++) {
 685                memcpy(dst, src, bytesPerRow);
 686                dst += dstRowStride;
 687                src += srcRowStride;
 688             }
 689          }
 690
 691          /* unmap src texture buffer */
 692          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset);
 693       }
 694       else {
 695          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage");
 696       }
 697    }
 698
 699    return memCopy;
 700 }
 701
 702
 703 /**
 704  * This is the software fallback for Driver.GetTexSubImage().
 705  * All error checking will have been done before this routine is called.
 706  * We'll call ctx->Driver.MapTextureImage() to access the data, then
 707  * unmap with ctx->Driver.UnmapTextureImage().
 708  */
 709 void
 710 _mesa_GetTexSubImage_sw(struct gl_context *ctx,
 711                         GLint xoffset, GLint yoffset, GLint zoffset,
 712                         GLsizei width, GLsizei height, GLint depth,
 713                         GLenum format, GLenum type, GLvoid *pixels,
 714                         struct gl_texture_image *texImage)
 715 {
 716    const GLuint dimensions =
 717       _mesa_get_texture_dimensions(texImage->TexObject->Target);
 718
 719    /* map dest buffer, if PBO */
 720    if (_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
 721       /* Packing texture image into a PBO.
 722        * Map the (potentially) VRAM-based buffer into our process space so
 723        * we can write into it with the code below.
 724        * A hardware driver might use a sophisticated blit to move the
 725        * texture data to the PBO if the PBO is in VRAM along with the texture.
 726        */
 727       GLubyte *buf = (GLubyte *)
 728          ctx->Driver.MapBufferRange(ctx, 0, ctx->Pack.BufferObj->Size,
 729                                     GL_MAP_WRITE_BIT, ctx->Pack.BufferObj,
 730                                     MAP_INTERNAL);
 731       if (!buf) {
 732          /* out of memory or other unexpected error */
 733          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetTexImage(map PBO failed)");
 734          return;
 735       }
 736       /* <pixels> was an offset into the PBO.
 737        * Now make it a real, client-side pointer inside the mapped region.
 738        */
 739       pixels = ADD_POINTERS(buf, pixels);
 740    }
 741
 742    if (get_tex_memcpy(ctx, xoffset, yoffset, zoffset, width, height, depth,
 743                       format, type, pixels, texImage)) {
 744       /* all done */
 745    }
 746    else if (format == GL_DEPTH_COMPONENT) {
 747       get_tex_depth(ctx, dimensions, xoffset, yoffset, zoffset,
 748                     width, height, depth, format, type, pixels, texImage);
 749    }
 750    else if (format == GL_DEPTH_STENCIL_EXT) {
 751       get_tex_depth_stencil(ctx, dimensions, xoffset, yoffset, zoffset,
 752                             width, height, depth, format, type, pixels,
 753                             texImage);
 754    }
 755    else if (format == GL_STENCIL_INDEX) {
 756       get_tex_stencil(ctx, dimensions, xoffset, yoffset, zoffset,
 757                       width, height, depth, format, type, pixels, texImage);
 758    }
 759    else if (format == GL_YCBCR_MESA) {
 760       get_tex_ycbcr(ctx, dimensions, xoffset, yoffset, zoffset,
 761                     width, height, depth, format, type, pixels, texImage);
 762    }
 763    else {
 764       get_tex_rgba(ctx, dimensions, xoffset, yoffset, zoffset,
 765                    width, height, depth, format, type, pixels, texImage);
 766    }
 767
 768    if (_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
 769       ctx->Driver.UnmapBuffer(ctx, ctx->Pack.BufferObj, MAP_INTERNAL);
 770    }
 771 }
 772
 773
 774
 775 /**
 776  * This is the software fallback for Driver.GetCompressedTexSubImage().
 777  * All error checking will have been done before this routine is called.
 778  */
 779 void
 780 _mesa_GetCompressedTexSubImage_sw(struct gl_context *ctx,
 781                                   struct gl_texture_image *texImage,
 782                                   GLint xoffset, GLint yoffset,
 783                                   GLint zoffset, GLsizei width,
 784                                   GLint height, GLint depth,
 785                                   GLvoid *img)
 786 {
 787    const GLuint dimensions =
 788       _mesa_get_texture_dimensions(texImage->TexObject->Target);
 789    struct compressed_pixelstore store;
 790    GLint slice;
 791    GLubyte *dest;
 792
 793    _mesa_compute_compressed_pixelstore(dimensions, texImage->TexFormat,
 794                                        width, height, depth,
 795                                        &ctx->Pack, &store);
 796
 797    if (_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
 798       /* pack texture image into a PBO */
 799       dest = (GLubyte *)
 800          ctx->Driver.MapBufferRange(ctx, 0, ctx->Pack.BufferObj->Size,
 801                                     GL_MAP_WRITE_BIT, ctx->Pack.BufferObj,
 802                                     MAP_INTERNAL);
 803       if (!dest) {
 804          /* out of memory or other unexpected error */
 805          _mesa_error(ctx, GL_OUT_OF_MEMORY,
 806                      "glGetCompresssedTexImage(map PBO failed)");
 807          return;
 808       }
 809       dest = ADD_POINTERS(dest, img);
 810    } else {
 811       dest = img;
 812    }
 813
 814    dest += store.SkipBytes;
 815
 816    for (slice = 0; slice < store.CopySlices; slice++) {
 817       GLint srcRowStride;
 818       GLubyte *src;
 819
 820       /* map src texture buffer */
 821       ctx->Driver.MapTextureImage(ctx, texImage, zoffset + slice,
 822                                   xoffset, yoffset, width, height,
 823                                   GL_MAP_READ_BIT, &src, &srcRowStride);
 824
 825       if (src) {
 826          GLint i;
 827          for (i = 0; i < store.CopyRowsPerSlice; i++) {
 828             memcpy(dest, src, store.CopyBytesPerRow);
 829             dest += store.TotalBytesPerRow;
 830             src += srcRowStride;
 831          }
 832
 833          ctx->Driver.UnmapTextureImage(ctx, texImage, zoffset + slice);
 834
 835          /* Advance to next slice */
 836          dest += store.TotalBytesPerRow * (store.TotalRowsPerSlice -
 837                                            store.CopyRowsPerSlice);
 838
 839       } else {
 840          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGetCompresssedTexImage");
 841       }
 842    }
 843
 844    if (_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
 845       ctx->Driver.UnmapBuffer(ctx, ctx->Pack.BufferObj, MAP_INTERNAL);
 846    }
 847 }
 848
 849
 850 /**
 851  * Validate the texture target enum supplied to glGetTex(ture)Image or
 852  * glGetCompressedTex(ture)Image.
 853  */
 854 static GLboolean
 855 legal_getteximage_target(struct gl_context *ctx, GLenum target, bool dsa)
 856 {
 857    switch (target) {
 858    case GL_TEXTURE_1D:
 859    case GL_TEXTURE_2D:
 860    case GL_TEXTURE_3D:
 861       return GL_TRUE;
 862    case GL_TEXTURE_RECTANGLE_NV:
 863       return ctx->Extensions.NV_texture_rectangle;
 864    case GL_TEXTURE_1D_ARRAY_EXT:
 865    case GL_TEXTURE_2D_ARRAY_EXT:
 866       return ctx->Extensions.EXT_texture_array;
 867    case GL_TEXTURE_CUBE_MAP_ARRAY:
 868       return ctx->Extensions.ARB_texture_cube_map_array;
 869
 870    /* Section 8.11 (Texture Queries) of the OpenGL 4.5 core profile spec
 871     * (30.10.2014) says:
 872     *    "An INVALID_ENUM error is generated if the effective target is not
 873     *    one of TEXTURE_1D, TEXTURE_2D, TEXTURE_3D, TEXTURE_1D_ARRAY,
 874     *    TEXTURE_2D_ARRAY, TEXTURE_CUBE_MAP_ARRAY, TEXTURE_RECTANGLE, one of
 875     *    the targets from table 8.19 (for GetTexImage and GetnTexImage *only*),
 876     *    or TEXTURE_CUBE_MAP (for GetTextureImage *only*)." (Emphasis added.)
 877     */
 878    case GL_TEXTURE_CUBE_MAP_POSITIVE_X_ARB:
 879    case GL_TEXTURE_CUBE_MAP_NEGATIVE_X_ARB:
 880    case GL_TEXTURE_CUBE_MAP_POSITIVE_Y_ARB:
 881    case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y_ARB:
 882    case GL_TEXTURE_CUBE_MAP_POSITIVE_Z_ARB:
 883    case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z_ARB:
 884       return dsa ? GL_FALSE : ctx->Extensions.ARB_texture_cube_map;
 885    case GL_TEXTURE_CUBE_MAP:
 886       return dsa ? GL_TRUE : GL_FALSE;
 887    default:
 888       return GL_FALSE;
 889    }
 890 }
 891
 892
 893 /**
 894  * Do error checking for a glGetTex(ture)Image() call.
 895  * \return GL_TRUE if any error, GL_FALSE if no errors.
 896  */
 897 static GLboolean
 898 getteximage_error_check(struct gl_context *ctx,
 899                         struct gl_texture_image *texImage,
 900                         GLenum target, GLint level,
 901                         GLenum format, GLenum type, GLsizei clientMemSize,
 902                         GLvoid *pixels, bool dsa)
 903 {
 904    const GLint maxLevels = _mesa_max_texture_levels(ctx, target);
 905    const GLuint dimensions = (target == GL_TEXTURE_3D) ? 3 : 2;
 906    GLenum baseFormat;
 907    const char *suffix = dsa ? "ture" : "";
 908
 909    assert(texImage);
 910    assert(maxLevels != 0);
 911    if (level < 0 || level >= maxLevels) {
 912       _mesa_error(ctx, GL_INVALID_VALUE,
 913                   "glGetTex%sImage(level out of range)", suffix);
 914       return GL_TRUE;
 915    }
 916
 917    /*
 918     * Format and type checking has been moved up to GetnTexImage and
 919     * GetTextureImage so that it happens before getting the texImage object.
 920     */
 921
 922    baseFormat = _mesa_get_format_base_format(texImage->TexFormat);
 923
 924    /* Make sure the requested image format is compatible with the
 925     * texture's format.
 926     */
 927    if (_mesa_is_color_format(format)
 928        && !_mesa_is_color_format(baseFormat)) {
 929       _mesa_error(ctx, GL_INVALID_OPERATION,
 930                   "glGetTex%sImage(format mismatch)", suffix);
 931       return GL_TRUE;
 932    }
 933    else if (_mesa_is_depth_format(format)
 934             && !_mesa_is_depth_format(baseFormat)
 935             && !_mesa_is_depthstencil_format(baseFormat)) {
 936       _mesa_error(ctx, GL_INVALID_OPERATION,
 937                   "glGetTex%sImage(format mismatch)", suffix);
 938       return GL_TRUE;
 939    }
 940    else if (_mesa_is_stencil_format(format)
 941             && !ctx->Extensions.ARB_texture_stencil8) {
 942       _mesa_error(ctx, GL_INVALID_ENUM,
 943                   "glGetTex%sImage(format=GL_STENCIL_INDEX)", suffix);
 944       return GL_TRUE;
 945    }
 946    else if (_mesa_is_ycbcr_format(format)
 947             && !_mesa_is_ycbcr_format(baseFormat)) {
 948       _mesa_error(ctx, GL_INVALID_OPERATION,
 949                   "glGetTex%sImage(format mismatch)", suffix);
 950       return GL_TRUE;
 951    }
 952    else if (_mesa_is_depthstencil_format(format)
 953             && !_mesa_is_depthstencil_format(baseFormat)) {
 954       _mesa_error(ctx, GL_INVALID_OPERATION,
 955                   "glGetTex%sImage(format mismatch)", suffix);
 956       return GL_TRUE;
 957    }
 958    else if (!_mesa_is_stencil_format(format) &&
 959             _mesa_is_enum_format_integer(format) !=
 960             _mesa_is_format_integer(texImage->TexFormat)) {
 961       _mesa_error(ctx, GL_INVALID_OPERATION,
 962                   "glGetTex%sImage(format mismatch)", suffix);
 963       return GL_TRUE;
 964    }
 965
 966    if (!_mesa_validate_pbo_access(dimensions, &ctx->Pack, texImage->Width,
 967                                   texImage->Height, texImage->Depth,
 968                                   format, type, clientMemSize, pixels)) {
 969       if (_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
 970          _mesa_error(ctx, GL_INVALID_OPERATION,
 971                      "glGetTex%sImage(out of bounds PBO access)", suffix);
 972       } else {
 973          _mesa_error(ctx, GL_INVALID_OPERATION,
 974                      "%s(out of bounds access:"
 975                      " bufSize (%d) is too small)",
 976                      dsa ? "glGetTextureImage" : "glGetnTexImageARB",
 977                      clientMemSize);
 978       }
 979       return GL_TRUE;
 980    }
 981
 982    if (_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
 983       /* PBO should not be mapped */
 984       if (_mesa_check_disallowed_mapping(ctx->Pack.BufferObj)) {
 985          _mesa_error(ctx, GL_INVALID_OPERATION,
 986                      "glGetTex%sImage(PBO is mapped)", suffix);
 987          return GL_TRUE;
 988       }
 989    }
 990
 991    return GL_FALSE;
 992 }
 993
 994
 995 /**
 996  * This is the implementation for glGetnTexImageARB, glGetTextureImage,
 997  * and glGetTexImage.
 998  *
 999  * Requires caller to pass in texImage object because _mesa_GetTextureImage
1000  * must handle the GL_TEXTURE_CUBE_MAP target.
1001  *
1002  * \param target texture target.
1003  * \param level image level.
1004  * \param format pixel data format for returned image.
1005  * \param type pixel data type for returned image.
1006  * \param bufSize size of the pixels data buffer.
1007  * \param pixels returned pixel data.
1008  * \param dsa True when the caller is an ARB_direct_state_access function,
1009  *            false otherwise
1010  */
1011 static void
1012 get_texture_image(struct gl_context *ctx,
1013                   struct gl_texture_object *texObj,
1014                   struct gl_texture_image *texImage, GLenum target,
1015                   GLint level, GLenum format, GLenum type,
1016                   GLsizei bufSize, GLvoid *pixels, bool dsa)
1017 {
1018    assert(texObj);
1019    assert(texImage);
1020
1021    FLUSH_VERTICES(ctx, 0);
1022
1023    /*
1024     * Legal target checking has been moved up to GetnTexImage and
1025     * GetTextureImage so that it can be caught before receiving a NULL
1026     * texImage object and exiting.
1027     */
1028
1029    if (getteximage_error_check(ctx, texImage, target, level, format,
1030                                type, bufSize, pixels, dsa)) {
1031       return;
1032    }
1033
1034    if (!_mesa_is_bufferobj(ctx->Pack.BufferObj) && !pixels) {
1035       /* not an error, do nothing */
1036       return;
1037    }
1038
1039    if (_mesa_is_zero_size_texture(texImage))
1040       return;
1041
1042    if (MESA_VERBOSE & (VERBOSE_API | VERBOSE_TEXTURE)) {
1043       _mesa_debug(ctx, "glGetTex%sImage(tex %u) format = %s, w=%d, h=%d,"
1044                   " dstFmt=0x%x, dstType=0x%x\n",
1045                   dsa ? "ture": "",
1046                   texObj->Name,
1047                   _mesa_get_format_name(texImage->TexFormat),
1048                   texImage->Width, texImage->Height,
1049                   format, type);
1050    }
1051
1052    _mesa_lock_texture(ctx, texObj);
1053    {
1054       ctx->Driver.GetTexSubImage(ctx, 0, 0, 0,
1055                                  texImage->Width, texImage->Height,
1056                                  texImage->Depth,
1057                                  format, type, pixels, texImage);
1058    }
1059    _mesa_unlock_texture(ctx, texObj);
1060 }
1061
1062 /**
1063  * Get texture image.  Called by glGetTexImage.
1064  *
1065  * \param target texture target.
1066  * \param level image level.
1067  * \param format pixel data format for returned image.
1068  * \param type pixel data type for returned image.
1069  * \param bufSize size of the pixels data buffer.
1070  * \param pixels returned pixel data.
1071  */
1072 void GLAPIENTRY
1073 _mesa_GetnTexImageARB(GLenum target, GLint level, GLenum format,
1074                       GLenum type, GLsizei bufSize, GLvoid *pixels)
1075 {
1076    struct gl_texture_object *texObj;
1077    struct gl_texture_image *texImage;
1078    GLenum err;
1079    GET_CURRENT_CONTEXT(ctx);
1080
1081    /*
1082     * This has been moved here because a format/type mismatch can cause a NULL
1083     * texImage object, which in turn causes the mismatch error to be
1084     * ignored.
1085     */
1086    err = _mesa_error_check_format_and_type(ctx, format, type);
1087    if (err != GL_NO_ERROR) {
1088       _mesa_error(ctx, err, "glGetnTexImage(format/type)");
1089       return;
1090    }
1091
1092    /*
1093     * Legal target checking has been moved here to prevent exiting with a NULL
1094     * texImage object.
1095     */
1096    if (!legal_getteximage_target(ctx, target, false)) {
1097       _mesa_error(ctx, GL_INVALID_ENUM, "glGetnTexImage(target=0x%x)",
1098                   target);
1099       return;
1100    }
1101
1102    texObj = _mesa_get_current_tex_object(ctx, target);
1103    if (!texObj)
1104       return;
1105
1106    texImage = _mesa_select_tex_image(texObj, target, level);
1107    if (!texImage)
1108       return;
1109
1110    get_texture_image(ctx, texObj, texImage, target, level, format, type,
1111                      bufSize, pixels, false);
1112 }
1113
1114
1115 void GLAPIENTRY
1116 _mesa_GetTexImage( GLenum target, GLint level, GLenum format,
1117                    GLenum type, GLvoid *pixels )
1118 {
1119    _mesa_GetnTexImageARB(target, level, format, type, INT_MAX, pixels);
1120 }
1121
1122 /**
1123  * Get texture image.
1124  *
1125  * \param texture texture name.
1126  * \param level image level.
1127  * \param format pixel data format for returned image.
1128  * \param type pixel data type for returned image.
1129  * \param bufSize size of the pixels data buffer.
1130  * \param pixels returned pixel data.
1131  */
1132 void GLAPIENTRY
1133 _mesa_GetTextureImage(GLuint texture, GLint level, GLenum format,
1134                       GLenum type, GLsizei bufSize, GLvoid *pixels)
1135 {
1136    struct gl_texture_object *texObj;
1137    struct gl_texture_image *texImage;
1138    int i;
1139    GLint image_stride;
1140    GLenum err;
1141    GET_CURRENT_CONTEXT(ctx);
1142
1143    /*
1144     * This has been moved here because a format/type mismatch can cause a NULL
1145     * texImage object, which in turn causes the mismatch error to be
1146     * ignored.
1147     */
1148    err = _mesa_error_check_format_and_type(ctx, format, type);
1149    if (err != GL_NO_ERROR) {
1150       _mesa_error(ctx, err, "glGetTextureImage(format/type)");
1151       return;
1152    }
1153
1154    texObj = _mesa_lookup_texture_err(ctx, texture, "glGetTextureImage");
1155    if (!texObj)
1156       return;
1157
1158    /*
1159     * Legal target checking has been moved here to prevent exiting with a NULL
1160     * texImage object.
1161     */
1162    if (!legal_getteximage_target(ctx, texObj->Target, true)) {
1163       _mesa_error(ctx, GL_INVALID_ENUM, "glGetTextureImage(target=%s)",
1164                   _mesa_enum_to_string(texObj->Target));
1165       return;
1166    }
1167
1168    /* Must handle special case GL_TEXTURE_CUBE_MAP. */
1169    if (texObj->Target == GL_TEXTURE_CUBE_MAP) {
1170
1171       /* Make sure the texture object is a proper cube.
1172        * (See texturesubimage in teximage.c for details on why this check is
1173        * performed.)
1174        */
1175       if (!_mesa_cube_level_complete(texObj, level)) {
1176          _mesa_error(ctx, GL_INVALID_OPERATION,
1177                      "glGetTextureImage(cube map incomplete)");
1178          return;
1179       }
1180
1181       /* Copy each face. */
1182       for (i = 0; i < 6; ++i) {
1183          texImage = texObj->Image[i][level];
1184          assert(texImage);
1185
1186          get_texture_image(ctx, texObj, texImage, texObj->Target, level,
1187                            format, type, bufSize, pixels, true);
1188
1189          image_stride = _mesa_image_image_stride(&ctx->Pack, texImage->Width,
1190                                                  texImage->Height, format,
1191                                                  type);
1192          pixels = (GLubyte *) pixels + image_stride;
1193          bufSize -= image_stride;
1194       }
1195    }
1196    else {
1197       texImage = _mesa_select_tex_image(texObj, texObj->Target, level);
1198       if (!texImage)
1199          return;
1200
1201       get_texture_image(ctx, texObj, texImage, texObj->Target, level,
1202                         format, type, bufSize, pixels, true);
1203    }
1204 }
1205
1206 /**
1207  * Do error checking for a glGetCompressedTexImage() call.
1208  * \return GL_TRUE if any error, GL_FALSE if no errors.
1209  */
1210 static GLboolean
1211 getcompressedteximage_error_check(struct gl_context *ctx,
1212                                   struct gl_texture_image *texImage,
1213                                   GLenum target,
1214                                   GLint level, GLsizei clientMemSize,
1215                                   GLvoid *img, bool dsa)
1216 {
1217    const GLint maxLevels = _mesa_max_texture_levels(ctx, target);
1218    GLuint compressedSize, dimensions;
1219    const char *suffix = dsa ? "ture" : "";
1220
1221    assert(texImage);
1222
1223    if (!legal_getteximage_target(ctx, target, dsa)) {
1224       _mesa_error(ctx, GL_INVALID_ENUM,
1225                   "glGetCompressedTex%sImage(target=%s)", suffix,
1226                   _mesa_enum_to_string(target));
1227       return GL_TRUE;
1228    }
1229
1230    assert(maxLevels != 0);
1231    if (level < 0 || level >= maxLevels) {
1232       _mesa_error(ctx, GL_INVALID_VALUE,
1233                   "glGetCompressedTex%sImage(bad level = %d)", suffix, level);
1234       return GL_TRUE;
1235    }
1236
1237    if (!_mesa_is_format_compressed(texImage->TexFormat)) {
1238       _mesa_error(ctx, GL_INVALID_OPERATION,
1239                   "glGetCompressedTex%sImage(texture is not compressed)",
1240                   suffix);
1241       return GL_TRUE;
1242    }
1243
1244    compressedSize = _mesa_format_image_size(texImage->TexFormat,
1245                                             texImage->Width,
1246                                             texImage->Height,
1247                                             texImage->Depth);
1248
1249    /* Check for invalid pixel storage modes */
1250    dimensions = _mesa_get_texture_dimensions(texImage->TexObject->Target);
1251    if (!_mesa_compressed_pixel_storage_error_check(ctx, dimensions,
1252                                               &ctx->Pack, dsa ?
1253                                               "glGetCompressedTextureImage":
1254                                               "glGetCompressedTexImage")) {
1255       return GL_TRUE;
1256    }
1257
1258    if (!_mesa_is_bufferobj(ctx->Pack.BufferObj)) {
1259       /* do bounds checking on writing to client memory */
1260       if (clientMemSize < (GLsizei) compressedSize) {
1261          _mesa_error(ctx, GL_INVALID_OPERATION,
1262                      "%s(out of bounds access: bufSize (%d) is too small)",
1263                      dsa ? "glGetCompressedTextureImage" :
1264                      "glGetnCompressedTexImageARB", clientMemSize);
1265          return GL_TRUE;
1266       }
1267    } else {
1268       /* do bounds checking on PBO write */
1269       if ((const GLubyte *) img + compressedSize >
1270           (const GLubyte *) ctx->Pack.BufferObj->Size) {
1271          _mesa_error(ctx, GL_INVALID_OPERATION,
1272                      "glGetCompressedTex%sImage(out of bounds PBO access)",
1273                      suffix);
1274          return GL_TRUE;
1275       }
1276
1277       /* make sure PBO is not mapped */
1278       if (_mesa_check_disallowed_mapping(ctx->Pack.BufferObj)) {
1279          _mesa_error(ctx, GL_INVALID_OPERATION,
1280                      "glGetCompressedTex%sImage(PBO is mapped)", suffix);
1281          return GL_TRUE;
1282       }
1283    }
1284
1285    return GL_FALSE;
1286 }
1287
1288 /** Implements glGetnCompressedTexImageARB, glGetCompressedTexImage, and
1289  * glGetCompressedTextureImage.
1290  *
1291  * texImage must be passed in because glGetCompressedTexImage must handle the
1292  * target GL_TEXTURE_CUBE_MAP.
1293  */
1294 void
1295 _mesa_get_compressed_texture_image(struct gl_context *ctx,
1296                                    struct gl_texture_object *texObj,
1297                                    struct gl_texture_image *texImage,
1298                                    GLenum target, GLint level,
1299                                    GLsizei bufSize, GLvoid *pixels,
1300                                    bool dsa)
1301 {
1302    assert(texObj);
1303    assert(texImage);
1304
1305    FLUSH_VERTICES(ctx, 0);
1306
1307    if (getcompressedteximage_error_check(ctx, texImage, target, level,
1308                                          bufSize, pixels, dsa)) {
1309       return;
1310    }
1311
1312    if (!_mesa_is_bufferobj(ctx->Pack.BufferObj) && !pixels) {
1313       /* not an error, do nothing */
1314       return;
1315    }
1316
1317    if (_mesa_is_zero_size_texture(texImage))
1318       return;
1319
1320    if (MESA_VERBOSE & (VERBOSE_API | VERBOSE_TEXTURE)) {
1321       _mesa_debug(ctx,
1322                   "glGetCompressedTex%sImage(tex %u) format = %s, w=%d, h=%d\n",
1323                   dsa ? "ture" : "", texObj->Name,
1324                   _mesa_get_format_name(texImage->TexFormat),
1325                   texImage->Width, texImage->Height);
1326    }
1327
1328    _mesa_lock_texture(ctx, texObj);
1329    {
1330       ctx->Driver.GetCompressedTexSubImage(ctx, texImage,
1331                                            0, 0, 0,
1332                                            texImage->Width, texImage->Height,
1333                                            texImage->Depth, pixels);
1334    }
1335    _mesa_unlock_texture(ctx, texObj);
1336 }
1337
1338 void GLAPIENTRY
1339 _mesa_GetnCompressedTexImageARB(GLenum target, GLint level, GLsizei bufSize,
1340                                 GLvoid *img)
1341 {
1342    struct gl_texture_object *texObj;
1343    struct gl_texture_image *texImage;
1344    GET_CURRENT_CONTEXT(ctx);
1345
1346    texObj = _mesa_get_current_tex_object(ctx, target);
1347    if (!texObj)
1348       return;
1349
1350    texImage = _mesa_select_tex_image(texObj, target, level);
1351    if (!texImage)
1352       return;
1353
1354    _mesa_get_compressed_texture_image(ctx, texObj, texImage, target, level,
1355                                       bufSize, img, false);
1356 }
1357
1358 void GLAPIENTRY
1359 _mesa_GetCompressedTexImage(GLenum target, GLint level, GLvoid *img)
1360 {
1361    _mesa_GetnCompressedTexImageARB(target, level, INT_MAX, img);
1362 }
1363
1364 /**
1365  * Get compressed texture image.
1366  *
1367  * \param texture texture name.
1368  * \param level image level.
1369  * \param bufSize size of the pixels data buffer.
1370  * \param pixels returned pixel data.
1371  */
1372 void GLAPIENTRY
1373 _mesa_GetCompressedTextureImage(GLuint texture, GLint level,
1374                                 GLsizei bufSize, GLvoid *pixels)
1375 {
1376    struct gl_texture_object *texObj;
1377    struct gl_texture_image *texImage;
1378    int i;
1379    GLint image_stride;
1380    GET_CURRENT_CONTEXT(ctx);
1381
1382    texObj = _mesa_lookup_texture_err(ctx, texture,
1383                                      "glGetCompressedTextureImage");
1384    if (!texObj)
1385       return;
1386
1387    /* Must handle special case GL_TEXTURE_CUBE_MAP. */
1388    if (texObj->Target == GL_TEXTURE_CUBE_MAP) {
1389
1390       /* Make sure the texture object is a proper cube.
1391        * (See texturesubimage in teximage.c for details on why this check is
1392        * performed.)
1393        */
1394       if (!_mesa_cube_level_complete(texObj, level)) {
1395          _mesa_error(ctx, GL_INVALID_OPERATION,
1396                      "glGetCompressedTextureImage(cube map incomplete)");
1397          return;
1398       }
1399
1400       /* Copy each face. */
1401       for (i = 0; i < 6; ++i) {
1402          texImage = texObj->Image[i][level];
1403          assert(texImage);
1404
1405          _mesa_get_compressed_texture_image(ctx, texObj, texImage,
1406                                             texObj->Target, level,
1407                                             bufSize, pixels, true);
1408
1409          /* Compressed images don't have a client format */
1410          image_stride = _mesa_format_image_size(texImage->TexFormat,
1411                                                 texImage->Width,
1412                                                 texImage->Height, 1);
1413
1414          pixels = (GLubyte *) pixels + image_stride;
1415          bufSize -= image_stride;
1416       }
1417    }
1418    else {
1419       texImage = _mesa_select_tex_image(texObj, texObj->Target, level);
1420       if (!texImage)
1421          return;
1422
1423       _mesa_get_compressed_texture_image(ctx, texObj, texImage,
1424                                          texObj->Target, level, bufSize,
1425                                          pixels, true);
1426    }
1427 }