add opengl replacement texture support (requires libpng and zlib) (d1x r1.42, r1...
[btb/d2x.git] / main / piggy.h
1 /* $Id: piggy.h,v 1.26 2004-05-22 22:24:30 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_SHARE_BIG_PIGSIZE    5092871 // v1.0 - 1.4 before RLE compression
77 #define D1_SHARE_10_PIGSIZE     2529454 // v1.0 - 1.2
78 #define D1_SHARE_PIGSIZE        2509799 // v1.4
79 #define D1_10_BIG_PIGSIZE       7640220 // v1.0 before RLE compression
80 #define D1_10_PIGSIZE           4520145 // v1.0
81 #define D1_PIGSIZE              4920305 // v1.4 - 1.5 (Incl. OEM v1.4a)
82 #define D1_OEM_PIGSIZE          5039735 // v1.0
83 #define D1_MAC_PIGSIZE          3975533
84 #define D1_MAC_SHARE_PIGSIZE    2714487
85
86 #define MAX_ALIASES 20
87
88 typedef struct alias {
89         char alias_name[FILENAME_LEN];
90         char file_name[FILENAME_LEN];
91 } alias;
92
93 extern alias alias_list[MAX_ALIASES];
94 extern int Num_aliases;
95
96 extern int Piggy_hamfile_version;
97
98 // an index into the bitmap collection of the piggy file
99 typedef struct bitmap_index {
100         ushort index;
101 } __pack__ bitmap_index;
102
103 int piggy_init();
104 void piggy_close();
105 void piggy_dump_all();
106 bitmap_index piggy_register_bitmap( grs_bitmap * bmp, char * name, int in_file );
107 int piggy_register_sound( digi_sound * snd, char * name, int in_file );
108 bitmap_index piggy_find_bitmap( char * name );
109 int piggy_find_sound( char * name );
110
111 extern int Pigfile_initialized;
112
113 void piggy_read_bitmap_data(grs_bitmap * bmp);
114 void piggy_read_sound_data(digi_sound *snd);
115
116 void piggy_load_level_data();
117
118 char* piggy_game_bitmap_name(grs_bitmap *bmp);
119
120 #define MAX_BITMAP_FILES    2620 // Upped for CD Enhanced
121 #define MAX_SOUND_FILES     MAX_SOUNDS
122
123 extern digi_sound GameSounds[MAX_SOUND_FILES];
124 extern grs_bitmap GameBitmaps[MAX_BITMAP_FILES];
125
126
127 #ifdef PIGGY_USE_PAGING
128         extern void piggy_bitmap_page_in( bitmap_index bmp );
129         extern void piggy_bitmap_page_out_all();
130         extern int piggy_page_flushed;
131
132 /* Make GNUC use static inline function as #define with backslash continuations causes problems with dos linefeeds */
133 # ifdef __GNUC__
134 #  define  PIGGY_PAGE_IN(bmp) _piggy_page_in(bmp)
135 static inline void _piggy_page_in(bitmap_index bmp) {
136     if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT ) {
137         piggy_bitmap_page_in( bmp );
138     }
139 }
140
141 # else /* __GNUC__ */
142
143         #define PIGGY_PAGE_IN(bmp)      \
144 do {                                    \
145         if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT )    {\
146                 piggy_bitmap_page_in( bmp ); \
147         }                               \
148 } while(0)
149 /*              mprintf(( 0, "Paging in '%s' from file '%s', line %d\n", #bmp, __FILE__,__LINE__ ));    \ */
150 # endif /* __GNUC__ */
151 #else
152 # define PIGGY_PAGE_IN(bmp)
153 #endif
154
155 void piggy_read_sounds();
156
157 //reads in a new pigfile (for new palette)
158 //returns the size of all the bitmap data
159 void piggy_new_pigfile(char *pigname);
160
161 //loads custom bitmaps for current level
162 void load_bitmap_replacements(char *level_name);
163 //if descent.pig exists, loads descent 1 texture bitmaps
164 void load_d1_bitmap_replacements();
165
166 #ifdef FAST_FILE_IO
167 #define bitmap_index_read(bi, fp) cfread(bi, sizeof(bitmap_index), 1, fp)
168 #define bitmap_index_read_n(bi, n, fp) cfread(bi, sizeof(bitmap_index), n, fp)
169 #else
170 /*
171  * reads a bitmap_index structure from a CFILE
172  */
173 void bitmap_index_read(bitmap_index *bi, CFILE *fp);
174
175 /*
176  * reads n bitmap_index structs from a CFILE
177  */
178 int bitmap_index_read_n(bitmap_index *bi, int n, CFILE *fp);
179 #endif // FAST_FILE_IO
180
181 /*
182  * Find and load the named bitmap from descent.pig
183  */
184 bitmap_index read_extra_bitmap_d1_pig(char *name);
185
186 #endif //_PIGGY_H