src/lib/16_tdef.h

   1 /* Project 16 Source Code~\r
   2  * Copyright (C) 2012-2017 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 *data;             //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         byte    imgname[8];             //image file of tileset\r
  78 } tiles_t;\r
  79 \r
  80 //TODO: 16_mm and 16_ca must handle this\r
  81 //TODO: add variables from 16_ca\r
  82 #define MAPLAYERS 2\r
  83 typedef struct {\r
  84         //long          planestart[3];\r
  85         //unsigned      planelength[3];\r
  86         byte *data;                     //TODO: 16_mm and 16_ca must handle this\r
  87         byte * far *layerdata;  //TODO: 16_mm and 16_ca must handle this\r
  88         //tiles_t *tiles;               //TODO: 16_mm and 16_ca must handle this\r
  89         tiles_t far *layertile[MAPLAYERS];      //TODO: 16_mm and 16_ca must handle this\r
  90         int width, height;              //this has to be signed!\r
  91         byte name[16];\r
  92 } map_t;\r
  93 \r
  94 typedef struct{\r
  95         word tw;                /* screen width in tiles */\r
  96         word th;                /* screen height in tiles */\r
  97         word tilesw;            /* virtual screen width in tiles */\r
  98         word tilesh;            /* virtual screen height in tiles */\r
  99         sword tilemidposscreenx;        /* middle tile x position */    /* needed for scroll system to work accordingly */\r
 100         sword tilemidposscreeny;        /* middle tile y position */    /* needed for scroll system to work accordingly */\r
 101         sword tileplayerposscreenx;     /* player position on screen */ /* needed for scroll and map system to work accordingly */\r
 102         sword tileplayerposscreeny;     /* player position on screen */ /* needed for scroll and map system to work accordingly */\r
 103 } tileinfo_t;\r
 104 \r
 105 typedef struct {\r
 106         nibble/*word*/ id;      /* the Identification number of the page~ For layering~ */\r
 107         byte far* data; /* the data for the page */\r
 108         tileinfo_t      ti;\r
 109         word dx;                /* col we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the left size */\r
 110         word dy;                /* row we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the top size */\r
 111         word sw;                /* screen width */      /* resolution */\r
 112         word sh;                /* screen heigth */     /* resolution */\r
 113         word width;             /* virtual width of the page */\r
 114         word height;    /* virtual height of the page */\r
 115         word stridew;                   /* width/4 */   /* VGA */\r
 116         word pagesize;                  /* page size */\r
 117         word pi;                                /* increment page by this much to preserve location */\r
 118         int tlx,tly;\r
 119 //newer vars\r
 120 //TODO: find where they are used\r
 121         sword delta;                    // How much should we shift the page for smooth scrolling\r
 122 } page_t;\r
 123 \r
 124 //from 16_sprit.h\r
 125 #ifdef  __WATCOMC__\r
 126 typedef struct sprite\r
 127 {\r
 128         // VRS container from which we will extract animation and image data\r
 129         struct vrs_container *spritesheet;\r
 130         // Container for a vrl sprite\r
 131         struct vrl_container *sprite_vrl_cont;\r
 132         // Current sprite id\r
 133         int curr_spri_id;\r
 134         // Index of a current sprite in an animation sequence\r
 135         int curr_anim_spri;\r
 136         // Current animation sequence\r
 137         struct vrs_animation_list_entry_t *curr_anim_list;\r
 138         // Index of current animation in relevant VRS offsets table\r
 139         int curr_anim;\r
 140         // Delay in time units untill we should change sprite\r
 141         int delay;\r
 142         // Position of sprite on screen\r
 143         int x, y;\r
 144 } sprite_t;\r
 145 #endif\r
 146 \r
 147 //newer structs\r
 148 typedef struct\r
 149 {\r
 150         int x; //entity exact position on the viewable map\r
 151         int y; //entity exact position on the viewable map\r
 152         int tx; //entity tile position on the viewable map\r
 153         int ty; //entity tile position on the viewable map\r
 154         int triggerx; //entity's trigger box tile position on the viewable map\r
 155         int triggery; //entity's trigger box tile position on the viewable map\r
 156 //      int sheetsetx; //NOT USED YET! entity sprite sheet set on the image x\r
 157 //      int sheetsety; //NOT USED YET! entity sprite sheet set on the image y\r
 158         nibble d;               //direction to render sprite!! wwww\r
 159         nibble pred;    //prev. direction for animation changing\r
 160         word dire;              //sprite in use\r
 161         nibble q;               //loop variable for anumation and locking the playing to compleate the animation cycle to prevent issues with misalignment www\r
 162         word speed;             //entity speed!\r
 163         word spt;               //speed per tile\r
 164 #ifdef  __WATCOMC__\r
 165         sprite_t *spri; // sprite used by entity\r
 166 #endif\r
 167         sword hp; //hitpoints of the entity\r
 168         nibble overdraww, overdrawh;    // how many pixels to "overdraw" so that moving sprites with edge pixels don't leave streaks.\r
 169                                                 // if the sprite's edge pixels are clear anyway, you can set this to 0.\r
 170         nibble /*int*/ persist_aniframe;    // gonna be increased to 1 before being used, so 0 is ok for default\r
 171 } entity_t;\r
 172 \r
 173 //from 16_in\r
 174 //==========================================================================\r
 175 typedef byte            ScanCode;\r
 176 \r
 177 typedef enum            {\r
 178                                                 //ctrl_None,                            // MDM (GAMERS EDGE) - added\r
 179                                                 ctrl_Keyboard,\r
 180                                                         ctrl_Keyboard1 = ctrl_Keyboard,ctrl_Keyboard2,\r
 181                                                 ctrl_Joystick,\r
 182                                                         ctrl_Joystick1 = ctrl_Joystick,ctrl_Joystick2,\r
 183                                                 ctrl_Mouse,\r
 184                                         } ControlType;\r
 185 typedef enum            {\r
 186                                                 motion_Left = -1,motion_Up = -1,\r
 187                                                 motion_None = 0,\r
 188                                                 motion_Right = 1,motion_Down = 1\r
 189                                         } Motion;\r
 190 typedef enum            {\r
 191                                                 dir_North,//dir_NorthEast,\r
 192                                                 dir_West,//dir_Nortinest,\r
 193                                                 dir_None,\r
 194                                                 dir_East,//,dir_SouthEast,\r
 195                                                 dir_South,//dir_Soutinest,\r
 196                                         } Direction;\r
 197 typedef struct          {\r
 198                                                 boolean near    button0,button1,button2,button3;\r
 199                                                 int     near            x,y;\r
 200                                                 Motion  near    xaxis,yaxis;\r
 201                                                 Direction near  dir;\r
 202                                         } CursorInfo;\r
 203 \r
 204 typedef struct          {\r
 205                                                 ScanCode near   button0,button1,\r
 206                                                                         //upleft,\r
 207                                                                         up,\r
 208                                                                         down,\r
 209                                                                         left,\r
 210                                                                         right\r
 211                                                                         //upright,\r
 212                                                                         //downleft,\r
 213                                                                         //,downright\r
 214                                                                         ;\r
 215                                         } KeyboardDef;\r
 216 typedef struct          {\r
 217                                                 word    near    joyMinX,joyMinY,\r
 218                                                                         threshMinX,threshMinY,\r
 219                                                                         threshMaxX,threshMaxY,\r
 220                                                                         joyMaxX,joyMaxY,\r
 221                                                                         joyMultXL,joyMultYL,\r
 222                                                                         joyMultXH,joyMultYH;\r
 223                                         } JoystickDef;\r
 224 \r
 225 //==========================================================================\r
 226 \r
 227 typedef struct\r
 228 {\r
 229         entity_t near   enti;\r
 230 #ifdef  __WATCOMC__\r
 231         //struct sprite *spri;  //supposively the sprite sheet data\r
 232         memptr          gr;\r
 233 #endif\r
 234         bitmap_t        *data;          //supposively the sprite sheet data//old format\r
 235         bitmap_t        bmp;\r
 236 \r
 237         //input\r
 238         byte near               pdir;   //previous direction~ used in IN_16 in IN_ReadControl()\r
 239         CursorInfo              info;\r
 240         ControlType     Controls;\r
 241         word walktype;\r
 242 //newer vars\r
 243         int dx, dy, delta;      //TODO: what is this? ^^\r
 244 } player_t;\r
 245 \r
 246 //===========================================//\r
 247 \r
 248 typedef struct\r
 249 {\r
 250         int profilehandle,debughandle,showmemhandle;\r
 251         int heaphandle;\r
 252 } loghandle_t;\r
 253 \r
 254 typedef struct\r
 255 {\r
 256         word frames_per_second;\r
 257         clock_t t;\r
 258         dword tiku;             //frames passed\r
 259         word clock_start;       //timer start\r
 260         word *clock;    //current time on clock\r
 261         boolean fpscap; //cap the fps var\r
 262 } kurokku_t;\r
 263 \r
 264 //video\r
 265 typedef struct\r
 266 {\r
 267         unsigned int offscreen_ofs;\r
 268         unsigned int pattern_ofs;\r
 269 } ofs_t;\r
 270 #define NUMCHUNKS       416     //keen\r
 271 \r
 272 typedef struct\r
 273 {\r
 274         char old_mode;          //old video mode before game!\r
 275         byte palette[768];              //palette array\r
 276         page_t page[MAXPAGE];   //can be used as a pointer to root page[0]\r
 277         word vmem_remain;       //remaining video memory\r
 278         byte num_of_pages;      //number of actual pages\r
 279         //doslib origi vars\r
 280         byte far * omemptr;\r
 281         byte vga_draw_stride;\r
 282         byte vga_draw_stride_limit;             // further X clipping\r
 283         //end of doslib origi vars\r
 284         boolean __near rss;             //render sprite switch\r
 285         boolean __near bgps;            //bg preservation render switch between old and new\r
 286         sword __near sprifilei;         //player file's i\r
 287         nibble __near p;                        //render page number\r
 288         nibble __near sp;                       //show page number(for showpage)\r
 289         boolean __near dorender;        //page flip, showpage, or render        if true\r
 290         word pr[MAXPAGE][4];    //render sections of pages (this is supposed to be set up to draw sections of the screen if updated)\r
 291 \r
 292         nibble sfip;            //shinku_fps_indicator_page; // we're on page 1 now, shinku(). follow along please or it will not be visible.\r
 293         ofs_t   ofs;            //offset vars used for doslib\r
 294         word    vh;             //video combined height\r
 295         //0000word startclk; float clk, tickclk;        //timer\r
 296 //newer vars\r
 297 //TODO: find out how they are used\r
 298         byte grneeded[NUMCHUNKS];\r
 299 } video_t;\r
 300 \r
 301 //from scroll16\r
 302 //==========================================================================\r
 303 typedef struct\r
 304 {\r
 305         map_t *map;\r
 306         page_t *page;\r
 307         int tx,ty; //appears to be the top left tile position on the viewable screen map\r
 308         word dxThresh,dyThresh; //Threshold for physical tile switch\r
 309         video_t *video; //pointer to game variables of the video\r
 310         nibble __near *p;       // pointer to video's render page num\r
 311         nibble __near *sp;      // pointer to video's show page num\r
 312         int dx, dy;     // draw row and col var\r
 313 //newer vars!\r
 314         int delta, d;\r
 315 } map_view_t;\r
 316 /* Map is presumed to:\r
 317  * 1. Have all the required layers and tilesets within itself\r
 318  * 2. Have a 'fence' around accessible blocks to simplify boundary logic\r
 319  * 3. Have a persistent map and tile size among the layers\r
 320  * Map view is presumed to:\r
 321  * 1. Calculate, store and update a panning info, which includes, but not limited to:\r
 322  *      combined layer information, actual map representation (reflecting real state of the game),\r
 323  *      pixel shift for smooth tile scrolling.\r
 324  * 2. Provide ways to draw a visible part of map. For simplicity with smooth scrolling,\r
 325  *      additional row/column is always drawn at the each side of the map. This implies that 'fence'\r
 326  *      should have a sprite too. Map is drawn left-to-right, top-to-bottom.\r
 327  */\r
 328 \r
 329 //==========================================================================\r
 330 \r
 331 //from 16_mm\r
 332 //==========================================================================\r
 333 \r
 334 #define MAXBLOCKS               1024\r
 335 #define MAXUMBS         12\r
 336 \r
 337 typedef struct mmblockstruct\r
 338 {\r
 339         word    start,length;\r
 340         //word  start;  dword length;\r
 341         word    blob;   //for data larger than 64k\r
 342         unsigned        attributes;\r
 343         memptr          *useptr;        // pointer to the segment start\r
 344         struct mmblockstruct far *next;\r
 345 } mmblocktype;\r
 346 \r
 347 typedef struct\r
 348 {\r
 349         dword   nearheap,farheap,EMSmem,XMSmem,mainmem;\r
 350 //      boolean         PMStarted, MainPresent, EMSPresent, XMSPresent;\r
 351 } mminfotype;\r
 352 \r
 353 typedef struct\r
 354 {\r
 355         memptr bufferseg;\r
 356         boolean         mmstarted, bombonerror, mmerror;\r
 357         void far        *farheap;\r
 358 #ifdef __BORLANDC__\r
 359         void    *nearheap;\r
 360 #endif\r
 361 #ifdef __WATCOMC__\r
 362         void __near     *nearheap;\r
 363 #endif\r
 364         unsigned int            EMSVer;\r
 365         word numUMBs,UMBbase[MAXUMBS];\r
 366         word                    totalEMSpages, freeEMSpages, EMSpagesmapped, EMSHandle, EMSPageFrame;\r
 367         //dword numUMBs,UMBbase[MAXUMBS];\r
 368         mmblocktype     far mmblocks[MAXBLOCKS],far *mmhead,far *mmfree,far *mmrover,far *mmnew;\r
 369 } mminfo_t;\r
 370 \r
 371 //==========================================================================\r
 372 \r
 373 \r
 374 //from 16_pm\r
 375 //==========================================================================\r
 376 \r
 377 //      NOTE! PMPageSize must be an even divisor of EMSPageSize, and >= 1024\r
 378 #define EMSPageSize             16384\r
 379 #define EMSPageSizeSeg  (EMSPageSize >> 4)\r
 380 #define EMSPageSizeKB   (EMSPageSize >> 10)\r
 381 #define EMSFrameCount   4\r
 382 #define PMPageSize              4096\r
 383 #define PMPageSizeSeg   (PMPageSize >> 4)\r
 384 #define PMPageSizeKB    (PMPageSize >> 10)\r
 385 #define PMEMSSubPage    (EMSPageSize / PMPageSize)\r
 386 \r
 387 #define PMMinMainMem    10                      // Min acceptable # of pages from main\r
 388 #define PMMaxMainMem    100                     // Max number of pages in main memory\r
 389 \r
 390 #define PMThrashThreshold       1       // Number of page thrashes before panic mode\r
 391 #define PMUnThrashThreshold     5       // Number of non-thrashing frames before leaving panic mode\r
 392 \r
 393 typedef enum\r
 394                 {\r
 395                         pml_Unlocked,\r
 396                         pml_Locked\r
 397                 } PMLockType;\r
 398 \r
 399 typedef enum\r
 400                 {\r
 401                         pmba_Unused = 0,\r
 402                         pmba_Used = 1,\r
 403                         pmba_Allocated = 2\r
 404                 } PMBlockAttr;\r
 405 \r
 406 typedef struct\r
 407                 {\r
 408                         dword   offset;         // Offset of chunk into file\r
 409                         word            length;         // Length of the chunk\r
 410 \r
 411                         int                     xmsPage;        // If in XMS, (xmsPage * PMPageSize) gives offset into XMS handle\r
 412 \r
 413                         PMLockType      locked;         // If set, this page can't be purged\r
 414                         int                     emsPage;        // If in EMS, logical page/offset into page\r
 415                         int                     mainPage;       // If in Main, index into handle array\r
 416 \r
 417                         dword   lastHit;        // Last frame number of hit\r
 418                 } PageListStruct;\r
 419 \r
 420 typedef struct\r
 421                 {\r
 422                         int                     baseEMSPage;    // Base EMS page for this phys frame\r
 423                         dword   lastHit;                // Last frame number of hit\r
 424                 } EMSListStruct;\r
 425 \r
 426 //      Main Mem specific variables\r
 427 typedef struct\r
 428 {\r
 429         boolean                 MainPresent;\r
 430         memptr                  MainMemPages[PMMaxMainMem];\r
 431         PMBlockAttr             MainMemUsed[PMMaxMainMem];\r
 432         int                             MainPagesAvail;\r
 433 } pm_mmi_t;\r
 434 \r
 435 //      EMS specific variables\r
 436 typedef struct\r
 437 {\r
 438         boolean                 EMSPresent;\r
 439         unsigned int                    EMSVer;\r
 440         word                    EMSAvail,EMSPagesAvail,EMSHandle,\r
 441                                         EMSPageFrame,EMSPhysicalPage;\r
 442         word                    totalEMSpages, freeEMSpages, EMSpagesmapped;\r
 443         EMSListStruct   EMSList[EMSFrameCount];\r
 444 } pm_emmi_t;\r
 445 \r
 446 //      XMS specific variables\r
 447 typedef struct\r
 448 {\r
 449         boolean                 XMSPresent;\r
 450         word                    XMSAvail,XMSPagesAvail,XMSHandle;//,XMSVer;\r
 451         dword                   XMSDriver;\r
 452         int                             XMSProtectPage;// = -1;\r
 453 } pm_xmmi_t;\r
 454 \r
 455 //      File specific variables\r
 456 typedef struct\r
 457 {\r
 458         char                    PageFileName[13];// = {"VSWAP."};\r
 459         int                             PageFile;// = -1;\r
 460         word                    ChunksInFile;\r
 461         word                    PMSpriteStart,PMSoundStart;\r
 462 } pm_fi_t;\r
 463 \r
 464 //      General usage variables\r
 465 typedef struct\r
 466 {\r
 467         boolean                 PMStarted,\r
 468                                         PMPanicMode,\r
 469                                         PMThrashing;\r
 470         word                    XMSPagesUsed,\r
 471                                         EMSPagesUsed,\r
 472                                         MainPagesUsed,\r
 473                                         PMNumBlocks;\r
 474         long                    PMFrameCount;\r
 475         PageListStruct  far *PMPages;\r
 476         __SEGA *PMSegPages;\r
 477         pm_mmi_t        mm;\r
 478         pm_emmi_t       emm;\r
 479         pm_xmmi_t       xmm;\r
 480         pm_fi_t fi;\r
 481 } pm_t;\r
 482 \r
 483 //==========================================================================\r
 484 \r
 485 //from 16_ca\r
 486 //==========================================================================\r
 487 \r
 488 #define NUMMAPS         4//39\r
 489 #define MAPPLANES               3\r
 490 \r
 491 typedef struct\r
 492 {\r
 493   word bit0,bit1;       // 0-255 is a character, > is a pointer to a node\r
 494 } huffnode;\r
 495 \r
 496 typedef struct\r
 497 {\r
 498         int             mapon, mapnum;\r
 499         //__SEGA        *mapsegs[4];\r
 500         //__SEGA        *mapheaderseg[NUMMAPS];\r
 501         //__SEGA        *tinf;\r
 502         memptr  mapsegs;\r
 503 } ca_mapinfo_t;\r
 504 \r
 505 typedef struct\r
 506 {\r
 507         int                     maphandle[4];           // handle to MAPTEMP / GAMEMAPS\r
 508 } ca_handle_t;\r
 509 \r
 510 typedef struct\r
 511 {\r
 512         byte            ca_levelbit,ca_levelnum;\r
 513         ca_handle_t     file;           //files to open\r
 514         ca_mapinfo_t    camap;\r
 515         __SEGA  *grsegs[NUMCHUNKS];\r
 516         byte            far     grneeded[NUMCHUNKS];\r
 517         huffnode huffnode;\r
 518 \r
 519         //TODO: extend! and learn from keen/wolf/catacomb's code wwww\r
 520         memptr  spribuff;\r
 521 } ca_t;\r
 522 \r
 523 //==========================================================================\r
 524 \r
 525 //actual global game varables!\r
 526 typedef enum {\r
 527         ENGI_EXIT,\r
 528         ENGI_QUIT,\r
 529         ENGI_RUN,\r
 530         ENGI_INPUT,\r
 531         ENGI_PAUSE\r
 532 } engi_stat_t;\r
 533 \r
 534 typedef struct\r
 535 {\r
 536         video_t video;  // video settings variable\r
 537         ca_t            ca;     // ca stuff\r
 538         pm_t            pm;     // pm stuff\r
 539         loghandle_t handle;     //handles for file logging\r
 540         kurokku_t kurokku;      //clock struct\r
 541         mminfo_t mm; mminfotype mmi;\r
 542 } global_game_variables_t;\r
 543 \r
 544 #ifdef __WATCOMC__\r
 545 extern char global_temp_status_text[512];\r
 546 extern char global_temp_status_text2[512];\r
 547 #define EINVFMT EMFILE\r
 548 #endif\r
 549 #endif /* _TYPEDEFSTRUCT_H_ */\r