Windows: Add a DDA grabber for much better performance (#1745)

* Add a DXDI DDA grabber

* Change all names to camel case

* Handle cropping and pixel decimation

* Try more persistently to restart capture after an error occurred.

These can happen when changing resolution, or resuming from sleep.

Author: davidsansome

CHANGELOG.md

@@ -14,12 +14,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Support gaps on Matrix Layout (#1696)
+- Windows: Added a new grabber that uses the DXGI DDA (Desktop Duplication API). This has much better performance than the DX grabber as it does more of its work on the GPU.
 
 **JSON-API**
 - New subscription support for event updates, i.e. `Suspend, Resume, Idle, idleResume, Restart, Quit`.
 - Support direct or multiple instance addressing via single requests (#809)
 - Support of `serverinfo` subcommands: `getInfo, subscribe, unsubscribe, getSubscriptions, getSubscriptionCommands`
-- [Overview](https://github.com/hyperion-project/hyperion.ng/blob/API_Auth/doc/development/JSON-API%20_Commands_Overview.md) of API commands and subscription updates 
+- [Overview](https://github.com/hyperion-project/hyperion.ng/blob/API_Auth/doc/development/JSON-API%20_Commands_Overview.md) of API commands and subscription updates
 
 ### Changed
 
@@ -35,7 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Refactored JSON-API to ensure consistent authorization behaviour across sessions and single requests with token authorization.
 - Provide additional error details with API responses, esp. on JSON parsing, validation or token errors.
 - Generate random TANs for every API request from the Hyperion UI
-- Fixed: Handling of IP4 addresses wrapped in IPv6 for external network connections- 
+- Fixed: Handling of IP4 addresses wrapped in IPv6 for external network connections-
 
 ### Removed
 
@@ -135,7 +136,7 @@ Note: The wizard will configure an APIv2 capable bridge always with Entertainmen
 - Support streaming to individual WLED segments (requires WLED 0.13.3+).
 To allow segment streaming, enable "Realtime - Use main segment only" in WLED's Sync Interfaces setup screen
 - Allow to keep WLED powered on after streaming and restoring state
-- Allow to Disable / Enable all instances (#970) by 
+- Allow to Disable / Enable all instances (#970) by
 	- Suspend/Resume support for Linux and Windows (#1493,#1282, #978).
 	Suspend/Resume/Restart is supported via API, UI, Systray and hyperion-remote
 	- Idle scenario via Screen Locking (Linux/Windows), Screensaver invokation (Linux), hyperion-remote or API

CMakeLists.txt

@@ -68,6 +68,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 set(DEFAULT_AMLOGIC                     OFF)
 set(DEFAULT_DISPMANX                    OFF)
 set(DEFAULT_DX                          OFF)
+set(DEFAULT_DDA                         OFF)
 set(DEFAULT_MF                          OFF)
 set(DEFAULT_OSX                         OFF)
 set(DEFAULT_QT                          ON )
@@ -121,6 +122,7 @@ if(${CMAKE_SYSTEM} MATCHES "Linux")
 	set(DEFAULT_CEC             ON)
 elseif (WIN32)
 	set(DEFAULT_DX ON)
+	set(DEFAULT_DDA ON)
 	set(DEFAULT_MF ON)
 else()
 	set(DEFAULT_FB              OFF)
@@ -227,6 +229,7 @@ if(HYPERION_LIGHT)
 	SET ( DEFAULT_AMLOGIC                     OFF )
 	SET ( DEFAULT_DISPMANX                    OFF )
 	SET ( DEFAULT_DX                          OFF )
+	SET ( DEFAULT_DDA                         OFF )
 	SET ( DEFAULT_FB                          OFF )
 	SET ( DEFAULT_MF                          OFF )
 	SET ( DEFAULT_OSX                         OFF )
@@ -264,6 +267,9 @@ message(STATUS "ENABLE_DISPMANX = ${ENABLE_DISPMANX}")
 option(ENABLE_DX "Enable the DirectX grabber" ${DEFAULT_DX})
 message(STATUS "ENABLE_DX = ${ENABLE_DX}")
 
+option(ENABLE_DDA "Enable the DXGI DDA grabber" ${DEFAULT_DDA})
+message(STATUS "ENABLE_DDA = ${ENABLE_DDA}")
+
 if(ENABLE_AMLOGIC)
 	set(ENABLE_FB ON)
 else()

HyperionConfig.h.in

@@ -9,6 +9,9 @@
 // Define to enable the DirectX grabber
 #cmakedefine ENABLE_DX
 
+// Define to enable the DXGI DDA (Desktop Duplication API) grabber
+#cmakedefine ENABLE_DDA
+
 // Define to enable the framebuffer grabber
 // Define to enable the Audio grabber
 #cmakedefine ENABLE_AUDIO

doc/development/CompileHowto.md

@@ -128,7 +128,7 @@ We assume a 64bit Windows 10. Install the following;
 - [CMake (Windows win64-x64 installer)](https://cmake.org/download/) (Check: Add to PATH)
 - [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/downloads/#visual-studio-community-2022)
   - Select 'Desktop development with C++'
-  - On the right, just select `MSVC v143 VS 2022 C++ x64/x86-Buildtools` and latest `Windows 10 SDK`. Everything else is not needed.
+  - On the right, just select `MSVC v143 VS 2022 C++ x64/x86-Buildtools`, `C++ ATL for latest v143 build tools (x86 & x64)` and latest `Windows 10 SDK`. Everything else is not needed.
 - [Win64 OpenSSL v1.1.1w](https://slproweb.com/products/Win32OpenSSL.html) ([direct link](https://slproweb.com/download/Win64OpenSSL-1_1_1w.exe))
 - [Python 3 (Windows x86-64 executable installer)](https://www.python.org/downloads/windows/) (Check: Add to PATH and Debug Symbols)
   - Open a console window and execute `pip install aqtinstall`.

include/grabber/GrabberConfig.h

@@ -27,6 +27,10 @@
 #include <grabber/directx/directXGrabber.h>
 #endif
 
+#ifdef ENABLE_DDA
+#include <grabber/dda/DDAGrabber.h>
+#endif
+
 #if defined(ENABLE_X11)
 #include <grabber/x11/X11Grabber.h>
 #endif
@@ -35,10 +39,6 @@
 #include <grabber/xcb/XcbGrabber.h>
 #endif
 
-#if defined(ENABLE_DX)
-#include <grabber/directx/DirectXGrabber.h>
-#endif
-
 #if defined(ENABLE_FB)
 #include <grabber/framebuffer/FramebufferFrameGrabber.h>
 #endif

include/grabber/dda/DDAGrabber.h

@@ -0,0 +1,75 @@
+#pragma once
+
+#include <QObject>
+#include <QJsonObject>
+
+#include <hyperion/Grabber.h>
+#include <utils/ColorRgb.h>
+
+class DDAGrabberImpl;
+
+class DDAGrabber : public Grabber
+{
+public:
+	DDAGrabber(int display = 0, int cropLeft = 0, int cropRight = 0, int cropTop = 0, int cropBottom = 0);
+
+	virtual ~DDAGrabber();
+
+	///
+	/// Captures a single snapshot of the display and writes the data to the given image. The
+	/// provided image should have the same dimensions as the configured values (_width and _height)
+	///
+	/// @param[out] image  The snapped screenshot
+	///
+	int grabFrame(Image<ColorRgb> &image);
+
+	///
+	/// @brief Set a new video mode
+	///
+	void setVideoMode(VideoMode mode) override;
+
+	///
+	/// @brief Apply new width/height values, overwrite Grabber.h implementation
+	///
+	bool setWidthHeight(int /* width */, int /*height*/) override
+	{
+		return true;
+	}
+
+	///
+	/// @brief Apply new pixelDecimation
+	///
+	bool setPixelDecimation(int pixelDecimation) override;
+
+	///
+	/// Set the crop values
+	/// @param  cropLeft    Left pixel crop
+	/// @param  cropRight   Right pixel crop
+	/// @param  cropTop     Top pixel crop
+	/// @param  cropBottom  Bottom pixel crop
+	///
+	void setCropping(int cropLeft, int cropRight, int cropTop, int cropBottom);
+
+	///
+	/// @brief Apply display index
+	///
+	bool setDisplayIndex(int index) override;
+
+	/// @brief Discover QT screens available (for configuration).
+	///
+	/// @param[in] params Parameters used to overwrite discovery default behaviour
+	///
+	/// @return A JSON structure holding a list of devices found
+	///
+	QJsonObject discover(const QJsonObject &params);
+
+private:
+	///
+	/// @brief Setup a new capture display, will free the previous one
+	/// @return True on success, false if no display is found
+	///
+	bool restartCapture();
+
+private:
+	std::unique_ptr<DDAGrabberImpl> d;
+};

include/grabber/dda/DDAWrapper.h

@@ -0,0 +1,24 @@
+#pragma once
+
+#include <grabber/dda/DDAGrabber.h>
+#include <hyperion/GrabberWrapper.h>
+
+class DDAWrapper : public GrabberWrapper
+{
+public:
+	static constexpr const char *GRABBERTYPE = "DDA";
+
+	DDAWrapper(int updateRate_Hz = GrabberWrapper::DEFAULT_RATE_HZ, int display = 0,
+	           int pixelDecimation = GrabberWrapper::DEFAULT_PIXELDECIMATION, int cropLeft = 0, int cropRight = 0,
+	           int cropTop = 0, int cropBottom = 0);
+
+	DDAWrapper(const QJsonDocument &grabberConfig = QJsonDocument());
+
+	virtual ~DDAWrapper(){};
+
+public slots:
+	virtual void action();
+
+private:
+	DDAGrabber _grabber;
+};

libsrc/api/JsonInfo.cpp

@@ -592,6 +592,10 @@ QJsonArray JsonInfo::discoverScreenInputs(const QJsonObject& params) const
 	discoverGrabber<DirectXGrabber>(screenInputs, params);
 #endif
 
+#ifdef ENABLE_DDA
+	discoverGrabber<DDAGrabber>(screenInputs, params);
+#endif
+
 #ifdef ENABLE_X11
 	discoverGrabber<X11Grabber>(screenInputs, params);
 #endif

libsrc/grabber/CMakeLists.txt

@@ -34,6 +34,10 @@ if(ENABLE_DX)
 	add_subdirectory(directx)
 endif(ENABLE_DX)
 
+if(ENABLE_DDA)
+	add_subdirectory(dda)
+endif(ENABLE_DDA)
+
 if(ENABLE_AUDIO)
 	add_subdirectory(audio)
 endif()

libsrc/grabber/dda/CMakeLists.txt

@@ -0,0 +1,12 @@
+add_library(dda-grabber
+	${CMAKE_SOURCE_DIR}/include/grabber/dda/DDAGrabber.h
+	${CMAKE_SOURCE_DIR}/include/grabber/dda/DDAWrapper.h
+	${CMAKE_SOURCE_DIR}/libsrc/grabber/dda/DDAGrabber.cpp
+	${CMAKE_SOURCE_DIR}/libsrc/grabber/dda/DDAWrapper.cpp
+)
+
+target_link_libraries(dda-grabber
+	hyperion
+	d3d11.lib
+	dxgi.lib
+)