1 /* -----------------------------------------------------------------------------
5 Copyright (c) 2002, Randy Reddig & seaw0lf
8 Redistribution and use in source and binary forms, with or without modification,
9 are permitted provided that the following conditions are met:
11 Redistributions of source code must retain the above copyright notice, this list
12 of conditions and the following disclaimer.
14 Redistributions in binary form must reproduce the above copyright notice, this
15 list of conditions and the following disclaimer in the documentation and/or
16 other materials provided with the distribution.
18 Neither the names of the copyright holders nor the names of its contributors may
19 be used to endorse or promote products derived from this software without
20 specific prior written permission.
22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
26 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 ----------------------------------------------------------------------------- */
41 #include "picointernal.h"
43 /* disable warnings */
45 #pragma warning( disable:4100 ) /* unref param */
49 * - loader seems stable
51 * - fix uv coordinate problem
52 * - check for buffer overflows ('bufptr' accesses)
54 /* uncomment when debugging this module */
56 #define DEBUG_PM_MS3D_EX
59 static picoColor_t white = { 255,255,255,255 };
62 #define MS3D_MAX_VERTS 8192
63 #define MS3D_MAX_TRIS 16384
64 #define MS3D_MAX_GROUPS 128
65 #define MS3D_MAX_MATERIALS 128
66 #define MS3D_MAX_JOINTS 128
67 #define MS3D_MAX_KEYFRAMES 216
70 #define MS3D_SELECTED 1
72 #define MS3D_SELECTED2 4
75 /* this freaky loader needs byte alignment */
79 typedef struct SMsHeader
87 typedef struct SMsVertex
89 unsigned char flags; /* sel, sel2, or hidden */
91 char boneID; /* -1 means 'no bone' */
92 unsigned char refCount;
97 typedef struct SMsTriangle
99 unsigned short flags; /* sel, sel2, or hidden */
100 unsigned short vertexIndices[3];
101 float vertexNormals[3][3];
104 unsigned char smoothingGroup; /* 1 - 32 */
105 unsigned char groupIndex;
110 typedef struct SMsMaterial
117 float shininess; /* range 0..128 */
118 float transparency; /* range 0..1 */
120 char texture [128]; /* texture.bmp */
121 char alphamap[128]; /* alpha.bmp */
125 // ms3d group (static part)
126 // followed by a variable size block (see below)
127 typedef struct SMsGroup
129 unsigned char flags; // sel, hidden
131 unsigned short numTriangles;
133 unsigned short triangleIndices[ numTriangles ];
134 char materialIndex; // -1 means 'no material'
140 typedef struct SMsJoint
146 float translation[3];
147 unsigned short numRotationKeyframes;
148 unsigned short numTranslationKeyframes;
153 typedef struct SMsKeyframe
160 /* restore previous data alignment */
164 * validates a milkshape3d model file.
166 static int _ms3d_canload( PM_PARAMS_CANLOAD )
168 const TMsHeader *hdr;
172 if ((size_t) bufSize < sizeof(TMsHeader))
173 return PICO_PMV_ERROR_SIZE;
175 /* get ms3d header */
176 hdr = (const TMsHeader *)buffer;
178 /* check ms3d magic */
179 if (strncmp(hdr->magic,"MS3D000000",10) != 0)
180 return PICO_PMV_ERROR_IDENT;
182 /* check ms3d version */
183 if (_pico_little_long(hdr->version) < 3 ||
184 _pico_little_long(hdr->version) > 4)
186 _pico_printf( PICO_ERROR,"MS3D file ignored. Only MS3D 1.3 and 1.4 is supported." );
187 return PICO_PMV_ERROR_VERSION;
189 /* file seems to be a valid ms3d */
193 static unsigned char *GetWord( unsigned char *bufptr, int *out )
195 if (bufptr == NULL) return NULL;
196 *out = _pico_little_short( *(unsigned short *)bufptr );
197 return( bufptr + 2 );
201 * loads a milkshape3d model file.
203 static picoModel_t *_ms3d_load( PM_PARAMS_LOAD )
206 unsigned char *bufptr, *bufptr0;
207 int shaderRefs[ MS3D_MAX_GROUPS ];
210 // unsigned char *ptrToGroups;
212 unsigned char *ptrToVerts;
214 unsigned char *ptrToTris;
217 /* create new pico model */
218 model = PicoNewModel();
219 if (model == NULL) return NULL;
222 PicoSetModelFrameNum( model, frameNum );
223 PicoSetModelName( model, fileName );
224 PicoSetModelFileName( model, fileName );
226 bufptr0 = bufptr = (picoByte_t*) _pico_alloc(bufSize);
227 memcpy(bufptr, buffer, bufSize);
229 bufptr += sizeof(TMsHeader);
231 /* get number of vertices */
232 bufptr = GetWord( bufptr,&numVerts );
236 printf("NumVertices: %d\n",numVerts);
239 for (i=0; i<numVerts; i++)
242 vertex = (TMsVertex *)bufptr;
243 bufptr += sizeof( TMsVertex );
245 vertex->xyz[ 0 ] = _pico_little_float( vertex->xyz[ 0 ] );
246 vertex->xyz[ 1 ] = _pico_little_float( vertex->xyz[ 1 ] );
247 vertex->xyz[ 2 ] = _pico_little_float( vertex->xyz[ 2 ] );
249 #ifdef DEBUG_PM_MS3D_EX_
250 printf("Vertex: x: %f y: %f z: %f\n",
256 /* get number of triangles */
257 bufptr = GetWord( bufptr,&numTris );
261 printf("NumTriangles: %d\n",numTris);
264 for (i=0; i<numTris; i++)
266 TMsTriangle *triangle;
267 triangle = (TMsTriangle *)bufptr;
268 bufptr += sizeof( TMsTriangle );
270 triangle->flags = _pico_little_short( triangle->flags );
272 /* run through all tri verts */
275 /* swap tex coords */
276 triangle->s[ k ] = _pico_little_float( triangle->s[ k ] );
277 triangle->t[ k ] = _pico_little_float( triangle->t[ k ] );
280 triangle->vertexIndices[ k ] = _pico_little_short( triangle->vertexIndices[ k ] );
281 triangle->vertexNormals[ 0 ][ k ] = _pico_little_float( triangle->vertexNormals[ 0 ][ k ] );
282 triangle->vertexNormals[ 1 ][ k ] = _pico_little_float( triangle->vertexNormals[ 1 ][ k ] );
283 triangle->vertexNormals[ 2 ][ k ] = _pico_little_float( triangle->vertexNormals[ 2 ][ k ] );
285 /* check for out of range indices */
286 if (triangle->vertexIndices[ k ] >= numVerts)
288 _pico_printf( PICO_ERROR,"Vertex %d index %d out of range (%d, max %d)",i,k,triangle->vertexIndices[k],numVerts-1);
289 PicoFreeModel( model );
291 return NULL; /* yuck */
295 /* get number of groups */
296 bufptr = GetWord( bufptr,&numGroups );
297 // ptrToGroups = bufptr;
300 printf("NumGroups: %d\n",numGroups);
302 /* run through all groups in model */
303 for (i=0; i<numGroups && i<MS3D_MAX_GROUPS; i++)
305 picoSurface_t *surface;
308 group = (TMsGroup *)bufptr;
309 bufptr += sizeof( TMsGroup );
311 /* we ignore hidden groups */
312 if (group->flags & MS3D_HIDDEN)
314 bufptr += (group->numTriangles * 2) + 1;
317 /* forced null term of group name */
318 group->name[ 31 ] = '\0';
320 /* create new pico surface */
321 surface = PicoNewSurface( model );
324 PicoFreeModel( model );
328 /* do surface setup */
329 PicoSetSurfaceType( surface,PICO_TRIANGLES );
330 PicoSetSurfaceName( surface,group->name );
332 /* process triangle indices */
333 for (k=0; k<group->numTriangles; k++)
335 TMsTriangle *triangle;
336 unsigned int triangleIndex;
338 /* get triangle index */
339 bufptr = GetWord( bufptr,(int *)&triangleIndex );
341 /* get ptr to triangle data */
342 triangle = (TMsTriangle *)(ptrToTris + (sizeof(TMsTriangle) * triangleIndex));
344 /* run through triangle vertices */
348 unsigned int vertexIndex;
351 /* get ptr to vertex data */
352 vertexIndex = triangle->vertexIndices[ m ];
353 vertex = (TMsVertex *)(ptrToVerts + (sizeof(TMsVertex) * vertexIndex));
355 /* store vertex origin */
356 PicoSetSurfaceXYZ( surface,vertexIndex,vertex->xyz );
358 /* store vertex color */
359 PicoSetSurfaceColor( surface,0,vertexIndex,white );
361 /* store vertex normal */
362 PicoSetSurfaceNormal( surface,vertexIndex,triangle->vertexNormals[ m ] );
364 /* store current face vertex index */
365 PicoSetSurfaceIndex( surface,(k * 3 + (2 - m)),(picoIndex_t)vertexIndex );
367 /* get texture vertex coord */
368 texCoord[ 0 ] = triangle->s[ m ];
369 texCoord[ 1 ] = -triangle->t[ m ]; /* flip t */
371 /* store texture vertex coord */
372 PicoSetSurfaceST( surface,0,vertexIndex,texCoord );
376 shaderRefs[ i ] = *bufptr++;
379 printf("Group %d: '%s' (%d tris)\n",i,group->name,group->numTriangles);
382 /* get number of materials */
383 bufptr = GetWord( bufptr,&numMaterials );
386 printf("NumMaterials: %d\n",numMaterials);
388 /* run through all materials in model */
389 for (i=0; i<numMaterials; i++)
391 picoShader_t *shader;
392 picoColor_t ambient,diffuse,specular;
393 TMsMaterial *material;
396 material = (TMsMaterial *)bufptr;
397 bufptr += sizeof( TMsMaterial );
399 /* null term strings */
400 material->name [ 31 ] = '\0';
401 material->texture [ 127 ] = '\0';
402 material->alphamap[ 127 ] = '\0';
405 _pico_strltrim( material->name );
406 _pico_strltrim( material->texture );
407 _pico_strltrim( material->alphamap );
410 _pico_strrtrim( material->name );
411 _pico_strrtrim( material->texture );
412 _pico_strrtrim( material->alphamap );
414 /* create new pico shader */
415 shader = PicoNewShader( model );
418 PicoFreeModel( model );
422 /* scale shader colors */
425 ambient [ k ] = (picoByte_t) (material->ambient[ k ] * 255);
426 diffuse [ k ] = (picoByte_t) (material->diffuse[ k ] * 255);
427 specular[ k ] = (picoByte_t) (material->specular[ k ] * 255);
429 /* set shader colors */
430 PicoSetShaderAmbientColor( shader,ambient );
431 PicoSetShaderDiffuseColor( shader,diffuse );
432 PicoSetShaderSpecularColor( shader,specular );
434 /* set shader transparency */
435 PicoSetShaderTransparency( shader,material->transparency );
437 /* set shader shininess (0..127) */
438 PicoSetShaderShininess( shader,material->shininess );
440 /* set shader name */
441 PicoSetShaderName( shader,material->name );
443 /* set shader texture map name */
444 PicoSetShaderMapName( shader,material->texture );
447 printf("Material %d: '%s' ('%s','%s')\n",i,material->name,material->texture,material->alphamap);
450 /* assign shaders to surfaces */
451 for (i=0; i<numGroups && i<MS3D_MAX_GROUPS; i++)
453 picoSurface_t *surface;
454 picoShader_t *shader;
457 if (shaderRefs[ i ] >= MS3D_MAX_MATERIALS ||
462 surface = PicoGetModelSurface( model,i );
463 if (surface == NULL) continue;
466 shader = PicoGetModelShader( model,shaderRefs[ i ] );
467 if (shader == NULL) continue;
470 PicoSetSurfaceShader( surface,shader );
473 printf("Mapped: %d ('%s') to %d (%s)\n",
474 shaderRefs[i],shader->name,i,surface->name);
477 /* return allocated pico model */
483 /* pico file format module definition */
484 const picoModule_t picoModuleMS3D =
486 "0.4-a", /* module version string */
487 "Milkshape 3D", /* module display name */
488 "seaw0lf", /* author's name */
489 "2002 seaw0lf", /* module copyright */
491 "ms3d",NULL,NULL,NULL /* default extensions to use */
493 _ms3d_canload, /* validation routine */
494 _ms3d_load, /* load routine */
495 NULL, /* save validation routine */
496 NULL /* save routine */