Merge pull request #715 from Jocke4f/fix_665_obs_nested_sources

Added support for nested OBS scenes for websocket5
josephdadams · Aug 18, 2024 · d105f4c · d105f4c
2 parents 6104d5c + 90bf441
commit d105f4c
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 41 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -76,7 +76,7 @@
         "jspack": "^0.0.4",
         "node-emberplus": "^3.0.5",
         "obs-websocket-js": "npm:obs-websocket-js@^4.0.3",
-        "obs-websocket-js-5": "npm:obs-websocket-js@^5.0.2",
+        "obs-websocket-js-5": "npm:obs-websocket-js@^5.0.6",
         "osc": "^2.4.3",
         "rate-limiter-flexible": "^2.3.7",
         "reflect-metadata": "^0.1.13",

diff --git a/src/sources/OBS.ts b/src/sources/OBS.ts
@@ -422,19 +422,19 @@ export class OBSSource extends TallyInput {
         });
 
         this.obsClient5.on("CurrentPreviewSceneChanged", (data) => {
-            this.scenes5.forEach((scene) => {
-                if(scene !== data.sceneName) this.removeBusFromAddress(scene, "preview");
-            });
-            this.setBussesForAddress(data.sceneName, ["preview"]);
-            this.sendTallyData();
+            this.removeBusFromAllAddresses("preview");
+            this.addBusToAddress(data.sceneName, "preview");
+            this.processSceneChange5(data.sceneName, "preview");
+
+            //this.sendTallyData();
         });
 
         this.obsClient5.on("CurrentProgramSceneChanged", (data) => {
-            this.scenes5.forEach((scene) => {
-                if(scene !== data.sceneName) this.removeBusFromAddress(scene, "program");
-            });
-            this.setBussesForAddress(data.sceneName, ["program"]);
-            this.sendTallyData();
+            this.removeBusFromAllAddresses("program");
+            this.addBusToAddress(data.sceneName, "program");
+            this.processSceneChange5(data.sceneName, "program");
+
+            // this.sendTallyData();
         });
 
         this.obsClient5.on("CurrentSceneCollectionChanged", (data) => {
@@ -585,9 +585,11 @@ export class OBSSource extends TallyInput {
                 }
                 if(scene === data.currentPreviewSceneName) {
                     this.setBussesForAddress(scene, ["preview"]);
+                    this.processSceneChange5(scene, "preview");
                 }
                 if(scene === data.currentProgramSceneName) {
                     this.setBussesForAddress(scene, ["program"]);
+                    this.processSceneChange5(scene, "program")
                 }
                 if(scene != data.currentPreviewSceneName && scene != data.currentProgramSceneName) {
                     this.setBussesForAddress(scene, []);
@@ -598,6 +600,7 @@ export class OBSSource extends TallyInput {
         });
     }
 
+
     /** Adds a bus to the scene, nested scenes and scene sources.
      * @param sceneName - Name of the scene.
      * @param sources - List of scene sources (SceneItem).
@@ -618,6 +621,35 @@ export class OBSSource extends TallyInput {
         this.addBusToAddress(sceneName, bus);
     }
 
+
+    /** Adds a bus for the scene, nested scenes and scene sources.
+     * @param sceneName - Name of the scene.
+     * @param bus - Bus to assign (preview/program).
+     */
+    private processSceneChange5(sceneName: string, bus: string): void {
+        // No support for specific handling for Groups since Group usage is discouraged in OBS, see https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlist
+        this.obsClient5.call("GetSceneItemList", { sceneName: sceneName}).then((sceneItems) => {
+
+            let sceneSources = 0;
+            for (let i = 0; i < sceneItems.sceneItems.length; i++) {
+                // All scene source items to the bus
+                // Should a check be done for audio input if they are enabled?
+                this.addBusToAddress(sceneItems.sceneItems[i].sourceName as string, bus);
+                if (sceneItems.sceneItems[i].sourceType == "OBS_SOURCE_TYPE_INPUT") {
+                    sceneSources++;
+                } else if (sceneItems.sceneItems[i].sourceType == "OBS_SOURCE_TYPE_SCENE") {
+                    // Nested scene, dig deeper...
+                    this.processSceneChange5(sceneItems.sceneItems[i].sourceName as string, bus);
+                }
+            }
+
+            // If this scene doesn't contain a scene then we trigger this.sendTallyData().
+            // The check is done to keep uncessary updates to a minimum.
+            if (sceneSources == sceneItems.sceneItems.length) {this.sendTallyData();}
+        });
+    }
+
+
     /** Adds audio input to addresses, to the "audioInputs" list and change tally bus if it's not muted. */
     private addAudioInput(input): void {
         if (this.obsProtocolVersion === 4) {