fix(audio): set the bits-per-sample of Steam Streaming Speakers to 16-bit when the default audio device is 16-bit #3704

andygrundman · 2025-03-05T02:54:01Z

Description

fix(audio): set the bits-per-sample of Steam Streaming Speakers to 16-bit when the default audio device is 16-bit. This may help with audio glitches when enabling the virtual device.

Screenshot

Issues Fixed or Closed

Resolves https://github.com/orgs/LizardByte/discussions/682

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Dependency update (updates to dependencies)
Documentation update (changes to documentation)
Repository update (changes to repository files, e.g. .github/...)

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

codecov · 2025-03-05T04:09:41Z

Codecov Report

Attention: Patch coverage is 5.88235% with 16 lines in your changes missing coverage. Please review.

Project coverage is 11.60%. Comparing base (fd9f10f) to head (b0db65c).

Files with missing lines	Patch %	Lines
src/platform/windows/audio.cpp	5.88%	16 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3704      +/-   ##
==========================================
- Coverage   11.61%   11.60%   -0.02%     
==========================================
  Files          92       92              
  Lines       17337    17353      +16     
  Branches     8100     8109       +9     
==========================================
  Hits         2013     2013              
- Misses      14727    14743      +16     
  Partials      597      597

Flag	Coverage Δ
Linux	`11.28% <ø> (ø)`
Windows	`12.99% <5.88%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/platform/windows/audio.cpp	`25.27% <5.88%> (-0.77%)`	⬇️

andygrundman · 2025-03-05T07:17:58Z

I'm going to rewrite this as a method that returns the default device format and actually matches the SSS to the device. It doesn't need to be specific to 16 bits.

andygrundman · 2025-03-05T13:58:30Z

This may have a bad bug :( I somehow caused it to run into some errors. I realized I'm not sure that I'm safely calling default_device(device_enum) and will need to read more of the docs.

Info: Reinitializing audio capture
Error: Couldn't initialize audio client for [Stereo]: [0x8889000A]
Error: Couldn't find supported format for audio
Warning: Couldn't re-initialize audio input

src/platform/windows/audio.cpp

andygrundman · 2025-03-06T11:04:41Z

OK, this is cleaned up and squashed to 1 commit. I discovered that the last patch I made to this file, removing f32 and s32 from stereo, would break this new logic if you had a 32-bit default device. The correct fix for that previous issue is just to put these at the bottom of the list so they aren't preferred over 24 and 16.

This now works well for me and I can't reproduce the issue I had. I have also added extra logging that may prove helpful if this doesn't solve the issue for people. Specifically I log the bps and samplerate of the internal mixer format, with a note about auto-resampling if it's not 48k.

… format * Match the virtual device's bits-per-sample to the default audio device, as a mismatch could cause audio glitches. * Add back f32 and s32 stereo formats which are now needed to support devices set to 32-bit. They are now lower priority than 24 and 16-bit to avoid regressing the fix for spatial audio settings. * Add more detailed logging around the virtual audio settings. Some users may be having problems caused by the internal mixer format, so that is now logged as well.

sonarqubecloud · 2025-03-15T14:55:31Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ReenigneArcher · 2025-03-19T17:12:57Z

src/platform/windows/audio.cpp

+  // The list of virtual formats are sorted in preference order and the first valid format will be used.
+  // All bits-per-sample options are listed because we try to match this to the default audio device.


This seems like a good opportunity to document the template better. Could you document this template using a doxygen comment block?

/** * @brief ... * @tparam ... */

https://docs.lizardbyte.dev/projects/sunshine/latest/md_third-party_2doxyconfig_2docs_2source__code.html#documentation-blocks

https://stackoverflow.com/a/13359876

ReenigneArcher · 2025-03-19T17:13:55Z

src/platform/windows/audio.cpp

      };
    } else if (channel_count == 6) {
      auto channel_mask1 = waveformat_mask_surround51_with_backspeakers;
-      auto channel_mask2 = waveformat_mask_surround51_with_sidespeakers;
+      auto channel_mask2 = waveformat_mask_surround51_with_sidespeakers;  // XXX will never be used, but is probably the better 5.1 layout


What is XXX indicating here? Just calling extra attention to the note?

I'm not sure it's actually true either. I thought 5.1 with surrounds as back speakers was pretty universal. @andygrundman did you have more context to add here?

Back in the DVD era, 5.1 had the 2 rear speakers on the side walls at 90 degrees and also they were a few feet above ear level. In the modern 5.1 layout for Atmos, Dolby says it's anywhere between 110 and 120 degrees, and everything is at ear level now. One thing that was never an actual thing is 5.1 with 180 degree rear wall speakers. Those speakers are what you add to the side speakers to get a 7.1 system (where sides are back to 90 degrees). So the right 5.1 would be putting them at 120, splitting the difference, but Microsoft is stuck with their legacy options, and an Atmos option that we can't really use.

I think in practice, it doesn't matter where the rear speakers are as long as it's sort of behind you a little bit. My comment preferring 5.1-side is partly because I'm old, but mostly referring to the way the ordering works in Sunshine, those other options won't ever be used and the user can't choose them. Really I'm happy if the channels are all lined up correctly on the client side. 7.1 was different from Windows in SDL for years and nobody noticed until we got it patched recently. (That was actually a Mac issue and don't get me started about Apple, with probably a hundred weird speaker layouts in their header files).

ReenigneArcher · 2025-03-19T17:15:43Z

src/platform/windows/audio.cpp

+        audio::prop_t prop;
+        prop_var_t current_device_format;
+
+        // clang-format off: easier to read this split over 2 lines


I know it's not ideal to have this on a long line, but I'd prefer not to have clang-format exceptions for this. I'm open to different clang-format rules though to help make things more readable.

ReenigneArcher reviewed Mar 5, 2025

View reviewed changes

src/platform/windows/audio.cpp Outdated Show resolved Hide resolved

ReenigneArcher marked this pull request as draft March 5, 2025 14:04

andygrundman force-pushed the andyg.16bit-steam-speakers branch from 7859814 to e7df2a3 Compare March 6, 2025 10:59

andygrundman marked this pull request as ready for review March 6, 2025 11:07

andygrundman force-pushed the andyg.16bit-steam-speakers branch from e7df2a3 to 754a825 Compare March 6, 2025 11:15

Merge branch 'LizardByte:master' into andyg.16bit-steam-speakers

4f3fc87

ReenigneArcher reviewed Mar 19, 2025

View reviewed changes

ReenigneArcher added this to the stable release milestone Mar 19, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(audio): set the bits-per-sample of Steam Streaming Speakers to 16-bit when the default audio device is 16-bit #3704

fix(audio): set the bits-per-sample of Steam Streaming Speakers to 16-bit when the default audio device is 16-bit #3704

andygrundman commented Mar 5, 2025 •

edited by ReenigneArcher

Loading

codecov bot commented Mar 5, 2025 •

edited

Loading

andygrundman commented Mar 5, 2025

andygrundman commented Mar 5, 2025 •

edited

Loading

andygrundman commented Mar 6, 2025 •

edited

Loading

sonarqubecloud bot commented Mar 15, 2025

ReenigneArcher Mar 19, 2025 •

edited

Loading

ReenigneArcher Mar 19, 2025

cgutman Mar 27, 2025

andygrundman Mar 27, 2025 •

edited

Loading

ReenigneArcher Mar 19, 2025

		// The list of virtual formats are sorted in preference order and the first valid format will be used.
		// All bits-per-sample options are listed because we try to match this to the default audio device.

fix(audio): set the bits-per-sample of Steam Streaming Speakers to 16-bit when the default audio device is 16-bit #3704

Are you sure you want to change the base?

fix(audio): set the bits-per-sample of Steam Streaming Speakers to 16-bit when the default audio device is 16-bit #3704

Conversation

andygrundman commented Mar 5, 2025 • edited by ReenigneArcher Loading

Description

Screenshot

Issues Fixed or Closed

Type of Change

Checklist

codecov bot commented Mar 5, 2025 • edited Loading

Codecov Report

andygrundman commented Mar 5, 2025

andygrundman commented Mar 5, 2025 • edited Loading

andygrundman commented Mar 6, 2025 • edited Loading

sonarqubecloud bot commented Mar 15, 2025

Quality Gate passed

ReenigneArcher Mar 19, 2025 • edited Loading

Choose a reason for hiding this comment

ReenigneArcher Mar 19, 2025

Choose a reason for hiding this comment

cgutman Mar 27, 2025

Choose a reason for hiding this comment

andygrundman Mar 27, 2025 • edited Loading

Choose a reason for hiding this comment

ReenigneArcher Mar 19, 2025

Choose a reason for hiding this comment

andygrundman commented Mar 5, 2025 •

edited by ReenigneArcher

Loading

codecov bot commented Mar 5, 2025 •

edited

Loading

andygrundman commented Mar 5, 2025 •

edited

Loading

andygrundman commented Mar 6, 2025 •

edited

Loading

ReenigneArcher Mar 19, 2025 •

edited

Loading

andygrundman Mar 27, 2025 •

edited

Loading