src/mesa/state_tracker/st_cb_bitmap.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   * Authors:
  30   *   Brian Paul
  31   */
  32
  33 #include "main/imports.h"
  34 #include "main/image.h"
  35 #include "main/bufferobj.h"
  36 #include "main/macros.h"
  37 #include "shader/program.h"
  38 #include "shader/prog_print.h"
  39
  40 #include "st_context.h"
  41 #include "st_atom.h"
  42 #include "st_atom_constbuf.h"
  43 #include "st_program.h"
  44 #include "st_cb_bitmap.h"
  45 #include "st_texture.h"
  46 #include "st_inlines.h"
  47
  48 #include "pipe/p_context.h"
  49 #include "pipe/p_defines.h"
  50 #include "util/u_inlines.h"
  51 #include "util/u_draw_quad.h"
  52 #include "util/u_simple_shaders.h"
  53 #include "shader/prog_instruction.h"
  54 #include "cso_cache/cso_context.h"
  55
  56
  57
  58 /**
  59  * glBitmaps are drawn as textured quads.  The user's bitmap pattern
  60  * is stored in a texture image.  An alpha8 texture format is used.
  61  * The fragment shader samples a bit (texel) from the texture, then
  62  * discards the fragment if the bit is off.
  63  *
  64  * Note that we actually store the inverse image of the bitmap to
  65  * simplify the fragment program.  An "on" bit gets stored as texel=0x0
  66  * and an "off" bit is stored as texel=0xff.  Then we kill the
  67  * fragment if the negated texel value is less than zero.
  68  */
  69
  70
  71 /**
  72  * The bitmap cache attempts to accumulate multiple glBitmap calls in a
  73  * buffer which is then rendered en mass upon a flush, state change, etc.
  74  * A wide, short buffer is used to target the common case of a series
  75  * of glBitmap calls being used to draw text.
  76  */
  77 static GLboolean UseBitmapCache = GL_TRUE;
  78
  79
  80 #define BITMAP_CACHE_WIDTH  512
  81 #define BITMAP_CACHE_HEIGHT 32
  82
  83 struct bitmap_cache
  84 {
  85    /** Window pos to render the cached image */
  86    GLint xpos, ypos;
  87    /** Bounds of region used in window coords */
  88    GLint xmin, ymin, xmax, ymax;
  89
  90    GLfloat color[4];
  91
  92    /** Bitmap's Z position */
  93    GLfloat zpos;
  94
  95    struct pipe_resource *texture;
  96    struct pipe_transfer *trans;
  97
  98    GLboolean empty;
  99
 100    /** An I8 texture image: */
 101    ubyte *buffer;
 102 };
 103
 104
 105 /** Epsilon for Z comparisons */
 106 #define Z_EPSILON 1e-06
 107
 108
 109 /**
 110  * Make fragment program for glBitmap:
 111  *   Sample the texture and kill the fragment if the bit is 0.
 112  * This program will be combined with the user's fragment program.
 113  */
 114 static struct st_fragment_program *
 115 make_bitmap_fragment_program(GLcontext *ctx, GLuint samplerIndex)
 116 {
 117    struct st_fragment_program *stfp;
 118    struct gl_program *p;
 119    GLuint ic = 0;
 120
 121    p = ctx->Driver.NewProgram(ctx, GL_FRAGMENT_PROGRAM_ARB, 0);
 122    if (!p)
 123       return NULL;
 124
 125    p->NumInstructions = 3;
 126
 127    p->Instructions = _mesa_alloc_instructions(p->NumInstructions);
 128    if (!p->Instructions) {
 129       ctx->Driver.DeleteProgram(ctx, p);
 130       return NULL;
 131    }
 132    _mesa_init_instructions(p->Instructions, p->NumInstructions);
 133
 134    /* TEX tmp0, fragment.texcoord[0], texture[0], 2D; */
 135    p->Instructions[ic].Opcode = OPCODE_TEX;
 136    p->Instructions[ic].DstReg.File = PROGRAM_TEMPORARY;
 137    p->Instructions[ic].DstReg.Index = 0;
 138    p->Instructions[ic].SrcReg[0].File = PROGRAM_INPUT;
 139    p->Instructions[ic].SrcReg[0].Index = FRAG_ATTRIB_TEX0;
 140    p->Instructions[ic].TexSrcUnit = samplerIndex;
 141    p->Instructions[ic].TexSrcTarget = TEXTURE_2D_INDEX;
 142    ic++;
 143
 144    /* KIL if -tmp0 < 0 # texel=0 -> keep / texel=0 -> discard */
 145    p->Instructions[ic].Opcode = OPCODE_KIL;
 146    p->Instructions[ic].SrcReg[0].File = PROGRAM_TEMPORARY;
 147
 148    if (ctx->st->bitmap.tex_format == PIPE_FORMAT_L8_UNORM)
 149       p->Instructions[ic].SrcReg[0].Swizzle = SWIZZLE_XXXX;
 150
 151    p->Instructions[ic].SrcReg[0].Index = 0;
 152    p->Instructions[ic].SrcReg[0].Negate = NEGATE_XYZW;
 153    ic++;
 154
 155    /* END; */
 156    p->Instructions[ic++].Opcode = OPCODE_END;
 157
 158    assert(ic == p->NumInstructions);
 159
 160    p->InputsRead = FRAG_BIT_TEX0;
 161    p->OutputsWritten = 0x0;
 162    p->SamplersUsed = (1 << samplerIndex);
 163
 164    stfp = (struct st_fragment_program *) p;
 165    stfp->Base.UsesKill = GL_TRUE;
 166
 167    return stfp;
 168 }
 169
 170
 171 static int
 172 find_free_bit(uint bitfield)
 173 {
 174    int i;
 175    for (i = 0; i < 32; i++) {
 176       if ((bitfield & (1 << i)) == 0) {
 177          return i;
 178       }
 179    }
 180    return -1;
 181 }
 182
 183
 184 /**
 185  * Combine basic bitmap fragment program with the user-defined program.
 186  */
 187 static struct st_fragment_program *
 188 combined_bitmap_fragment_program(GLcontext *ctx)
 189 {
 190    struct st_context *st = ctx->st;
 191    struct st_fragment_program *stfp = st->fp;
 192
 193    if (!stfp->bitmap_program) {
 194       /*
 195        * Generate new program which is the user-defined program prefixed
 196        * with the bitmap sampler/kill instructions.
 197        */
 198       struct st_fragment_program *bitmap_prog;
 199       uint sampler;
 200
 201       sampler = find_free_bit(st->fp->Base.Base.SamplersUsed);
 202       bitmap_prog = make_bitmap_fragment_program(ctx, sampler);
 203
 204       stfp->bitmap_program = (struct st_fragment_program *)
 205          _mesa_combine_programs(ctx,
 206                                 &bitmap_prog->Base.Base, &stfp->Base.Base);
 207       stfp->bitmap_program->bitmap_sampler = sampler;
 208
 209       /* done with this after combining */
 210       st_reference_fragprog(st, &bitmap_prog, NULL);
 211
 212 #if 0
 213       {
 214          struct gl_program *p = &stfp->bitmap_program->Base.Base;
 215          printf("Combined bitmap program:\n");
 216          _mesa_print_program(p);
 217          printf("InputsRead: 0x%x\n", p->InputsRead);
 218          printf("OutputsWritten: 0x%x\n", p->OutputsWritten);
 219          _mesa_print_parameter_list(p->Parameters);
 220       }
 221 #endif
 222
 223       /* translate to TGSI tokens */
 224       st_translate_fragment_program(st, stfp->bitmap_program);
 225    }
 226
 227    return stfp->bitmap_program;
 228 }
 229
 230
 231 /**
 232  * Copy user-provide bitmap bits into texture buffer, expanding
 233  * bits into texels.
 234  * "On" bits will set texels to 0x0.
 235  * "Off" bits will not modify texels.
 236  * Note that the image is actually going to be upside down in
 237  * the texture.  We deal with that with texcoords.
 238  */
 239 static void
 240 unpack_bitmap(struct st_context *st,
 241               GLint px, GLint py, GLsizei width, GLsizei height,
 242               const struct gl_pixelstore_attrib *unpack,
 243               const GLubyte *bitmap,
 244               ubyte *destBuffer, uint destStride)
 245 {
 246    destBuffer += py * destStride + px;
 247
 248    _mesa_expand_bitmap(width, height, unpack, bitmap,
 249                        destBuffer, destStride, 0x0);
 250 }
 251
 252
 253 /**
 254  * Create a texture which represents a bitmap image.
 255  */
 256 static struct pipe_resource *
 257 make_bitmap_texture(GLcontext *ctx, GLsizei width, GLsizei height,
 258                     const struct gl_pixelstore_attrib *unpack,
 259                     const GLubyte *bitmap)
 260 {
 261    struct pipe_context *pipe = ctx->st->pipe;
 262    struct pipe_transfer *transfer;
 263    ubyte *dest;
 264    struct pipe_resource *pt;
 265
 266    /* PBO source... */
 267    bitmap = _mesa_map_pbo_source(ctx, unpack, bitmap);
 268    if (!bitmap) {
 269       return NULL;
 270    }
 271
 272    /**
 273     * Create texture to hold bitmap pattern.
 274     */
 275    pt = st_texture_create(ctx->st, PIPE_TEXTURE_2D, ctx->st->bitmap.tex_format,
 276                           0, width, height, 1,
 277                           PIPE_BIND_SAMPLER_VIEW);
 278    if (!pt) {
 279       _mesa_unmap_pbo_source(ctx, unpack);
 280       return NULL;
 281    }
 282
 283    transfer = st_no_flush_get_tex_transfer(st_context(ctx), pt, 0, 0, 0,
 284                                            PIPE_TRANSFER_WRITE,
 285                                            0, 0, width, height);
 286
 287    dest = pipe_transfer_map(pipe, transfer);
 288
 289    /* Put image into texture transfer */
 290    memset(dest, 0xff, height * transfer->stride);
 291    unpack_bitmap(ctx->st, 0, 0, width, height, unpack, bitmap,
 292                  dest, transfer->stride);
 293
 294    _mesa_unmap_pbo_source(ctx, unpack);
 295
 296    /* Release transfer */
 297    pipe_transfer_unmap(pipe, transfer);
 298    pipe->transfer_destroy(pipe, transfer);
 299
 300    return pt;
 301 }
 302
 303 static GLuint
 304 setup_bitmap_vertex_data(struct st_context *st,
 305                          int x, int y, int width, int height,
 306                          float z, const float color[4])
 307 {
 308    struct pipe_context *pipe = st->pipe;
 309    const struct gl_framebuffer *fb = st->ctx->DrawBuffer;
 310    const GLfloat fb_width = (GLfloat)fb->Width;
 311    const GLfloat fb_height = (GLfloat)fb->Height;
 312    const GLfloat x0 = (GLfloat)x;
 313    const GLfloat x1 = (GLfloat)(x + width);
 314    const GLfloat y0 = (GLfloat)y;
 315    const GLfloat y1 = (GLfloat)(y + height);
 316    const GLfloat sLeft = (GLfloat)0.0, sRight = (GLfloat)1.0;
 317    const GLfloat tTop = (GLfloat)0.0, tBot = (GLfloat)1.0 - tTop;
 318    const GLfloat clip_x0 = (GLfloat)(x0 / fb_width * 2.0 - 1.0);
 319    const GLfloat clip_y0 = (GLfloat)(y0 / fb_height * 2.0 - 1.0);
 320    const GLfloat clip_x1 = (GLfloat)(x1 / fb_width * 2.0 - 1.0);
 321    const GLfloat clip_y1 = (GLfloat)(y1 / fb_height * 2.0 - 1.0);
 322
 323    /* XXX: Need to improve buffer_write to allow NO_WAIT (as well as
 324     * no_flush) updates to buffers where we know there is no conflict
 325     * with previous data.  Currently using max_slots > 1 will cause
 326     * synchronous rendering if the driver flushes its command buffers
 327     * between one bitmap and the next.  Our flush hook below isn't
 328     * sufficient to catch this as the driver doesn't tell us when it
 329     * flushes its own command buffers.  Until this gets fixed, pay the
 330     * price of allocating a new buffer for each bitmap cache-flush to
 331     * avoid synchronous rendering.
 332     */
 333    const GLuint max_slots = 1; /* 4096 / sizeof(st->bitmap.vertices); */
 334    GLuint i;
 335
 336    if (st->bitmap.vbuf_slot >= max_slots) {
 337       pipe_resource_reference(&st->bitmap.vbuf, NULL);
 338       st->bitmap.vbuf_slot = 0;
 339    }
 340
 341    if (!st->bitmap.vbuf) {
 342       st->bitmap.vbuf = pipe_buffer_create(pipe->screen,
 343                                            PIPE_BIND_VERTEX_BUFFER,
 344                                            max_slots * sizeof(st->bitmap.vertices));
 345    }
 346
 347    /* Positions are in clip coords since we need to do clipping in case
 348     * the bitmap quad goes beyond the window bounds.
 349     */
 350    st->bitmap.vertices[0][0][0] = clip_x0;
 351    st->bitmap.vertices[0][0][1] = clip_y0;
 352    st->bitmap.vertices[0][2][0] = sLeft;
 353    st->bitmap.vertices[0][2][1] = tTop;
 354
 355    st->bitmap.vertices[1][0][0] = clip_x1;
 356    st->bitmap.vertices[1][0][1] = clip_y0;
 357    st->bitmap.vertices[1][2][0] = sRight;
 358    st->bitmap.vertices[1][2][1] = tTop;
 359
 360    st->bitmap.vertices[2][0][0] = clip_x1;
 361    st->bitmap.vertices[2][0][1] = clip_y1;
 362    st->bitmap.vertices[2][2][0] = sRight;
 363    st->bitmap.vertices[2][2][1] = tBot;
 364
 365    st->bitmap.vertices[3][0][0] = clip_x0;
 366    st->bitmap.vertices[3][0][1] = clip_y1;
 367    st->bitmap.vertices[3][2][0] = sLeft;
 368    st->bitmap.vertices[3][2][1] = tBot;
 369
 370    /* same for all verts: */
 371    for (i = 0; i < 4; i++) {
 372       st->bitmap.vertices[i][0][2] = z;
 373       st->bitmap.vertices[i][0][3] = 1.0;
 374       st->bitmap.vertices[i][1][0] = color[0];
 375       st->bitmap.vertices[i][1][1] = color[1];
 376       st->bitmap.vertices[i][1][2] = color[2];
 377       st->bitmap.vertices[i][1][3] = color[3];
 378       st->bitmap.vertices[i][2][2] = 0.0; /*R*/
 379       st->bitmap.vertices[i][2][3] = 1.0; /*Q*/
 380    }
 381
 382    /* put vertex data into vbuf */
 383    st_no_flush_pipe_buffer_write_nooverlap(st,
 384                                            st->bitmap.vbuf,
 385                                            st->bitmap.vbuf_slot * sizeof st->bitmap.vertices,
 386                                            sizeof st->bitmap.vertices,
 387                                            st->bitmap.vertices);
 388
 389    return st->bitmap.vbuf_slot++ * sizeof st->bitmap.vertices;
 390 }
 391
 392
 393
 394 /**
 395  * Render a glBitmap by drawing a textured quad
 396  */
 397 static void
 398 draw_bitmap_quad(GLcontext *ctx, GLint x, GLint y, GLfloat z,
 399                  GLsizei width, GLsizei height,
 400                  struct pipe_sampler_view *sv,
 401                  const GLfloat *color)
 402 {
 403    struct st_context *st = ctx->st;
 404    struct pipe_context *pipe = ctx->st->pipe;
 405    struct cso_context *cso = ctx->st->cso_context;
 406    struct st_fragment_program *stfp;
 407    GLuint maxSize;
 408    GLuint offset;
 409
 410    stfp = combined_bitmap_fragment_program(ctx);
 411
 412    /* As an optimization, Mesa's fragment programs will sometimes get the
 413     * primary color from a statevar/constant rather than a varying variable.
 414     * when that's the case, we need to ensure that we use the 'color'
 415     * parameter and not the current attribute color (which may have changed
 416     * through glRasterPos and state validation.
 417     * So, we force the proper color here.  Not elegant, but it works.
 418     */
 419    {
 420       GLfloat colorSave[4];
 421       COPY_4V(colorSave, ctx->Current.Attrib[VERT_ATTRIB_COLOR0]);
 422       COPY_4V(ctx->Current.Attrib[VERT_ATTRIB_COLOR0], color);
 423       st_upload_constants(st, stfp->Base.Base.Parameters, PIPE_SHADER_FRAGMENT);
 424       COPY_4V(ctx->Current.Attrib[VERT_ATTRIB_COLOR0], colorSave);
 425    }
 426
 427
 428    /* limit checks */
 429    /* XXX if the bitmap is larger than the max texture size, break
 430     * it up into chunks.
 431     */
 432    maxSize = 1 << (pipe->screen->get_param(pipe->screen, PIPE_CAP_MAX_TEXTURE_2D_LEVELS) - 1);
 433    assert(width <= (GLsizei)maxSize);
 434    assert(height <= (GLsizei)maxSize);
 435
 436    cso_save_rasterizer(cso);
 437    cso_save_samplers(cso);
 438    cso_save_fragment_sampler_views(cso);
 439    cso_save_viewport(cso);
 440    cso_save_fragment_shader(cso);
 441    cso_save_vertex_shader(cso);
 442    cso_save_vertex_elements(cso);
 443
 444    /* rasterizer state: just scissor */
 445    st->bitmap.rasterizer.scissor = ctx->Scissor.Enabled;
 446    cso_set_rasterizer(cso, &st->bitmap.rasterizer);
 447
 448    /* fragment shader state: TEX lookup program */
 449    cso_set_fragment_shader_handle(cso, stfp->driver_shader);
 450
 451    /* vertex shader state: position + texcoord pass-through */
 452    cso_set_vertex_shader_handle(cso, st->bitmap.vs);
 453
 454    /* user samplers, plus our bitmap sampler */
 455    {
 456       struct pipe_sampler_state *samplers[PIPE_MAX_SAMPLERS];
 457       uint num = MAX2(stfp->bitmap_sampler + 1, st->state.num_samplers);
 458       uint i;
 459       for (i = 0; i < st->state.num_samplers; i++) {
 460          samplers[i] = &st->state.samplers[i];
 461       }
 462       samplers[stfp->bitmap_sampler] = &st->bitmap.sampler;
 463       cso_set_samplers(cso, num, (const struct pipe_sampler_state **) samplers);
 464    }
 465
 466    /* user textures, plus the bitmap texture */
 467    {
 468       struct pipe_sampler_view *sampler_views[PIPE_MAX_SAMPLERS];
 469       uint num = MAX2(stfp->bitmap_sampler + 1, st->state.num_textures);
 470       memcpy(sampler_views, st->state.sampler_views, sizeof(sampler_views));
 471       sampler_views[stfp->bitmap_sampler] = sv;
 472       cso_set_fragment_sampler_views(cso, num, sampler_views);
 473    }
 474
 475    /* viewport state: viewport matching window dims */
 476    {
 477       const struct gl_framebuffer *fb = st->ctx->DrawBuffer;
 478       const GLboolean invert = (st_fb_orientation(fb) == Y_0_TOP);
 479       const GLfloat width = (GLfloat)fb->Width;
 480       const GLfloat height = (GLfloat)fb->Height;
 481       struct pipe_viewport_state vp;
 482       vp.scale[0] =  0.5f * width;
 483       vp.scale[1] = height * (invert ? -0.5f : 0.5f);
 484       vp.scale[2] = 0.5f;
 485       vp.scale[3] = 1.0f;
 486       vp.translate[0] = 0.5f * width;
 487       vp.translate[1] = 0.5f * height;
 488       vp.translate[2] = 0.5f;
 489       vp.translate[3] = 0.0f;
 490       cso_set_viewport(cso, &vp);
 491    }
 492
 493    cso_set_vertex_elements(cso, 3, st->velems_util_draw);
 494
 495    /* convert Z from [0,1] to [-1,-1] to match viewport Z scale/bias */
 496    z = z * 2.0 - 1.0;
 497
 498    /* draw textured quad */
 499    offset = setup_bitmap_vertex_data(st, x, y, width, height, z, color);
 500
 501    util_draw_vertex_buffer(pipe, st->bitmap.vbuf, offset,
 502                            PIPE_PRIM_TRIANGLE_FAN,
 503                            4,  /* verts */
 504                            3); /* attribs/vert */
 505
 506
 507    /* restore state */
 508    cso_restore_rasterizer(cso);
 509    cso_restore_samplers(cso);
 510    cso_restore_fragment_sampler_views(cso);
 511    cso_restore_viewport(cso);
 512    cso_restore_fragment_shader(cso);
 513    cso_restore_vertex_shader(cso);
 514    cso_restore_vertex_elements(cso);
 515 }
 516
 517
 518 static void
 519 reset_cache(struct st_context *st)
 520 {
 521    struct pipe_context *pipe = st->pipe;
 522    struct bitmap_cache *cache = st->bitmap.cache;
 523
 524    /*memset(cache->buffer, 0xff, sizeof(cache->buffer));*/
 525    cache->empty = GL_TRUE;
 526
 527    cache->xmin = 1000000;
 528    cache->xmax = -1000000;
 529    cache->ymin = 1000000;
 530    cache->ymax = -1000000;
 531
 532    if (cache->trans) {
 533       pipe->transfer_destroy(pipe, cache->trans);
 534       cache->trans = NULL;
 535    }
 536
 537    assert(!cache->texture);
 538
 539    /* allocate a new texture */
 540    cache->texture = st_texture_create(st, PIPE_TEXTURE_2D,
 541                                       st->bitmap.tex_format, 0,
 542                                       BITMAP_CACHE_WIDTH, BITMAP_CACHE_HEIGHT,
 543                                       1,
 544                                       PIPE_BIND_SAMPLER_VIEW);
 545 }
 546
 547
 548 /** Print bitmap image to stdout (debug) */
 549 static void
 550 print_cache(const struct bitmap_cache *cache)
 551 {
 552    int i, j, k;
 553
 554    for (i = 0; i < BITMAP_CACHE_HEIGHT; i++) {
 555       k = BITMAP_CACHE_WIDTH * (BITMAP_CACHE_HEIGHT - i - 1);
 556       for (j = 0; j < BITMAP_CACHE_WIDTH; j++) {
 557          if (cache->buffer[k])
 558             printf("X");
 559          else
 560             printf(" ");
 561          k++;
 562       }
 563       printf("\n");
 564    }
 565 }
 566
 567
 568 static void
 569 create_cache_trans(struct st_context *st)
 570 {
 571    struct pipe_context *pipe = st->pipe;
 572    struct bitmap_cache *cache = st->bitmap.cache;
 573
 574    if (cache->trans)
 575       return;
 576
 577    /* Map the texture transfer.
 578     * Subsequent glBitmap calls will write into the texture image.
 579     */
 580    cache->trans = st_no_flush_get_tex_transfer(st, cache->texture, 0, 0, 0,
 581                                                PIPE_TRANSFER_WRITE, 0, 0,
 582                                                BITMAP_CACHE_WIDTH,
 583                                                BITMAP_CACHE_HEIGHT);
 584    cache->buffer = pipe_transfer_map(pipe, cache->trans);
 585
 586    /* init image to all 0xff */
 587    memset(cache->buffer, 0xff, cache->trans->stride * BITMAP_CACHE_HEIGHT);
 588 }
 589
 590
 591 /**
 592  * If there's anything in the bitmap cache, draw/flush it now.
 593  */
 594 void
 595 st_flush_bitmap_cache(struct st_context *st)
 596 {
 597    if (!st->bitmap.cache->empty) {
 598       struct bitmap_cache *cache = st->bitmap.cache;
 599
 600       if (st->ctx->DrawBuffer) {
 601          struct pipe_context *pipe = st->pipe;
 602          struct pipe_sampler_view *sv;
 603
 604          assert(cache->xmin <= cache->xmax);
 605
 606 /*         printf("flush size %d x %d  at %d, %d\n",
 607                 cache->xmax - cache->xmin,
 608                 cache->ymax - cache->ymin,
 609                 cache->xpos, cache->ypos);
 610 */
 611
 612          /* The texture transfer has been mapped until now.
 613           * So unmap and release the texture transfer before drawing.
 614           */
 615          if (cache->trans) {
 616             if (0)
 617                print_cache(cache);
 618             pipe_transfer_unmap(pipe, cache->trans);
 619             cache->buffer = NULL;
 620
 621             pipe->transfer_destroy(pipe, cache->trans);
 622             cache->trans = NULL;
 623          }
 624
 625          sv = st_sampler_view_from_texture(st->pipe, cache->texture);
 626          if (sv) {
 627             draw_bitmap_quad(st->ctx,
 628                              cache->xpos,
 629                              cache->ypos,
 630                              cache->zpos,
 631                              BITMAP_CACHE_WIDTH, BITMAP_CACHE_HEIGHT,
 632                              sv,
 633                              cache->color);
 634
 635             pipe_sampler_view_reference(&sv, NULL);
 636          }
 637       }
 638
 639       /* release/free the texture */
 640       pipe_resource_reference(&cache->texture, NULL);
 641
 642       reset_cache(st);
 643    }
 644 }
 645
 646 /* Flush bitmap cache and release vertex buffer.
 647  */
 648 void
 649 st_flush_bitmap( struct st_context *st )
 650 {
 651    st_flush_bitmap_cache(st);
 652
 653    /* Release vertex buffer to avoid synchronous rendering if we were
 654     * to map it in the next frame.
 655     */
 656    pipe_resource_reference(&st->bitmap.vbuf, NULL);
 657    st->bitmap.vbuf_slot = 0;
 658 }
 659
 660
 661 /**
 662  * Try to accumulate this glBitmap call in the bitmap cache.
 663  * \return  GL_TRUE for success, GL_FALSE if bitmap is too large, etc.
 664  */
 665 static GLboolean
 666 accum_bitmap(struct st_context *st,
 667              GLint x, GLint y, GLsizei width, GLsizei height,
 668              const struct gl_pixelstore_attrib *unpack,
 669              const GLubyte *bitmap )
 670 {
 671    struct bitmap_cache *cache = st->bitmap.cache;
 672    int px = -999, py = -999;
 673    const GLfloat z = st->ctx->Current.RasterPos[2];
 674
 675    if (width > BITMAP_CACHE_WIDTH ||
 676        height > BITMAP_CACHE_HEIGHT)
 677       return GL_FALSE; /* too big to cache */
 678
 679    if (!cache->empty) {
 680       px = x - cache->xpos;  /* pos in buffer */
 681       py = y - cache->ypos;
 682       if (px < 0 || px + width > BITMAP_CACHE_WIDTH ||
 683           py < 0 || py + height > BITMAP_CACHE_HEIGHT ||
 684           !TEST_EQ_4V(st->ctx->Current.RasterColor, cache->color) ||
 685           ((fabs(z - cache->zpos) > Z_EPSILON))) {
 686          /* This bitmap would extend beyond cache bounds, or the bitmap
 687           * color is changing
 688           * so flush and continue.
 689           */
 690          st_flush_bitmap_cache(st);
 691       }
 692    }
 693
 694    if (cache->empty) {
 695       /* Initialize.  Center bitmap vertically in the buffer. */
 696       px = 0;
 697       py = (BITMAP_CACHE_HEIGHT - height) / 2;
 698       cache->xpos = x;
 699       cache->ypos = y - py;
 700       cache->zpos = z;
 701       cache->empty = GL_FALSE;
 702       COPY_4FV(cache->color, st->ctx->Current.RasterColor);
 703    }
 704
 705    assert(px != -999);
 706    assert(py != -999);
 707
 708    if (x < cache->xmin)
 709       cache->xmin = x;
 710    if (y < cache->ymin)
 711       cache->ymin = y;
 712    if (x + width > cache->xmax)
 713       cache->xmax = x + width;
 714    if (y + height > cache->ymax)
 715       cache->ymax = y + height;
 716
 717    /* create the transfer if needed */
 718    create_cache_trans(st);
 719
 720    unpack_bitmap(st, px, py, width, height, unpack, bitmap,
 721                  cache->buffer, BITMAP_CACHE_WIDTH);
 722
 723    return GL_TRUE; /* accumulated */
 724 }
 725
 726
 727
 728 /**
 729  * Called via ctx->Driver.Bitmap()
 730  */
 731 static void
 732 st_Bitmap(GLcontext *ctx, GLint x, GLint y, GLsizei width, GLsizei height,
 733           const struct gl_pixelstore_attrib *unpack, const GLubyte *bitmap )
 734 {
 735    struct st_context *st = ctx->st;
 736    struct pipe_resource *pt;
 737
 738    if (width == 0 || height == 0)
 739       return;
 740
 741    st_validate_state(st);
 742
 743    if (!st->bitmap.vs) {
 744       /* create pass-through vertex shader now */
 745       const uint semantic_names[] = { TGSI_SEMANTIC_POSITION,
 746                                       TGSI_SEMANTIC_COLOR,
 747                                       TGSI_SEMANTIC_GENERIC };
 748       const uint semantic_indexes[] = { 0, 0, 0 };
 749       st->bitmap.vs = util_make_vertex_passthrough_shader(st->pipe, 3,
 750                                                           semantic_names,
 751                                                           semantic_indexes);
 752    }
 753
 754    if (UseBitmapCache && accum_bitmap(st, x, y, width, height, unpack, bitmap))
 755       return;
 756
 757    pt = make_bitmap_texture(ctx, width, height, unpack, bitmap);
 758    if (pt) {
 759       struct pipe_sampler_view *sv = st_sampler_view_from_texture(st->pipe, pt);
 760
 761       assert(pt->target == PIPE_TEXTURE_2D);
 762
 763       if (sv) {
 764          draw_bitmap_quad(ctx, x, y, ctx->Current.RasterPos[2],
 765                           width, height, sv,
 766                           st->ctx->Current.RasterColor);
 767
 768          pipe_sampler_view_reference(&sv, NULL);
 769       }
 770
 771       /* release/free the texture */
 772       pipe_resource_reference(&pt, NULL);
 773    }
 774 }
 775
 776
 777 /** Per-context init */
 778 void
 779 st_init_bitmap_functions(struct dd_function_table *functions)
 780 {
 781    functions->Bitmap = st_Bitmap;
 782 }
 783
 784
 785 /** Per-context init */
 786 void
 787 st_init_bitmap(struct st_context *st)
 788 {
 789    struct pipe_sampler_state *sampler = &st->bitmap.sampler;
 790    struct pipe_context *pipe = st->pipe;
 791    struct pipe_screen *screen = pipe->screen;
 792
 793    /* init sampler state once */
 794    memset(sampler, 0, sizeof(*sampler));
 795    sampler->wrap_s = PIPE_TEX_WRAP_CLAMP;
 796    sampler->wrap_t = PIPE_TEX_WRAP_CLAMP;
 797    sampler->wrap_r = PIPE_TEX_WRAP_CLAMP;
 798    sampler->min_img_filter = PIPE_TEX_FILTER_NEAREST;
 799    sampler->min_mip_filter = PIPE_TEX_MIPFILTER_NONE;
 800    sampler->mag_img_filter = PIPE_TEX_FILTER_NEAREST;
 801    sampler->normalized_coords = 1;
 802
 803    /* init baseline rasterizer state once */
 804    memset(&st->bitmap.rasterizer, 0, sizeof(st->bitmap.rasterizer));
 805    st->bitmap.rasterizer.gl_rasterization_rules = 1;
 806
 807    /* find a usable texture format */
 808    if (screen->is_format_supported(screen, PIPE_FORMAT_I8_UNORM, PIPE_TEXTURE_2D,
 809                                    PIPE_BIND_SAMPLER_VIEW, 0)) {
 810       st->bitmap.tex_format = PIPE_FORMAT_I8_UNORM;
 811    }
 812    else if (screen->is_format_supported(screen, PIPE_FORMAT_A8_UNORM, PIPE_TEXTURE_2D,
 813                                         PIPE_BIND_SAMPLER_VIEW, 0)) {
 814       st->bitmap.tex_format = PIPE_FORMAT_A8_UNORM;
 815    }
 816    else if (screen->is_format_supported(screen, PIPE_FORMAT_L8_UNORM, PIPE_TEXTURE_2D,
 817                                         PIPE_BIND_SAMPLER_VIEW, 0)) {
 818       st->bitmap.tex_format = PIPE_FORMAT_L8_UNORM;
 819    }
 820    else {
 821       /* XXX support more formats */
 822       assert(0);
 823    }
 824
 825    /* alloc bitmap cache object */
 826    st->bitmap.cache = ST_CALLOC_STRUCT(bitmap_cache);
 827
 828    reset_cache(st);
 829 }
 830
 831
 832 /** Per-context tear-down */
 833 void
 834 st_destroy_bitmap(struct st_context *st)
 835 {
 836    struct pipe_context *pipe = st->pipe;
 837    struct bitmap_cache *cache = st->bitmap.cache;
 838
 839
 840
 841    if (st->bitmap.vs) {
 842       cso_delete_vertex_shader(st->cso_context, st->bitmap.vs);
 843       st->bitmap.vs = NULL;
 844    }
 845
 846    if (st->bitmap.vbuf) {
 847       pipe_resource_reference(&st->bitmap.vbuf, NULL);
 848       st->bitmap.vbuf = NULL;
 849    }
 850
 851    if (cache) {
 852       if (cache->trans) {
 853          pipe_transfer_unmap(pipe, cache->trans);
 854          pipe->transfer_destroy(pipe, cache->trans);
 855       }
 856       pipe_resource_reference(&st->bitmap.cache->texture, NULL);
 857       free(st->bitmap.cache);
 858       st->bitmap.cache = NULL;
 859    }
 860 }