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