Correct SmartPointers around Hyperion to ensure proper ownership

Author: Lord-Grey

include/api/API.h

@@ -383,7 +383,7 @@ class API : public QObject
 
 	// current instance index
 	quint8 _currInstanceIndex;
-	QSharedPointer<Hyperion> _hyperion;
+	QWeakPointer<Hyperion> _hyperionWeak;
 
 signals:
 	///

include/api/JsonAPI.h

@@ -422,5 +422,4 @@ private slots:
 	QSharedPointer<JsonCallbacks> _jsonCB;
 
 	bool _isServiceAvailable;
-
 };

include/api/JsonApiSubscription.h

@@ -13,9 +13,7 @@ class Subscription {
 		Unknown,
 		AdjustmentUpdate,
 		ComponentsUpdate,
-#if defined(ENABLE_EFFECTENGINE)
 		EffectsUpdate,
-#endif
 		EventUpdate,
 		ImageToLedMappingUpdate,
 		ImageUpdate,
@@ -33,9 +31,7 @@ class Subscription {
 		switch (type) {
 		case AdjustmentUpdate: return "adjustment-update";
 		case ComponentsUpdate: return "components-update";
-#if defined(ENABLE_EFFECTENGINE)
 		case EffectsUpdate: return "effects-update";
-#endif
 		case EventUpdate: return "event-update";
 		case ImageToLedMappingUpdate: return "imageToLedMapping-update";
 		case ImageUpdate: return "ledcolors-imagestream-update";
@@ -55,9 +51,7 @@ class Subscription {
 		switch (type) {
 		case AdjustmentUpdate:
 		case ComponentsUpdate:
-#if defined(ENABLE_EFFECTENGINE)
 		case EffectsUpdate:
-#endif
 		case ImageToLedMappingUpdate:
 		case ImageUpdate:
 		case LedColorsUpdate:
@@ -109,9 +103,7 @@ class ApiSubscriptionRegister {
 		static const SubscriptionLookupMap subscriptionLookup {
 			{ {"adjustment-update"}, { Subscription::AdjustmentUpdate, true} },
 			{ {"components-update"}, { Subscription::ComponentsUpdate, true} },
-#if defined(ENABLE_EFFECTENGINE)
 			{ {"effects-update"}, { Subscription::EffectsUpdate, true} },
-#endif
 			{ {"event-update"}, { Subscription::EventUpdate, true} },
 			{ {"imageToLedMapping-update"}, { Subscription::ImageToLedMappingUpdate, true} },
 			{ {"ledcolors-imagestream-update"}, { Subscription::ImageUpdate, false} },

include/api/JsonCallbacks.h

@@ -196,16 +196,16 @@ private slots:
 
 	Logger *_log;
 	quint8 _instanceID;
-	QSharedPointer<Hyperion> _hyperion;
+	QWeakPointer<Hyperion> _hyperionWeak;
 
 	/// The peer address of the client
 	QString _peerAddress;
 
 	/// pointer of comp register
-	QSharedPointer<ComponentRegister> _componentRegister;
+	QWeakPointer<ComponentRegister> _componentRegisterWeak;
 
 	/// priority muxer instance
-	QSharedPointer<PriorityMuxer> _prioMuxer;
+	QWeakPointer<PriorityMuxer> _prioMuxerWeak;
 
 	/// contains active subscriptions
 	QSet<Subscription::Type> _subscribedCommands;

include/api/JsonInfo.h

@@ -7,29 +7,31 @@
 
 #include <QJsonObject>
 #include <QJsonArray>
+#include <QSharedPointer>
+
 
 class JsonInfo
 {
 
 public:
-	static QJsonObject getInfo(const Hyperion* hyperion, Logger* log);
-	static QJsonArray getAdjustmentInfo(const Hyperion* hyperion, Logger* log);
-	static QJsonArray getPrioritiestInfo(const Hyperion* hyperion);
+	static QJsonObject getInfo(const QSharedPointer<Hyperion>& hyperionInstance, Logger* log);
+	static QJsonArray getAdjustmentInfo(const QSharedPointer<Hyperion>& hyperionInstance, Logger* log);
+	static QJsonArray getPrioritiestInfo(const QSharedPointer<Hyperion>& hyperionInstance);
 	static QJsonArray getPrioritiestInfo(int currentPriority, const PriorityMuxer::InputsMap& activeInputs);
 	static QJsonArray getEffects();
 	static QJsonArray getEffectSchemas();
 	static QJsonArray getAvailableScreenGrabbers();
 	static QJsonArray getAvailableVideoGrabbers();
 	static QJsonArray getAvailableAudioGrabbers();
-	static QJsonObject getGrabbers(const Hyperion* hyperion);
+	static QJsonObject getGrabbers(const QSharedPointer<Hyperion>& hyperionInstance);
 	static QJsonObject getAvailableLedDevices();
 	static QJsonObject getCecInfo();
 	static QJsonArray getServices();
-	static QJsonArray getComponents(const Hyperion* hyperion);
+	static QJsonArray getComponents(const QSharedPointer<Hyperion>& hyperionInstance);
 	static QJsonArray getInstanceInfo();
-	static QJsonArray getActiveEffects(const Hyperion* hyperion);
-	static QJsonArray getActiveColors(const Hyperion* hyperion);
-	static QJsonArray getTransformationInfo(const Hyperion* hyperion);
+	static QJsonArray getActiveEffects(const QSharedPointer<Hyperion>& hyperionInstance);
+	static QJsonArray getActiveColors(const QSharedPointer<Hyperion>& hyperionInstance);
+	static QJsonArray getTransformationInfo(const QSharedPointer<Hyperion>& hyperionInstance);
 	static QJsonObject getSystemInfo();
 	QJsonObject discoverSources (const QString& sourceType, const QJsonObject& params);
 

include/blackborder/BlackBorderProcessor.h

@@ -26,7 +26,8 @@ namespace hyperion
 	{
 		Q_OBJECT
 	public:
-		BlackBorderProcessor(Hyperion* hyperion, QObject* parent);
+		BlackBorderProcessor(const QSharedPointer<Hyperion>& hyperionInstance, QObject* parent);
+		~BlackBorderProcessor() override;
 
 		///
 		/// Return the current (detected) border
@@ -114,7 +115,9 @@ namespace hyperion
 
 	private:
 		/// Hyperion instance
-		Hyperion* _hyperion;
+		QWeakPointer<Hyperion> _hyperionWeak;
+		/// Logger instance
+		Logger* _log;
 
 		///
 		/// Updates the current border based on the newly detected border. Returns true if the

include/effectengine/Effect.h

@@ -24,7 +24,7 @@ class Effect : public QThread
 
 	friend class EffectModule;
 
-	Effect(Hyperion* hyperion
+	Effect(const QSharedPointer<Hyperion>& hyperionInstance
 		, int priority
 		, int timeout
 		, const QString& script
@@ -84,7 +84,8 @@ public slots:
 	bool setModuleParameters();
 	void addImage();
 
-	Hyperion* _hyperion;
+	/// Hyperion instance pointer
+	QWeakPointer<Hyperion> _hyperionWeak;
 
 	const int _priority;
 

include/effectengine/EffectEngine.h

@@ -27,7 +27,7 @@ class EffectEngine : public QObject
 	Q_OBJECT
 
 public:
-	EffectEngine(Hyperion * hyperion);
+	explicit EffectEngine(const QSharedPointer<Hyperion>& hyperionInstance);
 	~EffectEngine() override;
 
 	std::list<EffectDefinition> getEffects() const { return _availableEffects; }
@@ -101,7 +101,8 @@ private slots:
 	void waitForEffectsToStop();
 
 private:
-	Hyperion * _hyperion;
+	/// Hyperion instance pointer
+	QWeakPointer<Hyperion> _hyperionWeak;
 
 	std::list<EffectDefinition> _availableEffects;
 
@@ -112,7 +113,7 @@ private slots:
 	Logger * _log;
 
 	// The global effect file handler
-	EffectFileHandler* _effectFileHandler;
+	EffectFileHandler * _effectFileHandler;
 
 	QEventLoop _eventLoop;
 	int _remainingEffects;

include/forwarder/MessageForwarder.h

@@ -14,6 +14,7 @@
 #include <QJsonArray>
 #include <QJsonDocument>
 #include <QSharedPointer>
+#include <QWeakPointer>
 
 // Utils includes
 #include <utils/ColorRgb.h>
@@ -133,10 +134,11 @@ private slots:
 	SettingsTable _settings;
 
 	/// Hyperion instance forwarded
-	QSharedPointer<Hyperion> _hyperion;
+	///  Hyperion instance
+	QWeakPointer<Hyperion> _hyperionWeak;
 
 	/// Muxer instance
-	QSharedPointer<PriorityMuxer> _muxer;
+	QWeakPointer<PriorityMuxer> _muxerWeak;
 
 	// JSON connections for forwarding
 	QList<TargetHost> _jsonTargets;

include/hyperion/BGEffectHandler.h

@@ -17,7 +17,8 @@ class BGEffectHandler : public QObject
 	Q_OBJECT
 
 public:
-	BGEffectHandler(Hyperion* hyperion = nullptr);
+	BGEffectHandler(const QSharedPointer<Hyperion>& hyperionInstance);
+	~BGEffectHandler() override;
 
 	///
 	/// @brief Disconnect from connected signals
@@ -48,7 +49,7 @@ private slots:
 
 private:
 	/// Hyperion instance pointer
-	Hyperion* _hyperion;
+	QWeakPointer<Hyperion> _hyperionWeak;
 	Logger * _log;
 
 	QJsonDocument _bgEffectConfig;