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