]> icculus.org git repositories - divverent/darkplaces.git/blob - model_sprite.c
DP_QC_EXTRESPONSEPACKET - getextresponse() function now also in csqc and svqc (same...
[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 #include "image.h"
27
28 cvar_t r_mipsprites = {CVAR_SAVE, "r_mipsprites", "1", "mipmaps sprites so they render faster in the distance and do not display noise artifacts"};
29 cvar_t r_picmipsprites = {CVAR_SAVE, "r_picmipsprites", "1", "make gl_picmip affect sprites too (saves some graphics memory in sprite heavy games)"};
30 cvar_t r_labelsprites_scale = {CVAR_SAVE, "r_labelsprites_scale", "1", "global scale to apply to label sprites before conversion to HUD coordinates"};
31 cvar_t r_labelsprites_roundtopixels = {CVAR_SAVE, "r_labelsprites_roundtopixels", "1", "try to make label sprites sharper by rounding their size to 0.5x or 1x and by rounding their position to whole pixels if possible"};
32
33 /*
34 ===============
35 Mod_SpriteInit
36 ===============
37 */
38 void Mod_SpriteInit (void)
39 {
40         Cvar_RegisterVariable(&r_mipsprites);
41         Cvar_RegisterVariable(&r_picmipsprites);
42         Cvar_RegisterVariable(&r_labelsprites_scale);
43         Cvar_RegisterVariable(&r_labelsprites_roundtopixels);
44 }
45
46 static void Mod_SpriteSetupTexture(texture_t *texture, skinframe_t *skinframe, qboolean fullbright, qboolean additive)
47 {
48         if (!skinframe)
49                 skinframe = R_SkinFrame_LoadMissing();
50         texture->basematerialflags = MATERIALFLAG_WALL;
51         if (fullbright)
52                 texture->basematerialflags |= MATERIALFLAG_FULLBRIGHT;
53         if (additive)
54                 texture->basematerialflags |= MATERIALFLAG_ADD | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
55         else if (skinframe->fog)
56                 texture->basematerialflags |= MATERIALFLAG_ALPHA | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
57         texture->currentmaterialflags = texture->basematerialflags;
58         texture->numskinframes = 1;
59         texture->currentskinframe = texture->skinframes[0] = skinframe;
60 }
61
62 static void Mod_Sprite_SharedSetup(const unsigned char *datapointer, int version, const unsigned int *palette, qboolean additive)
63 {
64         int                                     i, j, groupframes, realframes, x, y, origin[2], width, height, fullbright;
65         dspriteframetype_t      *pinframetype;
66         dspriteframe_t          *pinframe;
67         dspritegroup_t          *pingroup;
68         dspriteinterval_t       *pinintervals;
69         skinframe_t                     *skinframe;
70         float                           modelradius, interval;
71         char                            name[MAX_QPATH], fogname[MAX_QPATH];
72         const void                      *startframes;
73         int                 texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | (r_picmipsprites.integer ? TEXF_PICMIP : 0) | TEXF_ALPHA | TEXF_CLAMP | TEXF_PRECACHE;
74         modelradius = 0;
75
76         if (loadmodel->numframes < 1)
77                 Host_Error ("Mod_Sprite_SharedSetup: Invalid # of frames: %d", loadmodel->numframes);
78
79         // LordHavoc: hack to allow sprites to be non-fullbright
80         fullbright = true;
81         for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
82                 if (loadmodel->name[i] == '!')
83                         fullbright = false;
84
85 //
86 // load the frames
87 //
88         startframes = datapointer;
89         realframes = 0;
90         for (i = 0;i < loadmodel->numframes;i++)
91         {
92                 pinframetype = (dspriteframetype_t *)datapointer;
93                 datapointer += sizeof(dspriteframetype_t);
94
95                 if (LittleLong (pinframetype->type) == SPR_SINGLE)
96                         groupframes = 1;
97                 else
98                 {
99                         pingroup = (dspritegroup_t *)datapointer;
100                         datapointer += sizeof(dspritegroup_t);
101
102                         groupframes = LittleLong(pingroup->numframes);
103
104                         datapointer += sizeof(dspriteinterval_t) * groupframes;
105                 }
106
107                 for (j = 0;j < groupframes;j++)
108                 {
109                         pinframe = (dspriteframe_t *)datapointer;
110                         if (version == SPRITE32_VERSION)
111                                 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height) * 4;
112                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
113                                 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height);
114                 }
115                 realframes += groupframes;
116         }
117
118         loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
119         loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * realframes);
120         loadmodel->num_textures = realframes;
121         loadmodel->num_texturesperskin = 1;
122         loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
123
124         datapointer = (unsigned char *)startframes;
125         realframes = 0;
126         for (i = 0;i < loadmodel->numframes;i++)
127         {
128                 pinframetype = (dspriteframetype_t *)datapointer;
129                 datapointer += sizeof(dspriteframetype_t);
130
131                 if (LittleLong (pinframetype->type) == SPR_SINGLE)
132                 {
133                         groupframes = 1;
134                         interval = 0.1f;
135                 }
136                 else
137                 {
138                         pingroup = (dspritegroup_t *)datapointer;
139                         datapointer += sizeof(dspritegroup_t);
140
141                         groupframes = LittleLong(pingroup->numframes);
142
143                         pinintervals = (dspriteinterval_t *)datapointer;
144                         datapointer += sizeof(dspriteinterval_t) * groupframes;
145
146                         interval = LittleFloat(pinintervals[0].interval);
147                         if (interval < 0.01f)
148                                 Host_Error("Mod_Sprite_SharedSetup: invalid interval");
149                 }
150
151                 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
152                 loadmodel->animscenes[i].firstframe = realframes;
153                 loadmodel->animscenes[i].framecount = groupframes;
154                 loadmodel->animscenes[i].framerate = 1.0f / interval;
155                 loadmodel->animscenes[i].loop = true;
156
157                 for (j = 0;j < groupframes;j++)
158                 {
159                         pinframe = (dspriteframe_t *)datapointer;
160                         datapointer += sizeof(dspriteframe_t);
161
162                         origin[0] = LittleLong (pinframe->origin[0]);
163                         origin[1] = LittleLong (pinframe->origin[1]);
164                         width = LittleLong (pinframe->width);
165                         height = LittleLong (pinframe->height);
166
167                         loadmodel->sprite.sprdata_frames[realframes].left = origin[0];
168                         loadmodel->sprite.sprdata_frames[realframes].right = origin[0] + width;
169                         loadmodel->sprite.sprdata_frames[realframes].up = origin[1];
170                         loadmodel->sprite.sprdata_frames[realframes].down = origin[1] - height;
171
172                         x = (int)max(loadmodel->sprite.sprdata_frames[realframes].left * loadmodel->sprite.sprdata_frames[realframes].left, loadmodel->sprite.sprdata_frames[realframes].right * loadmodel->sprite.sprdata_frames[realframes].right);
173                         y = (int)max(loadmodel->sprite.sprdata_frames[realframes].up * loadmodel->sprite.sprdata_frames[realframes].up, loadmodel->sprite.sprdata_frames[realframes].down * loadmodel->sprite.sprdata_frames[realframes].down);
174                         if (modelradius < x + y)
175                                 modelradius = x + y;
176
177                         if (cls.state != ca_dedicated)
178                         {
179                                 skinframe = NULL;
180                                 // note: Nehahra's null.spr has width == 0 and height == 0
181                                 if (width > 0 && height > 0)
182                                 {
183                                         if (groupframes > 1)
184                                         {
185                                                 dpsnprintf (name, sizeof(name), "%s_%i_%i", loadmodel->name, i, j);
186                                                 dpsnprintf (fogname, sizeof(fogname), "%s_%i_%ifog", loadmodel->name, i, j);
187                                         }
188                                         else
189                                         {
190                                                 dpsnprintf (name, sizeof(name), "%s_%i", loadmodel->name, i);
191                                                 dpsnprintf (fogname, sizeof(fogname), "%s_%ifog", loadmodel->name, i);
192                                         }
193                                         if (!(skinframe = R_SkinFrame_LoadExternal(name, texflags | TEXF_COMPRESS, false)))
194                                         {
195                                                 unsigned char *pixels = (unsigned char *) Mem_Alloc(loadmodel->mempool, width*height*4);
196                                                 if (version == SPRITE32_VERSION)
197                                                 {
198                                                         for (x = 0;x < width*height;x++)
199                                                         {
200                                                                 pixels[x*4+2] = datapointer[x*4+0];
201                                                                 pixels[x*4+1] = datapointer[x*4+1];
202                                                                 pixels[x*4+0] = datapointer[x*4+2];
203                                                                 pixels[x*4+3] = datapointer[x*4+3];
204                                                         }
205                                                 }
206                                                 else //if (version == SPRITEHL_VERSION || version == SPRITE_VERSION)
207                                                         Image_Copy8bitBGRA(datapointer, pixels, width*height, palette ? palette : palette_bgra_transparent);
208                                                 skinframe = R_SkinFrame_LoadInternalBGRA(name, texflags, pixels, width, height);
209                                                 Mem_Free(pixels);
210                                         }
211                                 }
212                                 if (skinframe == NULL)
213                                         skinframe = R_SkinFrame_LoadMissing();
214                                 Mod_SpriteSetupTexture(&loadmodel->data_textures[realframes], skinframe, fullbright, additive);
215                         }
216
217                         if (version == SPRITE32_VERSION)
218                                 datapointer += width * height * 4;
219                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
220                                 datapointer += width * height;
221                         realframes++;
222                 }
223         }
224
225         modelradius = sqrt(modelradius);
226         for (i = 0;i < 3;i++)
227         {
228                 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
229                 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
230         }
231         loadmodel->radius = modelradius;
232         loadmodel->radius2 = modelradius * modelradius;
233 }
234
235 extern void R_Model_Sprite_Draw(entity_render_t *ent);
236 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend)
237 {
238         int version;
239         const unsigned char *datapointer;
240
241         datapointer = (unsigned char *)buffer;
242
243         loadmodel->modeldatatypestring = "SPR1";
244
245         loadmodel->type = mod_sprite;
246
247         loadmodel->DrawSky = NULL;
248         loadmodel->Draw = R_Model_Sprite_Draw;
249         loadmodel->DrawDepth = NULL;
250         loadmodel->CompileShadowVolume = NULL;
251         loadmodel->DrawShadowVolume = NULL;
252         loadmodel->DrawLight = NULL;
253         loadmodel->DrawAddWaterPlanes = NULL;
254
255         version = LittleLong(((dsprite_t *)buffer)->version);
256         if (version == SPRITE_VERSION || version == SPRITE32_VERSION)
257         {
258                 dsprite_t *pinqsprite;
259
260                 pinqsprite = (dsprite_t *)datapointer;
261                 datapointer += sizeof(dsprite_t);
262
263                 loadmodel->numframes = LittleLong (pinqsprite->numframes);
264                 loadmodel->sprite.sprnum_type = LittleLong (pinqsprite->type);
265                 loadmodel->synctype = (synctype_t)LittleLong (pinqsprite->synctype);
266
267                 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinqsprite->version), NULL, false);
268         }
269         else if (version == SPRITEHL_VERSION)
270         {
271                 int i, rendermode;
272                 unsigned char palette[256][4];
273                 const unsigned char *in;
274                 dspritehl_t *pinhlsprite;
275
276                 pinhlsprite = (dspritehl_t *)datapointer;
277                 datapointer += sizeof(dspritehl_t);
278
279                 loadmodel->numframes = LittleLong (pinhlsprite->numframes);
280                 loadmodel->sprite.sprnum_type = LittleLong (pinhlsprite->type);
281                 loadmodel->synctype = (synctype_t)LittleLong (pinhlsprite->synctype);
282                 rendermode = pinhlsprite->rendermode;
283
284                 in = datapointer;
285                 datapointer += 2;
286                 i = in[0] + in[1] * 256;
287                 if (i != 256)
288                         Host_Error ("Mod_IDSP_Load: unexpected number of palette colors %i (should be 256)", i);
289                 in = datapointer;
290                 datapointer += 768;
291                 switch(rendermode)
292                 {
293                 case SPRHL_OPAQUE:
294                         for (i = 0;i < 256;i++)
295                         {
296                                 palette[i][2] = in[i*3+0];
297                                 palette[i][1] = in[i*3+1];
298                                 palette[i][0] = in[i*3+2];
299                                 palette[i][3] = 255;
300                         }
301                         break;
302                 case SPRHL_ADDITIVE:
303                         for (i = 0;i < 256;i++)
304                         {
305                                 palette[i][2] = in[i*3+0];
306                                 palette[i][1] = in[i*3+1];
307                                 palette[i][0] = in[i*3+2];
308                                 palette[i][3] = 255;
309                         }
310                         // also passes additive == true to Mod_Sprite_SharedSetup
311                         break;
312                 case SPRHL_INDEXALPHA:
313                         for (i = 0;i < 256;i++)
314                         {
315                                 palette[i][2] = in[765];
316                                 palette[i][1] = in[766];
317                                 palette[i][0] = in[767];
318                                 palette[i][3] = i;
319                                 in += 3;
320                         }
321                         break;
322                 case SPRHL_ALPHATEST:
323                         for (i = 0;i < 256;i++)
324                         {
325                                 palette[i][2] = in[i*3+0];
326                                 palette[i][1] = in[i*3+1];
327                                 palette[i][0] = in[i*3+2];
328                                 palette[i][3] = 255;
329                         }
330                         palette[255][0] = palette[255][1] = palette[255][2] = palette[255][3] = 0;
331                         // should this use alpha test or alpha blend?  (currently blend)
332                         break;
333                 default:
334                         Host_Error("Mod_IDSP_Load: unknown texFormat (%i, should be 0, 1, 2, or 3)", i);
335                         return;
336                 }
337
338                 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinhlsprite->version), (unsigned int *)(&palette[0][0]), rendermode == SPRHL_ADDITIVE);
339         }
340         else
341                 Host_Error("Mod_IDSP_Load: %s has wrong version number (%i). Only %i (quake), %i (HalfLife), and %i (sprite32) supported",
342                                         loadmodel->name, version, SPRITE_VERSION, SPRITEHL_VERSION, SPRITE32_VERSION);
343
344         loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || loadmodel->animscenes[0].framecount > 1;
345 }
346
347
348 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend)
349 {
350         int i, version, fullbright;
351         const dsprite2_t *pinqsprite;
352         skinframe_t *skinframe;
353         float modelradius;
354         int texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | (r_picmipsprites.integer ? TEXF_PICMIP : 0) | TEXF_COMPRESS | TEXF_ALPHA | TEXF_CLAMP | TEXF_PRECACHE;
355
356         loadmodel->modeldatatypestring = "SPR2";
357
358         loadmodel->type = mod_sprite;
359
360         loadmodel->DrawSky = NULL;
361         loadmodel->Draw = R_Model_Sprite_Draw;
362         loadmodel->DrawDepth = NULL;
363         loadmodel->CompileShadowVolume = NULL;
364         loadmodel->DrawShadowVolume = NULL;
365         loadmodel->DrawLight = NULL;
366         loadmodel->DrawAddWaterPlanes = NULL;
367
368         pinqsprite = (dsprite2_t *)buffer;
369
370         version = LittleLong(pinqsprite->version);
371         if (version != SPRITE2_VERSION)
372                 Host_Error("Mod_IDS2_Load: %s has wrong version number (%i should be 2 (quake 2)", loadmodel->name, version);
373
374         loadmodel->numframes = LittleLong (pinqsprite->numframes);
375         if (loadmodel->numframes < 1)
376                 Host_Error ("Mod_IDS2_Load: Invalid # of frames: %d", loadmodel->numframes);
377         loadmodel->sprite.sprnum_type = SPR_VP_PARALLEL;
378         loadmodel->synctype = ST_SYNC;
379
380         // LordHavoc: hack to allow sprites to be non-fullbright
381         fullbright = true;
382         for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
383                 if (loadmodel->name[i] == '!')
384                         fullbright = false;
385
386         loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
387         loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * loadmodel->numframes);
388         loadmodel->num_textures = loadmodel->numframes;
389         loadmodel->num_texturesperskin = 1;
390         loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
391
392         modelradius = 0;
393         for (i = 0;i < loadmodel->numframes;i++)
394         {
395                 int origin[2], x, y, width, height;
396                 const dsprite2frame_t *pinframe;
397                 mspriteframe_t *sprframe;
398
399                 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
400                 loadmodel->animscenes[i].firstframe = i;
401                 loadmodel->animscenes[i].framecount = 1;
402                 loadmodel->animscenes[i].framerate = 10;
403                 loadmodel->animscenes[i].loop = true;
404
405                 pinframe = &pinqsprite->frames[i];
406
407                 origin[0] = LittleLong (pinframe->origin_x);
408                 origin[1] = LittleLong (pinframe->origin_y);
409                 width = LittleLong (pinframe->width);
410                 height = LittleLong (pinframe->height);
411
412                 sprframe = &loadmodel->sprite.sprdata_frames[i];
413
414                 // note that sp2 origin[0] is positive, where as it is negative in
415                 // spr/spr32/hlspr
416                 sprframe->left = -origin[0];
417                 sprframe->right = -origin[0] + width;
418                 sprframe->up = origin[1];
419                 sprframe->down = origin[1] - height;
420
421                 x = (int)max(sprframe->left * sprframe->left, sprframe->right * sprframe->right);
422                 y = (int)max(sprframe->up * sprframe->up, sprframe->down * sprframe->down);
423                 if (modelradius < x + y)
424                         modelradius = x + y;
425         }
426
427         if (cls.state != ca_dedicated)
428         {
429                 for (i = 0;i < loadmodel->numframes;i++)
430                 {
431                         const dsprite2frame_t *pinframe;
432                         pinframe = &pinqsprite->frames[i];
433                         if (!(skinframe = R_SkinFrame_LoadExternal(pinframe->name, texflags, false)))
434                         {
435                                 Con_Printf("Mod_IDS2_Load: failed to load %s", pinframe->name);
436                                 skinframe = R_SkinFrame_LoadMissing();
437                         }
438                         Mod_SpriteSetupTexture(&loadmodel->data_textures[i], skinframe, fullbright, false);
439                 }
440         }
441
442         modelradius = sqrt(modelradius);
443         for (i = 0;i < 3;i++)
444         {
445                 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
446                 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
447         }
448         loadmodel->radius = modelradius;
449         loadmodel->radius2 = modelradius * modelradius;
450
451         loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || loadmodel->animscenes[0].framecount > 1;
452 }