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