xash3d-fwgs/ref/vk/vk_materials.c

#include "vk_materials.h"
#include "vk_textures.h"
#include "vk_mapents.h"
#include "vk_const.h"
#include "profiler.h"
#include "vk_logs.h"
#include "unordered_roadmap.h"

#include <stdio.h>

#define LOG_MODULE mat

#define MAX_INCLUDE_DEPTH 4

#define MAX_MATERIALS 2048
#define MAX_NEW_MATERIALS 128

static r_vk_material_t k_default_material = {
	.tex_base_color = -1,
	.tex_metalness = 0,
	.tex_roughness = 0,
	.tex_normalmap = 0, // 0 means no normal map, checked in shaders

	.metalness = 0.f,
	.roughness = 1.f,
	.normal_scale = 1.f,
	.base_color = { 1.f, 1.f, 1.f, 1.f },
};

/* TODO
enum {
#define X(bit, type, name, key, func) kMatField_##key = (1 << (bit)),
MATERIAL_FIELDS_LIST(X)
#undef X
};
*/

#define MAX_RENDERMODE_MATERIALS 32
typedef struct {
		struct {
			int tex_id;
			r_vk_material_ref_t mat;
		} map[MAX_RENDERMODE_MATERIALS];
		int count;
} r_vk_material_per_mode_t;

enum {
	kMaterialNotChecked = 0,
	kMaterialNoReplacement = -1,
};

typedef struct {
	int mat_id;

	// TODO rendermode chain
} texture_to_material_t;

typedef struct {
	//int for_tex_id;
	string name;

	r_vk_material_t material;
} material_entry_t;

typedef struct {
	urmom_header_t hdr_;
	int mat_id; // into g_materials.table
} material_name_map_t;

static struct {
	int count;
	material_entry_t table[MAX_MATERIALS];

	texture_to_material_t tex_to_mat[MAX_TEXTURES];

	// TODO embed into tex_to_mat
	r_vk_material_per_mode_t for_rendermode[kRenderTransAdd+1];

	urmom_desc_t map_desc;
	material_name_map_t map[MAX_NEW_MATERIALS];
} g_materials;

static struct {
	int mat_files_read;
	int texture_lookups;
	int texture_loads;
	uint64_t material_file_read_duration_ns;
	uint64_t texture_lookup_duration_ns;
	uint64_t texture_load_duration_ns;
} g_stats;

static int loadTexture( const char *filename, qboolean force_reload, colorspace_hint_e colorspace ) {
	const uint64_t load_begin_ns = aprof_time_now_ns();
	const int tex_id = R_TextureUploadFromFileExAcquire( filename, colorspace, force_reload );
	DEBUG("Loaded texture %s => %d", filename, tex_id);
	g_stats.texture_loads++;
	g_stats.texture_load_duration_ns += aprof_time_now_ns() - load_begin_ns;
	return tex_id ? tex_id : -1;
}

static void makePath(char *out, size_t out_size, const char *value, const char *path_begin, const char *path_end) {
	if (value[0] == '/') {
		// Path relative to valve/pbr dir
		Q_snprintf(out, out_size, "pbr%s", value);
	} else {
		// Path relative to current material.mat file
		Q_snprintf(out, out_size, "%.*s%s", (int)(path_end - path_begin), path_begin, value);
	}
}

#define MAKE_PATH(out, value) \
	makePath(out, sizeof(out), value, path_begin, path_end)

static void printMaterial(int index) {
	const char* const name = g_materials.table[index].name;
	const r_vk_material_t* const mat = &g_materials.table[index].material;

	DEBUG("material[%d] \"%s\" (tbc=%d, tr=%d, tm=%d, tn=%d bc=(%.03f,%.03f,%.03f,%.03f) r=%.03f m=%.03f ns=%.03f",
		index, name,
		mat->tex_base_color, mat->tex_roughness, mat->tex_metalness, mat->tex_normalmap,
		mat->base_color[0], mat->base_color[1], mat->base_color[2], mat->base_color[3],
		mat->roughness, mat->metalness, mat->normal_scale
		);
}

static void acquireTexturesForMaterial( int index ) {
	const r_vk_material_t *mat = &g_materials.table[index].material;
	DEBUG("%s(%d: %s)", __FUNCTION__, index, g_materials.table[index].name);
	if (mat->tex_base_color > 0)
		R_TextureAcquire(mat->tex_base_color);
	R_TextureAcquire(mat->tex_metalness);
	R_TextureAcquire(mat->tex_roughness);
	if (mat->tex_normalmap > 0)
		R_TextureAcquire(mat->tex_normalmap);
}

static void releaseTexturesForMaterialPtr( const r_vk_material_t *mat ) {
	if (mat->tex_base_color > 0)
		R_TextureRelease(mat->tex_base_color);
	R_TextureRelease(mat->tex_metalness);
	R_TextureRelease(mat->tex_roughness);
	if (mat->tex_normalmap > 0)
		R_TextureRelease(mat->tex_normalmap);
}

static void releaseTexturesForMaterial( int index ) {
	const r_vk_material_t *mat = &g_materials.table[index].material;
	DEBUG("%s(%d: %s)", __FUNCTION__, index, g_materials.table[index].name);
	releaseTexturesForMaterialPtr( mat );
}

static int addMaterial(const char *name, const r_vk_material_t* mat) {
	if (g_materials.count == MAX_MATERIALS) {
		ERR("Max count of materials %d reached", MAX_MATERIALS);
		return -1;
	}

	Q_strncpy(g_materials.table[g_materials.count].name, name, sizeof g_materials.table[g_materials.count].name);
	g_materials.table[g_materials.count].material = *mat;
	acquireTexturesForMaterial(g_materials.count);

	printMaterial(g_materials.count);

	ASSERT(mat->tex_base_color >= 0);
	ASSERT(mat->tex_metalness >= 0);
	ASSERT(mat->tex_roughness >= 0);
	ASSERT(mat->tex_normalmap >= 0);

	return g_materials.count++;
}

static void assignMaterialForTexture(const char *name, int for_tex_id, int mat_id) {
	const char* const tex_name = R_TextureGetNameByIndex(for_tex_id);
	DEBUG("Assigning material \"%s\" for_tex_id=\"%s\"(%d)", name, tex_name, for_tex_id);

	ASSERT(mat_id >= 0);
	ASSERT(mat_id < g_materials.count);

	ASSERT(for_tex_id < COUNTOF(g_materials.tex_to_mat));
	texture_to_material_t* const t2m = g_materials.tex_to_mat + for_tex_id;

	if (t2m->mat_id == kMaterialNoReplacement) {
		ERR("Texture \"%s\"(%d) has been already queried by something. Only future queries will get the new material", tex_name, for_tex_id);
	} else if (t2m->mat_id != kMaterialNotChecked) {
		ERR("Texture \"%s\"(%d) already has material assigned, will replace", tex_name, for_tex_id);
	}

	t2m->mat_id = mat_id;
}

static void loadMaterialsFromFile( const char *filename, int depth ) {
	const uint64_t load_file_begin_ns = aprof_time_now_ns();
	byte *data = gEngine.fsapi->LoadFile( filename, 0, false );
	g_stats.material_file_read_duration_ns +=  aprof_time_now_ns() - load_file_begin_ns;

	r_vk_material_t current_material = k_default_material;
	int for_tex_id = -1;
	qboolean force_reload = false;
	qboolean create = false;
	qboolean metalness_set = false;

	string name;
	string basecolor_map, normal_map, metal_map, roughness_map;
	//uint32_t fields;

	int rendermode = 0;

	DEBUG("Loading materials from %s (exists=%d)", filename, data != 0);

	if ( !data )
		return;

	const char *const path_begin = filename;
	const char *path_end = Q_strrchr(filename, '/');
	if ( !path_end )
		path_end = path_begin;
	else
		path_end++;

	char *pos = (char*)data;
	for (;;) {
		char key[1024];
		char value[1024];

		const char *const line_begin = pos;
		pos = COM_ParseFile(pos, key, sizeof(key));
		ASSERT(Q_strlen(key) < sizeof(key));
		if (!pos)
			break;

		if (key[0] == '{') {
			current_material = k_default_material;
			for_tex_id = -1;
			force_reload = false;
			create = false;
			metalness_set = false;
			name[0] = basecolor_map[0] = normal_map[0] = metal_map[0] = roughness_map[0] = '\0';
			rendermode = 0;
			//fields = 0;
			continue;
		}

		if (key[0] == '}') {
			if (for_tex_id <= 0 && !create) {
				// Skip this material, as its texture hasn't been loaded
				// NOTE: might want to check whether it makes sense wrt late-loading stuff
				continue;
			}

			if (name[0] == '\0') {
				WARN("Unreferenceable (no \"for_texture\", no \"new\") material found in %s", filename);
				continue;
			}

			// If basecolor_map wasn't inherited
			if (current_material.tex_base_color < 0) {
			// Start with *default texture for base color, it will be acquired if no replacement is specified or could be loaded.
				current_material.tex_base_color = for_tex_id >= 0 ? for_tex_id : 0;
			}

#define LOAD_TEXTURE_FOR(name, field, colorspace) \
			do { \
				if (name[0] != '\0') { \
					char texture_path[256]; \
					MAKE_PATH(texture_path, name); \
					const int tex_id = loadTexture(texture_path, force_reload, colorspace); \
					if (tex_id < 0) { \
						ERR("Failed to load texture \"%s\" for "#name"", name); \
						if (current_material.field > 0) \
							R_TextureAcquire(current_material.field); \
					} else { \
						current_material.field = tex_id; \
					} \
				} else { \
					if (current_material.field > 0) \
						R_TextureAcquire(current_material.field); \
				} \
			} while(0)

			LOAD_TEXTURE_FOR(basecolor_map, tex_base_color, kColorspaceNative);
			LOAD_TEXTURE_FOR(normal_map, tex_normalmap, kColorspaceLinear);
			LOAD_TEXTURE_FOR(metal_map, tex_metalness, kColorspaceLinear);
			LOAD_TEXTURE_FOR(roughness_map, tex_roughness, kColorspaceLinear);

			if (!metalness_set && current_material.tex_metalness != tglob.whiteTexture) {
				// If metalness factor wasn't set explicitly, but texture was specified, set it to match the texture value.
				current_material.metalness = 1.f;
			}

			const int mat_id = addMaterial(name, &current_material);

			releaseTexturesForMaterialPtr(&current_material);

			if (mat_id < 0) {
				ERR("Cannot add material \"%s\" for_tex_id=\"%s\"(%d)", name, for_tex_id >= 0 ? R_TextureGetNameByIndex(for_tex_id) : "N/A", for_tex_id);
				continue;
			}

			if (create)
			{
				const urmom_insert_t insert = urmomInsert(&g_materials.map_desc, name);
				if (insert.index < 0) {
					ERR("Cannot add new material '%s', ran out of space (max=%d)", name, MAX_NEW_MATERIALS);
					continue;
				}

				material_name_map_t *const item = g_materials.map + insert.index;

				if (!insert.created)
					WARN("Replacing material '%s'@%d %d=>%d", name, insert.index, item->mat_id, mat_id);
				else
					DEBUG("Mapping new material '%s'@%d => %d", name, insert.index, mat_id);

				item->mat_id = mat_id;
			}

			// Assign from-texture mapping if there's a texture
			if (for_tex_id >= 0) {
				// Assign rendermode-specific materials
				if (rendermode > 0) {
					const char* const tex_name = R_TextureGetNameByIndex(for_tex_id);
					DEBUG("Adding material \"%s\" for_tex_id=\"%s\"(%d) for rendermode %d", name, tex_name, for_tex_id, rendermode);

					r_vk_material_per_mode_t* const rm = g_materials.for_rendermode + rendermode;
					if (rm->count == COUNTOF(rm->map)) {
						ERR("Too many rendermode/tex_id mappings");
						continue;
					}

					rm->map[rm->count].tex_id = for_tex_id;
					rm->map[rm->count].mat.index = mat_id;
					rm->count++;
				} else {
					assignMaterialForTexture(name, for_tex_id, mat_id);
				}
			}

			continue;
		} // if (key[0] == '}') -- closing material block

		pos = COM_ParseFile(pos, value, sizeof(value));
		if (!pos)
			break;

		//DEBUG("key=\"%s\", value=\"%s\"", key, value);

		if (Q_stricmp(key, "for") == 0) {
			if (name[0] != '\0')
				WARN("Material already has \"new\" or \"for_texture\" old=\"%s\" new=\"%s\"", name, value);

			const uint64_t lookup_begin_ns = aprof_time_now_ns();
			for_tex_id = R_TextureFindByNameLike(value);
			DEBUG("R_TextureFindByNameLike(%s)=%d", value, for_tex_id);
			if (for_tex_id >= 0)
				ASSERT(Q_stristr(R_TextureGetNameByIndex(for_tex_id), value) != NULL);
			g_stats.texture_lookup_duration_ns += aprof_time_now_ns() - lookup_begin_ns;
			g_stats.texture_lookups++;
			Q_strncpy(name, value, sizeof name);
		} else if (Q_stricmp(key, "new") == 0) {
			if (name[0] != '\0')
				WARN("Material already has \"new\" or \"for_texture\" old=\"%s\" new=\"%s\"", name, value);
			Q_strncpy(name, value, sizeof name);
			create = true;
		} else if (Q_stricmp(key, "force_reload") == 0) {
			force_reload = Q_atoi(value) != 0;
		} else if (Q_stricmp(key, "include") == 0) {
			if (depth > 0) {
				char include_path[256];
				MAKE_PATH(include_path, value);
				loadMaterialsFromFile( include_path, depth - 1);
			} else {
				ERR("material: max include depth %d reached when including '%s' from '%s'", MAX_INCLUDE_DEPTH, value, filename);
			}
		} else {
			int *tex_id_dest = NULL;
			if (Q_stricmp(key, "basecolor_map") == 0) {
				Q_strncpy(basecolor_map, value, sizeof(basecolor_map));
				//fields |= kMatField_basecolor_map;
			} else if (Q_stricmp(key, "normal_map") == 0) {
				Q_strncpy(normal_map, value, sizeof(normal_map));
				//fields |= kMatField_normal_map;
			} else if (Q_stricmp(key, "metal_map") == 0) {
				Q_strncpy(metal_map, value, sizeof(metal_map));
				//fields |= kMatField_metal_map;
			} else if (Q_stricmp(key, "roughness_map") == 0) {
				Q_strncpy(roughness_map, value, sizeof(roughness_map));
				//fields |= kMatField_roughness_map;
			} else if (Q_stricmp(key, "inherit") == 0 || Q_stricmp(key, "use") == 0) {
				const r_vk_material_ref_t ref = R_VkMaterialGetForName(value);
				if (ref.index < 0) {
					ERR("In material \"%s\" cannot find material \"%s\" to inherit", name, value);
					continue;
				}
				const r_vk_material_t inherited = R_VkMaterialGetForRef(ref);
				current_material = inherited;
			} else if (Q_stricmp(key, "roughness") == 0) {
				sscanf(value, "%f", &current_material.roughness);
				//fields |= kMatField_roughness;
			} else if (Q_stricmp(key, "metalness") == 0) {
				sscanf(value, "%f", &current_material.metalness);
				//fields |= kMatField_metalness;
				metalness_set = true;
			} else if (Q_stricmp(key, "normal_scale") == 0) {
				sscanf(value, "%f", &current_material.normal_scale);
				//fields |= kMatField_normal_scale;
			} else if (Q_stricmp(key, "base_color") == 0) {
				sscanf(value, "%f %f %f %f", &current_material.base_color[0], &current_material.base_color[1], &current_material.base_color[2], &current_material.base_color[3]);
				//fields |= kMatField_base_color;
			} else if (Q_stricmp(key, "for_rendermode") == 0) {
				rendermode = R_VkRenderModeFromString(value);
				if (rendermode < 0)
					ERR("Invalid rendermode \"%s\"", value);
				ASSERT(rendermode < COUNTOF(g_materials.for_rendermode[0].map));
				//fields |= kMatField_rendermode;
			} else {
				ERR("Unknown material key \"%s\" on line `%.*s`", key, (int)(pos - line_begin), line_begin);
				continue;
			}
		}
	}

	Mem_Free( data );
	g_stats.mat_files_read++;
}

static void loadMaterialsFromFileF( const char *fmt, ... ) {
	char buffer[256];
	va_list argptr;

	va_start( argptr, fmt );
	vsnprintf( buffer, sizeof buffer, fmt, argptr );
	va_end( argptr );

	loadMaterialsFromFile( buffer, MAX_INCLUDE_DEPTH );
}

static int findFilenameExtension(const char *s, int len) {
	if (len < 0)
		len = Q_strlen(s);

	for (int i = len - 1; i >= 0; --i) {
		if (s[i] == '.')
			return i;
	}

	return len;
}

static void materialsReleaseTextures( void ) {
	for (int i = 1; i < g_materials.count; ++i)
		releaseTexturesForMaterial(i);
}

void R_VkMaterialsReload( void ) {
	const uint64_t begin_time_ns = aprof_time_now_ns();
	memset(&g_stats, 0, sizeof(g_stats));

	materialsReleaseTextures();

	g_materials.count = 1;

	memset(g_materials.tex_to_mat, 0, sizeof g_materials.tex_to_mat);

	g_materials.map_desc = (urmom_desc_t){
		.type = kUrmomStringInsensitive,
		.array = g_materials.map,
		.count = COUNTOF(g_materials.map),
		.item_size = sizeof(g_materials.map[0]),
	};
	urmomInit(&g_materials.map_desc);

	for (int i = 0; i < COUNTOF(g_materials.for_rendermode); ++i)
		g_materials.for_rendermode[i].count = 0;

	// TODO make these texture constants static constants
	k_default_material.tex_metalness = tglob.whiteTexture;
	k_default_material.tex_roughness = tglob.whiteTexture;

	// TODO name?
	g_materials.table[0].material = k_default_material;
	g_materials.table[0].material.tex_base_color = 0;

	loadMaterialsFromFile( "pbr/materials.mat", MAX_INCLUDE_DEPTH );

	// Load materials by WAD files
	{
		for(const char *wad = g_map_entities.wadlist; *wad;) {
			const char *wad_end = wad;
			const char *ext = NULL;
			while (*wad_end && *wad_end != ';') {
				if (*wad_end == '.')
					ext = wad_end;
				++wad_end;
			}

			const int full_length = wad_end - wad;

			// Length without extension
			const int short_length = ext ? ext - wad : full_length;

			loadMaterialsFromFileF("pbr/%.*s/%.*s.mat", full_length, wad, short_length, wad);
			wad = wad_end + 1;
		}
	}

	// Load materials by map/BSP file
	{
		const model_t *map = gEngine.pfnGetModelByIndex( 1 );
		const char *filename = COM_FileWithoutPath(map->name);
		const int no_ext_len = findFilenameExtension(filename, -1);
		loadMaterialsFromFileF("pbr/%s/%.*s.mat", map->name, no_ext_len, filename);
	}

	// Print out statistics
	{
		const int duration_ms = (aprof_time_now_ns() - begin_time_ns) / 1000000ull;
		INFO("Loading materials took %dms, .mat files parsed: %d (fread: %dms). Texture lookups: %d (%dms). Texture loads: %d (%dms).",
			duration_ms,
			g_stats.mat_files_read,
			(int)(g_stats.material_file_read_duration_ns / 1000000ull),
			g_stats.texture_lookups,
			(int)(g_stats.texture_lookup_duration_ns / 1000000ull),
			g_stats.texture_loads,
			(int)(g_stats.texture_load_duration_ns / 1000000ull)
			);
	}
}

void R_VkMaterialsLoadForModel( const struct model_s* mod ) {
	// Brush models are loaded separately
	if (mod->type == mod_brush)
		return;

	// TODO add stats

	const char *filename = COM_FileWithoutPath(mod->name);
	const int no_ext_len = findFilenameExtension(filename, -1);
	loadMaterialsFromFileF("pbr/%s/%.*s.mat", mod->name, no_ext_len, filename);
}

r_vk_material_t R_VkMaterialGetForTexture( int tex_index ) {
	return R_VkMaterialGetForTextureWithFlags( tex_index, kVkMaterialFlagNone );
}

r_vk_material_t R_VkMaterialGetForTextureWithFlags( int tex_index, uint32_t flags ) {
	//DEBUG("Getting material for tex_id=%d", tex_index);
	ASSERT(tex_index >= 0);
	ASSERT(tex_index < MAX_TEXTURES);

	texture_to_material_t* const t2m = g_materials.tex_to_mat + tex_index;

	if (t2m->mat_id > 0) {
		ASSERT(t2m->mat_id < g_materials.count);
		//DEBUG("Getting material for tex_id=%d", tex_index);
		//printMaterial(t2m->mat_id);
		return g_materials.table[t2m->mat_id].material;
	}

	if (t2m->mat_id == kMaterialNotChecked) {
		// TODO check for replacement textures named in a predictable way
		// If there are, create a new material and assign it here

		const char* texname = R_TextureGetNameByIndex(tex_index);
		DEBUG("Would try to load texture files by default names of \"%s\"", texname);

		// If no PBR textures found, continue using legacy+default ones
		t2m->mat_id = kMaterialNoReplacement;
	}

	r_vk_material_t ret = k_default_material;
	ret.tex_base_color = tex_index;

	if ( flags & kVkMaterialFlagChrome )
		ret.tex_roughness = tglob.grayTexture;

	//DEBUG("Returning default material with tex_base_color=%d", tex_index);
	return ret;
}

r_vk_material_ref_t R_VkMaterialGetForName( const char *name ) {
	// Find in internal map first
	// New materials have preference over texture names
	const int index = urmomFind(&g_materials.map_desc, name);
	if (index >= 0)
		return (r_vk_material_ref_t){.index = g_materials.map[index].mat_id};
	DEBUG("Couldn't find material '%s', fallback to texture lookup", name);

	// Find by texture name
	const int tex_id = R_TextureFindByNameLike(name);
	if (tex_id <= 0) {
		ERR("Neither material nor texture with name \"%s\" was found", name);
		return (r_vk_material_ref_t){.index = -1,};
	}

	ASSERT(tex_id > 0);
	ASSERT(tex_id < MAX_TEXTURES);

	return (r_vk_material_ref_t){.index = g_materials.tex_to_mat[tex_id].mat_id};
}

r_vk_material_t R_VkMaterialGetForRef( r_vk_material_ref_t ref ) {
	if (ref.index < 0) {
		r_vk_material_t ret = k_default_material;
		ret.tex_base_color = 0; // Default/error texture
		return ret;
	}

	ASSERT(ref.index < g_materials.count);
	return g_materials.table[ref.index].material;
}

qboolean R_VkMaterialGetEx( int tex_id, int rendermode, r_vk_material_t *out_material ) {
	DEBUG("Getting material for tex_id=%d rendermode=%d", tex_id, rendermode);

	if (rendermode == 0) {
		WARN("rendermode==0: fallback to regular tex_id=%d", tex_id);
		*out_material = R_VkMaterialGetForTexture(tex_id);
		return true;
	}

	// TODO move rendermode-specifit things to by-texid-chains
	ASSERT(rendermode < COUNTOF(g_materials.for_rendermode));
	const r_vk_material_per_mode_t* const mode = &g_materials.for_rendermode[rendermode];
	for (int i = 0; i < mode->count; ++i) {
		if (mode->map[i].tex_id == tex_id) {
			const int index = mode->map[i].mat.index;
			ASSERT(index >= 0);
			ASSERT(index < g_materials.count);
			*out_material = g_materials.table[index].material;
			return true;
		}
	}

	return false;
}

void R_VkMaterialsShutdown( void ) {
	materialsReleaseTextures();
}