1 /* Project 16 Source Code~
\r
2 * Copyright (C) 2012-2017 sparky4 & pngwen & andrius4669 & joncampbell123 & yakui-lover
\r
4 * This file is part of Project 16.
\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
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
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
23 #ifndef _TYPEDEFSTRUCT_H_
\r
24 #define _TYPEDEFSTRUCT_H_
\r
26 #include "src/lib/16_t.h"
\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
40 #define BDOFSCONV (unsigned __near)
\r
41 #define BOFS page[1].data
\r
42 #define DOFS page[0].data
\r
44 #define CONFIGNAME "config.16"
\r
47 * typedefs of the game variables!
\r
50 byte far *plane[4]; // 4 planes of image data
\r
51 word width; // width of the image (spread across 4 planes)
\r
52 word height; // height of the image (spread across 4 planes)
\r
53 word pwidth; // the number of bytes in each plane
\r
59 #include <hw/vga/vrl.h>
\r
61 typedef struct vrs_container{
\r
62 // Size of a .vrs blob in memory
\r
67 struct vrs_header far *vrs_hdr;
\r
69 // Array of corresponding vrl line offsets
\r
70 vrl1_vgax_offset_t **vrl_line_offsets;
\r
72 byte far _seg *spribuff;
\r
75 typedef struct vrl_container{
\r
76 // Size of a .vrl blob in memory
\r
81 struct vrl1_vgax_header far *vrl_header;
\r
83 // Pointer to a corresponding vrl line offsets struct
\r
84 vrl1_vgax_offset_t *line_offsets;
\r
86 byte far _seg *spribuff;
\r
89 typedef struct sprite
\r
91 // VRS container from which we will extract animation and image data
\r
92 vrs_container_t spritesheet;
\r
93 // Container for a vrl sprite
\r
94 vrl_container_t sprite_vrl_cont;
\r
95 // Current sprite id
\r
97 // Index of a current sprite in an animation sequence
\r
99 // Current animation sequence
\r
100 struct vrs_animation_list_entry_t *curr_anim_list;
\r
101 // Index of current animation in relevant VRS offsets table
\r
103 // Delay in time units untill we should change sprite
\r
105 // Position of sprite on screen
\r
113 int x; //entity exact position on the viewable map
\r
114 int y; //entity exact position on the viewable map
\r
115 int tx; //entity tile position on the viewable map
\r
116 int ty; //entity tile position on the viewable map
\r
117 int triggerx; //entity's trigger box tile position on the viewable map
\r
118 int triggery; //entity's trigger box tile position on the viewable map
\r
119 // int sheetsetx; //NOT USED YET! entity sprite sheet set on the image x
\r
120 // int sheetsety; //NOT USED YET! entity sprite sheet set on the image y
\r
121 nibble d; //direction to render sprite!! wwww
\r
122 nibble pred; //prev. direction for animation changing
\r
123 word dire; //sprite in use
\r
124 nibble q; //loop variable for anumation and locking the playing to compleate the animation cycle to prevent issues with misalignment www
\r
125 // word speed; //entity speed!
\r
126 word spt; //speed per tile
\r
128 sprite_t spri; // sprite used by entity
\r
130 sword hp; //hitpoints of the entity
\r
131 nibble overdraww, overdrawh; // how many pixels to "overdraw" so that moving sprites with edge pixels don't leave streaks.
\r
132 // if the sprite's edge pixels are clear anyway, you can set this to 0.
\r
133 nibble /*int*/ persist_aniframe; // gonna be increased to 1 before being used, so 0 is ok for default
\r
138 int x; //entity exact position on the viewable map
\r
139 int y; //entity exact position on the viewable map
\r
140 int tx; //entity tile position on the viewable map
\r
141 int ty; //entity tile position on the viewable map
\r
144 sprite_t spri; // sprite used by entity
\r
146 sword hp; //hitpoints of the entity
\r
147 } static_map_entity_t;
\r
149 //===========================================================================//
\r
151 //TODO: 16_mm and 16_ca must handle this
\r
154 sprite_t *spri; // I will probibaly use this --sparky4
\r
156 word tileHeight, tileWidth; //defined by mapfile
\r
157 unsigned int rows, cols;
\r
158 byte imgname[8]; //image file of tileset (set to 8 because DOS ^^;)
\r
159 } tiles_t; //seems to be the tileset properties
\r
161 //TODO: 16_mm and 16_ca must handle this
\r
162 //TODO: add variables from 16_ca
\r
165 byte *data; //TODO: 16_mm and 16_ca must handle this
\r
166 } mapl_t; //map layer array type def
\r
168 #define MAPPLANES 3
\r
170 //long planestart[3];
\r
171 //unsigned planelength[3];
\r
172 mapl_t layerdata[MAPPLANES]; // mapdata for multilayer (map index values for rendering which image on the tile)
\r
173 tiles_t *tiles; //TODO: 16_mm and 16_ca must handle this // tilesets for layers (currently ony 4 can be loaded wwww)
\r
174 int width, height; //this has to be signed!
\r
178 //===================================//
\r
181 word tw; /* screen width in tiles */
\r
182 word th; /* screen height in tiles */
\r
183 word tilesw; /* virtual screen width in tiles */
\r
184 word tilesh; /* virtual screen height in tiles */
\r
185 sword tilemidposscreenx; /* middle tile x position */ /* needed for scroll system to work accordingly */
\r
186 sword tilemidposscreeny; /* middle tile y position */ /* needed for scroll system to work accordingly */
\r
187 sword tileplayerposscreenx; /* player position on screen */ /* needed for scroll and map system to work accordingly */
\r
188 sword tileplayerposscreeny; /* player position on screen */ /* needed for scroll and map system to work accordingly */
\r
192 nibble/*word*/ id; /* the Identification number of the page~ For layering~ */
\r
193 byte far* data; /* the data for the page */
\r
194 pagetileinfo_t ti; // the tile information of the page
\r
195 word dx; /* col we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the left size */
\r
196 word dy; /* row we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the top size */
\r
197 word sw; /* screen width */ /* resolution */
\r
198 word sh; /* screen heigth */ /* resolution */
\r
199 word width; /* virtual width of the page */
\r
200 word height; /* virtual height of the page */
\r
201 word stridew; /* width/4 */ /* VGA */
\r
202 word pagesize; /* page size */
\r
203 word pi; /* increment page by this much to preserve location */
\r
206 //TODO: find where they are used
\r
207 sword delta; // How much should we shift the page for smooth scrolling
\r
211 //==========================================================================
\r
212 #define KeyInt 9 // The keyboard ISR number
\r
221 #define MouseInt 0x33
\r
222 //#define Mouse(x) _AX = x,geninterrupt(MouseInt)
\r
225 // joystick constants
\r
227 #define JoyScaleMax 32768
\r
228 #define JoyScaleShift 8
\r
229 #define MaxJoyValue 5000
\r
231 #define MaxPlayers 4
\r
234 #define NumCodes 128
\r
236 typedef byte ScanCode;
\r
239 //ctrl_None, // MDM (GAMERS EDGE) - added
\r
241 ctrl_Keyboard1 = ctrl_Keyboard,ctrl_Keyboard2,
\r
243 ctrl_Joystick1 = ctrl_Joystick,ctrl_Joystick2,
\r
247 motion_Left = -1,motion_Up = -1,
\r
249 motion_Right = 1,motion_Down = 1
\r
251 typedef enum { // Quick lookup for total direction
\r
252 /*dir_NorthWest, */dir_North,/* dir_NorthEast,*/
\r
253 dir_West, dir_None, dir_East,
\r
254 /*dir_SouthWest, */dir_South/*, dir_SouthEast*/
\r
257 boolean near button0,button1,button2,button3;
\r
259 Motion near xaxis,yaxis;
\r
260 Direction near dir;
\r
264 ScanCode near button0,button1,
\r
276 word near joyMinX,joyMinY,
\r
277 threshMinX,threshMinY,
\r
278 threshMaxX,threshMaxY,
\r
280 joyMultXL,joyMultYL,
\r
281 joyMultXH,joyMultYH;
\r
284 typedef struct instat {
\r
286 ScanCode CurCode,LastCode;
\r
288 boolean Keyboard[NumCodes];
\r
294 typedef struct// inconfig
\r
296 boolean IN_Started;
\r
298 // configuration variables
\r
300 boolean JoysPresent[MaxJoys],
\r
304 // Global variables
\r
305 KeyboardDef KbdDefs[MaxKbds];
\r
306 JoystickDef JoyDefs[MaxJoys];
\r
310 //==========================================================================
\r
314 entity_t near enti;
\r
316 //struct sprite *spri; //supposively the sprite sheet data
\r
319 // bitmap_t *data; //supposively the sprite sheet data//old format
\r
323 byte near pdir; //previous direction~ used in IN_16 in IN_ReadControl()
\r
325 ControlType Controls;
\r
328 int dx, dy, delta; //TODO: what is this? ^^
\r
331 //===========================================//
\r
335 int profilehandle,debughandle,showmemhandle;
\r
337 byte datadumpfilename[12];
\r
338 byte heapdumpfilename[12];
\r
343 word frames_per_second;
\r
345 dword tiku; //frames passed
\r
346 word clock_start; //timer start
\r
347 word *clock; //current time on clock
\r
348 boolean fpscap; //cap the fps var
\r
349 nibble wcpu; //stored value of cpu type
\r
352 //===================================//
\r
353 #define PALSIZE 768 //vga
\r
354 #define NUMCHUNKS 416 //keen
\r
355 //#define MAXSCANLINES 240 // size of ylookup table
\r
357 #define MAXSHIFTS 4
\r
358 #define STARTSPRITES 0 //temp
\r
371 unsigned sourceoffset[MAXSHIFTS];
\r
372 unsigned planesize[MAXSHIFTS];
\r
373 unsigned width[MAXSHIFTS];
\r
375 } spritetype; // the memptr for each sprite points to this
\r
385 word tileHeight, tileWidth; //defined by mapfile
\r
386 word quadwh; //preproccessed quad size of tilewidth and tileheight
\r
387 } tile_dimention_t;
\r
389 #define MAXSCROLLEDGES 2
\r
392 unsigned panx,pany; // panning adjustments inside port in pixels
\r
393 unsigned pansx,pansy;
\r
394 unsigned panadjust; // panx/pany adjusted by screen resolution
\r
395 int hscrollblocks,vscrollblocks;
\r
396 int hscrolledge[MAXSCROLLEDGES],vscrolledge[MAXSCROLLEDGES];
\r
401 //---- ylookup[MAXSCANLINES],
\r
402 unsigned int offscreen_ofs;
\r
403 unsigned int pattern_ofs;
\r
404 //+-+- unsigned bufferofs,linewidth,displayofs;
\r
407 } ofs_t; //unfinished
\r
411 //doslib origi vars
\r
412 byte far * omemptr;
\r
413 byte vga_draw_stride;
\r
414 byte vga_draw_stride_limit; // further X clipping
\r
415 //end of doslib origi vars
\r
416 boolean __near rss; //render sprite switch
\r
417 boolean __near bgps; //bg preservation render switch between old and new
\r
422 boolean VL_Started,VL_Initiated;
\r
423 char old_mode; //old video mode before game!
\r
424 sword curr_mode; //modex curent mode
\r
425 byte palette[PALSIZE], dpal[PALSIZE]; //palette array
\r
426 page_t page[MAXPAGE]; //can be used as a pointer to root page[0]
\r
427 word vmem_remain; //remaining video memory
\r
428 byte num_of_pages; //number of actual pages
\r
429 vga_state_t vga_state;
\r
430 sword __near sprifilei; //player file's i
\r
431 nibble __near p; //render page number
\r
432 nibble __near sp; //show page number(for showpage)
\r
433 boolean __near dorender; //page flip, showpage, or render if true
\r
434 word pr[MAXPAGE][4]; //render sections of pages (this is supposed to be set up to draw sections of the screen if updated)
\r
436 nibble sfip; //shinku_fps_indicator_page; // we're on page 1 now, shinku(). follow along please or it will not be visible.
\r
437 ofs_t ofs; //offset vars used for doslib
\r
438 word vh; //video combined height
\r
439 tile_dimention_t td;
\r
440 //0000word startclk; float clk, tickclk; //timer
\r
442 boolean screenfaded;
\r
444 boolean fastpalette;
\r
445 byte far palette1[256][3],far palette2[256][3];
\r
446 //???? pictabletype _seg *pictable;
\r
448 // spritetabletype _seg *spritetable;
\r
449 // unsigned *shifttabletable[8];
\r
453 //==========================================================================
\r
458 int tx,ty; //appears to be the top left tile position on the viewable screen map
\r
459 word dxThresh,dyThresh; //Threshold for physical tile switch
\r
460 video_t *video; //pointer to game variables of the video
\r
461 kurokku_t *kurokku; //pointer to game variables of the kurokku
\r
462 nibble __near *p; // pointer to video's render page num
\r
463 nibble __near *sp; // pointer to video's show page num
\r
464 int dx, dy; // draw row and col var
\r
468 /* Map is presumed to:
\r
469 * 1. Have all the required layers and tilesets within itself
\r
470 * 2. Have a 'fence' around accessible blocks to simplify boundary logic
\r
471 * 3. Have a persistent map and tile size among the layers
\r
472 * Map view is presumed to:
\r
473 * 1. Calculate, store and update a panning info, which includes, but not limited to:
\r
474 * combined layer information, actual map representation (reflecting real state of the game),
\r
475 * pixel shift for smooth tile scrolling.
\r
476 * 2. Provide ways to draw a visible part of map. For simplicity with smooth scrolling,
\r
477 * additional row/column is always drawn at the each side of the map. This implies that 'fence'
\r
478 * should have a sprite too. Map is drawn left-to-right, top-to-bottom.
\r
481 //==========================================================================
\r
484 //==========================================================================
\r
486 #define MAXBLOCKS 1024 //kd=1300 wolf3d=700 cata=600
\r
488 typedef struct mmblockstruct
\r
490 //word start,length, blob; //for data larger than 64k
\r
491 word start; dword length;
\r
492 unsigned attributes;
\r
493 memptr *useptr; // pointer to the segment start
\r
494 struct mmblockstruct far *next;
\r
497 typedef struct mmshowmemoryinfo
\r
500 mmblocktype far *scan;
\r
501 } mmshowmemoryinfo_t;
\r
505 dword nearheap,farheap,EMSmem,XMSmem,mainmem;
\r
506 // boolean PMStarted, MainPresent, EMSPresent, XMSPresent;
\r
511 boolean mmstarted, bombonerror, mmerror;
\r
513 #ifdef __BORLANDC__
\r
517 void __near *nearheap;
\r
519 //---- unsigned int EMSVer;
\r
520 //---- word numUMBs,UMBbase[MAXUMBS];
\r
521 //---- word totalEMSpages, freeEMSpages, EMSpagesmapped, EMSHandle, EMSPageFrame;
\r
522 //---- dword numUMBs,UMBbase[MAXUMBS];
\r
523 mmblocktype far mmblocks[MAXBLOCKS],far *mmhead,far *mmfree,far *mmrover,far *mmnew;
\r
524 memptr bufferseg; //Allocates bufferseg misc buffer
\r
527 //==========================================================================
\r
531 //==========================================================================
\r
533 // NOTE! PMPageSize must be an even divisor of EMSPageSize, and >= 1024
\r
534 #define EMSPageSize 16384
\r
535 #define EMSPageSizeSeg (EMSPageSize >> 4)
\r
536 #define EMSPageSizeKB (EMSPageSize >> 10)
\r
537 #define EMSFrameCount 4
\r
538 #define PMPageSize 4096
\r
539 #define PMPageSizeSeg (PMPageSize >> 4)
\r
540 #define PMPageSizeKB (PMPageSize >> 10)
\r
541 #define PMEMSSubPage (EMSPageSize / PMPageSize)
\r
543 #define PMMinMainMem 10 // Min acceptable # of pages from main
\r
544 #define PMMaxMainMem 100 // Max number of pages in main memory
\r
546 #define PMThrashThreshold 1 // Number of page thrashes before panic mode
\r
547 #define PMUnThrashThreshold 5 // Number of non-thrashing frames before leaving panic mode
\r
564 dword offset; // Offset of chunk into file
\r
565 word length; // Length of the chunk
\r
567 int xmsPage; // If in XMS, (xmsPage * PMPageSize) gives offset into XMS handle
\r
569 PMLockType locked; // If set, this page can't be purged
\r
570 int emsPage; // If in EMS, logical page/offset into page
\r
571 int mainPage; // If in Main, index into handle array
\r
573 dword lastHit; // Last frame number of hit
\r
578 int baseEMSPage; // Base EMS page for this phys frame
\r
579 dword lastHit; // Last frame number of hit
\r
582 // Main Mem specific variables
\r
585 boolean MainPresent;
\r
586 memptr MainMemPages[PMMaxMainMem];
\r
587 PMBlockAttr MainMemUsed[PMMaxMainMem];
\r
588 int MainPagesAvail;
\r
591 // EMS specific variables
\r
594 boolean EMSPresent;
\r
595 unsigned int EMSVer;
\r
596 word EMSAvail,EMSPagesAvail,EMSHandle,
\r
597 EMSPageFrame,EMSPhysicalPage;
\r
598 word totalEMSpages, freeEMSpages, EMSpagesmapped;
\r
599 EMSListStruct EMSList[EMSFrameCount];
\r
602 // XMS specific variables
\r
605 boolean XMSPresent;
\r
606 word XMSAvail,XMSPagesAvail,XMSHandle;//,XMSVer;
\r
608 int XMSProtectPage;// = -1;
\r
611 // File specific variables
\r
614 char PageFileName[13];// = {"VSWAP."};
\r
615 int PageFile;// = -1;
\r
617 word PMSpriteStart,PMSoundStart;
\r
620 // General usage variables
\r
631 PageListStruct far *PMPages,
\r
639 //==========================================================================
\r
642 //==========================================================================
\r
643 #pragma pack(push,1)
\r
644 typedef struct imf_entry
\r
653 volatile unsigned long irq0_ticks;//=0;
\r
654 volatile unsigned int irq0_cnt,irq0_add,irq0_max;//=0;
\r
655 imf_entry_t* imf_music;//=NULL;
\r
656 imf_entry_t* imf_play_ptr;//=NULL;
\r
657 imf_entry_t* imf_music_end;//=NULL;
\r
658 word imf_delay_countdown;//=0;
\r
661 //==========================================================================
\r
664 //==========================================================================
\r
670 //#define MAPHEADERLINKED
\r
671 //#define GRHEADERLINKED
\r
672 //#define AUDIOHEADERLINKED
\r
674 #define NUMMAPS 4//39
\r
675 #define NUMSNDCHUNKS 4//3
\r
676 //#define NUMPICS 4//132//wolf3d wl6
\r
678 #define STRUCTPIC 0
\r
679 #define CASVT dword //*start var type
\r
682 #define DATADIR "data/"
\r
683 #define GDICTNAME DATADIR"vgadict."
\r
684 #define GHEADNAME DATADIR"vgahead."
\r
685 #define GFILENAME DATADIR"vgagraph."
\r
688 #define MAPSEGBUF mapsegs
\r
689 #define MAPSEGPTR MAPSEGBUF[0]
\r
690 #define MAPSEGINLM (gvar->ca.MAPSEGPTR)
\r
694 word bit0,bit1; // 0-255 is a character, > is a pointer to a node
\r
699 long planestart[3];
\r
700 unsigned planelength[3];
\r
701 unsigned width,height;
\r
708 long headeroffsets[100];
\r
714 int maphandle; // handle to MAPTEMP / GAMEMAPS
\r
715 int grhandle; // handle to EGAGRAPH
\r
716 int audiohandle; // handle to AUDIOT / AUDIO
\r
719 16/wf3d8086/id_ca.c: grstarts = (long _seg *)FP_SEG(&EGAhead);
\r
720 16/wf3d8086/id_ca.c: tinf = (byte _seg *)FP_SEG(&maphead);
\r
721 16/wf3d8086/id_ca.c: pos = ((mapfiletype _seg *)tinf)->headeroffsets[i];
\r
722 16/wf3d8086/id_ca.c: audiostarts = (long _seg *)FP_SEG(&audiohead);
\r
723 16/wf3d8086/id_ca.c: ((mapfiletype _seg *)tinf)->RLEWtag);
\r
724 16/wf3d8086/id_ca.c: ((mapfiletype _seg *)tinf)->RLEWtag);
\r
725 16/wf3d8086/id_ca.c: source = (byte _seg *)bufferseg+(pos-bufferstart);
\r
727 typedef struct //TODO: USE THIS!!!!
\r
729 byte ca_levelbit,ca_levelnum;
\r
730 ca_handle_t file; //files to open
\r
732 byte _seg *tinf;//?? where in the id engine is this used and what is it? --sparky4
\r
734 maptype _seg *mapheaderseg[NUMMAPS];
\r
735 unsigned _seg *mapsegs[MAPPLANES];
\r
736 void _seg *grsegs[NUMCHUNKS];
\r
737 byte far grneeded[NUMCHUNKS];
\r
738 word _seg *audiosegs[NUMSNDCHUNKS];//long
\r
740 CASVT _seg *grstarts; // array of offsets in egagraph, -1 for sparse//long
\r
741 CASVT _seg *audiostarts; // array of offsets in audio / audiot//long
\r
743 #ifdef GRHEADERLINKED
\r
744 huffnode *grhuffman;
\r
746 huffnode grhuffman[63];
\r
749 #ifdef AUDIOHEADERLINKED
\r
750 huffnode *audiohuffman;
\r
752 huffnode audiohuffman[63];
\r
755 CASVT chunkcomplen,chunkexplen;//long
\r
758 //TODO: extend! and learn from keen/wolf/catacomb's code wwww
\r
759 memptr spribuff[64]; //temp
\r
762 //==========================================================================
\r
764 //actual global game varables!
\r
774 extern char global_temp_status_text[512];
\r
775 extern char global_temp_status_text2[512];
\r
778 typedef struct glob_game_vars
\r
780 video_t video; // video settings variable
\r
781 ca_t ca; // ca stuff
\r
782 pm_t pm; // pm stuff
\r
783 loghandle_t handle; //handles for file logging
\r
784 kurokku_t kurokku; //clock struct
\r
785 mminfo_t mm; mminfotype mmi; // mm stuff
\r
786 in_info_t in; // 16_in info
\r
787 player_t player[MaxPlayers]; // player vars
\r
792 } global_game_variables_t;
\r
794 #endif /* _TYPEDEFSTRUCT_H_ */
\r