Merge branch 'staging' into auto_config_apiv2

Resolved conflicts:
- obs-studio-client/source/video.cpp: keep staging's ValidateResponse check in Video::set; do not reintroduce the lastVideo cache (removed on this branch).
- obs-studio-server/source/osn-simple-streaming.cpp: keep this branch's reconnect guard plus staging's GetCanvasVideo and encoder-compatibility guards.
- js/module.js: regenerated from merged module.ts via build:javascript.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: summeroff

.github/workflows/check-js-generated.yml

@@ -0,0 +1,36 @@
+name: Check Generated JS
+
+on:
+  push:
+    paths-ignore: ['**.md']
+    branches-ignore: [staging]
+  pull_request:
+    paths-ignore: ['**.md']
+    branches-ignore: [staging]
+
+permissions:
+  contents: read
+
+jobs:
+  check-js-generated:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install dependencies
+        run: |
+          corepack enable
+          corepack prepare yarn@4.14.1 --activate
+          yarn install --immutable
+
+      - name: Regenerate js/ outputs
+        run: yarn run build:javascript
+
+      - name: Fail if generated files are stale
+        run: ./ci/check-js-generated.sh

.github/workflows/main.yml

@@ -25,7 +25,7 @@ env:
   SLGenerator: Visual Studio 17 2022
   SLDistributeDirectory: distribute
   SLFullDistributePath: "streamlabs-build.app/distribute" # The .app extension is required to run macOS tests correctly.
-  LibOBSVersion: 31.1.2sl13
+  LibOBSVersion: 31.1.2sl20
   PACKAGE_NAME: osn
 
 jobs:

CMakeLists.txt

@@ -81,6 +81,9 @@ include(ExternalProject)
 include(DownloadProject)
 include(FetchContent)
 
+option(BUILD_TESTING "Build C++ unit tests" ON)
+include(CTest)
+
 if(MSVC)
 	add_definitions(/MP)
 	add_link_options(/debug:fastlink)
@@ -118,6 +121,21 @@ if(NOT nlohmannjson_POPULATED)
   FetchContent_Populate(nlohmannjson)
 endif()
 
+if(BUILD_TESTING)
+  FetchContent_Declare(
+    Catch2
+    GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+    GIT_TAG        v3.11.0
+  )
+
+  set(CATCH_INSTALL_DOCS OFF CACHE BOOL "" FORCE)
+  set(CATCH_INSTALL_EXTRAS ON CACHE BOOL "" FORCE)
+  set(CATCH_DEVELOPMENT_BUILD OFF CACHE BOOL "" FORCE)
+
+  FetchContent_MakeAvailable(Catch2)
+  list(APPEND CMAKE_MODULE_PATH "${catch2_SOURCE_DIR}/extras")
+endif()
+
 FetchContent_Declare(
 	libcurl
 	URL https://curl.se/download/curl-7.88.1.tar.gz

README.md

@@ -104,6 +104,10 @@ scan-build --keep-empty -internal-stats -stats -v -v -v -o check ninja.exe
 ```
 Step with `"fixing"` errors is important as code base and especially third-party code are not ready to be build with clang. And files which failed to compile will not be scanned for errors.
 
+#### Generated JS surface (`js/module.{js,d.ts}`)
+
+`js/module.ts` is the source of truth. `js/module.js` and `js/module.d.ts` (and the `index.*` / `type_check.*` siblings) are tsc outputs of `js/tsconfig.json` — the npm package ships them as-is, so they're committed. Regenerate with `yarn build:javascript`. `yarn local:build` already chains it. CI rejects stale outputs via `.github/workflows/check-js-generated.yml` (`ci/check-js-generated.sh`).
+
 ### Tests
 
 The tests for obs studio node are written in Typescript and use Mocha as test framework, with electron-mocha pacakage to make Mocha run in Electron, and Chai as assertion framework.

ci/check-js-generated.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# Verify that the committed tsc outputs under js/ match what regenerating
+# from js/module.ts would produce. CI runs `yarn build:javascript` first,
+# so any change under js/ at this point is a stale generated file.
+dirty=$(git status --porcelain -- js/)
+
+set +x
+if [[ $dirty ]]; then
+	echo "================================================="
+	echo "Generated JS files are stale. Run locally:"
+	echo "    yarn build:javascript"
+	echo "and commit the regenerated files."
+	echo ""
+	echo "Stale files:"
+	echo "$dirty"
+	echo "================================================="
+	exit 1
+fi

ci/run-unit-tests.js

@@ -0,0 +1,54 @@
+"use strict";
+
+const { spawnSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+
+const buildDirectory =
+  process.env.SLBUILDDIRECTORY ||
+  process.env.SLBuildDirectory ||
+  process.env.BUILD_DIRECTORY ||
+  "build";
+const buildConfig = process.env.BUILD_CONFIG || process.env.BuildConfig || "RelWithDebInfo";
+const target = "obs_studio_client_unit_tests";
+// Match the TEST_PREFIX passed to catch_discover_tests so ctest only runs this unit-test suite.
+const testPattern = `^${target}::`;
+
+function hasDiscoveredTests() {
+  const testsDirectory = path.join(buildDirectory, "obs-studio-client");
+
+  try {
+    return fs
+      .readdirSync(testsDirectory)
+      .some(fileName => fileName.startsWith(`${target}-`) && fileName.endsWith("_tests.cmake"));
+  } catch {
+    return false;
+  }
+}
+
+function run(command, args) {
+  const result = spawnSync(command, args, { stdio: "inherit" });
+
+  if (result.error) {
+    console.error(result.error.message);
+    process.exit(1);
+  }
+
+  if (result.status !== 0) {
+    process.exit(result.status);
+  }
+}
+
+const skipBuild =
+  process.env.OSN_SKIP_UNIT_TEST_BUILD === "1" ||
+  // Test jobs run from uploaded build artifacts. Building again can force CMake
+  // to reconfigure FetchContent checkouts whose hidden .git directories were not uploaded.
+  (process.env.GITHUB_ACTIONS === "true" && hasDiscoveredTests());
+
+if (skipBuild) {
+  console.log("Skipping unit-test build; discovered CTest tests are already present.");
+} else {
+  run("cmake", ["--build", buildDirectory, "--config", buildConfig, "--target", target]);
+}
+
+run("ctest", ["--test-dir", buildDirectory, "-C", buildConfig, "--output-on-failure", "-R", testPattern]);

js/module.d.ts

@@ -296,7 +296,6 @@ export declare const InputFactory: IInputFactory;
 export declare const SceneFactory: ISceneFactory;
 export declare const FilterFactory: IFilterFactory;
 export declare const TransitionFactory: ITransitionFactory;
-export declare const DisplayFactory: IDisplayFactory;
 export declare const VolmeterFactory: IVolmeterFactory;
 export declare const FaderFactory: IFaderFactory;
 export declare const Audio: IAudio;
@@ -351,19 +350,15 @@ export interface IIPC {
     disconnect(): void;
 }
 export interface IGlobal {
-    startup(locale: string, path?: string): void;
-    shutdown(): void;
     getOutputFlagsFromId(id: string): number;
     setOutputSource(channel: number, input: ISource): void;
     getOutputSource(channel: number): ISource;
     addSceneToBackstage(input: ISource): void;
     removeSceneFromBackstage(input: ISource): void;
     readonly totalFrames: number;
     readonly laggedFrames: number;
-    readonly initialized: boolean;
     locale: string;
     multipleRendering: boolean;
-    readonly version: number;
     readonly cpuPercentage: number;
     readonly currentFrameRate: number;
     readonly averageFrameRenderTime: number;
@@ -424,7 +419,6 @@ export interface INumberDetails {
     readonly step: number;
 }
 export interface IProperty {
-    readonly status: number;
     readonly name: string;
     readonly description: string;
     readonly longDescription: string;
@@ -433,11 +427,14 @@ export interface IProperty {
     readonly type: EPropertyType;
     readonly value: any;
     next(): IProperty;
+    previous(): IProperty;
+    is_first(): boolean;
+    is_last(): boolean;
     modified(): boolean;
 }
 export interface IProperties {
-    readonly status: number;
     first(): IProperty;
+    last(): IProperty;
     count(): number;
     get(name: string): IProperty;
 }
@@ -522,8 +519,9 @@ export interface IInput extends ISource {
     sendFocus(focus: boolean): void;
     sendKeyClick(eventData: IKeyEvent, keyUp: boolean): void;
     setFilterOrder(filter: IFilter, movement: EOrderMovement): void;
-    setFilterOrder(filter: IFilter, movement: EOrderMovement): void;
+    copyFilters(other: IInput): boolean;
     readonly filters: IFilter[];
+    readonly active: boolean;
     readonly width: number;
     readonly height: number;
     getDuration(): number;
@@ -532,6 +530,8 @@ export interface IInput extends ISource {
     pause(): void;
     restart(): void;
     stop(): void;
+    getMediaState(): number;
+    load(): void;
 }
 export interface ISceneFactory {
     create(name: string): IScene;
@@ -547,6 +547,13 @@ export interface IScene extends ISource {
     findItem(id: string | number): ISceneItem;
     getItemAtIdx(idx: number): ISceneItem;
     getItems(): ISceneItem[];
+    getItemsInRange(fromIndex: number, toIndex: number): ISceneItem[];
+    load(): void;
+    sendMouseClick(eventData: IMouseEvent, type: EMouseButtonType, mouseUp: boolean, clickCount: number): void;
+    sendMouseMove(eventData: IMouseEvent, mouseLeave: boolean): void;
+    sendMouseWheel(eventData: IMouseEvent, x_delta: number, y_delta: number): void;
+    sendFocus(focus: boolean): void;
+    sendKeyClick(eventData: IKeyEvent, keyUp: boolean): void;
 }
 export interface ISceneItem {
     readonly source: IInput;
@@ -588,6 +595,12 @@ export interface ITransition extends ISource {
     clear(): void;
     set(input: ISource): void;
     start(ms: number, input: ISource): void;
+    load(): void;
+    sendMouseClick(eventData: IMouseEvent, type: EMouseButtonType, mouseUp: boolean, clickCount: number): void;
+    sendMouseMove(eventData: IMouseEvent, mouseLeave: boolean): void;
+    sendMouseWheel(eventData: IMouseEvent, x_delta: number, y_delta: number): void;
+    sendFocus(focus: boolean): void;
+    sendKeyClick(eventData: IKeyEvent, keyUp: boolean): void;
 }
 export interface IConfigurable {
     update(settings: ISettings): void;
@@ -631,26 +644,6 @@ export interface IVolmeter {
 }
 export interface ICallbackData {
 }
-export interface IDisplayFactory {
-    create(source?: IInput): IDisplay;
-}
-export interface IDisplay {
-    destroy(): void;
-    setPosition(x: number, y: number): void;
-    getPosition(): IVec2;
-    setSize(x: number, y: number): void;
-    getSize(): IVec2;
-    getPreviewOffset(): IVec2;
-    getPreviewSize(x: number, y: number): void;
-    shouldDrawUI: boolean;
-    paddingSize: number;
-    setPaddingColor(r: number, g: number, b: number, a: number): void;
-    setBackgroundColor(r: number, g: number, b: number, a: number): void;
-    setOutlineColor(r: number, g: number, b: number, a: number): void;
-    setGuidelineColor(r: number, g: number, b: number, a: number): void;
-    setResizeBoxOuterColor(r: number, g: number, b: number, a: number): void;
-    setResizeBoxInnerColor(r: number, g: number, b: number, a: number): void;
-}
 export interface IVideoInfo {
     fpsNum: number;
     fpsDen: number;
@@ -692,22 +685,18 @@ export interface IAudioFactory {
     disableAudioDucking: boolean;
     disableAudioDuckingLegacy: boolean;
 }
-export interface IModuleFactory extends IFactoryTypes {
+export interface IModuleFactory {
     open(binPath: string, dataPath: string): IModule;
-    loadAll(): void;
-    addPath(path: string, dataPath: string): void;
-    logLoaded(): void;
     modules(): String[];
 }
 export interface IModule {
     initialize(): void;
-    filename(): string;
-    name(): string;
-    author(): string;
-    description(): string;
-    binPath(): string;
-    dataPath(): string;
-    status(): number;
+    readonly fileName: string;
+    readonly name: string;
+    readonly author: string;
+    readonly description: string;
+    readonly binaryPath: string;
+    readonly dataPath: string;
 }
 export declare function addItems(scene: IScene, sceneItems: ISceneItemInfo[]): ISceneItem[];
 export interface FilterInfo {

js/module.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeObs = exports.AdvancedReplayBufferFactory = exports.SimpleReplayBufferFactory = exports.AudioEncoderFactory = exports.AdvancedRecordingFactory = exports.SimpleRecordingFactory = exports.AudioTrackFactory = exports.NetworkFactory = exports.ReconnectFactory = exports.DelayFactory = exports.EnhancedBroadcastingSimpleStreamingFactory = exports.EnhancedBroadcastingAdvancedStreamingFactory = exports.AdvancedStreamingFactory = exports.SimpleStreamingFactory = exports.ServiceFactory = exports.VideoEncoderFactory = exports.IPC = exports.ModuleFactory = exports.AudioFactory = exports.Audio = exports.FaderFactory = exports.VolmeterFactory = exports.DisplayFactory = exports.TransitionFactory = exports.FilterFactory = exports.SceneFactory = exports.InputFactory = exports.VideoFactory = exports.Video = exports.Global = exports.DefaultPluginPathMac = exports.DefaultPluginDataPath = exports.DefaultPluginPath = exports.DefaultDataPath = exports.DefaultBinPath = exports.DefaultDrawPluginPath = exports.DefaultOpenGLPath = exports.DefaultD3D11Path = void 0;
+exports.NodeObs = exports.AdvancedReplayBufferFactory = exports.SimpleReplayBufferFactory = exports.AudioEncoderFactory = exports.AdvancedRecordingFactory = exports.SimpleRecordingFactory = exports.AudioTrackFactory = exports.NetworkFactory = exports.ReconnectFactory = exports.DelayFactory = exports.EnhancedBroadcastingSimpleStreamingFactory = exports.EnhancedBroadcastingAdvancedStreamingFactory = exports.AdvancedStreamingFactory = exports.SimpleStreamingFactory = exports.ServiceFactory = exports.VideoEncoderFactory = exports.IPC = exports.ModuleFactory = exports.AudioFactory = exports.Audio = exports.FaderFactory = exports.VolmeterFactory = exports.TransitionFactory = exports.FilterFactory = exports.SceneFactory = exports.InputFactory = exports.VideoFactory = exports.Video = exports.Global = exports.DefaultPluginPathMac = exports.DefaultPluginDataPath = exports.DefaultPluginPath = exports.DefaultDataPath = exports.DefaultBinPath = exports.DefaultDrawPluginPath = exports.DefaultOpenGLPath = exports.DefaultD3D11Path = void 0;
 exports.addItems = addItems;
 exports.createSources = createSources;
 exports.getSourcesSize = getSourcesSize;
@@ -25,7 +25,6 @@ exports.InputFactory = obs.Input;
 exports.SceneFactory = obs.Scene;
 exports.FilterFactory = obs.Filter;
 exports.TransitionFactory = obs.Transition;
-exports.DisplayFactory = obs.Display;
 exports.VolmeterFactory = obs.Volmeter;
 exports.FaderFactory = obs.Fader;
 exports.Audio = obs.Audio;
@@ -66,7 +65,6 @@ function createSources(sources) {
     const items = [];
     if (Array.isArray(sources)) {
         sources.forEach(function (source) {
-            var _a, _b, _c;
             let newSource = null;
             try {
                 newSource = obs.Input.create(source.type, source.name, source.settings);
@@ -77,17 +75,16 @@ function createSources(sources) {
             }
             if (newSource) {
                 if (newSource.audioMixers) {
-                    newSource.muted = (_a = source.muted) !== null && _a !== void 0 ? _a : false;
-                    newSource.volume = (_b = source.volume) !== null && _b !== void 0 ? _b : 1;
-                    newSource.syncOffset = (_c = source.syncOffset) !== null && _c !== void 0 ? _c : { sec: 0, nsec: 0 };
+                    newSource.muted = source.muted ?? false;
+                    newSource.volume = source.volume ?? 1;
+                    newSource.syncOffset = source.syncOffset ?? { sec: 0, nsec: 0 };
                 }
                 newSource.deinterlaceMode = source.deinterlaceMode;
                 newSource.deinterlaceFieldOrder = source.deinterlaceFieldOrder;
                 items.push(newSource);
                 const filters = source.filters;
                 if (Array.isArray(filters)) {
                     filters.forEach(function (filter) {
-                        var _a;
                         let ObsFilter = null;
                         try {
                             ObsFilter = obs.Filter.create(filter.type, filter.name, filter.settings);
@@ -96,7 +93,7 @@ function createSources(sources) {
                             console.error(`[OSN] Failed to create filter "${filter.name}" for source "${source.name}":`, filterError instanceof Error ? filterError.message : filterError);
                         }
                         if (ObsFilter) {
-                            ObsFilter.enabled = (_a = filter.enabled) !== null && _a !== void 0 ? _a : true;
+                            ObsFilter.enabled = filter.enabled ?? true;
                             newSource.addFilter(ObsFilter);
                             ObsFilter.release();
                         }