Merge pull request #36 from OPENSPHERE-Inc/patch-0.7.0

0.7.0

Author: hanatyan128

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "lib/json"]
 	path = lib/json
 	url = https://github.com/nlohmann/json.git
+[submodule "lib/obs-websocket"]
+	path = lib/obs-websocket
+	url = https://github.com/obsproject/obs-websocket.git

CMakeLists.txt

@@ -78,6 +78,32 @@ set(o2_SRCS
 
 target_sources(${CMAKE_PROJECT_NAME} PRIVATE ${o2_SRCS})
 
+configure_file(lib/obs-websocket/src/plugin-macros.h.in plugin-macros.generated.h)
+
+set(obs-websocket_SRCS
+    lib/obs-websocket/src/eventhandler/EventHandler_Config.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_Filters.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_General.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_Inputs.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_MediaInputs.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_Outputs.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_SceneItems.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_Scenes.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_Transitions.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler_Ui.cpp
+    lib/obs-websocket/src/eventhandler/EventHandler.cpp
+    lib/obs-websocket/src/utils/Obs_VolumeMeter.cpp
+    lib/obs-websocket/src/utils/Obs_StringHelper.cpp
+    lib/obs-websocket/src/utils/Obs_ArrayHelper.cpp
+    lib/obs-websocket/src/utils/Obs_ObjectHelper.cpp
+    lib/obs-websocket/src/utils/Json.cpp
+    lib/obs-websocket/src/utils/Obs_NumberHelper.cpp
+    lib/obs-websocket/src/plugin-macros.h.in)
+
+target_sources(${CMAKE_PROJECT_NAME} PRIVATE ${obs-websocket_SRCS})
+target_compile_options(${CMAKE_PROJECT_NAME} PRIVATE $<$<COMPILE_LANG_AND_ID:CXX,GNU,AppleClang,Clang>:-Wno-error=shadow
+                                                     -Wno-error=conversion>)
+
 add_subdirectory(${CMAKE_SOURCE_DIR}/lib/json)
 target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE nlohmann_json::nlohmann_json)
 
@@ -98,17 +124,22 @@ target_sources(
           src/UI/egress-link-dock.cpp
           src/UI/egress-link-connection-widget.ui
           src/UI/egress-link-connection-widget.cpp
+          src/UI/ws-portal-dock.ui
+          src/UI/ws-portal-dock.cpp
           src/UI/resources.qrc
           src/sources/ingress-link-source.cpp
           src/sources/audio-capture.cpp
           src/sources/image-renderer.cpp
           src/outputs/egress-link-output.cpp
-          src/outputs/audio-source.cpp)
+          src/outputs/audio-source.cpp
+          src/ws-portal/ws-portal-client.cpp
+          src/ws-portal/event-handler.cpp)
 
 target_include_directories(
   ${CMAKE_PROJECT_NAME}
   PRIVATE ${CMAKE_SOURCE_DIR}/lib/o2/src ${CMAKE_SOURCE_DIR}/shared/properties-view
-          ${CMAKE_SOURCE_DIR}/shared/qt/vertical-scroll-area ${CMAKE_SOURCE_DIR}/shared/qt/wrappers)
+          ${CMAKE_SOURCE_DIR}/shared/qt/vertical-scroll-area ${CMAKE_SOURCE_DIR}/shared/qt/wrappers
+          ${CMAKE_SOURCE_DIR}/lib/obs-websocket/lib ${CMAKE_SOURCE_DIR}/lib/obs-websocket/src)
 
 if(NOT buildspec)
   file(READ "${CMAKE_CURRENT_SOURCE_DIR}/buildspec.json" buildspec)

README.md

@@ -23,7 +23,9 @@ SRC-Link works with [SRC-Link Control Panel](https://src-link.live/introduction)
 - **(Since 0.5.5)** Operation Teams allows to share receiver among your organization staffs to operate live streaming program jointly.
 - **(Since 0.6.0)** Stream Recording functionality records cleanfeed in guest's local disk.
 - **(Since 0.6.0)** External Connections allows SRC-Link connects to external SRT servers such as vMix, SRT MiniServer, Nimble Streamer etc..
-
+- **(Since 0.7.0)** WebSocket Portal for OBS provides an obs-websocket compatible server and allows remote control of 
+  OBS Studio over the Internet using obs-websocket clients. No open ports, tunneling or VPN is required.
+  
 **Glossary**
 
 - **HOST**: OBS instance (and SRC-Link user) receiving video and audio

README_ja.md

@@ -22,7 +22,9 @@ SRC-Link はウェブサービスの [SRC-Link Control Panel](https://src-link.l
 - **(0.5.5 より)** 運営チームを使用すると、組織のスタッフ間でレシーバーを共有し、ライブ配信を共同で運営できます。
 - **(0.6.0 より)** ストリーム録画機能は、ゲストのローカルディスクにクリーンフィードを録画します。
 - **(0.6.0 より)** 外部コネクションは、vMix や SRT MiniServer、Nimble Streamer 等の外部 SRT サーバーと SRC-Link を接続することができます。
-
+- **(0.7.0 より)** WebSocket ポータル for OBS は obs-websocket 互換のサーバーを提供し、obs-websocket クライアントを使った、
+  インターネット越しに OBS Studio のリモートコントロールを可能にします。ポートの開放やトンネリング、VPN は不要です。
+  
 **用語集**
 
 - **ホスト**: 映像音声を受信する OBS インスタンス（及び SRC-Link ユーザー）

buildspec.json

@@ -38,7 +38,7 @@
     },
     "name": "osi-src-link",
     "displayName": "SRC-Link Plugin",
-    "version": "0.6.1",
+    "version": "0.7.0",
     "author": "OPENSPHERE Inc.",
     "website": "https://opensphere.co.jp/",
     "email": "[email protected]",

data/locale/en-US.ini

@@ -59,7 +59,7 @@ SRCLinkDock="SRC-Link"
 SourceLinkSettings="SRC-Link Settings"
 oauth-reply.html="oauth-reply-en-US.html"
 DownlinkInput="SRC-Link Downlink"
-Uplink="Uplink"
+Uplink="Uplink Receiver"
 Interlock="Interlock"
 NoReceiver="No Receiver"
 LocalSource="Video Source"
@@ -127,4 +127,15 @@ SplitFile.NoSplit="No split"
 SplitFile.ByTime="Split by Time"
 SplitFile.BySize="Split by Size"
 SplitFile.Time="Split Time (Minutes)"
-SplitFile.Size="Split Size (MB)"
+SplitFile.Size="Split Size (MB)"
+OBSWebSocketPortal="OBS WebSocket Portal"
+NoPortal="No Portal"
+ManagePortals="Manage Portals"
+Connected="Connected"
+Disconnected="Disconnected"
+Reconnecting="Reconnecting"
+WsPortalDock="WebSocket Portal"
+NotReady="Not Ready"
+Linked="Linked"
+Unlinked="Unlinked"
+Retrying="Retrying"

data/locale/ja-JP.ini

@@ -59,7 +59,7 @@ SRCLinkDock="SRC-Link"
 SourceLinkSettings="SRC-Link 設定"
 oauth-reply.html="oauth-reply-ja-JP.html"
 DownlinkInput="SRC-Link ダウンリンク"
-Uplink="アップリンク"
+Uplink="アップリンク レシーバー"
 Interlock="連動"
 NoReceiver="レシーバーがありません"
 LocalSource="映像ソース"
@@ -128,3 +128,14 @@ SplitFile.ByTime="時間で分割"
 SplitFile.BySize="サイズで分割"
 SplitFile.Time="分割時間 (分)"
 SplitFile.Size="分割サイズ (MB)"
+OBSWebSocketPortal="OBS WebSocket ポータル"
+NoPortal="ポータルがありません"
+ManagePortals="ポータルを管理"
+Connected="接続済み"
+Disconnected="切断済み"
+Reconnecting="再接続中"
+WsPortalDock="WebSocket ポータル"
+NotReady="未接続"
+Linked="リンク済"
+Unlinked="未リンク"
+Retrying="再試行中"

lib/obs-websocket

@@ -98,14 +98,14 @@ EgressLinkConnectionWidget::~EgressLinkConnectionWidget()
 
 void EgressLinkConnectionWidget::onOBSSourcesChanged(void *data, calldata_t *)
 {
-    auto widget = (EgressLinkConnectionWidget *)data;
+    auto widget = static_cast<EgressLinkConnectionWidget *>(data);
     // Prevent crash
     QMetaObject::invokeMethod(widget, "updateSourceList", Qt::QueuedConnection);
 }
 
 void EgressLinkConnectionWidget::onOBSFrontendEvent(enum obs_frontend_event event, void *param)
 {
-    auto widget = (EgressLinkConnectionWidget *)param;
+    auto widget = static_cast<EgressLinkConnectionWidget *>(param);
     // Prevent to reset output config
     if (event == OBS_FRONTEND_EVENT_SCRIPTING_SHUTDOWN) {
         widget->sourceCreateSignal.Disconnect();
@@ -180,7 +180,7 @@ void EgressLinkConnectionWidget::updateSourceList()
 
         obs_enum_sources(
             [](void *param, obs_source_t *_source) {
-                auto widget = (EgressLinkConnectionWidget *)param;
+                auto widget = static_cast<EgressLinkConnectionWidget *>(param);
                 auto type = obs_source_get_type(_source);
                 auto flags = obs_source_get_output_flags(_source);
 
@@ -193,7 +193,7 @@ void EgressLinkConnectionWidget::updateSourceList()
         );
         obs_enum_scenes(
             [](void *param, obs_source_t *_source) {
-                auto widget = (EgressLinkConnectionWidget *)param;
+                auto widget = static_cast<EgressLinkConnectionWidget *>(param);
                 auto type = obs_source_get_type(_source);
 
                 if (type == OBS_SOURCE_TYPE_SCENE && isSourceAvailable(_source)) {

src/UI/egress-link-connection-widget.cpp

@@ -82,7 +82,6 @@ EgressLinkDock::EgressLinkDock(SRCLinkApiClient *_apiClient, QWidget *parent)
 
     // Translations
     ui->egressLinkLabel->setText(QTStr("Uplink"));
-    ui->participantLabel->setText(QTStr("Receiver"));
     ui->interlockTypeLabel->setText(QTStr("Interlock"));
     ui->participantComboBox->setPlaceholderText(QTStr("NoReceiver"));
     ui->controlPanelButton->setText(QTStr("SRCLinkControlPanel"));
@@ -237,18 +236,22 @@ void EgressLinkDock::onUplinkReady(const UplinkInfo &uplink)
         ui->seatAllocationStatus->setText(QTStr("Ready"));
         setThemeID(ui->seatAllocationSeatName, "good", "text-success");
         setThemeID(ui->seatAllocationStatus, "good", "text-success");
+    } else if (!uplink.getStage().isEmpty()) {
+        ui->seatAllocationSeatName->setText(QTStr("NoSlot"));
+        ui->seatAllocationStatus->setText(QTStr("Ready"));
+        setThemeID(ui->seatAllocationSeatName, "error", "text-danger");
+        setThemeID(ui->seatAllocationStatus, "good", "text-success");
     } else {
         ui->seatAllocationSeatName->setText("");
-        ui->seatAllocationStatus->setText(QTStr("NoSlot"));
-        setThemeID(ui->seatAllocationSeatName, "error", "text-danger");
+        ui->seatAllocationStatus->setText(QTStr("NotReady"));
         setThemeID(ui->seatAllocationStatus, "error", "text-danger");
     }
 }
 
 void EgressLinkDock::onUplinkFailed(const QString &)
 {
     ui->seatAllocationSeatName->setText("");
-    ui->seatAllocationStatus->setText(QTStr("NoSlot"));
+    ui->seatAllocationStatus->setText(QTStr("NotReady"));
     setThemeID(ui->seatAllocationStatus, "error", "text-danger");
 
     qDeleteAll(connectionWidgets);