model.h

   1 #ifndef MODEL_H
   2 #define MODEL_H
   3
   4 #include "common.h"
   5
   6 typedef struct glmesh glmesh;
   7
   8 typedef struct mdl_vert mdl_vert;
   9 typedef struct mdl_submesh mdl_submesh;
  10 typedef struct mdl_material mdl_material;
  11 typedef struct mdl_node mdl_node;
  12 typedef struct mdl_header mdl_header;
  13 typedef struct mdl_animation mdl_animation;
  14 typedef struct mdl_keyframe mdl_keyframe;
  15
  16 #define MDL_SIZE_MAX          0x1000000
  17 #define MDL_VERT_MAX          1000000
  18 #define MDL_INDICE_MAX        1000000
  19 #define MDL_MATERIAL_MAX      32
  20 #define MDL_NODE_MAX          4000
  21 #define MDL_SUBMESH_MAX       8000
  22 #define MDL_STRING_LENGTH_MAX 64
  23
  24 #pragma pack(push,1)
  25
  26 struct mdl_vert
  27 {
  28    v3f co,
  29        norm;
  30    v2f uv;
  31    u8  colour[4];
  32    u16 weights[4];
  33    u8  groups[4];
  34 };
  35
  36 struct mdl_submesh
  37 {
  38    u32 indice_start,
  39        indice_count,
  40        vertex_start,
  41        vertex_count;
  42
  43    boxf bbx;
  44    u32 material_id;
  45 };
  46
  47 struct mdl_material
  48 {
  49    u32 pstr_name;
  50 };
  51
  52 struct mdl_node
  53 {
  54    v3f co;
  55    v4f q;
  56    v3f s;
  57
  58    union{ u32 submesh_start, sub_uid; };
  59
  60    u32
  61        submesh_count,
  62        classtype,
  63        offset,
  64        parent,
  65        pstr_name;
  66 };
  67
  68 struct mdl_keyframe
  69 {
  70    v3f co;
  71    v4f q;
  72    v3f s;
  73 };
  74
  75 struct mdl_animation
  76 {
  77    u32 pstr_name,
  78        length;
  79
  80    float rate;
  81
  82    u32 offset;
  83 };
  84
  85 struct mdl_header
  86 {
  87    u32 identifier, version, file_length;
  88
  89    u32 vertex_count, vertex_offset,
  90        indice_count, indice_offset,
  91        submesh_count, submesh_offset,
  92        material_count, material_offset,
  93        node_count, node_offset,
  94        anim_count, anim_offset,
  95        strings_offset, entdata_offset, animdata_offset;
  96 };
  97
  98 /*
  99  * Entity data structures
 100  */
 101
 102 struct classtype_block
 103 {
 104    boxf bbx;
 105 };
 106
 107 struct classtype_gate
 108 {
 109    u32 target;
 110    v3f dims;
 111 };
 112
 113 struct classtype_spawn
 114 {
 115    u32 target;
 116 };
 117
 118 struct classtype_water
 119 {
 120    u32 temp;
 121 };
 122
 123 struct classtype_car_path
 124 {
 125    u32 target, target1;
 126 };
 127
 128 struct classtype_instance
 129 {
 130    u32 pstr_file;
 131 };
 132
 133 struct classtype_capsule
 134 {
 135    float height, radius;
 136 };
 137
 138 struct classtype_route_node
 139 {
 140    u32 target, target1;
 141 };
 142
 143 struct classtype_route
 144 {
 145    u32 pstr_name;
 146    u32 id_start;
 147    v3f colour;
 148 };
 149
 150 struct classtype_bone
 151 {
 152    u32 deform;
 153 };
 154
 155 struct classtype_ik_bone
 156 {
 157    u32 deform,
 158        target,
 159        pole;
 160 };
 161
 162 struct classtype_skeleton
 163 {
 164    u32 channels,
 165        ik_count,
 166        anim_start,
 167        anim_count;
 168 };
 169
 170 struct classtype_skin
 171 {
 172    u32 skeleton;
 173 };
 174
 175 #pragma pack(pop)
 176
 177 /*
 178  * Simple mesh interface for OpenGL
 179  */
 180
 181 struct glmesh
 182 {
 183    GLuint vao, vbo, ebo;
 184    u32 indice_count;
 185 };
 186
 187 static void mesh_upload( glmesh *mesh,
 188       mdl_vert *verts, u32 vert_count,
 189       u32 *indices, u32 indice_count )
 190 {
 191    glGenVertexArrays( 1, &mesh->vao );
 192    glGenBuffers( 1, &mesh->vbo );
 193    glGenBuffers( 1, &mesh->ebo );
 194    glBindVertexArray( mesh->vao );
 195
 196    size_t stride = sizeof(mdl_vert);
 197
 198    glBindBuffer( GL_ARRAY_BUFFER, mesh->vbo );
 199    glBufferData( GL_ARRAY_BUFFER, vert_count*stride, verts, GL_STATIC_DRAW );
 200
 201    glBindVertexArray( mesh->vao );
 202    glBindBuffer( GL_ELEMENT_ARRAY_BUFFER, mesh->ebo );
 203    glBufferData( GL_ELEMENT_ARRAY_BUFFER, indice_count*sizeof(u32),
 204          indices, GL_STATIC_DRAW );
 205
 206    /* 0: coordinates */
 207    glVertexAttribPointer( 0, 3, GL_FLOAT, GL_FALSE, stride, (void*)0 );
 208    glEnableVertexAttribArray( 0 );
 209
 210    /* 1: normal */
 211    glVertexAttribPointer( 1, 3, GL_FLOAT, GL_FALSE,
 212          stride, (void *)offsetof(mdl_vert, norm) );
 213    glEnableVertexAttribArray( 1 );
 214
 215    /* 2: uv */
 216    glVertexAttribPointer( 2, 2, GL_FLOAT, GL_FALSE,
 217          stride, (void *)offsetof(mdl_vert, uv) );
 218    glEnableVertexAttribArray( 2 );
 219
 220    /* 3: colour */
 221    glVertexAttribPointer( 3, 4, GL_UNSIGNED_BYTE, GL_TRUE,
 222          stride, (void *)offsetof(mdl_vert, colour) );
 223    glEnableVertexAttribArray( 3 );
 224
 225    /* 4: weights */
 226    glVertexAttribPointer( 4, 4, GL_UNSIGNED_SHORT, GL_TRUE,
 227          stride, (void *)offsetof(mdl_vert, weights) );
 228    glEnableVertexAttribArray( 4 );
 229
 230    /* 5: groups */
 231    glVertexAttribIPointer( 5, 4, GL_UNSIGNED_BYTE,
 232          stride, (void *)offsetof(mdl_vert, groups) );
 233    glEnableVertexAttribArray( 5 );
 234
 235
 236    VG_CHECK_GL();
 237    mesh->indice_count = indice_count;
 238 }
 239
 240 static void mesh_bind( glmesh *mesh )
 241 {
 242    glBindVertexArray( mesh->vao );
 243 }
 244
 245 static void mesh_drawn( u32 start, u32 count )
 246 {
 247    glDrawElements( GL_TRIANGLES, count, GL_UNSIGNED_INT,
 248          (void *)(start*sizeof(u32)) );
 249 }
 250
 251 static void mesh_draw( glmesh *mesh )
 252 {
 253    mesh_drawn( 0, mesh->indice_count );
 254 }
 255
 256 static void mesh_free( glmesh *mesh )
 257 {
 258    glDeleteVertexArrays( 1, &mesh->vao );
 259    glDeleteBuffers( 1, &mesh->ebo );
 260    glDeleteBuffers( 1, &mesh->vbo );
 261 }
 262
 263
 264 /*
 265  * Model implementation
 266  */
 267
 268 static mdl_header *mdl_load( const char *path )
 269 {
 270    i64 size;
 271    mdl_header *header = vg_asset_read_s( path, &size );
 272
 273    /*
 274     * Check file is valid
 275     */
 276    if( !header )
 277    {
 278       vg_error( "Could not open '%s'\n", path );
 279       return NULL;
 280    }
 281
 282    if( size < sizeof(mdl_header) )
 283    {
 284       free( header );
 285       vg_error( "Invalid file '%s' (too small for header)\n", path );
 286       return NULL;
 287    }
 288
 289    if( header->file_length != size )
 290    {
 291       vg_error( "Invalid file '%s'"
 292                 "(wrong .file_length, %ub != real file size %ub)\n",
 293                 path, header->file_length, size );
 294       free( header );
 295       return NULL;
 296    }
 297
 298    /*
 299     * Validate offsets and memory sections, to ensure all arrays are in-bounds,
 300     * and that they do not overlap.
 301     */
 302
 303    struct memregion
 304    {
 305       const char *desc;
 306       u32 count, max_count, size, offset;
 307    }
 308    regions[] = {
 309       {
 310          "Vertices",
 311          header->vertex_count, MDL_VERT_MAX,
 312          sizeof(mdl_vert), header->vertex_offset
 313       },
 314       {
 315          "Indices",
 316          header->indice_count, MDL_INDICE_MAX,
 317          sizeof(u32), header->indice_offset
 318       },
 319       {
 320          "Submesh",
 321          header->submesh_count, MDL_SUBMESH_MAX,
 322          sizeof(mdl_submesh), header->submesh_offset
 323       },
 324       {
 325          "Materials",
 326          header->material_count, MDL_MATERIAL_MAX,
 327          sizeof(mdl_material), header->material_offset
 328       },
 329       {
 330          "Nodes",
 331          header->node_count, MDL_NODE_MAX,
 332          sizeof(mdl_node), header->node_count
 333       }
 334    };
 335
 336    for( int i=0; i<vg_list_size(regions); i++ )
 337    {
 338       struct memregion *ri = &regions[i];
 339
 340       if( ri->count == 0 )
 341          continue;
 342
 343       if( ri->count > ri->max_count )
 344       {
 345          free( header );
 346          vg_error( "'%s': '%s' buffer exceeds the maximum (%u/%u)\n",
 347                path, ri->desc, ri->count, ri->max_count );
 348          return NULL;
 349       }
 350
 351       if( ri->offset >= header->file_length )
 352       {
 353          free( header );
 354          vg_error( "'%s': '%s' buffer offset is out of range\n",
 355                path, ri->desc );
 356          return NULL;
 357       }
 358
 359       if( ri->offset + ri->size*ri->count > header->file_length )
 360       {
 361          free( header );
 362          vg_error( "'%s': '%s' buffer size is out of range\n",
 363                path, ri->desc );
 364          return NULL;
 365       }
 366
 367       for( int j=0; j<vg_list_size(regions); j++ )
 368       {
 369          struct memregion *rj = &regions[j];
 370          if( rj->count == 0 )
 371             continue;
 372
 373          if( ri->offset >= rj->offset &&
 374                (ri->offset+ri->size*ri->count < rj->offset+rj->size*rj->count))
 375          {
 376             free( header );
 377             vg_error( "'%s': '%s' buffer overlaps '%s'\n",
 378                   path, ri->desc, rj->desc );
 379             return NULL;
 380          }
 381       }
 382    }
 383
 384    /*
 385     * Pointer validation TODO(workshop)
 386     */
 387
 388    /*
 389     * strings TODO(workshop)
 390     */
 391
 392    return header;
 393 }
 394
 395 static void *mdl_baseptr( mdl_header *mdl, u32 offset )
 396 {
 397    return (void *)mdl + offset;
 398 }
 399
 400 static const char *mdl_pstr( mdl_header *mdl, u32 pstr )
 401 {
 402    return (const char *)(mdl_baseptr( mdl, mdl->strings_offset )) + pstr;
 403 }
 404
 405 static mdl_node *mdl_node_from_id( mdl_header *mdl, u32 id )
 406 {
 407    return ((mdl_node *)mdl_baseptr( mdl, mdl->node_offset )) + id;
 408 }
 409
 410 static mdl_node *mdl_node_from_name( mdl_header *mdl, const char *name )
 411 {
 412    for( int i=0; i<mdl->node_count; i++ )
 413    {
 414       mdl_node *pnode = mdl_node_from_id( mdl, i );
 415
 416       if( !strcmp( name, mdl_pstr( mdl, pnode->pstr_name )) )
 417          return pnode;
 418    }
 419
 420    return NULL;
 421 }
 422
 423 static mdl_submesh *mdl_submesh_from_id( mdl_header *mdl, u32 id )
 424 {
 425    if( id >= mdl->submesh_count )
 426       return NULL;
 427
 428    return ((mdl_submesh *)mdl_baseptr( mdl, mdl->submesh_offset )) + id;
 429 }
 430
 431 static mdl_submesh *mdl_node_submesh( mdl_header *mdl, mdl_node *node, u32 i )
 432 {
 433    if( i >= node->submesh_count )
 434       return NULL;
 435
 436    return mdl_submesh_from_id( mdl, node->submesh_start+i );
 437 }
 438
 439 static u32 *mdl_submesh_indices( mdl_header *mdl, mdl_submesh *sm )
 440 {
 441    return ((u32 *)mdl_baseptr( mdl, mdl->indice_offset )) + sm->indice_start;
 442 }
 443
 444 static mdl_vert *mdl_submesh_vertices( mdl_header *mdl, mdl_submesh *sm )
 445 {
 446    return ((mdl_vert *)mdl_baseptr(mdl,mdl->vertex_offset)) + sm->vertex_start;
 447 }
 448
 449 static mdl_material *mdl_material_from_id( mdl_header *mdl, u32 id )
 450 {
 451    return ((mdl_material *)mdl_baseptr(mdl,mdl->material_offset)) + id;
 452 }
 453
 454 static mdl_animation *mdl_animation_from_id( mdl_header *mdl, u32 id )
 455 {
 456    return ((mdl_animation *)mdl_baseptr(mdl,mdl->anim_offset)) + id;
 457 }
 458
 459 static void mdl_node_transform( mdl_node *pnode, m4x3f transform )
 460 {
 461    q_m3x3( pnode->q, transform );
 462    v3_muls( transform[0], pnode->s[0], transform[0] );
 463    v3_muls( transform[1], pnode->s[1], transform[1] );
 464    v3_muls( transform[2], pnode->s[2], transform[2] );
 465    v3_copy( pnode->co, transform[3] );
 466 }
 467
 468 static void mdl_unpack_submesh( mdl_header *mdl, glmesh *mesh, mdl_submesh *sm )
 469 {
 470    mesh_upload( mesh, mdl_submesh_vertices( mdl, sm ), sm->vertex_count,
 471                       mdl_submesh_indices( mdl, sm ), sm->indice_count );
 472 }
 473
 474 static void mdl_unpack_glmesh( mdl_header *mdl, glmesh *mesh )
 475 {
 476    u32 offset = mdl_submesh_from_id( mdl, 0 )->vertex_count;
 477
 478    for( int i=1; i< mdl->submesh_count; i++ )
 479    {
 480       mdl_submesh *sm = mdl_submesh_from_id( mdl, i );
 481       u32 *indices =    mdl_submesh_indices( mdl, sm );
 482
 483       for( u32 j=0; j<sm->indice_count; j++ )
 484          indices[j] += offset;
 485
 486       offset += sm->vertex_count;
 487    }
 488
 489    mdl_vert *vertex_base = mdl_baseptr( mdl, mdl->vertex_offset );
 490    u32 *indice_base = mdl_baseptr( mdl, mdl->indice_offset );
 491
 492    mesh_upload( mesh, vertex_base, mdl->vertex_count,
 493                       indice_base, mdl->indice_count );
 494 }
 495
 496 static void mdl_draw_submesh( mdl_submesh *sm )
 497 {
 498    mesh_drawn( sm->indice_start, sm->indice_count );
 499 }
 500
 501 static void *mdl_get_entdata( mdl_header *mdl, mdl_node *pnode )
 502 {
 503    return mdl_baseptr( mdl, mdl->entdata_offset ) + pnode->offset;
 504 }
 505
 506 static mdl_keyframe *mdl_get_animdata( mdl_header *mdl, mdl_animation *anim )
 507 {
 508    return mdl_baseptr( mdl, mdl->animdata_offset ) + anim->offset;
 509 }
 510
 511 static void mdl_link_materials( mdl_header *root, mdl_header *child )
 512 {
 513    u32 lookup[MDL_MATERIAL_MAX];
 514
 515    for( int i=0; i<child->material_count; i++ )
 516    {
 517       mdl_material *mi = mdl_material_from_id( child, i );
 518       const char *si = mdl_pstr( child, mi->pstr_name );
 519
 520       lookup[i] = 0;
 521
 522       for( int j=0; j<root->material_count; j++ )
 523       {
 524          mdl_material *mj = mdl_material_from_id( root, j );
 525          const char *sj = mdl_pstr( root, mj->pstr_name );
 526
 527          if( !strcmp( si, sj ) )
 528          {
 529             lookup[i] = j;
 530             break;
 531          }
 532       }
 533
 534       if( lookup[i] == 0 && i != 0 )
 535       {
 536          vg_warn( "Could not link material '%s' (not present in root model)\n",
 537                    si );
 538       }
 539    }
 540
 541    for( int i=0; i<child->submesh_count; i++ )
 542    {
 543       mdl_submesh *sm = mdl_submesh_from_id( child, i );
 544       sm->material_id = lookup[sm->material_id];
 545    }
 546 }
 547
 548
 549 #endif