DtAudioManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2022 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once

#include <vrvAudio/vrvAudio.h>

#include <vrvCore/DtUniqueID.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <matrix/vlVector.h>

namespace makVrv
{
   class DtDe;
   class DtSoundModelAgent;

   class DT_DLL_VRVAUDIO DtAudioManager : public DtVirtualBaseClass
   {
   public:

      enum ListenerLocationType
      {
         ObserverListener, // Get listener location (and orientation) from current observer
         EntityListener,   // Get listener location (and orientation) from an entity
         ExplicitListener  // Use listener location (and orientation) specified in API
      };

   public:

      static DtAudioManager& instance(DtDe& de);

      virtual bool init();

      virtual bool playbackDeviceInitialized();

      virtual bool captureDeviceInitialized();

      virtual bool isEnabled();

      virtual void setEnabled(bool enable);

      virtual double soundVolume();

      virtual void setSoundVolume(double volume);

      virtual void setListenerLocationType(ListenerLocationType listenerType);

      virtual ListenerLocationType listenerLocationType() const;

      virtual void setEntityListener(DtElementID listenerEntity);

      virtual DtElementID entityListener() const;

      virtual void setListenerLocation(const DtVector& location);

      virtual const DtVector& listenerLocation() const;

      virtual void setListenerVelocity(const DtVector& velocity);

      virtual const DtVector& listenerVelocity() const;

      virtual void setListenerFront(const DtVector& frontVec);

      virtual const DtVector& listenerFront() const;

      virtual void setListenerUp(const DtVector& upVec);

      virtual const DtVector& listenerUp() const;

      virtual int maxVoices();

      virtual void setMaxVoices(int numVoices);

      virtual double speedOfSound();

      virtual void setSpeedOfSound(double c);

      virtual float maximumOutputDecibelCapability();

      virtual void setMaximumOutputDecibelCapability(float max);

      virtual bool environmentalProcessingAvailable();

      virtual bool isEnvironmentalProcessingEnabled();

      virtual void setEnvironmentalProcessingEnabled(bool enable);

      virtual void loadDefaults();

      virtual bool environmentalProcessingAvailable() const;

      virtual std::vector<std::string> playbackDeviceList() const;

      virtual std::vector<std::string> captureDeviceList() const;

      //Signaled when the playback device is initialized
      boost::signalslib::signal<void()> signal_playbackDeviceInitialized;

      //Signaled when the playback device is initialized
      boost::signalslib::signal<void()> signal_captureDeviceInitialized;

   protected:

      DtAudioManager(DtDe&);

      virtual ~DtAudioManager();

      void connectSignals();

      virtual void tick();

      virtual void shutdown();

      virtual void kinStateFromObserver();

      virtual void kinStateFromEntity();
      
      virtual void initializeAudioDevicesIfNeeded();

      virtual void slot_AudioEnabledUpdated(bool enabled);

      virtual void slot_VolumeUpdated(double volume);

      virtual void slot_playbackDeviceUpdated(const std::string& device);

      virtual void slot_captureDeviceUpdated(const std::string& device);

      virtual void slot_showCaptureDeviceSettingsUpdated(bool show);

      virtual void slot_SpeedOfSoundUpdated(double speed);

      virtual void slot_MaxVoicesUpdated(double numOfVoices);

      virtual void slot_maximumOutputDecibelCapabilityUpdated(double decibel);

      virtual void slot_EnvironmentalProcessingEnabledUpdated(bool enabled);

      template <typename ManagerClass>
      friend ManagerClass& defaultManagerInstanceFunction(DtDe&, bool);

      template <typename ManagerClass>
      friend void defaultManagerRegisterInstanceFunction(DtDe&, ManagerClass*);

   private:
      DtAudioManager();
      DtAudioManager(const DtAudioManager &);
      DtAudioManager &operator=(const DtAudioManager &);

   protected:
      DtDe& myDe;
      DtSignalConnectionManager myConnections;
      ListenerLocationType myListenerLocationType;
      DtElementID myListenerEntity;
      DtVector myListenerLocation;
      DtVector myListenerFront;
      DtVector myListenerUp;
      DtVector myListenerVelocity;

      bool myPlaybackDeviceInitialized;
      bool myCaptureDeviceInitialized;
   };

}