AudioSystem.h

#pragma once
 
#include <AudioSystemPlugin/AudioSystemPluginDLL.h>
 
#include <AudioSystemPlugin/ATL/AudioTranslationLayer.h>
#include <AudioSystemPlugin/Core/AudioSystemData.h>
#include <AudioSystemPlugin/Core/AudioThread.h>
 
#include <Core/GameApplication/GameApplicationBase.h>
#include <Core/Interfaces/SoundInterface.h>
 
#include <Foundation/Configuration/Singleton.h>
#include <Foundation/Threading/Semaphore.h>
 
typedef plDeque<plVariant> plAudioSystemRequestsQueue;
 
class PL_AUDIOSYSTEMPLUGIN_DLL plAudioSystem final : public plSoundInterface
{
  PL_DECLARE_SINGLETON_OF_INTERFACE(plAudioSystem, plSoundInterface);
 
  // ----- plSoundInterface
 
public:
  void LoadConfiguration(plStringView sFile) override;
 
  void SetOverridePlatform(plStringView sPlatform) override;
 
  void UpdateSound() override;
 
  void SetMasterChannelVolume(float fVolume) override;
 
  float GetMasterChannelVolume() const override;
 
  void SetMasterChannelMute(bool bMute) override;
 
  bool GetMasterChannelMute() const override;
 
  void SetMasterChannelPaused(bool bPaused) override;
 
  bool GetMasterChannelPaused() const override;
 
  void SetSoundGroupVolume(plStringView sVcaGroupGuid, float fVolume) override;
 
  float GetSoundGroupVolume(plStringView sVcaGroupGuid) const override;
 
  void SetNumListeners(plUInt8 uiNumListeners) override {}
 
  plUInt8 GetNumListeners() override;
 
  void SetListenerOverrideMode(bool bEnabled) override;
 
  void SetListener(plInt32 iIndex, const plVec3& vPosition, const plVec3& vForward, const plVec3& vUp, const plVec3& vVelocity) override;
 
  plResult OneShotSound(plStringView sResourceID, const plTransform& globalPosition, float fPitch = 1.0f, float fVolume = 1.0f, bool bBlockIfNotLoaded = true) override;
 
  // ----- plAudioSystem
 
public:
  plAudioSystem();
  virtual ~plAudioSystem();
 
  bool Startup();
  void Shutdown();
 
  [[nodiscard]] bool IsInitialized() const;
 
  void SendRequest(plVariant&& request);
  void SendRequests(plAudioSystemRequestsQueue& requests);
 
  void SendRequestSync(plVariant&& request);
 
  plAudioSystemDataID GetTriggerId(plStringView sTriggerName) const;
 
  plAudioSystemDataID GetRtpcId(plStringView sRtpcName) const;
 
  plAudioSystemDataID GetSwitchStateId(plStringView sSwitchStateName) const;
 
  plAudioSystemDataID GetEnvironmentId(plStringView sEnvironmentName) const;
 
  plAudioSystemDataID GetBankId(plStringView sBankName) const;
 
  void RegisterTrigger(plAudioSystemDataID uiId, plAudioSystemTriggerData* pTriggerData);
  void RegisterRtpc(plAudioSystemDataID uiId, plAudioSystemRtpcData* pRtpcData);
  void RegisterSwitchState(plAudioSystemDataID uiId, plAudioSystemSwitchStateData* pSwitchStateData);
  void RegisterEnvironment(plAudioSystemDataID uiId, plAudioSystemEnvironmentData* pEnvironmentData);
  void RegisterSoundBank(plAudioSystemDataID uiId, plAudioSystemBankData* pSoundBankData);
 
  void UnregisterEntity(plAudioSystemDataID uiId);
  void UnregisterListener(plAudioSystemDataID uiId);
  void UnregisterTrigger(plAudioSystemDataID uiId);
  void UnregisterRtpc(plAudioSystemDataID uiId);
  void UnregisterSwitchState(plAudioSystemDataID uiId);
  void UnregisterEnvironment(plAudioSystemDataID uiId);
  void UnregisterSoundBank(plAudioSystemDataID uiId);
 
private:
  PL_MAKE_SUBSYSTEM_STARTUP_FRIEND(AudioSystem, AudioSystemPlugin);
 
  friend class plAudioThread;
  friend class plAudioTranslationLayer;
 
  static void GameApplicationEventHandler(const plGameApplicationExecutionEvent& e);
 
  void UpdateInternal();
 
  void StartAudioThread();
  void StopAudioThread();
 
  void QueueRequestCallback(plVariant&& request, bool bSync);
 
  plAudioThread* m_pAudioThread = nullptr;
  plAudioTranslationLayer m_AudioTranslationLayer;
 
  plAudioSystemRequestsQueue m_RequestsQueue;
  plAudioSystemRequestsQueue m_PendingRequestsQueue;
  plAudioSystemRequestsQueue m_BlockingRequestsQueue;
  plAudioSystemRequestsQueue m_PendingRequestCallbacksQueue;
  plAudioSystemRequestsQueue m_BlockingRequestCallbacksQueue;
 
  mutable plMutex m_RequestsMutex;
  mutable plMutex m_PendingRequestsMutex;
  mutable plMutex m_BlockingRequestsMutex;
  mutable plMutex m_PendingRequestCallbacksMutex;
  mutable plMutex m_BlockingRequestCallbacksMutex;
 
  plSemaphore m_MainEvent;
  plSemaphore m_ProcessingEvent;
 
  bool m_bInitialized;
 
  bool m_bListenerOverrideMode;
};