util-osx: init cef before [app run] (#1614)

* Apparently CEF 6533 (obs31.1) is a bit more strict how it is
initialized. Now CefInitialize() will be invoked before
NSApplication is instantiated.

Author: sandboxcoder

obs-studio-server/source/nodeobs_api.cpp

@@ -1049,6 +1049,13 @@ void OBS_API::OBS_API_initAPI(void *data, const int64_t id, const std::vector<ip
 	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
 	rval.push_back(ipc::value(OBS_VIDEO_SUCCESS));
 
+#if defined(__APPLE__)
+	// Block until CEF has been initialized by the main thread.
+	g_util_osx->nextState();
+	while (!g_util_osx->hasInitCef()) {
+		std::this_thread::sleep_for(std::chrono::milliseconds(50));
+	}
+#endif
 	AUTO_DEBUG;
 }
 

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

@@ -17,6 +17,7 @@
 ******************************************************************************/
 
 #include "util-osx-impl.h"
+#include "obs.h"
 #include <iostream>
 #include <unistd.h>
 #include <sys/types.h>
@@ -43,13 +44,13 @@
 		return;
 
 	while (true) {
-		if (!appRunning) {
+		if (state == UtilObjCInt::EState::Stop) {
 			break;
 		}
 		int ret = ::read(file_descriptor, buffer.data(), count);
 		if (ret > 0) {
 			bool appCrashed = *reinterpret_cast<bool *>(buffer.data());
-			if (appCrashed && appRunning)
+			if (appCrashed && state != UtilObjCInt::EState::Stop)
 				this->stopApplication();
 			break;
 		}
@@ -86,17 +87,33 @@ @implementation UtilImplObj
 
 void UtilObjCInt::runApplication(void)
 {
-	worker = new std::thread(&UtilObjCInt::wait_terminate, this);
+	// Wait for OBS_API_initAPI to be invoked
+	while (!hasInitApi() && isRunning()) {
+		std::this_thread::sleep_for(std::chrono::milliseconds(50));
+	}
+	if (isRunning()) {
+		// Create a dummy source to init obs-browser plugin. Must be init from main thread before [NSApplication run]
+		obs_source_t *source = obs_source_create("browser_source", "dummy", NULL, NULL);
+		obs_source_release(source);
+		nextState();
 
-	@autoreleasepool {
-		NSApplication *app = [NSApplication sharedApplication];
-		appRunning = true;
-		[app run];
+		worker = new std::thread(&UtilObjCInt::wait_terminate, this);
+
+		@autoreleasepool {
+			NSApplication *app = [NSApplication sharedApplication];
+			[app run];
+		}
 	}
 }
 
 void UtilObjCInt::stopApplication(void)
 {
+	if (!hasInitCef()) {
+		state = UtilObjCInt::EState::Stop;
+		return;
+	} else {
+		state = UtilObjCInt::EState::Stop;
+	}
 	dispatch_async(dispatch_get_main_queue(), ^{
 		[[NSApplication sharedApplication] stop:nil];
 		NSEvent *event = [NSEvent otherEventWithType:NSEventTypeApplicationDefined
@@ -110,12 +127,17 @@ @implementation UtilImplObj
 						       data2:0];
 		[NSApp postEvent:event atStart:TRUE];
 
-		appRunning = false;
+		state = UtilObjCInt::EState::Stop;
 		if (worker->joinable())
 			worker->join();
 	});
 }
 
+bool UtilObjCInt::isRunning(void)
+{
+	return state != UtilObjCInt::EState::Stop;
+}
+
 unsigned long long UtilObjCInt::getTotalPhysicalMemory(void)
 {
 	return [NSProcessInfo processInfo].physicalMemory;
@@ -191,4 +213,22 @@ @implementation UtilImplObj
 		return 0;
 	return physical_cores;
 }
+
+void UtilObjCInt::nextState(void)
+{
+	if (state + 1 < UtilObjCInt::EState::Max) {
+		state = state + 1;
+	}
+}
+
+bool UtilObjCInt::hasInitApi(void)
+{
+	return state == UtilObjCInt::EState::InitializedApi;
+}
+
+bool UtilObjCInt::hasInitCef(void)
+{
+	return state == UtilObjCInt::EState::InitializedCEF;
+}
+
 @end

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

@@ -32,6 +32,7 @@ class UtilObjCInt {
 	std::string getDefaultVideoSavePath(void);
 	void runApplication(void);
 	void stopApplication(void);
+	bool isRunning(void);
 	unsigned long long getTotalPhysicalMemory(void);
 	unsigned long long getAvailableMemory(void);
 	std::vector<std::pair<uint32_t, uint32_t>> getAvailableScreenResolutions(void);
@@ -40,10 +41,20 @@ class UtilObjCInt {
 	std::string getComputerName(void);
 	int getPhysicalCores(void);
 	void wait_terminate(void);
+	void nextState(void);
+	bool hasInitApi(void);
+	bool hasInitCef(void);
 
 private:
+	enum EState {
+		Idle = 0,
+		InitializedApi, // Was initAPI invoked?
+		InitializedCEF, // Was CefInitialize() invoked?
+		Stop,
+		Max
+	};
 	void *self;
-	std::atomic<bool> appRunning;
+	std::atomic<int> state; // See EState enum. Tracks application state
 	std::thread *worker;
 };
 

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

@@ -49,6 +49,11 @@ void UtilInt::stopApplication(void)
 	_impl->stopApplication();
 }
 
+bool UtilInt::isRunning(void)
+{
+	return _impl->isRunning();
+}
+
 unsigned long long UtilInt::getTotalPhysicalMemory(void)
 {
 	return _impl->getTotalPhysicalMemory();
@@ -83,3 +88,18 @@ int UtilInt::getPhysicalCores(void)
 {
 	return _impl->getPhysicalCores();
 }
+
+void UtilInt::nextState(void)
+{
+	_impl->nextState();
+}
+
+bool UtilInt::hasInitApi(void)
+{
+	return _impl->hasInitApi();
+}
+
+bool UtilInt::hasInitCef(void)
+{
+	return _impl->hasInitCef();
+}

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

@@ -33,13 +33,17 @@ class UtilInt {
 	std::string getDefaultVideoSavePath(void);
 	void runApplication(void);
 	void stopApplication(void);
+	bool isRunning(void);
 	unsigned long long getTotalPhysicalMemory(void);
 	unsigned long long getAvailableMemory(void);
 	std::vector<std::pair<uint32_t, uint32_t>> getAvailableScreenResolutions(void);
 	std::string getUserDataPath(void);
 	std::string getWorkingDirectory(void);
 	std::string getComputerName(void);
 	int getPhysicalCores(void);
+	void nextState(void);
+	bool hasInitApi(void);
+	bool hasInitCef(void);
 
 private:
 	UtilObjCInt *_impl;

tests/osn-tests/src/test_osn_input.ts

@@ -81,6 +81,16 @@ describe(testName, () => {
         });
     });
 
+    it('Create Browser source and verify Chromium Embedded Framework (CEF) functionality', () => {
+        const input = osn.InputFactory.create(EOBSInputTypes.BrowserSource, 'input');
+
+        // Checking if input source was created correctly
+        expect(input).to.not.equal(undefined, GetErrorMessage(ETestErrorMsg.CreateInput, EOBSInputTypes.BrowserSource));
+        expect(input.id).to.equal(EOBSInputTypes.BrowserSource, GetErrorMessage(ETestErrorMsg.InputId, EOBSInputTypes.BrowserSource));
+        expect(input.name).to.equal('input', GetErrorMessage(ETestErrorMsg.InputName, EOBSInputTypes.BrowserSource));
+        input.release();
+    });
+
     it('Create all types of input with settings parameter', () => {
         // Create all input sources available with settings parameter
         obs.inputTypes.forEach(function(inputType) {