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