ShaderRegistry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorShaders/phosphorshaders_export.h>
 
#include <PhosphorFsLoader/MetadataPackRegistryBase.h>
#include <PhosphorFsLoader/MetadataPackScanStrategy.h>
 
#include <QHash>
#include <QImage>
#include <QList>
#include <QMap>
#include <QMutex>
#include <QRect>
#include <QSize>
#include <QString>
#include <QUrl>
#include <QVariant>
#include <array>
#include <memory>
 
namespace PhosphorShaders {
 
class IWallpaperProvider;
 
class PHOSPHORSHADERS_EXPORT ShaderRegistry : public PhosphorFsLoader::MetadataPackRegistryBase
{
    Q_OBJECT
 
public:
    struct ParameterInfo
    {
        QString id;
        QString name;
        QString group;
        QString type; 
        int slot = -1;
        QVariant defaultValue;
        QVariant minValue;
        QVariant maxValue;
        bool useZoneColor = false; 
        QString wrap;
 
        QString uniformName() const;
    };
 
    struct ShaderInfo
    {
        QString id;
        QString name;
        QString description;
        QString author;
        QString version;
        QUrl shaderUrl;
        QString sourcePath;
        QString vertexShaderPath;
        QStringList bufferShaderPaths;
        QString previewPath;
        QString category;
        QList<ParameterInfo> parameters;
        QMap<QString, QVariantMap> presets;
        bool isUserShader = false;
        bool isMultipass = false;
        bool useWallpaper = false;
        bool bufferFeedback = false;
        qreal bufferScale = 1.0;
        QString bufferWrap = QStringLiteral("clamp");
        QStringList bufferWraps;
        QString bufferFilter = QStringLiteral("linear");
        QStringList bufferFilters;
        bool useDepthBuffer = false;
 
        bool isValid() const
        {
            return !id.isEmpty() && (isNoneShader(id) || shaderUrl.isValid());
        }
    };
 
    explicit ShaderRegistry(QObject* parent = nullptr);
    ~ShaderRegistry() override;
 
    // ── Shader discovery ──────────────────────────────────────────────
 
    static QString noneShaderUuid();
    static bool isNoneShader(const QString& id);
 
    QList<ShaderInfo> availableShaders() const;
    Q_INVOKABLE QVariantList availableShadersVariant() const;
 
    ShaderInfo shader(const QString& id) const;
    Q_INVOKABLE QVariantMap shaderInfo(const QString& id) const;
    Q_INVOKABLE QUrl shaderUrl(const QString& id) const;
 
    // ── Parameters & presets ──────────────────────────────────────────
 
    Q_INVOKABLE QVariantMap defaultParams(const QString& id) const;
    bool validateParams(const QString& id, const QVariantMap& params) const;
    QVariantMap validateAndCoerceParams(const QString& id, const QVariantMap& params) const;
    Q_INVOKABLE QVariantMap translateParamsToUniforms(const QString& shaderId, const QVariantMap& storedParams) const;
    Q_INVOKABLE QVariantMap presetParams(const QString& shaderId, const QString& presetName) const;
    Q_INVOKABLE QStringList shaderPresetNames(const QString& shaderId) const;
    Q_INVOKABLE QVariantList shaderPresetsVariant(const QString& shaderId) const;
 
    Q_INVOKABLE bool shadersEnabled() const
    {
        return true;
    }
 
    // ── Lifecycle ─────────────────────────────────────────────────────
 
    void reportShaderBakeStarted(const QString& shaderId);
    void reportShaderBakeFinished(const QString& shaderId, bool success, const QString& error);
 
    // ── Wallpaper ─────────────────────────────────────────────────────
 
    static QString wallpaperPath();
    static QImage loadWallpaperImage();
 
    static QImage loadWallpaperImage(const QRect& subGeom, const QRect& physGeom);
 
    static QRect computeWallpaperCropRect(QSize wpSize, const QRect& physGeom, const QRect& subGeom);
 
    static void invalidateWallpaperCache();
 
Q_SIGNALS:
    void shadersChanged();
    void shaderCompilationStarted(const QString& shaderId);
    void shaderCompilationFinished(const QString& shaderId, bool success, const QString& error);
 
protected:
    void onUserPathChanged(const QString& path) override;
 
private:
    bool validateParameterValue(const ParameterInfo& param, const QVariant& value) const;
    QVariantMap shaderInfoToVariantMap(const ShaderInfo& info) const;
    QVariantMap parameterInfoToVariantMap(const ParameterInfo& param) const;
 
    using ScanStrategy = PhosphorFsLoader::MetadataPackScanStrategy<ShaderInfo>;
 
    static std::unique_ptr<PhosphorFsLoader::IScanStrategy> buildScanStrategy(ShaderRegistry* self);
 
    // Non-owning typed alias for the strategy the base owns. Populated
    // in the ctor's member-init list via `static_cast<ScanStrategy*>(strategy())`
    // — the cast is safe because we passed in the same instance. Named
    // distinctly from the base's private `m_strategy` so a future reader
    // can't accidentally read this as the same field.
    ScanStrategy* m_typedStrategy;
 
    static std::unique_ptr<IWallpaperProvider> s_wallpaperProvider;
    static QString s_cachedWallpaperPath;
    static QImage s_cachedWallpaperImage;
    static qint64 s_cachedWallpaperMtime;
    static QMutex s_wallpaperCacheMutex;
 
    // Per-VS crop cache: keeps the same QImage (and cacheKey) for repeated
    // loadWallpaperImage(sub, phys) calls so downstream cacheKey()-based
    // short-circuits in ShaderEffect/ShaderNodeRhi keep working and the GPU
    // doesn't re-upload the wallpaper on every overlay update.
    struct WallpaperCropEntry
    {
        QRect sub;
        QRect phys;
        qint64 mtime = 0;
        QImage img;
    };
    static constexpr int CropCacheCapacity = 8;
    static std::array<WallpaperCropEntry, CropCacheCapacity> s_cachedWallpaperCrops;
    static int s_cachedWallpaperCropNextSlot;
};
 
} // namespace PhosphorShaders