main/piggy.h

   1 /*
   2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
   9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  11 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  12 */
  13
  14 /*
  15  *
  16  * Interface to piggy functions.
  17  *
  18  */
  19
  20 #ifndef _PIGGY_H
  21 #define _PIGGY_H
  22
  23 #include "digi.h"
  24 #include "sounds.h"
  25 #include "cfile.h"
  26
  27 #define D1_PIGFILE              "descent.pig"
  28
  29 #define D1_SHARE_BIG_PIGSIZE    5092871 // v1.0 - 1.4 before RLE compression
  30 #define D1_SHARE_10_PIGSIZE     2529454 // v1.0 - 1.2
  31 #define D1_SHARE_PIGSIZE        2509799 // v1.4
  32 #define D1_10_BIG_PIGSIZE       7640220 // v1.0 before RLE compression
  33 #define D1_10_PIGSIZE           4520145 // v1.0
  34 #define D1_PIGSIZE              4920305 // v1.4 - 1.5 (Incl. OEM v1.4a)
  35 #define D1_OEM_PIGSIZE          5039735 // v1.0
  36 #define D1_MAC_PIGSIZE          3975533
  37 #define D1_MAC_SHARE_PIGSIZE    2714487
  38
  39 #define MAX_ALIASES 20
  40
  41 typedef struct alias {
  42         char alias_name[FILENAME_LEN];
  43         char file_name[FILENAME_LEN];
  44 } alias;
  45
  46 extern alias alias_list[MAX_ALIASES];
  47 extern int Num_aliases;
  48
  49 extern int Piggy_hamfile_version;
  50
  51 // an index into the bitmap collection of the piggy file
  52 typedef struct bitmap_index {
  53         ushort index;
  54 } __pack__ bitmap_index;
  55
  56 int piggy_init();
  57 void piggy_close();
  58 void piggy_dump_all();
  59 bitmap_index piggy_register_bitmap( grs_bitmap * bmp, char * name, int in_file );
  60 int piggy_register_sound( digi_sound * snd, char * name, int in_file );
  61 bitmap_index piggy_find_bitmap( char * name );
  62 int piggy_find_sound( char * name );
  63
  64 extern int Pigfile_initialized;
  65
  66 void piggy_read_bitmap_data(grs_bitmap * bmp);
  67 void piggy_read_sound_data(digi_sound *snd);
  68
  69 void piggy_load_level_data();
  70
  71 char* piggy_game_bitmap_name(grs_bitmap *bmp);
  72
  73 #define MAX_BITMAP_FILES    2620 // Upped for CD Enhanced
  74 #define MAX_SOUND_FILES     MAX_SOUNDS
  75
  76 extern digi_sound GameSounds[MAX_SOUND_FILES];
  77 extern grs_bitmap GameBitmaps[MAX_BITMAP_FILES];
  78
  79
  80 #ifdef PIGGY_USE_PAGING
  81         extern void piggy_bitmap_page_in( bitmap_index bmp );
  82         extern void piggy_bitmap_page_out_all();
  83         extern int piggy_page_flushed;
  84
  85 /* Make GNUC use static inline function as #define with backslash continuations causes problems with dos linefeeds */
  86 # ifdef __GNUC__
  87 #  define  PIGGY_PAGE_IN(bmp) _piggy_page_in(bmp)
  88 static inline void _piggy_page_in(bitmap_index bmp) {
  89     if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT ) {
  90         piggy_bitmap_page_in( bmp );
  91     }
  92 }
  93
  94 # else /* __GNUC__ */
  95
  96         #define PIGGY_PAGE_IN(bmp)      \
  97 do {                                    \
  98         if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT )    {\
  99                 piggy_bitmap_page_in( bmp ); \
 100         }                               \
 101 } while(0)
 102 /*              mprintf(( 0, "Paging in '%s' from file '%s', line %d\n", #bmp, __FILE__,__LINE__ ));    \ */
 103 # endif /* __GNUC__ */
 104 #else
 105 # define PIGGY_PAGE_IN(bmp)
 106 #endif
 107
 108 void piggy_read_sounds();
 109
 110 //reads in a new pigfile (for new palette)
 111 //returns the size of all the bitmap data
 112 void piggy_new_pigfile(char *pigname);
 113
 114 //loads custom bitmaps for current level
 115 void load_bitmap_replacements(char *level_name);
 116 //if descent.pig exists, loads descent 1 texture bitmaps
 117 void load_d1_bitmap_replacements();
 118
 119 #ifdef FAST_FILE_IO
 120 #define bitmap_index_read(bi, fp) cfread(bi, sizeof(bitmap_index), 1, fp)
 121 #define bitmap_index_read_n(bi, n, fp) cfread(bi, sizeof(bitmap_index), n, fp)
 122 #else
 123 /*
 124  * reads a bitmap_index structure from a CFILE
 125  */
 126 void bitmap_index_read(bitmap_index *bi, CFILE *fp);
 127
 128 /*
 129  * reads n bitmap_index structs from a CFILE
 130  */
 131 int bitmap_index_read_n(bitmap_index *bi, int n, CFILE *fp);
 132 #endif // FAST_FILE_IO
 133
 134 /*
 135  * Find and load the named bitmap from descent.pig
 136  */
 137 bitmap_index read_extra_bitmap_d1_pig(char *name);
 138
 139 #endif //_PIGGY_H