Merged branch staging into obs_merge_31.1.2

Author: avoitenko-logitech

.github/workflows/main.yml

@@ -24,7 +24,7 @@ env:
   SLGenerator: Visual Studio 17 2022
   SLDistributeDirectory: distribute
   SLFullDistributePath: "streamlabs-build.app/distribute" # The .app extension is required to run macOS tests correctly.
-  LibOBSVersion: 31.1.2test3
+  LibOBSVersion: 31.1.2test4
   PACKAGE_NAME: osn
 
 jobs:
@@ -82,12 +82,15 @@ jobs:
         run: node ci/bump-version.js "${{ steps.get_version.outputs.VERSION }}" "${{env.PACKAGE_PATH}}"
         env:
           PACKAGE_PATH: "${{env.SLFullDistributePath}}/${{env.InstallPath}}"
+      - name: Package compiled artifacts
+        run: |
+          tar -cvzf build-artifacts.tar.gz -C "${{env.SLBUILDDIRECTORY}}" .
       - name: Upload compiled artifacts
         uses: actions/upload-artifact@v4
         with:
           name: build-artifacts-mac-${{matrix.Architecture}}
           path: |
-            ${{env.SLBUILDDIRECTORY}}/
+            build-artifacts.tar.gz
             tests/osn-tests/osn/index.ts
 
   run-tests-macos:
@@ -131,11 +134,10 @@ jobs:
         with:
           name: build-artifacts-mac-${{matrix.Architecture}}
           path: .
-      - name: Set executable permissions
+      - name: Extract artifacts
         run: |
-          chmod +x streamlabs-build.app/distribute/obs-studio-node/bin/obs64
-          chmod +x streamlabs-build.app/distribute/obs-studio-node/crashpad_*
-        shell: bash
+          mkdir -p "${{env.SLBUILDDIRECTORY}}"
+          tar -xvzf build-artifacts.tar.gz -C "${{env.SLBUILDDIRECTORY}}"
       - name: 'Run tests'
         timeout-minutes: 30
         run: 'yarn run test'
@@ -173,6 +175,10 @@ jobs:
         with:
           name: build-artifacts-mac-${{matrix.Architecture}}
           path: .
+      - name: Extract artifacts
+        run: |
+          mkdir -p "${{env.SLBUILDDIRECTORY}}"
+          tar -xvzf build-artifacts.tar.gz -C "${{env.SLBUILDDIRECTORY}}"
       - name: Get the version
         id: get_version
         run: echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
@@ -226,6 +232,10 @@ jobs:
         with:
           name: build-artifacts-mac-${{matrix.Architecture}}
           path: .
+      - name: Extract artifacts
+        run: |
+          mkdir -p "${{env.SLBUILDDIRECTORY}}"
+          tar -xvzf build-artifacts.tar.gz -C "${{env.SLBUILDDIRECTORY}}"
       - name: Get the version
         id: get_version
         run: echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT

README.md

@@ -42,10 +42,10 @@ yarn install
 git submodule update --init --recursive
 mkdir build
 cd build
-cmake .. -DCMAKE_INSTALL_PREFIX=~/streamlabs/desktop/node_modules/obs-studio-node/OSN.app/distribute/obs-studio-node -DCMAKE_OSX_ARCHITECTURES=arm64 -G Xcode
+cmake .. -DCMAKE_INSTALL_PREFIX=/Users/<you>/streamlabs/desktop/node_modules/obs-studio-node/OSN.app/distribute/obs-studio-node -DCMAKE_OSX_ARCHITECTURES=arm64 -G Xcode
 cmake --build . --target install --config RelWithDebInfo
 ```
-Note, the only gotcha is that if you later run `yarn package:mac` command in the desktop folder instead, then you should remove *OSN.app* from the `CMAKE_INSTALL_PREFIX` path. This is because the electron-builder scripts will throw an error this is not a fully formed app bundle during codesign.
+Note, the only gotcha is that if you later run `yarn package:mac-arm64` command in the desktop folder instead, then you should remove *OSN.app* from the `CMAKE_INSTALL_PREFIX` path. This is because the electron-builder scripts will throw an error this is not a fully formed app bundle during codesign.
 
 ### Custom OBS Build
 By default, we download a pre-built version of libobs if none is specified. However, this pre-built version may not be what you want to use or maybe you're testing a new obs feature.

js/module.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeObs = exports.getSourcesSize = exports.createSources = exports.addItems = exports.AdvancedReplayBufferFactory = exports.SimpleReplayBufferFactory = exports.AudioEncoderFactory = exports.AdvancedRecordingFactory = exports.SimpleRecordingFactory = exports.AudioTrackFactory = exports.NetworkFactory = exports.ReconnectFactory = exports.DelayFactory = exports.AdvancedStreamingFactory = exports.SimpleStreamingFactory = exports.ServiceFactory = exports.VideoEncoderFactory = exports.IPC = exports.ModuleFactory = exports.AudioFactory = exports.Audio = exports.FaderFactory = exports.VolmeterFactory = exports.DisplayFactory = exports.TransitionFactory = exports.FilterFactory = exports.SceneFactory = exports.InputFactory = exports.VideoFactory = exports.Video = exports.Global = exports.DefaultPluginPathMac = exports.DefaultPluginDataPath = exports.DefaultPluginPath = exports.DefaultDataPath = exports.DefaultBinPath = exports.DefaultDrawPluginPath = exports.DefaultOpenGLPath = exports.DefaultD3D11Path = void 0;
-const obs = require('./obs_studio_client.node');
 const path = require("path");
 const fs = require("fs");
+// Mac- search for optional OSN.app bundle (Chromium requires an app bundle to find obs64 helper apps)
+const hasDeveloperApp = process.platform === 'darwin' && fs.existsSync(path.join(__dirname, 'OSN.app'));
+const obs = hasDeveloperApp
+  ? require('./OSN.app/distribute/obs-studio-node/obs_studio_client.node')
+  : require('./obs_studio_client.node');
 exports.DefaultD3D11Path = path.resolve(__dirname, `libobs-d3d11.dll`);
 exports.DefaultOpenGLPath = path.resolve(__dirname, `libobs-opengl.dll`);
 exports.DefaultDrawPluginPath = path.resolve(__dirname, `simple_draw.dll`);
@@ -117,7 +121,9 @@ function getSourcesSize(sourcesNames) {
     return sourcesSize;
 }
 exports.getSourcesSize = getSourcesSize;
-const __dirnameApple = fs.existsSync(__dirname + '/OSN.app') ? __dirname + '/OSN.app/distribute/obs-studio-node/bin' : __dirname + '/bin'; // search for local developer OSN.app bundle which stores CEF helper apps
+const __dirnameApple = hasDeveloperApp
+  ? path.join(__dirname, 'OSN.app', 'distribute', 'obs-studio-node', 'bin')
+  : path.join(__dirname, 'bin');
 if (fs.existsSync(path.resolve(__dirnameApple).replace('app.asar', 'app.asar.unpacked'))) {
     obs.IPC.setServerPath(path.resolve(__dirnameApple, `obs64`).replace('app.asar', 'app.asar.unpacked'), path.resolve(__dirnameApple).replace('app.asar', 'app.asar.unpacked'));
 }

js/module.ts

@@ -1,6 +1,10 @@
-const obs = require('./obs_studio_client.node');
 import * as path from 'path';
 import * as fs from 'fs';
+// Mac- search for optional OSN.app bundle (Chromium requires an app bundle to find obs64 helper apps)
+const hasDeveloperApp = process.platform === 'darwin' && fs.existsSync(path.join(__dirname, 'OSN.app'));
+const obs = hasDeveloperApp
+  ? require('./OSN.app/distribute/obs-studio-node/obs_studio_client.node')
+  : require('./obs_studio_client.node');
 
 /* Convenient paths to modules */
 export const DefaultD3D11Path: string =
@@ -1890,7 +1894,9 @@ export const enum VCamOutputType {
 };
 
 // Initialization and other stuff which needs local data.
-const __dirnameApple = fs.existsSync(__dirname + '/OSN.app') ? __dirname + '/OSN.app/distribute/obs-studio-node/bin' : __dirname + '/bin'; // search for local developer OSN.app bundle which stores CEF helper apps
+const __dirnameApple = hasDeveloperApp
+  ? path.join(__dirname, 'OSN.app', 'distribute', 'obs-studio-node', 'bin')
+  : path.join(__dirname, 'bin');
 if (fs.existsSync(path.resolve(__dirnameApple).replace('app.asar', 'app.asar.unpacked'))) {
     obs.IPC.setServerPath(path.resolve(__dirnameApple, `obs64`).replace('app.asar', 'app.asar.unpacked'), path.resolve(__dirnameApple).replace('app.asar', 'app.asar.unpacked'));
 }

obs-studio-client/source/nodeobs_service.cpp

@@ -268,6 +268,8 @@ int service::getServiceIdByName(std::string serviceName)
 		return 0;
 	} else if (serviceName == "vertical") {
 		return 1;
+	} else if (serviceName == "both") {
+		return 2;
 	}
 	return 0;
 }

obs-studio-server/source/main.cpp

@@ -212,7 +212,7 @@ int main(int argc, char *argv[])
 
 	// Check versions
 	if (receivedVersion != myVersion) {
-		std::cerr << "Versions mismatch. Server version: " << myVersion << "but received client version: " << receivedVersion;
+		std::cerr << "Versions mismatch. Server version: " << myVersion << " but received client version: " << receivedVersion << std::endl;
 		return ipc::ProcessInfo::ExitCode::VERSION_MISMATCH;
 	}
 

obs-studio-server/source/nodeobs_service.cpp

@@ -193,14 +193,23 @@ void OBS_service::OBS_service_setVideoInfo(void *data, const int64_t id, const s
 void OBS_service::OBS_service_startStreaming(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval)
 {
 	StreamServiceId serviceid = static_cast<StreamServiceId>(args[0].value_union.i64);
+	blog(LOG_INFO, "OBS_service_startStreaming - serviceid: %d", serviceid);
+
+	bool dualStreamingMode = false;
+	if (serviceid == StreamServiceId::Both) {
+		// Both is the special mode than needs to be implemented as a full scale service one day.
+		// For now for simplicity and compatibility we just fall back to the Main.
+		serviceid = StreamServiceId::Main;
+		dualStreamingMode = true;
+	}
 
 	if (isStreamingOutputActive(serviceid)) {
 		rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
 		AUTO_DEBUG;
 		return;
 	}
 
-	if (!startStreaming(serviceid)) {
+	if (!startStreaming(serviceid, dualStreamingMode)) {
 		PRETTY_ERROR_RETURN(ErrorCode::Error, "Failed to start streaming!");
 	} else {
 		rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
@@ -1354,9 +1363,9 @@ bool OBS_service::startSingleTrackStreaming(StreamServiceId serviceId)
 	return isStreaming[serviceId];
 }
 
-bool OBS_service::startMultiTrackStreaming(StreamServiceId serviceId)
+bool OBS_service::startMultiTrackStreaming(StreamServiceId serviceId, bool dualStreamingMode)
 {
-	blog(LOG_INFO, "startMultiTrackStreaming - serviceId: %d", serviceId);
+	blog(LOG_INFO, "startMultiTrackStreaming - serviceId: %d, dualStreamingMode: %d", serviceId, (int)dualStreamingMode);
 
 	const bool is_custom = strncmp("rtmp_custom", obs_service_get_type(services[serviceId]), 11) == 0;
 
@@ -1389,7 +1398,7 @@ bool OBS_service::startMultiTrackStreaming(StreamServiceId serviceId)
 
 	auto vod_track_mixer = IsVodTrackEnabled(services[serviceId]) ? std::optional{vodTrackIndex} : std::nullopt;
 
-	auto go_live_post = osn::constructGoLivePost(key, std::nullopt, std::nullopt, vod_track_mixer.has_value());
+	auto go_live_post = osn::constructGoLivePost(serviceId, dualStreamingMode, key, std::nullopt, std::nullopt, vod_track_mixer.has_value());
 	std::optional<osn::Config> go_live_config = osn::DownloadGoLiveConfig(auto_config_url, go_live_post);
 	if (!go_live_config.has_value()) {
 		throw std::runtime_error("startStreaming - go live config is empty");
@@ -1430,16 +1439,16 @@ bool OBS_service::startMultiTrackStreaming(StreamServiceId serviceId)
 	return isStreaming[serviceId];
 }
 
-bool OBS_service::startStreaming(StreamServiceId serviceId)
+bool OBS_service::startStreaming(StreamServiceId serviceId, bool dualStreamingMode)
 {
 	if (streamingOutput[serviceId]) {
 		obs_output_release(streamingOutput[serviceId]);
 		streamingOutput[serviceId] = nullptr;
 	}
 
 	try {
-		if (isTwitchStream(serviceId) && IsMultitrackVideoEnabled()) {
-			return startMultiTrackStreaming(serviceId);
+		if (isTwitchStream(serviceId) && (IsMultitrackVideoEnabled() || dualStreamingMode)) {
+			return startMultiTrackStreaming(serviceId, dualStreamingMode);
 		}
 
 		return startSingleTrackStreaming(serviceId);

obs-studio-server/source/nodeobs_service.h

@@ -91,7 +91,12 @@
 
 #define MAX_AUDIO_MIXES 6
 
-enum StreamServiceId : int { Main = 0, Second = 1 };
+/*
+ Main - is a horizontal canvas
+ Second - is a vertical one
+ Both - is a little bit special; it soes not create a service, but signals a special streaming mode.
+*/
+enum StreamServiceId : int { Main = 0, Second = 1, Both = 2 };
 
 class SignalInfo {
 private:
@@ -158,9 +163,9 @@ class OBS_service {
 	static void OBS_service_updateVirtualCam(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 
 private:
-	static bool startStreaming(StreamServiceId serviceId);
+	static bool startStreaming(StreamServiceId serviceId, bool dualStreamingMode);
 	static bool startSingleTrackStreaming(StreamServiceId serviceId);
-	static bool startMultiTrackStreaming(StreamServiceId serviceId);
+	static bool startMultiTrackStreaming(StreamServiceId serviceId, bool dualStreamingMode);
 	static void stopStreaming(bool forceStop, StreamServiceId serviceId);
 	static bool startRecording(void);
 	static bool startReplayBuffer(void);

obs-studio-server/source/nodeobs_settings.cpp

@@ -3898,17 +3898,24 @@ void getDevices(const char *source_id, const char *property_name, std::vector<ip
 		obs_data_set_string(settings, "audio_device_id", dummy_device_name);
 	}
 
-	auto props = obs_get_source_properties(source_id);
+	// Create a dummy source so that the "device" property can be init
+	auto dummy_source = obs_source_create(source_id, dummy_device_name, settings, nullptr);
+	if (!dummy_source) {
+		obs_data_release(settings);
+		return;
+	}
+
+	auto props = obs_source_properties(dummy_source);
 	if (!props) {
+		obs_source_release(dummy_source);
 		obs_data_release(settings);
-		blog(LOG_WARNING, "Could not get source properties for source id: %s", source_id);
 		return;
 	}
 
 	auto prop = obs_properties_get(props, property_name);
 	if (!prop) {
-		blog(LOG_WARNING, "Could not get the property [%s] for source id: %s", property_name, source_id);
 		obs_properties_destroy(props);
+		obs_source_release(dummy_source);
 		obs_data_release(settings);
 		return;
 	}
@@ -3934,6 +3941,7 @@ void getDevices(const char *source_id, const char *property_name, std::vector<ip
 
 	obs_properties_destroy(props);
 	obs_data_release(settings);
+	obs_source_release(dummy_source);
 }
 
 #ifdef WIN32

obs-studio-server/source/osn-multitrack-video-configuration.cpp

@@ -218,7 +218,7 @@ std::string MultitrackVideoAutoConfigURL(obs_service_t *service)
 	return url;
 }
 
-PostData constructGoLivePost(std::string streamKey, const std::optional<uint64_t> &maximum_aggregate_bitrate,
+PostData constructGoLivePost(StreamServiceId serviceId, bool dualStreamingMode, std::string streamKey, const std::optional<uint64_t> &maximum_aggregate_bitrate,
 			     const std::optional<uint32_t> &maximum_video_tracks, bool vod_track_enabled)
 {
 	PostData post_data{};
@@ -258,6 +258,17 @@ PostData constructGoLivePost(std::string streamKey, const std::optional<uint64_t
 	const size_t contexts = obs_get_video_info_count();
 	for (size_t i = 0; i < contexts; i++) {
 		if (obs_get_video_info_by_index(i, &ovi)) {
+			const bool isHorizontalCanvas = ovi.base_width >= ovi.base_height;
+			if (!dualStreamingMode && isHorizontalCanvas && serviceId != StreamServiceId::Main) {
+				blog(LOG_INFO, "constructGoLivePost - skipping horizontal canvas");
+				continue;
+			}
+
+			if (!dualStreamingMode && !isHorizontalCanvas && serviceId != StreamServiceId::Second) {
+				blog(LOG_INFO, "constructGoLivePost - skipping vertical canvas");
+				continue;
+			}
+
 			preferences.canvases.emplace_back(
 				Canvas{ovi.output_width, ovi.output_height, ovi.base_width, ovi.base_height, {ovi.fps_num, ovi.fps_den}});
 		}