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