src/mesa/drivers/dri/intel/intel_pixel_bitmap.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2006 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 portionsalloc
  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 #include "main/glheader.h"
  29 #include "main/enums.h"
  30 #include "main/image.h"
  31 #include "main/colormac.h"
  32 #include "main/mtypes.h"
  33 #include "main/macros.h"
  34 #include "main/bufferobj.h"
  35 #include "main/pixelstore.h"
  36 #include "main/state.h"
  37 #include "main/teximage.h"
  38 #include "main/texenv.h"
  39 #include "main/texobj.h"
  40 #include "main/texstate.h"
  41 #include "main/texparam.h"
  42 #include "main/varray.h"
  43 #include "main/attrib.h"
  44 #include "main/enable.h"
  45 #include "shader/arbprogram.h"
  46 #include "glapi/dispatch.h"
  47 #include "swrast/swrast.h"
  48
  49 #include "intel_screen.h"
  50 #include "intel_context.h"
  51 #include "intel_batchbuffer.h"
  52 #include "intel_blit.h"
  53 #include "intel_regions.h"
  54 #include "intel_buffer_objects.h"
  55 #include "intel_buffers.h"
  56 #include "intel_pixel.h"
  57 #include "intel_reg.h"
  58
  59
  60 #define FILE_DEBUG_FLAG DEBUG_PIXEL
  61
  62
  63 /* Unlike the other intel_pixel_* functions, the expectation here is
  64  * that the incoming data is not in a PBO.  With the XY_TEXT blit
  65  * method, there's no benefit haveing it in a PBO, but we could
  66  * implement a path based on XY_MONO_SRC_COPY_BLIT which might benefit
  67  * PBO bitmaps.  I think they are probably pretty rare though - I
  68  * wonder if Xgl uses them?
  69  */
  70 static const GLubyte *map_pbo( GLcontext *ctx,
  71                                GLsizei width, GLsizei height,
  72                                const struct gl_pixelstore_attrib *unpack,
  73                                const GLubyte *bitmap )
  74 {
  75    GLubyte *buf;
  76
  77    if (!_mesa_validate_pbo_access(2, unpack, width, height, 1,
  78                                   GL_COLOR_INDEX, GL_BITMAP,
  79                                   (GLvoid *) bitmap)) {
  80       _mesa_error(ctx, GL_INVALID_OPERATION,"glBitmap(invalid PBO access)");
  81       return NULL;
  82    }
  83
  84    buf = (GLubyte *) ctx->Driver.MapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
  85                                            GL_READ_ONLY_ARB,
  86                                            unpack->BufferObj);
  87    if (!buf) {
  88       _mesa_error(ctx, GL_INVALID_OPERATION, "glBitmap(PBO is mapped)");
  89       return NULL;
  90    }
  91
  92    return ADD_POINTERS(buf, bitmap);
  93 }
  94
  95 static GLboolean test_bit( const GLubyte *src,
  96                             GLuint bit )
  97 {
  98    return (src[bit/8] & (1<<(bit % 8))) ? 1 : 0;
  99 }
 100
 101 static GLboolean test_msb_bit(const GLubyte *src, GLuint bit)
 102 {
 103    return (src[bit/8] & (1<<(7 - (bit % 8)))) ? 1 : 0;
 104 }
 105
 106 static void set_bit( GLubyte *dest,
 107                           GLuint bit )
 108 {
 109    dest[bit/8] |= 1 << (bit % 8);
 110 }
 111
 112 /* Extract a rectangle's worth of data from the bitmap.  Called
 113  * per-cliprect.
 114  */
 115 static GLuint get_bitmap_rect(GLsizei width, GLsizei height,
 116                               const struct gl_pixelstore_attrib *unpack,
 117                               const GLubyte *bitmap,
 118                               GLuint x, GLuint y,
 119                               GLuint w, GLuint h,
 120                               GLubyte *dest,
 121                               GLuint row_align,
 122                               GLboolean invert)
 123 {
 124    GLuint src_offset = (x + unpack->SkipPixels) & 0x7;
 125    GLuint mask = unpack->LsbFirst ? 0 : 7;
 126    GLuint bit = 0;
 127    GLint row, col;
 128    GLint first, last;
 129    GLint incr;
 130    GLuint count = 0;
 131
 132    if (INTEL_DEBUG & DEBUG_PIXEL)
 133       _mesa_printf("%s %d,%d %dx%d bitmap %dx%d skip %d src_offset %d mask %d\n",
 134                    __FUNCTION__, x,y,w,h,width,height,unpack->SkipPixels, src_offset, mask);
 135
 136    if (invert) {
 137       first = h-1;
 138       last = 0;
 139       incr = -1;
 140    }
 141    else {
 142       first = 0;
 143       last = h-1;
 144       incr = 1;
 145    }
 146
 147    /* Require that dest be pre-zero'd.
 148     */
 149    for (row = first; row != (last+incr); row += incr) {
 150       const GLubyte *rowsrc = _mesa_image_address2d(unpack, bitmap,
 151                                                     width, height,
 152                                                     GL_COLOR_INDEX, GL_BITMAP,
 153                                                     y + row, x);
 154
 155       for (col = 0; col < w; col++, bit++) {
 156          if (test_bit(rowsrc, (col + src_offset) ^ mask)) {
 157             set_bit(dest, bit ^ 7);
 158             count++;
 159          }
 160       }
 161
 162       if (row_align)
 163          bit = ALIGN(bit, row_align);
 164    }
 165
 166    return count;
 167 }
 168
 169 /**
 170  * Returns the low Y value of the vertical range given, flipped according to
 171  * whether the framebuffer is or not.
 172  */
 173 static inline int
 174 y_flip(struct gl_framebuffer *fb, int y, int height)
 175 {
 176    if (fb->Name != 0)
 177       return y;
 178    else
 179       return fb->Height - y - height;
 180 }
 181
 182 /*
 183  * Render a bitmap.
 184  */
 185 static GLboolean
 186 do_blit_bitmap( GLcontext *ctx,
 187                 GLint dstx, GLint dsty,
 188                 GLsizei width, GLsizei height,
 189                 const struct gl_pixelstore_attrib *unpack,
 190                 const GLubyte *bitmap )
 191 {
 192    struct intel_context *intel = intel_context(ctx);
 193    struct intel_region *dst = intel_drawbuf_region(intel);
 194    struct gl_framebuffer *fb = ctx->DrawBuffer;
 195    GLfloat tmpColor[4];
 196    GLubyte ubcolor[4];
 197    GLuint color;
 198    unsigned int num_cliprects;
 199    drm_clip_rect_t *cliprects;
 200    int x_off, y_off;
 201    GLsizei bitmap_width = width;
 202    GLsizei bitmap_height = height;
 203
 204    /* Update draw buffer bounds */
 205    _mesa_update_state(ctx);
 206
 207    if (ctx->Depth.Test) {
 208       /* The blit path produces incorrect results when depth testing is on.
 209        * It seems the blit Z coord is always 1.0 (the far plane) so fragments
 210        * will likely be obscured by other, closer geometry.
 211        */
 212       return GL_FALSE;
 213    }
 214
 215    if (!dst)
 216        return GL_FALSE;
 217
 218    if (unpack->BufferObj->Name) {
 219       bitmap = map_pbo(ctx, width, height, unpack, bitmap);
 220       if (bitmap == NULL)
 221          return GL_TRUE;        /* even though this is an error, we're done */
 222    }
 223
 224    COPY_4V(tmpColor, ctx->Current.RasterColor);
 225
 226    if (NEED_SECONDARY_COLOR(ctx)) {
 227        ADD_3V(tmpColor, tmpColor, ctx->Current.RasterSecondaryColor);
 228    }
 229
 230    UNCLAMPED_FLOAT_TO_UBYTE(ubcolor[0], tmpColor[0]);
 231    UNCLAMPED_FLOAT_TO_UBYTE(ubcolor[1], tmpColor[1]);
 232    UNCLAMPED_FLOAT_TO_UBYTE(ubcolor[2], tmpColor[2]);
 233    UNCLAMPED_FLOAT_TO_UBYTE(ubcolor[3], tmpColor[3]);
 234
 235    if (dst->cpp == 2)
 236       color = INTEL_PACKCOLOR565(ubcolor[0], ubcolor[1], ubcolor[2]);
 237    else
 238       color = INTEL_PACKCOLOR8888(ubcolor[0], ubcolor[1],
 239                                   ubcolor[2], ubcolor[3]);
 240
 241    if (!intel_check_blit_fragment_ops(ctx, tmpColor[3] == 1.0F))
 242       return GL_FALSE;
 243
 244    LOCK_HARDWARE(intel);
 245
 246    intel_get_cliprects(intel, &cliprects, &num_cliprects, &x_off, &y_off);
 247    if (num_cliprects != 0) {
 248       GLuint i;
 249       GLint orig_dstx = dstx;
 250       GLint orig_dsty = dsty;
 251
 252       /* Clip to buffer bounds and scissor. */
 253       if (!_mesa_clip_to_region(fb->_Xmin, fb->_Ymin,
 254                                 fb->_Xmax, fb->_Ymax,
 255                                 &dstx, &dsty, &width, &height))
 256             goto out;
 257
 258       dstx = x_off + dstx;
 259       dsty = y_off + y_flip(fb, dsty, height);
 260
 261       for (i = 0; i < num_cliprects; i++) {
 262          int box_x, box_y, box_w, box_h;
 263          GLint px, py;
 264          GLuint stipple[32];
 265
 266          box_x = dstx;
 267          box_y = dsty;
 268          box_w = width;
 269          box_h = height;
 270
 271          /* Clip to drawable cliprect */
 272          if (!_mesa_clip_to_region(cliprects[i].x1,
 273                                    cliprects[i].y1,
 274                                    cliprects[i].x2,
 275                                    cliprects[i].y2,
 276                                    &box_x, &box_y, &box_w, &box_h))
 277             continue;
 278
 279 #define DY 32
 280 #define DX 32
 281
 282          /* Then, finally, chop it all into chunks that can be
 283           * digested by hardware:
 284           */
 285          for (py = 0; py < box_h; py += DY) {
 286             for (px = 0; px < box_w; px += DX) {
 287                int h = MIN2(DY, box_h - py);
 288                int w = MIN2(DX, box_w - px);
 289                GLuint sz = ALIGN(ALIGN(w,8) * h, 64)/8;
 290                GLenum logic_op = ctx->Color.ColorLogicOpEnabled ?
 291                   ctx->Color.LogicOp : GL_COPY;
 292
 293                assert(sz <= sizeof(stipple));
 294                memset(stipple, 0, sz);
 295
 296                /* May need to adjust this when padding has been introduced in
 297                 * sz above:
 298                 *
 299                 * Have to translate destination coordinates back into source
 300                 * coordinates.
 301                 */
 302                if (get_bitmap_rect(bitmap_width, bitmap_height, unpack,
 303                                    bitmap,
 304                                    -orig_dstx + (box_x + px - x_off),
 305                                    -orig_dsty + y_flip(fb,
 306                                                        box_y + py - y_off, h),
 307                                    w, h,
 308                                    (GLubyte *)stipple,
 309                                    8,
 310                                    fb->Name == 0 ? GL_TRUE : GL_FALSE) == 0)
 311                   continue;
 312
 313                if (!intelEmitImmediateColorExpandBlit(intel,
 314                                                       dst->cpp,
 315                                                       (GLubyte *)stipple,
 316                                                       sz,
 317                                                       color,
 318                                                       dst->pitch,
 319                                                       dst->buffer,
 320                                                       0,
 321                                                       dst->tiling,
 322                                                       box_x + px,
 323                                                       box_y + py,
 324                                                       w, h,
 325                                                       logic_op)) {
 326                   return GL_FALSE;
 327                }
 328             }
 329          }
 330       }
 331    }
 332 out:
 333    UNLOCK_HARDWARE(intel);
 334
 335    if (INTEL_DEBUG & DEBUG_SYNC)
 336       intel_batchbuffer_flush(intel->batch);
 337
 338    if (unpack->BufferObj->Name) {
 339       /* done with PBO so unmap it now */
 340       ctx->Driver.UnmapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
 341                               unpack->BufferObj);
 342    }
 343
 344    return GL_TRUE;
 345 }
 346
 347 static GLboolean
 348 intel_texture_bitmap(GLcontext * ctx,
 349                      GLint dst_x, GLint dst_y,
 350                      GLsizei width, GLsizei height,
 351                      const struct gl_pixelstore_attrib *unpack,
 352                      const GLubyte *bitmap)
 353 {
 354    struct intel_context *intel = intel_context(ctx);
 355    static const char *fp =
 356       "!!ARBfp1.0\n"
 357       "TEMP val;\n"
 358       "PARAM color=program.local[0];\n"
 359       "TEX val, fragment.texcoord[0], texture[0], 2D;\n"
 360       "ADD val, val.wwww, {-.5, -.5, -.5, -.5};\n"
 361       "KIL val;\n"
 362       "MOV result.color, color;\n"
 363       "END\n";
 364    GLuint texname;
 365    GLfloat vertices[4][4];
 366    GLint old_active_texture;
 367    GLubyte *unpacked_bitmap;
 368    GLubyte *a8_bitmap;
 369    int x, y;
 370    GLfloat dst_z;
 371
 372    /* We need a fragment program for the KIL effect */
 373    if (!ctx->Extensions.ARB_fragment_program ||
 374        !ctx->Extensions.ARB_vertex_program) {
 375       if (INTEL_DEBUG & DEBUG_FALLBACKS)
 376          fprintf(stderr,
 377                  "glBitmap fallback: No fragment/vertex program support\n");
 378       return GL_FALSE;
 379    }
 380
 381    /* We're going to mess with texturing with no regard to existing texture
 382     * state, so if there is some set up we have to bail.
 383     */
 384    if (ctx->Texture._EnabledUnits != 0) {
 385       if (INTEL_DEBUG & DEBUG_FALLBACKS)
 386          fprintf(stderr, "glBitmap fallback: texturing enabled\n");
 387       return GL_FALSE;
 388    }
 389
 390    /* Can't do textured DrawPixels with a fragment program, unless we were
 391     * to generate a new program that sampled our texture and put the results
 392     * in the fragment color before the user's program started.
 393     */
 394    if (ctx->FragmentProgram.Enabled) {
 395       if (INTEL_DEBUG & DEBUG_FALLBACKS)
 396          fprintf(stderr, "glBitmap fallback: fragment program enabled\n");
 397       return GL_FALSE;
 398    }
 399
 400    if (ctx->VertexProgram.Enabled) {
 401       if (INTEL_DEBUG & DEBUG_FALLBACKS)
 402          fprintf(stderr, "glBitmap fallback: vertex program enabled\n");
 403       return GL_FALSE;
 404    }
 405
 406    if (!ctx->Extensions.ARB_texture_non_power_of_two &&
 407        (!is_power_of_two(width) || !is_power_of_two(height))) {
 408       if (INTEL_DEBUG & DEBUG_FALLBACKS)
 409          fprintf(stderr,
 410                  "glBitmap() fallback: NPOT texture\n");
 411       return GL_FALSE;
 412    }
 413
 414    /* Check that we can load in a texture this big. */
 415    if (width > (1 << (ctx->Const.MaxTextureLevels - 1)) ||
 416        height > (1 << (ctx->Const.MaxTextureLevels - 1))) {
 417       if (INTEL_DEBUG & DEBUG_FALLBACKS)
 418          fprintf(stderr, "glBitmap fallback: bitmap too large (%dx%d)\n",
 419                  width, height);
 420       return GL_FALSE;
 421    }
 422
 423    /* Convert the A1 bitmap to an A8 format suitable for glTexImage */
 424    if (unpack->BufferObj->Name) {
 425       bitmap = map_pbo(ctx, width, height, unpack, bitmap);
 426       if (bitmap == NULL)
 427          return GL_TRUE;        /* even though this is an error, we're done */
 428    }
 429    unpacked_bitmap = _mesa_unpack_bitmap(width, height, bitmap,
 430                                          unpack);
 431    a8_bitmap = _mesa_calloc(width * height);
 432    for (y = 0; y < height; y++) {
 433       for (x = 0; x < width; x++) {
 434          if (test_msb_bit(unpacked_bitmap, ALIGN(width, 8) * y + x))
 435             a8_bitmap[y * width + x] = 0xff;
 436       }
 437    }
 438    _mesa_free(unpacked_bitmap);
 439    if (unpack->BufferObj->Name) {
 440       /* done with PBO so unmap it now */
 441       ctx->Driver.UnmapBuffer(ctx, GL_PIXEL_UNPACK_BUFFER_EXT,
 442                               unpack->BufferObj);
 443    }
 444
 445    /* Save GL state before we start setting up our drawing */
 446    _mesa_PushAttrib(GL_ENABLE_BIT | GL_CURRENT_BIT |
 447                     GL_VIEWPORT_BIT);
 448    _mesa_PushClientAttrib(GL_CLIENT_VERTEX_ARRAY_BIT |
 449                           GL_CLIENT_PIXEL_STORE_BIT);
 450    old_active_texture = ctx->Texture.CurrentUnit;
 451
 452    _mesa_Disable(GL_POLYGON_STIPPLE);
 453
 454    /* Upload our bitmap data to an alpha texture */
 455    _mesa_ActiveTextureARB(GL_TEXTURE0_ARB);
 456    _mesa_Enable(GL_TEXTURE_2D);
 457    _mesa_GenTextures(1, &texname);
 458    _mesa_BindTexture(GL_TEXTURE_2D, texname);
 459    _mesa_TexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
 460    _mesa_TexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 461
 462    _mesa_PixelStorei(GL_UNPACK_SWAP_BYTES, GL_FALSE);
 463    _mesa_PixelStorei(GL_UNPACK_LSB_FIRST, GL_FALSE);
 464    _mesa_PixelStorei(GL_UNPACK_ROW_LENGTH, 0);
 465    _mesa_PixelStorei(GL_UNPACK_SKIP_PIXELS, 0);
 466    _mesa_PixelStorei(GL_UNPACK_SKIP_ROWS, 0);
 467    _mesa_PixelStorei(GL_UNPACK_ALIGNMENT, 1);
 468    _mesa_TexImage2D(GL_TEXTURE_2D, 0, GL_ALPHA, width, height, 0,
 469                     GL_ALPHA, GL_UNSIGNED_BYTE, a8_bitmap);
 470    _mesa_free(a8_bitmap);
 471
 472    intel_meta_set_fragment_program(intel, &intel->meta.bitmap_fp, fp);
 473    _mesa_ProgramLocalParameter4fvARB(GL_FRAGMENT_PROGRAM_ARB, 0,
 474                                      ctx->Current.RasterColor);
 475    intel_meta_set_passthrough_vertex_program(intel);
 476    intel_meta_set_passthrough_transform(intel);
 477
 478    /* convert rasterpos Z from [0,1] to NDC coord in [-1,1] */
 479    dst_z = -1.0 + 2.0 * ctx->Current.RasterPos[2];
 480
 481    vertices[0][0] = dst_x;
 482    vertices[0][1] = dst_y;
 483    vertices[0][2] = dst_z;
 484    vertices[0][3] = 1.0;
 485    vertices[1][0] = dst_x + width;
 486    vertices[1][1] = dst_y;
 487    vertices[1][2] = dst_z;
 488    vertices[1][3] = 1.0;
 489    vertices[2][0] = dst_x + width;
 490    vertices[2][1] = dst_y + height;
 491    vertices[2][2] = dst_z;
 492    vertices[2][3] = 1.0;
 493    vertices[3][0] = dst_x;
 494    vertices[3][1] = dst_y + height;
 495    vertices[3][2] = dst_z;
 496    vertices[3][3] = 1.0;
 497
 498    _mesa_VertexPointer(4, GL_FLOAT, 4 * sizeof(GLfloat), &vertices);
 499    _mesa_Enable(GL_VERTEX_ARRAY);
 500    intel_meta_set_default_texrect(intel);
 501    _mesa_DrawArrays(GL_TRIANGLE_FAN, 0, 4);
 502
 503    intel_meta_restore_texcoords(intel);
 504    intel_meta_restore_transform(intel);
 505    intel_meta_restore_fragment_program(intel);
 506    intel_meta_restore_vertex_program(intel);
 507
 508    _mesa_PopClientAttrib();
 509    _mesa_Disable(GL_TEXTURE_2D); /* asserted that it was disabled at entry */
 510    _mesa_ActiveTextureARB(GL_TEXTURE0_ARB + old_active_texture);
 511    _mesa_PopAttrib();
 512
 513    _mesa_DeleteTextures(1, &texname);
 514
 515    return GL_TRUE;
 516 }
 517
 518 /* There are a large number of possible ways to implement bitmap on
 519  * this hardware, most of them have some sort of drawback.  Here are a
 520  * few that spring to mind:
 521  *
 522  * Blit:
 523  *    - XY_MONO_SRC_BLT_CMD
 524  *         - use XY_SETUP_CLIP_BLT for cliprect clipping.
 525  *    - XY_TEXT_BLT
 526  *    - XY_TEXT_IMMEDIATE_BLT
 527  *         - blit per cliprect, subject to maximum immediate data size.
 528  *    - XY_COLOR_BLT
 529  *         - per pixel or run of pixels
 530  *    - XY_PIXEL_BLT
 531  *         - good for sparse bitmaps
 532  *
 533  * 3D engine:
 534  *    - Point per pixel
 535  *    - Translate bitmap to an alpha texture and render as a quad
 536  *    - Chop bitmap up into 32x32 squares and render w/polygon stipple.
 537  */
 538 void
 539 intelBitmap(GLcontext * ctx,
 540             GLint x, GLint y,
 541             GLsizei width, GLsizei height,
 542             const struct gl_pixelstore_attrib *unpack,
 543             const GLubyte * pixels)
 544 {
 545    if (do_blit_bitmap(ctx, x, y, width, height,
 546                           unpack, pixels))
 547       return;
 548
 549    if (intel_texture_bitmap(ctx, x, y, width, height,
 550                             unpack, pixels))
 551       return;
 552
 553    if (INTEL_DEBUG & DEBUG_PIXEL)
 554       _mesa_printf("%s: fallback to swrast\n", __FUNCTION__);
 555
 556    _swrast_Bitmap(ctx, x, y, width, height, unpack, pixels);
 557 }