DtSharedAudioSettingsManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvUtil/DtBaseSettingsManager.h>

#include <vrvAudioCommon/vrvAudioCommon.h>
#include <vrvAudioCommon/DtAudioSettingsRecord.h>
#include <vrvAudioCommon/DtSoundMapRecord.h>
#include <vrvAudioCommon/DtSharedAudioSettings.h>

#include <string>

namespace makVrv
{

   class DtDe;

   class DT_DLL_VRVAUDIOCOMMON DtSharedAudioSettingsManager
      : public DtBaseSharedSettingsManager<DtAudioSettingsRecord,
         DtSharedAudioSettings>
   {
   public:

      static DtSharedAudioSettingsManager& instance( DtDe& de );

      virtual ~DtSharedAudioSettingsManager();


      virtual void setAudioEnabled( bool val );

      virtual bool audioEnabled() const;

      virtual void setVolume( double val );

      virtual double volume() const;

      virtual void setAudioPlaybackDevice(const std::string& val);

      virtual std::string audioPlaybackDevice() const;

      virtual void setAudioCaptureDevice(const std::string& val);

      virtual std::string audioCaptureDevice() const;

      virtual void setShowCaptureDeviceSettings( bool val );

      virtual bool showCaptureDeviceSettings() const;

      virtual void setSpeedOfSound( double val );

      virtual double speedOfSound() const;

      virtual void setMaxVoices( int val );

      virtual int maxVoices() const;

      virtual void setMaximumOutputDecibelCapability( double val );

      virtual double maximumOutputDecibelCapability() const;

      virtual void setEnvironmentalProcessingEnabled( bool val );

      virtual bool environmentalProcessingEnabled() const;

      virtual bool environmentalProcessingAvailable() const;

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

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


      virtual unsigned int entityMapSize() const;

      virtual unsigned int weaponFireMapSize() const;

      virtual unsigned int detonationMapSize() const;

      virtual const DtEntitySoundMapRecord&
         entityMapAt( unsigned int index ) const;

      virtual const DtEntitySoundMapRecord&
         weaponFireMapAt( unsigned int index ) const;

      virtual const DtEntitySoundMapRecord&
         detonationMapAt( unsigned int index ) const;

      virtual unsigned int entityMapIndex(
         const DtEntitySoundMapRecord& record ) const;

      virtual unsigned int weaponFireMapIndex(
         const DtFireSoundMapRecord& record ) const;

      virtual unsigned int detonationMapIndex(
         const DtDetonationSoundMapRecord& record ) const;

      virtual void entityMapAdd(
         const DtEntitySoundMapRecord& record, bool reload = true );

      virtual void entityMapRemove(
         const DtEntitySoundMapRecord& record, bool reload = true );

      virtual void weaponFireMapAdd(
         const DtFireSoundMapRecord& record, bool reload = false );

      virtual void weaponFireMapRemove(
         const DtEntitySoundMapRecord& record, bool reload = false );

      virtual void detonationMapAdd(
         const DtDetonationSoundMapRecord& record, bool reload = false );

      virtual void detonationMapRemove(
         const DtEntitySoundMapRecord& record, bool reload = false );



      boost::signal<void (bool)> signal_AudioEnabledUpdated;
      boost::signal<void (double)> signal_VolumeUpdated;
      boost::signal<void (std::string)> signal_playbackDeviceUpdated;
      boost::signal<void (std::string)> signal_captureDeviceUpdated;
      boost::signal<void (bool)> signal_showCaptureDeviceSettingsUpdated;
      boost::signal<void (double)> signal_SpeedOfSoundUpdated;
      boost::signal<void (double)> signal_MaxVoicesUpdated;
      boost::signal<void (double)> signal_maximumOutputDecibelCapabilityUpdated;
      boost::signal<void (bool)> signal_EnvironmentalProcessingEnabledUpdated;


      virtual void slot_backupRestored( const DtSettingsBackup* s );

   protected:

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

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

      DtSharedAudioSettingsManager( DtDe& de );
   };

}