103 lines
3.0 KiB
C++
103 lines
3.0 KiB
C++
// Copyright 2023 Dolphin Emulator Project
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#pragma once
|
|
|
|
#include "Common/CommonTypes.h"
|
|
#include "VideoCommon/Assets/CustomAssetLibrary.h"
|
|
|
|
#include <memory>
|
|
#include <mutex>
|
|
#include <optional>
|
|
|
|
namespace VideoCommon
|
|
{
|
|
// An abstract class that provides operations for loading
|
|
// data from a 'CustomAssetLibrary'
|
|
class CustomAsset
|
|
{
|
|
public:
|
|
CustomAsset(std::shared_ptr<CustomAssetLibrary> library,
|
|
const CustomAssetLibrary::AssetID& asset_id);
|
|
virtual ~CustomAsset() = default;
|
|
CustomAsset(const CustomAsset&) = delete;
|
|
CustomAsset(CustomAsset&&) = delete;
|
|
CustomAsset& operator=(const CustomAsset&) = delete;
|
|
CustomAsset& operator=(CustomAsset&&) = delete;
|
|
|
|
// Loads the asset from the library returning a pass/fail result
|
|
bool Load();
|
|
|
|
// Queries the last time the asset was modified or standard epoch time
|
|
// if the asset hasn't been modified yet
|
|
// Note: not thread safe, expected to be called by the loader
|
|
CustomAssetLibrary::TimeType GetLastWriteTime() const;
|
|
|
|
// Returns the time that the data was last loaded
|
|
const CustomAssetLibrary::TimeType& GetLastLoadedTime() const;
|
|
|
|
// Returns an id that uniquely identifies this asset
|
|
const CustomAssetLibrary::AssetID& GetAssetId() const;
|
|
|
|
// A rough estimate of how much space this asset
|
|
// will take in memroy
|
|
std::size_t GetByteSizeInMemory() const;
|
|
|
|
protected:
|
|
const std::shared_ptr<CustomAssetLibrary> m_owning_library;
|
|
|
|
private:
|
|
virtual CustomAssetLibrary::LoadInfo LoadImpl(const CustomAssetLibrary::AssetID& asset_id) = 0;
|
|
CustomAssetLibrary::AssetID m_asset_id;
|
|
|
|
mutable std::mutex m_info_lock;
|
|
std::size_t m_bytes_loaded = 0;
|
|
CustomAssetLibrary::TimeType m_last_loaded_time = {};
|
|
};
|
|
|
|
// An abstract class that is expected to
|
|
// be the base class for all assets
|
|
// It provides a simple interface for
|
|
// verifying that an asset data of type
|
|
// 'UnderlyingType' is loaded by
|
|
// checking against 'GetData()'
|
|
template <typename UnderlyingType>
|
|
class CustomLoadableAsset : public CustomAsset
|
|
{
|
|
public:
|
|
using CustomAsset::CustomAsset;
|
|
|
|
// Callees should understand that the type returned is
|
|
// a local copy and 'GetData()' needs to be called
|
|
// to ensure the latest copy is available if
|
|
// they want to handle reloads
|
|
[[nodiscard]] std::shared_ptr<UnderlyingType> GetData() const
|
|
{
|
|
std::lock_guard lk(m_data_lock);
|
|
if (m_loaded)
|
|
return m_data;
|
|
return nullptr;
|
|
}
|
|
|
|
protected:
|
|
bool m_loaded = false;
|
|
mutable std::mutex m_data_lock;
|
|
std::shared_ptr<UnderlyingType> m_data;
|
|
};
|
|
|
|
// A helper struct that contains
|
|
// an asset with a last cached write time
|
|
// This can be used to determine if the asset
|
|
// has diverged from the last known state
|
|
// To know if it is time to update other dependencies
|
|
// based on the asset data
|
|
// TODO C++20: use a 'derived_from' concept against 'CustomAsset' when available
|
|
template <typename AssetType>
|
|
struct CachedAsset
|
|
{
|
|
std::shared_ptr<AssetType> m_asset;
|
|
VideoCommon::CustomAssetLibrary::TimeType m_cached_write_time;
|
|
};
|
|
|
|
} // namespace VideoCommon
|