Introduce Sound Scene

src/xrEngine/IGame_Level.cpp

@@ -25,6 +25,8 @@ IGame_Level::IGame_Level()
     bReady = false;
     pCurrentEntity = NULL;
     pCurrentViewEntity = NULL;
+    Sound = GEnv.Sound->create_scene();
+    DefaultSoundScene = Sound;
 #ifndef MASTER_GOLD
     GEnv.Render->ResourcesDumpMemoryUsage();
 #endif
@@ -44,8 +46,8 @@ IGame_Level::~IGame_Level()
     Device.seqFrame.Remove(this);
     CCameraManager::ResetPP();
     ///////////////////////////////////////////
-    GEnv.Sound->set_geometry_occ(nullptr);
-    GEnv.Sound->set_handler(nullptr);
+    DefaultSoundScene = g_pGamePersistent->m_pSound;
+    GEnv.Sound->destroy_scene(Sound);
 #ifndef MASTER_GOLD
     GEnv.Render->ResourcesDumpMemoryUsage();
 #endif
@@ -115,8 +117,8 @@ bool IGame_Level::Load(u32 dwNum)
     g_pGamePersistent->SpatialSpace.initialize(ObjectSpace.GetBoundingVolume());
     g_pGamePersistent->SpatialSpacePhysic.initialize(ObjectSpace.GetBoundingVolume());
 
-    GEnv.Sound->set_geometry_occ(ObjectSpace.GetStaticModel());
-    GEnv.Sound->set_handler([](const ref_sound& S, float range)
+    Sound->set_geometry_occ(ObjectSpace.GetStaticModel());
+    Sound->set_handler([](const ref_sound& S, float range)
     {
         if (g_pGameLevel && S && S->feedback)
             g_pGameLevel->SoundEvent_Register(S, range);
@@ -303,7 +305,7 @@ void IGame_Level::SoundEvent_Register(const ref_sound& S, float range)
 
         // Energy and signal
         VERIFY(_valid(it->GetSpatialData().sphere.P));
-        float dist = snd_position.distance_to(it->GetSpatialData().sphere.P);
+        const float dist = snd_position.distance_to(it->GetSpatialData().sphere.P);
         if (dist > p->max_ai_distance)
             continue;
         VERIFY(_valid(dist));
@@ -312,7 +314,7 @@ void IGame_Level::SoundEvent_Register(const ref_sound& S, float range)
         VERIFY(_valid(Power));
         if (Power > EPS_S)
         {
-            float occ = GEnv.Sound->get_occlusion_to(it->GetSpatialData().sphere.P, snd_position);
+            const float occ = Sound->get_occlusion_to(it->GetSpatialData().sphere.P, snd_position);
             VERIFY(_valid(occ));
             Power *= occ;
             if (Power > EPS_S)

src/xrEngine/IGame_Level.h

@@ -75,6 +75,8 @@ class ENGINE_API IGame_Level : public FactoryObjectBase,
     xr_vector<ISpatial*> snd_ER;
 
 public:
+    ISoundScene* Sound{};
+
     CObjectList Objects;
     CObjectSpace ObjectSpace;
     CCameraManager& Cameras() { return *m_pCameras; };

src/xrEngine/IGame_Persistent.cpp

@@ -44,10 +44,16 @@ IGame_Persistent::IGame_Persistent()
     pEnvironment = xr_new<CEnvironment>();
 
     m_pGShaderConstants = xr_new<ShadersExternalData>(); //--#SM+#--
+
+    m_pSound = GEnv.Sound->create_scene();
+    DefaultSoundScene = m_pSound;
 }
 
 IGame_Persistent::~IGame_Persistent()
 {
+    GEnv.Sound->destroy_scene(m_pSound);
+    DefaultSoundScene = nullptr;
+
     xr_delete(PerlinNoise1D);
     Device.seqFrame.Remove(this);
     Device.seqAppStart.Remove(this);

src/xrEngine/IGame_Persistent.h

@@ -147,6 +147,7 @@ class ENGINE_API IGame_Persistent :
     CEnvironment& Environment() { return *pEnvironment; };
     void Prefetch();
 #endif
+    ISoundScene* m_pSound{};
     IMainMenu* m_pMainMenu{};
     static bool IsMainMenuActive();
     static bool MainMenuActiveOrLevelNotExist();

src/xrEngine/xr_object_list.cpp

@@ -311,7 +311,7 @@ void CObjectList::Update(bool bForce)
                 (*oit)->net_Relcase(destroy_queue[it]);
 
         for (int it = destroy_queue.size() - 1; it >= 0; it--)
-            GEnv.Sound->object_relcase(destroy_queue[it]);
+            g_pGameLevel->Sound->object_relcase(destroy_queue[it]);
 
         RELCASE_CALLBACK_VEC::iterator it = m_relcase_callbacks.begin();
         const RELCASE_CALLBACK_VEC::iterator ite = m_relcase_callbacks.end();

src/xrGame/Level_load.cpp

@@ -90,14 +90,14 @@ bool CLevel::Load_GameSpecific_After()
         if (FS.exist(fn_game, "$level$", "level.snd_env"))
         {
             IReader* F = FS.r_open(fn_game);
-            GEnv.Sound->set_geometry_env(F);
+            Sound->set_geometry_env(F);
             FS.r_close(F);
         }
         // loading SOM
         if (FS.exist(fn_game, "$level$", "level.som"))
         {
             IReader* F = FS.r_open(fn_game);
-            GEnv.Sound->set_geometry_som(F);
+            Sound->set_geometry_som(F);
             FS.r_close(F);
         }
 

src/xrGame/level_sounds.cpp

@@ -34,7 +34,7 @@ void SStaticSound::Update(u32 game_time, u32 global_time)
         if (0 == m_Source._feedback())
         {
             Fvector occ[3];
-            const float occluder_volume = GEnv.Sound->get_occlusion(m_Position, .2f, occ);
+            const float occluder_volume = g_pGameLevel->Sound->get_occlusion(m_Position, .2f, occ);
             const float vol = m_Volume * occluder_volume;
 
             if ((0 == m_PauseTime.x) && (0 == m_PauseTime.y))

src/xrSound/Sound.cpp

@@ -4,6 +4,8 @@
 
 XRSOUND_API u32 snd_device_id = u32(-1);
 
+ISoundScene* DefaultSoundScene{};
+
 void CSoundManager::CreateDevicesList()
 {
     static bool noSound = strstr(Core.Params, "-nosound");

src/xrSound/Sound.h

@@ -24,6 +24,7 @@ constexpr pcstr SNDENV_FILENAME = "sEnvironment.xr";
 class IGameObject;
 class CSound;
 struct resptrcode_sound;
+class ISoundScene;
 class XRSOUND_API CSound_params;
 class XRSOUND_API CSound_source;
 class XRSOUND_API CSound_emitter;
@@ -52,6 +53,8 @@ XRSOUND_API extern int psSoundCacheSizeMB;
 XRSOUND_API extern u32 psSoundPrecacheAll;
 XRSOUND_API extern u32 snd_device_id;
 
+XRSOUND_API extern ISoundScene* DefaultSoundScene;
+
 // Flags
 enum : u32
 {
@@ -200,6 +203,40 @@ namespace CDB
     class MODEL;
 }
 
+class XRSOUND_API XR_NOVTABLE ISoundScene
+{
+protected:
+    friend struct resptrcode_sound;
+
+public:
+    virtual ~ISoundScene() = 0;
+
+    virtual void play(ref_sound& S, IGameObject* O, u32 flags = 0, float delay = 0.f) = 0;
+    virtual void play_at_pos(ref_sound& S, IGameObject* O, const Fvector& pos, u32 flags = 0, float delay = 0.f) = 0;
+    virtual void play_no_feedback(ref_sound& S, IGameObject* O, u32 flags = 0, float delay = 0.f, Fvector* pos = nullptr,
+        float* vol = nullptr, float* freq = nullptr, Fvector2* range = nullptr) = 0;
+
+    virtual void stop_emitters() const = 0;
+    virtual int pause_emitters(bool pauseState) = 0;
+
+    virtual void set_handler(sound_event* E) = 0;
+    virtual void set_geometry_env(IReader* I) = 0;
+    virtual void set_geometry_som(IReader* I) = 0;
+    virtual void set_geometry_occ(CDB::MODEL* M) = 0;
+
+    virtual void set_user_env(CSound_environment* E) = 0;
+    virtual void set_environment(u32 id, CSound_environment** dst_env) = 0;
+    virtual void set_environment_size(CSound_environment* src_env, CSound_environment** dst_env) = 0;
+    virtual CSound_environment* get_environment(const Fvector& P) = 0;
+
+    virtual float get_occlusion_to(const Fvector& hear_pt, const Fvector& snd_pt, float dispersion = 0.2f) = 0;
+    virtual float get_occlusion(Fvector& P, float R, Fvector* occ) = 0;
+
+    virtual void object_relcase(IGameObject* obj) = 0;
+};
+
+inline ISoundScene::~ISoundScene() = default;
+
 /// definition (Sound Manager Interface)
 class XRSOUND_API XR_NOVTABLE ISoundManager
 {
@@ -212,43 +249,30 @@ class XRSOUND_API XR_NOVTABLE ISoundManager
 
     virtual void attach_tail(CSound& S, pcstr fName) = 0;
 
-    virtual void play(ref_sound& S, IGameObject* O, u32 flags = 0, float delay = 0.f) = 0;
-    virtual void play_at_pos(ref_sound& S, IGameObject* O, const Fvector& pos, u32 flags = 0, float delay = 0.f) = 0;
-    virtual void play_no_feedback(ref_sound& S, IGameObject* O, u32 flags = 0, float delay = 0.f, Fvector* pos = nullptr,
-        float* vol = nullptr, float* freq = nullptr, Fvector2* range = nullptr) = 0;
-
 public:
     virtual ~ISoundManager() = default;
 
+    virtual ISoundScene* create_scene() = 0;
+    virtual void destroy_scene(ISoundScene*&) = 0;
+
     virtual void _restart() = 0;
     virtual bool i_locked() = 0;
 
     virtual void prefetch() = 0;
 
     virtual void stop_emitters() = 0;
-    virtual int pause_emitters(bool val) = 0;
+    virtual int pause_emitters(bool pauseState) = 0;
 
     virtual void set_master_volume(float f = 1.f) = 0;
-    virtual void set_geometry_env(IReader* I) = 0;
-    virtual void set_geometry_som(IReader* I) = 0;
-    virtual void set_geometry_occ(CDB::MODEL* M) = 0;
-    virtual void set_handler(sound_event* E) = 0;
 
     virtual void update(const Fvector& P, const Fvector& D, const Fvector& N) = 0;
     virtual void statistic(CSound_stats* s0, CSound_stats_ext* s1) = 0;
     virtual void DumpStatistics(class IGameFont& font, class IPerformanceAlert* alert) = 0;
 
-    virtual float get_occlusion_to(const Fvector& hear_pt, const Fvector& snd_pt, float dispersion = 0.2f) = 0;
-    virtual float get_occlusion(Fvector& P, float R, Fvector* occ) = 0;
-
-    virtual void object_relcase(IGameObject* obj) = 0;
     virtual const Fvector& listener_position() = 0;
 
     virtual void refresh_env_library() = 0;
-    virtual void set_user_env(CSound_environment* E) = 0;
     virtual void refresh_sources() = 0;
-    virtual void set_environment(u32 id, CSound_environment** dst_env) = 0;
-    virtual void set_environment_size(CSound_environment* src_env, CSound_environment** dst_env) = 0;
 };
 
 class XRSOUND_API CSoundManager
@@ -331,7 +355,6 @@ struct resptrcode_sound : public resptr_base<CSound>
     [[nodiscard]]
     ICF CSound_UserDataPtr _g_userdata() const { VERIFY(p_); return p_ ? p_->g_userdata : nullptr; }
 
-
     bool create(pcstr name, esound_type sound_type, int game_type, bool replaceWithNoSound = true)
     {
         VerSndUnlocked();
@@ -369,20 +392,26 @@ struct resptrcode_sound : public resptr_base<CSound>
 
     void play(IGameObject* O, u32 flags = 0, float delay = 0.f)
     {
+        if (!p_ || !DefaultSoundScene)
+            return;
         VerSndUnlocked();
-        GEnv.Sound->play(static_cast<ref_sound&>(*this), O, flags, delay);
+        DefaultSoundScene->play(static_cast<ref_sound&>(*this), O, flags, delay);
     }
 
     void play_at_pos(IGameObject* O, const Fvector& pos, u32 flags = 0, float delay = 0.f)
     {
+        if (!p_ || !DefaultSoundScene)
+            return;
         VerSndUnlocked();
-        GEnv.Sound->play_at_pos(static_cast<ref_sound&>(*this), O, pos, flags, delay);
+        DefaultSoundScene->play_at_pos(static_cast<ref_sound&>(*this), O, pos, flags, delay);
     }
 
     void play_no_feedback(IGameObject* O, u32 flags = 0, float delay = 0.f, Fvector* pos = nullptr, float* vol = nullptr, float* freq = nullptr, Fvector2* range = nullptr)
     {
+        if (!p_ || !DefaultSoundScene)
+            return;
         VerSndUnlocked();
-        GEnv.Sound->play_no_feedback(static_cast<ref_sound&>(*this), O, flags, delay, pos, vol, freq, range);
+        DefaultSoundScene->play_no_feedback(static_cast<ref_sound&>(*this), O, flags, delay, pos, vol, freq, range);
     }
 
     ICF void stop()                           const { VerSndUnlocked(); if (_feedback()) _feedback()->stop(false); }