Skip to content

getDevice optimization#1691

Open
sandboxcoder wants to merge 5 commits intostagingfrom
rno/get-properties
Open

getDevice optimization#1691
sandboxcoder wants to merge 5 commits intostagingfrom
rno/get-properties

Conversation

@sandboxcoder
Copy link
Copy Markdown
Contributor

@sandboxcoder sandboxcoder commented May 6, 2026

Description

  • revert 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.isOnDarwinCI() 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.
  • Adds a test for OBS_settings_getVideoDevices. Sadly, there is no virtual video device on the test runner so it only checks for empty array when ran on the runner. But when run locally, it is more useful because it can detect if the array is non-empty catching issues that could mess up the old onboarding flow, etc.

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread obs-studio-server/source/nodeobs_settings-osx.mm
Comment thread obs-studio-server/source/nodeobs_settings-osx.h Outdated
Comment thread obs-studio-server/source/nodeobs_settings.cpp Outdated
Comment thread obs-studio-server/source/nodeobs_settings.cpp Outdated
Comment thread tests/osn-tests/util/obs_handler.ts Outdated
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 6, 2026

CLA assistant check
All committers have signed the CLA.

@sandboxcoder sandboxcoder force-pushed the rno/get-properties branch from 5ce44ad to e05ad58 Compare May 7, 2026 01:26
@sandboxcoder sandboxcoder force-pushed the rno/get-properties branch from e05ad58 to 7d202e7 Compare May 7, 2026 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants