RFC 39: Service overhaul

.editorconfig

@@ -53,3 +53,11 @@ indent_size = 2
 [{*.zsh,.*.zsh,build-aux/.functions/*,.github/scripts/utils.zsh/*}]
 indent_style = space
 indent_size = 2
+
+[json-schema/*.json]
+indent_style = space
+indent_size = 4
+
+[plugins/obs-services/json/**/*.json]
+indent_style = space
+indent_size = 4

.github/actions/obs-services-json-parser-validator/action.yaml

@@ -0,0 +1,51 @@
+name: obs-services JSON Parser Validator
+description: Runs quicktype againts obs-services JSON schemas and checks for any changes introduced by it
+inputs:
+  failCondition:
+    description: Controls whether failed checks also fail the workflow run
+    required: false
+    default: never
+  workingDirectory:
+    description: Working directory for checks
+    required: false
+    default: ${{ github.workspace }}
+runs:
+  using: composite
+  steps:
+    - name: Check Runner Operating System 🏃‍♂️
+      if: runner.os == 'Windows'
+      shell: bash
+      run: |
+        : Check Runner Operating System 🏃‍♂️
+        echo "::notice::obs-services-json-parser-validator action requires a macOS-based or Linux-based runner."
+        exit 2
+
+    - name: Install Dependencies 🛍️
+      if: runner.os == 'Linux'
+      shell: bash
+      run: |
+        : Install Dependencies 🛍️
+        echo ::group::Install Dependencies
+        eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+        echo "/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin" >> $GITHUB_PATH
+        brew install --quiet zsh
+        echo ::endgroup::
+
+    - name: Validate obs-services JSON Parser 🎛️
+      id: result
+      shell: zsh --no-rcs --errexit --pipefail {0}
+      working-directory: ${{ github.workspace }}
+      env:
+        GITHUB_EVENT_FORCED: ${{ github.event.forced }}
+        GITHUB_REF_BEFORE: ${{ github.event.before }}
+      run: |
+        : Validate obs-services JSON Parser 🎛️
+        if (( ${+RUNNER_DEBUG} )) setopt XTRACE
+
+        print ::group::Install quicktype
+        npm install -g quicktype@23.0.49
+        print ::endgroup::
+
+        print ::group::Run Validation
+        ./build-aux/regen-obs-services-json-parser.zsh --fail-${{ inputs.failCondition }} --check
+        print ::endgroup::

.github/workflows/check-format.yaml

@@ -61,3 +61,15 @@ jobs:
         uses: ./.github/actions/qt-xml-validator
         with:
           failCondition: error
+
+  obs-services-json-parser-validator:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Validate obs-services JSON Parser
+        id: obs-services-json-parser-check
+        uses: ./.github/actions/obs-services-json-parser-validator
+        with:
+          failCondition: error

UI/CMakeLists.txt

@@ -20,6 +20,10 @@ if(NOT TARGET OBS::json11)
   add_subdirectory("${CMAKE_SOURCE_DIR}/deps/json11" "${CMAKE_BINARY_DIR}/deps/json11")
 endif()
 
+if(NOT TARGET OBS::obf)
+  add_subdirectory("${CMAKE_SOURCE_DIR}/deps/obf" "${CMAKE_BINARY_DIR}/deps/obf")
+endif()
+
 add_executable(obs-studio)
 add_executable(OBS::studio ALIAS obs-studio)
 
@@ -31,23 +35,15 @@ target_link_libraries(
           FFmpeg::avformat
           OBS::libobs
           OBS::frontend-api
-          OBS::json11)
+          OBS::json11
+          OBS::obf)
 
 include(cmake/ui-qt.cmake)
 include(cmake/ui-elements.cmake)
 include(cmake/ui-windows.cmake)
 include(cmake/feature-importers.cmake)
 include(cmake/feature-browserpanels.cmake)
 
-if(NOT OAUTH_BASE_URL)
-  # cmake-format: off
-  set(OAUTH_BASE_URL "https://auth.obsproject.com/" CACHE STRING "Default OAuth base URL")
-  mark_as_advanced(OAUTH_BASE_URL)
-  # cmake-format: on
-endif()
-include(cmake/feature-twitch.cmake)
-include(cmake/feature-restream.cmake)
-include(cmake/feature-youtube.cmake)
 include(cmake/feature-sparkle.cmake)
 include(cmake/feature-whatsnew.cmake)
 
@@ -59,19 +55,13 @@ target_sources(
   obs-studio
   PRIVATE # cmake-format: sortable
           api-interface.cpp
-          auth-base.cpp
-          auth-base.hpp
-          auth-listener.cpp
-          auth-listener.hpp
-          auth-oauth.cpp
-          auth-oauth.hpp
+          broadcast-flow.cpp
+          broadcast-flow.hpp
           display-helpers.hpp
           ffmpeg-utils.cpp
           ffmpeg-utils.hpp
           multiview.cpp
           multiview.hpp
-          obf.c
-          obf.h
           obs-app.cpp
           obs-app.hpp
           obs-proxy-style.cpp

UI/api-interface.cpp

@@ -6,6 +6,10 @@
 
 #include <functional>
 
+#ifdef ENABLE_WAYLAND
+#include <obs-nix-platform.h>
+#endif
+
 using namespace std;
 
 Q_DECLARE_METATYPE(OBSScene);
@@ -399,7 +403,7 @@ struct OBSStudioAPI : obs_frontend_callbacks {
 	}
 
 	bool obs_frontend_add_dock_by_id(const char *id, const char *title,
-					 void *widget) override
+					 void *_widget) override
 	{
 		if (main->IsDockObjectNameUsed(QT_UTF8(id))) {
 			blog(LOG_WARNING,
@@ -410,12 +414,16 @@ struct OBSStudioAPI : obs_frontend_callbacks {
 		}
 
 		OBSDock *dock = new OBSDock(main);
-		dock->setWidget((QWidget *)widget);
+		QWidget *widget = (QWidget *)_widget;
+		dock->setWidget(widget);
 		dock->setWindowTitle(QT_UTF8(title));
 		dock->setObjectName(QT_UTF8(id));
 
 		main->AddDockWidget(dock, Qt::RightDockWidgetArea);
 
+		if (widget->property("Dock_WA_NativeWindow").toBool())
+			dock->setAttribute(Qt::WA_NativeWindow);
+
 		dock->setFloating(true);
 		dock->setVisible(false);
 
@@ -445,6 +453,59 @@ struct OBSStudioAPI : obs_frontend_callbacks {
 		return true;
 	}
 
+	bool obs_frontend_is_browser_available(void) override
+	{
+#ifdef BROWSER_AVAILABLE
+#ifdef ENABLE_WAYLAND
+		return (obs_get_nix_platform() != OBS_NIX_PLATFORM_WAYLAND);
+#else
+		return true;
+#endif
+#else
+		return false;
+#endif
+	}
+
+	void *obs_frontend_get_browser_widget_s(
+		const struct obs_frontend_browser_params *params,
+		size_t size) override
+	{
+#ifdef BROWSER_AVAILABLE
+#ifdef ENABLE_WAYLAND
+		if (!obs_frontend_is_browser_available())
+			return nullptr;
+#endif
+		struct obs_frontend_browser_params data = {0};
+		if (size > sizeof(data)) {
+			blog(LOG_ERROR,
+			     "Tried to add obs_frontend_get_browser_widget with size "
+			     "%llu which is more than OBS Studio currently "
+			     "supports (%llu)",
+			     (long long unsigned)size,
+			     (long long unsigned)sizeof(data));
+			return nullptr;
+		}
+
+		memcpy(&data, params, size);
+
+		return (void *)main->GetBrowserWidget(data);
+#else
+		UNUSED_PARAMETER(params);
+		UNUSED_PARAMETER(size);
+		return nullptr;
+#endif
+	}
+
+	void obs_frontend_delete_browser_cookie(const char *url) override
+	{
+		if (!url)
+			return;
+
+		std::string urlStr = url;
+		if (!urlStr.empty())
+			main->DeleteCookie(urlStr);
+	}
+
 	void obs_frontend_add_event_callback(obs_frontend_event_cb callback,
 					     void *private_data) override
 	{
@@ -747,6 +808,33 @@ struct OBSStudioAPI : obs_frontend_callbacks {
 			undo_data, redo_data, repeatable);
 	}
 
+	void obs_frontend_add_broadcast_flow_s(
+		const obs_service_t *service,
+		const struct obs_frontend_broadcast_flow *flow,
+		size_t size) override
+	{
+		struct obs_frontend_broadcast_flow data = {0};
+		if (size > sizeof(data)) {
+			blog(LOG_ERROR,
+			     "Tried to add obs_frontend_broadcast_flow with size "
+			     "%llu which is more than OBS Studio currently "
+			     "supports (%llu)",
+			     (long long unsigned)size,
+			     (long long unsigned)sizeof(data));
+			return;
+		}
+
+		memcpy(&data, flow, size);
+
+		main->AddBroadcastFlow(service, data);
+	}
+
+	void obs_frontend_remove_broadcast_flow(
+		const obs_service_t *service) override
+	{
+		main->RemoveBroadcastFlow(service);
+	}
+
 	void on_load(obs_data_t *settings) override
 	{
 		for (size_t i = saveCallbacks.size(); i > 0; i--) {