FmodSingleton.h

#pragma once
 
#include <Core/Interfaces/SoundInterface.h>
#include <Core/ResourceManager/ResourceHandle.h>
#include <FmodPlugin/FmodPluginDLL.h>
#include <Foundation/Configuration/Plugin.h>
#include <Foundation/Configuration/Singleton.h>
#include <Foundation/Types/UniquePtr.h>
 
struct plGameApplicationExecutionEvent;
class plOpenDdlWriter;
class plOpenDdlReaderElement;
using plDataBuffer = plDynamicArray<plUInt8>;
 
using plFmodSoundBankResourceHandle = plTypedResourceHandle<class plFmodSoundBankResource>;
 
enum class plFmodSpeakerMode : plUInt8
{
  ModeStereo,
  Mode5Point1,
  Mode7Point1,
};
 
struct PL_FMODPLUGIN_DLL plFmodConfiguration
{
  plString m_sMasterSoundBank;
  plFmodSpeakerMode m_SpeakerMode = plFmodSpeakerMode::Mode5Point1; 
  plUInt16 m_uiVirtualChannels = 32;                                
  plUInt32 m_uiSamplerRate = 0;                                     
 
  void Save(plOpenDdlWriter& ref_ddl) const;
  void Load(const plOpenDdlReaderElement& ddl);
 
  bool operator==(const plFmodConfiguration& rhs) const;
  bool operator!=(const plFmodConfiguration& rhs) const { return !operator==(rhs); }
};
 
struct PL_FMODPLUGIN_DLL plFmodAssetProfiles
{
  static constexpr const plStringView s_sConfigFile = ":project/RuntimeConfigs/FmodConfig.ddl"_plsv;
 
  plResult Save(plStringView sFile = s_sConfigFile) const;
  plResult Load(plStringView sFile = s_sConfigFile);
 
  plMap<plString, plFmodConfiguration> m_AssetProfiles;
};
 
class PL_FMODPLUGIN_DLL plFmod : public plSoundInterface
{
  PL_DECLARE_SINGLETON_OF_INTERFACE(plFmod, plSoundInterface);
 
public:
  plFmod();
 
  void Startup();
  void Shutdown();
 
  FMOD::Studio::System* GetStudioSystem() const { return m_pStudioSystem; }
  FMOD::System* GetLowLevelSystem() const { return m_pLowLevelSystem; }
 
  virtual void LoadConfiguration(plStringView sFile) override;
 
  virtual void SetOverridePlatform(plStringView sPlatform) override;
 
  virtual void UpdateSound() override;
 
  virtual void SetMasterChannelVolume(float fVolume) override;
  virtual float GetMasterChannelVolume() const override;
 
  virtual void SetMasterChannelMute(bool bMute) override;
  virtual bool GetMasterChannelMute() const override;
 
  virtual void SetMasterChannelPaused(bool bPaused) override;
  virtual bool GetMasterChannelPaused() const override;
 
  virtual void SetSoundGroupVolume(plStringView sVcaGroupGuid, float fVolume) override;
  virtual float GetSoundGroupVolume(plStringView sVcaGroupGuid) const override;
  void UpdateSoundGroupVolumes();
 
  virtual void SetNumListeners(plUInt8 uiNumListeners) override;
  virtual plUInt8 GetNumListeners() override;
 
  static void GameApplicationEventHandler(const plGameApplicationExecutionEvent& e);
 
  void SetNumBlendedReverbVolumes(plUInt8 uiNumBlendedVolumes);
 
  plUInt8 GetNumBlendedReverbVolumes() const { return m_uiNumBlendedVolumes; }
 
 
  virtual void SetListenerOverrideMode(bool bEnabled) override;
  virtual void SetListener(plInt32 iIndex, const plVec3& vPosition, const plVec3& vForward, const plVec3& vUp, const plVec3& vVelocity) override;
  plVec3 GetListenerPosition() { return m_vListenerPosition; }
 
  virtual plResult OneShotSound(plStringView sResourceID, const plTransform& globalPosition, float fPitch = 1.0f, float fVolume = 1.0f, bool bBlockIfNotLoaded = true) override;
 
private:
  friend class plFmodSoundBankResource;
  void QueueSoundBankDataForDeletion(plDataBuffer* pData);
  void ClearSoundBankDataDeletionQueue();
  mutable plMutex m_DeletionQueueMutex;
 
private:
  void DetectPlatform();
  plResult LoadMasterSoundBank(const char* szMasterBankResourceID);
 
  bool m_bInitialized = false;
  bool m_bListenerOverrideMode = false;
  plVec3 m_vListenerPosition;
  plUInt8 m_uiNumBlendedVolumes = 4;
 
  FMOD::Studio::System* m_pStudioSystem;
  FMOD::System* m_pLowLevelSystem;
 
  struct Data
  {
    plMap<plString, float> m_VcaVolumes;
    plFmodAssetProfiles m_Configs;
    plString m_sPlatform;
    plFmodSoundBankResourceHandle m_hMasterBank;
    plFmodSoundBankResourceHandle m_hMasterBankStrings;
    plHybridArray<plDataBuffer*, 4> m_SbDeletionQueue;
  };
 
  plUniquePtr<Data> m_pData;
};