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    enum pipe_format format;
  92
  93    if (strb->format != PIPE_FORMAT_NONE)
  94       format = strb->format;
  95    else
  96       format = st_choose_renderbuffer_format(pipe, internalFormat);
  97
  98    /* init renderbuffer fields */
  99    strb->Base.Width  = width;
 100    strb->Base.Height = height;
 101    init_renderbuffer_bits(strb, format);
 102
 103    if(strb->software) {
 104       struct pipe_format_block block;
 105       size_t size;
 106
 107       _mesa_free(strb->data);
 108
 109       assert(strb->format != PIPE_FORMAT_NONE);
 110       pf_get_block(strb->format, &block);
 111
 112       strb->stride = pf_get_stride(&block, width);
 113       size = pf_get_2d_size(&block, strb->stride, height);
 114
 115       strb->data = _mesa_malloc(size);
 116
 117       return strb->data != NULL;
 118    }
 119    else {
 120       struct pipe_texture template;
 121       unsigned surface_usage;
 122
 123       /* Free the old surface and texture
 124        */
 125       pipe_surface_reference( &strb->surface, NULL );
 126       pipe_texture_reference( &strb->texture, NULL );
 127
 128       /* Setup new texture template.
 129        */
 130       memset(&template, 0, sizeof(template));
 131       template.target = PIPE_TEXTURE_2D;
 132       template.format = format;
 133       pf_get_block(format, &template.block);
 134       template.width[0] = width;
 135       template.height[0] = height;
 136       template.depth[0] = 1;
 137       template.last_level = 0;
 138       template.nr_samples = rb->NumSamples;
 139       if (pf_is_depth_stencil(format)) {
 140          template.tex_usage = PIPE_TEXTURE_USAGE_DEPTH_STENCIL;
 141       }
 142       else {
 143          template.tex_usage = (PIPE_TEXTURE_USAGE_DISPLAY_TARGET |
 144                                PIPE_TEXTURE_USAGE_RENDER_TARGET);
 145       }
 146
 147       /* Probably need dedicated flags for surface usage too:
 148        */
 149       surface_usage = (PIPE_BUFFER_USAGE_GPU_READ |
 150                        PIPE_BUFFER_USAGE_GPU_WRITE);
 151 #if 0
 152                        PIPE_BUFFER_USAGE_CPU_READ |
 153                        PIPE_BUFFER_USAGE_CPU_WRITE);
 154 #endif
 155
 156       strb->texture = pipe->screen->texture_create( pipe->screen,
 157                                                     &template );
 158
 159       if (!strb->texture)
 160          return FALSE;
 161
 162       strb->surface = pipe->screen->get_tex_surface( pipe->screen,
 163                                                      strb->texture,
 164                                                      0, 0, 0,
 165                                                      surface_usage );
 166
 167       assert(strb->surface->texture);
 168       assert(strb->surface->format);
 169       assert(strb->surface->width == width);
 170       assert(strb->surface->height == height);
 171
 172
 173       return strb->surface != NULL;
 174    }
 175 }
 176
 177
 178 /**
 179  * gl_renderbuffer::Delete()
 180  */
 181 static void
 182 st_renderbuffer_delete(struct gl_renderbuffer *rb)
 183 {
 184    struct st_renderbuffer *strb = st_renderbuffer(rb);
 185    ASSERT(strb);
 186    pipe_surface_reference(&strb->surface, NULL);
 187    pipe_texture_reference(&strb->texture, NULL);
 188    _mesa_free(strb->data);
 189    _mesa_free(strb);
 190 }
 191
 192
 193 /**
 194  * gl_renderbuffer::GetPointer()
 195  */
 196 static void *
 197 null_get_pointer(GLcontext * ctx, struct gl_renderbuffer *rb,
 198                  GLint x, GLint y)
 199 {
 200    /* By returning NULL we force all software rendering to go through
 201     * the span routines.
 202     */
 203 #if 0
 204    assert(0);  /* Should never get called with softpipe */
 205 #endif
 206    return NULL;
 207 }
 208
 209
 210 /**
 211  * Called via ctx->Driver.NewFramebuffer()
 212  */
 213 static struct gl_framebuffer *
 214 st_new_framebuffer(GLcontext *ctx, GLuint name)
 215 {
 216    /* XXX not sure we need to subclass gl_framebuffer for pipe */
 217    return _mesa_new_framebuffer(ctx, name);
 218 }
 219
 220
 221 /**
 222  * Called via ctx->Driver.NewRenderbuffer()
 223  */
 224 static struct gl_renderbuffer *
 225 st_new_renderbuffer(GLcontext *ctx, GLuint name)
 226 {
 227    struct st_renderbuffer *strb = ST_CALLOC_STRUCT(st_renderbuffer);
 228    if (strb) {
 229       _mesa_init_renderbuffer(&strb->Base, name);
 230       strb->Base.Delete = st_renderbuffer_delete;
 231       strb->Base.AllocStorage = st_renderbuffer_alloc_storage;
 232       strb->Base.GetPointer = null_get_pointer;
 233       strb->format = PIPE_FORMAT_NONE;
 234       return &strb->Base;
 235    }
 236    return NULL;
 237 }
 238
 239
 240 /**
 241  * Allocate a renderbuffer for a an on-screen window (not a user-created
 242  * renderbuffer).  The window system code determines the format.
 243  */
 244 struct gl_renderbuffer *
 245 st_new_renderbuffer_fb(enum pipe_format format, int samples, boolean sw)
 246 {
 247    struct st_renderbuffer *strb;
 248
 249    strb = ST_CALLOC_STRUCT(st_renderbuffer);
 250    if (!strb) {
 251       _mesa_error(NULL, GL_OUT_OF_MEMORY, "creating renderbuffer");
 252       return NULL;
 253    }
 254
 255    _mesa_init_renderbuffer(&strb->Base, 0);
 256    strb->Base.ClassID = 0x4242; /* just a unique value */
 257    strb->Base.NumSamples = samples;
 258    strb->format = format;
 259    strb->software = sw;
 260
 261    switch (format) {
 262    case PIPE_FORMAT_A8R8G8B8_UNORM:
 263    case PIPE_FORMAT_B8G8R8A8_UNORM:
 264    case PIPE_FORMAT_X8R8G8B8_UNORM:
 265    case PIPE_FORMAT_B8G8R8X8_UNORM:
 266    case PIPE_FORMAT_A1R5G5B5_UNORM:
 267    case PIPE_FORMAT_A4R4G4B4_UNORM:
 268    case PIPE_FORMAT_R5G6B5_UNORM:
 269       strb->Base.InternalFormat = GL_RGBA;
 270       strb->Base._BaseFormat = GL_RGBA;
 271       break;
 272    case PIPE_FORMAT_Z16_UNORM:
 273       strb->Base.InternalFormat = GL_DEPTH_COMPONENT16;
 274       strb->Base._BaseFormat = GL_DEPTH_COMPONENT;
 275       break;
 276    case PIPE_FORMAT_Z32_UNORM:
 277       strb->Base.InternalFormat = GL_DEPTH_COMPONENT32;
 278       strb->Base._BaseFormat = GL_DEPTH_COMPONENT;
 279       break;
 280    case PIPE_FORMAT_S8Z24_UNORM:
 281    case PIPE_FORMAT_Z24S8_UNORM:
 282    case PIPE_FORMAT_X8Z24_UNORM:
 283    case PIPE_FORMAT_Z24X8_UNORM:
 284       strb->Base.InternalFormat = GL_DEPTH24_STENCIL8_EXT;
 285       strb->Base._BaseFormat = GL_DEPTH_STENCIL_EXT;
 286       break;
 287    case PIPE_FORMAT_S8_UNORM:
 288       strb->Base.InternalFormat = GL_STENCIL_INDEX8_EXT;
 289       strb->Base._BaseFormat = GL_STENCIL_INDEX;
 290       break;
 291    case PIPE_FORMAT_R16G16B16A16_SNORM:
 292       strb->Base.InternalFormat = GL_RGBA16;
 293       strb->Base._BaseFormat = GL_RGBA;
 294       break;
 295    default:
 296       _mesa_problem(NULL,
 297                     "Unexpected format in st_new_renderbuffer_fb");
 298       return NULL;
 299    }
 300
 301    /* st-specific methods */
 302    strb->Base.Delete = st_renderbuffer_delete;
 303    strb->Base.AllocStorage = st_renderbuffer_alloc_storage;
 304    strb->Base.GetPointer = null_get_pointer;
 305
 306    /* surface is allocated in st_renderbuffer_alloc_storage() */
 307    strb->surface = NULL;
 308
 309    return &strb->Base;
 310 }
 311
 312
 313
 314
 315 /**
 316  * Called via ctx->Driver.BindFramebufferEXT().
 317  */
 318 static void
 319 st_bind_framebuffer(GLcontext *ctx, GLenum target,
 320                     struct gl_framebuffer *fb, struct gl_framebuffer *fbread)
 321 {
 322
 323 }
 324
 325 /**
 326  * Called by ctx->Driver.FramebufferRenderbuffer
 327  */
 328 static void
 329 st_framebuffer_renderbuffer(GLcontext *ctx,
 330                             struct gl_framebuffer *fb,
 331                             GLenum attachment,
 332                             struct gl_renderbuffer *rb)
 333 {
 334    /* XXX no need for derivation? */
 335    _mesa_framebuffer_renderbuffer(ctx, fb, attachment, rb);
 336 }
 337
 338
 339 /**
 340  * Called by ctx->Driver.RenderTexture
 341  */
 342 static void
 343 st_render_texture(GLcontext *ctx,
 344                   struct gl_framebuffer *fb,
 345                   struct gl_renderbuffer_attachment *att)
 346 {
 347    struct pipe_screen *screen = ctx->st->pipe->screen;
 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    assert(strb->Base.RefCount > 0);
 371
 372    /* get the texture for the texture object */
 373    stObj = st_texture_object(att->Texture);
 374
 375    /* point renderbuffer at texobject */
 376    strb->rtt = stObj;
 377    strb->rtt_level = att->TextureLevel;
 378    strb->rtt_face = att->CubeMapFace;
 379    strb->rtt_slice = att->Zoffset;
 380
 381    rb->Width = texImage->Width2;
 382    rb->Height = texImage->Height2;
 383    /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
 384
 385    /*printf("***** pipe texture %d x %d\n", pt->width[0], pt->height[0]);*/
 386
 387    pipe_texture_reference( &strb->texture, pt );
 388
 389    pipe_surface_reference(&strb->surface, NULL);
 390
 391    /* new surface for rendering into the texture */
 392    strb->surface = screen->get_tex_surface(screen,
 393                                            strb->texture,
 394                                            strb->rtt_face,
 395                                            strb->rtt_level,
 396                                            strb->rtt_slice,
 397                                            PIPE_BUFFER_USAGE_GPU_READ |
 398                                            PIPE_BUFFER_USAGE_GPU_WRITE);
 399
 400    init_renderbuffer_bits(strb, pt->format);
 401
 402    /*
 403    printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p  %d x %d\n",
 404           att->Texture, pt, strb->surface, rb->Width, rb->Height);
 405    */
 406
 407    /* Invalidate buffer state so that the pipe's framebuffer state
 408     * gets updated.
 409     * That's where the new renderbuffer (which we just created) gets
 410     * passed to the pipe as a (color/depth) render target.
 411     */
 412    st_invalidate_state(ctx, _NEW_BUFFERS);
 413 }
 414
 415
 416 /**
 417  * Called via ctx->Driver.FinishRenderTexture.
 418  */
 419 static void
 420 st_finish_render_texture(GLcontext *ctx,
 421                          struct gl_renderbuffer_attachment *att)
 422 {
 423    struct st_renderbuffer *strb = st_renderbuffer(att->Renderbuffer);
 424
 425    if (!strb)
 426       return;
 427
 428    st_flush( ctx->st, PIPE_FLUSH_RENDER_CACHE, NULL );
 429
 430    if (strb->surface)
 431       pipe_surface_reference( &strb->surface, NULL );
 432
 433    strb->rtt = NULL;
 434
 435    /*
 436    printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
 437    */
 438
 439    _mesa_reference_renderbuffer(&att->Renderbuffer, NULL);
 440
 441    /* restore previous framebuffer state */
 442    st_invalidate_state(ctx, _NEW_BUFFERS);
 443 }
 444
 445
 446 /**
 447  * Check that the framebuffer configuration is valid in terms of what
 448  * the driver can support.
 449  *
 450  * For Gallium we only supports combined Z+stencil, not separate buffers.
 451  */
 452 static void
 453 st_validate_framebuffer(GLcontext *ctx, struct gl_framebuffer *fb)
 454 {
 455    const struct gl_renderbuffer *depthRb =
 456       fb->Attachment[BUFFER_DEPTH].Renderbuffer;
 457    const struct gl_renderbuffer *stencilRb =
 458       fb->Attachment[BUFFER_STENCIL].Renderbuffer;
 459
 460    if (stencilRb && depthRb && stencilRb != depthRb) {
 461       fb->_Status = GL_FRAMEBUFFER_UNSUPPORTED_EXT;
 462    }
 463 }
 464
 465
 466 void st_init_fbo_functions(struct dd_function_table *functions)
 467 {
 468    functions->NewFramebuffer = st_new_framebuffer;
 469    functions->NewRenderbuffer = st_new_renderbuffer;
 470    functions->BindFramebuffer = st_bind_framebuffer;
 471    functions->FramebufferRenderbuffer = st_framebuffer_renderbuffer;
 472    functions->RenderTexture = st_render_texture;
 473    functions->FinishRenderTexture = st_finish_render_texture;
 474    functions->ValidateFramebuffer = st_validate_framebuffer;
 475    /* no longer needed by core Mesa, drivers handle resizes...
 476    functions->ResizeBuffers = st_resize_buffers;
 477    */
 478 }