assetmanager.h

Go to the documentation of this file.

/* Conquer Space
 * Copyright (C) 2021-2023 Conquer Space
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
#include <hjson.h>
#include <spdlog/spdlog.h>
 
#include <istream>
#include <map>
#include <memory>
#include <optional>
#include <queue>
#include <string>
#include <utility>
#include <vector>
 
#include "engine/asset/asset.h"
#include "engine/asset/assetprototype.h"
#include "engine/asset/textasset.h"
#include "engine/asset/vfs/vfs.h"
#include "engine/engine.h"
#include "engine/enginelogger.h"
#include "engine/graphics/shader.h"
#include "engine/graphics/text.h"
#include "engine/graphics/texture.h"
#include "engine/gui.h"
 
namespace cqsp {
namespace asset {
class QueueHolder {
 public:
    QueueHolder() { prototype = nullptr; }
    explicit QueueHolder(AssetPrototype* type) : prototype(type) {}
 
    AssetPrototype* prototype;
};
 
template <typename T>
class ThreadsafeQueue {
    std::queue<T> queue_;
    mutable std::mutex mutex_;
 
    // Moved out of public interface to prevent races between this
    // and pop().
    bool empty() const { return queue_.empty(); }
 
 public:
    ThreadsafeQueue() = default;
    ThreadsafeQueue(const ThreadsafeQueue<T>&) = delete;
    ThreadsafeQueue& operator=(const ThreadsafeQueue<T>&) = delete;
 
    ThreadsafeQueue(ThreadsafeQueue<T>&& other) {
        std::lock_guard<std::mutex> lock(mutex_);
        queue_ = std::move(other.queue_);
    }
 
    virtual ~ThreadsafeQueue() {}
 
    unsigned long size() const {
        std::lock_guard<std::mutex> lock(mutex_);
        return queue_.size();
    }
 
    std::optional<T> pop() {
        std::lock_guard<std::mutex> lock(mutex_);
        if (queue_.empty()) {
            return {};
        }
        T tmp = queue_.front();
        queue_.pop();
        return tmp;
    }
 
    void push(const T& item) {
        std::lock_guard<std::mutex> lock(mutex_);
        queue_.push(item);
    }
};
 
class AssetLoader;
class AssetManager;
 
class Package {
 public:
    std::string name;
    std::string version;
    std::string title;
    std::string author;
 
    template <class T, typename V>
    T* GetAsset(const V asset) {
        if (!HasAsset(asset)) {
            ENGINE_LOG_ERROR("Invalid key {}", asset);
        }
        return dynamic_cast<T*>(assets[asset].get());
    }
 
    bool HasAsset(const char* asset);
    bool HasAsset(const std::string& asset);
 
    auto begin() { return assets.begin(); }
 
    auto end() { return assets.end(); }
 
 private:
    std::map<std::string, std::unique_ptr<Asset>> assets;
 
    void ClearAssets();
 
    friend class AssetLoader;
    friend class AssetManager;
};
 
class PackagePrototype {
 public:
    std::string name;
    std::string version;
    std::string title;
    std::string author;
    std::string path;
 
    bool enabled;
};
 
class AssetManager {
 public:
    AssetManager() = default;
 
    ShaderProgram_t MakeShader(const std::string& vert, const std::string& frag);
    ShaderProgram_t MakeShader(const std::string& vert, const std::string& frag, const std::string& geom);
 
    template <class T>
    T* GetAsset(const std::string& key) {
        static_assert(std::is_base_of<Asset, T>::value, "Class is not child of cqsp::asset::Asset");
        std::size_t separation = key.find(":");
        // Default name is core
        std::string package_name = "core";
        if (separation != std::string::npos) {
            package_name = key.substr(0, separation);
        }
 
        // Check if package exists
        if (packages.count(package_name) == 0) {
            ENGINE_LOG_ERROR("Cannot find package {}", package_name);
            return nullptr;
        }
        std::string pkg_key = key.substr(separation + 1, key.length());
        auto& package = packages[package_name];
        // Probably a better way to do this, to be honest
        // Load default texture
        if (!package->HasAsset(pkg_key)) {
            ENGINE_LOG_ERROR("Cannot find asset {}", pkg_key);
            if constexpr (std::is_same<T, asset::Texture>::value) {
                return &empty_texture;
            }
            return nullptr;
        }
        // Check if asset exists
        T* ptr = package->GetAsset<T>(pkg_key);
        if (ptr == nullptr) {
            SPDLOG_WARN("Asset {} is wrong type", key);
        } else {
            ptr->accessed++;
        }
        return ptr;
    }
 
    void LoadDefaultTexture();
    void ClearAssets();
 
    Package* GetPackage(const std::string& name) { return packages[name].get(); }
 
    int GetPackageCount() { return packages.size(); }
 
    auto begin() { return packages.begin(); }
 
    auto end() { return packages.end(); }
 
    void SaveModList();
 
    std::map<std::string, PackagePrototype> m_package_prototype_list;
 
 private:
    std::map<std::string, std::unique_ptr<Package>> packages;
    asset::Texture empty_texture;
    friend class AssetLoader;
};
 
class AssetLoader {
 public:
    AssetLoader();
 
    void LoadMods();
 
    std::unique_ptr<Package> LoadPackage(const std::string& path);
 
    void BuildNextAsset();
 
    bool QueueHasItems() { return m_asset_queue.size() != 0; }
 
    std::vector<std::string>& GetMissingAssets() { return missing_assets; }
 
    static std::string GetModFilePath();
 
    std::atomic_int& getMaxLoading() { return max_loading; }
    std::atomic_int& getCurrentLoading() { return currentloading; }
 
    friend class AssetManager;
 
    AssetManager* manager;
 
    typedef std::function<std::unique_ptr<Asset>(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                 const std::string& key, const Hjson::Value& hints)>
        LoaderFunction;
 
 private:
    std::optional<PackagePrototype> LoadModPrototype(const std::string&);
 
    std::unique_ptr<cqsp::asset::Asset> LoadText(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                 const std::string& key, const Hjson::Value& hints);
    std::unique_ptr<cqsp::asset::Asset> LoadTextDirectory(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                          const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadTexture(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                    const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadBinaryAsset(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                        const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadHjson(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                  const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadShader(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                   const std::string& key, const Hjson::Value& hints);
    std::unique_ptr<cqsp::asset::Asset> LoadFont(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                 const std::string& key, const Hjson::Value& hints);
    std::unique_ptr<cqsp::asset::Asset> LoadAudio(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                  const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadCubemap(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                    const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadModel(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                  const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<ShaderDefinition> LoadShaderDefinition(cqsp::asset::VirtualMounter* mount, const std::string& path,
                                                           const std::string& key, const Hjson::Value& hints);
 
    std::unique_ptr<TextDirectoryAsset> LoadScriptDirectory(VirtualMounter* mount, const std::string& path,
                                                            const Hjson::Value& hints);
 
    std::unique_ptr<cqsp::asset::Asset> LoadAsset(const AssetType& type, const std::string& path,
                                                  const std::string& key, const Hjson::Value& hints);
 
    ShaderProgram_t MakeShader(const std::string& key);
 
    void PlaceAsset(Package& package, const AssetType& type, const std::string& path, const std::string& key,
                    const Hjson::Value& hints);
 
    void LoadDirectory(const std::string& path, const std::function<void(std::string)>& file);
 
    void LoadResources(Package& package, const std::string& path);
 
    void LoadResourceHjsonFile(Package& package, const std::string& package_mount_path,
                               const std::string& resource_file_path, const Hjson::Value& asset_value);
    bool HjsonPrototypeDirectory(Package& package, const std::string& path, const std::string& name);
 
    IVirtualFileSystem* GetVfs(const std::string& path);
 
    std::vector<std::string> missing_assets;
    ThreadsafeQueue<QueueHolder> m_asset_queue;
 
    // All the assets that are to be loaded
    std::atomic_int max_loading;
 
    std::atomic_int currentloading;
    std::map<AssetType, LoaderFunction> loading_functions;
    VirtualMounter mounter;
};
}  // namespace asset
}  // namespace cqsp