main/piggy.h

   1 /* $Id: piggy.h,v 1.16 2003-03-29 22:35:00 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 #ifndef _PIGGY_H
  16 #define _PIGGY_H
  17
  18 #include "digi.h"
  19 #include "sounds.h"
  20 #include "inferno.h"
  21 #include "cfile.h"
  22
  23 #define D1_PIGFILE              "descent.pig"
  24
  25 #define D1_SHAREWARE_10_PIGSIZE 2529454 // v1.0 - 1.2
  26 #define D1_SHAREWARE_PIGSIZE    2509799 // v1.4
  27 #define D1_PIGSIZE              4920305
  28 #define D1_OEM_PIGSIZE          5039735 // Destination: Saturn
  29 #define D1_MAC_PIGSIZE          3975533
  30 #define D1_MAC_SHARE_PIGSIZE    2714487
  31
  32 #define MAX_ALIASES 20
  33
  34 typedef struct alias {
  35         char alias_name[FILENAME_LEN];
  36         char file_name[FILENAME_LEN];
  37 } alias;
  38
  39 extern alias alias_list[MAX_ALIASES];
  40 extern int Num_aliases;
  41
  42 extern int Piggy_hamfile_version;
  43
  44 // an index into the bitmap collection of the piggy file
  45 typedef struct bitmap_index {
  46         ushort index;
  47 } __pack__ bitmap_index;
  48
  49 typedef struct DiskBitmapHeader {
  50         char name[8];
  51         ubyte dflags;                   //bits 0-5 anim frame num, bit 6 abm flag
  52         ubyte width;                    //low 8 bits here, 4 more bits in wh_extra
  53         ubyte height;                   //low 8 bits here, 4 more bits in wh_extra
  54         ubyte wh_extra;                 //bits 0-3 width, bits 4-7 height
  55         ubyte flags;
  56         ubyte avg_color;
  57         int offset;
  58 } __pack__ DiskBitmapHeader;
  59
  60 #define DISKBITMAPHEADER_SIZE 18 // for disk i/o
  61 #define DISKBITMAPHEADER_D1_SIZE 17 // for disk i/o
  62
  63 typedef struct DiskSoundHeader {
  64         char name[8];
  65         int length;
  66         int data_length;
  67         int offset;
  68 } __pack__ DiskSoundHeader;
  69
  70 #define DISKSOUNDHEADER_SIZE 20 // for disk i/o
  71
  72 int piggy_init();
  73 void piggy_close();
  74 void piggy_dump_all();
  75 bitmap_index piggy_register_bitmap( grs_bitmap * bmp, char * name, int in_file );
  76 int piggy_register_sound( digi_sound * snd, char * name, int in_file );
  77 bitmap_index piggy_find_bitmap( char * name );
  78 int piggy_find_sound( char * name );
  79
  80 extern int Pigfile_initialized;
  81
  82 void piggy_read_bitmap_data(grs_bitmap * bmp);
  83 void piggy_read_sound_data(digi_sound *snd);
  84
  85 void piggy_load_level_data();
  86
  87 #define MAX_BITMAP_FILES    2620 // Upped for CD Enhanced
  88 #define MAX_SOUND_FILES     MAX_SOUNDS
  89
  90 extern digi_sound GameSounds[MAX_SOUND_FILES];
  91 extern grs_bitmap GameBitmaps[MAX_BITMAP_FILES];
  92
  93
  94 #ifdef PIGGY_USE_PAGING
  95         extern void piggy_bitmap_page_in( bitmap_index bmp );
  96         extern void piggy_bitmap_page_out_all();
  97         extern int piggy_page_flushed;
  98
  99 /* Make GNUC use static inline function as #define with backslash continuations causes problems with dos linefeeds */
 100 # ifdef __GNUC__
 101 #  define  PIGGY_PAGE_IN(bmp) _piggy_page_in(bmp)
 102 static inline void _piggy_page_in(bitmap_index bmp) {
 103     if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT ) {
 104         piggy_bitmap_page_in( bmp );
 105     }
 106 }
 107
 108 # else /* __GNUC__ */
 109
 110         #define PIGGY_PAGE_IN(bmp)      \
 111 do {                                    \
 112         if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT )    {\
 113                 piggy_bitmap_page_in( bmp ); \
 114         }                               \
 115 } while(0)
 116 /*              mprintf(( 0, "Paging in '%s' from file '%s', line %d\n", #bmp, __FILE__,__LINE__ ));    \ */
 117 # endif /* __GNUC__ */
 118 #else
 119 # define PIGGY_PAGE_IN(bmp)
 120 #endif
 121
 122 void piggy_read_sounds();
 123
 124 //reads in a new pigfile (for new palette)
 125 //returns the size of all the bitmap data
 126 void piggy_new_pigfile(char *pigname);
 127
 128 //loads custom bitmaps for current level
 129 void load_bitmap_replacements(char *level_name);
 130 //if descent.pig exists, loads descent 1 texture bitmaps
 131 void load_d1_bitmap_replacements();
 132
 133 #ifdef FAST_FILE_IO
 134 #define bitmap_index_read(bi, fp) cfread(bi, sizeof(bitmap_index), 1, fp)
 135 #define bitmap_index_read_n(bi, n, fp) cfread(bi, sizeof(bitmap_index), n, fp)
 136 #define DiskBitmapHeader_read(dbh, fp) cfread(dbh, sizeof(DiskBitmapHeader), 1, fp)
 137 #define DiskSoundHeader_read(dsh, fp) cfread(dsh, sizeof(DiskSoundHeader), 1, fp)
 138 #else
 139 /*
 140  * reads a bitmap_index structure from a CFILE
 141  */
 142 void bitmap_index_read(bitmap_index *bi, CFILE *fp);
 143
 144 /*
 145  * reads n bitmap_index structs from a CFILE
 146  */
 147 int bitmap_index_read_n(bitmap_index *bi, int n, CFILE *fp);
 148
 149 /*
 150  * reads a DiskBitmapHeader structure from a CFILE
 151  */
 152 void DiskBitmapHeader_read(DiskBitmapHeader *dbh, CFILE *fp);
 153
 154 /*
 155  * reads a DiskSoundHeader structure from a CFILE
 156  */
 157 void DiskSoundHeader_read(DiskSoundHeader *dsh, CFILE *fp);
 158 #endif // FAST_FILE_IO
 159
 160 /*
 161  * reads a descent 1 DiskBitmapHeader structure from a CFILE
 162  */
 163 void DiskBitmapHeader_d1_read(DiskBitmapHeader *dbh, CFILE *fp);
 164
 165 /*
 166  * Find and load the named bitmap from descent.pig
 167  */
 168 bitmap_index read_extra_bitmap_d1_pig(char *name);
 169
 170 #endif //_PIGGY_H