VulkanDisplayPlugin.h

//
//  Created by dr Karol Suprynowicz on 2024/08/12
//  Based on OpenGLDisplayPlugin.h, originally created by Bradley Austin Davis on 2015/05/29
//  Copyright 2015 High Fidelity, Inc.
//  Copyright 2025 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
#pragma once
 
// TODO: find a way of doing this from CMake. I'm not familiar enough with build system to figure this out.
#ifndef USE_GL
 
#include "DisplayPlugin.h"
 
#include <condition_variable>
#include <memory>
#include <queue>
 
#include <QtCore/QThread>
#include <QtCore/QTimer>
#include <QtGui/QImage>
 
#include <GLMHelpers.h>
#include <SimpleMovingAverage.h>
#include <shared/RateCounter.h>
 
#include <gpu/Batch.h>
#include <vk/VKWindow.h>
 
class RefreshRateController;
 
class VulkanDisplayPlugin : public DisplayPlugin {
    Q_OBJECT
    Q_PROPERTY(float hudAlpha MEMBER _hudAlpha)
    using Parent = DisplayPlugin;
 
protected:
    using Mutex = std::mutex;
    using Lock = std::unique_lock<Mutex>;
    using Condition = std::condition_variable;
 
public:
    ~VulkanDisplayPlugin();
    // These must be final to ensure proper ordering of operations
    // between the main thread and the presentation thread
 
    static std::function<void(int)> getRefreshRateOperator();
 
    bool activate() override final;
    void deactivate() override final;
    bool startStandBySession() override final;
    void endSession() override final;
    bool eventFilter(QObject* receiver, QEvent* event) override;
    bool isDisplayVisible() const override { return true; }
    bool isSupported() const override;
    void captureFrame(const std::string& outputName) const override;
    void submitFrame(const gpu::FramePointer& newFrame) override;
 
    glm::uvec2 getRecommendedRenderSize() const override { return getSurfacePixels(); }
 
    glm::uvec2 getRecommendedUiSize() const override { return getSurfaceSize(); }
 
    virtual bool setDisplayTexture(const QString& name) override;
    virtual bool onDisplayTextureReset() { return false; };
 
    float presentRate() const override;
 
    void resetPresentRate() override;
 
    float newFramePresentRate() const override;
 
    float droppedFrameRate() const override;
 
    float renderRate() const override;
 
    bool beginFrameRender(uint32_t frameIndex) override;
 
    virtual bool wantVsync() const { return true; }
    void setVsyncEnabled(bool vsyncEnabled) { _vsyncEnabled = vsyncEnabled; }
    bool isVsyncEnabled() const { return _vsyncEnabled; }
    // Three threads, one for rendering, one for texture transfers, one reserved for the GL driver
    // Drop to one reserved for better other-task performance in desktop
    int getRequiredThreadCount() const override { return 1; }
 
    virtual std::function<void(gpu::Batch&, const gpu::TexturePointer&)> getHUDOperator() override;
    void copyTextureToQuickFramebuffer(NetworkTexturePointer source,
                                       QOpenGLFramebufferObject* target,
                                       GLsync* fenceSync) override;
 
    virtual const QString getName() const override { return "Vulkan window"; }
    virtual void pluginUpdate() override {};
 
protected:
    friend class VulkanPresentThread;
 
    glm::uvec2 getSurfaceSize() const;
    glm::uvec2 getSurfacePixels() const;
    // Some display plugins require us to always execute some present logic,
    // whether we have a frame or not (Oculus Mobile plugin)
    // Such plugins must be prepared to do the right thing if the `_currentFrame`
    // is not populated
    virtual bool alwaysPresent() const { return false; }
 
    void updateCompositeFramebuffer();
 
    virtual QThread::Priority getPresentPriority() { return QThread::HighPriority; }
    virtual void compositeLayers();
    virtual void setupCompositeScenePipeline(gpu::Batch& batch);
    virtual void compositeScene();
    virtual void compositePointer();
    virtual void compositeExtra(){};
 
    // These functions must only be called on the presentation thread
    virtual void customizeContext();
    virtual void uncustomizeContext();
 
    // Returns true on successful activation
    virtual bool internalActivate() { return true; }
    virtual void internalDeactivate() {}
 
    // Returns true on successful activation of standby session
    virtual bool activateStandBySession() { return true; }
    virtual void deactivateSession() {}
 
    // Plugin specific functionality to send the composed scene to the output window or device
    virtual void internalPresent();
 
    void renderFromTexture(gpu::Batch& batch,
                           const gpu::TexturePointer& texture,
                           const glm::ivec4& viewport,
                           const glm::ivec4& scissor,
                           const gpu::FramebufferPointer& fbo);
    void renderFromTexture(gpu::Batch& batch,
                           const gpu::TexturePointer& texture,
                           const glm::ivec4& viewport,
                           const glm::ivec4& scissor);
    virtual void updateFrameData();
    virtual glm::mat4 getViewCorrection() { return glm::mat4(); }
 
    void withOtherThreadContext(std::function<void()> f) const;
 
    void present(const std::shared_ptr<RefreshRateController>& refreshRateController);
    virtual void swapBuffers();
 
    void render(std::function<void(gpu::Batch& batch)> f);
 
    bool _vsyncEnabled{ true };
    QThread* _presentThread{ nullptr };
    std::queue<gpu::FramePointer> _newFrameQueue;
    RateCounter<200> _droppedFrameRate;
    RateCounter<200> _newFrameRate;
    RateCounter<200> _presentRate;
    RateCounter<200> _renderRate;
 
    gpu::FramePointer _currentFrame;
    gpu::Frame* _lastFrame{ nullptr };
    mat4 _prevRenderView;
    gpu::FramebufferPointer _compositeFramebuffer;
    gpu::PipelinePointer _hudPipeline;
    gpu::PipelinePointer _mirrorHUDPipeline;
    gpu::ShaderPointer _mirrorHUDPS;
    gpu::PipelinePointer _drawTexturePipeline;
    gpu::PipelinePointer _drawTextureSqueezePipeline;
    gpu::PipelinePointer _linearToSRGBPipeline;
    gpu::PipelinePointer _SRGBToLinearPipeline;
    gpu::PipelinePointer _cursorPipeline;
    gpu::TexturePointer _displayTexture{};
    float _compositeHUDAlpha{ 1.0f };
 
    virtual gpu::PipelinePointer getRenderTexturePipeline();
 
    struct CursorData {
        QImage image;
        vec2 hotSpot;
        uvec2 size;
        gpu::TexturePointer texture;
    };
 
    std::map<uint16_t, CursorData> _cursorsData;
    bool _lockCurrentTexture{ false };
 
    void assertNotPresentThread() const;
    void assertIsPresentThread() const;
 
    template <typename F>
    void withPresentThreadLock(F f) const {
        assertIsPresentThread();
        Lock lock(_presentMutex);
        f();
    }
 
    template <typename F>
    void withNonPresentThreadLock(F f) const {
        assertNotPresentThread();
        Lock lock(_presentMutex);
        f();
    }
 
    const gpu::BackendPointer& getBackend() const;
 
    // Any resource shared by the main thread and the presentation thread must
    // be accessed through this mutex
    mutable Mutex _presentMutex;
    float _hudAlpha{ 1.0f };
 
    QImage getScreenshot(float aspectRatio);
    QImage getSecondaryCameraScreenshot();
    //std::shared_ptr<VKWindow> _vkWindow;
    //VKWidget *_vkWidget{ 0 };
    VKWindow *_vkWindow{ 0 };
    int _renderedFrameCount{ 0 };
};
 
#endif