MacOS getDevice() optimization, set CI env var, & add getVideoDevices() test by sandboxcoder · Pull Request #1691 · streamlabs/obs-studio-node

sandboxcoder · 2026-05-06T22:16:56Z

Description

Restore commit 9279b8a now that this has been fully root caused. Bringing back this change because it fixes the case where coreaudio spins up a reconnect_thread whenever Desktop queries for audio devices. This was because the previous implementation passed in a dummy device which causes coreaudio to create a thread to poll if this dummy device is later initialized. This will cleanup the logs eliminating this warning (32 occurrences in a log I checked from Desktop): [Warning] [coreaudio_get_device_name] failed to get name: 560947818
Set CI env flag for mac test CI. This is so we can use the new obs.isCI() function to determine if we're running in a CI env (no GPU) very quickly from the tests.
Add custom implementation to enumerate video devices on MacOS (Windows already does this). This new optimization to getDevices won't work for video plugins that requires to be initialized before returning properties thus requiring a workaround now. However, the bonus is now we do not have to worry about video plugins (like mac-avcapture-fast) breaking that requires the graphics pipeline to be init before calling it (so now mac-avcapture-fast plugin can be utilized on frontend if desired).
Adds a test for OBS_settings_getVideoDevices.
test_osn_advanced_replayBuffer.ts: still flaky on macOS test runner so
disable on CI runner

Performance:
New implementation (nanoseconds)

[000:00:00:02.369.327.958][66014221][Info] OBS_settings_getVideoDevices took 17846792 (almost 18ms but luckily this only invoked once)
[000:00:00:03.691.221.250][66014221][Info] OBS_settings_getInputAudioDevices took 400125
[000:00:00:03.691.641.333][66014221][Info] OBS_settings_getOutputAudioDevices took 288458

Old (nanoseconds)

[000:00:00:02.316.142.542][65989647][Info] OBS_settings_getVideoDevices took 16888125 (almost 17ms but only called once)
[000:00:00:03.530.971.333][65989647][Info] OBS_settings_getInputAudioDevices took 721292
[000:00:00:03.531.601.833][65989647][Info] OBS_settings_getOutputAudioDevices took 479084

The new getDevices implementation is more efficient since it does not create a dummy_source. Also, it avoids triggering coreaudio to create a reconnect_thread for a dummy device (which saves us another 2ms or so in an async thread because mac-coreaudio polls within the reconnect_thread). However, the new implementation to collect video devices is very similar performance wise (about 1ms difference) but that is only invoked once at startup whereas audio devices are queried much more frequently.

Motivation and Context

When I was looking into profiling missing source devices it reminded me that getDevices() triggers coreaudio to create a reconnect_thread which does later get reaped however it did not seem ideal. But it would be nice to avoid this. Currently, desktop queries getAudioDevices() at least around 14 times so it is nice to optimize this to get the app to load up faster and spin up less threads. Also, it is good to avoid spinning up a dummy_source for mac-capture video plugins specifically- since the newer ones (like mac-avcapture-fast) require graphics to be init first. So were unable to use that plugin because Desktop queries video devices before initializing graphics. But now that we manually enumerate video devices we should be to use that plugin now.

How Has This Been Tested?

Locally, I verified the same audio/video devices are output. Originally, commit 9279b8a was reverted due to breaking the old onboarding flow (no webcam detected) but that is addressed in this PR since we will enumerate video devices a different way to avoid that.

Types of changes

Performance enhancement (non-breaking change which improves efficiency)

Checklist:

The code has been tested.
All commit messages are properly formatted and commits squashed where appropriate.
I have included updates to all appropriate documentation.

Copilot

Pull request overview

This PR reintroduces and refines a getDevices optimization to avoid creating dummy sources (notably preventing CoreAudio from spinning up unnecessary reconnect threads), adds a macOS-specific video device enumeration path to avoid plugin initialization requirements, and updates CI/test utilities to better handle Darwin CI constraints.

Changes:

Replace dummy-source-based property enumeration with obs_get_source_properties() for device listing, and add warning logs on property lookup failures.
Implement manual macOS video device enumeration via AVFoundation and route OBS_settings_getVideoDevices (macOS) through it.
Add/adjust OSN tests and CI flags to better detect Darwin CI and validate video device enumeration output shape.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/osn-tests/util/obs_handler.ts	Adds `isOnDarwinCI()` helper for test gating on macOS CI.
tests/osn-tests/util/error_messages.ts	Adds new error messages for video device enumeration tests.
tests/osn-tests/src/test_osn_video.ts	Adds a test for `OBS_settings_getVideoDevices()` return shape and (non-CI) non-empty expectation.
tests/osn-tests/src/test_osn_audio.ts	Gates default output device expectation behind `isOnDarwinCI()`.
obs-studio-server/source/nodeobs_settings.cpp	Updates `getDevices()` to avoid dummy source creation; macOS video devices now enumerated via new macOS helper.
obs-studio-server/source/nodeobs_settings-osx.mm	New AVFoundation-based macOS video device enumeration implementation.
obs-studio-server/source/nodeobs_settings-osx.h	Declares macOS video device enumeration helper.
obs-studio-server/CMakeLists.txt	Adds new macOS settings enumeration sources to the build.
.github/workflows/main.yml	Explicitly sets `CI=true` for the macOS test job environment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

CLAassistant · 2026-05-06T23:52:05Z

All committers have signed the CLA.

This reverts commit 4434fda.

* isDarwin() now checks CI env var. This way all tests can be run locally * test_osn_audio: do not check for default audio device on the test runner * test_osn_advanced_replayBuffer.ts: still flaky on macOS test runner so disable on those * main.yml: add CI environment variable

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

+	auto props = obs_get_source_properties(source_id);
 	if (!props) {
-		obs_source_release(dummy_source);
-		obs_data_release(settings);
+		blog(LOG_WARNING, "Could not get source properties for source id: %s", source_id);
 		return;
 	}

 	auto prop = obs_properties_get(props, property_name);
 	if (!prop) {
+		blog(LOG_WARNING, "Could not get the property [%s] for source id: %s", property_name, source_id);
 		obs_properties_destroy(props);


Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

    it('Start advanced replay buffer - Use Recording', async function() {
+        if (obs.isDarwin()) {
+            this.skip();
+        }


    it('Start advanced replay buffer - Use Stream through Recording', async function() {
+        if (obs.isDarwin()) {
+            this.skip();
+        }


            }
        }
-        if (!obs.isDarwin()) { // On virtual mac the default output device is not included in the list of output devices
+        // On the CI, mac-coreaudio will not return a default device unless there is another output audio device.


+    it('Get output video devices', function() {
+        const devices = osn.NodeObs.OBS_settings_getVideoDevices();
+        expect(devices).to.not.equal(undefined, GetErrorMessage(ETestErrorMsg.VideoDevices));
+        expect(Array.isArray(devices)).to.equal(true, GetErrorMessage(ETestErrorMsg.VideoDevicesIsArray));
+        for (const device of devices) {
+            expect(device).to.have.property('id');
+            expect(device).to.have.property('description');
+            logInfo(testName, `Output Video Device Found: ${device.description} with id: ${device.id}`);


sandboxcoder force-pushed the rno/get-properties branch from 3a0c9ba to a935b64 Compare May 6, 2026 23:14

sandboxcoder requested a review from Copilot May 6, 2026 23:32

Copilot started reviewing on behalf of sandboxcoder May 6, 2026 23:33 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

Copilot started work on behalf of sandboxcoder May 6, 2026 23:51 View session

Copilot finished work on behalf of sandboxcoder May 6, 2026 23:52

sandboxcoder added 3 commits May 6, 2026 20:25

Revert "settings: revert 01b09d9 / fix device list (#1609)"

81c832a

This reverts commit 4434fda.

add test case to verify output devices

fe95060

adding method to enumerate video devices on MacOS

a39239f

sandboxcoder force-pushed the rno/get-properties branch from 5ce44ad to e05ad58 Compare May 7, 2026 01:26

cleanup getDevices and add fallback for older MacOS

04b54cb

sandboxcoder force-pushed the rno/get-properties branch from e05ad58 to 7d202e7 Compare May 7, 2026 01:32

sandboxcoder force-pushed the rno/get-properties branch from 32817d2 to 8b48df9 Compare May 7, 2026 15:36

sandboxcoder changed the title ~~getDevice optimization~~ MacOS getDevice() optimization, set CI env var, & add getVideoDevices() test May 7, 2026

sandboxcoder requested a review from Copilot May 7, 2026 17:18

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 17:19 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

sandboxcoder requested a review from Copilot May 7, 2026 18:12

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 18:12 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

update getDevices() to return errorCode properly & keep CI setting

9b7e04f

sandboxcoder force-pushed the rno/get-properties branch from 65e6812 to 9b7e04f Compare May 7, 2026 18:20

add condition to skip on CI runners

6010f2b

sandboxcoder requested a review from Copilot May 7, 2026 18:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MacOS getDevice() optimization, set CI env var, & add getVideoDevices() test#1691

MacOS getDevice() optimization, set CI env var, & add getVideoDevices() test#1691
sandboxcoder wants to merge 7 commits intostagingfrom
rno/get-properties

sandboxcoder commented May 6, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CLAassistant commented May 6, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

sandboxcoder commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CLAassistant commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sandboxcoder commented May 6, 2026 •

edited

Loading

CLAassistant commented May 6, 2026 •

edited

Loading