assets preloading with preload.json

This commit is contained in:
MihailRis 2024-03-11 15:09:21 +03:00
parent 739282dce9
commit 7449434f5c
8 changed files with 209 additions and 64 deletions

14
res/preload.json Normal file
View File

@ -0,0 +1,14 @@
{
"shaders": [
"ui3d",
"screen",
"background",
"skybox_gen"
],
"textures": [
"misc/moon",
"misc/sun",
"gui/crosshair"
]
}

View File

@ -7,26 +7,30 @@
#include <memory>
#include "../constants.h"
#include "../data/dynamic.h"
#include "../files/files.h"
#include "../files/engine_paths.h"
#include "../content/Content.h"
#include "../content/ContentPack.h"
#include "../logic/scripting/scripting.h"
AssetsLoader::AssetsLoader(Assets* assets, const ResPaths* paths)
: assets(assets), paths(paths) {
addLoader(ASSET_SHADER, assetload::shader);
addLoader(ASSET_TEXTURE, assetload::texture);
addLoader(ASSET_FONT, assetload::font);
addLoader(ASSET_ATLAS, assetload::atlas);
addLoader(ASSET_LAYOUT, assetload::layout);
addLoader(ASSET_SOUND, assetload::sound);
: assets(assets), paths(paths)
{
addLoader(AssetType::shader, assetload::shader);
addLoader(AssetType::texture, assetload::texture);
addLoader(AssetType::font, assetload::font);
addLoader(AssetType::atlas, assetload::atlas);
addLoader(AssetType::layout, assetload::layout);
addLoader(AssetType::sound, assetload::sound);
}
void AssetsLoader::addLoader(int tag, aloader_func func) {
void AssetsLoader::addLoader(AssetType tag, aloader_func func) {
loaders[tag] = func;
}
void AssetsLoader::add(int tag, const std::string filename, const std::string alias, std::shared_ptr<AssetCfg> settings) {
entries.push(aloader_entry{ tag, filename, alias, settings});
void AssetsLoader::add(AssetType tag, const std::string filename, const std::string alias, std::shared_ptr<AssetCfg> settings) {
entries.push(aloader_entry{tag, filename, alias, settings});
}
bool AssetsLoader::hasNext() const {
@ -39,7 +43,7 @@ bool AssetsLoader::loadNext() {
std::cout.flush();
auto found = loaders.find(entry.tag);
if (found == loaders.end()) {
std::cerr << "unknown asset tag " << entry.tag << std::endl;
std::cerr << "unknown asset tag " << static_cast<int>(entry.tag) << std::endl;
return false;
}
aloader_func loader = found->second;
@ -57,7 +61,7 @@ void addLayouts(int env, const std::string& prefix, const fs::path& folder, Asse
if (file.extension().u8string() != ".xml")
continue;
std::string name = prefix+":"+file.stem().u8string();
loader.add(ASSET_LAYOUT, file.u8string(), name, std::make_shared<LayoutCfg>(env));
loader.add(AssetType::layout, file.u8string(), name, std::make_shared<LayoutCfg>(env));
}
}
@ -65,29 +69,103 @@ void AssetsLoader::tryAddSound(std::string name) {
if (name.empty()) {
return;
}
fs::path file = SOUNDS_FOLDER+"/"+name+".ogg";
add(ASSET_SOUND, file, name);
std::string file = SOUNDS_FOLDER+"/"+name;
add(AssetType::sound, file, name);
}
static std::string assets_def_folder(AssetType tag) {
switch (tag) {
case AssetType::font: return FONTS_FOLDER;
case AssetType::shader: return SHADERS_FOLDER;
case AssetType::texture: return TEXTURES_FOLDER;
case AssetType::atlas: return TEXTURES_FOLDER;
case AssetType::layout: return LAYOUTS_FOLDER;
case AssetType::sound: return SOUNDS_FOLDER;
}
return "<error>";
}
void AssetsLoader::processPreload(
AssetType tag,
const std::string& name,
dynamic::Map* map
) {
std::string defFolder = assets_def_folder(tag);
std::string path = defFolder+"/"+name;
if (map == nullptr) {
add(tag, path, name);
return;
}
map->str("path", path);
switch (tag) {
case AssetType::sound:
add(tag, path, name, std::make_shared<SoundCfg>(
map->getBool("keep-pcm", false)
));
break;
default:
add(tag, path, name);
break;
}
}
void AssetsLoader::processPreloadList(AssetType tag, dynamic::List* list) {
if (list == nullptr) {
return;
}
for (uint i = 0; i < list->size(); i++) {
auto value = list->get(i);
switch (value->type) {
case dynamic::valtype::string:
processPreload(tag, *value->value.str, nullptr);
break;
case dynamic::valtype::map: {
auto name = value->value.map->getStr("name");
processPreload(tag, name, value->value.map);
break;
}
default:
throw std::runtime_error("invalid entry type");
}
}
}
void AssetsLoader::processPreloadConfig(fs::path file) {
auto root = files::read_json(file);
processPreloadList(AssetType::font, root->list("fonts"));
processPreloadList(AssetType::shader, root->list("shaders"));
processPreloadList(AssetType::texture, root->list("textures"));
processPreloadList(AssetType::sound, root->list("sounds"));
// layouts are loaded automatically
}
void AssetsLoader::processPreloadConfigs(const Content* content) {
for (auto& entry : content->getPacks()) {
const auto& pack = entry.second;
auto preloadFile = pack->getInfo().folder / fs::path("preload.json");
if (fs::exists(preloadFile)) {
processPreloadConfig(preloadFile);
}
}
auto preloadFile = paths->getMainRoot()/fs::path("preload.json");
if (fs::exists(preloadFile)) {
processPreloadConfig(preloadFile);
}
}
void AssetsLoader::addDefaults(AssetsLoader& loader, const Content* content) {
loader.add(ASSET_FONT, FONTS_FOLDER+"/font", "normal");
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/ui", "ui");
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/main", "main");
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/lines", "lines");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/menubg.png", "gui/menubg");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/delete_icon.png", "gui/delete_icon");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/no_icon.png", "gui/no_icon");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/warning.png", "gui/warning");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/error.png", "gui/error");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/cross.png", "gui/cross");
loader.add(AssetType::font, FONTS_FOLDER+"/font", "normal");
loader.add(AssetType::shader, SHADERS_FOLDER+"/ui", "ui");
loader.add(AssetType::shader, SHADERS_FOLDER+"/main", "main");
loader.add(AssetType::shader, SHADERS_FOLDER+"/lines", "lines");
loader.add(AssetType::texture, TEXTURES_FOLDER+"/gui/menubg", "gui/menubg");
loader.add(AssetType::texture, TEXTURES_FOLDER+"/gui/delete_icon", "gui/delete_icon");
loader.add(AssetType::texture, TEXTURES_FOLDER+"/gui/no_icon", "gui/no_icon");
loader.add(AssetType::texture, TEXTURES_FOLDER+"/gui/warning", "gui/warning");
loader.add(AssetType::texture, TEXTURES_FOLDER+"/gui/error", "gui/error");
loader.add(AssetType::texture, TEXTURES_FOLDER+"/gui/cross", "gui/cross");
if (content) {
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/ui3d", "ui3d");
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/screen", "screen");
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/background", "background");
loader.add(ASSET_SHADER, SHADERS_FOLDER+"/skybox_gen", "skybox_gen");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/misc/moon.png", "misc/moon");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/misc/sun.png", "misc/sun");
loader.add(ASSET_TEXTURE, TEXTURES_FOLDER+"/gui/crosshair.png", "gui/crosshair");
loader.processPreloadConfigs(content);
for (auto& entry : content->getBlockMaterials()) {
auto& material = entry.second;
@ -104,8 +182,8 @@ void AssetsLoader::addDefaults(AssetsLoader& loader, const Content* content) {
addLayouts(pack->getEnvironment()->getId(), info.id, folder, loader);
}
}
loader.add(ASSET_ATLAS, TEXTURES_FOLDER+"/blocks", "blocks");
loader.add(ASSET_ATLAS, TEXTURES_FOLDER+"/items", "items");
loader.add(AssetType::atlas, TEXTURES_FOLDER+"/blocks", "blocks");
loader.add(AssetType::atlas, TEXTURES_FOLDER+"/items", "items");
}
const ResPaths* AssetsLoader::getPaths() const {

View File

@ -3,16 +3,24 @@
#include <string>
#include <memory>
#include <filesystem>
#include <functional>
#include <map>
#include <queue>
inline constexpr short ASSET_TEXTURE = 1;
inline constexpr short ASSET_SHADER = 2;
inline constexpr short ASSET_FONT = 3;
inline constexpr short ASSET_ATLAS = 4;
inline constexpr short ASSET_LAYOUT = 5;
inline constexpr short ASSET_SOUND = 6;
namespace dynamic {
class Map;
class List;
}
enum class AssetType {
texture,
shader,
font,
atlas,
layout,
sound
};
class ResPaths;
class Assets;
@ -38,7 +46,7 @@ struct SoundCfg : AssetCfg {
using aloader_func = std::function<bool(AssetsLoader&, Assets*, const ResPaths*, const std::string&, const std::string&, std::shared_ptr<AssetCfg>)>;
struct aloader_entry {
int tag;
AssetType tag;
const std::string filename;
const std::string alias;
std::shared_ptr<AssetCfg> config;
@ -46,14 +54,19 @@ struct aloader_entry {
class AssetsLoader {
Assets* assets;
std::map<int, aloader_func> loaders;
std::map<AssetType, aloader_func> loaders;
std::queue<aloader_entry> entries;
const ResPaths* paths;
void tryAddSound(std::string name);
void processPreload(AssetType tag, const std::string& name, dynamic::Map* map);
void processPreloadList(AssetType tag, dynamic::List* list);
void processPreloadConfig(std::filesystem::path file);
void processPreloadConfigs(const Content* content);
public:
AssetsLoader(Assets* assets, const ResPaths* paths);
void addLoader(int tag, aloader_func func);
void addLoader(AssetType tag, aloader_func func);
/// @brief Enqueue asset load
/// @param tag asset type
@ -61,7 +74,7 @@ public:
/// @param alias internal asset name
/// @param settings asset loading settings (based on asset type)
void add(
int tag,
AssetType tag,
const std::string filename,
const std::string alias,
std::shared_ptr<AssetCfg> settings=nullptr

View File

@ -37,7 +37,7 @@ bool assetload::texture(
std::shared_ptr<AssetCfg>
) {
std::unique_ptr<Texture> texture(
png::load_texture(paths->find(filename).u8string())
png::load_texture(paths->find(filename+".png").u8string())
);
if (texture == nullptr) {
std::cerr << "failed to load texture '" << name << "'" << std::endl;
@ -171,26 +171,24 @@ bool assetload::sound(
auto cfg = dynamic_cast<SoundCfg*>(config.get());
bool keepPCM = cfg ? cfg->keepPCM : false;
size_t lastindex = file.find_last_of(".");
std::string extension = file.substr(lastindex);
std::string extensionless = file.substr(0, lastindex);
std::string extension = ".ogg";
try {
std::unique_ptr<audio::Sound> baseSound = nullptr;
// looking for 'sound_name' as base sound
auto soundFile = paths->find(file);
auto soundFile = paths->find(file+extension);
if (fs::exists(soundFile)) {
baseSound.reset(audio::load_sound(soundFile, keepPCM));
}
// looking for 'sound_name_0' as base sound
auto variantFile = paths->find(extensionless+"_0"+extension);
auto variantFile = paths->find(file+"_0"+extension);
if (fs::exists(variantFile)) {
baseSound.reset(audio::load_sound(variantFile, keepPCM));
}
// loading sound variants
for (uint i = 1; ; i++) {
auto variantFile = paths->find(extensionless+"_"+std::to_string(i)+extension);
auto variantFile = paths->find(file+"_"+std::to_string(i)+extension);
if (!fs::exists(variantFile)) {
break;
}

View File

@ -155,6 +155,34 @@ void Map::str(std::string key, std::string& dst) const {
dst = getStr(key, dst);
}
std::string Map::getStr(std::string key) const {
if (values.find(key) == values.end()) {
throw std::runtime_error("missing key '"+key+"'");
}
return getStr(key, "");
}
double Map::getNum(std::string key) const {
if (values.find(key) == values.end()) {
throw std::runtime_error("missing key '"+key+"'");
}
return getNum(key, 0);
}
int64_t Map::getInt(std::string key) const {
if (values.find(key) == values.end()) {
throw std::runtime_error("missing key '"+key+"'");
}
return getInt(key, 0);
}
bool Map::getBool(std::string key) const {
if (values.find(key) == values.end()) {
throw std::runtime_error("missing key '"+key+"'");
}
return getBool(key, false);
}
std::string Map::getStr(std::string key, const std::string& def) const {
auto found = values.find(key);
if (found == values.end())

View File

@ -77,6 +77,11 @@ namespace dynamic {
std::unordered_map<std::string, std::unique_ptr<Value>> values;
~Map();
std::string getStr(std::string key) const;
double getNum(std::string key) const;
int64_t getInt(std::string key) const;
bool getBool(std::string key) const;
std::string getStr(std::string key, const std::string& def) const;
double getNum(std::string key, double def) const;
int64_t getInt(std::string key, int64_t def) const;

View File

@ -15,7 +15,7 @@ namespace dynamic {
}
namespace files {
/* Read-only random access file */
/// @brief Read-only random access file
class rafile {
std::ifstream file;
size_t filelength;
@ -27,34 +27,43 @@ namespace files {
size_t length() const;
};
/* Write bytes array to the file without any extra data */
extern bool write_bytes(fs::path, const ubyte* data, size_t size);
/// @brief Write bytes array to the file without any extra data
/// @param file target file
/// @param data data bytes array
/// @param size size of data bytes array
extern bool write_bytes(fs::path file, const ubyte* data, size_t size);
/* Append bytes array to the file without any extra data */
extern uint append_bytes(fs::path, const ubyte* data, size_t size);
/// @brief Append bytes array to the file without any extra data
/// @param file target file
/// @param data data bytes array
/// @param size size of data bytes array
extern uint append_bytes(fs::path file, const ubyte* data, size_t size);
/* Write string to the file */
/// @brief Write string to the file
extern bool write_string(fs::path filename, const std::string content);
/* Write dynamic data to the JSON file
@param nice if true,
human readable format will be used, otherwise minimal */
/// @brief Write dynamic data to the JSON file
/// @param nice if true, human readable format will be used, otherwise minimal
extern bool write_json(
fs::path filename,
const dynamic::Map* obj,
bool nice=true);
/* Write dynamic data to the binary JSON file
(see src/coders/binary_json_spec.md)
@param compressed use gzip compression */
/// @brief Write dynamic data to the binary JSON file
/// (see src/coders/binary_json_spec.md)
/// @param compressed use gzip compression
extern bool write_binary_json(
fs::path filename,
const dynamic::Map* obj,
bool compressed=false);
bool compressed=false
);
extern bool read(fs::path, char* data, size_t size);
extern ubyte* read_bytes(fs::path, size_t& length);
extern std::string read_string(fs::path filename);
/// @brief Read JSON or BJSON file
/// @param file *.json or *.bjson file
extern std::unique_ptr<dynamic::Map> read_json(fs::path file);
extern std::unique_ptr<dynamic::Map> read_binary_json(fs::path file);
extern std::vector<std::string> read_list(fs::path file);

View File

@ -289,7 +289,7 @@ static std::shared_ptr<UINode> readImage(UiXmlReader& reader, xml::xmlelement el
std::string src = element->attr("src", "").getText();
auto image = std::make_shared<Image>(src);
_readUINode(reader, element, *image);
reader.getAssetsLoader().add(ASSET_TEXTURE, "textures/"+src+".png", src, nullptr);
reader.getAssetsLoader().add(AssetType::texture, "textures/"+src, src, nullptr);
return image;
}