Merged branch staging into obs_merge_31.0.3

Author: avoitenko-logitech

.github/workflows/main.yml

@@ -22,7 +22,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.0.3test3
+  LibOBSVersion: 31.0.3test4
   PACKAGE_NAME: osn
 
 jobs:

.gitignore

@@ -18,6 +18,7 @@ test-results.xml
 *.opendb
 docs/ 
 /*.log
+.vscode/
 streamlabs-build.app
 
 tests/osn-tests/*-cache-local.zip

obs-studio-client/source/nodeobs_service.cpp

@@ -27,6 +27,7 @@
 //#include <node.h>
 #include <sstream>
 #include <string>
+#include <fstream>
 #include "shared.hpp"
 #include "utility.hpp"
 #include "video.hpp"
@@ -420,6 +421,7 @@ Napi::Value service::OBS_service_updateVirtualCam(const Napi::CallbackInfo &info
 
 Napi::Value service::OBS_service_installVirtualCamPlugin(const Napi::CallbackInfo &info)
 {
+	bool isInstalled = true;
 #ifdef WIN32
 	SHELLEXECUTEINFO ShExecInfo = {0};
 	ShExecInfo.cbSize = sizeof(SHELLEXECUTEINFO);
@@ -445,9 +447,9 @@ Napi::Value service::OBS_service_installVirtualCamPlugin(const Napi::CallbackInf
 	WaitForSingleObject(ShExecInfo.hProcess, INFINITE);
 	CloseHandle(ShExecInfo.hProcess);
 #elif __APPLE__
-	return OBS_service_createVirtualCam(info);
+	isInstalled = g_util_osx->installPlugin();
 #endif
-	return info.Env().Undefined();
+	return Napi::Boolean::New(info.Env(), isInstalled);
 }
 
 Napi::Value service::OBS_service_uninstallVirtualCamPlugin(const Napi::CallbackInfo &info)
@@ -477,9 +479,7 @@ Napi::Value service::OBS_service_uninstallVirtualCamPlugin(const Napi::CallbackI
 	WaitForSingleObject(ShExecInfo.hProcess, INFINITE);
 	CloseHandle(ShExecInfo.hProcess);
 #elif __APPLE__
-	// User must manually uninstall the Apple SystemExtension (new obs-virtualcam)
-	// but we can uninstall the legacy DAL plugin if its there.
-	g_util_osx->uninstallPlugin(); // uninstall legacy plugin
+	g_util_osx->uninstallPlugin();
 #endif
 	return info.Env().Undefined();
 }
@@ -490,20 +490,45 @@ Napi::Value service::OBS_service_isVirtualCamPluginInstalled(const Napi::Callbac
 	HKEY OpenResult;
 	LONG error;
 
-	error = RegOpenKeyEx(HKEY_CLASSES_ROOT, L"CLSID\\{27B05C2D-93DC-474A-A5DA-9BBA34CB2A9C}", 0, KEY_READ | KEY_WOW64_64KEY, &OpenResult);
+	const char *prefix = "CLSID\\{";
+	std::string line = "";
+	std::string guid = "";
+	size_t pos = 0;
+	size_t endPos = 0;
+
+	//open install file and search for the correct GUID
+	std::wstring batPath = utfWorkingDir + L"\\data\\obs-plugins\\win-dshow\\virtualcam-install.bat";
+	std::ifstream batFile(batPath.c_str());
+	if (batFile.is_open()) {
+		while (std::getline(batFile, line)) {
+			pos = line.find(prefix);
+			if (pos != std::string::npos) {
+				pos += strlen(prefix);
+				endPos = line.find("}");
+				guid = line.substr(pos, endPos - pos);
+				guid.insert(0, prefix);
+				guid.append("}");
+				break;
+			}
+		}
+		batFile.close();
+	}
+
+	std::wstring wideGUID(from_utf8_to_utf16_wide(guid.c_str()));
+	error = RegOpenKeyEx(HKEY_CLASSES_ROOT, wideGUID.c_str(), 0, KEY_READ | KEY_WOW64_64KEY, &OpenResult);
 	if (error != ERROR_SUCCESS) {
 		return Napi::Number::New(info.Env(), VcamInstalledStatus::NotInstalled);
 	}
 
-	error = RegOpenKeyEx(HKEY_CLASSES_ROOT, L"CLSID\\{27B05C2D-93DC-474A-A5DA-9BBA34CB2A9C}", 0, KEY_READ | KEY_WOW64_32KEY, &OpenResult);
+	error = RegOpenKeyEx(HKEY_CLASSES_ROOT, wideGUID.c_str(), 0, KEY_READ | KEY_WOW64_32KEY, &OpenResult);
 	if (error != ERROR_SUCCESS) {
 		return Napi::Number::New(info.Env(), VcamInstalledStatus::NotInstalled);
 	}
 
 	DWORD dwRet = 0;
 	TCHAR buf[TOTALBYTES] = {0};
 	DWORD dwBufSize = sizeof(buf);
-	error = RegOpenKeyEx(HKEY_CLASSES_ROOT, L"CLSID\\{27B05C2D-93DC-474A-A5DA-9BBA34CB2A9C}\\InprocServer32", 0, KEY_READ | KEY_QUERY_VALUE, &OpenResult);
+	error = RegOpenKeyEx(HKEY_CLASSES_ROOT, wideGUID.c_str(), 0, KEY_READ | KEY_QUERY_VALUE, &OpenResult);
 	if (error == ERROR_SUCCESS && OpenResult) {
 		dwRet = RegQueryValueExW(OpenResult, TEXT(""), NULL, NULL, (LPBYTE)buf, &dwBufSize);
 		if (dwRet == ERROR_SUCCESS) {

obs-studio-client/source/util-osx-impl.mm

@@ -21,6 +21,85 @@
 
 std::string g_server_working_dir;
 
+void uninstallLegacyDALPlugin()
+{
+	@try {
+		NSDictionary *error = [NSDictionary dictionary];
+		std::string cmd = "do shell script \"rm -rf /Library/CoreMediaIO/Plug-Ins/DAL/vcam-plugin.plugin \" with administrator privileges";
+
+		NSString *script = [NSString stringWithCString:cmd.c_str() encoding:[NSString defaultCStringEncoding]];
+		NSAppleScript *run = [[NSAppleScript alloc] initWithSource:script];
+		[run executeAndReturnError:&error];
+		NSLog(@"errors: %@", error);
+	} @catch (NSException *exception) {
+		std::cout << "Caught an NSException!" << std::endl;
+		std::cout << "Name: " << [[exception name] UTF8String] << std::endl;
+		std::cout << "Reason: " << [[exception reason] UTF8String] << std::endl;
+	}
+}
+
+bool executeTaskAndCaptureOutput(const std::string &path, NSArray<NSString *> *exeArguments = nullptr)
+{
+	bool success = true;
+	@autoreleasepool {
+		@try {
+			// Create an NSTask instance
+			NSTask *task = [[NSTask alloc] init];
+
+			// Set the launch path (program to execute)
+			NSString *exePath = [NSString stringWithCString:path.c_str() encoding:[NSString defaultCStringEncoding]];
+			task.launchPath = exePath; // Command (e.g., "ls")
+			if (exeArguments && exeArguments.count > 0) {
+				task.arguments = exeArguments;
+			}
+
+			// Set up a pipe to capture the output
+			NSPipe *outputPipe = [NSPipe pipe];
+			task.standardOutput = outputPipe; // Redirect standard output to the pipe
+			task.standardError = outputPipe;  // Optional: Redirect errors as well
+
+			[task launch];
+			[task waitUntilExit];
+
+			int exitCode = [task terminationStatus];
+
+			// Read the data from the pipe
+			NSFileHandle *readHandle = [outputPipe fileHandleForReading];
+			NSData *outputData = [readHandle readDataToEndOfFile];
+
+			// Convert the data to a string
+			NSString *outputString = [[NSString alloc] initWithData:outputData encoding:NSUTF8StringEncoding];
+
+			// Print the captured output
+			std::cout << "Child process output:\n" << [outputString UTF8String] << std::endl;
+			std::cout << "Child process exited with code: " << exitCode << std::endl;
+		} @catch (NSException *exception) {
+			std::cout << "Caught an NSException!" << std::endl;
+			std::cout << "Name: " << [[exception name] UTF8String] << std::endl;
+			std::cout << "Reason: " << [[exception reason] UTF8String] << std::endl;
+			success = false;
+		}
+	}
+	return success;
+}
+
+// In our app bundle, we will search for the slobs-virtual-cam-installer.app which
+// exclusively handles installing/uninstalling the mac camera system extension.
+std::string getInstallerAppPath()
+{
+	NSString *bundlePath = [[NSBundle mainBundle] bundlePath];
+	std::string app_framework_path = bundlePath.UTF8String;
+	char delimiter = '/';
+
+	size_t last_occurrence_pos = app_framework_path.rfind(delimiter);
+
+	if (last_occurrence_pos != std::string::npos) {
+		app_framework_path.erase(last_occurrence_pos + 1); // Erase from after the delimiter
+	}
+	app_framework_path += "slobs-virtual-cam-installer.app/Contents/MacOS/slobs-virtual-cam-installer";
+	return app_framework_path;
+}
+
 @implementation UtilImplObj
 
 UtilObjCInt::UtilObjCInt(void) : self(NULL) {}
@@ -90,32 +169,19 @@ bool replace(std::string &str, const std::string &from, const std::string &to)
 	return true;
 }
 
-void UtilObjCInt::installPlugin()
+bool UtilObjCInt::installPlugin()
 {
-	NSDictionary *error = [NSDictionary dictionary];
-	std::string pathToScript = g_server_working_dir + "/data/obs-plugins/slobs-virtual-cam/install-plugin.sh";
-	std::cout << "launching: " << pathToScript.c_str() << std::endl;
-
-	replace(pathToScript, " ", "\\\\ ");
-	std::string arg = g_server_working_dir + "/data/obs-plugins/slobs-virtual-cam";
-	replace(arg, " ", "\\\\ ");
-	std::string cmd = "do shell script \"/bin/sh " + pathToScript + " " + arg + "\" with administrator privileges";
-
-	NSString *script = [NSString stringWithCString:cmd.c_str() encoding:[NSString defaultCStringEncoding]];
-	NSAppleScript *run = [[NSAppleScript alloc] initWithSource:script];
-	[run executeAndReturnError:&error];
-	NSLog(@"errors: %@", error);
+	const std::string path = getInstallerAppPath();
+	return executeTaskAndCaptureOutput(path); // Run the installer
 }
 
 void UtilObjCInt::uninstallPlugin()
 {
-	NSDictionary *error = [NSDictionary dictionary];
-	std::string cmd = "do shell script \"rm -rf /Library/CoreMediaIO/Plug-Ins/DAL/vcam-plugin.plugin \" with administrator privileges";
+	// Uninstall the camera system extension
+	const std::string path = getInstallerAppPath();
+	return executeTaskAndCaptureOutput(path, @[@"--deactivate"]); // Run the uninstaller
 
-	NSString *script = [NSString stringWithCString:cmd.c_str() encoding:[NSString defaultCStringEncoding]];
-	NSAppleScript *run = [[NSAppleScript alloc] initWithSource:script];
-	[run executeAndReturnError:&error];
-	NSLog(@"errors: %@", error);
+	uninstallLegacyDALPlugin();
 }
 
 bool UtilObjCInt::isPluginInstalled()
@@ -132,7 +198,9 @@ bool replace(std::string &str, const std::string &from, const std::string &to)
 			// Read the output from the command execution
 			while (fgets(buffer.data(), buffer.size(), pipe) != nullptr) {
 				std::string text(buffer.data());
-				if (text.find("com.streamlabs.slobs.mac-camera-extension") != std::string::npos) {
+				// Edge case- if it shows "terminated waiting to uninstall on reboot" then technically the plugin was uninstalled.
+				if ((text.find("com.streamlabs.slobs.mac-camera-extension") != std::string::npos) &&
+				    (text.find("terminated waiting to uninstall on reboot") == std::string::npos)) {
 					isInstalled = true;
 				}
 			}

obs-studio-client/source/util-osx-int.h

@@ -37,7 +37,7 @@ class UtilObjCInt {
 	void init(void);
 	void getPermissionsStatus(bool &webcam, bool &mic);
 	void requestPermissions(void *async_cb, perms_cb cb);
-	void installPlugin(void);
+	bool installPlugin(void);
 	void uninstallPlugin(void);
 	void setServerWorkingDirectoryPath(std::string path);
 	bool isPluginInstalled();

obs-studio-client/source/util-osx.cpp

@@ -44,7 +44,7 @@ void UtilInt::requestPermissions(void *async_cb, perms_cb cb)
 	_impl->requestPermissions(async_cb, cb);
 }
 
-void UtilInt::installPlugin(void)
+bool UtilInt::installPlugin(void)
 {
 	_impl->installPlugin();
 }

obs-studio-client/source/util-osx.hpp

@@ -33,7 +33,7 @@ class UtilInt {
 	void init(void);
 	void getPermissionsStatus(bool &webcam, bool &mic);
 	void requestPermissions(void *async_cb, perms_cb cb);
-	void installPlugin(void);
+	bool installPlugin(void);
 	void uninstallPlugin(void);
 	void setServerWorkingDirectoryPath(std::string path);
 	bool isPluginInstalled();

obs-studio-server/source/nodeobs_autoconfig.cpp

@@ -59,7 +59,7 @@ Encoder recordingEncoder = Encoder::Stream;
 Encoder streamingEncoder = Encoder::x264;
 Type type = Type::Streaming;
 FPSType fpsType = FPSType::PreferHighFPS;
-uint64_t idealBitrate = 2500;
+uint64_t idealBitrate = 4500;
 uint64_t baseResolutionCX = 1920;
 uint64_t baseResolutionCY = 1080;
 uint64_t idealResolutionCX = 1280;
@@ -78,7 +78,7 @@ bool qsvAvailable = false;
 bool vceAvailable = false;
 bool appleHWAvailable = false;
 
-int startingBitrate = 2500;
+int startingBitrate = 4500;
 bool customServer = false;
 bool bandwidthTest = true;
 bool testRegions = true;
@@ -1457,7 +1457,7 @@ void autoConfig::SetDefaultSettings(void)
 	idealResolutionCY = 720;
 	idealFPSNum = 30;
 	recordingQuality = Quality::High;
-	idealBitrate = 2500;
+	idealBitrate = 4500;
 	streamingEncoder = Encoder::x264;
 	recordingEncoder = Encoder::Stream;
 

obs-studio-server/source/nodeobs_configManager.cpp

@@ -125,7 +125,7 @@ void initBasicDefault(config_t *config)
 	std::string filePath = GetDefaultVideoSavePath();
 	config_set_default_string(config, "SimpleOutput", "FilePath", filePath.c_str());
 	config_set_default_string(config, "SimpleOutput", "RecFormat", "mp4");
-	config_set_default_uint(config, "SimpleOutput", "VBitrate", 2500);
+	config_set_default_uint(config, "SimpleOutput", "VBitrate", 4500);
 	config_set_default_string(config, "SimpleOutput", "StreamEncoder", SIMPLE_ENCODER_X264);
 
 	config_set_default_uint(config, "SimpleOutput", "ABitrate", 160);
@@ -160,7 +160,7 @@ void initBasicDefault(config_t *config)
 	config_set_default_bool(config, "AdvOut", "FFOutputToFile", true);
 	config_set_default_string(config, "AdvOut", "FFFilePath", GetDefaultVideoSavePath().c_str());
 	config_set_default_string(config, "AdvOut", "FFExtension", "mp4");
-	config_set_default_uint(config, "AdvOut", "FFVBitrate", 2500);
+	config_set_default_uint(config, "AdvOut", "FFVBitrate", 4500);
 	config_set_default_uint(config, "AdvOut", "FFVGOPSize", 250);
 	config_set_default_bool(config, "AdvOut", "FFUseRescale", false);
 	config_set_default_bool(config, "AdvOut", "FFIgnoreCompat", false);

obs-studio-server/source/nodeobs_service.cpp

@@ -2051,7 +2051,7 @@ void OBS_service::updateVideoStreamingEncoder(bool isSimpleMode, StreamServiceId
 		}
 
 		if (videoBitrate == 0) {
-			videoBitrate = 2500;
+			videoBitrate = 4500;
 			config_set_uint(ConfigManager::getInstance().getBasic(), "SimpleOutput", "VBitrate", videoBitrate);
 			config_save_safe(ConfigManager::getInstance().getBasic(), "tmp", nullptr);
 		}