Expose OpenAL doppler factor

RELEASE-NOTES.md

@@ -39,7 +39,7 @@ END TEMPLATE-->
 
 ### New features
 
-*None yet*
+* Added doppler factor as a CVar.
 
 ### Bugfixes
 

Robust.Client/Audio/AudioManager.Public.cs

@@ -2,7 +2,9 @@
 using System.IO;
 using System.Numerics;
 using System.Threading;
+using JetBrains.Annotations;
 using OpenTK.Audio.OpenAL;
+using Robust.Shared;
 using Robust.Client.Audio.Sources;
 using Robust.Client.Graphics;
 using Robust.Shared.Audio;
@@ -16,6 +18,12 @@ internal partial class AudioManager
 {
     private float _zOffset;
 
+    /// <inheritdoc />
+    public float MasterGain { get; private set; }
+
+    /// <inheritdoc />
+    public float DopplerFactor { get; private set; } = 1f;
+
     public void SetZOffset(float offset)
     {
         _zOffset = offset;
@@ -229,13 +237,11 @@ public AudioStream LoadAudioRaw(ReadOnlySpan<short> samples, int channels, int s
 
     public void SetMasterGain(float newGain)
     {
-        if (newGain < 0f)
-        {
-            OpenALSawmill.Error("Tried to set master gain below 0, clamping to 0");
-            AL.Listener(ALListenerf.Gain, 0f);
-            return;
-        }
+        if (!float.IsFinite(newGain))
+            newGain = 0f;
 
+        newGain = MathF.Max(newGain, 0f);
+        MasterGain = newGain;
 
         #region Platform hack for MacOS
         // HACK/BUG: Apple's OpenAL implementation has a bug where values of 0f for listener gain don't actually
@@ -251,6 +257,18 @@ public void SetMasterGain(float newGain)
         AL.Listener(ALListenerf.Gain, newGain);
     }
 
+    private void SetDopplerFactor(float value)
+    {
+        if (!float.IsFinite(value))
+            value = 0f;
+
+        value = MathF.Max(value, 0f);
+
+        DopplerFactor = value;
+        AL.DopplerFactor(value);
+        _checkAlError();
+    }
+
     public void SetAttenuation(Attenuation attenuation)
     {
         switch (attenuation)

Robust.Client/Audio/AudioManager.cs

@@ -143,6 +143,7 @@ private void InitializeAudio()
         IsEfxSupported = HasAlDeviceExtension("ALC_EXT_EFX");
 
         _cfg.OnValueChanged(CVars.AudioMasterVolume, SetMasterGain, true);
+        _cfg.OnValueChanged(CVars.AudioDopplerFactor, SetDopplerFactor, true);
 
         _reload.Register("/Audio", "*.ogg");
         _reload.Register("/Audio", "*.wav");

Robust.Client/Audio/HeadlessAudioManager.cs

@@ -1,8 +1,11 @@
 using System;
 using System.IO;
 using System.Numerics;
+using Robust.Shared;
 using Robust.Shared.Audio;
 using Robust.Shared.Audio.AudioLoading;
+using Robust.Shared.Configuration;
+using Robust.Shared.IoC;
 using Robust.Shared.Audio.Sources;
 using Robust.Shared.Maths;
 
@@ -11,13 +14,51 @@ namespace Robust.Client.Audio;
 /// <summary>
 /// Headless client audio.
 /// </summary>
-internal sealed class HeadlessAudioManager : IAudioInternal
+internal sealed partial class HeadlessAudioManager : IAudioInternal
 {
+    [Dependency] private IConfigurationManager _cfg = default!;
+
     private int _audioBuffer;
+    private float _masterGain;
+    private float _dopplerFactor = 1f;
+
+    /// <inheritdoc />
+    public float MasterGain => _masterGain;
+
+    /// <inheritdoc />
+    public float DopplerFactor
+    {
+        get => _dopplerFactor;
+        set => SetDopplerFactor(value, true);
+    }
 
     /// <inheritdoc />
     public void InitializePostWindowing()
     {
+        _cfg.OnValueChanged(CVars.AudioDopplerFactor, SetDopplerFactorFromCVar, true);
+    }
+
+    private void SetDopplerFactorFromCVar(float value)
+    {
+        SetDopplerFactor(value, false);
+    }
+
+    private void SetDopplerFactor(float value, bool updateCVar)
+    {
+        var original = _dopplerFactor;
+
+        if (!float.IsFinite(value))
+            value = 0f;
+
+        value = MathF.Max(value, 0f);
+
+        if (MathHelper.CloseTo(original, value))
+            return;
+
+        if (updateCVar)
+            _cfg.SetCVar(CVars.AudioDopplerFactor, value, true);
+
+        _dopplerFactor = value;
     }
 
     /// <inheritdoc />
@@ -60,6 +101,10 @@ public void SetRotation(Angle angle)
     /// <inheritdoc />
     public void SetMasterGain(float newGain)
     {
+        if (!float.IsFinite(newGain))
+            newGain = 0f;
+
+        _masterGain = MathF.Max(newGain, 0f);
     }
 
     /// <inheritdoc />

Robust.Client/Audio/IAudioManager.cs

@@ -10,6 +10,16 @@ namespace Robust.Client.Audio;
 [NotContentImplementable]
 public interface IAudioManager
 {
+    /// <summary>
+    /// OpenAL master gain for audio.
+    /// </summary>
+    float MasterGain { get; }
+
+    /// <summary>
+    /// OpenAL Doppler factor for audio.
+    /// </summary>
+    float DopplerFactor { get; }
+
     IAudioSource? CreateAudioSource(AudioStream stream);
 
     AudioStream LoadAudioOggVorbis(Stream stream, string? name = null);

Robust.Shared/CVars.cs

@@ -1300,6 +1300,12 @@ protected CVars()
         public static readonly CVarDef<float> AudioMasterVolume =
             CVarDef.Create("audio.mastervolume", 0.50f, CVar.ARCHIVE | CVar.CLIENTONLY);
 
+        /// <summary>
+        /// OpenAL doppler factor for positional audio.
+        /// </summary>
+        public static readonly CVarDef<float> AudioDopplerFactor =
+            CVarDef.Create("audio.doppler_factor", 1f, CVar.SERVER | CVar.REPLICATED);
+
         /// <summary>
         /// Maximum raycast distance for audio occlusion.
         /// </summary>