workaround for absolutely empty sprites (Nehahra s_null.spr)
[divverent/darkplaces.git] / model_sprite.c
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // models.c -- model loading and caching
21
22 // models are the only shared resource between a client and server running
23 // on the same machine.
24
25 #include "quakedef.h"
26
27 cvar_t r_mipsprites = {CVAR_SAVE, "r_mipsprites", "1"};
28
29 /*
30 ===============
31 Mod_SpriteInit
32 ===============
33 */
34 void Mod_SpriteInit (void)
35 {
36         Cvar_RegisterVariable(&r_mipsprites);
37 }
38
39 void Mod_Sprite_StripExtension(char *in, char *out)
40 {
41         char *end;
42         end = in + strlen(in);
43         if ((end - in) >= 6)
44                 if (strcmp(end - 6, ".spr32") == 0)
45                         end -= 6;
46         if ((end - in) >= 4)
47                 if (strcmp(end - 4, ".spr") == 0)
48                         end -= 4;
49         while (in < end)
50                 *out++ = *in++;
51         *out++ = 0;
52 }
53
54 void Mod_Sprite_SharedSetup(long datapointer, int version, int *palette)
55 {
56         int                                     i, j, k, groupframes, realframes, x, y, origin[2], width, height;
57         dspriteframetype_t      *pinframetype;
58         dspriteframe_t          *pinframe;
59         dspritegroup_t          *pingroup;
60         dspriteinterval_t       *pinintervals;
61         float                           modelradius, interval;
62         char                            tempname[MAX_QPATH], name[MAX_QPATH];
63         qbyte                           *pixbuf;
64         long                            startframes;
65         modelradius = 0;
66
67         Mod_Sprite_StripExtension(loadmodel->name, tempname);
68
69         if (loadmodel->numframes < 1)
70                 Host_Error ("Mod_Sprite_SharedSetup: Invalid # of frames: %d\n", loadmodel->numframes);
71
72         loadmodel->type = mod_sprite;
73         loadmodel->flags = EF_FULLBRIGHT;
74
75         // LordHavoc: hack to allow sprites to be non-fullbright
76         for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
77         {
78                 if (loadmodel->name[i] == '!')
79                 {
80                         loadmodel->flags &= ~EF_FULLBRIGHT;
81                         break;
82                 }
83         }
84
85         // LordHavoc: 32bit textures
86         if (version != SPRITE_VERSION && version != SPRITE32_VERSION && version != SPRITEHL_VERSION)
87                 Host_Error("Mod_Sprite_SharedSetup: unsupported version %i, only %i (quake), %i (HalfLife), and %i (sprite32) supported", version, SPRITE_VERSION, SPRITEHL_VERSION, SPRITE32_VERSION);
88
89 //
90 // load the frames
91 //
92         startframes = datapointer;
93         realframes = 0;
94         for (i = 0;i < loadmodel->numframes;i++)
95         {
96                 pinframetype = (dspriteframetype_t *)datapointer;
97                 datapointer += sizeof(dspriteframetype_t);
98
99                 if (LittleLong (pinframetype->type) == SPR_SINGLE)
100                         groupframes = 1;
101                 else
102                 {
103                         pingroup = (dspritegroup_t *)datapointer;
104                         datapointer += sizeof(dspritegroup_t);
105
106                         groupframes = LittleLong(pingroup->numframes);
107
108                         datapointer += sizeof(dspriteinterval_t) * groupframes;
109                 }
110
111                 for (j = 0;j < groupframes;j++)
112                 {
113                         pinframe = (dspriteframe_t *)datapointer;
114                         if (version == SPRITE32_VERSION)
115                                 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height) * 4;
116                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
117                                 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height);
118                 }
119                 realframes += groupframes;
120         }
121
122         loadmodel->animscenes = Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
123         loadmodel->sprdata_frames = Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * realframes);
124
125         datapointer = startframes;
126         realframes = 0;
127         for (i = 0;i < loadmodel->numframes;i++)
128         {
129                 pinframetype = (dspriteframetype_t *)datapointer;
130                 datapointer += sizeof(dspriteframetype_t);
131
132                 if (LittleLong (pinframetype->type) == SPR_SINGLE)
133                 {
134                         groupframes = 1;
135                         interval = 0.1f;
136                 }
137                 else
138                 {
139                         pingroup = (dspritegroup_t *)datapointer;
140                         datapointer += sizeof(dspritegroup_t);
141
142                         groupframes = LittleLong(pingroup->numframes);
143
144                         pinintervals = (dspriteinterval_t *)datapointer;
145                         datapointer += sizeof(dspriteinterval_t) * groupframes;
146
147                         interval = LittleFloat(pinintervals[0].interval);
148                         if (interval < 0.01f)
149                                 Host_Error("Mod_Sprite_SharedSetup: invalid interval");
150                 }
151
152                 sprintf(loadmodel->animscenes[i].name, "frame %i", i);
153                 loadmodel->animscenes[i].firstframe = realframes;
154                 loadmodel->animscenes[i].framecount = groupframes;
155                 loadmodel->animscenes[i].framerate = 1.0f / interval;
156                 loadmodel->animscenes[i].loop = true;
157
158                 for (j = 0;j < groupframes;j++)
159                 {
160                         pinframe = (dspriteframe_t *)datapointer;
161                         datapointer += sizeof(dspriteframe_t);
162
163                         origin[0] = LittleLong (pinframe->origin[0]);
164                         origin[1] = LittleLong (pinframe->origin[1]);
165                         width = LittleLong (pinframe->width);
166                         height = LittleLong (pinframe->height);
167
168                         loadmodel->sprdata_frames[realframes].left = origin[0];
169                         loadmodel->sprdata_frames[realframes].right = origin[0] + width;
170                         loadmodel->sprdata_frames[realframes].up = origin[1];
171                         loadmodel->sprdata_frames[realframes].down = origin[1] - height;
172
173                         x = max(loadmodel->sprdata_frames[realframes].left * loadmodel->sprdata_frames[realframes].left, loadmodel->sprdata_frames[realframes].right * loadmodel->sprdata_frames[realframes].right);
174                         y = max(loadmodel->sprdata_frames[realframes].up * loadmodel->sprdata_frames[realframes].up, loadmodel->sprdata_frames[realframes].down * loadmodel->sprdata_frames[realframes].down);
175                         if (modelradius < x + y)
176                                 modelradius = x + y;
177
178                         if (width > 0 && height > 0)
179                         {
180                                 if (groupframes > 1)
181                                         sprintf (name, "%s_%i_%i", tempname, i, j);
182                                 else
183                                         sprintf (name, "%s_%i", tempname, i);
184                                 loadmodel->sprdata_frames[realframes].texture = loadtextureimagewithmask(loadmodel->texturepool, name, 0, 0, false, r_mipsprites.integer, true);
185                                 loadmodel->sprdata_frames[realframes].fogtexture = image_masktex;
186
187                                 if (!loadmodel->sprdata_frames[realframes].texture)
188                                 {
189                                         pixbuf = Mem_Alloc(tempmempool, width*height*4);
190                                         if (version == SPRITE32_VERSION)
191                                                 memcpy(pixbuf, (qbyte *)datapointer, width*height*4);
192                                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
193                                                 Image_Copy8bitRGBA((qbyte *)datapointer, pixbuf, width*height, palette);
194
195                                         loadmodel->sprdata_frames[realframes].texture = R_LoadTexture (loadmodel->texturepool, name, width, height, pixbuf, TEXTYPE_RGBA, TEXF_ALPHA | (r_mipsprites.integer ? TEXF_MIPMAP : 0) | TEXF_PRECACHE);
196
197                                         // make fog version (just alpha)
198                                         for (k = 0;k < width*height;k++)
199                                         {
200                                                 pixbuf[k*4+0] = 255;
201                                                 pixbuf[k*4+1] = 255;
202                                                 pixbuf[k*4+2] = 255;
203                                         }
204                                         if (groupframes > 1)
205                                                 sprintf (name, "%s_%i_%ifog", tempname, i, j);
206                                         else
207                                                 sprintf (name, "%s_%ifog", tempname, i);
208                                         loadmodel->sprdata_frames[realframes].fogtexture = R_LoadTexture (loadmodel->texturepool, name, width, height, pixbuf, TEXTYPE_RGBA, TEXF_ALPHA | (r_mipsprites.integer ? TEXF_MIPMAP : 0) | TEXF_PRECACHE);
209
210                                         Mem_Free(pixbuf);
211                                 }
212                         }
213
214                         if (version == SPRITE32_VERSION)
215                                 datapointer += width * height * 4;
216                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
217                                 datapointer += width * height;
218                         realframes++;
219                 }
220         }
221
222         modelradius = sqrt(modelradius);
223         for (i = 0;i < 3;i++)
224         {
225                 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
226                 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
227         }
228 //      loadmodel->modelradius = modelradius;
229 }
230
231 void Mod_Sprite_SERAddEntity(void)
232 {
233         R_ClipSprite();
234 }
235
236
237 /*
238 =================
239 Mod_LoadSpriteModel
240 =================
241 */
242 void Mod_LoadSpriteModel (model_t *mod, void *buffer)
243 {
244         int version;
245         loadmodel->SERAddEntity = Mod_Sprite_SERAddEntity;
246         loadmodel->Draw = R_DrawSpriteModel;
247         loadmodel->DrawSky = NULL;
248         loadmodel->DrawShadow = NULL;
249
250         version = LittleLong(((dsprite_t *)buffer)->version);
251         if (version == SPRITE_VERSION || SPRITE32_VERSION)
252         {
253                 dsprite_t                       *pinsprite;
254                 long                            datapointer;
255
256                 datapointer = (long) buffer;
257
258                 pinsprite = (dsprite_t *)datapointer;
259                 datapointer += sizeof(dsprite_t);
260
261                 loadmodel->numframes = LittleLong (pinsprite->numframes);
262                 loadmodel->sprnum_type = LittleLong (pinsprite->type);
263                 loadmodel->synctype = LittleLong (pinsprite->synctype);
264
265                 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinsprite->version), d_8to24table);
266         }
267         else if (version == SPRITEHL_VERSION)
268         {
269                 int                                     i, rendermode;
270                 qbyte                           palette[256][4], *in;
271                 dspritehl_t                     *pinsprite;
272                 long                            datapointer;
273
274                 datapointer = (long) buffer;
275
276                 pinsprite = (dspritehl_t *)datapointer;
277                 datapointer += sizeof(dspritehl_t);
278
279                 loadmodel->numframes = LittleLong (pinsprite->numframes);
280                 loadmodel->sprnum_type = LittleLong (pinsprite->type);
281                 loadmodel->synctype = LittleLong (pinsprite->synctype);
282                 rendermode = pinsprite->rendermode;
283
284                 in = (qbyte *)datapointer;
285                 datapointer += 2;
286                 i = in[0] + in[1] * 256;
287                 if (i != 256)
288                         Host_Error ("Mod_LoadHLSprite: unexpected number of palette colors %i (should be 256)", i);
289                 in = (qbyte *)datapointer;
290                 datapointer += 768;
291                 switch(rendermode)
292                 {
293                 case SPRHL_NORMAL:
294                         for (i = 0;i < 255;i++)
295                         {
296                                 palette[i][0] = *in++;
297                                 palette[i][1] = *in++;
298                                 palette[i][2] = *in++;
299                                 palette[i][3] = 255;
300                         }
301                         palette[255][0] = palette[255][1] = palette[255][2] = palette[255][3] = 0;
302                         break;
303                 case SPRHL_ADDITIVE:
304                         for (i = 0;i < 256;i++)
305                         {
306                                 palette[i][0] = *in++;
307                                 palette[i][1] = *in++;
308                                 palette[i][2] = *in++;
309                                 palette[i][3] = 255;
310                         }
311         //              palette[255][0] = palette[255][1] = palette[255][2] = palette[255][3] = 0;
312                         loadmodel->flags |= EF_ADDITIVE;
313                         break;
314                 case SPRHL_INDEXALPHA:
315                         for (i = 0;i < 256;i++)
316                         {
317                                 palette[i][0] = 255;
318                                 palette[i][1] = 255;
319                                 palette[i][2] = 255;
320                                 palette[i][3] = i;
321                                 in += 3;
322                         }
323                         break;
324                 case SPRHL_ALPHATEST:
325                         for (i = 0;i < 255;i++)
326                         {
327                                 palette[i][0] = *in++;
328                                 palette[i][1] = *in++;
329                                 palette[i][2] = *in++;
330                                 palette[i][3] = 255;
331                         }
332                         palette[0][0] = palette[0][1] = palette[0][2] = palette[0][3] = 0;
333                         break;
334                 default:
335                         Host_Error("Mod_LoadHLSprite: unknown texFormat (%i, should be 0, 1, 2, or 3)\n", i);
336                         return;
337                 }
338
339                 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinsprite->version), (int *)(&palette[0][0]));
340         }
341         else
342                 Host_Error ("Mod_LoadSpriteModel: %s has wrong version number (%i should be 1 (quake) or 32 (sprite32) or 2 (halflife)", loadmodel->name, version);
343 }