src/lib/16_vl.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  * Functions for handling modex and doing other basic graphics stuff.\r
  24  */\r
  25 #ifndef MODEX16_H\r
  26 #define MODEX16_H\r
  27 \r
  28 #include "src/lib/16_head.h"\r
  29 //#include "src/lib/planar.h"\r
  30 //#include "src/lib/modex16/16planar.h"\r
  31 #include "src/lib/16text.h"\r
  32 ////#include "src/lib/modex16/320x240.h"\r
  33 // #include "src/lib/modex16/320x200.h"\r
  34 // #include "src/lib/modex16/256x192.h"\r
  35 // #include "src/lib/modex16/192x144_.h"\r
  36 // #include "src/lib/modex16/160x120.h"\r
  37 \r
  38 //320x240 = 20x15\r
  39 //192x144 = 12x9\r
  40 \r
  41 //temp defines\r
  42 #define TILEWH  16\r
  43 #define TILEWHD TILEWH*2\r
  44 #define QUADWH                  TILEWH/2\r
  45 \r
  46 //#define OLDBGPRESERVE\r
  47 \r
  48 /* -========================== Types & Macros ==========================- */\r
  49 #define PAGE_OFFSET(x,y) (((y)<<6)+((y)<<4)+((x)>>2))\r
  50 #define PLANE(x) (1 << ((x) & 3))\r
  51 #define SELECT_ALL_PLANES() outpw(0x03c4, 0xff02)\r
  52 \r
  53 // clips for rectangles not on 4s\r
  54 #define LRCLIPDEF \\r
  55         static byte lclip[4] = {0x0f, 0x0e, 0x0c, 0x08}; \\r
  56         static byte rclip[4] = {0x00, 0x01, 0x03, 0x07};\r
  57 \r
  58 #define VCLIPDEF \\r
  59         static byte pclip[4] = {1,2,4,8};\r
  60 \r
  61 typedef union\r
  62 {\r
  63         byte red;\r
  64         byte green;\r
  65         byte blue;\r
  66 } rgb_t;\r
  67 \r
  68 /* -======================= Constants & Vars ==========================- */\r
  69 extern byte far*  VGA;  /* The VGA Memory */\r
  70 #define SCREEN_SEG              0xa000\r
  71 #define VIDEO_INT               0x10\r
  72 #define SET_MODE                0x00\r
  73 #define VGA_256_COLOR_MODE      0x13\r
  74 #define TEXT_MODE               0x03\r
  75 \r
  76 #define SC_INDEX                0x03c4\r
  77 #define SC_RESET                        0\r
  78 #define SC_CLOCK                        1\r
  79 #define SC_MAPMASK                      2\r
  80 #define SC_CHARMAP                      3\r
  81 #define SC_MEMMODE                      4\r
  82 \r
  83 #define CRTC_INDEX                      0x3D4\r
  84 #define CRTC_H_TOTAL            0\r
  85 #define CRTC_H_DISPEND          1\r
  86 #define CRTC_H_BLANK            2\r
  87 #define CRTC_H_ENDBLANK         3\r
  88 #define CRTC_H_RETRACE          4\r
  89 #define CRTC_H_ENDRETRACE       5\r
  90 #define CRTC_V_TOTAL            6\r
  91 #define CRTC_OVERFLOW           7\r
  92 #define CRTC_ROWSCAN            8\r
  93 #define CRTC_MAXSCANLINE        9\r
  94 #define CRTC_CURSORSTART        10\r
  95 #define CRTC_CURSOREND          11\r
  96 #define CRTC_STARTHIGH          12\r
  97 #define CRTC_STARTLOW           13\r
  98 #define CRTC_CURSORHIGH         14\r
  99 #define CRTC_CURSORLOW          15\r
 100 #define CRTC_V_RETRACE          16\r
 101 #define CRTC_V_ENDRETRACE       17\r
 102 #define CRTC_V_DISPEND          18\r
 103 #define CRTC_OFFSET                     19\r
 104 #define CRTC_UNDERLINE          20\r
 105 #define CRTC_V_BLANK            21\r
 106 #define CRTC_V_ENDBLANK         22\r
 107 #define CRTC_MODE                       23\r
 108 #define CRTC_LINECOMPARE        24\r
 109 \r
 110 #define GC_INDEX                0x03ce\r
 111 #define GC_SETRESET                     0\r
 112 #define GC_ENABLESETRESET       1\r
 113 #define GC_COLORCOMPARE         2\r
 114 #define GC_DATAROTATE           3\r
 115 #define GC_READMAP                      4\r
 116 #define GC_MODE                         5\r
 117 #define GC_MISCELLANEOUS        6\r
 118 #define GC_COLORDONTCARE        7\r
 119 #define GC_BITMASK                      8\r
 120 \r
 121 #define AC_INDEX                0x03c0\r
 122 #define SC_DATA                 0x03c5\r
 123 #define CRTC_DATA               0x03d5\r
 124 #define MISC_OUTPUT             0x03c2\r
 125 #define HIGH_ADDRESS            0x0C\r
 126 #define LOW_ADDRESS             0x0D\r
 127 #define VRETRACE                0x08\r
 128 //#define INPUT _STATUS_1                       defined in 16_head\r
 129 //#define STATUS_REGISTER_1     0x03da\r
 130 \r
 131 #define STATUS_REGISTER_1    0x3da\r
 132 \r
 133 #define ATR_INDEX                       AC_INDEX\r
 134 #define ATR_OVERSCAN            17\r
 135 #define DISPLAY_ENABLE          0x01\r
 136 //#define MAP_MASK              0x02\r
 137 #define PAL_READ_REG                    0x03C7   /* Color register, read address */\r
 138 #define PAL_WRITE_REG              0x03C8   /* Color register, write address */\r
 139 #define PAL_DATA_REG                    0x03C9   /* Color register, data port */\r
 140 #define PAL_SIZE                                (256 * 3)\r
 141 \r
 142 //===========================================================================\r
 143 \r
 144 #define SCREENSEG               0xa000\r
 145 \r
 146 //#define SCREENWIDTH           80                      // default screen width in bytes\r
 147 //#define MAXSCANLINES  240                     // size of ylookup table\r
 148 \r
 149 //#define CHARWIDTH             2\r
 150 //#define TILEWIDTH             4\r
 151 \r
 152 //===========================================================================\r
 153 \r
 154 //\r
 155 // VGA hardware routines\r
 156 //\r
 157 void    VGAWRITEMODE(byte x),\r
 158         VGAMAPMASK(byte x),\r
 159         VGAREADMAP(byte x),\r
 160         VGABITMASK(byte x);\r
 161 \r
 162 #define VW_Hlin(x,z,y,c,q)      VL_Hlin(x,y,(z)-(x)+1,c,q)\r
 163 #define VW_Vlin(y,z,x,c,q)      VL_Vlin(x,y,(z)-(y)+1,c,q)\r
 164 #define PALPROGRAMSNEWPAGE gvar.video.page[0] = modexDefaultPage(&gvar.video.page[0], &gvar);// modexFadeOn(4, &gvar.video.palette);\r
 165 \r
 166 /* -============================ Functions =============================- */\r
 167 /* mode switching, page, and plane functions */\r
 168 void    VL_Startup (global_game_variables_t *gvar),\r
 169         VL_Shutdown (global_game_variables_t *gvar),\r
 170         VL_SetVGAPlaneMode (global_game_variables_t *gvar),\r
 171         VL_ClearVideo (byte color),\r
 172         VL_DePlaneVGA (),\r
 173         VGAmodeX(sword vq, boolean cmem, global_game_variables_t *gv),\r
 174         modexEnter(sword vq, boolean cmem, global_game_variables_t *gv);\r
 175 //void VL_vgaSetMode(byte mode);\r
 176 byte VL_vgaGetMode(void);\r
 177 extern void TL_VidInit(global_game_variables_t *gvar);\r
 178 void modexLeave(void);\r
 179 void modexsetBaseXMode();\r
 180 page_t modexDefaultPage(page_t *p, global_game_variables_t *gvar);\r
 181 page_t modexNextPage(page_t *p);\r
 182 page_t modexNextPageFlexibleSize(page_t *p, word x, word y);\r
 183 void modexCalcVmemRemain(video_t *video);\r
 184 void VL_Initofs(video_t *video);\r
 185 void modexHiganbanaPageSetup(global_game_variables_t *gvar);\r
 186 void modexShowPage(page_t *page);//for 0croll.exe\r
 187 void VL_ShowPage(page_t *page, boolean vsync, boolean sr);\r
 188 void modexPanPage(page_t *page, int dx, int dy);\r
 189 void modexSelectPlane(byte plane);\r
 190 void modexClearRegion(page_t *page, int x, int y, int w, int h, byte color);\r
 191 /* moved to src/lib/modex16/16render.c */\r
 192 void modexCopyPageRegion(page_t *dest, page_t *src, word sx, word sy, word dx, word dy, word width, word height);\r
 193 \r
 194 /* Palette fade and flash effects */\r
 195 void VL_FadeIn (int start, int end, byte far *palette, int steps, video_t *v);\r
 196 void modexFadeOn(word fade, byte *palette);\r
 197 void modexFadeOff(word fade, byte *palette);\r
 198 void modexFlashOn(word fade, byte *palette);\r
 199 void modexFlashOff(word fade, byte *palette);\r
 200 \r
 201 /* palette loading and saving */\r
 202 void modexPalSave(byte *palette);\r
 203 //byte *modexNewPal();\r
 204 void modexLoadPalFile(char *filename, byte *palette);\r
 205 void VL_LoadPalFile(const char *filename, byte *palette, global_game_variables_t *gvar);\r
 206 void VL_LoadPalFileCore(byte *palette, global_game_variables_t *gvar);\r
 207 //void VLL_LoadPalFilewithoffset(const char *filename, byte *palette, word o, global_game_variables_t *gvar);\r
 208 void VL_UpdatePaletteWrite(byte *palette, word o, word palsize, global_game_variables_t *gvar);\r
 209 void VL_PaletteSync(global_game_variables_t *gvar);\r
 210 void modexSavePalFile(char *filename, byte *palette);\r
 211 #define MenuFadeIn()    VL_FadeIn(0,255,&gamepal,10)\r
 212 \r
 213 /* fixed palette functions */\r
 214 void modexPalBlack();\r
 215 void modexPalWhite();\r
 216 \r
 217 /* utility functions */\r
 218 void modexPalUpdate(byte *p);\r
 219 void VL_modexPalScramble(byte *p);\r
 220 word VL_modexPalOverscan(byte *p, word col);\r
 221 void VL_ColorBorder (int color, video_t *v);\r
 222 void VL_Plot (int x, int y, int color, global_game_variables_t *gvar);\r
 223 void VL_Hlin (unsigned x, unsigned y, unsigned width, unsigned color, global_game_variables_t *gvar);\r
 224 void VL_Vlin (int x, int y, int height, int color, global_game_variables_t *gvar);\r
 225 void VL_Bar (int x, int y, int width, int height, int color, global_game_variables_t *gvar);\r
 226 void VL_MemToScreen (byte far *source, int width, int height, int x, int y, global_game_variables_t *gvar);\r
 227 void modexputPixel(page_t *page, int x, int y, byte color);\r
 228 byte modexgetPixel(page_t *page, int x, int y);\r
 229 \r
 230 #if 0 // not needed anymore. maybe good for reference purposes though.\r
 231 static inline void modexwritepixel(page_t *page, int x, int y, word addr, byte color)\r
 232 {\r
 233         /* Each address accesses four neighboring pixels, so set\r
 234            Write Plane Enable according to which pixel we want\r
 235            to modify.  The plane is determined by the two least\r
 236            significant bits of the x-coordinate: */\r
 237         modexSelectPlane(PLANE(x));\r
 238         //outp(SC_INDEX, 0x02);\r
 239         //outp(SC_DATA, 0x01 << (x & 3));\r
 240 \r
 241         /* The offset of the pixel into the video segment is\r
 242            offset = (width * y + x) / 4, and write the given\r
 243            color to the plane we selected above.  Heed the active\r
 244            page start selection. */\r
 245         vga_state.vga_graphics_ram[addr] = color;\r
 246 }\r
 247 static inline byte modexreadPixel(page_t *page, int x, int y, word addr)\r
 248 {\r
 249         /* Select the plane from which we must read the pixel color: */\r
 250         outpw(GC_INDEX, 0x04);\r
 251         outpw(GC_INDEX+1, x & 3);\r
 252         return vga_state.vga_graphics_ram[addr];\r
 253 }\r
 254 #endif\r
 255 \r
 256 void modexDrawChar(page_t *page, int x/*for planar selection only*/, word t, word col, word bgcol, word addr);\r
 257 void modexprint(page_t *page, sword x, sword y, word t, boolean tlsw, word color, word bgcolor, boolean vidsw, const byte *str);\r
 258 void modexprintbig(page_t *page, word x, word y, word t, word col, word bgcol, const byte *str);\r
 259 void VL_modexPrintTextBox(global_game_variables_t *gvar);\r
 260 void modexpdump(nibble pagenum, global_game_variables_t *gvar);\r
 261 void VL_PatternDraw(video_t *video, word pn, boolean sw, boolean allsw);\r
 262 void modexWaitBorder();\r
 263 void modexWaitBorder_start();\r
 264 void modexWaitBorder_end();\r
 265 void VL_WaitVBL(word num);\r
 266 void VL_SetLineWidth (unsigned width, global_game_variables_t *gvar);\r
 267 void VL_PrintmodexmemInfo(video_t *v);\r
 268 \r
 269 #endif\r