/* Copyright (c) 2019-2023 Péter Magyar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "voxel_library_merger_pcm.h" #include "../../texture_packer/texture_packer.h" #include "scene/resources/packed_scene.h" #include "scene/resources/texture.h" #include "scene/resources/material/spatial_material.h" #include "scene/resources/material/shader_material.h" #include "modules/modules_enabled.gen.h" #ifdef MODULE_PROPS_ENABLED #include "../../props/props/prop_data.h" #include "../../props/props/prop_data_prop.h" #ifdef MODULE_MESH_DATA_RESOURCE_ENABLED #include "../../mesh_data_resource/props/prop_data_mesh_data.h" #endif #endif #include "voxel_material_cache_pcm.h" #include "../defines.h" #include "../world/default/voxel_chunk_default.h" #include "core/containers/hashfuncs.h" bool VoxelLibraryMergerPCM::_supports_caching() { return true; } void VoxelLibraryMergerPCM::_material_cache_get_key(Ref chunk) { uint8_t *ch = chunk->channel_get(VoxelChunkDefault::DEFAULT_CHANNEL_TYPE); if (!ch) { chunk->material_cache_key_set(0); chunk->material_cache_key_has_set(false); return; } Vector surfaces; uint32_t size = chunk->get_data_size(); for (uint32_t i = 0; i < size; ++i) { uint8_t v = ch[i]; if (v == 0) { continue; } int ssize = surfaces.size(); bool found = false; for (uint8_t j = 0; j < ssize; ++j) { if (surfaces[j] == v) { found = true; break; } } if (!found) { surfaces.push_back(v); } } if (surfaces.size() == 0) { chunk->material_cache_key_set(0); chunk->material_cache_key_has_set(false); return; } surfaces.sort(); String hstr; for (int i = 0; i < surfaces.size(); ++i) { hstr += String::num(surfaces[i]) + "|"; } int hash = static_cast(hstr.hash()); chunk->material_cache_key_set(hash); chunk->material_cache_key_has_set(true); _material_cache_mutex.lock(); if (_material_cache.has(hash)) { Ref cc = _material_cache[hash]; if (cc.is_valid()) { cc->inc_ref_count(); } _material_cache_mutex.unlock(); return; } //print_error("New cache: " + hstr); Ref cache; cache.instance(); cache->inc_ref_count(); cache->set_texture_flags(get_texture_flags()); cache->set_max_atlas_size(get_max_atlas_size()); cache->set_keep_original_atlases(get_keep_original_atlases()); cache->set_background_color(get_background_color()); cache->set_margin(get_margin()); for (int i = 0; i < surfaces.size(); ++i) { int s = surfaces[i] - 1; if (_voxel_surfaces.size() <= s) { continue; } Ref ms = _voxel_surfaces[s]; if (!ms.is_valid()) { continue; } Ref nms = ms->duplicate(); nms->set_library(Ref(this)); nms->set_id(s); cache->surface_add(nms); } for (int i = 0; i < _materials.size(); ++i) { Ref m = _materials[i]; if (!m.is_valid()) { continue; } Ref nm = m->duplicate(); cache->material_add(nm); } _material_cache[hash] = cache; //unlock here, so if a different thread need the cache it will be able to immediately access the materials and surfaces when it gets it. _material_cache_mutex.unlock(); //this will generate the atlases cache->refresh_rects(); } Ref VoxelLibraryMergerPCM::_material_cache_get(const int key) { _material_cache_mutex.lock(); ERR_FAIL_COND_V(!_material_cache.has(key), Ref()); Ref c = _material_cache[key]; _material_cache_mutex.unlock(); return c; } void VoxelLibraryMergerPCM::_material_cache_unref(const int key) { _material_cache_mutex.lock(); if (!_material_cache.has(key)) { return; } Ref cc = _material_cache[key]; if (!cc.is_valid()) { return; } cc->dec_ref_count(); if (cc->get_ref_count() <= 0) { _material_cache.erase(key); } _material_cache_mutex.unlock(); } void VoxelLibraryMergerPCM::_prop_material_cache_get_key(Ref chunk) { Vector props; /* #ifdef MODULE_PROPS_ENABLED for (int i = 0; i < chunk->prop_get_count(); ++i) { Ref prop = chunk->prop_get(i); ERR_CONTINUE(!prop.is_valid()); //get pointer's value as uint64 uint64_t v = make_uint64_t(*prop); int psize = props.size(); bool found = false; for (int j = 0; j < psize; ++j) { if (props[j] == v) { found = true; break; } } if (!found) { props.push_back(v); } } #endif */ #ifdef MODULE_MESH_DATA_RESOURCE_ENABLED for (int i = 0; i < chunk->mesh_data_resource_get_count(); ++i) { Ref tex = chunk->mesh_data_resource_get_texture(i); if (!tex.is_valid()) continue; //get pointer's value as uint64 uint64_t v = make_uint64_t(*tex); int psize = props.size(); bool found = false; for (int j = 0; j < psize; ++j) { if (props[j] == v) { found = true; break; } } if (!found) { props.push_back(v); } } #endif if (props.size() == 0) { chunk->prop_material_cache_key_set(0); chunk->prop_material_cache_key_has_set(false); return; } props.sort(); String hstr; for (int i = 0; i < props.size(); ++i) { hstr += String::num_uint64(props[i]) + "|"; } int hash = static_cast(hstr.hash()); chunk->prop_material_cache_key_set(hash); chunk->prop_material_cache_key_has_set(true); _prop_material_cache_mutex.lock(); if (_prop_material_cache.has(hash)) { Ref cc = _prop_material_cache[hash]; if (cc.is_valid()) { cc->inc_ref_count(); } _prop_material_cache_mutex.unlock(); return; } //print_error("New prop cache: " + hstr); Ref cache; cache.instance(); cache->inc_ref_count(); cache->set_texture_flags(get_texture_flags()); cache->set_max_atlas_size(get_max_atlas_size()); cache->set_keep_original_atlases(get_keep_original_atlases()); cache->set_background_color(get_background_color()); cache->set_margin(get_margin()); for (int i = 0; i < _prop_materials.size(); ++i) { Ref m = _prop_materials[i]; if (!m.is_valid()) { continue; } Ref nm = m->duplicate(); cache->material_add(nm); } /* #ifdef MODULE_PROPS_ENABLED for (int i = 0; i < chunk->prop_get_count(); ++i) { Ref prop = chunk->prop_get(i); ERR_CONTINUE(!prop.is_valid()); cache->prop_add_textures(prop); } #endif */ #ifdef MODULE_MESH_DATA_RESOURCE_ENABLED for (int i = 0; i < chunk->mesh_data_resource_get_count(); ++i) { Ref tex = chunk->mesh_data_resource_get_texture(i); if (!tex.is_valid()) continue; cache->additional_texture_add(tex); } #endif _prop_material_cache[hash] = cache; //unlock here, so if a different thread need the cache it will be able to immediately access the materials and surfaces when it gets it. _prop_material_cache_mutex.unlock(); //this will generate the atlases cache->refresh_rects(); } Ref VoxelLibraryMergerPCM::_prop_material_cache_get(const int key) { _prop_material_cache_mutex.lock(); ERR_FAIL_COND_V(!_prop_material_cache.has(key), Ref()); Ref c = _prop_material_cache[key]; _prop_material_cache_mutex.unlock(); return c; } void VoxelLibraryMergerPCM::_prop_material_cache_unref(const int key) { _prop_material_cache_mutex.lock(); if (!_prop_material_cache.has(key)) { return; } Ref cc = _prop_material_cache[key]; if (!cc.is_valid()) { return; } cc->dec_ref_count(); if (cc->get_ref_count() <= 0) { _prop_material_cache.erase(key); } _prop_material_cache_mutex.unlock(); } int VoxelLibraryMergerPCM::get_texture_flags() const { return _packer->get_texture_flags(); } void VoxelLibraryMergerPCM::set_texture_flags(const int flags) { _packer->set_texture_flags(flags); _prop_packer->set_texture_flags(flags); } int VoxelLibraryMergerPCM::get_max_atlas_size() const { return _packer->get_max_atlas_size(); } void VoxelLibraryMergerPCM::set_max_atlas_size(const int size) { _packer->set_max_atlas_size(size); _prop_packer->set_max_atlas_size(size); } bool VoxelLibraryMergerPCM::get_keep_original_atlases() const { return _packer->get_keep_original_atlases(); } void VoxelLibraryMergerPCM::set_keep_original_atlases(const bool value) { _packer->set_keep_original_atlases(value); _prop_packer->set_keep_original_atlases(value); } Color VoxelLibraryMergerPCM::get_background_color() const { return _packer->get_background_color(); } void VoxelLibraryMergerPCM::set_background_color(const Color &color) { _packer->set_background_color(color); _prop_packer->set_background_color(color); } int VoxelLibraryMergerPCM::get_margin() const { return _packer->get_margin(); } void VoxelLibraryMergerPCM::set_margin(const int margin) { _packer->set_margin(margin); _prop_packer->set_margin(margin); } //Surfaces Ref VoxelLibraryMergerPCM::voxel_surface_get(const int index) { ERR_FAIL_INDEX_V(index, _voxel_surfaces.size(), Ref(NULL)); return _voxel_surfaces[index]; } void VoxelLibraryMergerPCM::voxel_surface_add(Ref value) { ERR_FAIL_COND(!value.is_valid()); value->set_library(Ref(this)); value->set_id(_voxel_surfaces.size()); _voxel_surfaces.push_back(value); } void VoxelLibraryMergerPCM::voxel_surface_set(const int index, Ref value) { ERR_FAIL_COND(index < 0); if (_voxel_surfaces.size() < index) { _voxel_surfaces.resize(index + 1); } if (_voxel_surfaces[index].is_valid()) { _voxel_surfaces.get(index)->set_library(Ref(NULL)); } if (value.is_valid()) { value->set_library(Ref(this)); _voxel_surfaces.set(index, value); } } void VoxelLibraryMergerPCM::voxel_surface_remove(const int index) { _voxel_surfaces.remove(index); } int VoxelLibraryMergerPCM::voxel_surface_get_num() const { return _voxel_surfaces.size(); } void VoxelLibraryMergerPCM::voxel_surfaces_clear() { _packer->clear(); for (int i = 0; i < _voxel_surfaces.size(); i++) { Ref surface = _voxel_surfaces[i]; if (surface.is_valid()) { surface->set_library(NULL); } } _voxel_surfaces.clear(); } Vector VoxelLibraryMergerPCM::get_voxel_surfaces() { VARIANT_ARRAY_GET(_voxel_surfaces); } void VoxelLibraryMergerPCM::set_voxel_surfaces(const Vector &surfaces) { _voxel_surfaces.clear(); for (int i = 0; i < surfaces.size(); i++) { Ref surface = Ref(surfaces[i]); if (surface.is_valid()) { surface->set_library(Ref(this)); } _voxel_surfaces.push_back(surface); } } #ifdef MODULE_PROPS_ENABLED Ref VoxelLibraryMergerPCM::get_prop(const int index) { ERR_FAIL_INDEX_V(index, _props.size(), Ref()); return _props[index]; } void VoxelLibraryMergerPCM::add_prop(Ref value) { _props.push_back(value); } bool VoxelLibraryMergerPCM::has_prop(const Ref &value) const { return _props.find(value) != -1; } void VoxelLibraryMergerPCM::set_prop(const int index, const Ref &value) { ERR_FAIL_INDEX(index, _props.size()); _props.write[index] = value; } void VoxelLibraryMergerPCM::remove_prop(const int index) { ERR_FAIL_INDEX(index, _props.size()); _props.remove(index); } int VoxelLibraryMergerPCM::get_num_props() const { return _props.size(); } void VoxelLibraryMergerPCM::clear_props() { _props.clear(); } Vector VoxelLibraryMergerPCM::get_props() { VARIANT_ARRAY_GET(_props); } void VoxelLibraryMergerPCM::set_props(const Vector &props) { VARIANT_ARRAY_SET(props, _props, PropData); } Rect2 VoxelLibraryMergerPCM::get_prop_uv_rect(const Ref &texture) { if (!texture.is_valid()) { return Rect2(0, 0, 1, 1); } Ref at = _prop_packer->get_texture(texture); if (!at.is_valid()) { return Rect2(0, 0, 1, 1); } Rect2 region = at->get_region(); Ref tex = at->get_atlas(); if (!tex.is_valid()) { return Rect2(0, 0, 1, 1); } Ref image = tex->get_data(); if (!image.is_valid()) { return Rect2(0, 0, 1, 1); } float w = image->get_width(); float h = image->get_height(); region.position = Size2(region.position.x / w, region.position.y / h); region.size = Size2(region.size.x / w, region.size.y / h); return region; } Ref VoxelLibraryMergerPCM::get_prop_packer() { return _prop_packer; } #endif void VoxelLibraryMergerPCM::refresh_rects() { bool texture_added = false; for (int i = 0; i < _voxel_surfaces.size(); i++) { Ref surface = Ref(_voxel_surfaces[i]); if (surface.is_valid()) { for (int j = 0; j < VoxelSurface::VOXEL_SIDES_COUNT; ++j) { Ref tex = surface->get_texture(static_cast(j)); if (!tex.is_valid()) continue; if (!_packer->contains_texture(tex)) { texture_added = true; surface->set_region(static_cast(j), _packer->add_texture(tex)); } else { surface->set_region(static_cast(j), _packer->get_texture(tex)); } } } } if (texture_added) { _packer->merge(); ERR_FAIL_COND(_packer->get_texture_count() == 0); Ref tex = _packer->get_generated_texture(0); setup_material_albedo(MATERIAL_INDEX_VOXELS, tex); setup_material_albedo(MATERIAL_INDEX_LIQUID, tex); } #ifdef MODULE_PROPS_ENABLED //todo add this back //texture_added = false; for (int i = 0; i < _props.size(); i++) { Ref prop = _props.get(i); if (prop.is_valid()) { if (process_prop_textures(prop)) texture_added = true; } } //if (texture_added) { if (_prop_packer->get_texture_count() > 0) { _prop_packer->merge(); //ERR_FAIL_COND(_prop_packer->get_texture_count() == 0); Ref tex = _prop_packer->get_generated_texture(0); setup_material_albedo(MATERIAL_INDEX_PROP, tex); } #endif for (int i = 0; i < _voxel_surfaces.size(); i++) { Ref surface = _voxel_surfaces[i]; if (surface.is_valid()) { surface->refresh_rects(); } } set_initialized(true); } void VoxelLibraryMergerPCM::_setup_material_albedo(const int material_index, const Ref &texture) { Ref mat; int count = 0; switch (material_index) { case MATERIAL_INDEX_VOXELS: count = material_get_num(); break; case MATERIAL_INDEX_LIQUID: count = liquid_material_get_num(); break; case MATERIAL_INDEX_PROP: count = prop_material_get_num(); break; } for (int i = 0; i < count; ++i) { switch (material_index) { case MATERIAL_INDEX_VOXELS: mat = material_get(i); break; case MATERIAL_INDEX_LIQUID: mat = liquid_material_get(i); break; case MATERIAL_INDEX_PROP: mat = prop_material_get(i); break; } Ref spmat; switch (material_index) { case MATERIAL_INDEX_VOXELS: spmat = material_get(i); break; case MATERIAL_INDEX_LIQUID: spmat = liquid_material_get(i); break; case MATERIAL_INDEX_PROP: spmat = prop_material_get(i); break; } if (spmat.is_valid()) { spmat->set_texture(SpatialMaterial::TEXTURE_ALBEDO, texture); return; } Ref shmat; switch (material_index) { case MATERIAL_INDEX_VOXELS: shmat = material_get(i); break; case MATERIAL_INDEX_LIQUID: shmat = liquid_material_get(i); break; case MATERIAL_INDEX_PROP: shmat = prop_material_get(i); break; } if (shmat.is_valid()) { shmat->set_shader_param("texture_albedo", texture); } } } VoxelLibraryMergerPCM::VoxelLibraryMergerPCM() { _packer.instance(); _packer->set_texture_flags(Texture::FLAG_MIPMAPS | Texture::FLAG_FILTER); _packer->set_max_atlas_size(1024); _packer->set_keep_original_atlases(false); _packer->set_margin(0); _prop_packer.instance(); _prop_packer->set_texture_flags(Texture::FLAG_MIPMAPS | Texture::FLAG_FILTER); _prop_packer->set_max_atlas_size(1024); _prop_packer->set_keep_original_atlases(false); _prop_packer->set_margin(0); } VoxelLibraryMergerPCM::~VoxelLibraryMergerPCM() { for (int i = 0; i < _voxel_surfaces.size(); ++i) { Ref surface = _voxel_surfaces[i]; if (surface.is_valid()) { surface->set_library(Ref()); } } _voxel_surfaces.clear(); _packer->clear(); _packer.unref(); _prop_packer->clear(); _prop_packer.unref(); } #ifdef MODULE_PROPS_ENABLED bool VoxelLibraryMergerPCM::process_prop_textures(Ref prop) { if (!prop.is_valid()) { return false; } bool texture_added = false; #ifdef MODULE_MESH_DATA_RESOURCE_ENABLED for (int i = 0; i < prop->get_prop_count(); ++i) { Ref pdm = prop->get_prop(i); if (pdm.is_valid()) { Ref tex = pdm->get_texture(); if (!tex.is_valid()) continue; if (!_prop_packer->contains_texture(tex)) { _prop_packer->add_texture(tex); texture_added = true; } } Ref pdp = prop->get_prop(i); if (pdp.is_valid()) { if (process_prop_textures(pdp)) texture_added = true; } } #endif return texture_added; } #endif void VoxelLibraryMergerPCM::_bind_methods() { ClassDB::bind_method(D_METHOD("get_texture_flags"), &VoxelLibraryMergerPCM::get_texture_flags); ClassDB::bind_method(D_METHOD("set_texture_flags", "flags"), &VoxelLibraryMergerPCM::set_texture_flags); ADD_PROPERTY(PropertyInfo(Variant::INT, "texture_flags", PROPERTY_HINT_FLAGS, "Mipmaps,Repeat,Filter,Anisotropic Linear,Convert to Linear,Mirrored Repeat,Video Surface"), "set_texture_flags", "get_texture_flags"); ClassDB::bind_method(D_METHOD("get_max_atlas_size"), &VoxelLibraryMergerPCM::get_max_atlas_size); ClassDB::bind_method(D_METHOD("set_max_atlas_size", "size"), &VoxelLibraryMergerPCM::set_max_atlas_size); ADD_PROPERTY(PropertyInfo(Variant::INT, "max_atlas_size"), "set_max_atlas_size", "get_max_atlas_size"); ClassDB::bind_method(D_METHOD("get_keep_original_atlases"), &VoxelLibraryMergerPCM::get_keep_original_atlases); ClassDB::bind_method(D_METHOD("set_keep_original_atlases", "value"), &VoxelLibraryMergerPCM::set_keep_original_atlases); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "keep_original_atlases"), "set_keep_original_atlases", "get_keep_original_atlases"); ClassDB::bind_method(D_METHOD("get_background_color"), &VoxelLibraryMergerPCM::get_background_color); ClassDB::bind_method(D_METHOD("set_background_color", "color"), &VoxelLibraryMergerPCM::set_background_color); ADD_PROPERTY(PropertyInfo(Variant::COLOR, "background_color"), "set_background_color", "get_background_color"); ClassDB::bind_method(D_METHOD("get_margin"), &VoxelLibraryMergerPCM::get_margin); ClassDB::bind_method(D_METHOD("set_margin", "size"), &VoxelLibraryMergerPCM::set_margin); ADD_PROPERTY(PropertyInfo(Variant::INT, "margin"), "set_margin", "get_margin"); ClassDB::bind_method(D_METHOD("get_voxel_surfaces"), &VoxelLibraryMergerPCM::get_voxel_surfaces); ClassDB::bind_method(D_METHOD("set_voxel_surfaces"), &VoxelLibraryMergerPCM::set_voxel_surfaces); ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "voxel_surfaces", PROPERTY_HINT_NONE, "23/20:VoxelSurfaceMerger", PROPERTY_USAGE_DEFAULT, "VoxelSurfaceMerger"), "set_voxel_surfaces", "get_voxel_surfaces"); #ifdef MODULE_PROPS_ENABLED ClassDB::bind_method(D_METHOD("get_props"), &VoxelLibraryMergerPCM::get_props); ClassDB::bind_method(D_METHOD("set_props"), &VoxelLibraryMergerPCM::set_props); ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "props", PROPERTY_HINT_NONE, "23/20:PropData", PROPERTY_USAGE_DEFAULT, "PropData"), "set_props", "get_props"); ClassDB::bind_method(D_METHOD("get_prop_uv_rect", "texture"), &VoxelLibraryMergerPCM::get_prop_uv_rect); ClassDB::bind_method(D_METHOD("get_prop_packer"), &VoxelLibraryMergerPCM::get_prop_packer); #endif ClassDB::bind_method(D_METHOD("_setup_material_albedo", "material_index", "texture"), &VoxelLibraryMergerPCM::_setup_material_albedo); }