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/renderbuffer.h"
  41
  42 #include "pipe/p_context.h"
  43 #include "pipe/p_defines.h"
  44 #include "pipe/p_screen.h"
  45 #include "st_context.h"
  46 #include "st_cb_fbo.h"
  47 #include "st_cb_texture.h"
  48 #include "st_format.h"
  49 #include "st_public.h"
  50 #include "st_texture.h"
  51
  52
  53
  54 /**
  55  * Compute the renderbuffer's Red/Green/EtcBit fields from the pipe format.
  56  */
  57 static int
  58 init_renderbuffer_bits(struct st_renderbuffer *strb,
  59                        enum pipe_format pipeFormat)
  60 {
  61    struct pipe_format_info info;
  62
  63    if (!st_get_format_info( pipeFormat, &info )) {
  64       assert( 0 );
  65    }
  66
  67    strb->Base._ActualFormat = info.base_format;
  68    strb->Base.RedBits = info.red_bits;
  69    strb->Base.GreenBits = info.green_bits;
  70    strb->Base.BlueBits = info.blue_bits;
  71    strb->Base.AlphaBits = info.alpha_bits;
  72    strb->Base.DepthBits = info.depth_bits;
  73    strb->Base.StencilBits = info.stencil_bits;
  74    strb->Base.DataType = st_format_datatype(pipeFormat);
  75
  76    return info.size;
  77 }
  78
  79 /**
  80  * gl_renderbuffer::AllocStorage()
  81  * This is called to allocate the original drawing surface, and
  82  * during window resize.
  83  */
  84 static GLboolean
  85 st_renderbuffer_alloc_storage(GLcontext * ctx, struct gl_renderbuffer *rb,
  86                               GLenum internalFormat,
  87                               GLuint width, GLuint height)
  88 {
  89    struct pipe_context *pipe = ctx->st->pipe;
  90    struct st_renderbuffer *strb = st_renderbuffer(rb);
  91    struct pipe_texture template;
  92    unsigned surface_usage;
  93
  94    /* Free the old surface and texture
  95     */
  96    pipe_surface_reference( &strb->surface, NULL );
  97    pipe_texture_reference( &strb->texture, NULL );
  98
  99    /* Setup new texture template.
 100     */
 101    memset(&template, 0, sizeof(template));
 102    template.target = PIPE_TEXTURE_2D;
 103    if (strb->format != PIPE_FORMAT_NONE) {
 104       template.format = strb->format;
 105    }
 106    else {
 107       template.format = st_choose_renderbuffer_format(pipe, internalFormat);
 108    }
 109    pf_get_block(template.format, &template.block);
 110    template.width[0] = width;
 111    template.height[0] = height;
 112    template.depth[0] = 1;
 113    template.last_level = 0;
 114    template.nr_samples = rb->NumSamples;
 115    if (pf_is_depth_stencil(template.format)) {
 116       template.tex_usage = PIPE_TEXTURE_USAGE_DEPTH_STENCIL;
 117    }
 118    else {
 119       template.tex_usage = (PIPE_TEXTURE_USAGE_DISPLAY_TARGET |
 120                             PIPE_TEXTURE_USAGE_RENDER_TARGET);
 121    }
 122
 123    /* init renderbuffer fields */
 124    strb->Base.Width  = width;
 125    strb->Base.Height = height;
 126    init_renderbuffer_bits(strb, template.format);
 127
 128    strb->defined = GL_FALSE;  /* undefined contents now */
 129
 130    /* Probably need dedicated flags for surface usage too:
 131     */
 132    surface_usage = (PIPE_BUFFER_USAGE_GPU_READ |
 133                     PIPE_BUFFER_USAGE_GPU_WRITE);
 134 #if 0
 135                     PIPE_BUFFER_USAGE_CPU_READ |
 136                     PIPE_BUFFER_USAGE_CPU_WRITE);
 137 #endif
 138
 139    strb->texture = pipe->screen->texture_create( pipe->screen,
 140                                                  &template );
 141
 142    /* Special path for accum buffers.
 143     *
 144     * Try a different surface format.  Since accum buffers are s/w
 145     * only for now, the surface pixel format doesn't really matter,
 146     * only that the buffer is large enough.
 147     */
 148    if (!strb->texture && template.format == DEFAULT_ACCUM_PIPE_FORMAT)
 149    {
 150       /* Actually, just setting this usage value should be sufficient
 151        * to tell the driver to go ahead and allocate the buffer, even
 152        * if HW doesn't support the format.
 153        */
 154       template.tex_usage = 0;
 155       surface_usage = (PIPE_BUFFER_USAGE_CPU_READ |
 156                        PIPE_BUFFER_USAGE_CPU_WRITE);
 157
 158       strb->texture = pipe->screen->texture_create( pipe->screen,
 159                                                     &template );
 160
 161    }
 162
 163    if (!strb->texture)
 164       return FALSE;
 165
 166    strb->surface = pipe->screen->get_tex_surface( pipe->screen,
 167                                                   strb->texture,
 168                                                   0, 0, 0,
 169                                                   surface_usage );
 170
 171    assert(strb->surface->texture);
 172    assert(strb->surface->format);
 173    assert(strb->surface->width == width);
 174    assert(strb->surface->height == height);
 175
 176
 177    return strb->surface != NULL;
 178 }
 179
 180
 181 /**
 182  * gl_renderbuffer::Delete()
 183  */
 184 static void
 185 st_renderbuffer_delete(struct gl_renderbuffer *rb)
 186 {
 187    struct st_renderbuffer *strb = st_renderbuffer(rb);
 188    ASSERT(strb);
 189    pipe_surface_reference(&strb->surface, NULL);
 190    pipe_texture_reference(&strb->texture, NULL);
 191    _mesa_free(strb);
 192 }
 193
 194
 195 /**
 196  * gl_renderbuffer::GetPointer()
 197  */
 198 static void *
 199 null_get_pointer(GLcontext * ctx, struct gl_renderbuffer *rb,
 200                  GLint x, GLint y)
 201 {
 202    /* By returning NULL we force all software rendering to go through
 203     * the span routines.
 204     */
 205 #if 0
 206    assert(0);  /* Should never get called with softpipe */
 207 #endif
 208    return NULL;
 209 }
 210
 211
 212 /**
 213  * Called via ctx->Driver.NewFramebuffer()
 214  */
 215 static struct gl_framebuffer *
 216 st_new_framebuffer(GLcontext *ctx, GLuint name)
 217 {
 218    /* XXX not sure we need to subclass gl_framebuffer for pipe */
 219    return _mesa_new_framebuffer(ctx, name);
 220 }
 221
 222
 223 /**
 224  * Called via ctx->Driver.NewRenderbuffer()
 225  */
 226 static struct gl_renderbuffer *
 227 st_new_renderbuffer(GLcontext *ctx, GLuint name)
 228 {
 229    struct st_renderbuffer *strb = ST_CALLOC_STRUCT(st_renderbuffer);
 230    if (strb) {
 231       _mesa_init_renderbuffer(&strb->Base, name);
 232       strb->Base.Delete = st_renderbuffer_delete;
 233       strb->Base.AllocStorage = st_renderbuffer_alloc_storage;
 234       strb->Base.GetPointer = null_get_pointer;
 235       strb->format = PIPE_FORMAT_NONE;
 236       return &strb->Base;
 237    }
 238    return NULL;
 239 }
 240
 241
 242 /**
 243  * Allocate a renderbuffer for a an on-screen window (not a user-created
 244  * renderbuffer).  The window system code determines the format.
 245  */
 246 struct gl_renderbuffer *
 247 st_new_renderbuffer_fb(enum pipe_format format, int samples)
 248 {
 249    struct st_renderbuffer *strb;
 250
 251    strb = ST_CALLOC_STRUCT(st_renderbuffer);
 252    if (!strb) {
 253       _mesa_error(NULL, GL_OUT_OF_MEMORY, "creating renderbuffer");
 254       return NULL;
 255    }
 256
 257    _mesa_init_renderbuffer(&strb->Base, 0);
 258    strb->Base.ClassID = 0x4242; /* just a unique value */
 259    strb->Base.NumSamples = samples;
 260    strb->format = format;
 261
 262    switch (format) {
 263    case PIPE_FORMAT_A8R8G8B8_UNORM:
 264    case PIPE_FORMAT_B8G8R8A8_UNORM:
 265    case PIPE_FORMAT_X8R8G8B8_UNORM:
 266    case PIPE_FORMAT_B8G8R8X8_UNORM:
 267    case PIPE_FORMAT_A1R5G5B5_UNORM:
 268    case PIPE_FORMAT_A4R4G4B4_UNORM:
 269    case PIPE_FORMAT_R5G6B5_UNORM:
 270       strb->Base.InternalFormat = GL_RGBA;
 271       strb->Base._BaseFormat = GL_RGBA;
 272       break;
 273    case PIPE_FORMAT_Z16_UNORM:
 274       strb->Base.InternalFormat = GL_DEPTH_COMPONENT16;
 275       strb->Base._BaseFormat = GL_DEPTH_COMPONENT;
 276       break;
 277    case PIPE_FORMAT_Z32_UNORM:
 278       strb->Base.InternalFormat = GL_DEPTH_COMPONENT32;
 279       strb->Base._BaseFormat = GL_DEPTH_COMPONENT;
 280       break;
 281    case PIPE_FORMAT_S8Z24_UNORM:
 282    case PIPE_FORMAT_Z24S8_UNORM:
 283    case PIPE_FORMAT_X8Z24_UNORM:
 284    case PIPE_FORMAT_Z24X8_UNORM:
 285       strb->Base.InternalFormat = GL_DEPTH24_STENCIL8_EXT;
 286       strb->Base._BaseFormat = GL_DEPTH_STENCIL_EXT;
 287       break;
 288    case PIPE_FORMAT_S8_UNORM:
 289       strb->Base.InternalFormat = GL_STENCIL_INDEX8_EXT;
 290       strb->Base._BaseFormat = GL_STENCIL_INDEX;
 291       break;
 292    case DEFAULT_ACCUM_PIPE_FORMAT: /*PIPE_FORMAT_R16G16B16A16_SNORM*/
 293       strb->Base.InternalFormat = GL_RGBA16;
 294       strb->Base._BaseFormat = GL_RGBA;
 295       break;
 296    default:
 297       _mesa_problem(NULL,
 298                     "Unexpected format in st_new_renderbuffer_fb");
 299       return NULL;
 300    }
 301
 302    /* st-specific methods */
 303    strb->Base.Delete = st_renderbuffer_delete;
 304    strb->Base.AllocStorage = st_renderbuffer_alloc_storage;
 305    strb->Base.GetPointer = null_get_pointer;
 306
 307    /* surface is allocated in st_renderbuffer_alloc_storage() */
 308    strb->surface = NULL;
 309
 310    return &strb->Base;
 311 }
 312
 313
 314
 315
 316 /**
 317  * Called via ctx->Driver.BindFramebufferEXT().
 318  */
 319 static void
 320 st_bind_framebuffer(GLcontext *ctx, GLenum target,
 321                     struct gl_framebuffer *fb, struct gl_framebuffer *fbread)
 322 {
 323
 324 }
 325
 326 /**
 327  * Called by ctx->Driver.FramebufferRenderbuffer
 328  */
 329 static void
 330 st_framebuffer_renderbuffer(GLcontext *ctx,
 331                             struct gl_framebuffer *fb,
 332                             GLenum attachment,
 333                             struct gl_renderbuffer *rb)
 334 {
 335    /* XXX no need for derivation? */
 336    _mesa_framebuffer_renderbuffer(ctx, fb, attachment, rb);
 337 }
 338
 339
 340 /**
 341  * Called by ctx->Driver.RenderTexture
 342  */
 343 static void
 344 st_render_texture(GLcontext *ctx,
 345                   struct gl_framebuffer *fb,
 346                   struct gl_renderbuffer_attachment *att)
 347 {
 348    struct st_renderbuffer *strb;
 349    struct gl_renderbuffer *rb;
 350    struct pipe_texture *pt = st_get_texobj_texture(att->Texture);
 351    struct st_texture_object *stObj;
 352    const struct gl_texture_image *texImage =
 353       att->Texture->Image[att->CubeMapFace][att->TextureLevel];
 354
 355    if (!pt)
 356       return;
 357
 358    /* create new renderbuffer which wraps the texture image */
 359    rb = st_new_renderbuffer(ctx, 0);
 360    if (!rb) {
 361       _mesa_error(ctx, GL_OUT_OF_MEMORY, "glFramebufferTexture()");
 362       return;
 363    }
 364
 365    _mesa_reference_renderbuffer(&att->Renderbuffer, rb);
 366    assert(rb->RefCount == 1);
 367    rb->AllocStorage = NULL; /* should not get called */
 368    strb = st_renderbuffer(rb);
 369
 370    /* get the texture for the texture object */
 371    stObj = st_texture_object(att->Texture);
 372
 373    /* point renderbuffer at texobject */
 374    strb->rtt = stObj;
 375    strb->rtt_level = att->TextureLevel;
 376    strb->rtt_face = att->CubeMapFace;
 377    strb->rtt_slice = att->Zoffset;
 378
 379    rb->Width = texImage->Width2;
 380    rb->Height = texImage->Height2;
 381    /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
 382
 383    /*printf("***** pipe texture %d x %d\n", pt->width[0], pt->height[0]);*/
 384
 385    pipe_texture_reference( &strb->texture, pt );
 386
 387    pipe_surface_reference(&strb->surface, NULL);
 388
 389    /* the new surface will be created during framebuffer validation */
 390
 391    init_renderbuffer_bits(strb, pt->format);
 392
 393    /*
 394    printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p  %d x %d\n",
 395           att->Texture, pt, strb->surface, rb->Width, rb->Height);
 396    */
 397
 398    /* Invalidate buffer state so that the pipe's framebuffer state
 399     * gets updated.
 400     * That's where the new renderbuffer (which we just created) gets
 401     * passed to the pipe as a (color/depth) render target.
 402     */
 403    st_invalidate_state(ctx, _NEW_BUFFERS);
 404 }
 405
 406
 407 /**
 408  * Called via ctx->Driver.FinishRenderTexture.
 409  */
 410 static void
 411 st_finish_render_texture(GLcontext *ctx,
 412                          struct gl_renderbuffer_attachment *att)
 413 {
 414    struct st_renderbuffer *strb = st_renderbuffer(att->Renderbuffer);
 415
 416    if (!strb)
 417       return;
 418
 419    st_flush( ctx->st, PIPE_FLUSH_RENDER_CACHE, NULL );
 420
 421    if (strb->surface)
 422       pipe_surface_reference( &strb->surface, NULL );
 423
 424    strb->rtt = NULL;
 425
 426    /*
 427    printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
 428    */
 429
 430    _mesa_reference_renderbuffer(&att->Renderbuffer, NULL);
 431
 432    /* restore previous framebuffer state */
 433    st_invalidate_state(ctx, _NEW_BUFFERS);
 434 }
 435
 436
 437 /**
 438  * Check that the framebuffer configuration is valid in terms of what
 439  * the driver can support.
 440  *
 441  * For Gallium we only supports combined Z+stencil, not separate buffers.
 442  */
 443 static void
 444 st_validate_framebuffer(GLcontext *ctx, struct gl_framebuffer *fb)
 445 {
 446    const struct gl_renderbuffer *depthRb =
 447       fb->Attachment[BUFFER_DEPTH].Renderbuffer;
 448    const struct gl_renderbuffer *stencilRb =
 449       fb->Attachment[BUFFER_STENCIL].Renderbuffer;
 450
 451    if (stencilRb && depthRb && stencilRb != depthRb) {
 452       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 453    }
 454 }
 455
 456
 457 /**
 458  * Check if we're drawing into, or read from, a front color buffer.  If the
 459  * front buffer is missing, create it now.
 460  *
 461  * The back color buffer must exist since we'll use its format/samples info
 462  * for creating the front buffer.
 463  *
 464  * \param frontIndex  either BUFFER_FRONT_LEFT or BUFFER_FRONT_RIGHT
 465  * \param backIndex  either BUFFER_BACK_LEFT or BUFFER_BACK_RIGHT
 466  */
 467 static void
 468 check_create_front_buffer(GLcontext *ctx, struct gl_framebuffer *fb,
 469                           gl_buffer_index frontIndex,
 470                           gl_buffer_index backIndex)
 471 {
 472    if (fb->Attachment[frontIndex].Renderbuffer == NULL) {
 473       GLboolean create = GL_FALSE;
 474
 475       /* check if drawing to or reading from front buffer */
 476       if (fb->_ColorReadBufferIndex == frontIndex) {
 477          create = GL_TRUE;
 478       }
 479       else {
 480          GLuint b;
 481          for (b = 0; b < fb->_NumColorDrawBuffers; b++) {
 482             if (fb->_ColorDrawBufferIndexes[b] == frontIndex) {
 483                create = GL_TRUE;
 484                break;
 485             }
 486          }
 487       }
 488
 489       if (create) {
 490          struct st_renderbuffer *back;
 491          struct gl_renderbuffer *front;
 492          enum pipe_format colorFormat;
 493          uint samples;
 494
 495          if (0)
 496             _mesa_debug(ctx, "Allocate new front buffer");
 497
 498          /* get back renderbuffer info */
 499          back = st_renderbuffer(fb->Attachment[backIndex].Renderbuffer);
 500          colorFormat = back->format;
 501          samples = back->Base.NumSamples;
 502
 503          /* create front renderbuffer */
 504          front = st_new_renderbuffer_fb(colorFormat, samples);
 505          _mesa_add_renderbuffer(fb, frontIndex, front);
 506
 507          /* alloc texture/surface for new front buffer */
 508          front->AllocStorage(ctx, front, front->InternalFormat,
 509                              fb->Width, fb->Height);
 510       }
 511    }
 512 }
 513
 514
 515 /**
 516  * If front left/right color buffers are missing, create them now.
 517  */
 518 static void
 519 check_create_front_buffers(GLcontext *ctx, struct gl_framebuffer *fb)
 520 {
 521    /* check if we need to create the front left buffer now */
 522    check_create_front_buffer(ctx, fb, BUFFER_FRONT_LEFT, BUFFER_BACK_LEFT);
 523
 524    if (fb->Visual.stereoMode) {
 525       check_create_front_buffer(ctx, fb, BUFFER_FRONT_RIGHT, BUFFER_BACK_RIGHT);
 526    }
 527
 528    st_invalidate_state(ctx, _NEW_BUFFERS);
 529 }
 530
 531
 532 /**
 533  * Called via glDrawBuffer.
 534  */
 535 static void
 536 st_DrawBuffers(GLcontext *ctx, GLsizei count, const GLenum *buffers)
 537 {
 538    (void) count;
 539    (void) buffers;
 540    check_create_front_buffers(ctx, ctx->DrawBuffer);
 541 }
 542
 543
 544 /**
 545  * Called via glReadBuffer.
 546  */
 547 static void
 548 st_ReadBuffer(GLcontext *ctx, GLenum buffer)
 549 {
 550    (void) buffer;
 551    check_create_front_buffers(ctx, ctx->ReadBuffer);
 552 }
 553
 554
 555 void st_init_fbo_functions(struct dd_function_table *functions)
 556 {
 557    functions->NewFramebuffer = st_new_framebuffer;
 558    functions->NewRenderbuffer = st_new_renderbuffer;
 559    functions->BindFramebuffer = st_bind_framebuffer;
 560    functions->FramebufferRenderbuffer = st_framebuffer_renderbuffer;
 561    functions->RenderTexture = st_render_texture;
 562    functions->FinishRenderTexture = st_finish_render_texture;
 563    functions->ValidateFramebuffer = st_validate_framebuffer;
 564    /* no longer needed by core Mesa, drivers handle resizes...
 565    functions->ResizeBuffers = st_resize_buffers;
 566    */
 567
 568    functions->DrawBuffers = st_DrawBuffers;
 569    functions->ReadBuffer = st_ReadBuffer;
 570 }