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