src/gallium/state_trackers/osmesa/osmesa.c

   1 /*
   2  * Copyright (c) 2013  Brian Paul   All Rights Reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included
  12  * in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23
  24 /*
  25  * Off-Screen rendering into client memory.
  26  * State tracker for gallium (for softpipe and llvmpipe)
  27  *
  28  * Notes:
  29  *
  30  * If Gallium is built with LLVM support we use the llvmpipe driver.
  31  * Otherwise we use softpipe.  The GALLIUM_DRIVER environment variable
  32  * may be set to "softpipe" or "llvmpipe" to override.
  33  *
  34  * With softpipe we could render directly into the user's buffer by using a
  35  * display target resource.  However, softpipe doesn't support "upside-down"
  36  * rendering which would be needed for the OSMESA_Y_UP=TRUE case.
  37  *
  38  * With llvmpipe we could only render directly into the user's buffer when its
  39  * width and height is a multiple of the tile size (64 pixels).
  40  *
  41  * Because of these constraints we always render into ordinary resources then
  42  * copy the results to the user's buffer in the flush_front() function which
  43  * is called when the app calls glFlush/Finish.
  44  *
  45  * In general, the OSMesa interface is pretty ugly and not a good match
  46  * for Gallium.  But we're interested in doing the best we can to preserve
  47  * application portability.  With a little work we could come up with a
  48  * much nicer, new off-screen Gallium interface...
  49  */
  50
  51
  52 #include <stdio.h>
  53 #include "GL/osmesa.h"
  54
  55 #include "glapi/glapi.h"  /* for OSMesaGetProcAddress below */
  56
  57 #include "pipe/p_context.h"
  58 #include "pipe/p_screen.h"
  59 #include "pipe/p_state.h"
  60
  61 #include "util/u_atomic.h"
  62 #include "util/u_box.h"
  63 #include "util/u_debug.h"
  64 #include "util/u_format.h"
  65 #include "util/u_memory.h"
  66
  67 #include "postprocess/filters.h"
  68 #include "postprocess/postprocess.h"
  69
  70 #include "state_tracker/st_api.h"
  71 #include "state_tracker/st_gl_api.h"
  72
  73
  74
  75 extern struct pipe_screen *
  76 osmesa_create_screen(void);
  77
  78
  79
  80 struct osmesa_buffer
  81 {
  82    struct st_framebuffer_iface *stfb;
  83    struct st_visual visual;
  84    unsigned width, height;
  85
  86    struct pipe_resource *textures[ST_ATTACHMENT_COUNT];
  87
  88    void *map;
  89
  90    struct osmesa_buffer *next;  /**< next in linked list */
  91 };
  92
  93
  94 struct osmesa_context
  95 {
  96    struct st_context_iface *stctx;
  97
  98    boolean ever_used;     /*< Has this context ever been current? */
  99
 100    struct osmesa_buffer *current_buffer;
 101
 102    enum pipe_format depth_stencil_format, accum_format;
 103
 104    GLenum format;         /*< User-specified context format */
 105    GLenum type;           /*< Buffer's data type */
 106    GLint user_row_length; /*< user-specified number of pixels per row */
 107    GLboolean y_up;        /*< TRUE  -> Y increases upward */
 108                           /*< FALSE -> Y increases downward */
 109
 110    /** Which postprocessing filters are enabled. */
 111    unsigned pp_enabled[PP_FILTERS];
 112    struct pp_queue_t *pp;
 113 };
 114
 115
 116 /**
 117  * Linked list of all osmesa_buffers.
 118  * We can re-use an osmesa_buffer from one OSMesaMakeCurrent() call to
 119  * the next unless the color/depth/stencil/accum formats change.
 120  * We have to do this to be compatible with the original OSMesa implementation
 121  * because some apps call OSMesaMakeCurrent() several times during rendering
 122  * a frame.
 123  */
 124 static struct osmesa_buffer *BufferList = NULL;
 125
 126
 127 /**
 128  * Called from the ST manager.
 129  */
 130 static int
 131 osmesa_st_get_param(struct st_manager *smapi, enum st_manager_param param)
 132 {
 133    /* no-op */
 134    return 0;
 135 }
 136
 137
 138 /**
 139  * Create/return singleton st_api object.
 140  */
 141 static struct st_api *
 142 get_st_api(void)
 143 {
 144    static struct st_api *stapi = NULL;
 145    if (!stapi) {
 146       stapi = st_gl_api_create();
 147    }
 148    return stapi;
 149 }
 150
 151
 152 /**
 153  * Create/return a singleton st_manager object.
 154  */
 155 static struct st_manager *
 156 get_st_manager(void)
 157 {
 158    static struct st_manager *stmgr = NULL;
 159    if (!stmgr) {
 160       stmgr = CALLOC_STRUCT(st_manager);
 161       if (stmgr) {
 162          stmgr->screen = osmesa_create_screen();
 163          stmgr->get_param = osmesa_st_get_param;
 164          stmgr->get_egl_image = NULL;
 165       }
 166    }
 167    return stmgr;
 168 }
 169
 170
 171 static inline boolean
 172 little_endian(void)
 173 {
 174    const unsigned ui = 1;
 175    return *((const char *) &ui);
 176 }
 177
 178
 179 /**
 180  * Given an OSMESA_x format and a GL_y type, return the best
 181  * matching PIPE_FORMAT_z.
 182  * Note that we can't exactly match all user format/type combinations
 183  * with gallium formats.  If we find this to be a problem, we can
 184  * implement more elaborate format/type conversion in the flush_front()
 185  * function.
 186  */
 187 static enum pipe_format
 188 osmesa_choose_format(GLenum format, GLenum type)
 189 {
 190    switch (format) {
 191    case OSMESA_RGBA:
 192       if (type == GL_UNSIGNED_BYTE) {
 193          if (little_endian())
 194             return PIPE_FORMAT_R8G8B8A8_UNORM;
 195          else
 196             return PIPE_FORMAT_A8B8G8R8_UNORM;
 197       }
 198       else if (type == GL_UNSIGNED_SHORT) {
 199          return PIPE_FORMAT_R16G16B16A16_UNORM;
 200       }
 201       else if (type == GL_FLOAT) {
 202          return PIPE_FORMAT_R32G32B32A32_FLOAT;
 203       }
 204       else {
 205          return PIPE_FORMAT_NONE;
 206       }
 207       break;
 208    case OSMESA_BGRA:
 209       if (type == GL_UNSIGNED_BYTE) {
 210          if (little_endian())
 211             return PIPE_FORMAT_B8G8R8A8_UNORM;
 212          else
 213             return PIPE_FORMAT_A8R8G8B8_UNORM;
 214       }
 215       else if (type == GL_UNSIGNED_SHORT) {
 216          return PIPE_FORMAT_R16G16B16A16_UNORM;
 217       }
 218       else if (type == GL_FLOAT) {
 219          return PIPE_FORMAT_R32G32B32A32_FLOAT;
 220       }
 221       else {
 222          return PIPE_FORMAT_NONE;
 223       }
 224       break;
 225    case OSMESA_ARGB:
 226       if (type == GL_UNSIGNED_BYTE) {
 227          if (little_endian())
 228             return PIPE_FORMAT_A8R8G8B8_UNORM;
 229          else
 230             return PIPE_FORMAT_B8G8R8A8_UNORM;
 231       }
 232       else if (type == GL_UNSIGNED_SHORT) {
 233          return PIPE_FORMAT_R16G16B16A16_UNORM;
 234       }
 235       else if (type == GL_FLOAT) {
 236          return PIPE_FORMAT_R32G32B32A32_FLOAT;
 237       }
 238       else {
 239          return PIPE_FORMAT_NONE;
 240       }
 241       break;
 242    case OSMESA_RGB:
 243       if (type == GL_UNSIGNED_BYTE) {
 244          return PIPE_FORMAT_R8G8B8_UNORM;
 245       }
 246       else if (type == GL_UNSIGNED_SHORT) {
 247          return PIPE_FORMAT_R16G16B16_UNORM;
 248       }
 249       else if (type == GL_FLOAT) {
 250          return PIPE_FORMAT_R32G32B32_FLOAT;
 251       }
 252       else {
 253          return PIPE_FORMAT_NONE;
 254       }
 255       break;
 256    case OSMESA_BGR:
 257       /* No gallium format for this one */
 258       return PIPE_FORMAT_NONE;
 259    case OSMESA_RGB_565:
 260       return PIPE_FORMAT_B5G6R5_UNORM;
 261    default:
 262       ; /* fall-through */
 263    }
 264    return PIPE_FORMAT_NONE;
 265 }
 266
 267
 268 /**
 269  * Initialize an st_visual object.
 270  */
 271 static void
 272 osmesa_init_st_visual(struct st_visual *vis,
 273                       enum pipe_format color_format,
 274                       enum pipe_format ds_format,
 275                       enum pipe_format accum_format)
 276 {
 277    vis->buffer_mask = ST_ATTACHMENT_FRONT_LEFT_MASK;
 278
 279    if (ds_format != PIPE_FORMAT_NONE)
 280       vis->buffer_mask |= ST_ATTACHMENT_DEPTH_STENCIL_MASK;
 281    if (accum_format != PIPE_FORMAT_NONE)
 282       vis->buffer_mask |= ST_ATTACHMENT_ACCUM;
 283
 284    vis->color_format = color_format;
 285    vis->depth_stencil_format = ds_format;
 286    vis->accum_format = accum_format;
 287    vis->samples = 1;
 288    vis->render_buffer = ST_ATTACHMENT_FRONT_LEFT;
 289 }
 290
 291
 292 /**
 293  * Return the osmesa_buffer that corresponds to an st_framebuffer_iface.
 294  */
 295 static inline struct osmesa_buffer *
 296 stfbi_to_osbuffer(struct st_framebuffer_iface *stfbi)
 297 {
 298    return (struct osmesa_buffer *) stfbi->st_manager_private;
 299 }
 300
 301
 302 /**
 303  * Called via glFlush/glFinish.  This is where we copy the contents
 304  * of the driver's color buffer into the user-specified buffer.
 305  */
 306 static boolean
 307 osmesa_st_framebuffer_flush_front(struct st_context_iface *stctx,
 308                                   struct st_framebuffer_iface *stfbi,
 309                                   enum st_attachment_type statt)
 310 {
 311    OSMesaContext osmesa = OSMesaGetCurrentContext();
 312    struct osmesa_buffer *osbuffer = stfbi_to_osbuffer(stfbi);
 313    struct pipe_context *pipe = stctx->pipe;
 314    struct pipe_resource *res = osbuffer->textures[statt];
 315    struct pipe_transfer *transfer = NULL;
 316    struct pipe_box box;
 317    void *map;
 318    ubyte *src, *dst;
 319    unsigned y, bytes, bpp;
 320    int dst_stride;
 321
 322    if (osmesa->pp) {
 323       struct pipe_resource *zsbuf = NULL;
 324       unsigned i;
 325
 326       /* Find the z/stencil buffer if there is one */
 327       for (i = 0; i < ARRAY_SIZE(osbuffer->textures); i++) {
 328          struct pipe_resource *res = osbuffer->textures[i];
 329          if (res) {
 330             const struct util_format_description *desc =
 331                util_format_description(res->format);
 332
 333             if (util_format_has_depth(desc)) {
 334                zsbuf = res;
 335                break;
 336             }
 337          }
 338       }
 339
 340       /* run the postprocess stage(s) */
 341       pp_run(osmesa->pp, res, res, zsbuf);
 342    }
 343
 344    u_box_2d(0, 0, res->width0, res->height0, &box);
 345
 346    map = pipe->transfer_map(pipe, res, 0, PIPE_TRANSFER_READ, &box,
 347                             &transfer);
 348
 349    /*
 350     * Copy the color buffer from the resource to the user's buffer.
 351     */
 352    bpp = util_format_get_blocksize(osbuffer->visual.color_format);
 353    src = map;
 354    dst = osbuffer->map;
 355    if (osmesa->user_row_length)
 356       dst_stride = bpp * osmesa->user_row_length;
 357    else
 358       dst_stride = bpp * osbuffer->width;
 359    bytes = bpp * res->width0;
 360
 361    if (osmesa->y_up) {
 362       /* need to flip image upside down */
 363       dst = dst + (res->height0 - 1) * dst_stride;
 364       dst_stride = -dst_stride;
 365    }
 366
 367    for (y = 0; y < res->height0; y++) {
 368       memcpy(dst, src, bytes);
 369       dst += dst_stride;
 370       src += transfer->stride;
 371    }
 372
 373    pipe->transfer_unmap(pipe, transfer);
 374
 375    return TRUE;
 376 }
 377
 378
 379 /**
 380  * Called by the st manager to validate the framebuffer (allocate
 381  * its resources).
 382  */
 383 static boolean
 384 osmesa_st_framebuffer_validate(struct st_context_iface *stctx,
 385                                struct st_framebuffer_iface *stfbi,
 386                                const enum st_attachment_type *statts,
 387                                unsigned count,
 388                                struct pipe_resource **out)
 389 {
 390    struct pipe_screen *screen = get_st_manager()->screen;
 391    enum st_attachment_type i;
 392    struct osmesa_buffer *osbuffer = stfbi_to_osbuffer(stfbi);
 393    struct pipe_resource templat;
 394
 395    memset(&templat, 0, sizeof(templat));
 396    templat.target = PIPE_TEXTURE_RECT;
 397    templat.format = 0; /* setup below */
 398    templat.last_level = 0;
 399    templat.width0 = osbuffer->width;
 400    templat.height0 = osbuffer->height;
 401    templat.depth0 = 1;
 402    templat.array_size = 1;
 403    templat.usage = PIPE_USAGE_DEFAULT;
 404    templat.bind = 0; /* setup below */
 405    templat.flags = 0;
 406
 407    for (i = 0; i < count; i++) {
 408       enum pipe_format format = PIPE_FORMAT_NONE;
 409       unsigned bind = 0;
 410
 411       /*
 412        * At this time, we really only need to handle the front-left color
 413        * attachment, since that's all we specified for the visual in
 414        * osmesa_init_st_visual().
 415        */
 416       if (statts[i] == ST_ATTACHMENT_FRONT_LEFT) {
 417          format = osbuffer->visual.color_format;
 418          bind = PIPE_BIND_RENDER_TARGET;
 419       }
 420       else if (statts[i] == ST_ATTACHMENT_DEPTH_STENCIL) {
 421          format = osbuffer->visual.depth_stencil_format;
 422          bind = PIPE_BIND_DEPTH_STENCIL;
 423       }
 424       else if (statts[i] == ST_ATTACHMENT_ACCUM) {
 425          format = osbuffer->visual.accum_format;
 426          bind = PIPE_BIND_RENDER_TARGET;
 427       }
 428       else {
 429          debug_warning("Unexpected attachment type in "
 430                        "osmesa_st_framebuffer_validate()");
 431       }
 432
 433       templat.format = format;
 434       templat.bind = bind;
 435       out[i] = osbuffer->textures[statts[i]] =
 436          screen->resource_create(screen, &templat);
 437    }
 438
 439    return TRUE;
 440 }
 441
 442 static uint32_t osmesa_fb_ID = 0;
 443
 444 static struct st_framebuffer_iface *
 445 osmesa_create_st_framebuffer(void)
 446 {
 447    struct st_framebuffer_iface *stfbi = CALLOC_STRUCT(st_framebuffer_iface);
 448    if (stfbi) {
 449       stfbi->flush_front = osmesa_st_framebuffer_flush_front;
 450       stfbi->validate = osmesa_st_framebuffer_validate;
 451       p_atomic_set(&stfbi->stamp, 1);
 452       stfbi->ID = p_atomic_inc_return(&osmesa_fb_ID);
 453       stfbi->state_manager = get_st_manager();
 454    }
 455    return stfbi;
 456 }
 457
 458
 459 /**
 460  * Create new buffer and add to linked list.
 461  */
 462 static struct osmesa_buffer *
 463 osmesa_create_buffer(enum pipe_format color_format,
 464                      enum pipe_format ds_format,
 465                      enum pipe_format accum_format)
 466 {
 467    struct osmesa_buffer *osbuffer = CALLOC_STRUCT(osmesa_buffer);
 468    if (osbuffer) {
 469       osbuffer->stfb = osmesa_create_st_framebuffer();
 470
 471       osbuffer->stfb->st_manager_private = osbuffer;
 472       osbuffer->stfb->visual = &osbuffer->visual;
 473
 474       osmesa_init_st_visual(&osbuffer->visual, color_format,
 475                             ds_format, accum_format);
 476
 477       /* insert into linked list */
 478       osbuffer->next = BufferList;
 479       BufferList = osbuffer;
 480    }
 481
 482    return osbuffer;
 483 }
 484
 485
 486 /**
 487  * Search linked list for a buffer with matching pixel formats and size.
 488  */
 489 static struct osmesa_buffer *
 490 osmesa_find_buffer(enum pipe_format color_format,
 491                    enum pipe_format ds_format,
 492                    enum pipe_format accum_format,
 493                    GLsizei width, GLsizei height)
 494 {
 495    struct osmesa_buffer *b;
 496
 497    /* Check if we already have a suitable buffer for the given formats */
 498    for (b = BufferList; b; b = b->next) {
 499       if (b->visual.color_format == color_format &&
 500           b->visual.depth_stencil_format == ds_format &&
 501           b->visual.accum_format == accum_format &&
 502           b->width == width &&
 503           b->height == height) {
 504          return b;
 505       }
 506    }
 507    return NULL;
 508 }
 509
 510
 511 static void
 512 osmesa_destroy_buffer(struct osmesa_buffer *osbuffer)
 513 {
 514    struct st_api *stapi = get_st_api();
 515
 516    /*
 517     * Notify the state manager that the associated framebuffer interface
 518     * is no longer valid.
 519     */
 520    stapi->destroy_drawable(stapi, osbuffer->stfb);
 521
 522    FREE(osbuffer->stfb);
 523    FREE(osbuffer);
 524 }
 525
 526
 527
 528 /**********************************************************************/
 529 /*****                    Public Functions                        *****/
 530 /**********************************************************************/
 531
 532
 533 /**
 534  * Create an Off-Screen Mesa rendering context.  The only attribute needed is
 535  * an RGBA vs Color-Index mode flag.
 536  *
 537  * Input:  format - Must be GL_RGBA
 538  *         sharelist - specifies another OSMesaContext with which to share
 539  *                     display lists.  NULL indicates no sharing.
 540  * Return:  an OSMesaContext or 0 if error
 541  */
 542 GLAPI OSMesaContext GLAPIENTRY
 543 OSMesaCreateContext(GLenum format, OSMesaContext sharelist)
 544 {
 545    return OSMesaCreateContextExt(format, 24, 8, 0, sharelist);
 546 }
 547
 548
 549 /**
 550  * New in Mesa 3.5
 551  *
 552  * Create context and specify size of ancillary buffers.
 553  */
 554 GLAPI OSMesaContext GLAPIENTRY
 555 OSMesaCreateContextExt(GLenum format, GLint depthBits, GLint stencilBits,
 556                        GLint accumBits, OSMesaContext sharelist)
 557 {
 558    int attribs[100], n = 0;
 559
 560    attribs[n++] = OSMESA_FORMAT;
 561    attribs[n++] = format;
 562    attribs[n++] = OSMESA_DEPTH_BITS;
 563    attribs[n++] = depthBits;
 564    attribs[n++] = OSMESA_STENCIL_BITS;
 565    attribs[n++] = stencilBits;
 566    attribs[n++] = OSMESA_ACCUM_BITS;
 567    attribs[n++] = accumBits;
 568    attribs[n++] = 0;
 569
 570    return OSMesaCreateContextAttribs(attribs, sharelist);
 571 }
 572
 573
 574 /**
 575  * New in Mesa 11.2
 576  *
 577  * Create context with attribute list.
 578  */
 579 GLAPI OSMesaContext GLAPIENTRY
 580 OSMesaCreateContextAttribs(const int *attribList, OSMesaContext sharelist)
 581 {
 582    OSMesaContext osmesa;
 583    struct st_context_iface *st_shared;
 584    enum st_context_error st_error = 0;
 585    struct st_context_attribs attribs;
 586    struct st_api *stapi = get_st_api();
 587    GLenum format = GL_RGBA;
 588    int depthBits = 0, stencilBits = 0, accumBits = 0;
 589    int profile = OSMESA_COMPAT_PROFILE, version_major = 1, version_minor = 0;
 590    int i;
 591
 592    if (sharelist) {
 593       st_shared = sharelist->stctx;
 594    }
 595    else {
 596       st_shared = NULL;
 597    }
 598
 599    for (i = 0; attribList[i]; i += 2) {
 600       switch (attribList[i]) {
 601       case OSMESA_FORMAT:
 602          format = attribList[i+1];
 603          switch (format) {
 604          case OSMESA_COLOR_INDEX:
 605          case OSMESA_RGBA:
 606          case OSMESA_BGRA:
 607          case OSMESA_ARGB:
 608          case OSMESA_RGB:
 609          case OSMESA_BGR:
 610          case OSMESA_RGB_565:
 611             /* legal */
 612             break;
 613          default:
 614             return NULL;
 615          }
 616          break;
 617       case OSMESA_DEPTH_BITS:
 618          depthBits = attribList[i+1];
 619          if (depthBits < 0)
 620             return NULL;
 621          break;
 622       case OSMESA_STENCIL_BITS:
 623          stencilBits = attribList[i+1];
 624          if (stencilBits < 0)
 625             return NULL;
 626          break;
 627       case OSMESA_ACCUM_BITS:
 628          accumBits = attribList[i+1];
 629          if (accumBits < 0)
 630             return NULL;
 631          break;
 632       case OSMESA_PROFILE:
 633          profile = attribList[i+1];
 634          if (profile != OSMESA_CORE_PROFILE &&
 635              profile != OSMESA_COMPAT_PROFILE)
 636             return NULL;
 637          break;
 638       case OSMESA_CONTEXT_MAJOR_VERSION:
 639          version_major = attribList[i+1];
 640          if (version_major < 1)
 641             return NULL;
 642          break;
 643       case OSMESA_CONTEXT_MINOR_VERSION:
 644          version_minor = attribList[i+1];
 645          if (version_minor < 0)
 646             return NULL;
 647          break;
 648       case 0:
 649          /* end of list */
 650          break;
 651       default:
 652          fprintf(stderr, "Bad attribute in OSMesaCreateContextAttribs()\n");
 653          return NULL;
 654       }
 655    }
 656
 657    osmesa = (OSMesaContext) CALLOC_STRUCT(osmesa_context);
 658    if (!osmesa)
 659       return NULL;
 660
 661    /* Choose depth/stencil/accum buffer formats */
 662    if (accumBits > 0) {
 663       osmesa->accum_format = PIPE_FORMAT_R16G16B16A16_SNORM;
 664    }
 665    if (depthBits > 0 && stencilBits > 0) {
 666       osmesa->depth_stencil_format = PIPE_FORMAT_Z24_UNORM_S8_UINT;
 667    }
 668    else if (stencilBits > 0) {
 669       osmesa->depth_stencil_format = PIPE_FORMAT_S8_UINT;
 670    }
 671    else if (depthBits >= 24) {
 672       osmesa->depth_stencil_format = PIPE_FORMAT_Z24X8_UNORM;
 673    }
 674    else if (depthBits >= 16) {
 675       osmesa->depth_stencil_format = PIPE_FORMAT_Z16_UNORM;
 676    }
 677
 678    /*
 679     * Create the rendering context
 680     */
 681    memset(&attribs, 0, sizeof(attribs));
 682    attribs.profile = (profile == OSMESA_CORE_PROFILE)
 683       ? ST_PROFILE_OPENGL_CORE : ST_PROFILE_DEFAULT;
 684    attribs.major = version_major;
 685    attribs.minor = version_minor;
 686    attribs.flags = 0;  /* ST_CONTEXT_FLAG_x */
 687    attribs.options.force_glsl_extensions_warn = FALSE;
 688    attribs.options.disable_blend_func_extended = FALSE;
 689    attribs.options.disable_glsl_line_continuations = FALSE;
 690    attribs.options.disable_shader_bit_encoding = FALSE;
 691    attribs.options.force_glsl_version = 0;
 692
 693    osmesa_init_st_visual(&attribs.visual,
 694                          PIPE_FORMAT_R8G8B8A8_UNORM,
 695                          osmesa->depth_stencil_format,
 696                          osmesa->accum_format);
 697
 698    osmesa->stctx = stapi->create_context(stapi, get_st_manager(),
 699                                          &attribs, &st_error, st_shared);
 700    if (!osmesa->stctx) {
 701       FREE(osmesa);
 702       return NULL;
 703    }
 704
 705    osmesa->stctx->st_manager_private = osmesa;
 706
 707    osmesa->format = format;
 708    osmesa->user_row_length = 0;
 709    osmesa->y_up = GL_TRUE;
 710
 711    return osmesa;
 712 }
 713
 714
 715
 716 /**
 717  * Destroy an Off-Screen Mesa rendering context.
 718  *
 719  * \param osmesa  the context to destroy
 720  */
 721 GLAPI void GLAPIENTRY
 722 OSMesaDestroyContext(OSMesaContext osmesa)
 723 {
 724    if (osmesa) {
 725       pp_free(osmesa->pp);
 726       osmesa->stctx->destroy(osmesa->stctx);
 727       FREE(osmesa);
 728    }
 729 }
 730
 731
 732 /**
 733  * Bind an OSMesaContext to an image buffer.  The image buffer is just a
 734  * block of memory which the client provides.  Its size must be at least
 735  * as large as width*height*pixelSize.  Its address should be a multiple
 736  * of 4 if using RGBA mode.
 737  *
 738  * By default, image data is stored in the order of glDrawPixels: row-major
 739  * order with the lower-left image pixel stored in the first array position
 740  * (ie. bottom-to-top).
 741  *
 742  * If the context's viewport hasn't been initialized yet, it will now be
 743  * initialized to (0,0,width,height).
 744  *
 745  * Input:  osmesa - the rendering context
 746  *         buffer - the image buffer memory
 747  *         type - data type for pixel components
 748  *                GL_UNSIGNED_BYTE, GL_UNSIGNED_SHORT_5_6_5, GL_UNSIGNED_SHORT
 749  *                or GL_FLOAT.
 750  *         width, height - size of image buffer in pixels, at least 1
 751  * Return:  GL_TRUE if success, GL_FALSE if error because of invalid osmesa,
 752  *          invalid type, invalid size, etc.
 753  */
 754 GLAPI GLboolean GLAPIENTRY
 755 OSMesaMakeCurrent(OSMesaContext osmesa, void *buffer, GLenum type,
 756                   GLsizei width, GLsizei height)
 757 {
 758    struct st_api *stapi = get_st_api();
 759    struct osmesa_buffer *osbuffer;
 760    enum pipe_format color_format;
 761
 762    if (!osmesa || !buffer || width < 1 || height < 1) {
 763       return GL_FALSE;
 764    }
 765
 766    if (osmesa->format == OSMESA_RGB_565 && type != GL_UNSIGNED_SHORT_5_6_5) {
 767       return GL_FALSE;
 768    }
 769
 770    color_format = osmesa_choose_format(osmesa->format, type);
 771    if (color_format == PIPE_FORMAT_NONE) {
 772       fprintf(stderr, "OSMesaMakeCurrent(unsupported format/type)\n");
 773       return GL_FALSE;
 774    }
 775
 776    /* See if we already have a buffer that uses these pixel formats */
 777    osbuffer = osmesa_find_buffer(color_format,
 778                                  osmesa->depth_stencil_format,
 779                                  osmesa->accum_format, width, height);
 780    if (!osbuffer) {
 781       /* Existing buffer found, create new buffer */
 782       osbuffer = osmesa_create_buffer(color_format,
 783                                       osmesa->depth_stencil_format,
 784                                       osmesa->accum_format);
 785    }
 786
 787    osbuffer->width = width;
 788    osbuffer->height = height;
 789    osbuffer->map = buffer;
 790
 791    /* XXX unused for now */
 792    (void) osmesa_destroy_buffer;
 793
 794    osmesa->current_buffer = osbuffer;
 795    osmesa->type = type;
 796
 797    stapi->make_current(stapi, osmesa->stctx, osbuffer->stfb, osbuffer->stfb);
 798
 799    if (!osmesa->ever_used) {
 800       /* one-time init, just postprocessing for now */
 801       boolean any_pp_enabled = FALSE;
 802       unsigned i;
 803
 804       for (i = 0; i < ARRAY_SIZE(osmesa->pp_enabled); i++) {
 805          if (osmesa->pp_enabled[i]) {
 806             any_pp_enabled = TRUE;
 807             break;
 808          }
 809       }
 810
 811       if (any_pp_enabled) {
 812          osmesa->pp = pp_init(osmesa->stctx->pipe,
 813                               osmesa->pp_enabled,
 814                               osmesa->stctx->cso_context);
 815
 816          pp_init_fbos(osmesa->pp, width, height);
 817       }
 818
 819       osmesa->ever_used = TRUE;
 820    }
 821
 822    return GL_TRUE;
 823 }
 824
 825
 826
 827 GLAPI OSMesaContext GLAPIENTRY
 828 OSMesaGetCurrentContext(void)
 829 {
 830    struct st_api *stapi = get_st_api();
 831    struct st_context_iface *st = stapi->get_current(stapi);
 832    return st ? (OSMesaContext) st->st_manager_private : NULL;
 833 }
 834
 835
 836
 837 GLAPI void GLAPIENTRY
 838 OSMesaPixelStore(GLint pname, GLint value)
 839 {
 840    OSMesaContext osmesa = OSMesaGetCurrentContext();
 841
 842    switch (pname) {
 843    case OSMESA_ROW_LENGTH:
 844       osmesa->user_row_length = value;
 845       break;
 846    case OSMESA_Y_UP:
 847       osmesa->y_up = value ? GL_TRUE : GL_FALSE;
 848       break;
 849    default:
 850       fprintf(stderr, "Invalid pname in OSMesaPixelStore()\n");
 851       return;
 852    }
 853 }
 854
 855
 856 GLAPI void GLAPIENTRY
 857 OSMesaGetIntegerv(GLint pname, GLint *value)
 858 {
 859    OSMesaContext osmesa = OSMesaGetCurrentContext();
 860    struct osmesa_buffer *osbuffer = osmesa ? osmesa->current_buffer : NULL;
 861
 862    switch (pname) {
 863    case OSMESA_WIDTH:
 864       *value = osbuffer ? osbuffer->width : 0;
 865       return;
 866    case OSMESA_HEIGHT:
 867       *value = osbuffer ? osbuffer->height : 0;
 868       return;
 869    case OSMESA_FORMAT:
 870       *value = osmesa->format;
 871       return;
 872    case OSMESA_TYPE:
 873       /* current color buffer's data type */
 874       *value = osmesa->type;
 875       return;
 876    case OSMESA_ROW_LENGTH:
 877       *value = osmesa->user_row_length;
 878       return;
 879    case OSMESA_Y_UP:
 880       *value = osmesa->y_up;
 881       return;
 882    case OSMESA_MAX_WIDTH:
 883       /* fall-through */
 884    case OSMESA_MAX_HEIGHT:
 885       {
 886          struct pipe_screen *screen = get_st_manager()->screen;
 887          int maxLevels = screen->get_param(screen,
 888                                            PIPE_CAP_MAX_TEXTURE_2D_LEVELS);
 889          *value = 1 << (maxLevels - 1);
 890       }
 891       return;
 892    default:
 893       fprintf(stderr, "Invalid pname in OSMesaGetIntegerv()\n");
 894       return;
 895    }
 896 }
 897
 898
 899 /**
 900  * Return information about the depth buffer associated with an OSMesa context.
 901  * Input:  c - the OSMesa context
 902  * Output:  width, height - size of buffer in pixels
 903  *          bytesPerValue - bytes per depth value (2 or 4)
 904  *          buffer - pointer to depth buffer values
 905  * Return:  GL_TRUE or GL_FALSE to indicate success or failure.
 906  */
 907 GLAPI GLboolean GLAPIENTRY
 908 OSMesaGetDepthBuffer(OSMesaContext c, GLint *width, GLint *height,
 909                      GLint *bytesPerValue, void **buffer)
 910 {
 911    struct osmesa_buffer *osbuffer = c->current_buffer;
 912    struct pipe_context *pipe = c->stctx->pipe;
 913    struct pipe_resource *res = osbuffer->textures[ST_ATTACHMENT_DEPTH_STENCIL];
 914    struct pipe_transfer *transfer = NULL;
 915    struct pipe_box box;
 916
 917    /*
 918     * Note: we can't really implement this function with gallium as
 919     * we did for swrast.  We can't just map the resource and leave it
 920     * mapped (and there's no OSMesaUnmapDepthBuffer() function) so
 921     * we unmap the buffer here and return a 'stale' pointer.  This should
 922     * actually be OK in most cases where the caller of this function
 923     * immediately uses the pointer.
 924     */
 925
 926    u_box_2d(0, 0, res->width0, res->height0, &box);
 927
 928    *buffer = pipe->transfer_map(pipe, res, 0, PIPE_TRANSFER_READ, &box,
 929                                 &transfer);
 930    if (!*buffer) {
 931       return GL_FALSE;
 932    }
 933
 934    *width = res->width0;
 935    *height = res->height0;
 936    *bytesPerValue = util_format_get_blocksize(res->format);
 937
 938    pipe->transfer_unmap(pipe, transfer);
 939
 940    return GL_TRUE;
 941 }
 942
 943
 944 /**
 945  * Return the color buffer associated with an OSMesa context.
 946  * Input:  c - the OSMesa context
 947  * Output:  width, height - size of buffer in pixels
 948  *          format - the pixel format (OSMESA_FORMAT)
 949  *          buffer - pointer to color buffer values
 950  * Return:  GL_TRUE or GL_FALSE to indicate success or failure.
 951  */
 952 GLAPI GLboolean GLAPIENTRY
 953 OSMesaGetColorBuffer(OSMesaContext osmesa, GLint *width,
 954                       GLint *height, GLint *format, void **buffer)
 955 {
 956    struct osmesa_buffer *osbuffer = osmesa->current_buffer;
 957
 958    if (osbuffer) {
 959       *width = osbuffer->width;
 960       *height = osbuffer->height;
 961       *format = osmesa->format;
 962       *buffer = osbuffer->map;
 963       return GL_TRUE;
 964    }
 965    else {
 966       *width = 0;
 967       *height = 0;
 968       *format = 0;
 969       *buffer = 0;
 970       return GL_FALSE;
 971    }
 972 }
 973
 974
 975 struct name_function
 976 {
 977    const char *Name;
 978    OSMESAproc Function;
 979 };
 980
 981 static struct name_function functions[] = {
 982    { "OSMesaCreateContext", (OSMESAproc) OSMesaCreateContext },
 983    { "OSMesaCreateContextExt", (OSMESAproc) OSMesaCreateContextExt },
 984    { "OSMesaCreateContextAttribs", (OSMESAproc) OSMesaCreateContextAttribs },
 985    { "OSMesaDestroyContext", (OSMESAproc) OSMesaDestroyContext },
 986    { "OSMesaMakeCurrent", (OSMESAproc) OSMesaMakeCurrent },
 987    { "OSMesaGetCurrentContext", (OSMESAproc) OSMesaGetCurrentContext },
 988    { "OSMesaPixelStore", (OSMESAproc) OSMesaPixelStore },
 989    { "OSMesaGetIntegerv", (OSMESAproc) OSMesaGetIntegerv },
 990    { "OSMesaGetDepthBuffer", (OSMESAproc) OSMesaGetDepthBuffer },
 991    { "OSMesaGetColorBuffer", (OSMESAproc) OSMesaGetColorBuffer },
 992    { "OSMesaGetProcAddress", (OSMESAproc) OSMesaGetProcAddress },
 993    { "OSMesaColorClamp", (OSMESAproc) OSMesaColorClamp },
 994    { "OSMesaPostprocess", (OSMESAproc) OSMesaPostprocess },
 995    { NULL, NULL }
 996 };
 997
 998
 999 GLAPI OSMESAproc GLAPIENTRY
1000 OSMesaGetProcAddress(const char *funcName)
1001 {
1002    int i;
1003    for (i = 0; functions[i].Name; i++) {
1004       if (strcmp(functions[i].Name, funcName) == 0)
1005          return functions[i].Function;
1006    }
1007    return _glapi_get_proc_address(funcName);
1008 }
1009
1010
1011 GLAPI void GLAPIENTRY
1012 OSMesaColorClamp(GLboolean enable)
1013 {
1014    extern void GLAPIENTRY _mesa_ClampColor(GLenum target, GLenum clamp);
1015
1016    _mesa_ClampColor(GL_CLAMP_FRAGMENT_COLOR_ARB,
1017                     enable ? GL_TRUE : GL_FIXED_ONLY_ARB);
1018 }
1019
1020
1021 GLAPI void GLAPIENTRY
1022 OSMesaPostprocess(OSMesaContext osmesa, const char *filter,
1023                   unsigned enable_value)
1024 {
1025    if (!osmesa->ever_used) {
1026       /* We can only enable/disable postprocess filters before a context
1027        * is made current for the first time.
1028        */
1029       unsigned i;
1030
1031       for (i = 0; i < PP_FILTERS; i++) {
1032          if (strcmp(pp_filters[i].name, filter) == 0) {
1033             osmesa->pp_enabled[i] = enable_value;
1034             return;
1035          }
1036       }
1037       debug_warning("OSMesaPostprocess(unknown filter)\n");
1038    }
1039    else {
1040       debug_warning("Calling OSMesaPostprocess() after OSMesaMakeCurrent()\n");
1041    }
1042 }