Updates (#2)

* Align ini-Files to POEditor conventions

* Allow full range of priorities

* Update minimum OBS version

* Fix Windows cache path

* Address compile warning

* Remove UI backup file

* Readd en-GB.init

* Streamline Code

* cleanup

* Address memory leaks reported by OBS

* Artifacts for PR

* Update socket states and related messages

* Add clean-up for artifacts

* Fix text

Co-authored-by: Paulchen Panther <[email protected]>

Author: Lord-Grey

.github/workflows/cleanup.yml

@@ -0,0 +1,16 @@
+name: Clean artifacts
+
+# Run cleanup workflow at the end of every day
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  clean:
+    runs-on: ubuntu-latest
+    steps:
+      - name: cleanup
+        uses: kolpav/purge-artifacts-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          expire-in: 7days # all artifacts max 7 days old

.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
     name: 'Linux 64bit'
     runs-on: ubuntu-latest
     env:
-      minimum-obs-version: 25.0.0
+      minimum-obs-version: 25.0.3
       project-name: hyperion-obs
       project-git: https://github.com/hyperion-project/hyperion-obs-plugin
       maintainer: hyperion-project.org
@@ -54,7 +54,7 @@ jobs:
           sudo mv ${{ github.workspace }}/plugin/*.deb ${{ github.workspace }}/plugin/${{ env.project-name }}.${{ env.VERSION }}.linux.x64.deb
 
       - name: Upload plugin
-        if: startsWith(github.event.ref, 'refs/tags')
+        if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'pull_request'
         uses: actions/upload-artifact@v2
         with:
           name: hyperion-obs
@@ -121,7 +121,7 @@ jobs:
         id: build-cache-obs
         uses: actions/cache@v1
         with:
-          path: ${{ github.workspace }}/obs-studio/build
+          path: ${{ github.workspace }}\obs-studio\build
           key: ${{ runner.os }}-build-cache-obs-${{ env.OBS_GIT_TAG }}
           restore-keys: ${{ runner.os }}-build-cache-obs-
 
@@ -163,7 +163,7 @@ jobs:
           iscc .\build\Windows.iss /O. /F"hyperion-obs.${{ env.VERSION }}.windows.x64"
 
       - name: Upload plugin
-        if: startsWith(github.event.ref, 'refs/tags')
+        if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'pull_request'
         uses: actions/upload-artifact@v2
         with:
           name: 'hyperion-obs.${{ env.VERSION }}.windows.x64'

CMakeLists.txt

@@ -70,6 +70,12 @@ if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
 	SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${qt_module_path}")
 endif()
 
+if(NOT EXISTS ${OBS_SOURCE})
+	if (DEFINED ENV{OBS_SOURCE})
+		set(OBS_SOURCE $ENV{OBS_SOURCE})
+	endif()
+endif()	
+
 set(OBS_SOURCE "" CACHE PATH "Where is the source code of OBS-Studio located")
 set(OBS_BUILD "" CACHE PATH "Where is the build directory of OBS-Studio located")
 

README.md

@@ -51,7 +51,7 @@ git clone --recursive https://github.com/obsproject/obs-studio.git
 git clone --recursive https://github.com/hyperion-project/hyperion-obs-plugin.git
 cd hyperion-obs-plugin
 mkdir build && cd build
-cmake -DOBS_SOURCE=../../obs-studio -DCMAKE_INSTALL_PREFIX=/usr ..
+cmake -DOBS_SOURCE=../../obs-studio ..
 make -j $(nproc)
 sudo make install
 ```

locale/de-DE.ini

@@ -1,13 +1,13 @@
-UI.Menu="Hyperion Streaming"
-UI.Title="Ausgabe an Hyperion"
-UI.AutoStart="Starte automatisch"
-UI.AutoStartTip="Starte den Stream mit dem OBS-Start."
-UI.Address="Adresse"
-UI.AddressTip="Der Hostname oder die IP-Adresse (IPv4/IPv6) des Hyperion-Servers."
-UI.PortTip="Der beim Hyperion Server konfigurierte Flatbufferport [Standard:19400]."
-UI.Priority="Priorität"
-UI.PriorityTip="Mit welche Priorität der Stream beim Hyperion-Server empfangen wird [Standard:150]"
-UI.SizeDecimation="Ausgabereduzierungsfaktor"
-UI.SizeDecimationTip="Bildverkleinerung (Faktor) ausgehend von der ursprünglichen Größe. 1 für die unveränderte/ursprüngliche Größe."
-UI.StartTip="Starte Ausgabe an Hyperion"
-UI.StopTip="Stoppe Ausgabe an Hyperion"
+UI_Menu="Hyperion Streaming"
+UI_Title="Ausgabe an Hyperion"
+UI_AutoStart="Starte automatisch"
+UI_AutoStartTip="Starte den Stream mit dem OBS-Start."
+UI_Address="Adresse"
+UI_AddressTip="Der Hostname oder die IP-Adresse (IPv4/IPv6) des Hyperion-Servers."
+UI_PortTip="Der beim Hyperion Server konfigurierte Flatbufferport [Standard:19400]."
+UI_Priority="Priorität"
+UI_PriorityTip="Mit welche Priorität der Stream beim Hyperion-Server empfangen wird [Standard:150]"
+UI_SizeDecimation="Ausgabereduzierungsfaktor"
+UI_SizeDecimationTip="Bildverkleinerung (Faktor) ausgehend von der ursprünglichen Größe. 1 für die unveränderte/ursprüngliche Größe."
+UI_StartTip="Starte Ausgabe an Hyperion"
+UI_StopTip="Stoppe Ausgabe an Hyperion"

locale/en-GB.ini

@@ -1,13 +1,13 @@
-UI.Menu="Hyperion Streaming"
-UI.Title="Stream to Hyperion"
-UI.AutoStart="Auto start"
-UI.AutoStartTip="Start streaming when OBS is started."
-UI.Address="Address"
-UI.AddressTip="The hostname or IP-address (IPv4 or IPv6) of the Hyperion server."
-UI.PortTip="The Flatbuffer port as configured at the Hyperion Server [Default:19400]."
-UI.Priority="Priority"
-UI.PriorityTip="With which priority the stream is received at the Hyperion server [Default:150]"
-UI.SizeDecimation="Output Decimation"
-UI.SizeDecimationTip="Scale the output image down by decimation factor. 1 means no decimation (keep original size)."
-UI.StartTip="Start streaming to Hyperion"
-UI.StopTip="Stop streaming to Hyperion"
+UI_Menu="Hyperion Streaming"
+UI_Title="Stream to Hyperion"
+UI_AutoStart="Auto start"
+UI_AutoStartTip="Start streaming when OBS is started."
+UI_Address="Address"
+UI_AddressTip="The hostname or IP-address (IPv4 or IPv6) of the Hyperion server."
+UI_PortTip="The Flatbuffer port as configured at the Hyperion Server [Default:19400]."
+UI_Priority="Priority"
+UI_PriorityTip="With which priority the stream is received at the Hyperion server [Default:150]"
+UI_SizeDecimation="Output Decimation"
+UI_SizeDecimationTip="Scale the output image down by decimation factor. 1 means no decimation (keep original size)."
+UI_StartTip="Start streaming to Hyperion"
+UI_StopTip="Stop streaming to Hyperion"

locale/en-US.ini

@@ -1,13 +1,13 @@
-UI.Menu="Hyperion Streaming"
-UI.Title="Stream to Hyperion"
-UI.AutoStart="Auto start"
-UI.AutoStartTip="Start streaming when OBS is started."
-UI.Address="Address"
-UI.AddressTip="The hostname or IP-address (IPv4 or IPv6) of the Hyperion server."
-UI.PortTip="The Flatbuffer port as configured at the Hyperion Server [Default:19400]."
-UI.Priority="Priority"
-UI.PriorityTip="With which priority the stream is received at the Hyperion server [Default:150]"
-UI.SizeDecimation="Output Decimation"
-UI.SizeDecimationTip="Scale the output image down by decimation factor. 1 means no decimation (keep original size)."
-UI.StartTip="Start streaming to Hyperion"
-UI.StopTip="Stop streaming to Hyperion"
+UI_Menu="Hyperion Streaming"
+UI_Title="Stream to Hyperion"
+UI_AutoStart="Auto start"
+UI_AutoStartTip="Start streaming when OBS is started."
+UI_Address="Address"
+UI_AddressTip="The hostname or IP-address (IPv4 or IPv6) of the Hyperion server."
+UI_PortTip="The Flatbuffer port as configured at the Hyperion Server [Default:19400]."
+UI_Priority="Priority"
+UI_PriorityTip="With which priority the stream is received at the Hyperion server [Default:150]"
+UI_SizeDecimation="Output Decimation"
+UI_SizeDecimationTip="Scale the output image down by decimation factor. 1 means no decimation (keep original size)."
+UI_StartTip="Start streaming to Hyperion"
+UI_StopTip="Stop streaming to Hyperion"

src/FlatBufferConnection.cpp

@@ -118,26 +118,32 @@ void FlatBufferConnection::connectToHost()
 
 void FlatBufferConnection::sendMessage(const uint8_t* buffer, uint32_t size)
 {
-	// print out connection message only when state is changed
-	if (_socket.state() != _prevSocketState )
+	QAbstractSocket::SocketState socketState = _socket.state();
+	if (socketState != _prevSocketState )
 	{
 		_registered = false;
-		switch (_socket.state() )
+		switch (socketState)
 		{
 			case QAbstractSocket::UnconnectedState:
-				emit logMessage(QString("No connection to Hyperion: %1:%2").arg(_host).arg(_port));
+				emit logMessage(QString("No connection to %1, port: %2").arg(_host).arg(_port));
+				break;
+			case QAbstractSocket::ConnectingState:
+				emit logMessage(QString("Connecting to %1, port: %2").arg(_host).arg(_port));
 				break;
 			case QAbstractSocket::ConnectedState:
-				emit logMessage(QString("Connected to Hyperion: %1:%2").arg(_host).arg(_port));
+				emit logMessage(QString("Connected to %1, port: %2").arg(_host).arg(_port));
+				break;
+			case QAbstractSocket::ClosingState:
+				emit logMessage(QString("Closing connection to %1, port: %2").arg(_host).arg(_port));
 				break;
 			default:
-				emit logMessage(QString("Connecting to Hyperion: %1:%2").arg(_host).arg(_port));
 				break;
+
 		}
-	  _prevSocketState = _socket.state();
+	  	_prevSocketState = socketState;
 	}
 
-	if (_socket.state() == QAbstractSocket::ConnectedState)
+	if (socketState == QAbstractSocket::ConnectedState)
 	{
 		if(!_registered)
 		{

src/HyperionProperties.cpp

@@ -6,6 +6,13 @@
 
 #define CONFIG_SECTION "HyperionOutput"
 
+static void logger_message(void *data, calldata_t * cd)
+{
+	auto *page = static_cast<HyperionProperties*>(data);
+	const char* msg = calldata_string(cd, "msg");
+	page->appendLogText(msg);
+}
+
 HyperionProperties::HyperionProperties(QWidget *parent)
 	: QDialog(parent)
 	, ui(new Ui::HyperionProperties)
@@ -42,9 +49,14 @@ HyperionProperties::HyperionProperties(QWidget *parent)
 		int sizeDecimation = static_cast<int>(config_get_int(config, CONFIG_SECTION, OBS_SETTINGS_SIZEDECIMATION));
 		ui->SizeDecimation->setValue(sizeDecimation);
 	}
-	
+
 	enableStart(true);
 
+	signal_handler_t *handler = hyperion_get_signal_handler();
+	signal_handler_connect(handler, "start", OnStartSignal , this);
+	signal_handler_connect(handler, "stop", OnStopSignal , this);
+	signal_handler_connect(handler, "log", logger_message, this);
+
 	connect(ui->ButtonStart, &QPushButton::clicked, this, &HyperionProperties::saveSettings);
 	connect(ui->AutoStart, &QCheckBox::stateChanged, this, &HyperionProperties::saveSettings);
 
@@ -59,25 +71,36 @@ HyperionProperties::HyperionProperties(QWidget *parent)
 
 HyperionProperties::~HyperionProperties()
 {
+	signal_handler_t *handler = hyperion_get_signal_handler();
+	signal_handler_disconnect(handler, "start", OnStartSignal , this);
+	signal_handler_disconnect(handler, "stop", OnStopSignal , this);
+	signal_handler_disconnect(handler, "log", logger_message, this);
+
 	saveSettings();
 	hyperion_release();
+
 	delete ui;
 }
 
 void HyperionProperties::enableStart(bool enable)
 {
 	ui->ButtonStart->setEnabled(enable);
 	ui->ButtonStop->setEnabled(!enable);
+
+	ui->Address->setEnabled(enable);
+	ui->Port->setEnabled(enable);
+	ui->Priority->setEnabled(enable);
+	ui->SizeDecimation->setEnabled(enable);
 }
 
 void HyperionProperties::appendLogText(const char *msg)
 {
-	ui->WarningText->appendPlainText(msg);
+	ui->LogText->appendPlainText(msg);
 }
 
 void HyperionProperties::clearLog()
 {
-	ui->WarningText->clear();
+	ui->LogText->clear();
 }
 
 void HyperionProperties::saveSettings()
@@ -106,42 +129,24 @@ void HyperionProperties::onStart()
 	int priority = ui->Priority->value();
 	int sizeDecimation = ui->SizeDecimation->value();
 
-	signal_handler_t *handler = hyperion_get_signal_handler();
-	signal_handler_connect(handler, "stop", output_stopped , this);
-	signal_handler_connect(handler, "log", logger_message, this);
-	
-	enableStart(false);
-	clearLog();
 	hyperion_start_streaming(address, port, priority, sizeDecimation);
 }
 
 void HyperionProperties::onStop()
 {
+	enableStart(true);
 	hyperion_stop_streaming();
 }
 
-static void output_stopped(void *data, calldata_t *cd)
+void HyperionProperties::OnStartSignal(void *data, calldata_t *cd)
 {
-	auto *page = static_cast<HyperionProperties*>(data);
-	auto *output = static_cast<obs_output_t*>(calldata_ptr(cd, "output"));
-	bool running = calldata_bool(cd, "running");
-	const char* msg = calldata_string(cd, "msg");
-
-	if (running)
-	{
-		page->appendLogText(msg);
-	}
-	
-	signal_handler_t *handler = obs_output_get_signal_handler(output);
-	page->enableStart(true);
-	signal_handler_disconnect(handler, "stop", output_stopped, page);
-	signal_handler_disconnect(handler, "log", logger_message, page);
+	auto page = (HyperionProperties *)data;
+	page->clearLog();
+	page->enableStart(false);
 }
 
-static void logger_message(void *data, calldata_t *cd)
+void HyperionProperties::OnStopSignal(void *data, calldata_t *cd)
 {
-	UNUSED_PARAMETER(cd);
-	auto *page = static_cast<HyperionProperties*>(data);
-	const char* msg = calldata_string(cd, "msg");
-	page->appendLogText(msg);
+	auto page = (HyperionProperties *)data;
+	page->enableStart(true);
 }

src/HyperionProperties.h

@@ -32,9 +32,9 @@ public Q_SLOTS:
 
 private:
 	Ui::HyperionProperties *ui;
-};
 
-static void output_stopped(void *data, calldata_t *cd);
-static void logger_message(void *data, calldata_t *cd);
+	static void OnStartSignal(void *data, calldata_t *cd);
+	static void OnStopSignal(void *data, calldata_t *cd);
+};
 
 #endif // HYPERIONPROPERTIES_H