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 ----------------------------------------------------------------------------- */
36 #include "picointernal.h"
39 /* uncomment when debugging this module */
40 /*#define DEBUG_PM_LWO*/
46 /* helper functions */
47 static const char *lwo_lwIDToStr( unsigned int lwID ){
48 static char lwIDStr[5];
54 lwIDStr[ 0 ] = (char)( ( lwID ) >> 24 );
55 lwIDStr[ 1 ] = (char)( ( lwID ) >> 16 );
56 lwIDStr[ 2 ] = (char)( ( lwID ) >> 8 );
57 lwIDStr[ 3 ] = (char)( ( lwID ) );
65 validates a LightWave Object model file. btw, i use the
66 preceding underscore cause it's a static func referenced
67 by one structure only.
69 static int _lwo_canload( PM_PARAMS_CANLOAD ){
71 unsigned int failID = 0;
75 /* create a new pico memorystream */
76 s = _pico_new_memstream( (const picoByte_t *)buffer, bufSize );
78 return PICO_PMV_ERROR_MEMORY;
81 ret = lwValidateObject( fileName, s, &failID, &failpos );
83 _pico_free_memstream( s );
90 loads a LightWave Object model file.
92 static picoModel_t *_lwo_load( PM_PARAMS_LOAD ){
94 unsigned int failID = 0;
104 int i, j, k, numverts;
106 picoModel_t *picoModel;
107 picoSurface_t *picoSurface;
108 picoShader_t *picoShader;
109 picoVec3_t xyz, normal;
113 int defaultSTAxis[ 2 ];
114 picoVec2_t defaultXYZtoSTScale;
116 picoVertexCombinationHash_t **hashTable;
117 picoVertexCombinationHash_t *vertexCombinationHash;
120 clock_t load_start, load_finish, convert_start, convert_finish;
121 double load_elapsed, convert_elapsed;
123 load_start = clock();
127 if ( frameNum < 0 || frameNum >= 1 ) {
128 _pico_printf( PICO_ERROR, "Invalid or out-of-range LWO frame specified" );
132 /* create a new pico memorystream */
133 s = _pico_new_memstream( (const picoByte_t *)buffer, bufSize );
138 obj = lwGetObject( fileName, s, &failID, &failpos );
140 _pico_free_memstream( s );
143 _pico_printf( PICO_ERROR, "Couldn't load LWO file, failed on ID '%s', position %d", lwo_lwIDToStr( failID ), failpos );
148 convert_start = load_finish = clock();
149 load_elapsed = (double)( load_finish - load_start ) / CLOCKS_PER_SEC;
152 /* -------------------------------------------------
154 ------------------------------------------------- */
156 /* create a new pico model */
157 picoModel = PicoNewModel();
158 if ( picoModel == NULL ) {
159 _pico_printf( PICO_ERROR, "Unable to allocate a new model" );
164 PicoSetModelFrameNum( picoModel, frameNum );
165 PicoSetModelNumFrames( picoModel, 1 );
166 PicoSetModelName( picoModel, fileName );
167 PicoSetModelFileName( picoModel, fileName );
169 /* create all polygons from layer[ 0 ] that belong to this surface */
170 layer = &obj->layer[0];
172 /* warn the user that other layers are discarded */
173 if ( obj->nlayers > 1 ) {
174 _pico_printf( PICO_WARNING, "LWO loader discards any geometry data not in Layer 1 (%d layers found)", obj->nlayers );
177 /* initialize dummy normal */
178 normal[ 0 ] = normal[ 1 ] = normal[ 2 ] = 0.f;
180 /* setup default st map */
181 st[ 0 ] = st[ 1 ] = 0.f; /* st[0] holds max, st[1] holds max par one */
182 defaultSTAxis[ 0 ] = 0;
183 defaultSTAxis[ 1 ] = 1;
184 for ( i = 0; i < 3; i++ )
186 float min = layer->bbox[ i ];
187 float max = layer->bbox[ i + 3 ];
188 float size = max - min;
190 if ( size > st[ 0 ] ) {
191 defaultSTAxis[ 1 ] = defaultSTAxis[ 0 ];
192 defaultSTAxis[ 0 ] = i;
197 else if ( size > st[ 1 ] ) {
198 defaultSTAxis[ 1 ] = i;
202 defaultXYZtoSTScale[ 0 ] = 4.f / st[ 0 ];
203 defaultXYZtoSTScale[ 1 ] = 4.f / st[ 1 ];
205 /* LWO surfaces become pico surfaces */
209 /* allocate new pico surface */
210 picoSurface = PicoNewSurface( picoModel );
211 if ( picoSurface == NULL ) {
212 _pico_printf( PICO_ERROR, "Unable to allocate a new model surface" );
213 PicoFreeModel( picoModel );
218 /* LWO model surfaces are all triangle meshes */
219 PicoSetSurfaceType( picoSurface, PICO_TRIANGLES );
221 /* set surface name */
222 PicoSetSurfaceName( picoSurface, surface->name );
224 /* create new pico shader */
225 picoShader = PicoNewShader( picoModel );
226 if ( picoShader == NULL ) {
227 _pico_printf( PICO_ERROR, "Unable to allocate a new model shader" );
228 PicoFreeModel( picoModel );
233 /* detox and set shader name */
234 strncpy( name, surface->name, sizeof( name ) );
235 _pico_first_token( name );
236 _pico_setfext( name, "" );
237 _pico_unixify( name );
238 PicoSetShaderName( picoShader, name );
240 /* associate current surface with newly created shader */
241 PicoSetSurfaceShader( picoSurface, picoShader );
243 /* copy indices and vertex data */
246 hashTable = PicoNewVertexCombinationHashTable();
248 if ( hashTable == NULL ) {
249 _pico_printf( PICO_ERROR, "Unable to allocate hash table" );
250 PicoFreeModel( picoModel );
255 for ( i = 0, pol = layer->polygon.pol; i < layer->polygon.count; i++, pol++ )
257 /* does this polygon belong to this surface? */
258 if ( pol->surf != surface ) {
262 /* we only support polygons of the FACE type */
263 if ( pol->type != ID_FACE ) {
264 _pico_printf( PICO_WARNING, "LWO loader discarded a polygon because it's type != FACE (%s)", lwo_lwIDToStr( pol->type ) );
268 /* NOTE: LWO has support for non-convex polygons, do we want to store them as well? */
269 if ( pol->nverts != 3 ) {
270 _pico_printf( PICO_WARNING, "LWO loader discarded a polygon because it has != 3 verts (%d)", pol->nverts );
274 for ( j = 0, v = pol->v; j < 3; j++, v++ )
276 pt = &layer->point.pt[ v->index ];
279 xyz[ 0 ] = pt->pos[ 0 ];
280 xyz[ 1 ] = pt->pos[ 2 ];
281 xyz[ 2 ] = pt->pos[ 1 ];
283 /* doom3 lwo data doesn't seem to have smoothing-angle information */
285 if ( surface->smooth <= 0 ) {
286 /* use face normals */
287 normal[ 0 ] = v->norm[ 0 ];
288 normal[ 1 ] = v->norm[ 2 ];
289 normal[ 2 ] = v->norm[ 1 ];
294 /* smooth normals later */
300 st[ 0 ] = xyz[ defaultSTAxis[ 0 ] ] * defaultXYZtoSTScale[ 0 ];
301 st[ 1 ] = xyz[ defaultSTAxis[ 1 ] ] * defaultXYZtoSTScale[ 1 ];
303 color[ 0 ] = (picoByte_t)( surface->color.rgb[ 0 ] * surface->diffuse.val * 0xFF );
304 color[ 1 ] = (picoByte_t)( surface->color.rgb[ 1 ] * surface->diffuse.val * 0xFF );
305 color[ 2 ] = (picoByte_t)( surface->color.rgb[ 2 ] * surface->diffuse.val * 0xFF );
308 /* set from points */
309 for ( k = 0, vm = pt->vm; k < pt->nvmaps; k++, vm++ )
311 if ( vm->vmap->type == LWID_( 'T','X','U','V' ) ) {
313 st[ 0 ] = vm->vmap->val[ vm->index ][ 0 ];
314 st[ 1 ] = 1.f - vm->vmap->val[ vm->index ][ 1 ];
316 else if ( vm->vmap->type == LWID_( 'R','G','B','A' ) ) {
318 color[ 0 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 0 ] * surface->color.rgb[ 0 ] * surface->diffuse.val * 0xFF );
319 color[ 1 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 1 ] * surface->color.rgb[ 1 ] * surface->diffuse.val * 0xFF );
320 color[ 2 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 2 ] * surface->color.rgb[ 2 ] * surface->diffuse.val * 0xFF );
321 color[ 3 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 3 ] * 0xFF );
325 /* override with polygon data */
326 for ( k = 0, vm = v->vm; k < v->nvmaps; k++, vm++ )
328 if ( vm->vmap->type == LWID_( 'T','X','U','V' ) ) {
330 st[ 0 ] = vm->vmap->val[ vm->index ][ 0 ];
331 st[ 1 ] = 1.f - vm->vmap->val[ vm->index ][ 1 ];
333 else if ( vm->vmap->type == LWID_( 'R','G','B','A' ) ) {
335 color[ 0 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 0 ] * surface->color.rgb[ 0 ] * surface->diffuse.val * 0xFF );
336 color[ 1 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 1 ] * surface->color.rgb[ 1 ] * surface->diffuse.val * 0xFF );
337 color[ 2 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 2 ] * surface->color.rgb[ 2 ] * surface->diffuse.val * 0xFF );
338 color[ 3 ] = (picoByte_t)( vm->vmap->val[ vm->index ][ 3 ] * 0xFF );
342 /* find vertex in this surface and if we can't find it there create it */
343 vertexCombinationHash = PicoFindVertexCombinationInHashTable( hashTable, xyz, normal, st, color );
345 if ( vertexCombinationHash ) {
346 /* found an existing one */
347 PicoSetSurfaceIndex( picoSurface, ( i * 3 + j ), vertexCombinationHash->index );
351 /* it is a new one */
352 vertexCombinationHash = PicoAddVertexCombinationToHashTable( hashTable, xyz, normal, st, color, (picoIndex_t) numverts );
354 if ( vertexCombinationHash == NULL ) {
355 _pico_printf( PICO_ERROR, "Unable to allocate hash bucket entry table" );
356 PicoFreeVertexCombinationHashTable( hashTable );
357 PicoFreeModel( picoModel );
362 /* add the vertex to this surface */
363 PicoSetSurfaceXYZ( picoSurface, numverts, xyz );
365 /* set dummy normal */
366 PicoSetSurfaceNormal( picoSurface, numverts, normal );
369 PicoSetSurfaceColor( picoSurface, 0, numverts, color );
372 PicoSetSurfaceST( picoSurface, 0, numverts, st );
375 PicoSetSurfaceIndex( picoSurface, ( i * 3 + j ), (picoIndex_t) numverts );
382 /* free the hashtable */
383 PicoFreeVertexCombinationHashTable( hashTable );
385 /* get next surface */
386 surface = surface->next;
390 load_start = convert_finish = clock();
396 load_finish = clock();
397 load_elapsed += (double)( load_finish - load_start ) / CLOCKS_PER_SEC;
398 convert_elapsed = (double)( convert_finish - convert_start ) / CLOCKS_PER_SEC;
399 _pico_printf( PICO_NORMAL, "Loaded model in in %-.2f second(s) (loading: %-.2fs converting: %-.2fs)\n", load_elapsed + convert_elapsed, load_elapsed, convert_elapsed );
402 /* return the new pico model */
406 /* pico file format module definition */
407 const picoModule_t picoModuleLWO =
409 "1.0", /* module version string */
410 "LightWave Object", /* module display name */
411 "Arnout van Meer", /* author's name */
412 "2003 Arnout van Meer, 2000 Ernie Wright", /* module copyright */
414 "lwo", NULL, NULL, NULL /* default extensions to use */
416 _lwo_canload, /* validation routine */
417 _lwo_load, /* load routine */
418 NULL, /* save validation routine */
419 NULL /* save routine */