Merge pull request #37 from DDRBoxman/scenecallback

OsirisNL · web-flow · commit ebcb12fca063 · 2016-09-12T13:21:56.000+02:00
Scene change js callback
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -5,6 +5,8 @@ project(cef-isolation)
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}")
 set(CMAKE_INCLUDE_CURRENT_DIR TRUE)
 
+include_directories(SYSTEM "${CMAKE_SOURCE_DIR}/UI/obs-frontend-api")
+
 include(BSUtils)
 
 find_package(LibObs REQUIRED)
@@ -108,7 +110,8 @@ else (APPLE)
 endif(APPLE)
 
 set(obs-browser_LIBRARIES
-	libobs)
+	libobs
+	obs-frontend-api)
 
 if (APPLE)
 	list(APPEND obs-browser_LIBRARIES
diff --git a/README.md b/README.md
@@ -19,7 +19,19 @@ window.obsstudio.pluginVersion
  *
  * @param {bool} visiblity - True -> visible, False -> hidden
  */
-window.obsstudio.onVisibilityChange(visiblity) {
+window.obsstudio.onVisibilityChange = function(visiblity) {
+	
+};
+```
+
+### Register for scene change callbacks
+```
+/**
+ * onSceneChange gets callbacks when the scene is changed
+ *
+ * @param {string} sceneName - The name of the scene that was changed to.
+ */
+window.obsstudio.onSceneChange = function(sceneName) {
 	
 };
 ```
diff --git a/cef-isolation/cef-isolated-client.mm b/cef-isolation/cef-isolated-client.mm
@@ -133,6 +133,16 @@ - (void)sendEvent:(const int)browserIdentifier
 	}
 }
 
+- (void)sendEventToAllBrowsers:(event_block_t)event
+{
+    for (auto& x: map) {
+		SharedBrowserHandle browserHandle = x.second;
+		sync_on_cef_ui(^{
+			event(browserHandle);
+		});
+	}
+}
+
 - (void)sendMouseClick:(const int)browserIdentifier
 	event:(ObsMouseEventBridge *)event type:(const int)type
 	mouseUp:(BOOL)mouseUp clickCount:(const int)clickCount
@@ -301,6 +311,19 @@ - (void)executeVisiblityJSCallback:(const int)browserIdentifier visible:(BOOL)vi
 	}];
 }
 
+- (void)executeSceneChangeJSCallback:(const char *)name
+{
+	[self sendEventToAllBrowsers:^(SharedBrowserHandle browserHandle)
+	{
+		CefRefPtr<CefBrowser> browser = browserHandle->GetBrowser();
+
+		CefRefPtr<CefProcessMessage> msg = CefProcessMessage::Create("SceneChange");
+		CefRefPtr<CefListValue> args = msg->GetArgumentList();
+		args->SetString(0, name);
+		browser->SendProcessMessage(PID_RENDERER, msg);
+	}];
+}
+
 - (void)destroyBrowser:(const int)browserIdentifier {
 	if (map.count(browserIdentifier) == 1) {
 		std::shared_ptr<BrowserHandle> browserHandle =
@@ -312,4 +335,4 @@ - (void)destroyBrowser:(const int)browserIdentifier {
 	}
 }
 
-@end
+@end
diff --git a/obs-browser/apple/browser-manager-mac.h b/obs-browser/apple/browser-manager-mac.h
@@ -52,6 +52,8 @@ class BrowserManager::Impl {
 	
 	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
 
+	void ExecuteSceneChangeJSCallback(const char *name);
+
 private:
 	std::unique_ptr<CEFIsolationServiceManager> cefIsolationServiceManager;
 };
diff --git a/obs-browser/apple/browser-manager-mac.mm b/obs-browser/apple/browser-manager-mac.mm
@@ -86,6 +86,11 @@
 	pimpl->ExecuteVisiblityJSCallback(browserIdentifier, visible);
 }
 
+void BrowserManager::ExecuteSceneChangeJSCallback(const char *name)
+{
+	pimpl->ExecuteSceneChangeJSCallback(name);
+}
+
 int BrowserManager::CreateBrowser(const BrowserSettings &browserSettings,
 		const std::shared_ptr<BrowserListener> &browserListener)
 {
@@ -171,6 +176,11 @@
 	cefIsolationServiceManager->ExecuteVisiblityJSCallback(browserIdentifier, visible);
 }
 
+void BrowserManager::Impl::ExecuteSceneChangeJSCallback(const char *name)
+{
+	cefIsolationServiceManager->ExecuteSceneChangeJSCallback(name);
+}
+
 static BrowserManager *instance;
 
 BrowserManager *BrowserManager::Instance()
diff --git a/obs-browser/apple/cef-isolation-service-manager.h b/obs-browser/apple/cef-isolation-service-manager.h
@@ -58,6 +58,8 @@ class CEFIsolationServiceManager {
 
 	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
 
+	void ExecuteSceneChangeJSCallback(const char *name);
+
 public:
 	NSString *GetUniqueClientName() { return _uniqueClientName; }
 
diff --git a/obs-browser/apple/cef-isolation-service-manager.mm b/obs-browser/apple/cef-isolation-service-manager.mm
@@ -245,3 +245,13 @@
 	}
 	@catch (NSException *exception) {}
 }
+
+void CEFIsolationServiceManager::ExecuteSceneChangeJSCallback(const char *name)
+{
+	id<CEFIsolatedClient> cefIsolatedClient =
+		[_cefIsolationService client];
+	@try {
+		[cefIsolatedClient executeSceneChangeJSCallback:name];
+	}
+	@catch (NSException *exception) {}
+}
diff --git a/obs-browser/apple/texture-ref.hpp b/obs-browser/apple/texture-ref.hpp
@@ -19,6 +19,7 @@
 
 #include <obs-module.h>
 #import <Foundation/Foundation.h>
+#import <IOSurface/IOSurfaceAPI.h>
 
 class TextureRef {
 public:
@@ -43,4 +44,4 @@ class TextureRef {
 private:
 	IOSurfaceRef ioSurfaceRef;
 	gs_texture_t *texture;
-};
+};
diff --git a/obs-browser/browser-manager-base.cpp b/obs-browser/browser-manager-base.cpp
@@ -80,6 +80,11 @@ void BrowserManager::ExecuteVisiblityJSCallback(int browserIdentifier, bool visi
 	pimpl->ExecuteVisiblityJSCallback(browserIdentifier, visible);
 }
 
+void BrowserManager::ExecuteSceneChangeJSCallback(const char *name)
+{
+	pimpl->ExecuteSceneChangeJSCallback(name);
+}
+
 BrowserManager::Impl::Impl()
 {
 	os_event_init(&dispatchEvent, OS_EVENT_TYPE_AUTO);
@@ -184,6 +189,29 @@ void BrowserManager::Impl::ExecuteOnBrowser(int browserIdentifier,
 	}
 }
 
+void BrowserManager::Impl::ExecuteOnAllBrowsers(
+	std::function<void(CefRefPtr<CefBrowser>)> f, 
+			bool async)
+{
+	for (auto& x: browserMap) {
+		CefRefPtr<CefBrowser> browser = x.second;
+		if (async) {
+			CefPostTask(TID_UI, BrowserTask::newTask([&] {
+				f(browser);
+			}));
+		} else {
+			os_event_t *finishedEvent;
+			os_event_init(&finishedEvent, OS_EVENT_TYPE_AUTO);
+			CefPostTask(TID_UI, BrowserTask::newTask([&] {
+				f(browser);
+				os_event_signal(finishedEvent);
+			}));
+			os_event_wait(finishedEvent);
+			os_event_destroy(finishedEvent);
+		}
+	}
+}
+
 void BrowserManager::Impl::SendMouseClick(int browserIdentifier,
 	const struct obs_mouse_event *event, int32_t type,
 	bool mouse_up, uint32_t click_count)
@@ -283,6 +311,17 @@ void BrowserManager::Impl::ExecuteVisiblityJSCallback(int browserIdentifier, boo
 	});
 }
 
+void BrowserManager::Impl::ExecuteSceneChangeJSCallback(const char *name)
+{
+	ExecuteOnAllBrowsers([&](CefRefPtr<CefBrowser> b)
+	{
+		CefRefPtr<CefProcessMessage> msg = CefProcessMessage::Create("SceneChange");
+		CefRefPtr<CefListValue> args = msg->GetArgumentList();
+		args->SetString(0, name);
+		b->SendProcessMessage(PID_RENDERER, msg);
+	});
+}
+
 void
 BrowserManager::Impl::Startup() 
 {
diff --git a/obs-browser/browser-manager-base.hpp b/obs-browser/browser-manager-base.hpp
@@ -56,11 +56,16 @@ class BrowserManager::Impl
 
 	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
 
+	void ExecuteSceneChangeJSCallback(const char *name);
+
 private: 
 	void ExecuteOnBrowser(int browserIdentifier, 
 			std::function<void(CefRefPtr<CefBrowser>)> f, 
 			bool async = false);
 
+	void ExecuteOnAllBrowsers(std::function<void(CefRefPtr<CefBrowser>)> f, 
+			bool async = false);
+
 private:
 	bool threadAlive;
 	os_event_t *dispatchEvent;
diff --git a/obs-browser/main.cpp b/obs-browser/main.cpp
@@ -16,6 +16,7 @@
  ******************************************************************************/
 
 #include <obs-module.h>
+#include <obs-frontend-api.h>
 
 #include "browser-version.h"
 #include "browser-manager.hpp"
@@ -26,6 +27,20 @@ OBS_MODULE_USE_DEFAULT_LOCALE("obs-browser", "en-US")
 extern struct obs_source_info create_browser_source_info();
 struct obs_source_info browser_source_info;
 
+// Handle events from the frontend
+static void handle_obs_frontend_event(enum obs_frontend_event event, void *)
+{
+	if (event == OBS_FRONTEND_EVENT_SCENE_CHANGED) {
+
+		obs_source_t *source = obs_frontend_get_current_scene();
+
+		const char *name = obs_source_get_name(source);
+
+		BrowserManager::Instance()->ExecuteSceneChangeJSCallback(name);
+		obs_source_release(source);
+	}
+}
+
 bool obs_module_load(void)
 {
     blog(LOG_INFO, "[browser_source: 'Version: %s']", OBS_BROWSER_VERSION);
@@ -37,6 +52,7 @@ bool obs_module_load(void)
 
 	BrowserManager::Instance()->Startup();
 	obs_register_source(&browser_source_info);
+	obs_frontend_add_event_callback(handle_obs_frontend_event, nullptr);
 
 	return true;
 }
@@ -46,4 +62,4 @@ void obs_module_unload()
 	BrowserManager::Instance()->Shutdown();
 	BrowserManager::Instance()->SetModulePath(nullptr);
 	BrowserManager::DestroyInstance();
-}
+}
diff --git a/shared/browser-app.cpp b/shared/browser-app.cpp
@@ -71,33 +71,47 @@ void BrowserApp::OnContextCreated(CefRefPtr<CefBrowser> browser,
 	obsStudioObj->SetValue("pluginVersion", pluginVersion, V8_PROPERTY_ATTRIBUTE_NONE);
 }
 
+void BrowserApp::ExecuteJSFunction(CefRefPtr<CefBrowser> browser,
+		const char *functionName,
+		CefV8ValueList arguments)
+{
+	CefRefPtr<CefV8Context> context = browser->GetMainFrame()->GetV8Context();
+
+	context->Enter();
+	
+	CefRefPtr<CefV8Value> globalObj = context->GetGlobal();
+
+	CefRefPtr<CefV8Value> obsStudioObj = globalObj->GetValue("obsstudio");
+
+	CefRefPtr<CefV8Value> jsFunction = obsStudioObj->GetValue(functionName);
+	if (jsFunction && jsFunction->IsFunction()) {
+		jsFunction->ExecuteFunction(NULL, arguments);
+	}
+
+	context->Exit();
+}
+
 bool BrowserApp::OnProcessMessageReceived(CefRefPtr<CefBrowser> browser,
 		CefProcessId source_process,
 		CefRefPtr<CefProcessMessage> message) {
 	DCHECK(source_process == PID_BROWSER);
 
-	if (message->GetName() == "Visibility") {
-		CefRefPtr<CefListValue> args = message->GetArgumentList();
-
-		CefRefPtr<CefV8Context> context = browser->GetMainFrame()->GetV8Context();
-
-		context->Enter();
-		
-		CefRefPtr<CefV8Value> globalObj = context->GetGlobal();
-
-		CefRefPtr<CefV8Value> obsStudioObj = globalObj->GetValue("obsstudio");
+	CefRefPtr<CefListValue> args = message->GetArgumentList();
 
-		CefRefPtr<CefV8Value> visibilityFunction = obsStudioObj->GetValue("onVisibilityChange");
-		if (visibilityFunction && visibilityFunction->IsFunction()) {
-			CefV8ValueList arguments;
-			arguments.push_back(CefV8Value::CreateBool(args->GetBool(0)));
-			visibilityFunction->ExecuteFunction(NULL, arguments);
-		}
+	if (message->GetName() == "Visibility") {
+		CefV8ValueList arguments;
+		arguments.push_back(CefV8Value::CreateBool(args->GetBool(0)));
 
-		context->Exit();
+		ExecuteJSFunction(browser, "onVisibilityChange", arguments);
+		return true;
+	}
+	else if (message->GetName() == "SceneChange") {
+		CefV8ValueList arguments;
+		arguments.push_back(CefV8Value::CreateString(args->GetString(0)));
 
+		ExecuteJSFunction(browser , "onSceneChange", arguments);
 		return true;
 	}
 
 	return false;
-}
+}
diff --git a/shared/browser-app.hpp b/shared/browser-app.hpp
@@ -45,6 +45,10 @@ class BrowserApp : public CefApp,
 		CefRefPtr<CefProcessMessage> message) OVERRIDE;
 
 private:
+	virtual void ExecuteJSFunction(CefRefPtr<CefBrowser> browser,
+		const char *functionName,
+        CefV8ValueList arguments);
+	
 	IMPLEMENT_REFCOUNTING(BrowserApp);
 
 };
diff --git a/shared/browser-manager.hpp b/shared/browser-manager.hpp
@@ -60,9 +60,11 @@ class BrowserManager {
 	const char *GetModulePath() { return path; }
 
 	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
+    
+    void ExecuteSceneChangeJSCallback(const char *name);
 
 private:
 	class Impl;
 	std::unique_ptr<Impl> pimpl;
 	const char *path;
-};
+};

Original file line number	Diff line number	Diff line change
`@@ -245,3 +245,13 @@`
`245`	`245`	`}`
`246`	`246`	`@catch (NSException *exception) {}`
`247`	`247`	`}`
	`248`	`+`
	`249`	`+void CEFIsolationServiceManager::ExecuteSceneChangeJSCallback(const char *name)`
	`250`	`+{`
	`251`	`+ id<CEFIsolatedClient> cefIsolatedClient =`
	`252`	`+ [_cefIsolationService client];`
	`253`	`+ @try {`
	`254`	`+ [cefIsolatedClient executeSceneChangeJSCallback:name];`
	`255`	`+ }`
	`256`	`+ @catch (NSException *exception) {}`
	`257`	`+}`