2 * Copyright (C) 2021-2022 Mt.ZERO Software, Harry Godden - All Rights Reserved
10 typedef struct glmesh glmesh
;
12 typedef struct mdl_vert mdl_vert
;
13 typedef struct mdl_submesh mdl_submesh
;
14 typedef struct mdl_material mdl_material
;
15 typedef struct mdl_node mdl_node
;
16 typedef struct mdl_file_header mdl_file_header
;
17 typedef struct mdl_animation mdl_animation
;
18 typedef struct mdl_keyframe mdl_keyframe
;
19 typedef struct mdl_texture mdl_texture
;
20 typedef struct mdl_context mdl_context
;
22 #define MDL_SIZE_MAX 0x1000000
23 #define MDL_VERT_MAX 1000000
24 #define MDL_INDICE_MAX 1000000
25 #define MDL_MATERIAL_MAX 32
26 #define MDL_NODE_MAX 4000
27 #define MDL_SUBMESH_MAX 8000
28 #define MDL_STRING_LENGTH_MAX 64
34 k_classtype_spawn
= 3,
35 k_classtype_water
= 4,
36 k_classtype_route_node
= 8,
37 k_classtype_route
= 9,
38 k_classtype_bone
= 10,
39 k_classtype_skeleton
= 11,
40 k_classtype_skin
= 12,
41 k_classtype_audio
= 14,
42 k_classtype_trigger
= 100,
43 k_classtype_logic_achievement
= 101,
44 k_classtype_logic_relay
= 102
49 k_shader_standard
= 0,
50 k_shader_standard_cutout
= 1,
51 k_shader_terrain_blend
= 2,
52 k_shader_standard_vertex_blend
= 3,
58 k_surface_prop_concrete
= 0,
59 k_surface_prop_wood
= 1,
60 k_surface_prop_grass
= 2
65 k_material_flag_skate_surface
= 0x1,
66 k_material_flag_collision
= 0x2,
67 k_material_flag_grow_grass
= 0x4
121 u32 sub_uid
, /* allocated in-file... too bad. */
147 struct mdl_file_header
149 u32 identifier
, version
, file_length
, pad0
;
152 node_count
, node_offset
,
153 submesh_count
, submesh_offset
,
154 material_count
, material_offset
,
155 texture_count
, texture_offset
,
156 anim_count
, anim_offset
,
157 entdata_size
, entdata_offset
,
158 strings_size
, strings_offset
,
160 keyframe_count
, keyframe_offset
,
162 vertex_count
, vertex_offset
,
163 indice_count
, indice_offset
,
165 pack_size
, pack_offset
;
169 * Entity data structures
172 struct classtype_gate
178 struct classtype_spawn
183 struct classtype_water
188 struct classtype_route_node
193 struct classtype_route
200 struct classtype_bone
212 struct classtype_skeleton
221 struct classtype_skin
226 struct classtype_trigger
231 struct classtype_logic_relay
236 struct classtype_logic_achievement
241 struct classtype_audio
255 mdl_file_header info
;
257 /* each buffer becomes availible after each _load function is called */
258 mdl_node
*node_buffer
; /* mdl_load_metadata() */
259 mdl_submesh
*submesh_buffer
;
260 mdl_material
*material_buffer
;
261 mdl_texture
*texture_buffer
;
262 mdl_animation
*anim_buffer
;
263 void *entdata_buffer
;
264 const char *string_buffer
;
266 mdl_keyframe
*keyframe_buffer
; /* mdl_load_anim_data() */
268 mdl_vert
*vertex_buffer
; /* mdl_load_mesh_data() */
271 void *pack
; /* mdl_load_pack_data() */
275 * Simple mesh interface for OpenGL
280 GLuint vao
, vbo
, ebo
;
285 VG_STATIC
void mesh_upload( glmesh
*mesh
,
286 mdl_vert
*verts
, u32 vert_count
,
287 u32
*indices
, u32 indice_count
)
289 //assert( mesh->loaded == 0 );
291 glGenVertexArrays( 1, &mesh
->vao
);
292 glGenBuffers( 1, &mesh
->vbo
);
293 glGenBuffers( 1, &mesh
->ebo
);
294 glBindVertexArray( mesh
->vao
);
296 size_t stride
= sizeof(mdl_vert
);
298 glBindBuffer( GL_ARRAY_BUFFER
, mesh
->vbo
);
299 glBufferData( GL_ARRAY_BUFFER
, vert_count
*stride
, verts
, GL_STATIC_DRAW
);
301 glBindVertexArray( mesh
->vao
);
302 glBindBuffer( GL_ELEMENT_ARRAY_BUFFER
, mesh
->ebo
);
303 glBufferData( GL_ELEMENT_ARRAY_BUFFER
, indice_count
*sizeof(u32
),
304 indices
, GL_STATIC_DRAW
);
307 glVertexAttribPointer( 0, 3, GL_FLOAT
, GL_FALSE
, stride
, (void*)0 );
308 glEnableVertexAttribArray( 0 );
311 glVertexAttribPointer( 1, 3, GL_FLOAT
, GL_FALSE
,
312 stride
, (void *)offsetof(mdl_vert
, norm
) );
313 glEnableVertexAttribArray( 1 );
316 glVertexAttribPointer( 2, 2, GL_FLOAT
, GL_FALSE
,
317 stride
, (void *)offsetof(mdl_vert
, uv
) );
318 glEnableVertexAttribArray( 2 );
321 glVertexAttribPointer( 3, 4, GL_UNSIGNED_BYTE
, GL_TRUE
,
322 stride
, (void *)offsetof(mdl_vert
, colour
) );
323 glEnableVertexAttribArray( 3 );
326 glVertexAttribPointer( 4, 4, GL_UNSIGNED_SHORT
, GL_TRUE
,
327 stride
, (void *)offsetof(mdl_vert
, weights
) );
328 glEnableVertexAttribArray( 4 );
331 glVertexAttribIPointer( 5, 4, GL_UNSIGNED_BYTE
,
332 stride
, (void *)offsetof(mdl_vert
, groups
) );
333 glEnableVertexAttribArray( 5 );
337 mesh
->indice_count
= indice_count
;
341 VG_STATIC
void mesh_bind( glmesh
*mesh
)
343 glBindVertexArray( mesh
->vao
);
346 VG_STATIC
void mesh_drawn( u32 start
, u32 count
)
348 glDrawElements( GL_TRIANGLES
, count
, GL_UNSIGNED_INT
,
349 (void *)(start
*sizeof(u32
)) );
352 VG_STATIC
void mesh_draw( glmesh
*mesh
)
354 mesh_drawn( 0, mesh
->indice_count
);
357 VG_STATIC
void mesh_free( glmesh
*mesh
)
361 glDeleteVertexArrays( 1, &mesh
->vao
);
362 glDeleteBuffers( 1, &mesh
->ebo
);
363 glDeleteBuffers( 1, &mesh
->vbo
);
368 VG_STATIC
void mdl_load_fatal_corrupt( mdl_context
*mdl
)
371 vg_file_print_invalid( mdl
->file
);
372 vg_fatal_exit_loop( "Corrupt model" );
376 * Model implementation
380 * you have two api options for loading a model, first, the easy way:
382 * will put the entire model straight into the linear_alloc
384 * or, to target different allocators:
388 * mdl_load_vertex_data
389 * mdl_load_indice_data
392 * these should ideally be called in quick succession to limit stalls.
396 * if calling mdl_open, and the file does not exist, the game will fatal quit
398 VG_STATIC
void mdl_open( mdl_context
*mdl
, const char *path
)
400 memset( mdl
, 0, sizeof( mdl_context
) );
401 mdl
->file
= fopen( path
, "rb" );
405 vg_error( "mdl_open('%s'): %s\n", path
, strerror(errno
) );
406 vg_fatal_exit_loop( "see above for details" );
409 u64 l
= fread( &mdl
->info
, sizeof(mdl_file_header
), 1, mdl
->file
);
411 mdl_load_fatal_corrupt( mdl
);
415 * Load all metadata (everything up until the large buffers). Probs at most 50k
417 VG_STATIC
void mdl_load_metadata( mdl_context
*mdl
, void *lin_alloc
)
421 u64 lheader
= sizeof(mdl_file_header
),
422 ldata
= mdl
->info
.keyframe_offset
- lheader
;
424 void *all_data
= vg_linear_alloc( lin_alloc
, ldata
);
426 fseek( mdl
->file
, lheader
, SEEK_SET
);
427 u64 l
= fread( all_data
, ldata
, 1, mdl
->file
);
431 vg_file_print_invalid( mdl
->file
);
432 vg_fatal_exit_loop( "Corrupt model" );
435 mdl
->node_buffer
= all_data
+ (mdl
->info
.node_offset
- lheader
);
436 mdl
->submesh_buffer
= all_data
+ (mdl
->info
.submesh_offset
- lheader
);
437 mdl
->material_buffer
= all_data
+ (mdl
->info
.material_offset
- lheader
);
438 mdl
->texture_buffer
= all_data
+ (mdl
->info
.texture_offset
- lheader
);
439 mdl
->anim_buffer
= all_data
+ (mdl
->info
.anim_offset
- lheader
);
440 mdl
->entdata_buffer
= all_data
+ (mdl
->info
.entdata_offset
- lheader
);
441 mdl
->string_buffer
= all_data
+ (mdl
->info
.strings_offset
- lheader
);
445 * Load just the mesh data
447 VG_STATIC
void mdl_load_mesh_data( mdl_context
*mdl
, void *lin_alloc
)
451 u64 size_verts
= mdl
->info
.vertex_count
* sizeof(mdl_vert
),
452 size_index
= mdl
->info
.indice_count
* sizeof(u32
);
454 mdl
->vertex_buffer
= vg_linear_alloc( lin_alloc
, size_verts
);
455 mdl
->index_buffer
= vg_linear_alloc( lin_alloc
, size_index
);
458 fseek( mdl
->file
, mdl
->info
.vertex_offset
, SEEK_SET
);
459 u64 l
= fread( mdl
->vertex_buffer
, size_verts
, 1, mdl
->file
);
461 mdl_load_fatal_corrupt( mdl
);
464 fseek( mdl
->file
, mdl
->info
.indice_offset
, SEEK_SET
);
465 u64 l
= fread( mdl
->index_buffer
, size_index
, 1, mdl
->file
);
467 mdl_load_fatal_corrupt( mdl
);
472 * Load animation data
474 VG_STATIC
void mdl_load_anim_data( mdl_context
*mdl
, void *lin_alloc
)
478 if( mdl
->info
.keyframe_count
== 0 )
481 u64 size_kf
= mdl
->info
.keyframe_count
* sizeof(mdl_keyframe
);
482 mdl
->keyframe_buffer
= vg_linear_alloc( lin_alloc
, size_kf
);
484 fseek( mdl
->file
, mdl
->info
.keyframe_offset
, SEEK_SET
);
485 u64 l
= fread( mdl
->keyframe_buffer
, size_kf
, 1, mdl
->file
);
487 mdl_load_fatal_corrupt( mdl
);
493 * TODO request specific files (low)
495 VG_STATIC
void mdl_load_pack_data( mdl_context
*mdl
, void *lin_alloc
)
499 if( mdl
->info
.pack_size
== 0 )
502 mdl
->pack
= vg_linear_alloc( lin_alloc
, mdl
->info
.pack_size
);
503 fseek( mdl
->file
, mdl
->info
.pack_offset
, SEEK_SET
);
505 u64 l
= fread( mdl
->pack
, mdl
->info
.pack_size
, 1, mdl
->file
);
507 mdl_load_fatal_corrupt( mdl
);
513 VG_STATIC
void mdl_close( mdl_context
*mdl
)
519 /* open a model. TODO: make this flags ( ANIM_DATA|MESH_DATA ... ) */
520 VG_STATIC mdl_context
*mdl_load_full( void *lin_alloc
, const char *path
)
522 /* Inspect the header by opening it, give us the size needed */
523 mdl_context temp_ctx
;
524 mdl_open( &temp_ctx
, path
);
526 /* create allocator */
527 u32 tot_size
= temp_ctx
.info
.file_length
+ sizeof( mdl_context
);
528 void *data
= vg_create_linear_allocator( lin_alloc
, tot_size
,
531 /* copy context and load all other data */
532 mdl_context
*ctx
= vg_linear_alloc( data
, sizeof(mdl_context
) );
533 memcpy( ctx
, &temp_ctx
, sizeof(mdl_context
) );
535 mdl_load_metadata( ctx
, data
);
536 mdl_load_anim_data( ctx
, data
);
537 mdl_load_mesh_data( ctx
, data
);
538 mdl_load_pack_data( ctx
, data
);
546 * ----------------------------------------------------------------------------
547 * TODO: Clamp access and oob errors
549 VG_STATIC
const char *mdl_pstr( mdl_context
*mdl
, u32 pstr
)
551 return mdl
->string_buffer
+ pstr
;
554 VG_STATIC mdl_node
*mdl_node_from_id( mdl_context
*mdl
, u32 id
)
556 return &mdl
->node_buffer
[id
];
559 VG_STATIC mdl_node
*mdl_node_from_name( mdl_context
*mdl
, const char *name
)
561 for( int i
=0; i
< mdl
->info
.node_count
; i
++ )
563 mdl_node
*pnode
= mdl_node_from_id( mdl
, i
);
565 if( !strcmp( name
, mdl_pstr( mdl
, pnode
->pstr_name
)) )
572 VG_STATIC mdl_submesh
*mdl_node_submesh( mdl_context
*mdl
,
573 mdl_node
*node
, u32 i
)
575 return &mdl
->submesh_buffer
[ node
->submesh_start
+i
];
578 VG_STATIC u32
*mdl_submesh_indices( mdl_context
*mdl
, mdl_submesh
*sm
)
580 return &mdl
->index_buffer
[ sm
->indice_start
];
583 VG_STATIC mdl_vert
*mdl_submesh_vertices( mdl_context
*mdl
, mdl_submesh
*sm
)
585 return &mdl
->vertex_buffer
[ sm
->vertex_start
];
588 VG_STATIC
void mdl_node_transform( mdl_node
*pnode
, m4x3f transform
)
590 q_m3x3( pnode
->q
, transform
);
591 v3_muls( transform
[0], pnode
->s
[0], transform
[0] );
592 v3_muls( transform
[1], pnode
->s
[1], transform
[1] );
593 v3_muls( transform
[2], pnode
->s
[2], transform
[2] );
594 v3_copy( pnode
->co
, transform
[3] );
597 /* upload a mesh based on file submesh */
598 VG_STATIC
void mdl_unpack_submesh( mdl_context
*mdl
, glmesh
*mesh
,
601 mesh_upload( mesh
, mdl_submesh_vertices( mdl
, sm
), sm
->vertex_count
,
602 mdl_submesh_indices( mdl
, sm
), sm
->indice_count
);
605 /* upload entire mesh from model */
606 VG_STATIC
void mdl_unpack_glmesh( mdl_context
*mdl
, glmesh
*mesh
)
608 u32 offset
= mdl
->submesh_buffer
[0].vertex_count
;
610 for( int i
=1; i
< mdl
->info
.submesh_count
; i
++ )
612 mdl_submesh
*sm
= &mdl
->submesh_buffer
[i
];
613 u32
*indices
= mdl_submesh_indices( mdl
, sm
);
615 for( u32 j
=0; j
<sm
->indice_count
; j
++ )
616 indices
[j
] += offset
;
618 offset
+= sm
->vertex_count
;
621 mesh_upload( mesh
, mdl
->vertex_buffer
, mdl
->info
.vertex_count
,
622 mdl
->index_buffer
, mdl
->info
.indice_count
);
625 VG_STATIC
void mdl_draw_submesh( mdl_submesh
*sm
)
627 mesh_drawn( sm
->indice_start
, sm
->indice_count
);
630 VG_STATIC
void *mdl_get_entdata( mdl_context
*mdl
, mdl_node
*pnode
)
632 return mdl
->entdata_buffer
+ pnode
->offset
;
635 VG_STATIC mdl_keyframe
*mdl_get_animdata( mdl_context
*mdl
, mdl_animation
*anim
)
637 return mdl
->keyframe_buffer
+ anim
->offset
;
640 VG_STATIC
void mdl_link_materials( mdl_context
*root
, mdl_context
*child
)
642 u32 lookup
[MDL_MATERIAL_MAX
];
644 for( int i
=0; i
<child
->info
.material_count
; i
++ )
646 mdl_material
*mi
= &child
->material_buffer
[i
];
647 const char *si
= mdl_pstr( child
, mi
->pstr_name
);
651 for( int j
=0; j
<root
->info
.material_count
; j
++ )
653 mdl_material
*mj
= &root
->material_buffer
[j
];
654 const char *sj
= mdl_pstr( root
, mj
->pstr_name
);
656 if( !strcmp( si
, sj
) )
663 if( lookup
[i
] == 0 && i
!= 0 )
665 vg_warn( "Could not link material '%s' (not present in root model)\n",
670 for( int i
=0; i
<child
->info
.submesh_count
; i
++ )
672 mdl_submesh
*sm
= &child
->submesh_buffer
[i
];
673 sm
->material_id
= lookup
[sm
->material_id
];