dlls/winedib.drv/dibdrv.h

   1 /*
   2  * DIB driver private definitions
   3  *
   4  * Copyright 2009 Massimo Del Fedele
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #ifndef __WINE_DIBDRV_H
  21 #define __WINE_DIBDRV_H
  22
  23 #include <stdarg.h>
  24 #include <stdlib.h>
  25 #include <X11/Xlib.h>
  26
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "winerror.h"
  30 #include "wingdi.h"
  31 #include "wine/list.h"
  32 #include "wine/library.h"
  33 #include "wine/debug.h"
  34 #include "wingdi.h"
  35 #include "winreg.h"
  36 #include "wine/winbase16.h" /* GlobalLock16 */
  37
  38 #include "freetype.h"
  39
  40 /* data structures needed to access opaque pointers
  41  * defined in gdi32.h */
  42 #include "dibdrv_gdi32.h"
  43
  44 /* enable this if you want debugging (i.e. TRACEs) output */
  45 #define DIBDRV_ENABLE_MAYBE
  46
  47 /* enable this if you want antialiased fonts */
  48 #define DIBDRV_ANTIALIASED_FONTS
  49
  50 /* provide a way to make debugging output appear
  51    only once. Usage example:
  52    ONCE(FIXME("Some message\n")); */
  53 #define ONCE(x) \
  54 { \
  55     static BOOL done = FALSE; \
  56     if(!done) \
  57     { \
  58         done = TRUE; \
  59         x; \
  60     } \
  61 }
  62
  63 /* provide a way to make debugging output appear
  64    only if enabled here. Can speed up stuffs
  65    avoiding long traces.Usage example:
  66    MAYBE(TRACE("Some message\n")); */
  67 #ifdef DIBDRV_ENABLE_MAYBE
  68 #define MAYBE(x) x
  69 #else
  70 #define MAYBE(x)
  71 #endif
  72
  73
  74 /* extra stock object: default 1x1 bitmap for memory DCs
  75    grabbed from gdi_private.h */
  76 #define DEFAULT_BITMAP (STOCK_LAST+1)
  77
  78 struct _DIBDRVBITMAP;
  79 struct _DIBDRVPHYSDEV;
  80 typedef struct _DIBDRV_PRIMITIVE_FUNCS
  81 {
  82     /* color to pixel data conversion */
  83     DWORD (* ColorToPixel)     (const struct _DIBDRVBITMAP *bmp, COLORREF color);
  84
  85     /* pixel primitives */
  86     void* (* GetPixelPointer)  (const struct _DIBDRVBITMAP *bmp, int x, int y);
  87     void  (* SetPixel)         (      struct _DIBDRVBITMAP *bmp, int x, int y, DWORD and, DWORD xor);
  88     DWORD (* GetPixel)         (const struct _DIBDRVBITMAP *bmp, int x, int y);
  89
  90     /* line drawing primitives */
  91     void  (* SolidHLine)       (      struct _DIBDRVBITMAP *bmp, int x1, int x2, int y, DWORD and, DWORD xor);
  92     void  (* PatternHLine)     (      struct _DIBDRVBITMAP *bmp, int x1, int x2, int y, const void *and, const void *xor, DWORD offset, DWORD count);
  93     void  (* SolidVLine)       (      struct _DIBDRVBITMAP *bmp, int x, int y1, int y2, DWORD and, DWORD xor);
  94
  95     /* bitmap conversion helpers */
  96     BOOL  (* GetLine)          (const struct _DIBDRVBITMAP *bmp, int line, int startx, int width, void *buf);
  97     BOOL  (* PutLine)          (      struct _DIBDRVBITMAP *bmp, int line, int startx, int width, void *buf);
  98
  99     /* BitBlt primitives */
 100     BOOL  (* AlphaBlend)       (      struct _DIBDRVPHYSDEV *physDevDst, int xDst, int yDst, int widthDst, int heightDst,
 101                                 const struct _DIBDRVPHYSDEV *physDevSrc, int xSrc, int ySrc, int widthSrc, int heightSrc, BLENDFUNCTION blendFn );
 102     BOOL  (* BitBlt)           (      struct _DIBDRVPHYSDEV *physDevDst, int xDst, int yDst, int width, int height,
 103                                 const struct _DIBDRVPHYSDEV *physDevSrc, int xSrc, int ySrc, DWORD rop );
 104     BOOL  (* StretchBlt)       (      struct _DIBDRVPHYSDEV *physDevDst, int xDst, int yDst, int widthDst, int heightDst,
 105                                 const struct _DIBDRVPHYSDEV *physDevSrc, int xSrc, int ySrc, int widthSrc, int heightSrc, DWORD rop );
 106
 107     /* font drawing helper */
 108     void  (* FreetypeBlit)     (      struct _DIBDRVPHYSDEV *physDev, int x, int y, RECT *clipRec, FT_Bitmap *bmp);
 109
 110 } DIBDRV_PRIMITIVE_FUNCS;
 111
 112 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB32_RGB;
 113 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB32_BITFIELDS;
 114 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB24;
 115 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB16_RGB;
 116 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB16_BITFIELDS;
 117 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB8;
 118 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB4;
 119 extern DIBDRV_PRIMITIVE_FUNCS DIBDRV_funcs_DIB1;
 120
 121 /* DIB bitmaps formats */
 122 typedef enum _DIBFORMAT
 123 {
 124     DIBFMT_UNKNOWN          =   0,
 125     DIBFMT_DIB1             =   1,
 126     DIBFMT_DIB4             =   2,
 127     DIBFMT_DIB4_RLE         =   3,
 128     DIBFMT_DIB8             =   4,
 129     DIBFMT_DIB8_RLE         =   5,
 130     DIBFMT_DIB16_RGB        =   6,
 131     DIBFMT_DIB16_BITFIELDS  =   7,
 132     DIBFMT_DIB24            =   8,
 133     DIBFMT_DIB32_RGB        =   9,
 134     DIBFMT_DIB32_BITFIELDS  =  10
 135 } DIBFORMAT;
 136
 137 /* DIB driver's generic bitmap structure */
 138 typedef struct _DIBDRVBITMAP
 139 {
 140     /* bitmap format of dib */
 141     DIBFORMAT format;
 142
 143     /* pointer to top left corner of bitmap */
 144     void *bits;
 145
 146     /* flags indicating if bits array is owned
 147        by the bitmap */
 148     BOOL ownsBits;
 149
 150     /* bitmap dimensions */
 151     int width;
 152     int height;
 153
 154     /* bitmap stride (== width in bytes) of a bitmap line */
 155     /* negative for a bottom-up bitmap */
 156     int stride;
 157
 158     /* number of bits/pixel in bitmap */
 159     int bitCount;
 160
 161     /* calculated numbers for bitfields */
 162
 163     /* bitfields masks */
 164     DWORD redMask, greenMask, blueMask;
 165     /* shifting required within a COLORREF's BYTE */
 166     int redShift, greenShift, blueShift;
 167     /* size of the fields */
 168     int redLen, greenLen, blueLen;
 169
 170     /* color table and its size */
 171     RGBQUAD *colorTable;
 172     DWORD colorTableSize;
 173
 174     /* lightest color index, for monochrome bitmaps */
 175     int lightColor;
 176
 177     /* flag indicating that color table has been grabbed */
 178     BOOL colorTableGrabbed;
 179
 180     /* primitive function pointers */
 181     DIBDRV_PRIMITIVE_FUNCS *funcs;
 182
 183 } DIBDRVBITMAP;
 184
 185 /* dash patterns */
 186 typedef struct _DASHPATTERN
 187 {
 188     DWORD count;
 189     DWORD dashes[6];
 190
 191 } DASHPATTERN;
 192
 193 /* DIB driver physical device */
 194 typedef struct _DIBDRVPHYSDEV
 195 {
 196     /* X11 driver physical device */
 197     PHYSDEV X11PhysDev;
 198
 199     /* HDC associated with physDev */
 200     HDC hdc;
 201
 202     /* is a DIB selected into DC ? */
 203     BOOL hasDIB;
 204
 205     /* currently selected HBITMAP */
 206     HBITMAP hbitmap;
 207
 208     /* physical bitmap */
 209     DIBDRVBITMAP *physBitmap;
 210
 211     /* active ROP2 */
 212     INT rop2;
 213
 214     /* clipping region and its rectangles */
 215     HRGN region;
 216     RGNDATA *regionData;
 217     RECT *regionRects;
 218     int regionRectCount;
 219
 220     /* background color and active ROP2 precalculated
 221        AND and XOR values for it */
 222     COLORREF backgroundColor;
 223     DWORD backgroundAnd, backgroundXor;
 224
 225     /* pen color and active ROP2 precalculated
 226        AND and XOR values for it */
 227     COLORREF penColorref;
 228     DWORD penColor;
 229     DWORD penAnd, penXor;
 230     const DASHPATTERN *penPattern;
 231     DWORD curDash, leftInDash;
 232     enum MARKSPACE { mark, space } markSpace;
 233
 234     /* pen style */
 235     UINT penStyle;
 236
 237     /* pen drawing functions */
 238     void (* penHLine)  (struct _DIBDRVPHYSDEV *physDev, int x1, int x2, int y);
 239     void (* penVLine)  (struct _DIBDRVPHYSDEV *physDev, int x, int y1, int y2);
 240     void (* penLine)   (struct _DIBDRVPHYSDEV *physDev, int x1, int y1, int x2, int y2);
 241     void (* brushHLine)(struct _DIBDRVPHYSDEV *physDev, int x1, int x2, int y);
 242
 243     /* brush color and active ROP2 precalculated
 244        AND and XOR values for it */
 245     COLORREF brushColorref;
 246     DWORD brushColor;
 247     DWORD brushAnd, brushXor;
 248     DWORD *brushAnds, *brushXors;
 249
 250     /* brush style */
 251     UINT brushStyle;
 252
 253     /* brush bitmap, if needed, and its converted/resized cache copy */
 254     BOOL isBrushBitmap;
 255     DIBDRVBITMAP *brushBitmap;
 256     DIBDRVBITMAP *brushBmpCache;
 257
 258     /* text color */
 259     COLORREF textColor;
 260     COLORREF textBackground;
 261
 262 #ifdef DIBDRV_ANTIALIASED_FONTS
 263     /* text color table for antialiased fonts */
 264     COLORREF textColorTable[256];
 265 #endif
 266
 267     /* freetype face associated to current DC HFONT */
 268     FT_Face face;
 269
 270 } DIBDRVPHYSDEV;
 271
 272
 273 /* *********************************************************************
 274  * DISPLAY DRIVER ACCESS FUNCTIONS
 275  * ********************************************************************/
 276
 277 /* LoadDisplayDriver
 278  * Loads display driver - partially grabbed from gdi32 */
 279 DC_FUNCTIONS *_DIBDRV_LoadDisplayDriver(void);
 280
 281 /* FreeDisplayDriver
 282    Frees resources allocated by Display driver */
 283 void _DIBDRV_FreeDisplayDriver(void);
 284
 285 /* GetDisplayDriver
 286    Gets a pointer to display drives'function table */
 287 inline DC_FUNCTIONS *_DIBDRV_GetDisplayDriver(void);
 288
 289 /* *********************************************************************
 290  * ROP2 AND OTHER DRAWING RELATED FUNCTIONS
 291  * ********************************************************************/
 292
 293 void _DIBDRV_CalcAndXorMasks(INT rop, DWORD color, DWORD *and, DWORD *xor);
 294
 295 inline void _DIBDRV_rop32(DWORD *ptr, DWORD and, DWORD xor);
 296 inline void _DIBDRV_rop16(WORD *ptr, WORD and, WORD xor);
 297 inline void _DIBDRV_rop8(BYTE *ptr, BYTE and, BYTE xor);
 298
 299 void _DIBDRV_ResetDashOrigin(DIBDRVPHYSDEV *physDev);
 300
 301 /* *********************************************************************
 302  * ROP2 FUNCTIONS
 303  * ********************************************************************/
 304
 305 /* the ROP3 operations
 306    this is a BIG case block; beware that some
 307    commons ROP3 operations will be optimized
 308    from inside blt routines */
 309 DWORD _DIBDRV_ROP3(DWORD p, DWORD s, DWORD d, BYTE rop);
 310
 311 /* *********************************************************************
 312  * PHYSICAL BITMAP  FUNCTIONS
 313  * ********************************************************************/
 314
 315 /* gets human-readable dib format name */
 316 const char *_DIBDRVBITMAP_GetFormatName(DIBDRVBITMAP const *bmp);
 317
 318 /* sets/gets bits of a DIBDRVBITMAP taking in account if it's a top down
 319    or a bottom-up DIB */
 320 void _DIBDRVBITMAP_Set_Bits(DIBDRVBITMAP *dib, void *bits, BOOL owns);
 321 void *_DIBDRVBITMAP_Get_Bits(DIBDRVBITMAP *dib);
 322
 323 /* calculates and sets the lightest color for monochrome bitmaps */
 324 int _DIBDRVBITMAP_GetLightestColorIndex(DIBDRVBITMAP *dib);
 325
 326 /* initialize or create dib from a bitmap :
 327     dib           dib being initialized
 328     bi            source BITMAPINFOHEADER with required DIB format info
 329     bit_fields    color masks
 330     color_table   color table, if any
 331     bits          pointer to image data array
 332     NOTE : DIBDRVBITMAP doesn't owns bits, but do own color table */
 333 BOOL _DIBDRVBITMAP_InitFromBMIH(DIBDRVBITMAP *dib, const BITMAPINFOHEADER *bi, const DWORD *bit_fields,
 334                                 const RGBQUAD *color_table, void *bits);
 335 DIBDRVBITMAP *_DIBDRVBITMAP_CreateFromBMIH(const BITMAPINFOHEADER *bi, const DWORD *bit_fields,
 336                      const RGBQUAD *colorTable, void *bits);
 337
 338 BOOL _DIBDRVBITMAP_InitFromBitmapinfo(DIBDRVBITMAP *dib, const BITMAPINFO *bmi, void *bits);
 339 DIBDRVBITMAP *_DIBDRVBITMAP_CreateFromBitmapinfo(const BITMAPINFO *bmi, void *bits);
 340
 341 /* initializes a DIBRDVBITMAP copying it from a source one
 342    Parameters :
 343       dib       destination DIBDRVBITMAP
 344       src       source DIBDRVBITMAP
 345       copy      TRUE->copy source pixel array FALSE->link to source pixel array */
 346 BOOL _DIBDRVBITMAP_InitFromDibdrvbitmap(DIBDRVBITMAP *dib, const DIBDRVBITMAP *src, BOOL copy);
 347
 348 /* creates a DIBRDVBITMAP copying format info from a source one
 349    Parameters :
 350       dib            destination DIBDRVBITMAP
 351       src            source DIBDRVBITMAP
 352       widht, height  sizes of newly created bitmap  */
 353 BOOL _DIBDRVBITMAP_CreateFromDibdrvbitmap(DIBDRVBITMAP *dib, const DIBDRVBITMAP *src, int width, int height);
 354
 355 /* allocates a new DIBDTVBITMAP */
 356 DIBDRVBITMAP *_DIBDRVBITMAP_New(void);
 357
 358 /* Frees and de-allocates a DIBDRVBITMAP structure data */
 359 void _DIBDRVBITMAP_Free(DIBDRVBITMAP *bmp);
 360
 361 /* Clears a DIBDRVBITMAP structure data
 362    WARNING : doesn't free anything */
 363 void _DIBDRVBITMAP_Clear(DIBDRVBITMAP *bmp);
 364
 365 /* checks whether the format of 2 DIBs are identical
 366    it checks the pixel bit count and the color table size
 367    and content, if needed */
 368 BOOL _DIBDRVBITMAP_FormatMatch(const DIBDRVBITMAP *d1, const DIBDRVBITMAP *d2);
 369
 370 /* convert a given dib into another format given by 'format' parameter */
 371 BOOL _DIBDRVBITMAP_Convert(DIBDRVBITMAP *dst, const DIBDRVBITMAP *src, const DIBDRVBITMAP *format);
 372
 373 /* creates a solid-filled DIB of given color and format
 374    DIB format is given by 'format' parameter */
 375 BOOL _DIBDRVBITMAP_CreateSolid(DIBDRVBITMAP *bmp, DIBDRVBITMAP *format, int width, int height, DWORD Color);
 376
 377 /* expands horizontally a bitmap to reach a minimum size,
 378    keeping its width as a multiple of a base width
 379    Used to widen brushes in order to optimize blitting */
 380 BOOL _DIBDRVBITMAP_ExpandHoriz(DIBDRVBITMAP *dib, int baseWidth, int minWidth);
 381
 382 /* *********************************************************************
 383  * BITMAP LIST MANAGEMENT FUNCTIONS
 384  * ********************************************************************/
 385
 386 /* initializes bitmap list -- to be called at process attach */
 387 void _BITMAPLIST_Init(void);
 388
 389 /* terminates bitmap list -- to be called at process detach */
 390 void _BITMAPLIST_Terminate(void);
 391
 392 /* adds a DIB to the list - it adds it on top, as
 393    usually most recently created DIBs are used first */
 394 BOOL _BITMAPLIST_Add(HBITMAP hbmp, DIBDRVBITMAP *bmp);
 395
 396 /* removes a DIB from the list */
 397 DIBDRVBITMAP *_BITMAPLIST_Remove(HBITMAP hbmp);
 398
 399 /* scans list for a DIB */
 400 DIBDRVBITMAP *_BITMAPLIST_Get(HBITMAP hbmp);
 401
 402 /* *********************************************************************
 403  * DIB <--> DDB CONVERSION ROUTINES
 404  * ********************************************************************/
 405
 406 /***********************************************************************
 407  * Creates DDB that is compatible with source hdc.
 408  * hdc is the HDC on where the DIB MUST be selected in
 409  * srcBmp is the source DIB
 410  * startScan and scanLines specify the portion of DIB to convert
 411  * in order to avoid unneeded conversion of large DIBs on blitting
 412  *
 413  * NOTE : the srcBmp DIB MUST NOT be selected in any DC */
 414 HBITMAP _DIBDRV_ConvertDIBtoDDB( HDC hdc, HBITMAP srcBmp, int startScan, int scanLines );
 415
 416 /***********************************************************************
 417  * Creates DIB that is compatible with the target hdc.
 418  * startScan and scanLines specify the portion of DDB to convert
 419  * in order to avoid unneeded conversion of large DDBs on blitting
 420  *
 421  * NOTE : the srcBmp DDB MUST NOT be selected in any DC */
 422 HBITMAP _DIBDRV_ConvertDDBtoDIB( HDC hdc, HBITMAP srcBmp, int startScan, int scanLines );
 423
 424 /***********************************************************************
 425  * Creates DIB that is compatible with the target hdc for a device (non memory) source DC */
 426 HBITMAP _DIBDRV_ConvertDevDDBtoDIB( HDC hdcSrc, HDC hdcDst, int xSrc, int ySrc, int width, int height );
 427
 428 /* *********************************************************************
 429  * QUERY FUNCTIONS
 430  * ********************************************************************/
 431
 432 /***********************************************************************
 433  *           DIBDRV_GetDeviceCaps */
 434 INT DIBDRV_GetDeviceCaps( DIBDRVPHYSDEV *physDev, INT cap );
 435
 436 /* *********************************************************************
 437  * GEOMETRIC UTILITIES
 438  * ********************************************************************/
 439
 440 /* intersect 2 rectangles (just to not use USER32 one...) */
 441 BOOL _DIBDRV_IntersectRect(RECT *d, const RECT *s1, const RECT *s2);
 442
 443 /* converts positions  from Word space to Device space */
 444 void _DIBDRV_Position_ws2ds(DIBDRVPHYSDEV *physDev, int *x, int *y);
 445 void _DIBDRV_Positions_ws2ds(DIBDRVPHYSDEV *physDev, int *x1, int *y1, int *x2, int *y2);
 446
 447 /* converts sizes from Word space to Device space */
 448 void _DIBDRV_Sizes_ws2ds(DIBDRVPHYSDEV *physDev, int *w, int *h);
 449
 450 /* converts a rectangle form Word space to Device space */
 451 void _DIBDRV_Rect_ws2ds(DIBDRVPHYSDEV *physDev, const RECT *src, RECT *dst);
 452
 453 /* converts positions  from Device space to World space */
 454 void _DIBDRV_Position_ds2ws(DIBDRVPHYSDEV *physDev, int *x, int *y);
 455 void _DIBDRV_Positions_ds2ws(DIBDRVPHYSDEV *physDev, int *x1, int *y1, int *x2, int *y2);
 456
 457 /* converts sizes from Device space to World space */
 458 void _DIBDRV_Sizes_ds2ws(DIBDRVPHYSDEV *physDev, int *w, int *h);
 459
 460 /* *********************************************************************
 461  * COLOR UTILITIES
 462  * ********************************************************************/
 463
 464 /* maps a colorref to actual color */
 465 COLORREF _DIBDRV_MapColor(DIBDRVPHYSDEV *physDev, COLORREF color);
 466
 467 /* gets nearest color index in DIB palette of a given colorref */
 468 DWORD _DIBDRV_GetNearestColorIndex(const DIBDRVBITMAP *dib, COLORREF color);
 469
 470 /* gets nearest color to DIB palette color */
 471 DWORD _DIBDRV_GetNearestColor(const DIBDRVBITMAP *dib, COLORREF color);
 472
 473 #endif