Merge pull request #47 from DDRBoxman/js_events

Frontend event callbacks through js events. Getter support from frontend API.

Author: OsirisNL

CMakeLists.txt

@@ -46,7 +46,8 @@ set(obs-browser_SOURCES
 	obs-browser/main.cpp
 	obs-browser/main-source.cpp
 	shared/browser-source.cpp
-	shared/base64.cpp)
+	shared/base64.cpp
+	shared/util.cpp)
 
 set(obs-browser_HEADERS
 	shared/browser-manager.hpp
@@ -56,7 +57,8 @@ set(obs-browser_HEADERS
 	shared/browser-types.h
 	shared/base64.hpp
 	shared/browser-types.h
-	shared/browser-version.h)
+	shared/browser-version.h
+	shared/util.hpp)
 
 if (APPLE)
 	list(APPEND obs-browser_SOURCES
@@ -94,7 +96,9 @@ else (APPLE)
 		obs-browser/browser-render-handler.cpp
 		obs-browser/browser-source-base.cpp
 		obs-browser/browser-load-handler.cpp
-		shared/browser-scheme.cpp)
+		obs-browser/browser-obs-bridge-base.cpp
+		shared/browser-scheme.cpp
+		fmt/format.cc)
 
 	list(APPEND obs-browser_HEADERS
 		shared/browser-client.hpp
@@ -105,13 +109,15 @@ else (APPLE)
 		obs-browser/browser-render-handler.hpp
 		obs-browser/browser-source-base.hpp
 		obs-browser/browser-load-handler.hpp
-		shared/browser-scheme.hpp)
+		obs-browser/browser-obs-bridge-base.hpp
+		shared/browser-scheme.hpp
+		fmt/format.h)
 
 endif(APPLE)
 
 set(obs-browser_LIBRARIES
-	libobs
-	obs-frontend-api)
+	obs-frontend-api
+	${OBS_JANSSON_IMPORT})
 
 if (APPLE)
 	list(APPEND obs-browser_LIBRARIES
@@ -128,13 +134,17 @@ target_include_directories(obs-browser PRIVATE
 	"obs-browser" 
 	"shared")
 
+target_include_directories(obs-browser PUBLIC
+	${OBS_JANSSON_INCLUDE_DIRS})
+
 if (APPLE)
 	target_include_directories(obs-browser PUBLIC 
 		"shared-apple")
-else(APPLE)
-	target_include_directories_system(obs-browser PUBLIC ${CEF_INCLUDE_DIR})
+else (APPLE)
+	target_include_directories_system(obs-browser PUBLIC ${CEF_ROOT_DIR})
 endif(APPLE)
 
+
 if (APPLE)
 	set_xcode_property(obs-browser CLANG_CXX_LIBRARY "libc++")
 endif(APPLE)
@@ -160,6 +170,7 @@ if(APPLE)
 	set(cef-isolation_SOURCES
 		cef-isolation/main.mm
 		cef-isolation/cef-isolated-client.mm
+		cef-isolation/browser-obs-bridge-mac.mm
 		cef-isolation/browser-handle.mm
 		cef-isolation/browser-render-handler.mm
 		cef-isolation/browser-texture-mac.mm
@@ -169,7 +180,8 @@ if(APPLE)
 		shared/browser-app.cpp
 		shared/browser-scheme.cpp
 		shared/base64.cpp
-		obs-browser/browser-load-handler.cpp)
+		obs-browser/browser-load-handler.cpp
+		fmt/format.cc)
 
 	set(cef-isolation_HEADERS
 		shared-apple/cef-logging.h
@@ -179,6 +191,7 @@ if(APPLE)
 		cef-isolation/browser-render-handler.hpp
 		cef-isolation/browser-texture-mac.h
 		cef-isolation/service-connection-delegate.h
+		cef-isolation/browser-obs-bridge-mac.hpp
 		shared/browser-texture.hpp
 		shared/browser-client.hpp
 		shared/browser-task.hpp
@@ -187,6 +200,7 @@ if(APPLE)
 		obs-browser/browser-load-handler.hpp
 		shared/browser-scheme.hpp
 		shared/browser-types.h
+		shared/browser-obs-bridge.hpp
 		shared-apple/browser-bridges.h)
 
 	add_executable(cef-isolation
@@ -205,21 +219,27 @@ if(APPLE)
 		"shared"
 		"shared-apple")
 
-	target_include_directories_system(cef-isolation PUBLIC ${CEF_INCLUDE_DIR})
+	target_include_directories_system(cef-isolation
+		PUBLIC
+			${CEF_INCLUDE_DIR}
+			${OBS_JANSSON_INCLUDE_DIRS})
 
 	target_link_libraries(cef-isolation
 		${CEF_LIBRARIES}
+		${OBS_JANSSON_IMPORT}
 		${APPKIT_FRAMEWORK}
 		${IOSURFACE_FRAMEWORK})
 
 endif(APPLE)
 
 set(cef-bootstrap_SOURCES
 	cef-bootstrap/main.cpp
-	shared/browser-app.cpp)
+	shared/browser-app.cpp
+	fmt/format.cc)
 
 set(cef-bootstrap_HEADERS
-	shared/browser-app.hpp)
+	shared/browser-app.hpp
+	fmt/format.h)
 
 add_executable(cef-bootstrap 
 	${cef-bootstrap_SOURCES} 
@@ -239,26 +259,30 @@ if (APPLE AND XCODE)
 endif(APPLE AND XCODE)
 
 target_include_directories(cef-bootstrap PRIVATE "shared")
-target_include_directories_system(cef-bootstrap PUBLIC ${CEF_INCLUDE_DIR})
+target_include_directories_system(cef-bootstrap
+	PUBLIC
+		${CEF_ROOT_DIR}
+		${OBS_JANSSON_INCLUDE_DIRS})
 
 target_link_libraries(cef-bootstrap
-	${CEF_LIBRARIES})
+	${CEF_LIBRARIES}
+	${OBS_JANSSON_IMPORT})
 
 if (APPLE)
 
 	set_target_properties(cef-isolation PROPERTIES
 		OUTPUT_NAME "CEF"
 		MACOSX_BUNDLE TRUE
 		BUILD_WITH_INSTALL_RPATH TRUE
-		INSTALL_RPATH "@loader_path/../Frameworks"
+		INSTALL_RPATH "@executable_path/.."
 		MACOSX_BUNDLE_BUNDLE_NAME "CEF Helper"
 		MACOSX_BUNDLE_GUI_IDENTIFIER "org.catchexception.cef.cef-isolation")
 
 	set_target_properties(cef-bootstrap PROPERTIES
 		OUTPUT_NAME "CEF Helper"
 		MACOSX_BUNDLE TRUE
 		BUILD_WITH_INSTALL_RPATH TRUE
-		INSTALL_RPATH "@loader_path/../../../"
+		INSTALL_RPATH "@executable_path/../../../.."
 		MACOSX_BUNDLE_BUNDLE_NAME "CEF Helper"
 		MACOSX_BUNDLE_GUI_IDENTIFIER "org.catchexception.cef.cef-bootstrap")
 

README.md

@@ -26,22 +26,23 @@ 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) {
-	
-};
+window.addEventListener('obsSceneChanged', function(evt) {
+	var t = document.createTextNode(evt.detail.name);
+    document.body.appendChild(t);
+});
+```
+
+### Get the current scene
+```
+window.obsstudio.getCurrentScene(function(data) {console.log(data);});
 ```
 
 ## Building on OSX
 
 ### Building CEF
 #### Getting
 *  Download CEF Mac 64 from [https://cefbuilds.com/](https://cefbuilds.com/)
-  *  At the time of writing this I used build 2704
+  *  At the time of writing this I used build 2883
 *  Extract and cd into the folder
 
 #### Setting Up Project
@@ -70,7 +71,7 @@ git clone [email protected]:kc5nra/obs-browser.git ./plugins/obs-browser
 echo "add_subdirectory(obs-browser)" >> ./plugins/CMakeLists.txt
 mkdir build
 cd ./build
-cmake -D CMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake -D CEF_ROOT_DIR=/Users/username/Development/cef_binary_3.2704.1434.gec3e9ed_macosx64 -G Xcode ..
+cmake -D CMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake -D CEF_ROOT_DIR=/Users/username/Development/cef_binary_3.2883.1540.gedbfb20_macosx64 -D BUILD_BROWSER=yes -G Xcode ..
 open obs-studio.xcodeproj/
 ```
 

cef-isolation/browser-obs-bridge-mac.hpp

@@ -0,0 +1,15 @@
+#pragma once
+
+#include "cef-isolation.h"
+#include "browser-obs-bridge.hpp"
+
+class BrowserOBSBridgeMac : public BrowserOBSBridge
+{
+public:
+	BrowserOBSBridgeMac(id<CEFIsolationService> cefIsolationService);
+
+    const char* GetCurrentSceneJSONData() override;
+
+private:
+	id<CEFIsolationService> cefIsolationService;	
+};

cef-isolation/browser-obs-bridge-mac.mm

@@ -0,0 +1,10 @@
+#include "browser-obs-bridge-mac.hpp"
+
+BrowserOBSBridgeMac::BrowserOBSBridgeMac(id<CEFIsolationService> cefIsolationService)
+: cefIsolationService(cefIsolationService)
+{}
+
+const char* BrowserOBSBridgeMac::GetCurrentSceneJSONData()
+{
+	return [cefIsolationService getCurrentSceneJSONData];
+}

cef-isolation/browser-render-handler.hpp

@@ -27,7 +27,6 @@ class BrowserRenderHandler : public CefRenderHandler
 
 	BrowserRenderHandler(std::shared_ptr<BrowserHandle> &browserHandle);
 
-
 public: /* CefRenderHandler overrides */
 
 	virtual bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect &rect)

cef-isolation/cef-isolated-client.mm

@@ -16,6 +16,7 @@
  ******************************************************************************/
 
 #import <Cocoa/Cocoa.h>
+#import <Foundation/Foundation.h>
 
 #include <include/cef_app.h>
 #include <include/cef_browser.h>
@@ -35,6 +36,8 @@
 
 #import "cef-isolated-client.h"
 
+#import "browser-obs-bridge-mac.hpp"
+
 @implementation CEFIsolatedClient
 
 - (id)init
@@ -73,6 +76,8 @@ - (int)createBrowser:(BrowserSettingsBridge *)browserSettings
 		new BrowserHandle(browserSettings.width,
 			browserSettings.height, _server));
 
+	BrowserOBSBridge *browserOBSBridge = new BrowserOBSBridgeMac(_server);
+
 	sync_on_cef_ui(^{
 
 		CefRefPtr<BrowserRenderHandler> browserRenderHandler =
@@ -82,7 +87,7 @@ new BrowserHandle(browserSettings.width,
 				new BrowserLoadHandler(std::string([browserSettings.css UTF8String]));
 
 		CefRefPtr<BrowserClient> browserClient =
-				new BrowserClient(browserRenderHandler.get(),loadHandler);
+				new BrowserClient(browserRenderHandler.get(),loadHandler, browserOBSBridge);
 
 		CefWindowInfo windowInfo;
 		windowInfo.view = nullptr;
@@ -286,13 +291,7 @@ - (void)sendKeyClick:(const int)browserIdentifier
 				return;
 			}
 
-			host->HandleKeyEventBeforeTextInputClient(nsEvent);
-
-			NSTextInputContext *inputContext =
-					host->GetNSTextInputContext();
-			[inputContext handleEvent:nsEvent];
-
-			host->HandleKeyEventAfterTextInputClient(nsEvent);
+			host->SendKeyEvent(keyEvent);
 		}
 	 }];
 }
@@ -335,7 +334,20 @@ - (void)refreshPageNoCache:(const int)browserIdentifier
      }];
 }
 
+-(void)dispatchJSEvent:(const char *)eventName data:(const char *)jsonString
+{
+	[self sendEventToAllBrowsers:^(SharedBrowserHandle browserHandle)
+	{
+		CefRefPtr<CefBrowser> browser = browserHandle->GetBrowser();
+
+		CefRefPtr<CefProcessMessage> msg = CefProcessMessage::Create("DispatchJSEvent");
+		CefRefPtr<CefListValue> args = msg->GetArgumentList();
+		args->SetString(0, eventName);
+		args->SetString(1, jsonString);
 
+		browser->SendProcessMessage(PID_RENDERER, msg);
+	}];
+}
 
 - (void)destroyBrowser:(const int)browserIdentifier {
 	if (map.count(browserIdentifier) == 1) {