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
45 * typedefs of the game variables!
\r
57 word ntiles; // the number of tiles
\r
58 word twidth; // width of the tiles
\r
59 word theight; // height of the tiles
\r
60 byte *palette; // palette for the tile set
\r
64 byte far *plane[4]; // 4 planes of image data
\r
65 word width; // width of the image (spread across 4 planes)
\r
66 word height; // height of the image (spread across 4 planes)
\r
67 word pwidth; // the number of bytes in each plane
\r
73 #include <hw/vga/vrl.h>
\r
75 typedef struct vrs_container{
\r
76 // Size of a .vrs blob in memory
\r
81 struct vrs_header far *vrs_hdr;
\r
83 // Array of corresponding vrl line offsets
\r
84 vrl1_vgax_offset_t **vrl_line_offsets;
\r
87 typedef struct vrl_container{
\r
88 // Size of a .vrl blob in memory
\r
93 struct vrl1_vgax_header far *vrl_header;
\r
95 // Pointer to a corresponding vrl line offsets struct
\r
96 vrl1_vgax_offset_t *line_offsets;
\r
99 typedef struct sprite
\r
101 // VRS container from which we will extract animation and image data
\r
102 vrs_container_t spritesheet;
\r
103 // Container for a vrl sprite
\r
104 vrl_container_t sprite_vrl_cont;
\r
105 // Current sprite id
\r
107 // Index of a current sprite in an animation sequence
\r
108 int curr_anim_spri;
\r
109 // Current animation sequence
\r
110 struct vrs_animation_list_entry_t *curr_anim_list;
\r
111 // Index of current animation in relevant VRS offsets table
\r
113 // Delay in time units untill we should change sprite
\r
115 // Position of sprite on screen
\r
123 int x; //entity exact position on the viewable map
\r
124 int y; //entity exact position on the viewable map
\r
125 int tx; //entity tile position on the viewable map
\r
126 int ty; //entity tile position on the viewable map
\r
127 int triggerx; //entity's trigger box tile position on the viewable map
\r
128 int triggery; //entity's trigger box tile position on the viewable map
\r
129 // int sheetsetx; //NOT USED YET! entity sprite sheet set on the image x
\r
130 // int sheetsety; //NOT USED YET! entity sprite sheet set on the image y
\r
131 nibble d; //direction to render sprite!! wwww
\r
132 nibble pred; //prev. direction for animation changing
\r
133 word dire; //sprite in use
\r
134 nibble q; //loop variable for anumation and locking the playing to compleate the animation cycle to prevent issues with misalignment www
\r
135 word speed; //entity speed!
\r
136 word spt; //speed per tile
\r
138 sprite_t spri; // sprite used by entity
\r
140 sword hp; //hitpoints of the entity
\r
141 nibble overdraww, overdrawh; // how many pixels to "overdraw" so that moving sprites with edge pixels don't leave streaks.
\r
142 // if the sprite's edge pixels are clear anyway, you can set this to 0.
\r
143 nibble /*int*/ persist_aniframe; // gonna be increased to 1 before being used, so 0 is ok for default
\r
148 int x; //entity exact position on the viewable map
\r
149 int y; //entity exact position on the viewable map
\r
150 int tx; //entity tile position on the viewable map
\r
151 int ty; //entity tile position on the viewable map
\r
154 sprite_t spri; // sprite used by entity
\r
156 sword hp; //hitpoints of the entity
\r
157 } static_map_entity_t;
\r
159 //===========================================================================//
\r
161 //TODO: 16_mm and 16_ca must handle this
\r
164 sprite_t *spri; // I will probibaly use this --sparky4
\r
166 word tileHeight, tileWidth; //defined by mapfile
\r
167 unsigned int rows, cols;
\r
168 byte imgname[8]; //image file of tileset (set to 8 because DOS ^^;)
\r
169 } tiles_t; //seems to be the tileset properties
\r
171 //TODO: 16_mm and 16_ca must handle this
\r
172 //TODO: add variables from 16_ca
\r
175 byte *data; //TODO: 16_mm and 16_ca must handle this
\r
176 } mapl_t; //map layer array type def
\r
178 #define MAPPLANES 3
\r
180 //long planestart[3];
\r
181 //unsigned planelength[3];
\r
182 mapl_t layerdata[MAPPLANES]; // mapdata for multilayer (map index values for rendering which image on the tile)
\r
183 tiles_t *tiles; //TODO: 16_mm and 16_ca must handle this // tilesets for layers (currently ony 4 can be loaded wwww)
\r
184 int width, height; //this has to be signed!
\r
188 //===================================//
\r
191 word tw; /* screen width in tiles */
\r
192 word th; /* screen height in tiles */
\r
193 word tilesw; /* virtual screen width in tiles */
\r
194 word tilesh; /* virtual screen height in tiles */
\r
195 sword tilemidposscreenx; /* middle tile x position */ /* needed for scroll system to work accordingly */
\r
196 sword tilemidposscreeny; /* middle tile y position */ /* needed for scroll system to work accordingly */
\r
197 sword tileplayerposscreenx; /* player position on screen */ /* needed for scroll and map system to work accordingly */
\r
198 sword tileplayerposscreeny; /* player position on screen */ /* needed for scroll and map system to work accordingly */
\r
202 nibble/*word*/ id; /* the Identification number of the page~ For layering~ */
\r
203 byte far* data; /* the data for the page */
\r
204 pagetileinfo_t ti; // the tile information of the page
\r
205 word dx; /* col we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the left size */
\r
206 word dy; /* row we are viewing on virtual screen (on page[0]) */ /* off screen buffer on the top size */
\r
207 word sw; /* screen width */ /* resolution */
\r
208 word sh; /* screen heigth */ /* resolution */
\r
209 word width; /* virtual width of the page */
\r
210 word height; /* virtual height of the page */
\r
211 word stridew; /* width/4 */ /* VGA */
\r
212 word pagesize; /* page size */
\r
213 word pi; /* increment page by this much to preserve location */
\r
216 //TODO: find where they are used
\r
217 sword delta; // How much should we shift the page for smooth scrolling
\r
221 //==========================================================================
\r
222 #define KeyInt 9 // The keyboard ISR number
\r
231 #define MouseInt 0x33
\r
232 //#define Mouse(x) _AX = x,geninterrupt(MouseInt)
\r
235 // joystick constants
\r
237 #define JoyScaleMax 32768
\r
238 #define JoyScaleShift 8
\r
239 #define MaxJoyValue 5000
\r
241 #define MaxPlayers 4
\r
244 #define NumCodes 128
\r
246 typedef byte ScanCode;
\r
249 //ctrl_None, // MDM (GAMERS EDGE) - added
\r
251 ctrl_Keyboard1 = ctrl_Keyboard,ctrl_Keyboard2,
\r
253 ctrl_Joystick1 = ctrl_Joystick,ctrl_Joystick2,
\r
257 motion_Left = -1,motion_Up = -1,
\r
259 motion_Right = 1,motion_Down = 1
\r
261 typedef enum { // Quick lookup for total direction
\r
262 /*dir_NorthWest, */dir_North,/* dir_NorthEast,*/
\r
263 dir_West, dir_None, dir_East,
\r
264 /*dir_SouthWest, */dir_South/*, dir_SouthEast*/
\r
267 boolean near button0,button1,button2,button3;
\r
269 Motion near xaxis,yaxis;
\r
270 Direction near dir;
\r
274 ScanCode near button0,button1,
\r
286 word near joyMinX,joyMinY,
\r
287 threshMinX,threshMinY,
\r
288 threshMaxX,threshMaxY,
\r
290 joyMultXL,joyMultYL,
\r
291 joyMultXH,joyMultYH;
\r
294 typedef struct instat {
\r
296 ScanCode CurCode,LastCode;
\r
298 boolean Keyboard[NumCodes];
\r
304 typedef struct// inconfig
\r
306 boolean IN_Started;
\r
308 // configuration variables
\r
310 boolean JoysPresent[MaxJoys],
\r
314 // Global variables
\r
315 KeyboardDef KbdDefs[MaxKbds];
\r
316 JoystickDef JoyDefs[MaxJoys];
\r
320 //==========================================================================
\r
324 entity_t near enti;
\r
326 //struct sprite *spri; //supposively the sprite sheet data
\r
329 // bitmap_t *data; //supposively the sprite sheet data//old format
\r
333 byte near pdir; //previous direction~ used in IN_16 in IN_ReadControl()
\r
335 ControlType Controls;
\r
338 int dx, dy, delta; //TODO: what is this? ^^
\r
341 //===========================================//
\r
345 int profilehandle,debughandle,showmemhandle;
\r
351 word frames_per_second;
\r
353 dword tiku; //frames passed
\r
354 word clock_start; //timer start
\r
355 word *clock; //current time on clock
\r
356 boolean fpscap; //cap the fps var
\r
357 nibble wcpu; //stored value of cpu type
\r
360 //===================================//
\r
361 #define PALSIZE 768
\r
362 #define NUMCHUNKS 416 //keen
\r
363 #define MAXSCANLINES 240 // size of ylookup table
\r
373 word tileHeight, tileWidth; //defined by mapfile
\r
374 word quadwh; //preproccessed quad size of tilewidth and tileheight
\r
375 } tile_dimention_t;
\r
377 #define MAXSCROLLEDGES 6
\r
380 unsigned panx,pany; // panning adjustments inside port in pixels
\r
381 unsigned pansx,pansy;
\r
382 unsigned panadjust; // panx/pany adjusted by screen resolution
\r
383 int hscrollblocks,vscrollblocks;
\r
384 int hscrolledge[MAXSCROLLEDGES],vscrolledge[MAXSCROLLEDGES];
\r
389 //ylookup[MAXSCANLINES],
\r
390 unsigned int offscreen_ofs;
\r
391 unsigned int pattern_ofs;
\r
392 // unsigned bufferofs,linewidth,displayofs;
\r
395 } ofs_t; //unfinished
\r
399 //doslib origi vars
\r
400 byte far * omemptr;
\r
401 byte vga_draw_stride;
\r
402 byte vga_draw_stride_limit; // further X clipping
\r
403 //end of doslib origi vars
\r
404 boolean __near rss; //render sprite switch
\r
405 boolean __near bgps; //bg preservation render switch between old and new
\r
410 boolean VL_Started,VL_Initiated;
\r
411 char old_mode; //old video mode before game!
\r
412 sword curr_mode; //modex curent mode
\r
413 byte palette[PALSIZE], dpal[PALSIZE]; //palette array
\r
414 page_t page[MAXPAGE]; //can be used as a pointer to root page[0]
\r
415 word vmem_remain; //remaining video memory
\r
416 byte num_of_pages; //number of actual pages
\r
417 vga_state_t vga_state;
\r
418 sword __near sprifilei; //player file's i
\r
419 nibble __near p; //render page number
\r
420 nibble __near sp; //show page number(for showpage)
\r
421 boolean __near dorender; //page flip, showpage, or render if true
\r
422 word pr[MAXPAGE][4]; //render sections of pages (this is supposed to be set up to draw sections of the screen if updated)
\r
424 nibble sfip; //shinku_fps_indicator_page; // we're on page 1 now, shinku(). follow along please or it will not be visible.
\r
425 ofs_t ofs; //offset vars used for doslib
\r
426 word vh; //video combined height
\r
427 tile_dimention_t td;
\r
428 //0000word startclk; float clk, tickclk; //timer
\r
430 boolean screenfaded;
\r
432 boolean fastpalette;
\r
433 byte far palette1[256][3],far palette2[256][3];
\r
434 pictabletype _seg *pictable;
\r
438 //==========================================================================
\r
443 int tx,ty; //appears to be the top left tile position on the viewable screen map
\r
444 word dxThresh,dyThresh; //Threshold for physical tile switch
\r
445 video_t *video; //pointer to game variables of the video
\r
446 kurokku_t *kurokku; //pointer to game variables of the kurokku
\r
447 nibble __near *p; // pointer to video's render page num
\r
448 nibble __near *sp; // pointer to video's show page num
\r
449 int dx, dy; // draw row and col var
\r
453 /* Map is presumed to:
\r
454 * 1. Have all the required layers and tilesets within itself
\r
455 * 2. Have a 'fence' around accessible blocks to simplify boundary logic
\r
456 * 3. Have a persistent map and tile size among the layers
\r
457 * Map view is presumed to:
\r
458 * 1. Calculate, store and update a panning info, which includes, but not limited to:
\r
459 * combined layer information, actual map representation (reflecting real state of the game),
\r
460 * pixel shift for smooth tile scrolling.
\r
461 * 2. Provide ways to draw a visible part of map. For simplicity with smooth scrolling,
\r
462 * additional row/column is always drawn at the each side of the map. This implies that 'fence'
\r
463 * should have a sprite too. Map is drawn left-to-right, top-to-bottom.
\r
466 //==========================================================================
\r
469 //==========================================================================
\r
471 #define MAXBLOCKS 800//kd=1300 wolf3d=700 cata=600
\r
473 typedef struct mmblockstruct
\r
475 unsigned start,length;
\r
476 unsigned attributes;
\r
477 memptr *useptr; // pointer to the segment start
\r
478 struct mmblockstruct far *next;
\r
481 typedef struct mmshowmemoryinfo
\r
484 mmblocktype far *scan;
\r
485 } mmshowmemoryinfo_t;
\r
489 dword nearheap,farheap,EMSmem,XMSmem,mainmem;
\r
490 // boolean PMStarted, MainPresent, EMSPresent, XMSPresent;
\r
495 boolean mmstarted, bombonerror, mmerror;
\r
497 #ifdef __BORLANDC__
\r
501 void __near *nearheap;
\r
503 //---- unsigned int EMSVer;
\r
504 //---- word numUMBs,UMBbase[MAXUMBS];
\r
505 //---- word totalEMSpages, freeEMSpages, EMSpagesmapped, EMSHandle, EMSPageFrame;
\r
506 //---- dword numUMBs,UMBbase[MAXUMBS];
\r
507 mmblocktype far mmblocks[MAXBLOCKS],far *mmhead,far *mmfree,far *mmrover,far *mmnew;
\r
508 memptr bufferseg; //Allocates bufferseg misc buffer
\r
511 //==========================================================================
\r
515 //==========================================================================
\r
517 // NOTE! PMPageSize must be an even divisor of EMSPageSize, and >= 1024
\r
518 #define EMSPageSize 16384
\r
519 #define EMSPageSizeSeg (EMSPageSize >> 4)
\r
520 #define EMSPageSizeKB (EMSPageSize >> 10)
\r
521 #define EMSFrameCount 4
\r
522 #define PMPageSize 4096
\r
523 #define PMPageSizeSeg (PMPageSize >> 4)
\r
524 #define PMPageSizeKB (PMPageSize >> 10)
\r
525 #define PMEMSSubPage (EMSPageSize / PMPageSize)
\r
527 #define PMMinMainMem 10 // Min acceptable # of pages from main
\r
528 #define PMMaxMainMem 100 // Max number of pages in main memory
\r
530 #define PMThrashThreshold 1 // Number of page thrashes before panic mode
\r
531 #define PMUnThrashThreshold 5 // Number of non-thrashing frames before leaving panic mode
\r
548 dword offset; // Offset of chunk into file
\r
549 word length; // Length of the chunk
\r
551 int xmsPage; // If in XMS, (xmsPage * PMPageSize) gives offset into XMS handle
\r
553 PMLockType locked; // If set, this page can't be purged
\r
554 int emsPage; // If in EMS, logical page/offset into page
\r
555 int mainPage; // If in Main, index into handle array
\r
557 dword lastHit; // Last frame number of hit
\r
562 int baseEMSPage; // Base EMS page for this phys frame
\r
563 dword lastHit; // Last frame number of hit
\r
566 // Main Mem specific variables
\r
569 boolean MainPresent;
\r
570 memptr MainMemPages[PMMaxMainMem];
\r
571 PMBlockAttr MainMemUsed[PMMaxMainMem];
\r
572 int MainPagesAvail;
\r
575 // EMS specific variables
\r
578 boolean EMSPresent;
\r
579 unsigned int EMSVer;
\r
580 word EMSAvail,EMSPagesAvail,EMSHandle,
\r
581 EMSPageFrame,EMSPhysicalPage;
\r
582 word totalEMSpages, freeEMSpages, EMSpagesmapped;
\r
583 EMSListStruct EMSList[EMSFrameCount];
\r
586 // XMS specific variables
\r
589 boolean XMSPresent;
\r
590 word XMSAvail,XMSPagesAvail,XMSHandle;//,XMSVer;
\r
592 int XMSProtectPage;// = -1;
\r
595 // File specific variables
\r
598 char PageFileName[13];// = {"VSWAP."};
\r
599 int PageFile;// = -1;
\r
601 word PMSpriteStart,PMSoundStart;
\r
604 // General usage variables
\r
615 PageListStruct far *PMPages,
\r
623 //==========================================================================
\r
626 //==========================================================================
\r
627 #pragma pack(push,1)
\r
628 typedef struct imf_entry
\r
637 volatile unsigned long irq0_ticks;//=0;
\r
638 volatile unsigned int irq0_cnt,irq0_add,irq0_max;//=0;
\r
639 imf_entry_t* imf_music;//=NULL;
\r
640 imf_entry_t* imf_play_ptr;//=NULL;
\r
641 imf_entry_t* imf_music_end;//=NULL;
\r
642 word imf_delay_countdown;//=0;
\r
645 //==========================================================================
\r
648 //==========================================================================
\r
651 //#define NOGRAPHICS
\r
654 #define MAPHEADERLINKED
\r
655 //#define GRHEADERLINKED
\r
656 #define AUDIOHEADERLINKED
\r
658 #define NUMMAPS 4//39
\r
659 #define NUMSNDCHUNKS 4//3
\r
660 //#define NUMPICS 4//132//wolf3d wl6
\r
662 #define STRUCTPIC 0
\r
663 #define CASVT dword //*start var type
\r
666 #define DATADIR "data/"
\r
667 #define GDICTNAME DATADIR"vgadict."
\r
668 #define GHEADNAME DATADIR"vgahead."
\r
669 #define GFILENAME DATADIR"vgagraph."
\r
670 #define EXTENSION "hb1"
\r
675 word bit0,bit1; // 0-255 is a character, > is a pointer to a node
\r
680 long planestart[3];
\r
681 unsigned planelength[3];
\r
682 unsigned width,height;
\r
689 maptype _seg *mapheaderseg[NUMMAPS];
\r
694 int maphandle; // handle to MAPTEMP / GAMEMAPS
\r
695 int grhandle; // handle to EGAGRAPH
\r
696 int audiohandle; // handle to AUDIOT / AUDIO
\r
699 16/wf3d8086/id_ca.c: grstarts = (long _seg *)FP_SEG(&EGAhead);
\r
700 16/wf3d8086/id_ca.c: tinf = (byte _seg *)FP_SEG(&maphead);
\r
701 16/wf3d8086/id_ca.c: pos = ((mapfiletype _seg *)tinf)->headeroffsets[i];
\r
702 16/wf3d8086/id_ca.c: audiostarts = (long _seg *)FP_SEG(&audiohead);
\r
703 16/wf3d8086/id_ca.c: ((mapfiletype _seg *)tinf)->RLEWtag);
\r
704 16/wf3d8086/id_ca.c: ((mapfiletype _seg *)tinf)->RLEWtag);
\r
705 16/wf3d8086/id_ca.c: source = (byte _seg *)bufferseg+(pos-bufferstart);
\r
707 typedef struct //TODO: USE THIS!!!!
\r
709 byte ca_levelbit,ca_levelnum;
\r
710 ca_handle_t file; //files to open
\r
711 ca_mapinfo_t camap;
\r
713 byte _seg *tinf;//?? where in the id engine is this used and what is it? --sparky4
\r
714 unsigned _seg *mapsegs[MAPPLANES];
\r
715 void _seg *grsegs[NUMCHUNKS];
\r
716 byte far grneeded[NUMCHUNKS];
\r
717 word _seg *audiosegs[NUMSNDCHUNKS];//long
\r
719 CASVT _seg *grstarts; // array of offsets in egagraph, -1 for sparse//long
\r
720 CASVT _seg *audiostarts; // array of offsets in audio / audiot//long
\r
722 #ifdef GRHEADERLINKED
\r
723 huffnode *grhuffman;
\r
725 huffnode grhuffman[255];
\r
728 #ifdef AUDIOHEADERLINKED
\r
729 huffnode *audiohuffman;
\r
731 huffnode audiohuffman[255];
\r
734 CASVT chunkcomplen,chunkexplen;//long
\r
737 //TODO: extend! and learn from keen/wolf/catacomb's code wwww
\r
741 //==========================================================================
\r
743 //actual global game varables!
\r
754 typedef struct glob_game_vars
\r
756 video_t video; // video settings variable
\r
757 ca_t ca; // ca stuff
\r
758 pm_t pm; // pm stuff
\r
759 loghandle_t handle; //handles for file logging
\r
760 kurokku_t kurokku; //clock struct
\r
761 mminfo_t mm; mminfotype mmi; // mm stuff
\r
762 in_info_t in; // 16_in info
\r
763 player_t player[MaxPlayers]; // player vars
\r
767 } global_game_variables_t;
\r
770 extern char global_temp_status_text[512];
\r
771 extern char global_temp_status_text2[512];
\r
772 #define EINVFMT EMFILE
\r
774 #endif /* _TYPEDEFSTRUCT_H_ */
\r