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