Source repositorygraphics.h

Go to the documentation of this file.

#pragma once
 
// standard includes
#include <array>
#include <optional>
#include <string_view>
 
// lib includes
#include <glad/egl.h>
#include <glad/gl.h>
 
// local includes
#include "misc.h"
#include "src/logging.h"
#include "src/platform/common.h"
#include "src/utility.h"
#include "src/video_colorspace.h"

#define SUNSHINE_STRINGIFY_HELPER(x) #x
#define SUNSHINE_STRINGIFY(x) SUNSHINE_STRINGIFY_HELPER(x)
#define gl_drain_errors_helper(x) gl::drain_errors(x)
#define gl_drain_errors gl_drain_errors_helper(__FILE__ ":" SUNSHINE_STRINGIFY(__LINE__))

extern "C" int close(int __fd);
 
// X11 Display
extern "C" struct _XDisplay;
 
struct AVFrame;
void free_frame(AVFrame *frame);

using frame_t = util::safe_ptr<AVFrame, &free_frame>;
 
namespace gl {
  extern GladGLContext ctx;
 
  // glEGLImageTargetTexture2DOES (GL_OES_EGL_image) is not part of desktop GL —
  // it is a GLES extension that must be loaded manually via eglGetProcAddress.
  // GLeglImageOES is typedef void* per the Khronos spec (gl.xml).
  using PFNGLEGLIMAGETARGETTEXTURE2DOESPROC = void (*)(GLenum target, void *image);
  PFNGLEGLIMAGETARGETTEXTURE2DOESPROC egl_image_target_texture_2d();

  void drain_errors(const std::string_view &prefix);

  class tex_t: public util::buffer_t<GLuint> {
    using util::buffer_t<GLuint>::buffer_t;
 
  public:
    tex_t(tex_t &&) = default;
    tex_t &operator=(tex_t &&) = default;
 
    ~tex_t();

    static tex_t make(std::size_t count);
  };

  class frame_buf_t: public util::buffer_t<GLuint> {
    using util::buffer_t<GLuint>::buffer_t;
 
  public:
    frame_buf_t(frame_buf_t &&) = default;
    frame_buf_t &operator=(frame_buf_t &&) = default;
 
    ~frame_buf_t();

    static frame_buf_t make(std::size_t count);

    inline void bind(std::nullptr_t, std::nullptr_t) {
      int x = 0;
      for (auto fb : (*this)) {
        ctx.BindFramebuffer(GL_FRAMEBUFFER, fb);
        ctx.FramebufferTexture(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0 + x, 0, 0);
 
        ++x;
      }
      return;
    }

    template<class It>
    void bind(It it_begin, It it_end) {
      using namespace std::literals;
      if (std::distance(it_begin, it_end) > size()) {
        BOOST_LOG(warning) << "To many elements to bind"sv;
        return;
      }
 
      int x = 0;
      std::for_each(it_begin, it_end, [&](auto tex) {
        ctx.BindFramebuffer(GL_FRAMEBUFFER, (*this)[x]);
        ctx.BindTexture(GL_TEXTURE_2D, tex);
 
        ctx.FramebufferTexture(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0 + x, tex, 0);
 
        ++x;
      });
    }

    void copy(int id, int texture, int offset_x, int offset_y, int width, int height);
  };

  class shader_t {
    KITTY_USING_MOVE_T(shader_internal_t, GLuint, std::numeric_limits<GLuint>::max(), {
      if (el != std::numeric_limits<GLuint>::max()) {
        ctx.DeleteShader(el);
      }
    });
 
  public:
    std::string err_str();

    static util::Either<shader_t, std::string> compile(const std::string_view &source, GLenum type);

    GLuint handle() const;
 
  private:
    shader_internal_t _shader;
  };

  class buffer_t {
    KITTY_USING_MOVE_T(buffer_internal_t, GLuint, std::numeric_limits<GLuint>::max(), {
      if (el != std::numeric_limits<GLuint>::max()) {
        ctx.DeleteBuffers(1, &el);
      }
    });
 
  public:
    static buffer_t make(util::buffer_t<GLint> &&offsets, const char *block, const std::string_view &data);

    GLuint handle() const;

    const char *block() const;

    void update(const std::string_view &view, std::size_t offset = 0);
    void update(std::string_view *members, std::size_t count, std::size_t offset = 0);
 
  private:
    const char *_block;
 
    std::size_t _size;
 
    util::buffer_t<GLint> _offsets;
 
    buffer_internal_t _buffer;
  };

  class program_t {
    KITTY_USING_MOVE_T(program_internal_t, GLuint, std::numeric_limits<GLuint>::max(), {
      if (el != std::numeric_limits<GLuint>::max()) {
        ctx.DeleteProgram(el);
      }
    });
 
  public:
    std::string err_str();

    static util::Either<program_t, std::string> link(const shader_t &vert, const shader_t &frag);

    void bind(const buffer_t &buffer);

    std::optional<buffer_t> uniform(const char *block, std::pair<const char *, std::string_view> *members, std::size_t count);

    GLuint handle() const;
 
  private:
    program_internal_t _program;
  };
}  // namespace gl
 
namespace gbm {
  struct device;
  using device_destroy_fn = void (*)(device *gbm);
  using create_device_fn = device *(*)(int fd);
 
  extern device_destroy_fn device_destroy;
  extern create_device_fn create_device;

  using gbm_t = util::dyn_safe_ptr<device, &device_destroy>;

  int init();
 
}  // namespace gbm
 
namespace egl {
  using display_t = util::dyn_safe_ptr_v2<void, EGLBoolean, &eglTerminate>;

  struct rgb_img_t {
    display_t::pointer display;  
    EGLImage xrgb8;  
 
    gl::tex_t tex;  
  };

  struct nv12_img_t {
    display_t::pointer display;  
    EGLImage r8;  
    EGLImage bg88;  
 
    gl::tex_t tex;  
    gl::frame_buf_t buf;  
 
    // sizeof(va::DRMPRIMESurfaceDescriptor::objects) / sizeof(va::DRMPRIMESurfaceDescriptor::objects[0]);
    static constexpr std::size_t num_fds = 4;  
 
    std::array<file_t, num_fds> fds;  
  };

  struct yuv444_img_t {
    display_t::pointer display;  
    EGLImage r8;  
    EGLImage g8;  
    EGLImage b8;  
 
    gl::tex_t tex;  
    gl::frame_buf_t buf;  
 
    static constexpr std::size_t num_fds = 4;  
 
    std::array<file_t, num_fds> fds;  
  };
 
#ifndef DOXYGEN
  KITTY_USING_MOVE_T(rgb_t, rgb_img_t, , {
    if (el.xrgb8) {
      eglDestroyImage(el.display, el.xrgb8);
    }
  });
 
  KITTY_USING_MOVE_T(nv12_t, nv12_img_t, , {
    if (el.r8) {
      eglDestroyImage(el.display, el.r8);
    }
 
    if (el.bg88) {
      eglDestroyImage(el.display, el.bg88);
    }
  });
 
  KITTY_USING_MOVE_T(yuv444_t, yuv444_img_t, , {
    if (el.r8) {
      eglDestroyImage(el.display, el.r8);
    }
 
    if (el.g8) {
      eglDestroyImage(el.display, el.g8);
    }
 
    if (el.b8) {
      eglDestroyImage(el.display, el.b8);
    }
  });
 
  KITTY_USING_MOVE_T(ctx_t, (std::tuple<display_t::pointer, EGLContext>), , {
    TUPLE_2D_REF(disp, ctx, el);
    if (ctx) {
      eglMakeCurrent(disp, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
      eglDestroyContext(disp, ctx);
    }
  });
#else
  class rgb_t;

  class nv12_t;

  class yuv444_t;

  class ctx_t;
#endif

  struct surface_descriptor_t {
    int width;  
    int height;  
    std::array<int, 4> fds;  
    std::uint32_t fourcc;  
    std::uint64_t modifier;  
    std::array<std::uint32_t, 4> pitches;  
    std::array<std::uint32_t, 4> offsets;  
  };

  display_t make_display(std::variant<gbm::gbm_t::pointer, wl_display *, _XDisplay *> native_display);
  std::optional<ctx_t> make_ctx(display_t::pointer display);

  void ensure_privileged_egl_worker_started();

  std::optional<rgb_t> import_source(display_t::pointer egl_display, const surface_descriptor_t &xrgb);

  rgb_t create_blank(platf::img_t &img);

  std::optional<nv12_t> import_target(
    display_t::pointer egl_display,
    std::array<file_t, nv12_img_t::num_fds> &&fds,
    const surface_descriptor_t &y,
    const surface_descriptor_t &uv
  );

  std::optional<yuv444_t> import_target(
    display_t::pointer egl_display,
    std::array<file_t, yuv444_img_t::num_fds> &&fds,
    const surface_descriptor_t &y,
    const surface_descriptor_t &u,
    const surface_descriptor_t &v
  );

  std::optional<nv12_t> create_nv12_target(int width, int height, AVPixelFormat format);

  std::optional<yuv444_t> create_yuv444_target(int width, int height, AVPixelFormat format);

  class cursor_t: public platf::img_t {
  public:
    int x;  
    int y;  
    int src_w;  
    int src_h;  
 
    unsigned long serial;  
 
    std::vector<std::uint8_t> buffer;  
  };
 
  // Allow cursor and the underlying image to be kept together
  class img_descriptor_t: public cursor_t {
  public:
    ~img_descriptor_t() {
      reset();
    }

    void reset() {
      for (auto fd_index = 0; fd_index < 4; ++fd_index) {
        if (sd.fds[fd_index] >= 0) {
          close(sd.fds[fd_index]);
 
          sd.fds[fd_index] = -1;
        }
      }
    }
 
    surface_descriptor_t sd;  
 
    // Increment sequence when new rgb_t needs to be created
    std::uint64_t sequence;  
 
    // Frame is vertically flipped (GL convention)
    bool y_invert {false};  
 
    // PipeWire metadata
    std::optional<uint64_t> pts;  
    std::optional<uint64_t> seq;  
    std::optional<bool> pw_damage;  
    std::optional<uint32_t> pw_flags;  
  };

  class sws_t {
  public:
    static std::optional<sws_t> make_nv12(int in_width, int in_height, int out_width, int out_height, gl::tex_t &&tex);
    static std::optional<sws_t> make_yuv444(int in_width, int in_height, int out_width, int out_height, gl::tex_t &&tex);

    static std::optional<sws_t> make(int in_width, int in_height, int out_width, int out_height, AVPixelFormat format, bool is_yuv444);
 
    // Convert the loaded image into the first two framebuffers
    int convert_nv12(gl::frame_buf_t &fb);
 
    // Convert the loaded image into the first three framebuffers
    int convert_yuv444(gl::frame_buf_t &fb);
 
    // Draw loaded image by programs to frame buffers
    int draw_programs_to_buffers(GLenum attachments[], gl::frame_buf_t &fb, int count, bool is_yuv444);
 
    // Make an area of the image black
    int blank(gl::frame_buf_t &fb, int offsetX_, int offsetY_, int width, int height, bool is_yuv444);

    void load_ram(platf::img_t &img);
    void load_vram(img_descriptor_t &img, int offset_x, int offset_y, int texture, bool is_yuv444);

    void apply_colorspace(const video::sunshine_colorspace_t &colorspace, bool is_yuv444);
 
    // The first texture is the monitor image.
    // The second texture is the cursor image
    gl::tex_t tex;  
 
    // The cursor image will be blended into this framebuffer
    gl::frame_buf_t cursor_framebuffer;  
    gl::frame_buf_t copy_framebuffer;  
 
    // Y - shader, UV - shader, Cursor - shader : for nv12
    // Y - shader, U - shader, V - shader, Cursor - shader : for yuv444
    std::array<gl::program_t, 4> program;  
    gl::buffer_t color_matrix;  
 
    int out_width;  
    int out_height;  
    int in_width;  
    int in_height;  
    int offsetX;  
    int offsetY;  
 
    // Pointer to the texture to be converted to nv12
    int loaded_texture;  
 
    // Store latest cursor for load_vram
    std::uint64_t serial;  
  };

  bool fail();
}  // namespace egl