assetloader.h

Go to the documentation of this file.

/* Conquer Space
 * Copyright (C) 2021-2025 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 <atomic>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <vector>
 
#include "engine/asset/assetoptions.h"
#include "engine/asset/assetprototype.h"
#include "engine/asset/package.h"
#include "engine/asset/packageprototype.h"
#include "engine/asset/textasset.h"
#include "engine/asset/vfs/vfs.h"
#include "engine/graphics/shader.h"
#include "engine/util/threadsafequeue.h"
 
namespace cqsp::asset {
class QueueHolder {
 public:
    QueueHolder() { prototype = nullptr; }
    explicit QueueHolder(AssetPrototype* type) : prototype(type) {}
 
    AssetPrototype* prototype;
};
 
class AssetLoader {
 public:
    AssetLoader(AssetOptions options = AssetOptions());
 
    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);
 
    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;
    engine::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;
    std::map<AssetType, uint64_t> loading_times;
    VirtualMounter mounter;
 
    AssetOptions asset_options;
};
}  // namespace cqsp::asset