src/mesa/state_tracker/st_cb_fbo.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28
  29 /**
  30  * Framebuffer/renderbuffer functions.
  31  *
  32  * \author Brian Paul
  33  */
  34
  35
  36 #include "main/imports.h"
  37 #include "main/context.h"
  38 #include "main/fbobject.h"
  39 #include "main/framebuffer.h"
  40 #include "main/macros.h"
  41 #include "main/renderbuffer.h"
  42
  43 #include "pipe/p_context.h"
  44 #include "pipe/p_defines.h"
  45 #include "pipe/p_screen.h"
  46 #include "st_context.h"
  47 #include "st_cb_fbo.h"
  48 #include "st_cb_flush.h"
  49 #include "st_format.h"
  50 #include "st_texture.h"
  51 #include "st_manager.h"
  52
  53 #include "util/u_format.h"
  54 #include "util/u_inlines.h"
  55
  56
  57 /**
  58  * gl_renderbuffer::AllocStorage()
  59  * This is called to allocate the original drawing surface, and
  60  * during window resize.
  61  */
  62 static GLboolean
  63 st_renderbuffer_alloc_storage(GLcontext * ctx, struct gl_renderbuffer *rb,
  64                               GLenum internalFormat,
  65                               GLuint width, GLuint height)
  66 {
  67    struct st_context *st = st_context(ctx);
  68    struct pipe_screen *screen = st->pipe->screen;
  69    struct st_renderbuffer *strb = st_renderbuffer(rb);
  70    enum pipe_format format;
  71
  72    if (strb->format != PIPE_FORMAT_NONE)
  73       format = strb->format;
  74    else
  75       format = st_choose_renderbuffer_format(screen, internalFormat, rb->NumSamples);
  76
  77    /* init renderbuffer fields */
  78    strb->Base.Width  = width;
  79    strb->Base.Height = height;
  80    strb->Base.Format = st_pipe_format_to_mesa_format(format);
  81    strb->Base.DataType = st_format_datatype(format);
  82
  83    strb->defined = GL_FALSE;  /* undefined contents now */
  84
  85    if (strb->software) {
  86       size_t size;
  87
  88       free(strb->data);
  89
  90       assert(strb->format != PIPE_FORMAT_NONE);
  91
  92       strb->stride = util_format_get_stride(strb->format, width);
  93       size = util_format_get_2d_size(strb->format, strb->stride, height);
  94
  95       strb->data = malloc(size);
  96
  97       return strb->data != NULL;
  98    }
  99    else {
 100       struct pipe_resource template;
 101
 102       /* Free the old surface and texture
 103        */
 104       pipe_surface_reference( &strb->surface, NULL );
 105       pipe_resource_reference( &strb->texture, NULL );
 106       pipe_sampler_view_reference(&strb->sampler_view, NULL);
 107
 108       /* Setup new texture template.
 109        */
 110       memset(&template, 0, sizeof(template));
 111       template.target = st->internal_target;
 112       template.format = format;
 113       template.width0 = width;
 114       template.height0 = height;
 115       template.depth0 = 1;
 116       template.last_level = 0;
 117       template.nr_samples = rb->NumSamples;
 118       if (util_format_is_depth_or_stencil(format)) {
 119          template.bind = PIPE_BIND_DEPTH_STENCIL;
 120       }
 121       else {
 122          template.bind = (PIPE_BIND_DISPLAY_TARGET |
 123                           PIPE_BIND_RENDER_TARGET);
 124       }
 125
 126       strb->texture = screen->resource_create(screen, &template);
 127
 128       if (!strb->texture)
 129          return FALSE;
 130
 131       strb->surface = screen->get_tex_surface(screen,
 132                                               strb->texture,
 133                                               0, 0, 0,
 134                                               template.bind);
 135       if (strb->surface) {
 136          assert(strb->surface->texture);
 137          assert(strb->surface->format);
 138          assert(strb->surface->width == width);
 139          assert(strb->surface->height == height);
 140       }
 141
 142       return strb->surface != NULL;
 143    }
 144 }
 145
 146
 147 /**
 148  * gl_renderbuffer::Delete()
 149  */
 150 static void
 151 st_renderbuffer_delete(struct gl_renderbuffer *rb)
 152 {
 153    struct st_renderbuffer *strb = st_renderbuffer(rb);
 154    ASSERT(strb);
 155    pipe_surface_reference(&strb->surface, NULL);
 156    pipe_resource_reference(&strb->texture, NULL);
 157    pipe_sampler_view_reference(&strb->sampler_view, NULL);
 158    free(strb->data);
 159    free(strb);
 160 }
 161
 162
 163 /**
 164  * gl_renderbuffer::GetPointer()
 165  */
 166 static void *
 167 null_get_pointer(GLcontext * ctx, struct gl_renderbuffer *rb,
 168                  GLint x, GLint y)
 169 {
 170    /* By returning NULL we force all software rendering to go through
 171     * the span routines.
 172     */
 173 #if 0
 174    assert(0);  /* Should never get called with softpipe */
 175 #endif
 176    return NULL;
 177 }
 178
 179
 180 /**
 181  * Called via ctx->Driver.NewFramebuffer()
 182  */
 183 static struct gl_framebuffer *
 184 st_new_framebuffer(GLcontext *ctx, GLuint name)
 185 {
 186    /* XXX not sure we need to subclass gl_framebuffer for pipe */
 187    return _mesa_new_framebuffer(ctx, name);
 188 }
 189
 190
 191 /**
 192  * Called via ctx->Driver.NewRenderbuffer()
 193  */
 194 static struct gl_renderbuffer *
 195 st_new_renderbuffer(GLcontext *ctx, GLuint name)
 196 {
 197    struct st_renderbuffer *strb = ST_CALLOC_STRUCT(st_renderbuffer);
 198    if (strb) {
 199       _mesa_init_renderbuffer(&strb->Base, name);
 200       strb->Base.Delete = st_renderbuffer_delete;
 201       strb->Base.AllocStorage = st_renderbuffer_alloc_storage;
 202       strb->Base.GetPointer = null_get_pointer;
 203       strb->format = PIPE_FORMAT_NONE;
 204       return &strb->Base;
 205    }
 206    return NULL;
 207 }
 208
 209
 210 /**
 211  * Allocate a renderbuffer for a an on-screen window (not a user-created
 212  * renderbuffer).  The window system code determines the format.
 213  */
 214 struct gl_renderbuffer *
 215 st_new_renderbuffer_fb(enum pipe_format format, int samples, boolean sw)
 216 {
 217    struct st_renderbuffer *strb;
 218
 219    strb = ST_CALLOC_STRUCT(st_renderbuffer);
 220    if (!strb) {
 221       _mesa_error(NULL, GL_OUT_OF_MEMORY, "creating renderbuffer");
 222       return NULL;
 223    }
 224
 225    _mesa_init_renderbuffer(&strb->Base, 0);
 226    strb->Base.ClassID = 0x4242; /* just a unique value */
 227    strb->Base.NumSamples = samples;
 228    strb->Base.Format = st_pipe_format_to_mesa_format(format);
 229    strb->Base.DataType = st_format_datatype(format);
 230    strb->format = format;
 231    strb->software = sw;
 232
 233    switch (format) {
 234    case PIPE_FORMAT_R8G8B8A8_UNORM:
 235    case PIPE_FORMAT_B8G8R8A8_UNORM:
 236    case PIPE_FORMAT_A8R8G8B8_UNORM:
 237    case PIPE_FORMAT_R8G8B8X8_UNORM:
 238    case PIPE_FORMAT_B8G8R8X8_UNORM:
 239    case PIPE_FORMAT_X8R8G8B8_UNORM:
 240    case PIPE_FORMAT_B5G5R5A1_UNORM:
 241    case PIPE_FORMAT_B4G4R4A4_UNORM:
 242    case PIPE_FORMAT_B5G6R5_UNORM:
 243       strb->Base.InternalFormat = GL_RGBA;
 244       break;
 245    case PIPE_FORMAT_Z16_UNORM:
 246       strb->Base.InternalFormat = GL_DEPTH_COMPONENT16;
 247       break;
 248    case PIPE_FORMAT_Z32_UNORM:
 249       strb->Base.InternalFormat = GL_DEPTH_COMPONENT32;
 250       break;
 251    case PIPE_FORMAT_Z24_UNORM_S8_USCALED:
 252    case PIPE_FORMAT_S8_USCALED_Z24_UNORM:
 253    case PIPE_FORMAT_Z24X8_UNORM:
 254    case PIPE_FORMAT_X8Z24_UNORM:
 255       strb->Base.InternalFormat = GL_DEPTH24_STENCIL8_EXT;
 256       break;
 257    case PIPE_FORMAT_S8_USCALED:
 258       strb->Base.InternalFormat = GL_STENCIL_INDEX8_EXT;
 259       break;
 260    case PIPE_FORMAT_R16G16B16A16_SNORM:
 261       strb->Base.InternalFormat = GL_RGBA16;
 262       break;
 263    default:
 264       _mesa_problem(NULL,
 265                     "Unexpected format in st_new_renderbuffer_fb");
 266       free(strb);
 267       return NULL;
 268    }
 269
 270    /* st-specific methods */
 271    strb->Base.Delete = st_renderbuffer_delete;
 272    strb->Base.AllocStorage = st_renderbuffer_alloc_storage;
 273    strb->Base.GetPointer = null_get_pointer;
 274
 275    /* surface is allocated in st_renderbuffer_alloc_storage() */
 276    strb->surface = NULL;
 277
 278    return &strb->Base;
 279 }
 280
 281
 282
 283
 284 /**
 285  * Called via ctx->Driver.BindFramebufferEXT().
 286  */
 287 static void
 288 st_bind_framebuffer(GLcontext *ctx, GLenum target,
 289                     struct gl_framebuffer *fb, struct gl_framebuffer *fbread)
 290 {
 291
 292 }
 293
 294 /**
 295  * Called by ctx->Driver.FramebufferRenderbuffer
 296  */
 297 static void
 298 st_framebuffer_renderbuffer(GLcontext *ctx,
 299                             struct gl_framebuffer *fb,
 300                             GLenum attachment,
 301                             struct gl_renderbuffer *rb)
 302 {
 303    /* XXX no need for derivation? */
 304    _mesa_framebuffer_renderbuffer(ctx, fb, attachment, rb);
 305 }
 306
 307
 308 /**
 309  * Called by ctx->Driver.RenderTexture
 310  */
 311 static void
 312 st_render_texture(GLcontext *ctx,
 313                   struct gl_framebuffer *fb,
 314                   struct gl_renderbuffer_attachment *att)
 315 {
 316    struct st_context *st = st_context(ctx);
 317    struct pipe_context *pipe = st->pipe;
 318    struct pipe_screen *screen = pipe->screen;
 319    struct st_renderbuffer *strb;
 320    struct gl_renderbuffer *rb;
 321    struct pipe_resource *pt = st_get_texobj_resource(att->Texture);
 322    struct st_texture_object *stObj;
 323    const struct gl_texture_image *texImage;
 324
 325    /* When would this fail?  Perhaps assert? */
 326    if (!pt)
 327       return;
 328
 329    /* get pointer to texture image we're rendeing to */
 330    texImage = att->Texture->Image[att->CubeMapFace][att->TextureLevel];
 331
 332    /* create new renderbuffer which wraps the texture image */
 333    rb = st_new_renderbuffer(ctx, 0);
 334    if (!rb) {
 335       _mesa_error(ctx, GL_OUT_OF_MEMORY, "glFramebufferTexture()");
 336       return;
 337    }
 338
 339    _mesa_reference_renderbuffer(&att->Renderbuffer, rb);
 340    assert(rb->RefCount == 1);
 341    rb->AllocStorage = NULL; /* should not get called */
 342    strb = st_renderbuffer(rb);
 343
 344    assert(strb->Base.RefCount > 0);
 345
 346    /* get the texture for the texture object */
 347    stObj = st_texture_object(att->Texture);
 348
 349    /* point renderbuffer at texobject */
 350    strb->rtt = stObj;
 351    strb->rtt_level = att->TextureLevel;
 352    strb->rtt_face = att->CubeMapFace;
 353    strb->rtt_slice = att->Zoffset;
 354
 355    rb->Width = texImage->Width2;
 356    rb->Height = texImage->Height2;
 357    rb->_BaseFormat = texImage->_BaseFormat;
 358    /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
 359
 360    /*printf("***** pipe texture %d x %d\n", pt->width0, pt->height0);*/
 361
 362    pipe_resource_reference( &strb->texture, pt );
 363
 364    pipe_surface_reference(&strb->surface, NULL);
 365
 366    pipe_sampler_view_reference(&strb->sampler_view,
 367                                st_get_texture_sampler_view(stObj, pipe));
 368
 369    assert(strb->rtt_level <= strb->texture->last_level);
 370
 371    /* new surface for rendering into the texture */
 372    strb->surface = screen->get_tex_surface(screen,
 373                                            strb->texture,
 374                                            strb->rtt_face,
 375                                            strb->rtt_level,
 376                                            strb->rtt_slice,
 377                                            PIPE_BIND_RENDER_TARGET);
 378
 379    strb->format = pt->format;
 380
 381    strb->Base.Format = st_pipe_format_to_mesa_format(pt->format);
 382    strb->Base.DataType = st_format_datatype(pt->format);
 383
 384    /*
 385    printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p  %d x %d\n",
 386           att->Texture, pt, strb->surface, rb->Width, rb->Height);
 387    */
 388
 389    /* Invalidate buffer state so that the pipe's framebuffer state
 390     * gets updated.
 391     * That's where the new renderbuffer (which we just created) gets
 392     * passed to the pipe as a (color/depth) render target.
 393     */
 394    st_invalidate_state(ctx, _NEW_BUFFERS);
 395 }
 396
 397
 398 /**
 399  * Called via ctx->Driver.FinishRenderTexture.
 400  */
 401 static void
 402 st_finish_render_texture(GLcontext *ctx,
 403                          struct gl_renderbuffer_attachment *att)
 404 {
 405    struct st_context *st = st_context(ctx);
 406    struct st_renderbuffer *strb = st_renderbuffer(att->Renderbuffer);
 407
 408    if (!strb)
 409       return;
 410
 411    st_flush(st, PIPE_FLUSH_RENDER_CACHE, NULL);
 412
 413    strb->rtt = NULL;
 414
 415    /*
 416    printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
 417    */
 418
 419    /* restore previous framebuffer state */
 420    st_invalidate_state(ctx, _NEW_BUFFERS);
 421 }
 422
 423
 424 /**
 425  * Validate a renderbuffer attachment for a particular set of bindings.
 426  */
 427 static GLboolean
 428 st_validate_attachment(struct pipe_screen *screen,
 429                        const struct gl_renderbuffer_attachment *att,
 430                        unsigned bindings)
 431 {
 432    const struct st_texture_object *stObj = st_texture_object(att->Texture);
 433
 434    /* Only validate texture attachments for now, since
 435     * st_renderbuffer_alloc_storage makes sure that
 436     * the format is supported.
 437     */
 438    if (att->Type != GL_TEXTURE)
 439       return GL_TRUE;
 440
 441    if (!stObj)
 442       return GL_FALSE;
 443
 444    return screen->is_format_supported(screen, stObj->pt->format,
 445                                       PIPE_TEXTURE_2D,
 446                                       stObj->pt->nr_samples, bindings, 0);
 447 }
 448
 449
 450 /**
 451  * Check if two renderbuffer attachments name a combined depth/stencil
 452  * renderbuffer.
 453  */
 454 GLboolean
 455 st_is_depth_stencil_combined(const struct gl_renderbuffer_attachment *depth,
 456                              const struct gl_renderbuffer_attachment *stencil)
 457 {
 458    assert(depth && stencil);
 459
 460    if (depth->Type == stencil->Type) {
 461       if (depth->Type == GL_RENDERBUFFER_EXT &&
 462           depth->Renderbuffer == stencil->Renderbuffer)
 463          return GL_TRUE;
 464
 465       if (depth->Type == GL_TEXTURE &&
 466           depth->Texture == stencil->Texture)
 467          return GL_TRUE;
 468    }
 469
 470    return GL_FALSE;
 471 }
 472
 473
 474 /**
 475  * Check that the framebuffer configuration is valid in terms of what
 476  * the driver can support.
 477  *
 478  * For Gallium we only supports combined Z+stencil, not separate buffers.
 479  */
 480 static void
 481 st_validate_framebuffer(GLcontext *ctx, struct gl_framebuffer *fb)
 482 {
 483    struct st_context *st = st_context(ctx);
 484    struct pipe_screen *screen = st->pipe->screen;
 485    const struct gl_renderbuffer_attachment *depth =
 486          &fb->Attachment[BUFFER_DEPTH];
 487    const struct gl_renderbuffer_attachment *stencil =
 488          &fb->Attachment[BUFFER_STENCIL];
 489    GLuint i;
 490
 491    if (depth->Type && stencil->Type && depth->Type != stencil->Type) {
 492       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 493       return;
 494    }
 495    if (depth->Type == GL_RENDERBUFFER_EXT &&
 496        stencil->Type == GL_RENDERBUFFER_EXT &&
 497        depth->Renderbuffer != stencil->Renderbuffer) {
 498       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 499       return;
 500    }
 501    if (depth->Type == GL_TEXTURE &&
 502        stencil->Type == GL_TEXTURE &&
 503        depth->Texture != stencil->Texture) {
 504       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 505       return;
 506    }
 507
 508    if (!st_validate_attachment(screen,
 509                                depth,
 510                                PIPE_BIND_DEPTH_STENCIL)) {
 511       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 512       return;
 513    }
 514    if (!st_validate_attachment(screen,
 515                                stencil,
 516                                PIPE_BIND_DEPTH_STENCIL)) {
 517       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 518       return;
 519    }
 520    for (i = 0; i < ctx->Const.MaxColorAttachments; i++) {
 521       if (!st_validate_attachment(screen,
 522                                   &fb->Attachment[BUFFER_COLOR0 + i],
 523                                   PIPE_BIND_RENDER_TARGET)) {
 524          fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 525          return;
 526       }
 527    }
 528 }
 529
 530
 531 /**
 532  * Called via glDrawBuffer.
 533  */
 534 static void
 535 st_DrawBuffers(GLcontext *ctx, GLsizei count, const GLenum *buffers)
 536 {
 537    struct st_context *st = st_context(ctx);
 538    GLframebuffer *fb = ctx->DrawBuffer;
 539    GLuint i;
 540
 541    (void) count;
 542    (void) buffers;
 543
 544    /* add the renderbuffers on demand */
 545    for (i = 0; i < fb->_NumColorDrawBuffers; i++) {
 546       gl_buffer_index idx = fb->_ColorDrawBufferIndexes[i];
 547       st_manager_add_color_renderbuffer(st, fb, idx);
 548    }
 549 }
 550
 551
 552 /**
 553  * Called via glReadBuffer.
 554  */
 555 static void
 556 st_ReadBuffer(GLcontext *ctx, GLenum buffer)
 557 {
 558    struct st_context *st = st_context(ctx);
 559    GLframebuffer *fb = ctx->ReadBuffer;
 560
 561    (void) buffer;
 562
 563    /* add the renderbuffer on demand */
 564    st_manager_add_color_renderbuffer(st, fb, fb->_ColorReadBufferIndex);
 565 }
 566
 567
 568 void st_init_fbo_functions(struct dd_function_table *functions)
 569 {
 570 #if FEATURE_EXT_framebuffer_object
 571    functions->NewFramebuffer = st_new_framebuffer;
 572    functions->NewRenderbuffer = st_new_renderbuffer;
 573    functions->BindFramebuffer = st_bind_framebuffer;
 574    functions->FramebufferRenderbuffer = st_framebuffer_renderbuffer;
 575    functions->RenderTexture = st_render_texture;
 576    functions->FinishRenderTexture = st_finish_render_texture;
 577    functions->ValidateFramebuffer = st_validate_framebuffer;
 578 #endif
 579    /* no longer needed by core Mesa, drivers handle resizes...
 580    functions->ResizeBuffers = st_resize_buffers;
 581    */
 582
 583    functions->DrawBuffers = st_DrawBuffers;
 584    functions->ReadBuffer = st_ReadBuffer;
 585 }
 586
 587 /* XXX unused ? */
 588 struct pipe_sampler_view *
 589 st_get_renderbuffer_sampler_view(struct st_renderbuffer *rb,
 590                                  struct pipe_context *pipe)
 591 {
 592    if (!rb->sampler_view) {
 593       rb->sampler_view = st_create_texture_sampler_view(pipe, rb->texture);
 594    }
 595
 596    return rb->sampler_view;
 597 }