Merge pull request #27 from DDRBoxman/js-bindings

OsirisNL · web-flow · commit cd0f8c1f34f9 · 2016-09-06T09:08:28.000+02:00
Visibility JS Bindings
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# obs-browser
+
+CEF Based obs-studio browser plugin
+
+## JS Bindings
+
+obs-browser provides a global object that allows access to some obs specific functionality from javascript.
+
+### Get OBS Studio Browser Plugin Version
+```
+window.obsstudio.pluginVersion
+// => 1.24.0
+```
+
+### Register for visibility callbacks
+```
+/**
+ * onVisibilityChange gets callbacks when the visibility of the browser source changes in OBS
+ *
+ * @param {bool} visiblity - True -> visible, False -> hidden
+ */
+window.obsstudio.onVisibilityChange(visiblity) {
+	
+};
+```
diff --git a/cef-isolation/cef-isolated-client.mm b/cef-isolation/cef-isolated-client.mm
@@ -287,6 +287,20 @@ - (void)sendKeyClick:(const int)browserIdentifier
 	 }];
 }
 
+- (void)executeVisiblityJSCallback:(const int)browserIdentifier visible:(BOOL)visible
+{
+	[self sendEvent:browserIdentifier
+		  event:^(SharedBrowserHandle browserHandle)
+	{
+		CefRefPtr<CefBrowser> browser = browserHandle->GetBrowser();
+
+		CefRefPtr<CefProcessMessage> msg = CefProcessMessage::Create("Visibility");
+		CefRefPtr<CefListValue> args = msg->GetArgumentList();
+		args->SetBool(0, visible);
+		browser->SendProcessMessage(PID_RENDERER, msg);
+	}];
+}
+
 - (void)destroyBrowser:(const int)browserIdentifier {
 	if (map.count(browserIdentifier) == 1) {
 		std::shared_ptr<BrowserHandle> browserHandle =
diff --git a/obs-browser/apple/browser-manager-mac.h b/obs-browser/apple/browser-manager-mac.h
@@ -49,6 +49,8 @@ class BrowserManager::Impl {
 	void SendFocus(int browserIdentifier, bool focus);
 	void SendKeyClick(const int browserIdentifier,
 			const struct obs_key_event *event, bool keyUp);
+	
+	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
 
 private:
 	std::unique_ptr<CEFIsolationServiceManager> cefIsolationServiceManager;
diff --git a/obs-browser/apple/browser-manager-mac.mm b/obs-browser/apple/browser-manager-mac.mm
@@ -81,6 +81,11 @@
 	pimpl->SendKeyClick(browserIdentifier, event, keyUp);
 }
 
+void BrowserManager::ExecuteVisiblityJSCallback(int browserIdentifier, bool visible)
+{
+	pimpl->ExecuteVisiblityJSCallback(browserIdentifier, visible);
+}
+
 int BrowserManager::CreateBrowser(const BrowserSettings &browserSettings,
 		const std::shared_ptr<BrowserListener> &browserListener)
 {
@@ -161,6 +166,11 @@
 		keyUp);
 }
 
+void BrowserManager::Impl::ExecuteVisiblityJSCallback(int browserIdentifier, bool visible)
+{
+	cefIsolationServiceManager->ExecuteVisiblityJSCallback(browserIdentifier, visible);
+}
+
 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
@@ -56,6 +56,8 @@ class CEFIsolationServiceManager {
 	void SendKeyClick(int browserIdentifier,
 			const struct obs_key_event *event, bool key_up);
 
+	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
+
 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
@@ -235,3 +235,13 @@
 	}
 	@catch (NSException *exception) {}
 }
+
+void CEFIsolationServiceManager::ExecuteVisiblityJSCallback(int browserIdentifier, bool visible)
+{
+	id<CEFIsolatedClient> cefIsolatedClient =
+		[_cefIsolationService client];
+	@try {
+		[cefIsolatedClient executeVisiblityJSCallback:browserIdentifier visible:visible];
+	}
+	@catch (NSException *exception) {}
+}
diff --git a/obs-browser/browser-manager-base.cpp b/obs-browser/browser-manager-base.cpp
@@ -75,6 +75,11 @@ void BrowserManager::SendKeyClick(int browserIdentifier,
 	pimpl->SendKeyClick(browserIdentifier, event, keyUp);
 }
 
+void BrowserManager::ExecuteVisiblityJSCallback(int browserIdentifier, bool visible)
+{
+	pimpl->ExecuteVisiblityJSCallback(browserIdentifier, visible);
+}
+
 BrowserManager::Impl::Impl()
 {
 	os_event_init(&dispatchEvent, OS_EVENT_TYPE_AUTO);
@@ -98,7 +103,6 @@ int BrowserManager::Impl::CreateBrowser(
 	CefPostTask(TID_UI, BrowserTask::newTask(
 			[&] 
 	{
-
 		CefRefPtr<BrowserRenderHandler> renderHandler(
 				new BrowserRenderHandler(browserSettings.width, 
 				browserSettings.height, browserListener));
@@ -268,6 +272,16 @@ void BrowserManager::Impl::SendKeyClick(int browserIdentifier,
 	});
 }
 
+void BrowserManager::Impl::ExecuteVisiblityJSCallback(int browserIdentifier, bool visible)
+{
+	ExecuteOnBrowser(browserIdentifier, [&](CefRefPtr<CefBrowser> b)
+	{
+		CefRefPtr<CefProcessMessage> msg = CefProcessMessage::Create("Visibility");
+		CefRefPtr<CefListValue> args = msg->GetArgumentList();
+		args->SetBool(0, visible);
+		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
@@ -54,6 +54,8 @@ class BrowserManager::Impl
 
 	void PushEvent(std::function<void()> event);
 
+	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
+
 private: 
 	void ExecuteOnBrowser(int browserIdentifier, 
 			std::function<void(CefRefPtr<CefBrowser>)> f, 
diff --git a/obs-browser/main-source.cpp b/obs-browser/main-source.cpp
@@ -130,24 +130,32 @@ static const char *browser_source_get_name(void *)
 	return obs_module_text("BrowserSource");
 }
 
+// Called when the source is visible
 static void browser_source_show(void *data)
 {
 	BrowserSource *bs = static_cast<BrowserSource *>(data);
 
-	if ( bs->GetShutdown() )
+	if ( bs->GetShutdown() ) {
 		bs->UpdateBrowser();
-	
+	}
+	else {
+		bs->ExecuteVisiblityJSCallback(true);
+	}
 }
 
+// Called when the source is no longer visible
 static void browser_source_hide(void *data)
 {
 	BrowserSource *bs = static_cast<BrowserSource *>(data);
 
-	if (bs->GetShutdown())
+	if (bs->GetShutdown()) {
 		BrowserManager::Instance()->DestroyBrowser(bs->GetBrowserIdentifier());
+	}
+	else {
+		bs->ExecuteVisiblityJSCallback(false);
+	}
 }
 
-
 static void *browser_source_create(obs_data_t *settings, obs_source_t *source)
 {
 	BrowserSource *browserSource = new BrowserSource(settings, source);
diff --git a/shared/browser-app.cpp b/shared/browser-app.cpp
@@ -17,15 +17,22 @@
 
 #include "browser-app.hpp"
 
+#include <iostream>
 #include <string>
 
 #include "cefsimple/simple_handler.h"
 #include "include/cef_browser.h"
 #include "include/cef_command_line.h"
 #include "include/wrapper/cef_helpers.h"
+#include "browser-version.h"
 
-BrowserApp::BrowserApp()
-{}
+BrowserApp::BrowserApp(){
+}
+
+CefRefPtr<CefRenderProcessHandler> BrowserApp::GetRenderProcessHandler()
+{
+	return this;
+}
 
 void BrowserApp::OnRegisterCustomSchemes(
 		CefRefPtr<CefSchemeRegistrar> registrar)
@@ -49,4 +56,48 @@ void BrowserApp::OnBeforeCommandLineProcessing(
 	command_line->AppendSwitch("enable-begin-frame-scheduling");
 
 	command_line->AppendSwitch("enable-system-flash");
+}
+
+void BrowserApp::OnContextCreated(CefRefPtr<CefBrowser> browser,
+		CefRefPtr<CefFrame> frame,
+		CefRefPtr<CefV8Context> context)
+{
+	CefRefPtr<CefV8Value> globalObj = context->GetGlobal();
+
+	CefRefPtr<CefV8Value> obsStudioObj = CefV8Value::CreateObject(0);
+	globalObj->SetValue("obsstudio", obsStudioObj, V8_PROPERTY_ATTRIBUTE_NONE);
+
+	CefRefPtr<CefV8Value> pluginVersion = CefV8Value::CreateString(OBS_BROWSER_VERSION);
+	obsStudioObj->SetValue("pluginVersion", pluginVersion, V8_PROPERTY_ATTRIBUTE_NONE);
+}
+
+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<CefV8Value> visibilityFunction = obsStudioObj->GetValue("onVisibilityChange");
+		if (visibilityFunction && visibilityFunction->IsFunction()) {
+			CefV8ValueList arguments;
+			arguments.push_back(CefV8Value::CreateBool(args->GetBool(0)));
+			visibilityFunction->ExecuteFunction(NULL, arguments);
+		}
+
+		context->Exit();
+
+		return true;
+	}
+
+	return false;
 }
diff --git a/shared/browser-app.hpp b/shared/browser-app.hpp
@@ -18,20 +18,32 @@
 #pragma once
 
 #include "include/cef_app.h"
+#include <include/cef_render_process_handler.h>
 
-class BrowserApp : public CefApp
+class BrowserApp : public CefApp,
+				   public CefRenderProcessHandler
 {
 
 public:
 	BrowserApp();
 
 public:
+	virtual CefRefPtr<CefRenderProcessHandler> GetRenderProcessHandler() OVERRIDE;
 	virtual void OnRegisterCustomSchemes(
 			CefRefPtr<CefSchemeRegistrar> registrar) OVERRIDE;
 	virtual void OnBeforeCommandLineProcessing(
 		const CefString& process_type,
 		CefRefPtr<CefCommandLine> command_line) OVERRIDE;
 
+	virtual void OnContextCreated(CefRefPtr<CefBrowser> browser,
+		CefRefPtr<CefFrame> frame,
+		CefRefPtr<CefV8Context> context) OVERRIDE;
+
+	virtual bool OnProcessMessageReceived(
+		CefRefPtr<CefBrowser> browser,
+		CefProcessId source_process,
+		CefRefPtr<CefProcessMessage> message) OVERRIDE;
+
 private:
 	IMPLEMENT_REFCOUNTING(BrowserApp);
 
diff --git a/shared/browser-manager.hpp b/shared/browser-manager.hpp
@@ -59,6 +59,8 @@ class BrowserManager {
 	void SetModulePath(const char *path) { this->path = path; }
 	const char *GetModulePath() { return path; }
 
+	void ExecuteVisiblityJSCallback(int browserIdentifier, bool visible);
+
 private:
 	class Impl;
 	std::unique_ptr<Impl> pimpl;
diff --git a/shared/browser-source.cpp b/shared/browser-source.cpp
@@ -89,3 +89,8 @@ void BrowserSource::SendKeyClick(const struct obs_key_event *event, bool keyUp)
 	BrowserManager::Instance()->SendKeyClick(browserIdentifier, event,
 			keyUp);
 }
+
+void BrowserSource::ExecuteVisiblityJSCallback(bool visible)
+{
+	BrowserManager::Instance()->ExecuteVisiblityJSCallback(browserIdentifier, visible);
+}
diff --git a/shared/browser-source.hpp b/shared/browser-source.hpp
@@ -67,6 +67,7 @@ class BrowserSource {
 	void SendKeyClick(const struct obs_key_event *event, bool keyUp);
 	std::shared_ptr<BrowserListener> CreateListener();
 
+	void ExecuteVisiblityJSCallback(bool visible);
 
 private:
 	class Impl;

Original file line number	Diff line number	Diff line change
`@@ -235,3 +235,13 @@`
`235`	`235`	`}`
`236`	`236`	`@catch (NSException *exception) {}`
`237`	`237`	`}`
	`238`	`+`
	`239`	`+void CEFIsolationServiceManager::ExecuteVisiblityJSCallback(int browserIdentifier, bool visible)`
	`240`	`+{`
	`241`	`+ id<CEFIsolatedClient> cefIsolatedClient =`
	`242`	`+ [_cefIsolationService client];`
	`243`	`+ @try {`
	`244`	`+ [cefIsolatedClient executeVisiblityJSCallback:browserIdentifier visible:visible];`
	`245`	`+ }`
	`246`	`+ @catch (NSException *exception) {}`
	`247`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -130,24 +130,32 @@ static const char browser_source_get_name(void )`
`130`	`130`	`return obs_module_text("BrowserSource");`
`131`	`131`	`}`
`132`	`132`
	`133`	`+// Called when the source is visible`
`133`	`134`	`static void browser_source_show(void *data)`
`134`	`135`	`{`
`135`	`136`	`BrowserSource bs = static_cast<BrowserSource >(data);`
`136`	`137`
`137`		`- if ( bs->GetShutdown() )`
	`138`	`+ if ( bs->GetShutdown() ) {`
`138`	`139`	`bs->UpdateBrowser();`
`139`		`-`
	`140`	`+ }`
	`141`	`+ else {`
	`142`	`+ bs->ExecuteVisiblityJSCallback(true);`
	`143`	`+ }`
`140`	`144`	`}`
`141`	`145`
	`146`	`+// Called when the source is no longer visible`
`142`	`147`	`static void browser_source_hide(void *data)`
`143`	`148`	`{`
`144`	`149`	`BrowserSource bs = static_cast<BrowserSource >(data);`
`145`	`150`
`146`		`- if (bs->GetShutdown())`
	`151`	`+ if (bs->GetShutdown()) {`
`147`	`152`	`BrowserManager::Instance()->DestroyBrowser(bs->GetBrowserIdentifier());`
	`153`	`+ }`
	`154`	`+ else {`
	`155`	`+ bs->ExecuteVisiblityJSCallback(false);`
	`156`	`+ }`
`148`	`157`	`}`
`149`	`158`
`150`		`-`
`151`	`159`	`static void browser_source_create(obs_data_t settings, obs_source_t *source)`
`152`	`160`	`{`
`153`	`161`	`BrowserSource *browserSource = new BrowserSource(settings, source);`