Implement some sound priorities

Use the sound's volume and distance to determine which sounds to replace. Player/bot sounds get a higher priority within `a_clientSoundPriorityMaxDistance` distance, with the multiplier `a_clientSoundPriorityMultiplier`.

Author: VReaperV

src/engine/audio/Audio.cpp

@@ -120,6 +120,8 @@ namespace Audio {
 
     static bool initialized = false;
 
+    int playerClientNum;
+
     static AL::Device* device;
     static AL::Context* context;
 
@@ -292,11 +294,13 @@ namespace Audio {
         }
     }
 
-    void BeginRegistration() {
+    void BeginRegistration( const int playerNum ) {
         if (not initialized) {
             return;
         }
 
+        playerClientNum = playerNum;
+
         BeginSampleRegistration();
     }
 
@@ -317,6 +321,10 @@ namespace Audio {
         EndSampleRegistration();
     }
 
+    static int GetSoundPriorityForEntity( const int entityNum ) {
+        return entityNum < MAX_CLIENTS ? CLIENT : ANY;
+    }
+
     void StartSound(int entityNum, Vec3 origin, sfxHandle_t sfx) {
         if (not initialized or not Sample::IsValidHandle(sfx)) {
             return;
@@ -335,15 +343,15 @@ namespace Audio {
             return;
         }
 
-        AddSound(emitter, std::make_shared<OneShotSound>(Sample::FromHandle(sfx)), 1);
+        AddSound( emitter, std::make_shared<OneShotSound>( Sample::FromHandle( sfx ) ), GetSoundPriorityForEntity( entityNum ) );
     }
 
     void StartLocalSound(sfxHandle_t sfx) {
         if (not initialized or not Sample::IsValidHandle(sfx)) {
             return;
         }
 
-        AddSound(GetLocalEmitter(), std::make_shared<OneShotSound>(Sample::FromHandle(sfx)), 1);
+        AddSound( GetLocalEmitter(), std::make_shared<OneShotSound>( Sample::FromHandle( sfx ) ), ANY );
     }
 
     void AddEntityLoopingSound(int entityNum, sfxHandle_t sfx, bool persistent) {
@@ -357,7 +365,7 @@ namespace Audio {
         if (not loop.sound) {
             loop.sound = std::make_shared<LoopingSound>(Sample::FromHandle(sfx));
             loop.oldSfx = sfx;
-            AddSound(GetEmitterForEntity(entityNum), loop.sound, 1);
+            AddSound( GetEmitterForEntity( entityNum ), loop.sound, GetSoundPriorityForEntity( entityNum ) );
         }
 
         loop.addedThisFrame = true;
@@ -402,7 +410,7 @@ namespace Audio {
         StopMusic();
         music = std::make_shared<LoopingSound>(loopingSample, leadingSample);
         music->volumeModifier = &musicVolume;
-        AddSound(GetLocalEmitter(), music, 1);
+        AddSound( GetLocalEmitter(), music, ANY );
     }
 
     void StopMusic() {
@@ -433,9 +441,9 @@ namespace Audio {
         if (not streams[streamNum]) {
             streams[streamNum] = std::make_shared<StreamingSound>();
             if (IsValidEntity(entityNum)) {
-                AddSound(GetEmitterForEntity(entityNum), streams[streamNum], 1);
+                AddSound( GetEmitterForEntity( entityNum ), streams[streamNum], GetSoundPriorityForEntity( entityNum ) );
             } else {
-                AddSound(GetLocalEmitter(), streams[streamNum], 1);
+                AddSound( GetLocalEmitter(), streams[streamNum], ANY );
             }
         }
 

src/engine/audio/Audio.h

@@ -43,7 +43,7 @@ namespace Audio {
     void Shutdown();
     void Update();
 
-    void BeginRegistration();
+    void BeginRegistration( const int playerNum );
     sfxHandle_t RegisterSFX(Str::StringRef filename);
     void EndRegistration();
 

src/engine/audio/AudioPrivate.h

@@ -65,6 +65,21 @@ namespace Audio {
 
     constexpr uint32_t MAX_ENTITY_SOUNDS = 4;
 
+    extern int playerClientNum;
+
+    struct entityData_t {
+        Vec3 position;
+        Vec3 velocity;
+        float occlusion;
+    };
+
+    extern entityData_t entities[MAX_GENTITIES];
+
+    enum EmitterPriority {
+        ANY,
+        CLIENT
+    };
+
     // Tweaks the value given by the audio slider
     float SliderToAmplitude(float slider);
 

src/engine/audio/Emitter.cpp

@@ -31,14 +31,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include "AudioPrivate.h"
 
 namespace Audio {
-
-    // Structures to keep the state of entities we were given
-    struct entityData_t {
-        Vec3 position;
-        Vec3 velocity;
-        float occlusion;
-    };
-    static entityData_t entities[MAX_GENTITIES];
+    entityData_t entities[MAX_GENTITIES];
     static int listenerEntity = -1;
 
     struct EntityMultiEmitter {
@@ -311,6 +304,10 @@ namespace Audio {
         Make3D(source, entities[entityNum].position, entities[entityNum].velocity);
     }
 
+    Vec3 EntityEmitter::GetPosition() const {
+        return entities[entityNum].position;
+    }
+
     // Implementation of PositionEmitter
 
     PositionEmitter::PositionEmitter(Vec3 position){
@@ -357,6 +354,10 @@ namespace Audio {
         MakeLocal(source);
     }
 
+    Vec3 LocalEmitter::GetPosition() const {
+        return Vec3 {};
+    }
+
     class TestReverbCmd : public Cmd::StaticCmd {
         public:
             TestReverbCmd(): StaticCmd("testReverb", Cmd::AUDIO, "Tests a reverb preset.") {

src/engine/audio/Emitter.h

@@ -64,11 +64,13 @@ namespace Audio {
             void SetupSound(Sound& sound);
 
             // Called each frame before any UpdateSound is called, used to factor computations
-            void virtual Update() = 0;
+            virtual void Update() = 0;
             // Update the Sound's source's spatialization
             virtual void UpdateSound(Sound& sound) = 0;
             // Setup a source for the spatialization of this Emitter
             virtual void InternalSetupSound(Sound& sound) = 0;
+
+            virtual Vec3 GetPosition() const = 0;
     };
 
     // An Emitter that will follow an entity
@@ -81,6 +83,8 @@ namespace Audio {
             virtual void UpdateSound(Sound& sound) override;
             virtual void InternalSetupSound(Sound& sound) override;
 
+            Vec3 GetPosition() const override;
+
         private:
             int entityNum;
     };
@@ -95,7 +99,7 @@ namespace Audio {
             virtual void UpdateSound(Sound& sound) override;
             virtual void InternalSetupSound(Sound& sound) override;
 
-            Vec3 GetPosition() const;
+            Vec3 GetPosition() const override;
 
         private:
             Vec3 position;
@@ -110,6 +114,8 @@ namespace Audio {
             void virtual Update() override;
             virtual void UpdateSound(Sound& sound) override;
             virtual void InternalSetupSound(Sound& sound) override;
+
+            Vec3 GetPosition() const override;
     };
 
 }

src/engine/audio/Sound.cpp

@@ -49,8 +49,6 @@ namespace Audio {
     static sourceRecord_t* sources = nullptr;
     static CONSTEXPR int nSources = 128; //TODO see what's the limit for OpenAL soft
 
-    sourceRecord_t* GetSource(int priority);
-
     static bool initialized = false;
 
     void InitSounds() {
@@ -116,44 +114,55 @@ namespace Audio {
         }
     }
 
-    void AddSound(std::shared_ptr<Emitter> emitter, std::shared_ptr<Sound> sound, int priority) {
-        if (not initialized) {
-            return;
-        }
+    static Cvar::Range<Cvar::Cvar<int>> a_clientSoundPriorityMaxDistance( "a_clientSoundPriorityMaxDistance",
+        "Sounds emitted by players/bots within this distance (in qu) will have higher priority than other sounds"
+        " (multiplier: a_clientSoundPriorityMultiplier)", Cvar::NONE, 32 * 32, 0, BIT( 16 ) );
 
-        sourceRecord_t* source = GetSource(priority);
+    static Cvar::Range<Cvar::Cvar<float>> a_clientSoundPriorityMultiplier( "a_clientSoundPriorityMultiplier",
+        "Sounds emitted by players/bots within a_clientSoundPriorityMaxDistance"
+        " will use this value as their priority multiplier",
+        Cvar::NONE, 2.0f, 0.0f, 1024.0f );
 
-        if (source) {
-            // Make the source forget if it was a "static" or a "streaming" source.
-            source->source.ResetBuffer();
-            sound->emitter = emitter;
-            sound->AcquireSource(source->source);
-            source->usingSound = sound;
-            source->priority = priority;
-            source->active = true;
+    static float GetAdjustedVolumeForPosition( const Vec3& origin, const Vec3& src, const bool isClient ) {
+        vec3_t v0 { origin.Data()[0], origin.Data()[1], origin.Data()[2] };
+        vec3_t v1 { src.Data()[0], src.Data()[1], src.Data()[2] };
 
-            sound->FinishSetup();
-            sound->Play();
+        float totalPriority = VectorDistanceSquared( v0, v1 );
+
+        const float distanceThreshold = a_clientSoundPriorityMaxDistance.Get();
+        if ( isClient && totalPriority < distanceThreshold * distanceThreshold ) {
+            totalPriority *= 1.0f / a_clientSoundPriorityMultiplier.Get();
         }
+
+       return 1.0f / totalPriority;
     }
 
     // Finds a inactive or low-priority source to play a new sound.
-    sourceRecord_t* GetSource(int priority) {
-        //TODO make a better heuristic? (take into account the distance / the volume /... ?)
+    static sourceRecord_t* GetSource( const Vec3& position, int priority, const float currentGain ) {
         int best = -1;
-        int bestPriority = priority;
 
-        // Gets the minimum sound by comparing activity first then priority
+        const Vec3& playerPos = entities[playerClientNum].position;
+
+        // Sound volume is inversely proportional to distance to the source
+        const float adjustedVolume = Q_rsqrt_fast( currentGain )
+            * GetAdjustedVolumeForPosition( playerPos, position, priority == CLIENT );
+
+        // Gets the minimum sound by comparing activity first, then the adjusted volume
         for (int i = 0; i < nSources; i++) {
             sourceRecord_t& source = sources[i];
 
             if (not source.active) {
                 return &source;
             }
 
-            if (source.priority < bestPriority || (best < 0 && source.priority <= priority)) {
+            const Vec3& sourcePos = source.usingSound->emitter->GetPosition();
+
+            // Sound volume is inversely proportional to distance to the source
+            const float adjustedSourceVolume = Q_rsqrt_fast( source.usingSound->currentGain )
+                * GetAdjustedVolumeForPosition( playerPos, sourcePos, source.priority == CLIENT );
+
+            if ( adjustedVolume > adjustedSourceVolume ) {
                 best = i;
-                bestPriority = source.priority;
                 continue;
             }
         }
@@ -171,6 +180,30 @@ namespace Audio {
         }
     }
 
+    void AddSound( std::shared_ptr<Emitter> emitter, std::shared_ptr<Sound> sound, int priority ) {
+        if ( not initialized ) {
+            return;
+        }
+
+        const Vec3& position = emitter->GetPosition();
+        const float currentGain = sound->positionalGain * sound->soundGain
+            * SliderToAmplitude( sound->volumeModifier->Get() );
+        sourceRecord_t* source = GetSource( position, priority, currentGain );
+
+        if ( source ) {
+            // Make the source forget if it was a "static" or a "streaming" source.
+            source->source.ResetBuffer();
+            sound->emitter = emitter;
+            sound->AcquireSource( source->source );
+            source->usingSound = sound;
+            source->priority = priority;
+            source->active = true;
+
+            sound->FinishSetup();
+            sound->Play();
+        }
+    }
+
     // Implementation of Sound
 
     Sound::Sound() : positionalGain(1.0f), soundGain(1.0f), currentGain(1.0f),

src/engine/client/cg_msgdef.h

@@ -291,7 +291,7 @@ namespace Audio {
 	using UpdateEntityVelocityMsg = IPC::Message<IPC::Id<VM::QVM, CG_S_UPDATEENTITYVELOCITY>, int, Vec3>;
 	using UpdateEntityPositionVelocityMsg = IPC::Message<IPC::Id<VM::QVM, CG_S_UPDATEENTITYPOSITIONVELOCITY>, int, Vec3, Vec3>;
 	using SetReverbMsg = IPC::Message<IPC::Id<VM::QVM, CG_S_SETREVERB>, int, std::string, float>;
-	using BeginRegistrationMsg = IPC::Message<IPC::Id<VM::QVM, CG_S_BEGINREGISTRATION>>;
+	using BeginRegistrationMsg = IPC::Message<IPC::Id<VM::QVM, CG_S_BEGINREGISTRATION>, int>;
 	using EndRegistrationMsg = IPC::Message<IPC::Id<VM::QVM, CG_S_ENDREGISTRATION>>;
 }
 

src/engine/client/cl_cgame.cpp

@@ -1561,8 +1561,8 @@ void CGameVM::CmdBuffer::HandleCommandBufferSyscall(int major, int minor, Util::
 				break;
 
 			case CG_S_BEGINREGISTRATION:
-				HandleMsg<Audio::BeginRegistrationMsg>(std::move(reader), [this] {
-					Audio::BeginRegistration();
+				HandleMsg<Audio::BeginRegistrationMsg>(std::move(reader), [this] ( const int playerNum ) {
+					Audio::BeginRegistration( playerNum );
 				});
 				break;
 

src/engine/null/NullAudio.cpp

@@ -47,7 +47,7 @@ namespace Audio {
     }
 
 
-    void BeginRegistration() {
+    void BeginRegistration( const int ) {
     }
 
     sfxHandle_t RegisterSFX(Str::StringRef) {

src/shared/client/cg_api.cpp

@@ -218,9 +218,9 @@ void trap_S_SetReverb( int slotNum, const char* name, float ratio )
 	cmdBuffer.SendMsg<Audio::SetReverbMsg>(slotNum, name, ratio);
 }
 
-void trap_S_BeginRegistration()
+void trap_S_BeginRegistration( const int playerNum )
 {
-	cmdBuffer.SendMsg<Audio::BeginRegistrationMsg>();
+	cmdBuffer.SendMsg<Audio::BeginRegistrationMsg>( playerNum );
 }
 
 void trap_S_EndRegistration()