dlls/gdiplus/gdiplus_private.h

   1 /*
   2  * Copyright (C) 2007 Google (Evan Stade)
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef __WINE_GP_PRIVATE_H_
  20 #define __WINE_GP_PRIVATE_H_
  21
  22 #include <math.h>
  23 #include <stdarg.h>
  24
  25 #include "windef.h"
  26 #include "wingdi.h"
  27 #include "winbase.h"
  28 #include "winuser.h"
  29
  30 #include "objbase.h"
  31 #include "ocidl.h"
  32 #include "wincodecsdk.h"
  33 #include "wine/list.h"
  34
  35 #include "gdiplus.h"
  36
  37 #define GP_DEFAULT_PENSTYLE (PS_GEOMETRIC | PS_SOLID | PS_ENDCAP_FLAT | PS_JOIN_MITER)
  38 #define MAX_ARC_PTS (13)
  39 #define MAX_DASHLEN (16) /* this is a limitation of gdi */
  40 #define INCH_HIMETRIC (2540)
  41
  42 #define VERSION_MAGIC  0xdbc01001
  43 #define VERSION_MAGIC2 0xdbc01002
  44 #define TENSION_CONST (0.3)
  45
  46 #define GIF_DISPOSE_UNSPECIFIED 0
  47 #define GIF_DISPOSE_DO_NOT_DISPOSE 1
  48 #define GIF_DISPOSE_RESTORE_TO_BKGND 2
  49 #define GIF_DISPOSE_RESTORE_TO_PREV 3
  50
  51 static void *heap_alloc_zero(size_t len) __WINE_ALLOC_SIZE(1);
  52 static inline void *heap_alloc_zero(size_t len)
  53 {
  54     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
  55 }
  56
  57 static inline BOOL heap_free(void *mem)
  58 {
  59     return HeapFree(GetProcessHeap(), 0, mem);
  60 }
  61
  62 COLORREF ARGB2COLORREF(ARGB color) DECLSPEC_HIDDEN;
  63 HBITMAP ARGB2BMP(ARGB color) DECLSPEC_HIDDEN;
  64 extern INT arc2polybezier(GpPointF * points, REAL x1, REAL y1, REAL x2, REAL y2,
  65     REAL startAngle, REAL sweepAngle) DECLSPEC_HIDDEN;
  66 extern REAL gdiplus_atan2(REAL dy, REAL dx) DECLSPEC_HIDDEN;
  67 extern GpStatus hresult_to_status(HRESULT res) DECLSPEC_HIDDEN;
  68 extern REAL units_to_pixels(REAL units, GpUnit unit, REAL dpi) DECLSPEC_HIDDEN;
  69 extern REAL pixels_to_units(REAL pixels, GpUnit unit, REAL dpi) DECLSPEC_HIDDEN;
  70 extern REAL units_scale(GpUnit from, GpUnit to, REAL dpi) DECLSPEC_HIDDEN;
  71
  72 extern GpStatus graphics_from_image(GpImage *image, GpGraphics **graphics) DECLSPEC_HIDDEN;
  73
  74 extern GpStatus METAFILE_GetGraphicsContext(GpMetafile* metafile, GpGraphics **result) DECLSPEC_HIDDEN;
  75 extern GpStatus METAFILE_GetDC(GpMetafile* metafile, HDC *hdc) DECLSPEC_HIDDEN;
  76 extern GpStatus METAFILE_ReleaseDC(GpMetafile* metafile, HDC hdc) DECLSPEC_HIDDEN;
  77 extern GpStatus METAFILE_FillRectangles(GpMetafile* metafile, GpBrush* brush,
  78     GDIPCONST GpRectF* rects, INT count) DECLSPEC_HIDDEN;
  79 extern GpStatus METAFILE_SetPageTransform(GpMetafile* metafile, GpUnit unit, REAL scale) DECLSPEC_HIDDEN;
  80 extern GpStatus METAFILE_GraphicsDeleted(GpMetafile* metafile) DECLSPEC_HIDDEN;
  81
  82 extern void calc_curve_bezier(const GpPointF *pts, REAL tension, REAL *x1,
  83     REAL *y1, REAL *x2, REAL *y2) DECLSPEC_HIDDEN;
  84 extern void calc_curve_bezier_endp(REAL xend, REAL yend, REAL xadj, REAL yadj,
  85     REAL tension, REAL *x, REAL *y) DECLSPEC_HIDDEN;
  86
  87 extern void free_installed_fonts(void) DECLSPEC_HIDDEN;
  88
  89 extern BOOL lengthen_path(GpPath *path, INT len) DECLSPEC_HIDDEN;
  90
  91 extern GpStatus trace_path(GpGraphics *graphics, GpPath *path) DECLSPEC_HIDDEN;
  92
  93 typedef struct region_element region_element;
  94 extern void delete_element(region_element *element) DECLSPEC_HIDDEN;
  95
  96 extern GpStatus get_hatch_data(HatchStyle hatchstyle, const char **result) DECLSPEC_HIDDEN;
  97
  98 static inline INT gdip_round(REAL x)
  99 {
 100     return (INT) floorf(x + 0.5);
 101 }
 102
 103 static inline INT ceilr(REAL x)
 104 {
 105     return (INT) ceilf(x);
 106 }
 107
 108 static inline REAL deg2rad(REAL degrees)
 109 {
 110     return M_PI * degrees / 180.0;
 111 }
 112
 113 static inline ARGB color_over(ARGB bg, ARGB fg)
 114 {
 115     BYTE b, g, r, a;
 116     BYTE bg_alpha, fg_alpha;
 117
 118     fg_alpha = (fg>>24)&0xff;
 119
 120     if (fg_alpha == 0xff) return fg;
 121
 122     if (fg_alpha == 0) return bg;
 123
 124     bg_alpha = (((bg>>24)&0xff) * (0xff-fg_alpha)) / 0xff;
 125
 126     if (bg_alpha == 0) return fg;
 127
 128     a = bg_alpha + fg_alpha;
 129     b = ((bg&0xff)*bg_alpha + (fg&0xff)*fg_alpha)/a;
 130     g = (((bg>>8)&0xff)*bg_alpha + ((fg>>8)&0xff)*fg_alpha)/a;
 131     r = (((bg>>16)&0xff)*bg_alpha + ((fg>>16)&0xff)*fg_alpha)/a;
 132
 133     return (a<<24)|(r<<16)|(g<<8)|b;
 134 }
 135
 136 /* fg is premult, bg and return value are not */
 137 static inline ARGB color_over_fgpremult(ARGB bg, ARGB fg)
 138 {
 139     BYTE b, g, r, a;
 140     BYTE bg_alpha, fg_alpha;
 141
 142     fg_alpha = (fg>>24)&0xff;
 143
 144     if (fg_alpha == 0) return bg;
 145
 146     bg_alpha = (((bg>>24)&0xff) * (0xff-fg_alpha)) / 0xff;
 147
 148     a = bg_alpha + fg_alpha;
 149     b = ((bg&0xff)*bg_alpha + (fg&0xff)*0xff)/a;
 150     g = (((bg>>8)&0xff)*bg_alpha + ((fg>>8)&0xff)*0xff)/a;
 151     r = (((bg>>16)&0xff)*bg_alpha + ((fg>>16)&0xff)*0xff)/a;
 152
 153     return (a<<24)|(r<<16)|(g<<8)|b;
 154 }
 155
 156 extern const char *debugstr_rectf(const RectF* rc) DECLSPEC_HIDDEN;
 157
 158 extern const char *debugstr_pointf(const PointF* pt) DECLSPEC_HIDDEN;
 159
 160 extern void convert_32bppARGB_to_32bppPARGB(UINT width, UINT height,
 161     BYTE *dst_bits, INT dst_stride, const BYTE *src_bits, INT src_stride) DECLSPEC_HIDDEN;
 162
 163 extern GpStatus convert_pixels(INT width, INT height,
 164     INT dst_stride, BYTE *dst_bits, PixelFormat dst_format,
 165     INT src_stride, const BYTE *src_bits, PixelFormat src_format, ColorPalette *palette) DECLSPEC_HIDDEN;
 166
 167 struct GpMatrix{
 168     REAL matrix[6];
 169 };
 170
 171 struct GpPen{
 172     UINT style;
 173     GpUnit unit;
 174     REAL width;
 175     GpLineCap endcap;
 176     GpLineCap startcap;
 177     GpDashCap dashcap;
 178     GpCustomLineCap *customstart;
 179     GpCustomLineCap *customend;
 180     GpLineJoin join;
 181     REAL miterlimit;
 182     GpDashStyle dash;
 183     REAL *dashes;
 184     INT numdashes;
 185     REAL offset;    /* dash offset */
 186     GpBrush *brush;
 187     GpPenAlignment align;
 188 };
 189
 190 struct GpGraphics{
 191     HDC hdc;
 192     HWND hwnd;
 193     BOOL owndc;
 194     BOOL alpha_hdc;
 195     GpImage *image;
 196     ImageType image_type;
 197     SmoothingMode smoothing;
 198     CompositingQuality compqual;
 199     InterpolationMode interpolation;
 200     PixelOffsetMode pixeloffset;
 201     CompositingMode compmode;
 202     TextRenderingHint texthint;
 203     GpUnit unit;    /* page unit */
 204     REAL scale;     /* page scale */
 205     REAL xres, yres;
 206     GpMatrix worldtrans; /* world transform */
 207     BOOL busy;      /* hdc handle obtained by GdipGetDC */
 208     GpRegion *clip; /* in device coords */
 209     UINT textcontrast; /* not used yet. get/set only */
 210     struct list containers;
 211     GraphicsContainer contid; /* last-issued container ID */
 212     INT origin_x, origin_y;
 213     /* For giving the caller an HDC when we technically can't: */
 214     HBITMAP temp_hbitmap;
 215     int temp_hbitmap_width;
 216     int temp_hbitmap_height;
 217     BYTE *temp_bits;
 218     HDC temp_hdc;
 219 };
 220
 221 struct GpBrush{
 222     GpBrushType bt;
 223 };
 224
 225 struct GpHatch{
 226     GpBrush brush;
 227     HatchStyle hatchstyle;
 228     ARGB forecol;
 229     ARGB backcol;
 230 };
 231
 232 struct GpSolidFill{
 233     GpBrush brush;
 234     ARGB color;
 235 };
 236
 237 struct GpPathGradient{
 238     GpBrush brush;
 239     GpPath* path;
 240     ARGB centercolor;
 241     GpWrapMode wrap;
 242     BOOL gamma;
 243     GpPointF center;
 244     GpPointF focus;
 245     REAL* blendfac;  /* blend factors */
 246     REAL* blendpos;  /* blend positions */
 247     INT blendcount;
 248     ARGB *surroundcolors;
 249     INT surroundcolorcount;
 250     ARGB* pblendcolor; /* preset blend colors */
 251     REAL* pblendpos; /* preset blend positions */
 252     INT pblendcount;
 253     GpMatrix transform;
 254 };
 255
 256 struct GpLineGradient{
 257     GpBrush brush;
 258     GpPointF startpoint;
 259     GpPointF endpoint;
 260     ARGB startcolor;
 261     ARGB endcolor;
 262     RectF rect;
 263     GpWrapMode wrap;
 264     BOOL gamma;
 265     REAL* blendfac;  /* blend factors */
 266     REAL* blendpos;  /* blend positions */
 267     INT blendcount;
 268     ARGB* pblendcolor; /* preset blend colors */
 269     REAL* pblendpos; /* preset blend positions */
 270     INT pblendcount;
 271 };
 272
 273 struct GpTexture{
 274     GpBrush brush;
 275     GpMatrix transform;
 276     GpImage *image;
 277     GpImageAttributes *imageattributes;
 278     BYTE *bitmap_bits; /* image bits converted to ARGB and run through imageattributes */
 279 };
 280
 281 struct GpPath{
 282     GpFillMode fill;
 283     GpPathData pathdata;
 284     BOOL newfigure; /* whether the next drawing action starts a new figure */
 285     INT datalen; /* size of the arrays in pathdata */
 286 };
 287
 288 struct GpPathIterator{
 289     GpPathData pathdata;
 290     INT subpath_pos;    /* for NextSubpath methods */
 291     INT marker_pos;     /* for NextMarker methods */
 292     INT pathtype_pos;   /* for NextPathType methods */
 293 };
 294
 295 struct GpCustomLineCap{
 296     GpPathData pathdata;
 297     BOOL fill;      /* TRUE for fill, FALSE for stroke */
 298     GpLineCap cap;  /* as far as I can tell, this value is ignored */
 299     REAL inset;     /* how much to adjust the end of the line */
 300     GpLineJoin join;
 301     REAL scale;
 302 };
 303
 304 struct GpAdustableArrowCap{
 305     GpCustomLineCap cap;
 306 };
 307
 308 struct GpImage{
 309     IPicture *picture;
 310     IWICBitmapDecoder *decoder;
 311     ImageType type;
 312     GUID format;
 313     UINT flags;
 314     UINT frame_count, current_frame;
 315     ColorPalette *palette;
 316     REAL xres, yres;
 317 };
 318
 319 struct GpMetafile{
 320     GpImage image;
 321     GpRectF bounds;
 322     GpUnit unit;
 323     MetafileType metafile_type;
 324     HENHMETAFILE hemf;
 325     int preserve_hemf; /* if true, hemf belongs to the app and should not be deleted */
 326
 327     /* recording */
 328     HDC record_dc;
 329     GpGraphics *record_graphics;
 330     BYTE *comment_data;
 331     DWORD comment_data_size;
 332     DWORD comment_data_length;
 333
 334     /* playback */
 335     GpGraphics *playback_graphics;
 336     HDC playback_dc;
 337     GpPointF playback_points[3];
 338     GpRectF src_rect;
 339     HANDLETABLE *handle_table;
 340     int handle_count;
 341     GpMatrix *world_transform;
 342     GpUnit page_unit;
 343     REAL page_scale;
 344 };
 345
 346 struct GpBitmap{
 347     GpImage image;
 348     INT width;
 349     INT height;
 350     PixelFormat format;
 351     ImageLockMode lockmode;
 352     INT numlocks;
 353     BYTE *bitmapbits;   /* pointer to the buffer we passed in BitmapLockBits */
 354     HBITMAP hbitmap;
 355     HDC hdc;
 356     BYTE *bits; /* actual image bits if this is a DIB */
 357     INT stride; /* stride of bits if this is a DIB */
 358     BYTE *own_bits; /* image bits that need to be freed with this object */
 359     INT lockx, locky; /* X and Y coordinates of the rect when a bitmap is locked for writing. */
 360     IWICMetadataReader *metadata_reader; /* NULL if there is no metadata */
 361     UINT prop_count;
 362     PropertyItem *prop_item; /* cached image properties */
 363 };
 364
 365 struct GpCachedBitmap{
 366     GpImage *image;
 367 };
 368
 369 struct color_key{
 370     BOOL enabled;
 371     ARGB low;
 372     ARGB high;
 373 };
 374
 375 struct color_matrix{
 376     BOOL enabled;
 377     ColorMatrixFlags flags;
 378     ColorMatrix colormatrix;
 379     ColorMatrix graymatrix;
 380 };
 381
 382 struct color_remap_table{
 383     BOOL enabled;
 384     INT mapsize;
 385     ColorMap *colormap;
 386 };
 387
 388 struct GpImageAttributes{
 389     WrapMode wrap;
 390     ARGB outside_color;
 391     BOOL clamp;
 392     struct color_key colorkeys[ColorAdjustTypeCount];
 393     struct color_matrix colormatrices[ColorAdjustTypeCount];
 394     struct color_remap_table colorremaptables[ColorAdjustTypeCount];
 395     BOOL gamma_enabled[ColorAdjustTypeCount];
 396     REAL gamma[ColorAdjustTypeCount];
 397 };
 398
 399 struct GpFont{
 400     GpFontFamily *family;
 401     OUTLINETEXTMETRICW otm;
 402     REAL emSize; /* in font units */
 403     Unit unit;
 404 };
 405
 406 struct GpStringFormat{
 407     INT attr;
 408     LANGID lang;
 409     LANGID digitlang;
 410     StringAlignment align;
 411     StringTrimming trimming;
 412     HotkeyPrefix hkprefix;
 413     StringAlignment vertalign;
 414     StringDigitSubstitute digitsub;
 415     INT tabcount;
 416     REAL firsttab;
 417     REAL *tabs;
 418     CharacterRange *character_ranges;
 419     INT range_count;
 420     BOOL generic_typographic;
 421 };
 422
 423 struct GpFontCollection{
 424     GpFontFamily **FontFamilies;
 425     INT count;
 426     INT allocated;
 427 };
 428
 429 struct GpFontFamily{
 430     WCHAR FamilyName[LF_FACESIZE];
 431     UINT16 em_height, ascent, descent, line_spacing; /* in font units */
 432     int dpi;
 433 };
 434
 435 /* internal use */
 436 typedef enum RegionType
 437 {
 438     RegionDataRect          = 0x10000000,
 439     RegionDataPath          = 0x10000001,
 440     RegionDataEmptyRect     = 0x10000002,
 441     RegionDataInfiniteRect  = 0x10000003,
 442 } RegionType;
 443
 444 struct region_element
 445 {
 446     DWORD type; /* Rectangle, Path, SpecialRectangle, or CombineMode */
 447     union
 448     {
 449         GpRectF rect;
 450         GpPath *path;
 451         struct
 452         {
 453             struct region_element *left;  /* the original region */
 454             struct region_element *right; /* what *left was combined with */
 455         } combine;
 456     } elementdata;
 457 };
 458
 459 struct GpRegion{
 460     DWORD num_children;
 461     region_element node;
 462 };
 463
 464 typedef GpStatus (*gdip_format_string_callback)(HDC hdc,
 465     GDIPCONST WCHAR *string, INT index, INT length, GDIPCONST GpFont *font,
 466     GDIPCONST RectF *rect, GDIPCONST GpStringFormat *format,
 467     INT lineno, const RectF *bounds, INT *underlined_indexes,
 468     INT underlined_index_count, void *user_data);
 469
 470 GpStatus gdip_format_string(HDC hdc,
 471     GDIPCONST WCHAR *string, INT length, GDIPCONST GpFont *font,
 472     GDIPCONST RectF *rect, GDIPCONST GpStringFormat *format, int ignore_empty_clip,
 473     gdip_format_string_callback callback, void *user_data) DECLSPEC_HIDDEN;
 474
 475 void get_log_fontW(const GpFont *, GpGraphics *, LOGFONTW *) DECLSPEC_HIDDEN;
 476
 477 #endif