Feature/xcb grabber (#912)

* Add Xcb grabber * update compile instruction Signed-off-by: Paulchen Panther <Paulchen-Panter@protonmail.com> * Fix problem on resolution change + Make XCB default if X11 is not avaialable * Fix decimation problem Co-authored-by: Paulchen Panther <16664240+Paulchen-Panther@users.noreply.github.com> Co-authored-by: Paulchen Panther <Paulchen-Panter@protonmail.com>
2025-03-01 10:33:28 +00:00 · 2020-08-03 12:31:39 +02:00
parent 11d7614591
commit 13205a9d11
38 changed files with 1545 additions and 20 deletions
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -14,6 +14,10 @@ if(ENABLE_X11)
 	add_subdirectory(hyperion-x11)
 endif()

+if(ENABLE_XCB)
+	add_subdirectory(hyperion-xcb)
+endif()
+
 if(ENABLE_DISPMANX)
 	add_subdirectory(hyperion-dispmanx)
 endif()
--- a/src/hyperion-xcb/CMakeLists.txt
+++ b/src/hyperion-xcb/CMakeLists.txt
@@ -0,0 +1,38 @@
+cmake_minimum_required(VERSION 3.0.0)
+project(hyperion-xcb)
+
+include_directories(
+	${CMAKE_CURRENT_BINARY_DIR}/../../libsrc/flatbufserver
+	${FLATBUFFERS_INCLUDE_DIRS}
+)
+
+set(Hyperion_XCB_HEADERS
+	XcbWrapper.h
+)
+
+set(Hyperion_XCB_SOURCES
+	hyperion-xcb.cpp
+	XcbWrapper.cpp
+)
+
+add_executable(${PROJECT_NAME}
+	${Hyperion_XCB_HEADERS}
+	${Hyperion_XCB_SOURCES}
+)
+
+target_link_libraries(${PROJECT_NAME}
+	commandline
+	hyperion-utils
+	flatbufserver
+	flatbuffers
+	xcb-grabber
+	ssdp
+)
+
+install (TARGETS ${PROJECT_NAME} DESTINATION "share/hyperion/bin" COMPONENT "hyperion_xcb")
+
+if(CMAKE_HOST_UNIX)
+	install(CODE "EXECUTE_PROCESS(COMMAND ln -sf \"../share/hyperion/bin/${PROJECT_NAME}\" \"${CMAKE_BINARY_DIR}/symlink_${PROJECT_NAME}\" )" COMPONENT "hyperion_xcb" )
+	install(FILES "${CMAKE_BINARY_DIR}/symlink_${PROJECT_NAME}" DESTINATION "bin" RENAME "${PROJECT_NAME}" COMPONENT "hyperion_xcb" )
+	install(CODE "FILE (REMOVE ${CMAKE_BINARY_DIR}/symlink_${PROJECT_NAME} )" COMPONENT "hyperion_xcb" )
+endif(CMAKE_HOST_UNIX)
--- a/src/hyperion-xcb/XcbWrapper.cpp
+++ b/src/hyperion-xcb/XcbWrapper.cpp
@@ -0,0 +1,47 @@
+
+// Hyperion-Xcb includes
+#include "XcbWrapper.h"
+
+XcbWrapper::XcbWrapper(int grabInterval, int cropLeft, int cropRight, int cropTop, int cropBottom, int pixelDecimation) :
+	_timer(this),
+	_grabber(cropLeft, cropRight, cropTop, cropBottom, pixelDecimation)
+{
+	_timer.setSingleShot(false);
+	_timer.setInterval(grabInterval);
+
+	// Connect capturing to the timeout signal of the timer
+	connect(&_timer, SIGNAL(timeout()), this, SLOT(capture()));
+}
+
+const Image<ColorRgb> & XcbWrapper::getScreenshot()
+{
+	_grabber.grabFrame(_screenshot, true);
+	return _screenshot;
+}
+
+void XcbWrapper::start()
+{
+	_timer.start();
+}
+
+void XcbWrapper::stop()
+{
+	_timer.stop();
+}
+
+bool XcbWrapper::displayInit()
+{
+	return _grabber.Setup();
+}
+
+void XcbWrapper::capture()
+{
+	_grabber.grabFrame(_screenshot, !_inited);
+	emit sig_screenshot(_screenshot);
+	_inited = true;
+}
+
+void XcbWrapper::setVideoMode(const VideoMode mode)
+{
+	_grabber.setVideoMode(mode);
+}
--- a/src/hyperion-xcb/XcbWrapper.h
+++ b/src/hyperion-xcb/XcbWrapper.h
@@ -0,0 +1,57 @@
+#pragma once
+
+// QT includes
+#include <QTimer>
+
+// Hyperion-Xcb includes
+#include <grabber/XcbGrabber.h>
+
+//Utils includes
+#include <utils/VideoMode.h>
+
+class XcbWrapper : public QObject
+{
+	Q_OBJECT
+public:
+	XcbWrapper(int grabInterval, int cropLeft, int cropRight, int cropTop, int cropBottom, int pixelDecimation);
+
+	const Image<ColorRgb> & getScreenshot();
+
+	///
+	/// Starts the timed capturing of screenshots
+	///
+	void start();
+
+	void stop();
+
+	bool displayInit();
+
+signals:
+	void sig_screenshot(const Image<ColorRgb> & screenshot);
+
+public slots:
+	///
+	/// Set the video mode (2D/3D)
+	/// @param[in] mode The new video mode
+	///
+	void setVideoMode(const VideoMode videoMode);
+
+private slots:
+	///
+	/// Performs a single screenshot capture and publishes the capture screenshot on the screenshot
+	/// signal.
+	///
+	void capture();
+
+private:
+	/// The QT timer to generate capture-publish events
+	QTimer _timer;
+
+	/// The grabber for creating screenshots
+	XcbGrabber _grabber;
+
+	Image<ColorRgb>  _screenshot;
+
+	// prevent cont dimension updates
+	bool _inited = false;
+};
--- a/src/hyperion-xcb/hyperion-xcb.cpp
+++ b/src/hyperion-xcb/hyperion-xcb.cpp
@@ -0,0 +1,115 @@
+
+// QT includes
+#include <QApplication>
+#include <QImage>
+
+#include <commandline/Parser.h>
+#include <flatbufserver/FlatBufferConnection.h>
+#include <utils/DefaultSignalHandler.h>
+#include "XcbWrapper.h"
+#include "HyperionConfig.h"
+
+// ssdp discover
+#include <ssdp/SSDPDiscover.h>
+
+using namespace commandline;
+
+// save the image as screenshot
+void saveScreenshot(QString filename, const Image<ColorRgb> & image)
+{
+	// store as PNG
+	QImage pngImage((const uint8_t *) image.memptr(), image.width(), image.height(), 3*image.width(), QImage::Format_RGB888);
+	pngImage.save(filename);
+}
+
+int main(int argc, char ** argv)
+{
+	 std::cout
+		<< "hyperion-xcb:" << std::endl
+		<< "\tVersion   : " << HYPERION_VERSION << " (" << HYPERION_BUILD_ID << ")" << std::endl
+		<< "\tbuild time: " << __DATE__ << " " << __TIME__ << std::endl;
+
+	DefaultSignalHandler::install();
+
+	QApplication app(argc, argv);
+	try
+	{
+		// create the option parser and initialize all parameters
+		Parser parser("XCB capture application for Hyperion. Will automatically search a Hyperion server if -a option isn't used. Please note that if you have more than one server running it's more or less random which one will be used.");
+
+		IntOption           & argFps             = parser.add<IntOption>    ('f', "framerate", "Capture frame rate [default: %1]", "10");
+		IntOption           & argCropWidth       = parser.add<IntOption>    (0x0, "crop-width", "Number of pixels to crop from the left and right sides of the picture before decimation [default: %1]", "0");
+		IntOption           & argCropHeight      = parser.add<IntOption>    (0x0, "crop-height", "Number of pixels to crop from the top and the bottom of the picture before decimation [default: %1]", "0");
+		IntOption           & argCropLeft        = parser.add<IntOption>    (0x0, "crop-left", "Number of pixels to crop from the left of the picture before decimation (overrides --crop-width)");
+		IntOption           & argCropRight       = parser.add<IntOption>    (0x0, "crop-right", "Number of pixels to crop from the right of the picture before decimation (overrides --crop-width)");
+		IntOption           & argCropTop         = parser.add<IntOption>    (0x0, "crop-top", "Number of pixels to crop from the top of the picture before decimation (overrides --crop-height)");
+		IntOption           & argCropBottom      = parser.add<IntOption>    (0x0, "crop-bottom", "Number of pixels to crop from the bottom of the picture before decimation (overrides --crop-height)");
+		IntOption           & argSizeDecimation  = parser.add<IntOption>    ('s', "size-decimator", "Decimation factor for the output size [default=%1]", "8", 1);
+		BooleanOption       & argScreenshot      = parser.add<BooleanOption>(0x0, "screenshot", "Take a single screenshot, save it to file and quit");
+		Option              & argAddress         = parser.add<Option>       ('a', "address", "Set the address of the hyperion server [default: %1]", "127.0.0.1:19400");
+		IntOption           & argPriority        = parser.add<IntOption>    ('p', "priority", "Use the provided priority channel (suggested 100-199) [default: %1]", "150");
+		BooleanOption       & argSkipReply       = parser.add<BooleanOption>(0x0, "skip-reply", "Do not receive and check reply messages from Hyperion");
+		BooleanOption       & argHelp            = parser.add<BooleanOption>('h', "help", "Show this help message and exit");
+
+		// parse all options
+		parser.process(app);
+
+		// check if we need to display the usage. exit if we do.
+		if (parser.isSet(argHelp))
+		{
+			parser.showHelp(0);
+		}
+
+		// Create the XCB grabbing stuff
+		XcbWrapper xcbWrapper(
+					1000 / argFps.getInt(parser),
+					parser.isSet(argCropLeft) ? argCropLeft.getInt(parser) : argCropWidth.getInt(parser),
+					parser.isSet(argCropRight) ? argCropRight.getInt(parser) : argCropWidth.getInt(parser),
+					parser.isSet(argCropTop) ? argCropTop.getInt(parser) : argCropHeight.getInt(parser),
+					parser.isSet(argCropBottom) ? argCropBottom.getInt(parser) : argCropHeight.getInt(parser),
+					argSizeDecimation.getInt(parser)); // decimation
+
+		if (!xcbWrapper.displayInit())
+			return -1;
+
+		if (parser.isSet(argScreenshot))
+		{
+			// Capture a single screenshot and finish
+			const Image<ColorRgb> & screenshot = xcbWrapper.getScreenshot();
+			saveScreenshot("screenshot.png", screenshot);
+		}
+		else
+		{
+			// server searching by ssdp
+			QString address = argAddress.value(parser);
+			if(argAddress.value(parser) == "127.0.0.1:19400")
+			{
+				SSDPDiscover discover;
+				address = discover.getFirstService(searchType::STY_FLATBUFSERVER);
+				if(address.isEmpty())
+				{
+					address = argAddress.value(parser);
+				}
+			}
+			// Create the Flatbuf-connection
+			FlatBufferConnection flatbuf("XCB Standalone", address, argPriority.getInt(parser), parser.isSet(argSkipReply));
+
+			// Connect the screen capturing to flatbuf connection processing
+			QObject::connect(&xcbWrapper, SIGNAL(sig_screenshot(const Image<ColorRgb> &)), &flatbuf, SLOT(setImage(Image<ColorRgb>)));
+
+			// Start the capturing
+			xcbWrapper.start();
+
+			// Start the application
+			app.exec();
+		}
+	}
+	catch (const std::runtime_error & e)
+	{
+		// An error occured. Display error and quit
+		Error(Logger::getInstance("XCBGRABBER"), "%s", e.what());
+		return -1;
+	}
+
+	return 0;
+}
--- a/src/hyperiond/CMakeLists.txt
+++ b/src/hyperiond/CMakeLists.txt
@@ -95,6 +95,10 @@ if (ENABLE_X11)
 	target_link_libraries(hyperiond	x11-grabber)
 endif ()

+if (ENABLE_XCB)
+	target_link_libraries(hyperiond	xcb-grabber)
+endif ()
+
 if (ENABLE_QT)
 	target_link_libraries(hyperiond	qt-grabber)
 endif ()
--- a/src/hyperiond/hyperiond.cpp
+++ b/src/hyperiond/hyperiond.cpp
@@ -75,6 +75,7 @@ HyperionDaemon::HyperionDaemon(const QString rootPath, QObject *parent, const bo
 		, _v4l2Grabber(nullptr)
 		, _dispmanx(nullptr)
 		, _x11Grabber(nullptr)
+		, _xcbGrabber(nullptr)
 		, _amlGrabber(nullptr)
 		, _fbGrabber(nullptr)
 		, _osxGrabber(nullptr)
@@ -133,7 +134,7 @@ HyperionDaemon::HyperionDaemon(const QString rootPath, QObject *parent, const bo
 	connect(this, &HyperionDaemon::videoMode, _instanceManager, &HyperionIManager::newVideoMode);

 // ---- grabber -----
-#if !defined(ENABLE_DISPMANX) && !defined(ENABLE_OSX) && !defined(ENABLE_FB) && !defined(ENABLE_X11) && !defined(ENABLE_AMLOGIC) && !defined(ENABLE_QT)
+#if !defined(ENABLE_DISPMANX) && !defined(ENABLE_OSX) && !defined(ENABLE_FB) && !defined(ENABLE_X11) && !defined(ENABLE_XCB) && !defined(ENABLE_AMLOGIC) && !defined(ENABLE_QT)
 	Warning(_log, "No platform capture can be instantiated, because all grabbers have been left out from the build");
 #endif

@@ -374,7 +375,13 @@ void HyperionDaemon::handleSettingsUpdate(const settings::type &settingsType, co
 				QByteArray envDisplay = qgetenv("DISPLAY");
 				if ( !envDisplay.isEmpty() )
 				{
+				#if defined(ENABLE_X11)
 					type = "x11";
+				#elif defined(ENABLE_XCB)
+					type = "xcb";
+				#else
+					type = "qt";
+				#endif
 				}
 				// qt -> if nothing other applies
 				else
@@ -429,6 +436,14 @@ void HyperionDaemon::handleSettingsUpdate(const settings::type &settingsType, co
 				 _x11Grabber = nullptr;
 			}
 			#endif
+			#ifdef ENABLE_XCB
+			if(_xcbGrabber != nullptr)
+			{
+				 _xcbGrabber->stop();
+				 delete _xcbGrabber;
+				 _xcbGrabber = nullptr;
+			}
+			#endif
 			#ifdef ENABLE_QT
 			if(_qtGrabber != nullptr)
 			{
@@ -479,6 +494,14 @@ void HyperionDaemon::handleSettingsUpdate(const settings::type &settingsType, co
 				_x11Grabber->tryStart();
 				#endif
 			}
+			else if (type == "xcb")
+			{
+				if (_xcbGrabber == nullptr)
+					createGrabberXcb(grabberConfig);
+				#ifdef ENABLE_XCB
+				_xcbGrabber->tryStart();
+				#endif
+			}
 			else if (type == "qt")
 			{
 				if (_qtGrabber == nullptr)
@@ -603,6 +626,25 @@ void HyperionDaemon::createGrabberX11(const QJsonObject &grabberConfig)
 #endif
 }

+void HyperionDaemon::createGrabberXcb(const QJsonObject &grabberConfig)
+{
+#ifdef ENABLE_XCB
+	_xcbGrabber = new XcbWrapper(
+			_grabber_cropLeft, _grabber_cropRight, _grabber_cropTop, _grabber_cropBottom,
+			grabberConfig["pixelDecimation"].toInt(8),
+			_grabber_frequency);
+	_xcbGrabber->setCropping(_grabber_cropLeft, _grabber_cropRight, _grabber_cropTop, _grabber_cropBottom);
+
+	// connect to HyperionDaemon signal
+	connect(this, &HyperionDaemon::videoMode, _xcbGrabber, &XcbWrapper::setVideoMode);
+	connect(this, &HyperionDaemon::settingsChanged, _xcbGrabber, &XcbWrapper::handleSettingsUpdate);
+
+	Info(_log, "XCB grabber created");
+#else
+	Error(_log, "The XCB grabber can not be instantiated, because it has been left out from the build");
+#endif
+}
+
 void HyperionDaemon::createGrabberQt(const QJsonObject &grabberConfig)
 {
 #ifdef ENABLE_QT
--- a/src/hyperiond/hyperiond.h
+++ b/src/hyperiond/hyperiond.h
@@ -40,6 +40,12 @@
 	typedef QObject X11Wrapper;
 #endif

+#ifdef ENABLE_XCB
+	#include <grabber/XcbWrapper.h>
+#else
+	typedef QObject XcbWrapper;
+#endif
+
 #ifdef ENABLE_QT
 	#include <grabber/QtWrapper.h>
 #else
@@ -144,6 +150,7 @@ private:
 	void createGrabberFramebuffer(const QJsonObject & grabberConfig);
 	void createGrabberOsx(const QJsonObject & grabberConfig);
 	void createGrabberX11(const QJsonObject & grabberConfig);
+	void createGrabberXcb(const QJsonObject & grabberConfig);
 	void createGrabberQt(const QJsonObject & grabberConfig);
 	void createCecHandler();

@@ -159,6 +166,7 @@ private:
 	V4L2Wrapper*               _v4l2Grabber;
 	DispmanxWrapper*           _dispmanx;
 	X11Wrapper*                _x11Grabber;
+	XcbWrapper*                _xcbGrabber;
 	AmlogicWrapper*            _amlGrabber;
 	FramebufferWrapper*        _fbGrabber;
 	OsxWrapper*                _osxGrabber;
--- a/src/hyperiond/main.cpp
+++ b/src/hyperiond/main.cpp
@@ -105,13 +105,21 @@ QCoreApplication* createApplication(int &argc, char *argv[])
 	if (!forceNoGui)
 	{
 		// if x11, then test if xserver is available
-		#ifdef ENABLE_X11
+		#if defined(ENABLE_X11)
 		Display* dpy = XOpenDisplay(NULL);
 		if (dpy != NULL)
 		{
 			XCloseDisplay(dpy);
 			isGuiApp = true;
 		}
+		#elif defined(ENABLE_XCB)
+			int screen_num;
+			xcb_connection_t * connection = xcb_connect(nullptr, &screen_num);
+			if (!xcb_connection_has_error(connection))
+			{
+				isGuiApp = true;
+			}
+			xcb_disconnect(connection);
 		#endif
 	}
 #endif