Source repositorydisplay.h

Go to the documentation of this file.

#pragma once
 
// platform includes
#include <d3d11.h>
#include <d3d11_4.h>
#include <d3dcommon.h>
#include <dwmapi.h>
#include <dxgi.h>
#include <dxgi1_6.h>
#include <Unknwn.h>
#include <winrt/windows.graphics.capture.h>
 
// local includes
#include "src/platform/common.h"
#include "src/utility.h"
#include "src/video.h"
 
namespace platf::dxgi {
  extern const std::array<const char *, 133> format_str;
 
  // Add D3D11_CREATE_DEVICE_DEBUG here to enable the D3D11 debug runtime.
  // You should have a debugger like WinDbg attached to receive debug messages.
  auto constexpr D3D11_CREATE_DEVICE_FLAGS = 0;  

  template<class T>
  void Release(T *dxgi) {
    dxgi->Release();
  }

  using factory1_t = util::safe_ptr<IDXGIFactory1, &Release<IDXGIFactory1>>;
  using dxgi_t = util::safe_ptr<IDXGIDevice, &Release<IDXGIDevice>>;
  using dxgi1_t = util::safe_ptr<IDXGIDevice1, &Release<IDXGIDevice1>>;
  using device_t = util::safe_ptr<ID3D11Device, &Release<ID3D11Device>>;
  using device1_t = util::safe_ptr<ID3D11Device1, &Release<ID3D11Device1>>;
  using device_ctx_t = util::safe_ptr<ID3D11DeviceContext, &Release<ID3D11DeviceContext>>;
  using adapter_t = util::safe_ptr<IDXGIAdapter1, &Release<IDXGIAdapter1>>;
  using output_t = util::safe_ptr<IDXGIOutput, &Release<IDXGIOutput>>;
  using output1_t = util::safe_ptr<IDXGIOutput1, &Release<IDXGIOutput1>>;
  using output5_t = util::safe_ptr<IDXGIOutput5, &Release<IDXGIOutput5>>;
  using output6_t = util::safe_ptr<IDXGIOutput6, &Release<IDXGIOutput6>>;
  using dup_t = util::safe_ptr<IDXGIOutputDuplication, &Release<IDXGIOutputDuplication>>;
  using texture2d_t = util::safe_ptr<ID3D11Texture2D, &Release<ID3D11Texture2D>>;
  using texture1d_t = util::safe_ptr<ID3D11Texture1D, &Release<ID3D11Texture1D>>;
  using resource_t = util::safe_ptr<IDXGIResource, &Release<IDXGIResource>>;
  using resource1_t = util::safe_ptr<IDXGIResource1, &Release<IDXGIResource1>>;
  using multithread_t = util::safe_ptr<ID3D11Multithread, &Release<ID3D11Multithread>>;
  using vs_t = util::safe_ptr<ID3D11VertexShader, &Release<ID3D11VertexShader>>;
  using ps_t = util::safe_ptr<ID3D11PixelShader, &Release<ID3D11PixelShader>>;
  using blend_t = util::safe_ptr<ID3D11BlendState, &Release<ID3D11BlendState>>;
  using input_layout_t = util::safe_ptr<ID3D11InputLayout, &Release<ID3D11InputLayout>>;
  using render_target_t = util::safe_ptr<ID3D11RenderTargetView, &Release<ID3D11RenderTargetView>>;
  using shader_res_t = util::safe_ptr<ID3D11ShaderResourceView, &Release<ID3D11ShaderResourceView>>;
  using buf_t = util::safe_ptr<ID3D11Buffer, &Release<ID3D11Buffer>>;
  using raster_state_t = util::safe_ptr<ID3D11RasterizerState, &Release<ID3D11RasterizerState>>;
  using sampler_state_t = util::safe_ptr<ID3D11SamplerState, &Release<ID3D11SamplerState>>;
  using blob_t = util::safe_ptr<ID3DBlob, &Release<ID3DBlob>>;
  using depth_stencil_state_t = util::safe_ptr<ID3D11DepthStencilState, &Release<ID3D11DepthStencilState>>;
  using depth_stencil_view_t = util::safe_ptr<ID3D11DepthStencilView, &Release<ID3D11DepthStencilView>>;
  using keyed_mutex_t = util::safe_ptr<IDXGIKeyedMutex, &Release<IDXGIKeyedMutex>>;
 
  namespace video {
    using device_t = util::safe_ptr<ID3D11VideoDevice, &Release<ID3D11VideoDevice>>;
    using ctx_t = util::safe_ptr<ID3D11VideoContext, &Release<ID3D11VideoContext>>;
    using processor_t = util::safe_ptr<ID3D11VideoProcessor, &Release<ID3D11VideoProcessor>>;
    using processor_out_t = util::safe_ptr<ID3D11VideoProcessorOutputView, &Release<ID3D11VideoProcessorOutputView>>;
    using processor_in_t = util::safe_ptr<ID3D11VideoProcessorInputView, &Release<ID3D11VideoProcessorInputView>>;
    using processor_enum_t = util::safe_ptr<ID3D11VideoProcessorEnumerator, &Release<ID3D11VideoProcessorEnumerator>>;
  }  // namespace video

  enum class fp16_transfer_e {
    linear,  
    perceptual_quantizer,  
    gamma_encoded,  
  };

  fp16_transfer_e select_fp16_transfer(DXGI_FORMAT format, bool hdr, bool gamma_encoded_sdr);
 
  class hwdevice_t;

  struct cursor_t {
    std::vector<std::uint8_t> img_data;  
 
    DXGI_OUTDUPL_POINTER_SHAPE_INFO shape_info;  
    int x;  
    int y;  
    bool visible;  
  };

  class gpu_cursor_t {
  public:
    gpu_cursor_t() = default;

    void set_pos(LONG new_topleft_x, LONG new_topleft_y, LONG new_display_width, LONG new_display_height, DXGI_MODE_ROTATION new_display_rotation, bool new_visible) {
      this->topleft_x = new_topleft_x;
      this->topleft_y = new_topleft_y;
      this->display_width = new_display_width;
      this->display_height = new_display_height;
      this->display_rotation = new_display_rotation;
      this->visible = new_visible;
      update_viewport();
    }

    void set_texture(LONG new_texture_width, LONG new_texture_height, texture2d_t &&new_texture) {
      this->texture = std::move(new_texture);
      this->texture_width = new_texture_width;
      this->texture_height = new_texture_height;
      update_viewport();
    }

    void update_viewport() {
      switch (display_rotation) {
        case DXGI_MODE_ROTATION_UNSPECIFIED:
        case DXGI_MODE_ROTATION_IDENTITY:
          cursor_view.TopLeftX = topleft_x;
          cursor_view.TopLeftY = topleft_y;
          cursor_view.Width = texture_width;
          cursor_view.Height = texture_height;
          break;
 
        case DXGI_MODE_ROTATION_ROTATE90:
          cursor_view.TopLeftX = topleft_y;
          cursor_view.TopLeftY = display_width - texture_width - topleft_x;
          cursor_view.Width = texture_height;
          cursor_view.Height = texture_width;
          break;
 
        case DXGI_MODE_ROTATION_ROTATE180:
          cursor_view.TopLeftX = display_width - texture_width - topleft_x;
          cursor_view.TopLeftY = display_height - texture_height - topleft_y;
          cursor_view.Width = texture_width;
          cursor_view.Height = texture_height;
          break;
 
        case DXGI_MODE_ROTATION_ROTATE270:
          cursor_view.TopLeftX = display_height - texture_height - topleft_y;
          cursor_view.TopLeftY = topleft_x;
          cursor_view.Width = texture_height;
          cursor_view.Height = texture_width;
          break;
      }
    }
 
    texture2d_t texture;  
    LONG texture_width;  
    LONG texture_height;  
 
    LONG topleft_x;  
    LONG topleft_y;  
 
    LONG display_width;  
    LONG display_height;  
    DXGI_MODE_ROTATION display_rotation;  
 
    shader_res_t input_res;  
 
    D3D11_VIEWPORT cursor_view {0, 0, 0, 0, 0.0f, 1.0f};  
 
    bool visible;  
  };

  class display_base_t: public display_t {
  public:
    int init(const ::video::config_t &config, const std::string &display_name);
 
    capture_e capture(const push_captured_image_cb_t &push_captured_image_cb, const pull_free_image_cb_t &pull_free_image_cb, bool *cursor) override;
 
    factory1_t factory;  
    adapter_t adapter;  
    output_t output;  
    device_t device;  
    device_ctx_t device_ctx;  
    DXGI_RATIONAL display_refresh_rate;  
    int display_refresh_rate_rounded;  
 
    DXGI_MODE_ROTATION display_rotation = DXGI_MODE_ROTATION_UNSPECIFIED;  
    int width_before_rotation;  
    int height_before_rotation;  
 
    int client_frame_rate;  
    DXGI_RATIONAL client_frame_rate_strict;  
 
    DXGI_FORMAT capture_format;  
    D3D_FEATURE_LEVEL feature_level;  
 
    std::unique_ptr<high_precision_timer> timer = create_high_precision_timer();  

    enum _D3DKMT_SCHEDULINGPRIORITYCLASS {
      D3DKMT_SCHEDULINGPRIORITYCLASS_IDLE,  
      D3DKMT_SCHEDULINGPRIORITYCLASS_BELOW_NORMAL,  
      D3DKMT_SCHEDULINGPRIORITYCLASS_NORMAL,  
      D3DKMT_SCHEDULINGPRIORITYCLASS_ABOVE_NORMAL,  
      D3DKMT_SCHEDULINGPRIORITYCLASS_HIGH,  
      D3DKMT_SCHEDULINGPRIORITYCLASS_REALTIME  
    };
 
    using D3DKMT_SCHEDULINGPRIORITYCLASS = _D3DKMT_SCHEDULINGPRIORITYCLASS;  

    using D3DKMT_HANDLE = UINT;

    struct _D3DKMT_OPENADAPTERFROMLUID {
      LUID AdapterLuid;  
      D3DKMT_HANDLE hAdapter;  
    };
 
    using D3DKMT_OPENADAPTERFROMLUID = _D3DKMT_OPENADAPTERFROMLUID;  

    struct _D3DKMT_WDDM_2_7_CAPS {
      union {
        struct
        {
          UINT HwSchSupported : 1;  
          UINT HwSchEnabled : 1;  
          UINT HwSchEnabledByDefault : 1;  
          UINT IndependentVidPnVSyncControl : 1;  
          UINT Reserved : 28;  
        };
 
        UINT Value;  
      };
    };
 
    using D3DKMT_WDDM_2_7_CAPS = _D3DKMT_WDDM_2_7_CAPS;  

    struct _D3DKMT_QUERYADAPTERINFO {
      D3DKMT_HANDLE hAdapter;  
      UINT Type;  
      VOID *pPrivateDriverData;  
      UINT PrivateDriverDataSize;  
    };
 
    using D3DKMT_QUERYADAPTERINFO = _D3DKMT_QUERYADAPTERINFO;  
 
    const UINT KMTQAITYPE_WDDM_2_7_CAPS = 70;  

    struct _D3DKMT_CLOSEADAPTER {
      D3DKMT_HANDLE hAdapter;  
    };
 
    using D3DKMT_CLOSEADAPTER = _D3DKMT_CLOSEADAPTER;  

    using PD3DKMTSetProcessSchedulingPriorityClass = NTSTATUS(WINAPI *)(HANDLE, D3DKMT_SCHEDULINGPRIORITYCLASS);
    using PD3DKMTOpenAdapterFromLuid = NTSTATUS(WINAPI *)(D3DKMT_OPENADAPTERFROMLUID *);
    using PD3DKMTQueryAdapterInfo = NTSTATUS(WINAPI *)(D3DKMT_QUERYADAPTERINFO *);
    using PD3DKMTCloseAdapter = NTSTATUS(WINAPI *)(D3DKMT_CLOSEADAPTER *);

    bool is_hdr() override;
    bool get_hdr_metadata(SS_HDR_METADATA &metadata) override;

    const char *dxgi_format_to_string(DXGI_FORMAT format);
    const char *colorspace_to_string(DXGI_COLOR_SPACE_TYPE type);
    virtual std::vector<DXGI_FORMAT> get_supported_capture_formats() = 0;
 
  protected:
    int get_pixel_pitch() const {
      return (capture_format == DXGI_FORMAT_R16G16B16A16_FLOAT) ? 8 : 4;
    }

    virtual capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr<platf::img_t> &img_out, std::chrono::milliseconds timeout, bool cursor_visible) = 0;
    virtual capture_e release_snapshot() = 0;
    virtual int complete_img(img_t *img, bool dummy) = 0;
  };

  class display_ram_t: public display_base_t {
  public:
    std::shared_ptr<img_t> alloc_img() override;
    int dummy_img(img_t *img) override;
    int complete_img(img_t *img, bool dummy) override;
    std::vector<DXGI_FORMAT> get_supported_capture_formats() override;

    std::unique_ptr<avcodec_encode_device_t> make_avcodec_encode_device(pix_fmt_e pix_fmt) override;
 
    D3D11_MAPPED_SUBRESOURCE img_info;  
    texture2d_t texture;  
  };

  class display_vram_t: public display_base_t, public std::enable_shared_from_this<display_vram_t> {
  public:
    std::shared_ptr<img_t> alloc_img() override;
    int dummy_img(img_t *img_base) override;
    int complete_img(img_t *img_base, bool dummy) override;
    std::vector<DXGI_FORMAT> get_supported_capture_formats() override;
 
    bool is_codec_supported(std::string_view name, const ::video::config_t &config) override;

    std::unique_ptr<avcodec_encode_device_t> make_avcodec_encode_device(pix_fmt_e pix_fmt) override;

    std::unique_ptr<nvenc_encode_device_t> make_nvenc_encode_device(pix_fmt_e pix_fmt) override;
 
    std::atomic<uint32_t> next_image_id;  
  };

  class duplication_t {
  public:
    dup_t dup;  
    bool has_frame {};  
    std::chrono::steady_clock::time_point last_protected_content_warning_time {};  

    int init(display_base_t *display, const ::video::config_t &config);
    capture_e next_frame(DXGI_OUTDUPL_FRAME_INFO &frame_info, std::chrono::milliseconds timeout, resource_t::pointer *res_p);
    capture_e reset(dup_t::pointer dup_p = dup_t::pointer());
    capture_e release_frame();
 
    ~duplication_t();
  };

  class display_ddup_ram_t: public display_ram_t {
  public:
    int init(const ::video::config_t &config, const std::string &display_name);
    capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr<platf::img_t> &img_out, std::chrono::milliseconds timeout, bool cursor_visible) override;
    capture_e release_snapshot() override;
 
    duplication_t dup;  
    cursor_t cursor;  
  };

  class display_ddup_vram_t: public display_vram_t {
  public:
    int init(const ::video::config_t &config, const std::string &display_name);
    capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr<platf::img_t> &img_out, std::chrono::milliseconds timeout, bool cursor_visible) override;
    capture_e release_snapshot() override;
 
    duplication_t dup;  
    sampler_state_t sampler_linear;  
 
    blend_t blend_alpha;  
    blend_t blend_invert;  
    blend_t blend_disable;  
 
    ps_t cursor_ps;  
    vs_t cursor_vs;  
 
    gpu_cursor_t cursor_alpha;  
    gpu_cursor_t cursor_xor;  
 
    texture2d_t old_surface_delayed_destruction;  
    std::chrono::steady_clock::time_point old_surface_timestamp;  
    std::variant<std::monostate, texture2d_t, std::shared_ptr<platf::img_t>> last_frame_variant;  
  };

  class wgc_capture_t {
    winrt::Windows::Graphics::DirectX::Direct3D11::IDirect3DDevice uwp_device {nullptr};
    winrt::Windows::Graphics::Capture::GraphicsCaptureItem item {nullptr};
    winrt::Windows::Graphics::Capture::Direct3D11CaptureFramePool frame_pool {nullptr};
    winrt::Windows::Graphics::Capture::GraphicsCaptureSession capture_session {nullptr};
    winrt::Windows::Graphics::Capture::Direct3D11CaptureFrame produced_frame {nullptr};
    winrt::Windows::Graphics::Capture::Direct3D11CaptureFrame consumed_frame {nullptr};
    SRWLOCK frame_lock = SRWLOCK_INIT;
    CONDITION_VARIABLE frame_present_cv;
 
    void on_frame_arrived(winrt::Windows::Graphics::Capture::Direct3D11CaptureFramePool const &sender, winrt::Windows::Foundation::IInspectable const &);
 
  public:
    wgc_capture_t();
    ~wgc_capture_t();

    int init(display_base_t *display, const ::video::config_t &config);
    capture_e next_frame(std::chrono::milliseconds timeout, ID3D11Texture2D **out, uint64_t &out_time);
    capture_e release_frame();
    int set_cursor_visible(bool cursor_visible);
  };

  class display_wgc_ram_t: public display_ram_t {
    wgc_capture_t dup;
 
  public:
    int init(const ::video::config_t &config, const std::string &display_name);
    capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr<platf::img_t> &img_out, std::chrono::milliseconds timeout, bool cursor_visible) override;
    capture_e release_snapshot() override;
  };

  class display_wgc_vram_t: public display_vram_t {
    wgc_capture_t dup;
 
  public:
    int init(const ::video::config_t &config, const std::string &display_name);
    capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr<platf::img_t> &img_out, std::chrono::milliseconds timeout, bool cursor_visible) override;
    capture_e release_snapshot() override;
  };
}  // namespace platf::dxgi