whitespace
[btb/d2x.git] / main / piggy.h
1 /* $Id: piggy.h,v 1.10 2002-08-27 04:14:58 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 typedef struct bitmap_index {
36         ushort index;
37 } __pack__ bitmap_index;
38
39 typedef struct DiskBitmapHeader {
40         char name[8];
41         ubyte dflags;                   //bits 0-5 anim frame num, bit 6 abm flag
42         ubyte width;                    //low 8 bits here, 4 more bits in wh_extra
43         ubyte height;                   //low 8 bits here, 4 more bits in wh_extra
44         ubyte wh_extra;                 //bits 0-3 width, bits 4-7 height
45         ubyte flags;
46         ubyte avg_color;
47         int offset;
48 } __pack__ DiskBitmapHeader;
49
50 #define DISKBITMAPHEADER_SIZE 18 // for disk i/o
51
52 typedef struct DiskSoundHeader {
53         char name[8];
54         int length;
55         int data_length;
56         int offset;
57 } __pack__ DiskSoundHeader;
58
59 #define DISKSOUNDHEADER_SIZE 20 // for disk i/o
60
61 int piggy_init();
62 void piggy_close();
63 void piggy_dump_all();
64 bitmap_index piggy_register_bitmap( grs_bitmap * bmp, char * name, int in_file );
65 int piggy_register_sound( digi_sound * snd, char * name, int in_file );
66 bitmap_index piggy_find_bitmap( char * name );
67 int piggy_find_sound( char * name );
68
69 extern int Pigfile_initialized;
70
71 void piggy_read_bitmap_data(grs_bitmap * bmp);
72 void piggy_read_sound_data(digi_sound *snd);
73
74 void piggy_load_level_data();
75
76 #define MAX_BITMAP_FILES    2620 // Upped for CD Enhanced
77 #define MAX_SOUND_FILES     MAX_SOUNDS
78
79 extern digi_sound GameSounds[MAX_SOUND_FILES];
80 extern grs_bitmap GameBitmaps[MAX_BITMAP_FILES];
81
82
83 #ifdef PIGGY_USE_PAGING
84         extern void piggy_bitmap_page_in( bitmap_index bmp );
85         extern void piggy_bitmap_page_out_all();
86         extern int piggy_page_flushed;
87
88 /* Make GNUC use static inline function as #define with backslash continuations causes problems with dos linefeeds */
89 # ifdef __GNUC__
90 #  define  PIGGY_PAGE_IN(bmp) _piggy_page_in(bmp)
91 static inline void _piggy_page_in(bitmap_index bmp) {
92     if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT ) {
93         piggy_bitmap_page_in( bmp );
94     }
95 }
96
97 # else /* __GNUC__ */
98
99         #define PIGGY_PAGE_IN(bmp)      \
100 do {                                    \
101         if ( GameBitmaps[(bmp).index].bm_flags & BM_FLAG_PAGED_OUT )    {\
102                 piggy_bitmap_page_in( bmp ); \
103         }                               \
104 } while(0)
105 /*              mprintf(( 0, "Paging in '%s' from file '%s', line %d\n", #bmp, __FILE__,__LINE__ ));    \ */
106 # endif /* __GNUC__ */
107 #else
108 # define PIGGY_PAGE_IN(bmp)
109 #endif
110
111 void piggy_read_sounds();
112
113 //reads in a new pigfile (for new palette)
114 //returns the size of all the bitmap data
115 void piggy_new_pigfile(char *pigname);
116
117 #ifdef FAST_FILE_IO
118 #define bitmap_index_read(bi, fp) cfread(bi, sizeof(bitmap_index), 1, fp)
119 #define bitmap_index_read_n(bi, n, fp) cfread(bi, sizeof(bitmap_index), n, fp)
120 #define DiskBitmapHeader_read(dbh, fp) cfread(dbh, sizeof(DiskBitmapHeader), 1, fp)
121 #define DiskSoundHeader_read(dsh, fp) cfread(dsh, sizeof(DiskSoundHeader), 1, 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
133 /*
134  * reads a DiskBitmapHeader structure from a CFILE
135  */
136 void DiskBitmapHeader_read(DiskBitmapHeader *dbh, CFILE *fp);
137
138 /*
139  * reads a DiskSoundHeader structure from a CFILE
140  */
141 void DiskSoundHeader_read(DiskSoundHeader *dsh, CFILE *fp);
142 #endif
143
144 #endif