src/mesa/state_tracker/st_texture.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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 #include <stdio.h>
  29
  30 #include "st_context.h"
  31 #include "st_format.h"
  32 #include "st_texture.h"
  33 #include "st_cb_fbo.h"
  34 #include "main/enums.h"
  35
  36 #include "pipe/p_state.h"
  37 #include "pipe/p_context.h"
  38 #include "pipe/p_defines.h"
  39 #include "util/u_inlines.h"
  40 #include "util/u_format.h"
  41 #include "util/u_rect.h"
  42 #include "util/u_math.h"
  43 #include "util/u_memory.h"
  44
  45
  46 #define DBG if(0) printf
  47
  48
  49 /**
  50  * Allocate a new pipe_resource object
  51  * width0, height0, depth0 are the dimensions of the level 0 image
  52  * (the highest resolution).  last_level indicates how many mipmap levels
  53  * to allocate storage for.  For non-mipmapped textures, this will be zero.
  54  */
  55 struct pipe_resource *
  56 st_texture_create(struct st_context *st,
  57                   enum pipe_texture_target target,
  58                   enum pipe_format format,
  59                   GLuint last_level,
  60                   GLuint width0,
  61                   GLuint height0,
  62                   GLuint depth0,
  63                   GLuint layers,
  64                   GLuint nr_samples,
  65                   GLuint bind )
  66 {
  67    struct pipe_resource pt, *newtex;
  68    struct pipe_screen *screen = st->pipe->screen;
  69
  70    assert(target < PIPE_MAX_TEXTURE_TYPES);
  71    assert(width0 > 0);
  72    assert(height0 > 0);
  73    assert(depth0 > 0);
  74    if (target == PIPE_TEXTURE_CUBE)
  75       assert(layers == 6);
  76
  77    DBG("%s target %d format %s last_level %d\n", __FUNCTION__,
  78        (int) target, util_format_name(format), last_level);
  79
  80    assert(format);
  81    assert(screen->is_format_supported(screen, format, target, 0,
  82                                       PIPE_BIND_SAMPLER_VIEW));
  83
  84    memset(&pt, 0, sizeof(pt));
  85    pt.target = target;
  86    pt.format = format;
  87    pt.last_level = last_level;
  88    pt.width0 = width0;
  89    pt.height0 = height0;
  90    pt.depth0 = depth0;
  91    pt.array_size = (target == PIPE_TEXTURE_CUBE ? 6 : layers);
  92    pt.usage = PIPE_USAGE_DEFAULT;
  93    pt.bind = bind;
  94    pt.flags = 0;
  95    pt.nr_samples = nr_samples;
  96
  97    newtex = screen->resource_create(screen, &pt);
  98
  99    assert(!newtex || pipe_is_referenced(&newtex->reference));
 100
 101    return newtex;
 102 }
 103
 104
 105 /**
 106  * In OpenGL the number of 1D array texture layers is the "height" and
 107  * the number of 2D array texture layers is the "depth".  In Gallium the
 108  * number of layers in an array texture is a separate 'array_size' field.
 109  * This function converts dimensions from the former to the later.
 110  */
 111 void
 112 st_gl_texture_dims_to_pipe_dims(GLenum texture,
 113                                 GLuint widthIn,
 114                                 GLuint heightIn,
 115                                 GLuint depthIn,
 116                                 GLuint *widthOut,
 117                                 GLuint *heightOut,
 118                                 GLuint *depthOut,
 119                                 GLuint *layersOut)
 120 {
 121    switch (texture) {
 122    case GL_TEXTURE_1D:
 123    case GL_PROXY_TEXTURE_1D:
 124       assert(heightIn == 1);
 125       assert(depthIn == 1);
 126       *widthOut = widthIn;
 127       *heightOut = 1;
 128       *depthOut = 1;
 129       *layersOut = 1;
 130       break;
 131    case GL_TEXTURE_1D_ARRAY:
 132    case GL_PROXY_TEXTURE_1D_ARRAY:
 133       assert(depthIn == 1);
 134       *widthOut = widthIn;
 135       *heightOut = 1;
 136       *depthOut = 1;
 137       *layersOut = heightIn;
 138       break;
 139    case GL_TEXTURE_2D:
 140    case GL_PROXY_TEXTURE_2D:
 141    case GL_TEXTURE_RECTANGLE:
 142    case GL_PROXY_TEXTURE_RECTANGLE:
 143    case GL_TEXTURE_EXTERNAL_OES:
 144    case GL_PROXY_TEXTURE_2D_MULTISAMPLE:
 145    case GL_TEXTURE_2D_MULTISAMPLE:
 146       assert(depthIn == 1);
 147       *widthOut = widthIn;
 148       *heightOut = heightIn;
 149       *depthOut = 1;
 150       *layersOut = 1;
 151       break;
 152    case GL_TEXTURE_CUBE_MAP:
 153    case GL_PROXY_TEXTURE_CUBE_MAP:
 154    case GL_TEXTURE_CUBE_MAP_POSITIVE_X:
 155    case GL_TEXTURE_CUBE_MAP_NEGATIVE_X:
 156    case GL_TEXTURE_CUBE_MAP_POSITIVE_Y:
 157    case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y:
 158    case GL_TEXTURE_CUBE_MAP_POSITIVE_Z:
 159    case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z:
 160       assert(depthIn == 1);
 161       *widthOut = widthIn;
 162       *heightOut = heightIn;
 163       *depthOut = 1;
 164       *layersOut = 6;
 165       break;
 166    case GL_TEXTURE_2D_ARRAY:
 167    case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
 168    case GL_PROXY_TEXTURE_2D_ARRAY:
 169    case GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY:
 170       *widthOut = widthIn;
 171       *heightOut = heightIn;
 172       *depthOut = 1;
 173       *layersOut = depthIn;
 174       break;
 175    case GL_TEXTURE_CUBE_MAP_ARRAY:
 176    case GL_PROXY_TEXTURE_CUBE_MAP_ARRAY:
 177       *widthOut = widthIn;
 178       *heightOut = heightIn;
 179       *depthOut = 1;
 180       *layersOut = depthIn;
 181       break;
 182    default:
 183       assert(0 && "Unexpected texture in st_gl_texture_dims_to_pipe_dims()");
 184       /* fall-through */
 185    case GL_TEXTURE_3D:
 186    case GL_PROXY_TEXTURE_3D:
 187       *widthOut = widthIn;
 188       *heightOut = heightIn;
 189       *depthOut = depthIn;
 190       *layersOut = 1;
 191       break;
 192    }
 193 }
 194
 195
 196 /**
 197  * Check if a texture image can be pulled into a unified mipmap texture.
 198  */
 199 GLboolean
 200 st_texture_match_image(const struct pipe_resource *pt,
 201                        const struct gl_texture_image *image)
 202 {
 203    GLuint ptWidth, ptHeight, ptDepth, ptLayers;
 204
 205    /* Images with borders are never pulled into mipmap textures.
 206     */
 207    if (image->Border)
 208       return GL_FALSE;
 209
 210    /* Check if this image's format matches the established texture's format.
 211     */
 212    if (st_mesa_format_to_pipe_format(image->TexFormat) != pt->format)
 213       return GL_FALSE;
 214
 215    st_gl_texture_dims_to_pipe_dims(image->TexObject->Target,
 216                                    image->Width, image->Height, image->Depth,
 217                                    &ptWidth, &ptHeight, &ptDepth, &ptLayers);
 218
 219    /* Test if this image's size matches what's expected in the
 220     * established texture.
 221     */
 222    if (ptWidth != u_minify(pt->width0, image->Level) ||
 223        ptHeight != u_minify(pt->height0, image->Level) ||
 224        ptDepth != u_minify(pt->depth0, image->Level) ||
 225        ptLayers != pt->array_size)
 226       return GL_FALSE;
 227
 228    return GL_TRUE;
 229 }
 230
 231
 232 /**
 233  * Map a texture image and return the address for a particular 2D face/slice/
 234  * layer.  The stImage indicates the cube face and mipmap level.  The slice
 235  * of the 3D texture is passed in 'zoffset'.
 236  * \param usage  one of the PIPE_TRANSFER_x values
 237  * \param x, y, w, h  the region of interest of the 2D image.
 238  * \return address of mapping or NULL if any error
 239  */
 240 GLubyte *
 241 st_texture_image_map(struct st_context *st, struct st_texture_image *stImage,
 242                      enum pipe_transfer_usage usage,
 243                      GLuint x, GLuint y, GLuint z,
 244                      GLuint w, GLuint h, GLuint d,
 245                      struct pipe_transfer **transfer)
 246 {
 247    struct st_texture_object *stObj =
 248       st_texture_object(stImage->base.TexObject);
 249    GLuint level;
 250    void *map;
 251
 252    DBG("%s \n", __FUNCTION__);
 253
 254    if (!stImage->pt)
 255       return NULL;
 256
 257    if (stObj->pt != stImage->pt)
 258       level = 0;
 259    else
 260       level = stImage->base.Level;
 261
 262    z += stImage->base.Face;
 263
 264    map = pipe_transfer_map_3d(st->pipe, stImage->pt, level, usage,
 265                               x, y, z, w, h, d, transfer);
 266    if (map) {
 267       /* Enlarge the transfer array if it's not large enough. */
 268       if (z >= stImage->num_transfers) {
 269          unsigned new_size = z + 1;
 270
 271          stImage->transfer = realloc(stImage->transfer,
 272                                      new_size * sizeof(void*));
 273          memset(&stImage->transfer[stImage->num_transfers], 0,
 274                (new_size - stImage->num_transfers) * sizeof(void*));
 275          stImage->num_transfers = new_size;
 276       }
 277
 278       assert(!stImage->transfer[z]);
 279       stImage->transfer[z] = *transfer;
 280    }
 281    return map;
 282 }
 283
 284
 285 void
 286 st_texture_image_unmap(struct st_context *st,
 287                        struct st_texture_image *stImage, unsigned slice)
 288 {
 289    struct pipe_context *pipe = st->pipe;
 290    struct pipe_transfer **transfer =
 291       &stImage->transfer[slice + stImage->base.Face];
 292
 293    DBG("%s\n", __FUNCTION__);
 294
 295    pipe_transfer_unmap(pipe, *transfer);
 296    *transfer = NULL;
 297 }
 298
 299
 300 /* Upload data for a particular image.
 301  */
 302 void
 303 st_texture_image_data(struct st_context *st,
 304                       struct pipe_resource *dst,
 305                       GLuint face,
 306                       GLuint level,
 307                       void *src,
 308                       GLuint src_row_stride, GLuint src_image_stride)
 309 {
 310    struct pipe_context *pipe = st->pipe;
 311    GLuint i;
 312    const GLubyte *srcUB = src;
 313    GLuint layers;
 314
 315    if (dst->target == PIPE_TEXTURE_1D_ARRAY ||
 316        dst->target == PIPE_TEXTURE_2D_ARRAY ||
 317        dst->target == PIPE_TEXTURE_CUBE_ARRAY)
 318       layers = dst->array_size;
 319    else
 320       layers = u_minify(dst->depth0, level);
 321
 322    DBG("%s\n", __FUNCTION__);
 323
 324    for (i = 0; i < layers; i++) {
 325       struct pipe_box box;
 326       u_box_2d_zslice(0, 0, face + i,
 327                       u_minify(dst->width0, level),
 328                       u_minify(dst->height0, level),
 329                       &box);
 330
 331       pipe->transfer_inline_write(pipe, dst, level, PIPE_TRANSFER_WRITE,
 332                                   &box, srcUB, src_row_stride, 0);
 333
 334       srcUB += src_image_stride;
 335    }
 336 }
 337
 338
 339 /**
 340  * For debug only: get/print center pixel in the src resource.
 341  */
 342 static void
 343 print_center_pixel(struct pipe_context *pipe, struct pipe_resource *src)
 344 {
 345    struct pipe_transfer *xfer;
 346    struct pipe_box region;
 347    ubyte *map;
 348
 349    region.x = src->width0 / 2;
 350    region.y = src->height0 / 2;
 351    region.z = 0;
 352    region.width = 1;
 353    region.height = 1;
 354    region.depth = 1;
 355
 356    map = pipe->transfer_map(pipe, src, 0, PIPE_TRANSFER_READ, &region, &xfer);
 357
 358    printf("center pixel: %d %d %d %d\n", map[0], map[1], map[2], map[3]);
 359
 360    pipe->transfer_unmap(pipe, xfer);
 361 }
 362
 363
 364 /**
 365  * Copy the image at level=0 in 'src' to the 'dst' resource at 'dstLevel'.
 366  * This is used to copy mipmap images from one texture buffer to another.
 367  * This typically happens when our initial guess at the total texture size
 368  * is incorrect (see the guess_and_alloc_texture() function).
 369  */
 370 void
 371 st_texture_image_copy(struct pipe_context *pipe,
 372                       struct pipe_resource *dst, GLuint dstLevel,
 373                       struct pipe_resource *src, GLuint srcLevel,
 374                       GLuint face)
 375 {
 376    GLuint width = u_minify(dst->width0, dstLevel);
 377    GLuint height = u_minify(dst->height0, dstLevel);
 378    GLuint depth = u_minify(dst->depth0, dstLevel);
 379    struct pipe_box src_box;
 380    GLuint i;
 381
 382    if (u_minify(src->width0, srcLevel) != width ||
 383        u_minify(src->height0, srcLevel) != height ||
 384        u_minify(src->depth0, srcLevel) != depth) {
 385       /* The source image size doesn't match the destination image size.
 386        * This can happen in some degenerate situations such as rendering to a
 387        * cube map face which was set up with mismatched texture sizes.
 388        */
 389       return;
 390    }
 391
 392    src_box.x = 0;
 393    src_box.y = 0;
 394    src_box.width = width;
 395    src_box.height = height;
 396    src_box.depth = 1;
 397    /* Loop over 3D image slices */
 398    /* could (and probably should) use "true" 3d box here -
 399       but drivers can't quite handle it yet */
 400    for (i = face; i < face + depth; i++) {
 401       src_box.z = i;
 402
 403       if (0)  {
 404          print_center_pixel(pipe, src);
 405       }
 406
 407       pipe->resource_copy_region(pipe,
 408                                  dst,
 409                                  dstLevel,
 410                                  0, 0, i,/* destX, Y, Z */
 411                                  src,
 412                                  srcLevel,
 413                                  &src_box);
 414    }
 415 }
 416
 417
 418 struct pipe_resource *
 419 st_create_color_map_texture(struct gl_context *ctx)
 420 {
 421    struct st_context *st = st_context(ctx);
 422    struct pipe_resource *pt;
 423    enum pipe_format format;
 424    const uint texSize = 256; /* simple, and usually perfect */
 425
 426    /* find an RGBA texture format */
 427    format = st_choose_format(st, GL_RGBA, GL_NONE, GL_NONE,
 428                              PIPE_TEXTURE_2D, 0, PIPE_BIND_SAMPLER_VIEW,
 429                              FALSE);
 430
 431    /* create texture for color map/table */
 432    pt = st_texture_create(st, PIPE_TEXTURE_2D, format, 0,
 433                           texSize, texSize, 1, 1, 0, PIPE_BIND_SAMPLER_VIEW);
 434    return pt;
 435 }
 436
 437 /**
 438  * Try to find a matching sampler view for the given context.
 439  * If none is found an empty slot is initialized with a
 440  * template and returned instead.
 441  */
 442 struct pipe_sampler_view **
 443 st_texture_get_sampler_view(struct st_context *st,
 444                             struct st_texture_object *stObj)
 445 {
 446    struct pipe_sampler_view **used = NULL, **free = NULL;
 447    GLuint i;
 448
 449    for (i = 0; i < stObj->num_sampler_views; ++i) {
 450       struct pipe_sampler_view **sv = &stObj->sampler_views[i];
 451       /* Is the array entry used ? */
 452       if (*sv) {
 453          /* Yes, check if it's the right one */
 454          if ((*sv)->context == st->pipe)
 455             return sv;
 456
 457          /* Wasn't the right one, but remember it as template */
 458          used = sv;
 459       } else {
 460          /* Found a free slot, remember that */
 461          free = sv;
 462       }
 463    }
 464
 465    /* Couldn't find a slot for our context, create a new one */
 466
 467    if (!free) {
 468       /* Haven't even found a free one, resize the array */
 469       GLuint old_size = stObj->num_sampler_views * sizeof(void *);
 470       GLuint new_size = old_size + sizeof(void *);
 471       stObj->sampler_views = REALLOC(stObj->sampler_views, old_size, new_size);
 472       free = &stObj->sampler_views[stObj->num_sampler_views++];
 473       *free = NULL;
 474    }
 475
 476    /* Add just any sampler view to be used as a template */
 477    if (used)
 478       pipe_sampler_view_reference(free, *used);
 479
 480    return free;
 481 }
 482
 483 void
 484 st_texture_release_sampler_view(struct st_context *st,
 485                                 struct st_texture_object *stObj)
 486 {
 487    GLuint i;
 488
 489    for (i = 0; i < stObj->num_sampler_views; ++i) {
 490       struct pipe_sampler_view **sv = &stObj->sampler_views[i];
 491
 492       if (*sv && (*sv)->context == st->pipe) {
 493          pipe_sampler_view_reference(sv, NULL);
 494          break;
 495       }
 496    }
 497 }
 498
 499 void
 500 st_texture_release_all_sampler_views(struct st_texture_object *stObj)
 501 {
 502    GLuint i;
 503
 504    for (i = 0; i < stObj->num_sampler_views; ++i)
 505       pipe_sampler_view_reference(&stObj->sampler_views[i], NULL);
 506 }
 507
 508
 509 void
 510 st_texture_free_sampler_views(struct st_texture_object *stObj)
 511 {
 512    /* NOTE:
 513     * We use FREE() here to match REALLOC() above.  Both come from
 514     * u_memory.h, not imports.h.  If we mis-match MALLOC/FREE from
 515     * those two headers we can trash the heap.
 516     */
 517    FREE(stObj->sampler_views);
 518 }