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,
68 k_material_flag_grind_surface
= 0x8
122 u32 sub_uid
, /* allocated in-file... too bad. */
148 struct mdl_file_header
150 u32 identifier
, version
, file_length
, pad0
;
153 node_count
, node_offset
,
154 submesh_count
, submesh_offset
,
155 material_count
, material_offset
,
156 texture_count
, texture_offset
,
157 anim_count
, anim_offset
,
158 entdata_size
, entdata_offset
,
159 strings_size
, strings_offset
,
161 keyframe_count
, keyframe_offset
,
163 vertex_count
, vertex_offset
,
164 indice_count
, indice_offset
,
166 pack_size
, pack_offset
;
170 * Entity data structures
173 struct classtype_gate
179 struct classtype_spawn
184 struct classtype_water
189 struct classtype_route_node
194 struct classtype_route
201 struct classtype_bone
213 struct classtype_skeleton
222 struct classtype_skin
227 struct classtype_trigger
232 struct classtype_logic_relay
237 struct classtype_logic_achievement
242 struct classtype_audio
256 mdl_file_header info
;
258 /* each buffer becomes availible after each _load function is called */
259 mdl_node
*node_buffer
; /* mdl_load_metadata() */
260 mdl_submesh
*submesh_buffer
;
261 mdl_material
*material_buffer
;
262 mdl_texture
*texture_buffer
;
263 mdl_animation
*anim_buffer
;
264 void *entdata_buffer
;
265 const char *string_buffer
;
267 mdl_keyframe
*keyframe_buffer
; /* mdl_load_anim_data() */
269 mdl_vert
*vertex_buffer
; /* mdl_load_mesh_data() */
272 void *pack
; /* mdl_load_pack_data() */
276 * Simple mesh interface for OpenGL
281 GLuint vao
, vbo
, ebo
;
286 VG_STATIC
void mesh_upload( glmesh
*mesh
,
287 mdl_vert
*verts
, u32 vert_count
,
288 u32
*indices
, u32 indice_count
)
290 //assert( mesh->loaded == 0 );
292 glGenVertexArrays( 1, &mesh
->vao
);
293 glGenBuffers( 1, &mesh
->vbo
);
294 glGenBuffers( 1, &mesh
->ebo
);
295 glBindVertexArray( mesh
->vao
);
297 size_t stride
= sizeof(mdl_vert
);
299 glBindBuffer( GL_ARRAY_BUFFER
, mesh
->vbo
);
300 glBufferData( GL_ARRAY_BUFFER
, vert_count
*stride
, verts
, GL_STATIC_DRAW
);
302 glBindVertexArray( mesh
->vao
);
303 glBindBuffer( GL_ELEMENT_ARRAY_BUFFER
, mesh
->ebo
);
304 glBufferData( GL_ELEMENT_ARRAY_BUFFER
, indice_count
*sizeof(u32
),
305 indices
, GL_STATIC_DRAW
);
308 glVertexAttribPointer( 0, 3, GL_FLOAT
, GL_FALSE
, stride
, (void*)0 );
309 glEnableVertexAttribArray( 0 );
312 glVertexAttribPointer( 1, 3, GL_FLOAT
, GL_FALSE
,
313 stride
, (void *)offsetof(mdl_vert
, norm
) );
314 glEnableVertexAttribArray( 1 );
317 glVertexAttribPointer( 2, 2, GL_FLOAT
, GL_FALSE
,
318 stride
, (void *)offsetof(mdl_vert
, uv
) );
319 glEnableVertexAttribArray( 2 );
322 glVertexAttribPointer( 3, 4, GL_UNSIGNED_BYTE
, GL_TRUE
,
323 stride
, (void *)offsetof(mdl_vert
, colour
) );
324 glEnableVertexAttribArray( 3 );
327 glVertexAttribPointer( 4, 4, GL_UNSIGNED_SHORT
, GL_TRUE
,
328 stride
, (void *)offsetof(mdl_vert
, weights
) );
329 glEnableVertexAttribArray( 4 );
332 glVertexAttribIPointer( 5, 4, GL_UNSIGNED_BYTE
,
333 stride
, (void *)offsetof(mdl_vert
, groups
) );
334 glEnableVertexAttribArray( 5 );
338 mesh
->indice_count
= indice_count
;
342 VG_STATIC
void mesh_bind( glmesh
*mesh
)
344 glBindVertexArray( mesh
->vao
);
347 VG_STATIC
void mesh_drawn( u32 start
, u32 count
)
349 glDrawElements( GL_TRIANGLES
, count
, GL_UNSIGNED_INT
,
350 (void *)(start
*sizeof(u32
)) );
353 VG_STATIC
void mesh_draw( glmesh
*mesh
)
355 mesh_drawn( 0, mesh
->indice_count
);
358 VG_STATIC
void mesh_free( glmesh
*mesh
)
362 glDeleteVertexArrays( 1, &mesh
->vao
);
363 glDeleteBuffers( 1, &mesh
->ebo
);
364 glDeleteBuffers( 1, &mesh
->vbo
);
369 VG_STATIC
void mdl_load_fatal_corrupt( mdl_context
*mdl
)
372 vg_file_print_invalid( mdl
->file
);
373 vg_fatal_exit_loop( "Corrupt model" );
377 * Model implementation
381 * you have two api options for loading a model, first, the easy way:
383 * will put the entire model straight into the linear_alloc
385 * or, to target different allocators:
389 * mdl_load_vertex_data
390 * mdl_load_indice_data
393 * these should ideally be called in quick succession to limit stalls.
397 * if calling mdl_open, and the file does not exist, the game will fatal quit
399 VG_STATIC
void mdl_open( mdl_context
*mdl
, const char *path
)
401 memset( mdl
, 0, sizeof( mdl_context
) );
402 mdl
->file
= fopen( path
, "rb" );
406 vg_error( "mdl_open('%s'): %s\n", path
, strerror(errno
) );
407 vg_fatal_exit_loop( "see above for details" );
410 u64 l
= fread( &mdl
->info
, sizeof(mdl_file_header
), 1, mdl
->file
);
412 mdl_load_fatal_corrupt( mdl
);
416 * Load all metadata (everything up until the large buffers). Probs at most 50k
418 VG_STATIC
void mdl_load_metadata( mdl_context
*mdl
, void *lin_alloc
)
422 u64 lheader
= sizeof(mdl_file_header
),
423 ldata
= mdl
->info
.keyframe_offset
- lheader
;
425 void *all_data
= vg_linear_alloc( lin_alloc
, ldata
);
427 fseek( mdl
->file
, lheader
, SEEK_SET
);
428 u64 l
= fread( all_data
, ldata
, 1, mdl
->file
);
432 vg_file_print_invalid( mdl
->file
);
433 vg_fatal_exit_loop( "Corrupt model" );
436 mdl
->node_buffer
= all_data
+ (mdl
->info
.node_offset
- lheader
);
437 mdl
->submesh_buffer
= all_data
+ (mdl
->info
.submesh_offset
- lheader
);
438 mdl
->material_buffer
= all_data
+ (mdl
->info
.material_offset
- lheader
);
439 mdl
->texture_buffer
= all_data
+ (mdl
->info
.texture_offset
- lheader
);
440 mdl
->anim_buffer
= all_data
+ (mdl
->info
.anim_offset
- lheader
);
441 mdl
->entdata_buffer
= all_data
+ (mdl
->info
.entdata_offset
- lheader
);
442 mdl
->string_buffer
= all_data
+ (mdl
->info
.strings_offset
- lheader
);
446 * Load just the mesh data
448 VG_STATIC
void mdl_load_mesh_data( mdl_context
*mdl
, void *lin_alloc
)
452 u64 size_verts
= vg_align8( mdl
->info
.vertex_count
* sizeof(mdl_vert
) ),
453 size_index
= vg_align8( mdl
->info
.indice_count
* sizeof(u32
) );
455 mdl
->vertex_buffer
= vg_linear_alloc( lin_alloc
, size_verts
);
456 mdl
->index_buffer
= vg_linear_alloc( lin_alloc
, size_index
);
459 fseek( mdl
->file
, mdl
->info
.vertex_offset
, SEEK_SET
);
460 u64 l
= fread( mdl
->vertex_buffer
, size_verts
, 1, mdl
->file
);
462 mdl_load_fatal_corrupt( mdl
);
465 fseek( mdl
->file
, mdl
->info
.indice_offset
, SEEK_SET
);
466 u64 l
= fread( mdl
->index_buffer
, size_index
, 1, mdl
->file
);
468 mdl_load_fatal_corrupt( mdl
);
473 * Load animation data
475 VG_STATIC
void mdl_load_anim_data( mdl_context
*mdl
, void *lin_alloc
)
479 if( mdl
->info
.keyframe_count
== 0 )
482 u64 size_kf
= vg_align8( mdl
->info
.keyframe_count
* sizeof(mdl_keyframe
) );
483 mdl
->keyframe_buffer
= vg_linear_alloc( lin_alloc
, size_kf
);
485 fseek( mdl
->file
, mdl
->info
.keyframe_offset
, SEEK_SET
);
486 u64 l
= fread( mdl
->keyframe_buffer
, size_kf
, 1, mdl
->file
);
488 mdl_load_fatal_corrupt( mdl
);
494 * TODO request specific files (low)
496 VG_STATIC
void mdl_load_pack_data( mdl_context
*mdl
, void *lin_alloc
)
500 if( mdl
->info
.pack_size
== 0 )
503 mdl
->pack
= vg_linear_alloc( lin_alloc
, vg_align8( mdl
->info
.pack_size
) );
504 fseek( mdl
->file
, mdl
->info
.pack_offset
, SEEK_SET
);
506 u64 l
= fread( mdl
->pack
, mdl
->info
.pack_size
, 1, mdl
->file
);
508 mdl_load_fatal_corrupt( mdl
);
514 VG_STATIC
void mdl_close( mdl_context
*mdl
)
520 /* open a model. TODO: make this flags ( ANIM_DATA|MESH_DATA ... ) */
521 VG_STATIC mdl_context
*mdl_load_full( void *lin_alloc
, const char *path
)
523 /* Inspect the header by opening it, give us the size needed */
524 mdl_context temp_ctx
;
525 mdl_open( &temp_ctx
, path
);
527 /* create allocator */
528 u32 tot_size
= temp_ctx
.info
.file_length
+ sizeof( mdl_context
) + 64;
529 void *data
= vg_create_linear_allocator( lin_alloc
, tot_size
,
532 /* copy context and load all other data */
533 mdl_context
*ctx
= vg_linear_alloc( data
, sizeof(mdl_context
) );
534 memcpy( ctx
, &temp_ctx
, sizeof(mdl_context
) );
536 mdl_load_metadata( ctx
, data
);
537 mdl_load_anim_data( ctx
, data
);
538 mdl_load_mesh_data( ctx
, data
);
539 mdl_load_pack_data( ctx
, data
);
547 * ----------------------------------------------------------------------------
548 * TODO: Clamp access and oob errors
550 VG_STATIC
const char *mdl_pstr( mdl_context
*mdl
, u32 pstr
)
552 return mdl
->string_buffer
+ pstr
;
555 VG_STATIC mdl_node
*mdl_node_from_id( mdl_context
*mdl
, u32 id
)
557 return &mdl
->node_buffer
[id
];
560 VG_STATIC mdl_node
*mdl_node_from_name( mdl_context
*mdl
, const char *name
)
562 for( int i
=0; i
< mdl
->info
.node_count
; i
++ )
564 mdl_node
*pnode
= mdl_node_from_id( mdl
, i
);
566 if( !strcmp( name
, mdl_pstr( mdl
, pnode
->pstr_name
)) )
573 VG_STATIC mdl_submesh
*mdl_node_submesh( mdl_context
*mdl
,
574 mdl_node
*node
, u32 i
)
576 return &mdl
->submesh_buffer
[ node
->submesh_start
+i
];
579 VG_STATIC u32
*mdl_submesh_indices( mdl_context
*mdl
, mdl_submesh
*sm
)
581 return &mdl
->index_buffer
[ sm
->indice_start
];
584 VG_STATIC mdl_vert
*mdl_submesh_vertices( mdl_context
*mdl
, mdl_submesh
*sm
)
586 return &mdl
->vertex_buffer
[ sm
->vertex_start
];
589 VG_STATIC
void mdl_node_transform( mdl_node
*pnode
, m4x3f transform
)
591 q_m3x3( pnode
->q
, transform
);
592 v3_muls( transform
[0], pnode
->s
[0], transform
[0] );
593 v3_muls( transform
[1], pnode
->s
[1], transform
[1] );
594 v3_muls( transform
[2], pnode
->s
[2], transform
[2] );
595 v3_copy( pnode
->co
, transform
[3] );
598 /* upload a mesh based on file submesh */
599 VG_STATIC
void mdl_unpack_submesh( mdl_context
*mdl
, glmesh
*mesh
,
602 mesh_upload( mesh
, mdl_submesh_vertices( mdl
, sm
), sm
->vertex_count
,
603 mdl_submesh_indices( mdl
, sm
), sm
->indice_count
);
606 /* upload entire mesh from model */
607 VG_STATIC
void mdl_unpack_glmesh( mdl_context
*mdl
, glmesh
*mesh
)
609 u32 offset
= mdl
->submesh_buffer
[0].vertex_count
;
611 for( int i
=1; i
< mdl
->info
.submesh_count
; i
++ )
613 mdl_submesh
*sm
= &mdl
->submesh_buffer
[i
];
614 u32
*indices
= mdl_submesh_indices( mdl
, sm
);
616 for( u32 j
=0; j
<sm
->indice_count
; j
++ )
617 indices
[j
] += offset
;
619 offset
+= sm
->vertex_count
;
622 mesh_upload( mesh
, mdl
->vertex_buffer
, mdl
->info
.vertex_count
,
623 mdl
->index_buffer
, mdl
->info
.indice_count
);
626 VG_STATIC
void mdl_draw_submesh( mdl_submesh
*sm
)
628 mesh_drawn( sm
->indice_start
, sm
->indice_count
);
631 VG_STATIC
void *mdl_get_entdata( mdl_context
*mdl
, mdl_node
*pnode
)
633 return mdl
->entdata_buffer
+ pnode
->offset
;
636 VG_STATIC mdl_keyframe
*mdl_get_animdata( mdl_context
*mdl
, mdl_animation
*anim
)
638 return mdl
->keyframe_buffer
+ anim
->offset
;
641 VG_STATIC
void mdl_link_materials( mdl_context
*root
, mdl_context
*child
)
643 u32 lookup
[MDL_MATERIAL_MAX
];
645 for( int i
=0; i
<child
->info
.material_count
; i
++ )
647 mdl_material
*mi
= &child
->material_buffer
[i
];
648 const char *si
= mdl_pstr( child
, mi
->pstr_name
);
652 for( int j
=0; j
<root
->info
.material_count
; j
++ )
654 mdl_material
*mj
= &root
->material_buffer
[j
];
655 const char *sj
= mdl_pstr( root
, mj
->pstr_name
);
657 if( !strcmp( si
, sj
) )
664 if( lookup
[i
] == 0 && i
!= 0 )
666 vg_warn( "Could not link material '%s' (not present in root model)\n",
671 for( int i
=0; i
<child
->info
.submesh_count
; i
++ )
673 mdl_submesh
*sm
= &child
->submesh_buffer
[i
];
674 sm
->material_id
= lookup
[sm
->material_id
];
678 VG_STATIC
void mdl_invert_uv_coordinates( mdl_context
*mdl
)
680 for( int i
=0; i
<mdl
->info
.vertex_count
; i
++ )
682 mdl_vert
*vert
= &mdl
->vertex_buffer
[i
];
683 vert
->uv
[1] = 1.0f
-vert
->uv
[1];