rom/graphics/graphics_intern.h

   1 #ifndef GRAPHICS_INTERN_H
   2 #define GRAPHICS_INTERN_H
   3 /*
   4     Copyright © 1995-2010, The AROS Development Team. All rights reserved.
   5     $Id$
   6
   7     Desc: Internal header file for graphics.library
   8     Lang: english
   9 */
  10
  11 #ifndef AROS_LIBCALL_H
  12 #   include <aros/libcall.h>
  13 #endif
  14 #ifndef EXEC_EXECBASE_H
  15 #   include <exec/execbase.h>
  16 #endif
  17 #ifndef EXEC_LISTS_H
  18 #   include <exec/lists.h>
  19 #endif
  20 #ifndef EXEC_NODES_H
  21 #   include <exec/nodes.h>
  22 #endif
  23 #ifndef EXEC_SEMAPHORE_H
  24 #   include <exec/semaphores.h>
  25 #endif
  26 #ifndef GRAPHICS_GFXBASE_H
  27 #   include <graphics/gfxbase.h>
  28 #endif
  29 #ifndef GRAPHICS_TEXT_H
  30 #   include <graphics/text.h>
  31 #endif
  32 #ifndef GRAPHICS_RASTPORT_H
  33 #   include <graphics/rastport.h>
  34 #endif
  35 #ifndef GRAPHICS_REGIONS_H
  36 #   include <graphics/regions.h>
  37 #endif
  38 #ifndef OOP_OOP_H
  39 #   include <oop/oop.h>
  40 #endif
  41 #ifndef GRAPHICS_VIEW_H
  42 #   include <graphics/view.h>
  43 #endif
  44 #ifndef HIDD_GRAPHICS_H
  45 #   include <hidd/graphics.h>
  46 #endif
  47
  48 #include <exec/memory.h>
  49 #include <proto/exec.h>
  50 #include <graphics/scale.h>
  51 #include "fontsupport.h"
  52 #include "objcache.h"
  53
  54 #define BITMAP_CLIPPING         1
  55
  56 #define REGIONS_USE_MEMPOOL     1
  57
  58 /* Setting BMDEPTH_COMPATIBILITY to 1 will cause bitmap->Depth
  59    to be never bigger than 8. The same seems to be the case under
  60    AmigaOS with CyberGraphX/Picasso96. GetBitMapAttr() OTOH will
  61    actually return the real depth. */
  62
  63 #define BMDEPTH_COMPATIBILITY   1
  64
  65 #define OBTAIN_DRIVERDATA(rp,libbase)   ObtainDriverData(rp, libbase)
  66 #define RELEASE_DRIVERDATA(rp,libbase)  ReleaseDriverData(rp, libbase)
  67
  68 #define SIZERECTBUF 128
  69
  70 struct RegionRectangleExt
  71 {
  72     struct RegionRectangle     RR;
  73     IPTR                       Counter;
  74 };
  75
  76 struct RegionRectangleExtChunk
  77 {
  78      struct RegionRectangleExt       Rects[SIZERECTBUF];
  79      struct RegionRectangleExtChunk *FirstChunk;
  80 };
  81
  82 #define RRE(x)     ((struct RegionRectangleExt *)(x))
  83 #define Counter(x) (RRE(x)->Counter)
  84 #define Chunk(x)   ((x) ? ((struct RegionRectangleExtChunk *)&RRE(x)[-Counter(x)]) : NULL)
  85
  86 /* PaletteExtra internals */
  87
  88 typedef WORD PalExtra_RefCnt_Type;
  89 typedef WORD PalExtra_AllocList_Type;
  90
  91 #define PALEXTRA_REFCNT(pe,n)       (((PalExtra_RefCnt_Type *)(pe)->pe_RefCnt)[(n)])
  92 #define PALEXTRA_ALLOCLIST(pe,n)    (((PalExtra_AllocList_Type *)(pe)->pe_AllocList)[(n)])
  93
  94 struct class_static_data
  95 {
  96     struct GfxBase  *gfxbase;
  97
  98     OOP_AttrBase    hiddFakeFBAttrBase;
  99
 100     OOP_Class       *fakegfxclass;
 101     OOP_Class       *fakefbclass;
 102 };
 103
 104 /*
 105  * Display mode database item. A pointer to this structure is used as a DisplayInfoHandle.
 106  * In future, if needed, this structure can be extended to hold static bunches of associated
 107  * DisplayInfoData.
 108  */
 109
 110 struct monitor_driverdata;
 111
 112 struct DisplayInfoHandle
 113 {
 114     HIDDT_ModeID               id;      /* HIDD Mode ID (without card ID)           */
 115     struct monitor_driverdata *drv;     /* Points back to display driver descriptor */
 116 };
 117
 118 #define DIH(x) ((struct DisplayInfoHandle *)x)
 119
 120 /* Monitor driver data. Describes a single physical display. */
 121 struct monitor_driverdata
 122 {
 123     struct monitor_driverdata *next;            /* Next driver data in chain                      */
 124     ULONG                      id;              /* Card ID (part of display mode ID)              */
 125     ULONG                      mask;            /* Mask of mode ID                                */
 126     OOP_Object                *gfxhidd;         /* Graphics driver to use (can be fakegfx object) */
 127     ObjectCache               *gc_cache;        /* GC cache                                       */
 128
 129     APTR                       userdata;        /* Associated data from notification callback     */
 130     UWORD                      flags;           /* Flags, see below                               */
 131     struct HIDD_ViewPortData  *display;         /* What is currently displayed                    */
 132
 133     /* FakeGfx-related */
 134     OOP_Object                *gfxhidd_orig;    /* Real graphics driver object                    */
 135
 136     /* Framebuffer stuff */
 137     struct BitMap             *frontbm;         /* Currently shown bitmap                         */
 138     OOP_Object                *framebuffer;     /* Framebuffer bitmap object                      */
 139     OOP_Object                *bm_bak;          /* Original shown bitmap object                   */
 140     OOP_Object                *colmap_bak;      /* Original colormap object of shown bitmap       */
 141     HIDDT_ColorModel          colmod_bak;       /* Original colormodel of shown bitmap            */
 142
 143     /* Display mode database. */
 144     struct DisplayInfoHandle  modes[1];         /* Display modes array                            */
 145 };
 146
 147 /* Driver flags */
 148 #define DF_BootMode   0x0001
 149 #define DF_UseFakeGfx 0x0002
 150
 151 /* Common driver data data to all monitors */
 152 struct common_driverdata
 153 {
 154     /* The order of these fields match struct monitor_driverdata */
 155     struct monitor_driverdata *monitors;                /* First monitor driver            */
 156     ULONG                      invalid_id;              /* INVALID_ID, for GET_BM_MODEID() */
 157     ULONG                      last_id;                 /* Last card ID                    */
 158     OOP_Object                *memorygfx;               /* Memory graphics driver          */
 159     ObjectCache               *gc_cache;                /* GC cache                        */
 160
 161     /* End of driverdata */
 162     APTR                       notify_data;                   /* User data for notification callback  */
 163     APTR (*DriverNotify)(APTR obj, BOOL add, APTR userdata); /* Display driver notification callback */
 164     struct SignalSemaphore     displaydb_sem;           /* Display mode database semaphore */
 165
 166     ObjectCache               *planarbm_cache;          /* Planar bitmaps cache            */
 167
 168     /* Attribute bases */
 169     OOP_AttrBase             hiddBitMapAttrBase;
 170     OOP_AttrBase             hiddGCAttrBase;
 171     OOP_AttrBase             hiddSyncAttrBase;
 172     OOP_AttrBase             hiddPixFmtAttrBase;
 173     OOP_AttrBase             hiddPlanarBMAttrBase;
 174     OOP_AttrBase             hiddGfxAttrBase;
 175     OOP_AttrBase             hiddFakeGfxHiddAttrBase;
 176 };
 177
 178 #define CDD(base)           ((struct common_driverdata *)&PrivGBase(base)->shared_driverdata)
 179
 180 #define __IHidd_BitMap      CDD(GfxBase)->hiddBitMapAttrBase
 181 #define __IHidd_GC          CDD(GfxBase)->hiddGCAttrBase
 182 #define __IHidd_Sync        CDD(GfxBase)->hiddSyncAttrBase
 183 #define __IHidd_PixFmt      CDD(GfxBase)->hiddPixFmtAttrBase
 184 #define __IHidd_PlanarBM    CDD(GfxBase)->hiddPlanarBMAttrBase
 185 #define __IHidd_Gfx         CDD(GfxBase)->hiddGfxAttrBase
 186 #define __IHidd_FakeGfxHidd CDD(GfxBase)->hiddFakeGfxHiddAttrBase
 187
 188 /* Hashtable sizes. Must be powers of two */
 189 #define GFXASSOCIATE_HASHSIZE   8
 190 #define TFE_HASHTABSIZE         16
 191 #define DRIVERDATALIST_HASHSIZE 256
 192
 193 /* Internal GFXBase struct */
 194 struct GfxBase_intern
 195 {
 196     struct GfxBase              gfxbase;
 197
 198     struct class_static_data    *fakegfx_staticdata; /* FakeGFX HIDD static data                                 */
 199     ULONG                       displays;            /* Number of display drivers installed in the system        */
 200     struct common_driverdata    shared_driverdata;   /* Driver data shared between all monitors (allocated once) */
 201     struct SignalSemaphore      monitors_sema;       /* Monitor list semaphore                                   */
 202     struct SignalSemaphore      hashtab_sema;        /* hash_table arbitration semaphore                         */
 203     struct SignalSemaphore      view_sema;           /* ActiView arbitration semaphore                           */
 204
 205     /* TextFontExtension pool */
 206     struct tfe_hashnode         * tfe_hashtab[TFE_HASHTABSIZE];
 207     struct SignalSemaphore      tfe_hashtab_sema;
 208     struct SignalSemaphore      fontsem;
 209
 210 #if REGIONS_USE_MEMPOOL
 211     /* Regions pool */
 212     struct SignalSemaphore      regionsem;
 213     APTR                        regionpool;
 214     struct MinList              ChunkPoolList;
 215 #endif
 216
 217     /* GC driverdata pool */
 218     struct SignalSemaphore      driverdatasem;
 219     APTR                        driverdatapool;
 220     struct MinList              driverdatalist[DRIVERDATALIST_HASHSIZE];
 221
 222     /* Pixelbuffer, needed for some operations */
 223     ULONG                      *pixel_buf;
 224     struct SignalSemaphore      pixbuf_sema;
 225     struct SignalSemaphore      blit_sema;
 226
 227     /* Private library bases */
 228     struct Library             *CyberGfxBase;
 229 };
 230
 231
 232 /* Macros */
 233
 234 #define PrivGBase(x)            ((struct GfxBase_intern *)x)
 235 #define CyberGfxBase            (PrivGBase(GfxBase)->CyberGfxBase)
 236
 237 #define WIDTH_TO_BYTES(width)   ((( (width) + 15) & ~15) >> 3)
 238 #define WIDTH_TO_WORDS(width)   ((( (width) + 15) & ~15) >> 4)
 239
 240 #define XCOORD_TO_BYTEIDX( x )  (( x ) >> 3)
 241 #define XCOORD_TO_WORDIDX( x )  (( x ) >> 4)
 242
 243 #define COORD_TO_BYTEIDX(x, y, bytes_per_row)   \
 244                                 ( ( ((LONG)(y)) * (bytes_per_row)) + XCOORD_TO_BYTEIDX(x))
 245
 246 #define CHUNKY8_COORD_TO_BYTEIDX(x, y, bytes_per_row)   \
 247                                 ( ( ((LONG)(y)) * (bytes_per_row)) + (x) )
 248
 249 #define XCOORD_TO_MASK(x)       (128L >> ((x) & 0x07))
 250
 251 /* For vsprite sorting */
 252
 253 #define JOIN_XY_COORDS(x,y)     (LONG)( ( ((UWORD)(y)) << 16) + ( ( ((UWORD)(x)) + 0x8000 ) & 0xFFFF ) )
 254
 255 #define TFE(tfe)                (*(struct TextFontExtension**)&tfe)
 256
 257 #define TFE_MATCHWORD           0xDFE7 /* randomly invented */
 258
 259 /* Defines for flags in areainfo->FlagPtr */
 260
 261 #define AREAINFOFLAG_MOVE       0x00
 262 #define AREAINFOFLAG_DRAW       0x01
 263 #define AREAINFOFLAG_CLOSEDRAW  0x02
 264 #define AREAINFOFLAG_ELLIPSE    0x03
 265
 266 /* Forward declaration */
 267 struct ViewPort;
 268
 269 /* Hash index calculation */
 270 extern ULONG CalcHashIndex(IPTR n, UWORD size);
 271
 272 BOOL ObtainDriverData (struct RastPort * rp, struct GfxBase * GfxBase);
 273 void ReleaseDriverData (struct RastPort * rp, struct GfxBase * GfxBase);
 274 void KillDriverData (struct RastPort * rp, struct GfxBase * GfxBase);
 275
 276 /* a function needed by ClipBlit */
 277 void internal_ClipBlit(struct RastPort * srcRP,
 278                        LONG xSrc,
 279                        LONG ySrc,
 280                        struct RastPort * destRP,
 281                        LONG xDest,
 282                        LONG yDest,
 283                        LONG xSize,
 284                        LONG ySize,
 285                        UBYTE minterm,
 286                        struct GfxBase * GfxBase);
 287
 288 /* Driver prototypes */
 289 extern void driver_LoadView(struct View *view, struct GfxBase *);
 290
 291 extern struct monitor_driverdata *driver_Setup(OOP_Object *gfxhidd, struct GfxBase *GfxBase);
 292 extern void driver_Expunge(struct monitor_driverdata *mdd, struct GfxBase *GfxBase);
 293
 294 /* functions in support.c */
 295 extern BOOL pattern_pen(struct RastPort *rp
 296         , LONG x, LONG y
 297         , ULONG apen, ULONG bpen
 298         , ULONG *pixval_ptr
 299         , struct GfxBase *GfxBase);
 300
 301 /* function for area opeartions */
 302 BOOL areafillpolygon(struct RastPort  * rp,
 303                      struct Rectangle * bounds,
 304                      UWORD              first_idx,
 305                      UWORD              last_idx,
 306                      ULONG              bytesperrow,
 307                      struct GfxBase   * GfxBase);
 308
 309 void areafillellipse(struct RastPort   * rp,
 310                      struct Rectangle  * bounds,
 311                      UWORD             * CurVctr,
 312                      ULONG               BytesPerRow,
 313                      struct GfxBase    * GfxBase);
 314
 315 void areaclosepolygon(struct AreaInfo *areainfo);
 316
 317 /* functions in color_support */
 318 ULONG color_distance(struct ColorMap * cm,
 319                      ULONG r,
 320                      ULONG g,
 321                      ULONG b,
 322                      ULONG index);
 323
 324 BOOL color_equal(struct ColorMap * cm,
 325                  ULONG r,
 326                  ULONG g,
 327                  ULONG b,
 328                  ULONG index);
 329
 330 VOID color_get(struct ColorMap *cm,
 331                 ULONG *r,
 332                 ULONG *g,
 333                 ULONG *b,
 334                 ULONG index);
 335
 336 void _DisposeRegionRectangleList
 337 (
 338     struct RegionRectangle *RR,
 339     struct GfxBase         *GfxBase
 340 );
 341
 342 struct RegionRectangle *_NewRegionRectangle
 343 (
 344     struct RegionRectangle **LastRectPtr,
 345     struct GfxBase *GfxBase
 346 );
 347
 348 BOOL _LinkRegionRectangleList
 349 (
 350     struct RegionRectangle  *src,
 351     struct RegionRectangle **dstptr,
 352     struct GfxBase          *GfxBase
 353 );
 354
 355 #if REGIONS_USE_POOL
 356 #   define GFX_ALLOC(Size)                                \
 357     ({                                                    \
 358         APTR Mem;                                         \
 359                                                           \
 360         ObtainSemaphore(&PrivGBase(GfxBase)->regionsem);  \
 361                                                           \
 362         Mem = AllocPooled                                 \
 363         (                                                 \
 364             PrivGBase(GfxBase)->regionpool,               \
 365             Size                                          \
 366         );                                                \
 367                                                           \
 368         ReleaseSemaphore(&PrivGBase(GfxBase)->regionsem); \
 369                                                           \
 370         Mem;                                              \
 371     })
 372
 373 #    define GFX_FREE(Mem, Size)                           \
 374      {                                                    \
 375         APTR Mem;                                         \
 376                                                           \
 377         ObtainSemaphore(&PrivGBase(GfxBase)->regionsem);  \
 378                                                           \
 379         FreePooled                                        \
 380         (                                                 \
 381             PrivGBase(GfxBase)->regionpool,               \
 382             Mem,                                          \
 383             size                                          \
 384         );                                                \
 385                                                           \
 386         ReleaseSemaphore(&PrivGBase(GfxBase)->regionsem); \
 387      }
 388 #else
 389 #    define GFX_ALLOC(Size)     AllocMem(Size, MEMF_ANY)
 390 #    define GFX_FREE(Mem, Size) FreeMem(Mem, Size)
 391 #endif
 392
 393 #define _NewRegionRectangleExtChunk() \
 394     __NewRegionRectangleExtChunk(GfxBase)
 395
 396 #define _DisposeRegionRectangleExtChunk(_chunk) \
 397     __DisposeRegionRectangleExtChunk(_chunk, GfxBase)
 398
 399 #define SIZECHUNKBUF 20
 400
 401 struct ChunkExt
 402 {
 403     struct RegionRectangleExtChunk  Chunk;
 404     struct ChunkPool               *Owner;
 405 };
 406
 407 struct ChunkPool
 408 {
 409     struct MinNode  Node;
 410     struct ChunkExt Chunks[SIZECHUNKBUF];
 411     struct MinList  ChunkList;
 412     LONG            NumChunkFree;
 413 };
 414
 415 void __DisposeRegionRectangleExtChunk
 416 (
 417     struct RegionRectangleExtChunk *Chunk,
 418     struct GfxBase *GfxBase
 419 );
 420
 421 #endif /* GRAPHICS_INTERN_H */