main/piggy.h

   1 /* $Id: piggy.h,v 1.20 2003-11-03 10:41:26 btb Exp $ */
   2 /*
   3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   4 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   7 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   9 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
  10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  12 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  13 */
  14
  15 /*
  16  *
  17  * Interface to piggy functions.
  18  *
  19  * Old Log:
  20  * Revision 1.1  1995/05/16  16:01:04  allender
  21  * Initial revision
  22  *
  23  * Revision 2.0  1995/02/27  11:31:21  john
  24  * New version 2.0, which has no anonymous unions, builds with
  25  * Watcom 10.0, and doesn't require parsing BITMAPS.TBL.
  26  *
  27  * Revision 1.10  1995/02/03  17:08:29  john
  28  * Changed sound stuff to allow low memory usage.
  29  * Also, changed so that Sounds isn't an array of digi_sounds, it
  30  * is a ubyte pointing into GameSounds, this way the digi.c code that
  31  * locks sounds won't accidentally unlock a sound that is already playing, but
  32  * since it's Sounds[soundno] is different, it would erroneously be unlocked.
  33  *
  34  * Revision 1.9  1995/01/24  14:33:49  john
  35  * *** empty log message ***
  36  *
  37  * Revision 1.8  1995/01/24  14:32:35  john
  38  * Took out paging in code.
  39  *
  40  * Revision 1.7  1995/01/23  12:30:17  john
  41  * Made debug code that mprintf what bitmap gets paged in.
  42  *
  43  * Revision 1.6  1995/01/17  14:11:37  john
  44  * Added function that is called after level loaded.
  45  *
  46  * Revision 1.5  1995/01/14  19:16:58  john
  47  * First version of new bitmap paging code.
  48  *
  49  * Revision 1.4  1994/10/27  18:51:57  john
  50  * Added -piglet option that only loads needed textures for a
  51  * mine.  Only saved ~1MB, and code still doesn't free textures
  52  * before you load a new mine.
  53  *
  54  * Revision 1.3  1994/06/08  14:20:47  john
  55  * Made piggy dump before going into game.
  56  *
  57  * Revision 1.2  1994/05/06  13:02:40  john
  58  * Added piggy stuff; worked on supertransparency
  59  *
  60  * Revision 1.1  1994/05/06  11:47:46  john
  61  * Initial revision
  62  *
  63  *
  64  */
  65
  66 #ifndef _PIGGY_H
  67 #define _PIGGY_H
  68
  69 #include "digi.h"
  70 #include "sounds.h"
  71 #include "inferno.h"
  72 #include "cfile.h"
  73
  74 #define D1_PIGFILE              "descent.pig"
  75
  76 #define D1_SHAREWARE_10_PIGSIZE 2529454 // v1.0 - 1.2
  77 #define D1_SHAREWARE_PIGSIZE    5092871 // v1.4 // was: 2509799
  78 #define D1_10_BIG_PIGSIZE       7640220 // v1.0 before RLE compression
  79 #define D1_10_PIGSIZE           4520145 // v1.0
  80 #define D1_PIGSIZE              4920305 // v1.4 - 1.5
  81 #define D1_OEM_PIGSIZE          5039735 // Destination: Saturn
  82 #define D1_MAC_PIGSIZE          3975533
  83 #define D1_MAC_SHARE_PIGSIZE    2714487
  84
  85 #define MAX_ALIASES 20
  86
  87 typedef struct alias {
  88         char alias_name[FILENAME_LEN];
  89         char file_name[FILENAME_LEN];
  90 } alias;
  91
  92 extern alias alias_list[MAX_ALIASES];
  93 extern int Num_aliases;
  94
  95 extern int Piggy_hamfile_version;
  96
  97 // an index into the bitmap collection of the piggy file
  98 typedef struct bitmap_index {
  99         ushort index;
 100 } __pack__ bitmap_index;
 101
 102 typedef struct DiskBitmapHeader {
 103         char name[8];
 104         ubyte dflags;                   //bits 0-5 anim frame num, bit 6 abm flag
 105         ubyte width;                    //low 8 bits here, 4 more bits in wh_extra
 106         ubyte height;                   //low 8 bits here, 4 more bits in wh_extra
 107         ubyte wh_extra;                 //bits 0-3 width, bits 4-7 height
 108         ubyte flags;
 109         ubyte avg_color;
 110         int offset;
 111 } __pack__ DiskBitmapHeader;
 112
 113 #define DISKBITMAPHEADER_SIZE 18 // for disk i/o
 114 #define DISKBITMAPHEADER_D1_SIZE 17 // for disk i/o
 115
 116 typedef struct DiskSoundHeader {
 117         char name[8];
 118         int length;
 119         int data_length;
 120         int offset;
 121 } __pack__ DiskSoundHeader;
 122
 123 #define DISKSOUNDHEADER_SIZE 20 // for disk i/o
 124
 125 int piggy_init();
 126 void piggy_close();
 127 void piggy_dump_all();
 128 bitmap_index piggy_register_bitmap( grs_bitmap * bmp, char * name, int in_file );
 129 int piggy_register_sound( digi_sound * snd, char * name, int in_file );
 130 bitmap_index piggy_find_bitmap( char * name );
 131 int piggy_find_sound( char * name );
 132
 133 extern int Pigfile_initialized;
 134
 135 void piggy_read_bitmap_data(grs_bitmap * bmp);
 136 void piggy_read_sound_data(digi_sound *snd);
 137
 138 void piggy_load_level_data();
 139
 140 #define MAX_BITMAP_FILES    2620 // Upped for CD Enhanced
 141 #define MAX_SOUND_FILES     MAX_SOUNDS
 142
 143 extern digi_sound GameSounds[MAX_SOUND_FILES];
 144 extern grs_bitmap GameBitmaps[MAX_BITMAP_FILES];
 145
 146
 147 #ifdef PIGGY_USE_PAGING
 148         extern void piggy_bitmap_page_in( bitmap_index bmp );
 149         extern void piggy_bitmap_page_out_all();
 150         extern int piggy_page_flushed;
 151
 152 /* Make GNUC use static inline function as #define with backslash continuations causes problems with dos linefeeds */
 153 # ifdef __GNUC__
 154 #  define  PIGGY_PAGE_IN(bmp) _piggy_page_in(bmp)
 155 static inline void _piggy_page_in(bitmap_index bmp) {
 156     if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT ) {
 157         piggy_bitmap_page_in( bmp );
 158     }
 159 }
 160
 161 # else /* __GNUC__ */
 162
 163         #define PIGGY_PAGE_IN(bmp)      \
 164 do {                                    \
 165         if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT )    {\
 166                 piggy_bitmap_page_in( bmp ); \
 167         }                               \
 168 } while(0)
 169 /*              mprintf(( 0, "Paging in '%s' from file '%s', line %d\n", #bmp, __FILE__,__LINE__ ));    \ */
 170 # endif /* __GNUC__ */
 171 #else
 172 # define PIGGY_PAGE_IN(bmp)
 173 #endif
 174
 175 void piggy_read_sounds();
 176
 177 //reads in a new pigfile (for new palette)
 178 //returns the size of all the bitmap data
 179 void piggy_new_pigfile(char *pigname);
 180
 181 //loads custom bitmaps for current level
 182 void load_bitmap_replacements(char *level_name);
 183 //if descent.pig exists, loads descent 1 texture bitmaps
 184 void load_d1_bitmap_replacements();
 185
 186 #ifdef FAST_FILE_IO
 187 #define bitmap_index_read(bi, fp) cfread(bi, sizeof(bitmap_index), 1, fp)
 188 #define bitmap_index_read_n(bi, n, fp) cfread(bi, sizeof(bitmap_index), n, fp)
 189 #define DiskBitmapHeader_read(dbh, fp) cfread(dbh, sizeof(DiskBitmapHeader), 1, fp)
 190 #define DiskSoundHeader_read(dsh, fp) cfread(dsh, sizeof(DiskSoundHeader), 1, fp)
 191 #else
 192 /*
 193  * reads a bitmap_index structure from a CFILE
 194  */
 195 void bitmap_index_read(bitmap_index *bi, CFILE *fp);
 196
 197 /*
 198  * reads n bitmap_index structs from a CFILE
 199  */
 200 int bitmap_index_read_n(bitmap_index *bi, int n, CFILE *fp);
 201
 202 /*
 203  * reads a DiskBitmapHeader structure from a CFILE
 204  */
 205 void DiskBitmapHeader_read(DiskBitmapHeader *dbh, CFILE *fp);
 206
 207 /*
 208  * reads a DiskSoundHeader structure from a CFILE
 209  */
 210 void DiskSoundHeader_read(DiskSoundHeader *dsh, CFILE *fp);
 211 #endif // FAST_FILE_IO
 212
 213 /*
 214  * reads a descent 1 DiskBitmapHeader structure from a CFILE
 215  */
 216 void DiskBitmapHeader_d1_read(DiskBitmapHeader *dbh, CFILE *fp);
 217
 218 /*
 219  * Find and load the named bitmap from descent.pig
 220  */
 221 bitmap_index read_extra_bitmap_d1_pig(char *name);
 222
 223 #endif //_PIGGY_H