src/lib/16_tdef.h

   1 /* Project 16 Source Code~\r
   2  * Copyright (C) 2012-2016 sparky4 & pngwen & andrius4669 & joncampbell123 & yakui-lover\r
   3  *\r
   4  * This file is part of Project 16.\r
   5  *\r
   6  * Project 16 is free software; you can redistribute it and/or modify\r
   7  * it under the terms of the GNU General Public License as published by\r
   8  * the Free Software Foundation; either version 3 of the License, or\r
   9  * (at your option) any later version.\r
  10  *\r
  11  * Project 16 is distributed in the hope that it will be useful,\r
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14  * GNU General Public License for more details.\r
  15  *\r
  16  * You should have received a copy of the GNU General Public License\r
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>, or\r
  18  * write to the Free Software Foundation, Inc., 51 Franklin Street,\r
  19  * Fifth Floor, Boston, MA 02110-1301 USA.\r
  20  *\r
  21  */\r
  22 \r
  23 #ifndef _TYPEDEFSTRUCT_H_\r
  24 #define _TYPEDEFSTRUCT_H_\r
  25 \r
  26 #include "src/lib/16_t.h"\r
  27 \r
  28 #define AARED           "\x1b[41;31m"\r
  29 #define AABLUE          "\x1b[44;34m"\r
  30 #define AAGREEN "\x1b[42;32m"\r
  31 #define AAYELLOW        "\x1b[43;33m"\r
  32 #define AAGREY          "\x1b[47;37m"\r
  33 #define AABLACK "\x1b[40;30m"\r
  34 #define AAWHITE         "\x1b[47;37m"\r
  35 #define AAMAGENTA       "\x1b[45;35m"\r
  36 #define AARESET "\x1b[0m"\r
  37 \r
  38 #define MAXPAGE 4\r
  39 \r
  40 /*\r
  41  * typedefs of the game variables!\r
  42  */\r
  43 typedef struct {\r
  44         byte *data;\r
  45         word width;\r
  46         word height;\r
  47         byte *palette;\r
  48         word offset;\r
  49 } bitmap_t;\r
  50 \r
  51 typedef struct {\r
  52         byte far **data;\r
  53         word ntiles;   /* the number of tiles */\r
  54         word twidth;   /* width of the tiles */\r
  55         word theight;  /* height of the tiles */\r
  56         byte *palette; /* palette for the tile set */\r
  57 } tileset_t;\r
  58 \r
  59 typedef struct {\r
  60         byte far *plane[4];     // 4 planes of image data\r
  61         word width;                     // width of the image (spread across 4 planes)\r
  62         word height;            // height of the image (spread across 4 planes)\r
  63         word pwidth;            // the number of bytes in each plane\r
  64         byte *palette;\r
  65 } planar_buf_t;\r
  66 \r
  67 //TODO: 16_mm and 16_ca must handle this\r
  68 typedef struct {\r
  69         bitmap_t far *btdata;           //old\r
  70         planar_buf_t far *data; //old\r
  71         word tileHeight, tileWidth;\r
  72         unsigned int rows, cols;\r
  73 //      #ifdef __DEBUG__\r
  74 //      boolean debug_text;     //show the value of the tile! wwww\r
  75 //      byte *debug_data;\r
  76 //      #endif\r
  77 } tiles_t;\r
  78 \r
  79 //TODO: 16_mm and 16_ca must handle this\r
  80 //TODO: add variables from 16_ca\r
  81 typedef struct {\r
  82         //long          planestart[3];\r
  83         //unsigned      planelength[3];\r
  84         byte *data;                     //TODO: 16_mm and 16_ca must handle this\r
  85         byte * far *layerdata;  //TODO: 16_mm and 16_ca must handle this\r
  86         tiles_t *tiles;         //TODO: 16_mm and 16_ca must handle this\r
  87         tiles_t * far *layertile;       //TODO: 16_mm and 16_ca must handle this\r
  88         int width, height;              //this has to be signed!\r
  89         char            name[16];\r
  90 } map_t;\r
  91 \r
  92 //TODO USE THIS tile info\r
  93 typedef struct{\r
  94         word tw;                /* screen width in tiles */\r
  95         word th;                /* screen height in tiles */\r
  96         word tilesw;            /* virtual screen width in tiles */\r
  97         word tilesh;            /* virtual screen height in tiles */\r
  98         sword tilemidposscreenx;        /* middle tile x position */    /* needed for scroll system to work accordingly */\r
  99         sword tilemidposscreeny;        /* middle tile y position */    /* needed for scroll system to work accordingly */\r
 100         sword tileplayerposscreenx;     /* player position on screen */ /* needed for scroll and map system to work accordingly */\r
 101         sword tileplayerposscreeny;     /* player position on screen */ /* needed for scroll and map system to work accordingly */\r
 102 } ti_t;\r
 103 \r
 104 typedef struct {\r
 105         nibble/*word*/ id;      /* the Identification number of the page~ For layering~ */\r
 106         byte far* data; /* the data for the page */\r
 107         word dx;                /* col we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the left size */\r
 108         word dy;                /* row we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the top size */\r
 109         word sw;                /* screen width */      /* resolution */\r
 110         word sh;                /* screen heigth */     /* resolution */\r
 111                 word tw;                /* screen width in tiles */\r
 112                 word th;                /* screen height in tiles */\r
 113         word width;             /* virtual width of the page */\r
 114         word height;    /* virtual height of the page */\r
 115                 word tilesw;            /* virtual screen width in tiles */\r
 116                 word tilesh;            /* virtual screen height in tiles */\r
 117                 sword tilemidposscreenx;        /* middle tile x position */    /* needed for scroll system to work accordingly */\r
 118                 sword tilemidposscreeny;        /* middle tile y position */    /* needed for scroll system to work accordingly */\r
 119                 sword tileplayerposscreenx;     /* player position on screen */ /* needed for scroll and map system to work accordingly */\r
 120                 sword tileplayerposscreeny;     /* player position on screen */ /* needed for scroll and map system to work accordingly */\r
 121         word stridew;                   /* width/4 */   /* VGA */\r
 122         word pagesize;                  /* page size */\r
 123         word pi;                                /* increment page by this much to preserve location */\r
 124 //newer vars\r
 125 //TODO: find where they are used\r
 126         sword delta;                    // How much should we shift the page for smooth scrolling\r
 127 } page_t;\r
 128 \r
 129 //new structs\r
 130 typedef struct\r
 131 {\r
 132         int x; //entity exact position on the viewable map\r
 133         int y; //entity exact position on the viewable map\r
 134         int tx; //entity tile position on the viewable map\r
 135         int ty; //entity tile position on the viewable map\r
 136         int triggerx; //entity's trigger box tile position on the viewable map\r
 137         int triggery; //entity's trigger box tile position on the viewable map\r
 138         int sheetsetx; //NOT USED YET! entity sprite sheet set on the image x\r
 139         int sheetsety; //NOT USED YET! entity sprite sheet set on the image y\r
 140         nibble d;               //direction to render sprite!! wwww\r
 141         nibble pred;    //prev. direction for animation changing\r
 142         word dire;              //sprite in use\r
 143         nibble q;               //loop variable for anumation and locking the playing to compleate the animation cycle to prevent issues with misalignment www\r
 144         word speed;             //entity speed!\r
 145         word spt;               //speed per tile\r
 146         struct sprite *spri; // sprite used by entity\r
 147         sword hp; //hitpoints of the entity\r
 148         nibble overdraww, overdrawh;    // how many pixels to "overdraw" so that moving sprites with edge pixels don't leave streaks.\r
 149                                                 // if the sprite's edge pixels are clear anyway, you can set this to 0.\r
 150         nibble /*int*/ persist_aniframe;    // gonna be increased to 1 before being used, so 0 is ok for default\r
 151 } entity_t;\r
 152 \r
 153 //TODO: MAKE THIS WWWW\r
 154 typedef struct\r
 155 {\r
 156         //sprite ....\r
 157         boolean wwww;\r
 158 } spri_t;\r
 159 \r
 160 //TODO: MAKE THIS TO WWWW\r
 161 typedef struct\r
 162 {\r
 163         //vrs with sprite ....\r
 164         spri_t *spri;\r
 165 } vrs_t;\r
 166 \r
 167 //from 16_in\r
 168 //==========================================================================\r
 169 typedef byte            ScanCode;\r
 170 \r
 171 typedef enum            {\r
 172                                                 //ctrl_None,                            // MDM (GAMERS EDGE) - added\r
 173                                                 ctrl_Keyboard,\r
 174                                                         ctrl_Keyboard1 = ctrl_Keyboard,ctrl_Keyboard2,\r
 175                                                 ctrl_Joystick,\r
 176                                                         ctrl_Joystick1 = ctrl_Joystick,ctrl_Joystick2,\r
 177                                                 ctrl_Mouse,\r
 178                                         } ControlType;\r
 179 typedef enum            {\r
 180                                                 motion_Left = -1,motion_Up = -1,\r
 181                                                 motion_None = 0,\r
 182                                                 motion_Right = 1,motion_Down = 1\r
 183                                         } Motion;\r
 184 typedef enum            {\r
 185                                                 dir_North,//dir_NorthEast,\r
 186                                                 dir_West,//dir_Nortinest,\r
 187                                                 dir_None,\r
 188                                                 dir_East,//,dir_SouthEast,\r
 189                                                 dir_South,//dir_Soutinest,\r
 190                                         } Direction;\r
 191 typedef struct          {\r
 192                                                 boolean near    button0,button1,button2,button3;\r
 193                                                 int     near            x,y;\r
 194                                                 Motion  near    xaxis,yaxis;\r
 195                                                 Direction near  dir;\r
 196                                         } CursorInfo;\r
 197 \r
 198 typedef struct          {\r
 199                                                 ScanCode near   button0,button1,\r
 200                                                                         //upleft,\r
 201                                                                         up,\r
 202                                                                         down,\r
 203                                                                         left,\r
 204                                                                         right\r
 205                                                                         //upright,\r
 206                                                                         //downleft,\r
 207                                                                         //,downright\r
 208                                                                         ;\r
 209                                         } KeyboardDef;\r
 210 typedef struct          {\r
 211                                                 word    near    joyMinX,joyMinY,\r
 212                                                                         threshMinX,threshMinY,\r
 213                                                                         threshMaxX,threshMaxY,\r
 214                                                                         joyMaxX,joyMaxY,\r
 215                                                                         joyMultXL,joyMultYL,\r
 216                                                                         joyMultXH,joyMultYH;\r
 217                                         } JoystickDef;\r
 218 \r
 219 //==========================================================================\r
 220 \r
 221 typedef struct\r
 222 {\r
 223         entity_t near   enti;\r
 224 #ifdef  __WATCOMC__\r
 225         //struct sprite *spri;  //supposively the sprite sheet data\r
 226         memptr          gr;\r
 227 #endif\r
 228         bitmap_t        *data;          //supposively the sprite sheet data//old format\r
 229         bitmap_t        bmp;\r
 230 \r
 231         //input\r
 232         byte near               pdir;   //previous direction~ used in IN_16 in IN_ReadControl()\r
 233         CursorInfo              info;\r
 234         ControlType     Controls;\r
 235         word walktype;\r
 236 //newer vars\r
 237         int dx, dy, delta;      //TODO: what is this? ^^\r
 238 } player_t;\r
 239 \r
 240 //===========================================//\r
 241 \r
 242 typedef struct\r
 243 {\r
 244         int profilehandle,debughandle,showmemhandle;\r
 245         int heaphandle;\r
 246 } loghandle_t;\r
 247 \r
 248 typedef struct\r
 249 {\r
 250         word frames_per_second;\r
 251         clock_t t;\r
 252         dword tiku;             //frames passed\r
 253         word clock_start;       //timer start\r
 254         word *clock;    //current time on clock\r
 255         boolean fpscap; //cap the fps var\r
 256 } kurokku_t;\r
 257 \r
 258 //video\r
 259 #define NUMCHUNKS       416     //keen\r
 260 \r
 261 typedef struct\r
 262 {\r
 263         char old_mode;          //old video mode before game!\r
 264         byte palette[768];              //palette array\r
 265         page_t page[MAXPAGE];   //can be used as a pointer to root page[0]\r
 266         word vmem_remain;       //remaining video memory\r
 267         byte num_of_pages;      //number of actual pages\r
 268         //doslib origi vars\r
 269         byte far * omemptr;\r
 270         byte vga_draw_stride;\r
 271         byte vga_draw_stride_limit;             // further X clipping\r
 272         //end of doslib origi vars\r
 273         boolean __near rss;                     //render sprite switch\r
 274         sword __near sprifilei;         //player file's i\r
 275         boolean __near p;                       //render page number //BLEH\r
 276         boolean __near r;                       //page flip, showpage, or render        if true\r
 277         word pr[MAXPAGE][4];    //render sections of pages (this is supposed to be set up to draw sections of the screen if updated)\r
 278 \r
 279         nibble sfip;            //shinku_fps_indicator_page; // we're on page 1 now, shinku(). follow along please or it will not be visible.\r
 280         nibble panp;            //pan_t replacement\r
 281         word    vh;             //video combined height\r
 282         //0000word startclk; float clk, tickclk;        //timer\r
 283 //newer vars\r
 284 //TODO: find out how they are used\r
 285         byte grneeded[NUMCHUNKS];\r
 286 } video_t;\r
 287 \r
 288 //from 16_mm\r
 289 //==========================================================================\r
 290 \r
 291 #define MAXBLOCKS               1024\r
 292 #define MAXUMBS         12\r
 293 \r
 294 typedef struct mmblockstruct\r
 295 {\r
 296         word    start,length;\r
 297         //word  start;  dword length;\r
 298         word    blob;   //for data larger than 64k\r
 299         unsigned        attributes;\r
 300         memptr          *useptr;        // pointer to the segment start\r
 301         struct mmblockstruct far *next;\r
 302 } mmblocktype;\r
 303 \r
 304 typedef struct\r
 305 {\r
 306         dword   nearheap,farheap,EMSmem,XMSmem,mainmem;\r
 307 //      boolean         PMStarted, MainPresent, EMSPresent, XMSPresent;\r
 308 } mminfotype;\r
 309 \r
 310 typedef struct\r
 311 {\r
 312         memptr bufferseg;\r
 313         boolean         mmstarted, bombonerror, mmerror;\r
 314         void far        *farheap;\r
 315 #ifdef __BORLANDC__\r
 316         void    *nearheap;\r
 317 #endif\r
 318 #ifdef __WATCOMC__\r
 319         void __near     *nearheap;\r
 320 #endif\r
 321         unsigned int            EMSVer;\r
 322         word numUMBs,UMBbase[MAXUMBS];\r
 323         word                    totalEMSpages, freeEMSpages, EMSpagesmapped, EMSHandle, EMSPageFrame;\r
 324         //dword numUMBs,UMBbase[MAXUMBS];\r
 325         mmblocktype     far mmblocks[MAXBLOCKS],far *mmhead,far *mmfree,far *mmrover,far *mmnew;\r
 326 } mminfo_t;\r
 327 \r
 328 //==========================================================================\r
 329 \r
 330 \r
 331 //from 16_pm\r
 332 //==========================================================================\r
 333 \r
 334 //      NOTE! PMPageSize must be an even divisor of EMSPageSize, and >= 1024\r
 335 #define EMSPageSize             16384\r
 336 #define EMSPageSizeSeg  (EMSPageSize >> 4)\r
 337 #define EMSPageSizeKB   (EMSPageSize >> 10)\r
 338 #define EMSFrameCount   4\r
 339 #define PMPageSize              4096\r
 340 #define PMPageSizeSeg   (PMPageSize >> 4)\r
 341 #define PMPageSizeKB    (PMPageSize >> 10)\r
 342 #define PMEMSSubPage    (EMSPageSize / PMPageSize)\r
 343 \r
 344 #define PMMinMainMem    10                      // Min acceptable # of pages from main\r
 345 #define PMMaxMainMem    100                     // Max number of pages in main memory\r
 346 \r
 347 #define PMThrashThreshold       1       // Number of page thrashes before panic mode\r
 348 #define PMUnThrashThreshold     5       // Number of non-thrashing frames before leaving panic mode\r
 349 \r
 350 typedef enum\r
 351                 {\r
 352                         pml_Unlocked,\r
 353                         pml_Locked\r
 354                 } PMLockType;\r
 355 \r
 356 typedef enum\r
 357                 {\r
 358                         pmba_Unused = 0,\r
 359                         pmba_Used = 1,\r
 360                         pmba_Allocated = 2\r
 361                 } PMBlockAttr;\r
 362 \r
 363 typedef struct\r
 364                 {\r
 365                         dword   offset;         // Offset of chunk into file\r
 366                         word            length;         // Length of the chunk\r
 367 \r
 368                         int                     xmsPage;        // If in XMS, (xmsPage * PMPageSize) gives offset into XMS handle\r
 369 \r
 370                         PMLockType      locked;         // If set, this page can't be purged\r
 371                         int                     emsPage;        // If in EMS, logical page/offset into page\r
 372                         int                     mainPage;       // If in Main, index into handle array\r
 373 \r
 374                         dword   lastHit;        // Last frame number of hit\r
 375                 } PageListStruct;\r
 376 \r
 377 typedef struct\r
 378                 {\r
 379                         int                     baseEMSPage;    // Base EMS page for this phys frame\r
 380                         dword   lastHit;                // Last frame number of hit\r
 381                 } EMSListStruct;\r
 382 \r
 383 //      Main Mem specific variables\r
 384 typedef struct\r
 385 {\r
 386         boolean                 MainPresent;\r
 387         memptr                  MainMemPages[PMMaxMainMem];\r
 388         PMBlockAttr             MainMemUsed[PMMaxMainMem];\r
 389         int                             MainPagesAvail;\r
 390 } pm_mmi_t;\r
 391 \r
 392 //      EMS specific variables\r
 393 typedef struct\r
 394 {\r
 395         boolean                 EMSPresent;\r
 396         unsigned int                    EMSVer;\r
 397         word                    EMSAvail,EMSPagesAvail,EMSHandle,\r
 398                                         EMSPageFrame,EMSPhysicalPage;\r
 399         word                    totalEMSpages, freeEMSpages, EMSpagesmapped;\r
 400         EMSListStruct   EMSList[EMSFrameCount];\r
 401 } pm_emmi_t;\r
 402 \r
 403 //      XMS specific variables\r
 404 typedef struct\r
 405 {\r
 406         boolean                 XMSPresent;\r
 407         word                    XMSAvail,XMSPagesAvail,XMSHandle;//,XMSVer;\r
 408         dword                   XMSDriver;\r
 409         int                             XMSProtectPage;// = -1;\r
 410 } pm_xmmi_t;\r
 411 \r
 412 //      File specific variables\r
 413 typedef struct\r
 414 {\r
 415         char                    PageFileName[13];// = {"VSWAP."};\r
 416         int                             PageFile;// = -1;\r
 417         word                    ChunksInFile;\r
 418         word                    PMSpriteStart,PMSoundStart;\r
 419 } pm_fi_t;\r
 420 \r
 421 //      General usage variables\r
 422 typedef struct\r
 423 {\r
 424         boolean                 PMStarted,\r
 425                                         PMPanicMode,\r
 426                                         PMThrashing;\r
 427         word                    XMSPagesUsed,\r
 428                                         EMSPagesUsed,\r
 429                                         MainPagesUsed,\r
 430                                         PMNumBlocks;\r
 431         long                    PMFrameCount;\r
 432         PageListStruct  far *PMPages;\r
 433         __SEGA *PMSegPages;\r
 434         pm_mmi_t        mm;\r
 435         pm_emmi_t       emm;\r
 436         pm_xmmi_t       xmm;\r
 437         pm_fi_t fi;\r
 438 } pm_t;\r
 439 \r
 440 //==========================================================================\r
 441 \r
 442 //from 16_ca\r
 443 //==========================================================================\r
 444 \r
 445 #define NUMMAPS         4//39\r
 446 #define MAPPLANES               3\r
 447 \r
 448 typedef struct\r
 449 {\r
 450   word bit0,bit1;       // 0-255 is a character, > is a pointer to a node\r
 451 } huffnode;\r
 452 \r
 453 typedef struct\r
 454 {\r
 455         int             mapon, mapnum;\r
 456         __SEGA  *mapsegs[4];\r
 457         __SEGA  *mapheaderseg[NUMMAPS];\r
 458         __SEGA  *tinf;\r
 459 } ca_mapinfo_t;\r
 460 \r
 461 typedef struct\r
 462 {\r
 463         int                     maphandle[4];           // handle to MAPTEMP / GAMEMAPS\r
 464 } ca_handle_t;\r
 465 \r
 466 typedef struct\r
 467 {\r
 468         byte            ca_levelbit,ca_levelnum;\r
 469         ca_handle_t     file;           //files to open\r
 470         ca_mapinfo_t    camap;\r
 471         __SEGA  *grsegs[NUMCHUNKS];\r
 472         byte            far     grneeded[NUMCHUNKS];\r
 473         huffnode huffnode;\r
 474 \r
 475         //TODO: extend! and learn from keen/wolf/catacomb's code wwww\r
 476         memptr  spribuff;\r
 477 } ca_t;\r
 478 \r
 479 //==========================================================================\r
 480 \r
 481 //actual global game varables!\r
 482 typedef enum {\r
 483         ENGI_EXIT,\r
 484         ENGI_QUIT,\r
 485         ENGI_RUN,\r
 486         ENGI_INPUT,\r
 487         ENGI_PAUSE\r
 488 } engi_stat_t;\r
 489 \r
 490 typedef struct\r
 491 {\r
 492         video_t video;  // video settings variable\r
 493         ca_t            ca;     // ca stuff\r
 494         pm_t            pm;     // pm stuff\r
 495         loghandle_t handle;     //handles for file logging\r
 496         kurokku_t kurokku;      //clock struct\r
 497         mminfo_t mm; mminfotype mmi;\r
 498 } global_game_variables_t;\r
 499 \r
 500 extern char global_temp_status_text[512];\r
 501 #ifdef __WATCOMC__\r
 502 #define EINVFMT EMFILE\r
 503 #endif\r
 504 #endif /* _TYPEDEFSTRUCT_H_ */\r