2 * Copyright (C) 2021-2023 Mt.ZERO Software, Harry Godden - All Rights Reserved
10 #define MDL_VERSION_MIN 101
11 #define MDL_VERSION_NR 102
14 k_shader_standard
= 0,
15 k_shader_standard_cutout
= 1,
16 k_shader_terrain_blend
= 2,
17 k_shader_standard_vertex_blend
= 3,
19 k_shader_invisible
= 5,
20 k_shader_boundary
= 6,
25 enum mdl_surface_prop
{
26 k_surface_prop_concrete
= 0,
27 k_surface_prop_wood
= 1,
28 k_surface_prop_grass
= 2,
29 k_surface_prop_tiles
= 3,
30 k_surface_prop_metal
= 4
34 k_material_flag_skate_target
= 0x00000001,
35 k_material_flag_collision
= 0x00000002,
36 k_material_flag_grow_grass
= 0x00000004,
37 k_material_flag_grindable
= 0x00000008,
38 k_material_flag_invisible
= 0x00000010,
39 k_material_flag_boundary
= 0x00000020,
40 k_material_flag_preview_visibile
= 0x00000040
52 u8 colour
[4]; /* 4*8 */
53 u16 weights
[4];/* 4*16 */
54 u8 groups
[4]; /* 4*8 */
59 typedef struct mdl_context mdl_context
;
60 typedef struct mdl_array_ptr mdl_array_ptr
;
61 typedef struct mdl_vert mdl_vert
;
62 typedef struct mdl_transform mdl_transform
;
63 typedef struct mdl_submesh mdl_submesh
;
64 typedef struct mdl_material mdl_material
;
65 typedef struct mdl_bone mdl_bone
;
66 typedef struct mdl_armature mdl_armature
;
67 typedef struct mdl_animation mdl_animation
;
68 typedef struct mdl_transform mdl_keyframe
;
69 typedef struct mdl_mesh mdl_mesh
;
70 typedef struct mdl_file mdl_file
;
71 typedef struct mdl_texture mdl_texture
;
72 typedef struct mdl_array mdl_array
;
73 typedef struct mdl_header mdl_header
;
75 typedef struct glmesh glmesh
;
89 static void transform_identity( mdl_transform
*transform
)
91 v3_zero( transform
->co
);
92 q_identity( transform
->q
);
93 v3_fill( transform
->s
, 1.0f
);
96 static void mdl_transform_vector( mdl_transform
*transform
, v3f vec
, v3f dest
)
98 v3_mul( transform
->s
, vec
, dest
);
99 q_mulv( transform
->q
, dest
, dest
);
102 static void mdl_transform_point( mdl_transform
*transform
, v3f co
, v3f dest
)
104 mdl_transform_vector( transform
, co
, dest
);
105 v3_add( transform
->co
, dest
, dest
);
108 static void mdl_transform_mul( mdl_transform
*a
, mdl_transform
*b
,
111 mdl_transform_point( a
, b
->co
, d
->co
);
112 q_mul( a
->q
, b
->q
, d
->q
);
114 v3_mul( a
->s
, b
->s
, d
->s
);
143 v3f conevx
, conevy
, coneva
;
149 k_bone_flag_deform
= 0x00000001,
150 k_bone_flag_ik
= 0x00000002,
151 k_bone_flag_cone_constraint
= 0x00000004
156 k_bone_collider_none
= 0,
157 k_bone_collider_box
= 1,
158 k_bone_collider_capsule
= 2
163 mdl_transform transform
;
186 u16 material_id
, flags
;
191 k_submesh_flag_none
= 0x0000,
192 k_submesh_flag_consumed
= 0x0001
197 mdl_transform transform
;
201 entity_id
, /* upper 16 bits: type, lower 16 bits: index */
237 struct mdl_array_ptr
{
253 /* animation buffers */
259 u32 pack_base_offset
;
266 VG_STATIC
void mdl_load_fatal_corrupt( mdl_context
*mdl
)
269 vg_file_print_invalid( mdl
->file
);
270 vg_fatal_error( "Corrupt model" );
274 * Model implementation
277 VG_STATIC u32
mdl_query_array_size( mdl_array
*arr
)
279 if( arr
->item_count
){
280 u32 size
= arr
->item_size
*arr
->item_count
;
281 return vg_align8(size
);
286 VG_STATIC
const char *mdl_pstr( mdl_context
*mdl
, u32 pstr
);
288 void mdl_fread_pack_file( mdl_context
*mdl
, mdl_file
*info
, void *dst
)
290 if( !info
->pack_size
){
291 vg_warn( "path: %s\n", mdl_pstr( mdl
, info
->pstr_path
) );
292 vg_fatal_error( "Packed file is only a header; it is not packed" );
295 fseek( mdl
->file
, mdl
->pack_base_offset
+info
->pack_offset
, SEEK_SET
);
296 u64 l
= fread( dst
, info
->pack_size
, 1, mdl
->file
);
298 if( l
!= 1 ) mdl_load_fatal_corrupt( mdl
);
301 /* TODO: Rename these */
302 VG_STATIC
void mdl_load_array_file_buffer( mdl_context
*mdl
, mdl_array
*arr
,
305 if( arr
->item_count
){
306 fseek( mdl
->file
, arr
->file_offset
, SEEK_SET
);
307 u64 l
= fread( buffer
, arr
->item_size
*arr
->item_count
, 1, mdl
->file
);
309 if( l
!= 1 ) mdl_load_fatal_corrupt( mdl
);
313 VG_STATIC
void mdl_load_array_file( mdl_context
*mdl
, mdl_array_ptr
*ptr
,
314 mdl_array
*arr
, void *lin_alloc
)
316 if( arr
->item_count
){
317 u32 size
= arr
->item_size
*arr
->item_count
;
318 ptr
->data
= vg_linear_alloc( lin_alloc
, vg_align8(size
) );
319 mdl_load_array_file_buffer( mdl
, arr
, ptr
->data
);
324 ptr
->count
= arr
->item_count
;
325 ptr
->stride
= arr
->item_size
;
328 VG_STATIC
void *mdl_arritm( mdl_array_ptr
*arr
, u32 index
)
330 return ((u8
*)arr
->data
) + index
*arr
->stride
;
333 VG_STATIC u32
mdl_arrcount( mdl_array_ptr
*arr
)
338 VG_STATIC mdl_array
*mdl_find_array( mdl_context
*mdl
, const char *name
)
340 for( u32 i
=0; i
<mdl_arrcount(&mdl
->index
); i
++ ){
341 mdl_array
*arr
= mdl_arritm( &mdl
->index
, i
);
343 if( !strncmp(arr
->name
,name
,16) ){
351 VG_STATIC
int mdl_load_array( mdl_context
*mdl
, mdl_array_ptr
*ptr
,
352 const char *name
, void *lin_alloc
)
354 mdl_array
*arr
= mdl_find_array( mdl
, name
);
357 mdl_load_array_file( mdl
, ptr
, arr
, lin_alloc
);
368 VG_STATIC
int mdl_load_mesh_block( mdl_context
*mdl
, void *lin_alloc
)
372 success
&= mdl_load_array( mdl
, &mdl
->verts
, "mdl_vert", lin_alloc
);
373 success
&= mdl_load_array( mdl
, &mdl
->indices
, "mdl_indice", lin_alloc
);
378 VG_STATIC
int mdl_load_metadata_block( mdl_context
*mdl
, void *lin_alloc
)
382 success
&= mdl_load_array( mdl
, &mdl
->strings
, "strings", lin_alloc
);
383 success
&= mdl_load_array( mdl
, &mdl
->meshs
, "mdl_mesh", lin_alloc
);
384 success
&= mdl_load_array( mdl
, &mdl
->submeshs
, "mdl_submesh", lin_alloc
);
385 success
&= mdl_load_array( mdl
, &mdl
->materials
, "mdl_material", lin_alloc
);
386 success
&= mdl_load_array( mdl
, &mdl
->textures
, "mdl_texture", lin_alloc
);
387 success
&= mdl_load_array( mdl
, &mdl
->armatures
, "mdl_armature", lin_alloc
);
388 success
&= mdl_load_array( mdl
, &mdl
->bones
, "mdl_bone", lin_alloc
);
389 success
&= mdl_load_array( mdl
, &mdl
->animations
,"mdl_animation",lin_alloc
);
394 VG_STATIC
int mdl_load_animation_block( mdl_context
*mdl
, void *lin_alloc
)
396 return mdl_load_array( mdl
, &mdl
->keyframes
, "mdl_keyframe", lin_alloc
);
400 * if calling mdl_open, and the file does not exist, the game will fatal quit
402 VG_STATIC
void mdl_open( mdl_context
*mdl
, const char *path
, void *lin_alloc
)
404 memset( mdl
, 0, sizeof( mdl_context
) );
405 mdl
->file
= fopen( path
, "rb" );
408 vg_error( "mdl_open('%s'): %s\n", path
, strerror(errno
) );
409 vg_fatal_error( "see above for details" );
412 u64 l
= fread( &mdl
->info
, sizeof(mdl_header
), 1, mdl
->file
);
414 mdl_load_fatal_corrupt( mdl
);
416 if( mdl
->info
.version
< MDL_VERSION_MIN
){
417 vg_warn( "For model: %s\n", path
);
418 vg_warn( " version: %u (min: %u, current: %u)\n",
419 mdl
->info
.version
, MDL_VERSION_MIN
, MDL_VERSION_NR
);
421 vg_fatal_error( "Legacy model version incompatable" );
424 mdl_load_array_file( mdl
, &mdl
->index
, &mdl
->info
.index
, lin_alloc
);
426 mdl_array
*pack
= mdl_find_array( mdl
, "pack" );
427 if( pack
) mdl
->pack_base_offset
= pack
->file_offset
;
428 else mdl
->pack_base_offset
= 0;
434 VG_STATIC
void mdl_close( mdl_context
*mdl
)
440 /* useful things you can do with the model */
442 VG_STATIC
void mdl_transform_m4x3( mdl_transform
*transform
, m4x3f mtx
)
444 q_m3x3( transform
->q
, mtx
);
445 v3_muls( mtx
[0], transform
->s
[0], mtx
[0] );
446 v3_muls( mtx
[1], transform
->s
[1], mtx
[1] );
447 v3_muls( mtx
[2], transform
->s
[2], mtx
[2] );
448 v3_copy( transform
->co
, mtx
[3] );
451 VG_STATIC
const char *mdl_pstr( mdl_context
*mdl
, u32 pstr
)
453 return ((char *)mdl_arritm( &mdl
->strings
, pstr
)) + 4;
458 mdl_pstreq( mdl_context
*mdl
, u32 pstr
, const char *str
, u32 djb2
)
460 u32 hash
= *((u32
*)mdl_arritm( &mdl
->strings
, pstr
));
462 if( !strcmp( str
, mdl_pstr( mdl
, pstr
))) return 1;
468 #define MDL_CONST_PSTREQ( MDL, Q, CONSTSTR )\
469 mdl_pstreq( MDL, Q, CONSTSTR, vg_strdjb2( CONSTSTR ) )
472 * Simple mesh interface for OpenGL
473 * ----------------------------------------------------------------------------
476 VG_STATIC
void mesh_upload( glmesh
*mesh
,
477 mdl_vert
*verts
, u32 vert_count
,
478 u32
*indices
, u32 indice_count
)
480 //assert( mesh->loaded == 0 );
482 glGenVertexArrays( 1, &mesh
->vao
);
483 glGenBuffers( 1, &mesh
->vbo
);
484 glGenBuffers( 1, &mesh
->ebo
);
485 glBindVertexArray( mesh
->vao
);
487 size_t stride
= sizeof(mdl_vert
);
489 glBindBuffer( GL_ARRAY_BUFFER
, mesh
->vbo
);
490 glBufferData( GL_ARRAY_BUFFER
, vert_count
*stride
, verts
, GL_STATIC_DRAW
);
492 glBindVertexArray( mesh
->vao
);
493 glBindBuffer( GL_ELEMENT_ARRAY_BUFFER
, mesh
->ebo
);
494 glBufferData( GL_ELEMENT_ARRAY_BUFFER
, indice_count
*sizeof(u32
),
495 indices
, GL_STATIC_DRAW
);
498 glVertexAttribPointer( 0, 3, GL_FLOAT
, GL_FALSE
, stride
, (void*)0 );
499 glEnableVertexAttribArray( 0 );
502 glVertexAttribPointer( 1, 3, GL_FLOAT
, GL_FALSE
,
503 stride
, (void *)offsetof(mdl_vert
, norm
) );
504 glEnableVertexAttribArray( 1 );
507 glVertexAttribPointer( 2, 2, GL_FLOAT
, GL_FALSE
,
508 stride
, (void *)offsetof(mdl_vert
, uv
) );
509 glEnableVertexAttribArray( 2 );
512 glVertexAttribPointer( 3, 4, GL_UNSIGNED_BYTE
, GL_TRUE
,
513 stride
, (void *)offsetof(mdl_vert
, colour
) );
514 glEnableVertexAttribArray( 3 );
517 glVertexAttribPointer( 4, 4, GL_UNSIGNED_SHORT
, GL_TRUE
,
518 stride
, (void *)offsetof(mdl_vert
, weights
) );
519 glEnableVertexAttribArray( 4 );
522 glVertexAttribIPointer( 5, 4, GL_UNSIGNED_BYTE
,
523 stride
, (void *)offsetof(mdl_vert
, groups
) );
524 glEnableVertexAttribArray( 5 );
528 mesh
->indice_count
= indice_count
;
532 VG_STATIC
void mesh_bind( glmesh
*mesh
)
534 glBindVertexArray( mesh
->vao
);
537 VG_STATIC
void mesh_drawn( u32 start
, u32 count
)
539 glDrawElements( GL_TRIANGLES
, count
, GL_UNSIGNED_INT
,
540 (void *)(start
*sizeof(u32
)) );
543 VG_STATIC
void mesh_draw( glmesh
*mesh
)
545 mesh_drawn( 0, mesh
->indice_count
);
548 VG_STATIC
void mesh_free( glmesh
*mesh
)
551 glDeleteVertexArrays( 1, &mesh
->vao
);
552 glDeleteBuffers( 1, &mesh
->ebo
);
553 glDeleteBuffers( 1, &mesh
->vbo
);
558 VG_STATIC
void mdl_draw_submesh( mdl_submesh
*sm
)
560 mesh_drawn( sm
->indice_start
, sm
->indice_count
);
563 VG_STATIC mdl_mesh
*mdl_find_mesh( mdl_context
*mdl
, const char *name
)
565 for( u32 i
=0; i
<mdl_arrcount( &mdl
->meshs
); i
++ ){
566 mdl_mesh
*mesh
= mdl_arritm( &mdl
->meshs
, i
);
567 if( !strcmp( name
, mdl_pstr( mdl
, mesh
->pstr_name
))){
574 struct payload_glmesh_load
{
584 VG_STATIC
void async_mdl_load_glmesh( void *payload
, u32 size
)
586 struct payload_glmesh_load
*job
= payload
;
587 mesh_upload( job
->mesh
, job
->verts
, job
->vertex_count
,
588 job
->indices
, job
->indice_count
);
591 /* TODO: Find out if this needs deprecating in favour of the new full loader */
592 VG_STATIC
void mdl_async_load_glmesh( mdl_context
*mdl
, glmesh
*mesh
)
594 mdl_array
*arr_vertices
= mdl_find_array( mdl
, "mdl_vert" );
595 mdl_array
*arr_indices
= mdl_find_array( mdl
, "mdl_indice" );
597 if( arr_vertices
&& arr_indices
){
598 u32 size_verts
= vg_align8(mdl_query_array_size( arr_vertices
)),
599 size_indices
= vg_align8(mdl_query_array_size( arr_indices
)),
600 size_hdr
= vg_align8(sizeof(struct payload_glmesh_load
)),
601 total
= size_hdr
+ size_verts
+ size_indices
;
603 vg_async_item
*call
= vg_async_alloc( total
);
604 struct payload_glmesh_load
*job
= call
->payload
;
606 u8
*payload
= call
->payload
;
609 job
->verts
= (void*)(payload
+ size_hdr
);
610 job
->indices
= (void*)(payload
+ size_hdr
+ size_verts
);
611 job
->vertex_count
= arr_vertices
->item_count
;
612 job
->indice_count
= arr_indices
->item_count
;
614 mdl_load_array_file_buffer( mdl
, arr_vertices
, job
->verts
);
615 mdl_load_array_file_buffer( mdl
, arr_indices
, job
->indices
);
618 * Unpack the indices (if there are meshes)
619 * ---------------------------------------------------------
622 if( mdl_arrcount( &mdl
->submeshs
) ){
623 mdl_submesh
*sm
= mdl_arritm( &mdl
->submeshs
, 0 );
624 u32 offset
= sm
->vertex_count
;
626 for( u32 i
=1; i
<mdl_arrcount( &mdl
->submeshs
); i
++ ){
627 mdl_submesh
*sm
= mdl_arritm( &mdl
->submeshs
, i
);
628 u32
*indices
= job
->indices
+ sm
->indice_start
;
630 for( u32 j
=0; j
<sm
->indice_count
; j
++ )
631 indices
[j
] += offset
;
633 offset
+= sm
->vertex_count
;
639 * -------------------------
642 vg_async_dispatch( call
, async_mdl_load_glmesh
);
645 vg_fatal_error( "no vertex/indice data\n" );
649 /* uploads the glmesh, and textures. everything is saved into the mdl_context */
650 VG_STATIC
void mdl_async_full_load_std( mdl_context
*mdl
){
651 mdl_async_load_glmesh( mdl
, &mdl
->mesh
);
653 for( u32 i
=0; i
<mdl_arrcount( &mdl
->textures
); i
++ ){
654 vg_linear_clear( vg_mem
.scratch
);
655 mdl_texture
*tex
= mdl_arritm( &mdl
->textures
, i
);
657 void *data
= vg_linear_alloc( vg_mem
.scratch
, tex
->file
.pack_size
);
658 mdl_fread_pack_file( mdl
, &tex
->file
, data
);
660 vg_tex2d_load_qoi_async( data
, tex
->file
.pack_size
,
661 VG_TEX2D_CLAMP
|VG_TEX2D_NEAREST
, &tex
->glname
);