New features: disable LEDs/components on startup, stop processing whe…

…n user has locked the system (#737) * Disable on user lock screen (Windows) * Fix * Add feature to disable components on startup
awawa-dev · Jan 19, 2024 · fd90a20 · fd90a20
1 parent 83c1f62
commit fd90a20
Show file tree

Hide file tree

Showing 22 changed files with 187 additions and 35 deletions.
diff --git a/include/base/ComponentController.h b/include/base/ComponentController.h
@@ -15,7 +15,7 @@ class ComponentController : public QObject
 	Q_OBJECT
 
 public:
-    ComponentController(HyperHdrInstance* hyperhdr);
+    ComponentController(HyperHdrInstance* hyperhdr, bool disableOnStartup);
     virtual ~ComponentController();
 
 	int isComponentEnabled(hyperhdr::Components comp) const;
@@ -35,4 +35,5 @@ private slots:
 	Logger* _log;
 	std::map<hyperhdr::Components, bool> _componentStates;
 	std::map<hyperhdr::Components, bool> _prevComponentStates;
+	bool _disableOnStartup;
 };
diff --git a/include/base/HyperHdrInstance.h b/include/base/HyperHdrInstance.h
@@ -51,7 +51,7 @@ class HyperHdrInstance : public QObject
 	Q_OBJECT
 
 public:
-	HyperHdrInstance(quint8 instance, bool readonlyMode, QString name);
+	HyperHdrInstance(quint8 instance, bool readonlyMode, bool disableOnstartup, QString name);
 	~HyperHdrInstance();
 
 	quint8 getInstanceIndex() const { return _instIndex; }
@@ -158,6 +158,7 @@ private slots:
 	QString					_name;
 
 	bool					_readOnlyMode;
+	bool					_disableOnStartup;
 
 	static std::atomic<bool>	_signalTerminate;
 	static std::atomic<int>		_totalRunningCount;

diff --git a/include/base/HyperHdrManager.h b/include/base/HyperHdrManager.h
@@ -54,7 +54,7 @@ public slots:
 
 	QVector<QVariantMap> getInstanceData() const;
 
-	bool startInstance(quint8 inst, QObject* caller = nullptr, int tan = 0);
+	bool startInstance(quint8 inst, QObject* caller = nullptr, int tan = 0, bool disableOnStartup = false);
 
 	bool stopInstance(quint8 inst);
 
@@ -97,7 +97,7 @@ private slots:
 
 	HyperHdrManager(const QString& rootPath, bool readonlyMode);
 
-	void startAll();
+	void startAll(bool disableOnStartup);
 
 	void stopAllonExit();
 

diff --git a/include/leddevice/LedDevice.h b/include/leddevice/LedDevice.h
@@ -70,6 +70,7 @@ public slots:
 	void blinking(QJsonObject params);
 	void smoothingRestarted(int newSmoothingInterval);
 	int hasLedClock();
+	void pauseRetryTimer(bool mode);
 
 signals:
 	void SignalEnableStateChanged(bool newState);
@@ -155,4 +156,5 @@ protected slots:
 	int _blinkIndex;
 	qint64 _blinkTime;
 	int _instanceIndex;
+	int _pauseRetryTimer;
 };
diff --git a/include/leddevice/LedDeviceWrapper.h b/include/leddevice/LedDeviceWrapper.h
@@ -22,7 +22,7 @@ class LedDeviceWrapper : public QObject
 	explicit LedDeviceWrapper(HyperHdrInstance* ownerInstance);
 	virtual ~LedDeviceWrapper();
 
-	void createLedDevice(QJsonObject config, int smoothingInterval);
+	void createLedDevice(QJsonObject config, int smoothingInterval, bool disableOnStartup);
 	static QJsonObject getLedDeviceSchemas();
 	static int addToDeviceMap(QString name, LedDeviceCreateFuncType funcPtr);
 	static const LedDeviceRegistry& getDeviceMap();

diff --git a/sources/base/ComponentController.cpp b/sources/base/ComponentController.cpp
@@ -8,8 +8,9 @@
 
 using namespace hyperhdr;
 
-ComponentController::ComponentController(HyperHdrInstance* hyperhdr)
-	: _log(Logger::getInstance(QString("COMPONENTCTRL%1").arg(hyperhdr->getInstanceIndex())))
+ComponentController::ComponentController(HyperHdrInstance* hyperhdr, bool disableOnStartup):
+	_log(Logger::getInstance(QString("COMPONENTCTRL%1").arg(hyperhdr->getInstanceIndex()))),
+	_disableOnStartup(disableOnStartup)
 {
 	// init all comps to false
 	QVector<hyperhdr::Components> vect;
@@ -27,7 +28,7 @@ ComponentController::ComponentController(HyperHdrInstance* hyperhdr)
 
 	connect(this, &ComponentController::SignalRequestComponent, hyperhdr, &HyperHdrInstance::SignalRequestComponent);
 	connect(hyperhdr, &HyperHdrInstance::SignalRequestComponent, this, &ComponentController::handleCompStateChangeRequest);
-	Debug(_log, "ComponentController is initialized");
+	Debug(_log, "ComponentController is initialized. Components are %s", (_disableOnStartup) ? "DISABLED" : "ENABLED");
 }
 
 ComponentController::~ComponentController()
@@ -41,11 +42,17 @@ void ComponentController::handleCompStateChangeRequest(hyperhdr::Components comp
 	{
 		if (!activated && _prevComponentStates.empty())
 		{
+			bool disableLeds = _disableOnStartup && !isComponentEnabled(COMP_ALL) && _prevComponentStates.empty();
+
 			Debug(_log, "Disabling HyperHDR instance: saving current component states first");
 			for (const auto& comp : _componentStates)
 				if (comp.first != COMP_ALL)
 				{
-					_prevComponentStates.emplace(comp.first, comp.second);
+					if (disableLeds && comp.first == COMP_LEDDEVICE)
+						_prevComponentStates.emplace(comp.first, true);
+					else
+						_prevComponentStates.emplace(comp.first, comp.second);
+
 					if (comp.second)
 					{
 						emit SignalRequestComponent(comp.first, false);

diff --git a/sources/base/HyperHdrInstance.cpp b/sources/base/HyperHdrInstance.cpp
@@ -67,7 +67,7 @@
 std::atomic<bool> HyperHdrInstance::_signalTerminate(false);
 std::atomic<int>  HyperHdrInstance::_totalRunningCount(0);
 
-HyperHdrInstance::HyperHdrInstance(quint8 instance, bool readonlyMode, QString name)
+HyperHdrInstance::HyperHdrInstance(quint8 instance, bool readonlyMode, bool disableOnStartup, QString name)
 	: QObject()
 	, _instIndex(instance)
 	, _bootEffect(QTime::currentTime().addSecs(5))
@@ -90,6 +90,7 @@ HyperHdrInstance::HyperHdrInstance(quint8 instance, bool readonlyMode, QString n
 	, _currentLedColors()
 	, _name((name.isEmpty()) ? QString("INSTANCE%1").arg(instance) : name)
 	, _readOnlyMode(readonlyMode)
+	, _disableOnStartup(disableOnStartup)
 {
 	_totalRunningCount++;
 }
@@ -142,7 +143,7 @@ void HyperHdrInstance::start()
 	Info(_log, "Starting the instance");	
 
 	_instanceConfig = std::unique_ptr<InstanceConfig>(new InstanceConfig(false, _instIndex, this, _readOnlyMode));
-	_componentController = std::unique_ptr<ComponentController>(new ComponentController(this));
+	_componentController = std::unique_ptr<ComponentController>(new ComponentController(this, _disableOnStartup));
 	connect(_componentController.get(), &ComponentController::SignalComponentStateChanged, this, &HyperHdrInstance::SignalComponentStateChanged);
 	_ledString = LedString::createLedString(getSetting(settings::type::LEDS).array(), LedString::createColorOrder(getSetting(settings::type::DEVICE).object()));
 	_muxer = std::unique_ptr<Muxer>(new Muxer(_instIndex, static_cast<int>(_ledString.leds().size()), this));
@@ -184,7 +185,7 @@ void HyperHdrInstance::start()
 
 	_ledDeviceWrapper = std::unique_ptr<LedDeviceWrapper>(new LedDeviceWrapper(this));
 	connect(this, &HyperHdrInstance::SignalRequestComponent, _ledDeviceWrapper.get(), &LedDeviceWrapper::handleComponentState);
-	_ledDeviceWrapper->createLedDevice(ledDevice, _smoothing->GetSuggestedInterval());
+	_ledDeviceWrapper->createLedDevice(ledDevice, _smoothing->GetSuggestedInterval(), _disableOnStartup);
 
 	// create the effect engine; needs to be initialized after smoothing!
 	_effectEngine = std::unique_ptr<EffectEngine>(new EffectEngine(this));
@@ -222,6 +223,12 @@ void HyperHdrInstance::start()
 	// instance initiated, enter thread event loop
 	emit SignalInstanceJustStarted();
 
+	if (_disableOnStartup)
+	{
+		_componentController->setNewComponentState(hyperhdr::COMP_ALL, false);
+		Warning(_log, "The user has disabled LEDs auto-start in the configuration (interface: 'General' tab)");
+	}
+
 	// exit
 	Info(_log, "The instance is running");
 }
@@ -295,9 +302,7 @@ void HyperHdrInstance::handleSettingsUpdate(settings::type type, const QJsonDocu
 
 		// do always reinit until the led devices can handle dynamic changes
 		dev["currentLedCount"] = _hwLedCount; // Inject led count info
-		_ledDeviceWrapper->createLedDevice(dev, _smoothing->GetSuggestedInterval());
-
-		// TODO: Check, if framegrabber frequency is lower than latchtime..., if yes, stop
+		_ledDeviceWrapper->createLedDevice(dev, _smoothing->GetSuggestedInterval(), false);		
 	}
 	else if (type == settings::type::BGEFFECT || type == settings::type::FGEFFECT)
 	{
@@ -684,9 +689,15 @@ void HyperHdrInstance::handlePriorityChangedLedDevice(const quint8& priority)
 		if (previousPriority == Muxer::LOWEST_PRIORITY)
 		{
 			Info(_log, "New source available -> switch LED-Device on");
-
-			emit SignalRequestComponent(hyperhdr::COMP_LEDDEVICE, true);
-			emit GlobalSignals::getInstance()->SignalPerformanceStateChanged(true, hyperhdr::PerformanceReportType::INSTANCE, getInstanceIndex(), _name);
+			if (!isComponentEnabled(hyperhdr::Components::COMP_ALL))
+			{
+				Warning(_log, "Components are disabled: ignoring switching LED-Device on");
+			}
+			else
+			{
+				emit SignalRequestComponent(hyperhdr::COMP_LEDDEVICE, true);
+				emit GlobalSignals::getInstance()->SignalPerformanceStateChanged(true, hyperhdr::PerformanceReportType::INSTANCE, getInstanceIndex(), _name);
+			}
 		}
 	}
 }

diff --git a/sources/base/HyperHdrManager.cpp b/sources/base/HyperHdrManager.cpp
@@ -102,15 +102,15 @@ bool HyperHdrManager::areInstancesReady()
 	return (--_fireStarter == 0);
 }
 
-void HyperHdrManager::startAll()
+void HyperHdrManager::startAll(bool disableOnStartup)
 {
 	auto instanceList = _instanceTable->getAllInstances(true);
 
 	_fireStarter = instanceList.count();
 
 	for (const auto& entry : instanceList)
 	{
-		startInstance(entry["instance"].toInt());
+		startInstance(entry["instance"].toInt(), nullptr, 0, disableOnStartup);
 	}
 }
 
@@ -179,7 +179,7 @@ void HyperHdrManager::hibernate(bool wakeUp)
 	}
 }
 
-bool HyperHdrManager::startInstance(quint8 inst, QObject* caller, int tan)
+bool HyperHdrManager::startInstance(quint8 inst, QObject* caller, int tan, bool disableOnStartup)
 {
 	if (_instanceTable->instanceExist(inst))
 	{
@@ -191,6 +191,7 @@ bool HyperHdrManager::startInstance(quint8 inst, QObject* caller, int tan)
 			auto hyperhdr = std::shared_ptr<HyperHdrInstance>(
 				new HyperHdrInstance(inst,
 					_readonlyMode,
+					disableOnStartup,
 					_instanceTable->getNamebyIndex(inst)),
 				[](HyperHdrInstance* oldInstance) {
 					THREAD_REMOVER(QString("HyperHDR instance at index = %1").arg(oldInstance->getInstanceIndex()),

diff --git a/sources/base/schema/schema-general.json b/sources/base/schema/schema-general.json
@@ -32,6 +32,24 @@
 				"hidden":true
 			},
 			"propertyOrder" : 4
+		},
+		"disableOnLocked" :
+		{
+			"type" : "boolean",
+			"format": "checkbox",
+			"title" : "edt_conf_gen_disableOnLocked_title",
+			"default" : false,
+			"required" : true,
+			"propertyOrder" : 5
+		},
+		"disableLedsStartup" :
+		{
+			"type" : "boolean",
+			"format": "checkbox",
+			"title" : "edt_conf_gen_disableLedsStartup_title",
+			"default" : false,
+			"required" : true,
+			"propertyOrder" : 6
 		}
 
 	},

diff --git a/sources/grabber/DX/DxGrabber.cpp b/sources/grabber/DX/DxGrabber.cpp
@@ -313,6 +313,8 @@ void DxGrabber::stop()
 		_timer->stop();
 		Info(_log, "Stopped");
 	}
+
+	_retryTimer->stop();
 }
 
 bool DxGrabber::initDirectX(QString selectedDeviceName)

diff --git a/sources/hyperhdr/HyperHdrDaemon.cpp b/sources/hyperhdr/HyperHdrDaemon.cpp
@@ -82,6 +82,7 @@ HyperHdrDaemon::HyperHdrDaemon(const QString& rootPath, QApplication* parent, bo
 	, _rootPath(rootPath)
 	, _params(params)
 	, _isGuiApp(isGuiApp)
+	, _disableOnStart(false)
 {
 
 	// Register metas for thread queued connection
@@ -166,7 +167,9 @@ HyperHdrDaemon::HyperHdrDaemon(const QString& rootPath, QApplication* parent, bo
 	// spawn all Hyperhdr instances (non blocking)
 	settingsChangedHandler(settings::type::VIDEOGRABBER, getSetting(settings::type::VIDEOGRABBER));
 	settingsChangedHandler(settings::type::SYSTEMGRABBER, getSetting(settings::type::SYSTEMGRABBER));
-	_instanceManager->startAll();
+	QJsonObject genConfig = getSetting(settings::type::GENERAL).object();	
+	_disableOnStart = genConfig["disableLedsStartup"].toBool(false);
+	_instanceManager->startAll(_disableOnStart);
 
 	//Cleaning up Hyperhdr before quit
 	connect(parent, &QCoreApplication::aboutToQuit, this, &HyperHdrDaemon::freeObjects);
@@ -177,7 +180,9 @@ HyperHdrDaemon::HyperHdrDaemon(const QString& rootPath, QApplication* parent, bo
 
 	// power management
 	#if defined(HAVE_POWER_MANAGEMENT)
-		_suspendHandler = std::unique_ptr<SuspendHandler>(new SuspendHandler());
+		bool lockedEnable = genConfig["disableOnLocked"].toBool(false);
+
+		_suspendHandler = std::unique_ptr<SuspendHandler>(new SuspendHandler(lockedEnable));
 		connect(_suspendHandler.get(), &SuspendHandler::SignalHibernate, _instanceManager.get(), &HyperHdrManager::hibernate);
 
 		#ifdef _WIN32
@@ -223,6 +228,12 @@ void HyperHdrDaemon::instanceStateChangedHandler(InstanceState state, quint8 ins
 			{
 				_networkThread->start();
 			}
+
+			if (_disableOnStart)
+			{
+				Warning(_log, "The user has disabled LEDs auto-start in the configuration (interface: 'General' tab)");
+				_instanceManager->toggleStateAllInstances(false);				
+			}			
 		}
 	}
 }

diff --git a/sources/hyperhdr/HyperHdrDaemon.h b/sources/hyperhdr/HyperHdrDaemon.h
@@ -170,5 +170,6 @@ public slots:
 	bool				_readonlyMode;
 	QStringList			_params;
 	bool				_isGuiApp;
+	bool				_disableOnStart;
 };
 
diff --git a/sources/hyperhdr/SuspendHandlerLinux.cpp b/sources/hyperhdr/SuspendHandlerLinux.cpp
@@ -46,7 +46,7 @@ namespace {
 	const QString UPOWER_INTER = QStringLiteral("org.freedesktop.login1.Manager");
 }
 
-SuspendHandler::SuspendHandler()
+SuspendHandler::SuspendHandler(bool sessionLocker)
 {
 	QDBusConnection bus = QDBusConnection::systemBus();
 

diff --git a/sources/hyperhdr/SuspendHandlerLinux.h b/sources/hyperhdr/SuspendHandlerLinux.h
@@ -37,7 +37,7 @@ class SuspendHandler : public QObject {
 	void SignalHibernate(bool wakeUp);
 
 public:
-	SuspendHandler();
+	SuspendHandler(bool sessionLocker = false);
 	~SuspendHandler();
 
 public slots:

diff --git a/sources/hyperhdr/SuspendHandlerMacOS.h b/sources/hyperhdr/SuspendHandlerMacOS.h
@@ -37,6 +37,6 @@ class SuspendHandler : public QObject {
 	void SignalHibernate(bool wakeUp);
 
 public:
-	SuspendHandler();
+	SuspendHandler(bool sessionLocker = false);
 	~SuspendHandler();
 };
diff --git a/sources/hyperhdr/SuspendHandlerMacOS.mm b/sources/hyperhdr/SuspendHandlerMacOS.mm
@@ -89,7 +89,7 @@ - (void)goingWake: (NSNotification*)note
 
 @end
 
-SuspendHandler::SuspendHandler()
+SuspendHandler::SuspendHandler(bool sessionLocker)
 {
 	_macSuspendHandlerInstance = [MacSuspendHandler new];
 	_suspendHandler = this;