main/piggy.h

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