API Clean-up (2) & Fixes

CHANGELOG.md

@@ -64,6 +64,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed: Python 3.12 crashes (#1747)
 - osX Grabber: Use ScreenCaptureKit under macOS 15 and above
 - Removed maximum LED number constraint from Matrix layout schema which was not synced with the UI behaviour (#1804)
+- UI: Instance listings are sorted, enabled instances are high-lighted in drop-downs 
 - Fixed bespoke WebSocket implementation by using of QWebSockets (#1816, #1448, #1247, #1130)
 - Fixed mDNS Browser deadlock, plus run in own thread now
 - Fixed that LED Buffer and Layout might get out of sync.
@@ -72,7 +73,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed Last update of an effect event is not removed in sources overview
 - Fixed Removed stale _logger object
 - Fixed Smoothing (#1863)
-- UI: Instance listings are sorted, enabled instances are high-lighted in drop-downs 
+- Fixed Crash when XCB,X11 was configured and display manager changed to Wayland
+- Fixed Target-directory not correctly build when exporting effects
+- Fixed Effect not suspended when instance is stopped (#1586)
+- Fixed Background effect is started when instance is disabled 
 
 **JSON-API**
 - Refactored JSON-API to ensure consistent authorization behaviour across sessions and single requests with token authorization.

assets/webconfig/js/content_dashboard.js

@@ -182,7 +182,6 @@ $(document).ready(function () {
           $("#general_comp_" + componentName).bootstrapToggle(isInstanceEnabled ? "enable" : "disable");
 
           $("#general_comp_" + componentName).change(function () {
-            const componentName = componentName;
             const isChecked = $(this).prop('checked');
             requestSetComponentState(componentName, isChecked);
           });

doc/development/JSON-API _Commands_Overview.md

@@ -66,10 +66,10 @@ _http/s Support_
 | instance       | switchTo                | Yes           | No           | No                | Yes            |
 | instance-data  | getImageSnapshot        | Yes           | Single       | Yes               | Yes            |
 | instance-data  | getLedSnapshot          | Yes           | Single       | Yes               | Yes            |
-| ledcolors      | imagestream-start       | Yes           | Single       | Yes               | Yes            |
-| ledcolors      | imagestream-stop        | Yes           | Single       | Yes               | Yes            |
-| ledcolors      | ledstream-start         | Yes           | Single       | Yes               | Yes            |
-| ledcolors      | ledstream-stop          | Yes           | Single       | Yes               | Yes            |
+| ledcolors      | imagestream-start       | Yes           | Single       | Yes               | No             |
+| ledcolors      | imagestream-stop        | Yes           | Single       | Yes               | No             |
+| ledcolors      | ledstream-start         | Yes           | Single       | Yes               | No             |
+| ledcolors      | ledstream-stop          | Yes           | Single       | Yes               | No             |
 | leddevice      | addAuthorization        | Yes           | Single       | Yes               | Yes            |
 | leddevice      | discover                | Yes           | No           | No                | Yes            |
 | leddevice      | getProperties           | Yes           | No           | No                | Yes            |

include/api/JsonApiCommand.h

@@ -330,10 +330,10 @@ class ApiCommandRegister {
 			{ {"instance", "switchTo"},                  { Command::Instance,       SubCommand::SwitchTo,                Authorization::Yes,    InstanceCmd::No,           InstanceCmd::MustRun_No,     NoListenerCmd::Yes } },
 			{ {"instance-data", "getImageSnapshot"},     { Command::InstanceData,   SubCommand::GetImageSnapshot,        Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
 			{ {"instance-data", "getLedSnapshot"},       { Command::InstanceData,   SubCommand::GetLedSnapshot,          Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
-			{ {"ledcolors", "imagestream-start"},        { Command::LedColors,      SubCommand::ImageStreamStart,        Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
-			{ {"ledcolors", "imagestream-stop"},         { Command::LedColors,      SubCommand::ImageStreamStop,         Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
-			{ {"ledcolors", "ledstream-start"},          { Command::LedColors,      SubCommand::LedStreamStart,          Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
-			{ {"ledcolors", "ledstream-stop"},           { Command::LedColors,      SubCommand::LedStreamStop,           Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
+			{ {"ledcolors", "imagestream-start"},        { Command::LedColors,      SubCommand::ImageStreamStart,        Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::No  } },
+			{ {"ledcolors", "imagestream-stop"},         { Command::LedColors,      SubCommand::ImageStreamStop,         Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::No  } },
+			{ {"ledcolors", "ledstream-start"},          { Command::LedColors,      SubCommand::LedStreamStart,          Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::No  } },
+			{ {"ledcolors", "ledstream-stop"},           { Command::LedColors,      SubCommand::LedStreamStop,           Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::No  } },
 			{ {"leddevice", "addAuthorization"},         { Command::LedDevice,      SubCommand::AddAuthorization,        Authorization::Yes,    InstanceCmd::Single,       InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
 			{ {"leddevice", "discover"},                 { Command::LedDevice,      SubCommand::Discover,                Authorization::Yes,    InstanceCmd::No,           InstanceCmd::MustRun_No,     NoListenerCmd::Yes } },
 			{ {"leddevice", "getProperties"},            { Command::LedDevice,      SubCommand::GetProperties,           Authorization::Yes,    InstanceCmd::No,           InstanceCmd::MustRun_No,     NoListenerCmd::Yes } },

include/api/JsonCallbacks.h

@@ -36,7 +36,7 @@ class JsonCallbacks : public QObject
 
 	///
 	/// @brief Subscribe to future data updates given by subscription list
-	/// @param type   Array of subscriptionsm
+	/// @param type   Array of subscriptions, an empty array subscribes to all updates
 	///
 	QStringList subscribe(const QJsonArray& subscriptions);
 
@@ -56,7 +56,7 @@ class JsonCallbacks : public QObject
 
 	///
 	/// @brief Unsubscribe to future data updates given by subscription list
-	/// @param type   Array of subscriptions
+	/// @param type   Array of subscriptions, an empty array will unsubcribe all current subscriptions
 	///
 	QStringList unsubscribe(const QJsonArray& subscriptions);
 

include/grabber/dispmanx/DispmanxFrameGrabber.h

@@ -38,7 +38,7 @@ class DispmanxFrameGrabber : public Grabber
 	///
 	/// @return true, on success (i.e. library is present), else false
 	///
-	bool isAvailable() override;
+	bool isAvailable(bool logError = true) override;
 
 	///
 	/// @brief Opens the input device.

include/grabber/qt/QtGrabber.h

@@ -72,6 +72,13 @@ class QtGrabber : public Grabber
 	///
 	bool setupDisplay();
 
+	///
+	/// @brief Determine if the grabber is available.
+	///
+	/// @return true, on success (i.e. Window Manager is not Wayland), else false
+	///
+	bool isAvailable(bool logError = true) override;
+
 	///
 	/// @brief Opens the input device.
 	///

include/grabber/qt/QtWrapper.h

@@ -38,6 +38,18 @@ class QtWrapper: public GrabberWrapper
 	///
 	QtWrapper(const QJsonDocument& grabberConfig = QJsonDocument());
 
+	///
+	/// @brief Determine if the grabber is available for usage on the platform
+	///
+	/// @return true, on success, else false
+	///
+	bool isAvailable() override;
+
+	///
+	/// Starts the grabber, if available
+	///
+	bool start() override;
+
 	///
 	/// Starts the grabber which produces led values with the specified update rate
 	///

include/grabber/x11/X11Grabber.h

@@ -34,8 +34,14 @@ class X11Grabber : public Grabber , public QAbstractNativeEventFilter
 
 	~X11Grabber() override;
 
-	bool open();
+	///
+	/// @brief Determine if the grabber is available.
+	///
+	/// @return true, on success (i.e. Window Manager is not Wayland), else false
+	///
+	bool isAvailable(bool logError = true) override;
 
+	bool open();
 	bool setupDisplay();
 
 	///

include/grabber/x11/X11Wrapper.h

@@ -38,6 +38,23 @@ class X11Wrapper: public GrabberWrapper
 	///
 	~X11Wrapper() override;
 
+	///
+	/// @brief Determine if the grabber is available for usage on the platform
+	///
+	/// @return true, on success, else false
+	///
+	bool isAvailable() override;
+
+	///
+	/// Starts the grabber, if available
+	///
+	bool start() override;
+
+	///
+	/// Starts the grabber which produces led values with the specified update rate
+	///
+	bool open() override;
+
 public slots:
 	///
 	/// Performs a single frame grab and computes the led-colors

include/grabber/xcb/XcbGrabber.h

@@ -29,6 +29,13 @@ class XcbGrabber : public Grabber, public QAbstractNativeEventFilter
 
 	~XcbGrabber() override;
 
+	///
+	/// @brief Determine if the grabber is available.
+	///
+	/// @return true, on success (i.e. Window Manager is not Wayland), else false
+	///
+	bool isAvailable(bool logError = true) override;
+
 	bool open();
 	bool setupDisplay();
 

include/grabber/xcb/XcbWrapper.h

@@ -37,6 +37,23 @@ class XcbWrapper: public GrabberWrapper
 
 	~XcbWrapper() override;
 
+	///
+	/// @brief Determine if the grabber is available for usage on the platform
+	///
+	/// @return true, on success, else false
+	///
+	bool isAvailable() override;
+
+	///
+	/// Starts the grabber, if available
+	///
+	bool start() override;
+
+	///
+	/// Starts the grabber which produces led values with the specified update rate
+	///
+	bool open() override;
+
 public slots:
 	void action() override;
 

include/hyperion/BGEffectHandler.h

@@ -52,8 +52,6 @@ private slots:
 
 	QJsonDocument _bgEffectConfig;
 	bool _isBgEffectEnabled;
-
-	bool _isSuspended;
 };
 
 #endif // BGEFFECTHANDLER_H

include/hyperion/Grabber.h

@@ -118,7 +118,7 @@ class Grabber : public QObject
 	///
 	/// @return true, on success (i.e. library is present), else false
 	///
-	virtual bool isAvailable() { return _isAvailable; }
+	virtual bool isAvailable(bool logError = true)  { return _isAvailable; }
 
 public slots:
 

include/hyperion/GrabberWrapper.h

@@ -168,9 +168,6 @@ private slots:
 	/// Will start and stop grabber based on active listeners count
 	void handleSourceRequest(hyperion::Components component, int hyperionInd, bool listen);
 
-	///
-
-
 protected:
 
 	///

libsrc/api/JSONRPC_schema/schema-effect.json

@@ -14,8 +14,7 @@
 				"minimum": 0,
 				"maximum": 254
 			},
-			"uniqueItems": true,
-			"minItems": 1
+			"uniqueItems": true
 		},
 		"tan" : {
 			"type" : "integer"

libsrc/api/JSONRPC_schema/schema-serverinfo.json

@@ -16,18 +16,11 @@
 			"minimum": 0,
 			"maximum": 254
 		},
-		"data": {
-		  "type": ["null", "array"],
-		  "properties": {
-			"subscriptions": {
-			  "type": "array",
-			  "items": {}
-			}
-		  },
-		  "additionalProperties": false
-		},
 		"subscribe" : {
-			"type" : "array"
+			"type" : "array",
+			"items": {
+				"type" : "string"
+			}
 		},
 		"tan" : {
 			"type" : "integer"

libsrc/api/JsonAPI.cpp

@@ -719,13 +719,13 @@ void JsonAPI::handleServerInfoCommand(const QJsonObject &message, const JsonApiC
 	case SubCommand::Subscribe:
 	case SubCommand::Unsubscribe:
 	{
-		const QJsonObject &params = message["data"].toObject();
-		const QJsonArray &subscriptions = params["subscriptions"].toArray();
-		if (subscriptions.isEmpty()) {
+		QJsonValue const subscriptionsValue = message["subscribe"];
+		if (subscriptionsValue.isUndefined())
+		{
 			sendErrorReply("Invalid params", {"No subscriptions provided"}, cmd);
-			return;
 		}
 
+		const QJsonArray &subscriptions = subscriptionsValue.toArray();
 		QStringList invaliCommands;
 		if (cmd.subCommand == SubCommand::Subscribe)
 		{

libsrc/api/JsonCallbacks.cpp

@@ -124,7 +124,7 @@ bool JsonCallbacks::subscribe(const QString& cmd)
 QStringList JsonCallbacks::subscribe(const QJsonArray& subscriptions)
 {
 	QJsonArray subsArr;
-	if (subscriptions.contains("all"))
+	if (subscriptions.isEmpty())
 	{
 		for (const auto& entry : getCommands(false))
 		{
@@ -229,7 +229,7 @@ bool JsonCallbacks::unsubscribe(const Subscription::Type cmd)
 
 bool JsonCallbacks::unsubscribe(const QString& cmd)
 {
-	JsonApiSubscription subscription = ApiSubscriptionRegister::getSubscriptionInfo(cmd);
+	JsonApiSubscription const subscription = ApiSubscriptionRegister::getSubscriptionInfo(cmd);
 	if (subscription.cmd == Subscription::Unknown)
 	{
 		return false;
@@ -240,18 +240,14 @@ bool JsonCallbacks::unsubscribe(const QString& cmd)
 QStringList JsonCallbacks::unsubscribe(const QJsonArray& subscriptions)
 {
 	QJsonArray subsArr;
-	if (subscriptions.contains("all"))
-	{
-		for (const auto& entry : getCommands(false))
-		{
-			subsArr.append(entry);
-		}
-	}
-	else
+	if (subscriptions.isEmpty())
 	{
-		subsArr = subscriptions;
+		resetSubscriptions();
+		return {};
 	}
 
+	subsArr = subscriptions;
+
 	QStringList invalidSubscriptions;
 	for (auto it = subsArr.begin(); it != subsArr.end(); ++it)
 	{

libsrc/effectengine/EffectEngine.cpp

@@ -44,6 +44,22 @@ EffectEngine::EffectEngine(Hyperion * hyperion)
 	// get notifications about refreshed effect list
 	connect(_effectFileHandler, &EffectFileHandler::effectListChanged, this, &EffectEngine::handleUpdatedEffectList);
 
+	// Stop all effects when instance is disabled, restart the same when enabled
+	connect(_hyperion, &Hyperion::compStateChangeRequest, this, [=](hyperion::Components component, bool enable) {
+		if (component == hyperion::COMP_ALL)
+		{
+			if (enable)
+			{
+				startCachedEffects();
+			}
+			else
+			{
+				cacheRunningEffects();
+				stopAllEffects();
+			}
+		}
+	});
+
 	// register smooth cfgs and fill available effects
 	handleUpdatedEffectList();
 }

libsrc/grabber/dispmanx/DispmanxFrameGrabber.cpp

@@ -31,7 +31,7 @@ DispmanxFrameGrabber::DispmanxFrameGrabber()
 	_useImageResampler = true;
 }
 
-bool DispmanxFrameGrabber::isAvailable()
+bool DispmanxFrameGrabber::isAvailable(bool logError)
 {
 #ifdef BCM_FOUND
 	void* bcm_host = dlopen(std::string("" BCM_LIBRARY).c_str(), RTLD_LAZY | RTLD_GLOBAL);