DirectVideoOutputBackend.hpp

Go to the documentation of this file.

#pragma once
 
#include <Gfx/Graph/RenderState.hpp> // GraphicsApi
#include <Gfx/Graph/interop/VideoOutputStrategy.hpp>
#include <Gfx/Graph/interop/CpuStagedVideoOutput.hpp> // HostStagedPlane
#include <Gfx/Graph/interop/PacedFramePump.hpp>
#include <Gfx/Graph/interop/VendorDmaRegistrar.hpp>
#include <Gfx/Graph/interop/VideoPixelFormat.hpp>
 
#include <score_plugin_gfx_export.h>
 
#include <QString>
 
#include <cstdint>
#include <functional>
#include <memory>
#include <vector>
 
class QRhi;
class QRhiTexture;
 
namespace score::gfx
{
 
struct SCORE_PLUGIN_GFX_EXPORT DirectVideoOutputBackend
{
  using CustomStage = std::function<bool(
      const std::uint8_t* src, int srcRowBytes, std::uint8_t* dst,
      int dstRowBytes, int rows)>;
 
  virtual ~DirectVideoOutputBackend();
 
  virtual bool open(GraphicsApi api) = 0;
 
  virtual int width() const noexcept = 0;
  virtual int height() const noexcept = 0;
 
  virtual double frameRate() const noexcept = 0;
 
  virtual bool isOpen() const noexcept = 0;
 
  virtual interop::VideoPixelFormat wireFormat() const noexcept = 0;
 
  virtual interop::VideoPixelFormat encoderFormat() const noexcept
  {
    return wireFormat();
  }
 
  virtual bool prefersFloatRender() const noexcept { return false; }
 
  virtual QString colorConversion() const = 0;
 
  virtual std::uint32_t frameByteSize() const noexcept = 0;
  virtual int visibleRows() const noexcept = 0;
  virtual std::vector<interop::HostStagedPlane> planes() const = 0;
 
  virtual interop::VendorDmaRegistrar registrar() = 0;
 
  virtual CustomStage customStage() { return {}; }
 
  virtual interop::FrameMemoryProvider frameMemoryProvider() { return {}; }
 
  virtual bool prefersGpuDownload() const noexcept { return false; }
 
  virtual std::vector<std::function<std::unique_ptr<interop::VideoOutputStrategy>()>>
  gpuDirectCandidates(QRhi* rhi, GraphicsApi api) = 0;
 
  virtual interop::PacedFramePump::Hooks pacingHooks() = 0;
 
  virtual std::function<bool()> genlockTickSource() { return {}; }
 
  virtual void quiesce() { }
 
  virtual void close() = 0;
};
 
} // namespace score::gfx