DtAudioSettingsRecord.h

Go to the documentation of this file.

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


#pragma once

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

#include <makArchives/makArchives.h>

#include <string>
#include <vector>

namespace makVrv
{

   class DT_DLL_VRVAUDIOCOMMON DtAudioSettingsRecord
   {
   public:
      typedef std::vector<DtEntitySoundMapRecord> EntityMapRecordList;

      typedef std::vector<DtFireSoundMapRecord> FireMapRecordList;

      typedef std::vector<DtDetonationSoundMapRecord> DetonationMapRecordList;

      DtAudioSettingsRecord();

      DtAudioSettingsRecord( const DtAudioSettingsRecord& other );

      virtual ~DtAudioSettingsRecord();

      DtAudioSettingsRecord& operator = ( DtAudioSettingsRecord rhs );

      virtual void swap( DtAudioSettingsRecord& other );

      virtual void sort();

      virtual void clearMaps();

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

      virtual std::string audioPlaybackDevice() const;

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

      virtual std::string audioCaptureDevice() const;

      virtual void setShowCaptureDeviceSettings( bool val );

      virtual bool showCaptureDeviceSettings() const;

      virtual void setAudioEnabled( bool val );

      virtual bool audioEnabled() const;

      virtual void setVolume( double val );

      virtual double volume() 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 unsigned int entityMapSize() const;

      virtual unsigned int weaponFireMapSize() const;

      virtual unsigned int detonationMapSize() const;

      virtual EntityMapRecordList& entityMap();

      virtual EntityMapRecordList::iterator
         entityMapFind( DtEntitySoundMapRecord& record );

      virtual EntityMapRecordList::const_iterator
         entityMapFind( const DtEntitySoundMapRecord& record );

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

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

      virtual FireMapRecordList& weaponFireMap();

      virtual FireMapRecordList::iterator
         weaponFireMapFind( DtFireSoundMapRecord& record );

      virtual FireMapRecordList::const_iterator
         weaponFireMapFind( const DtFireSoundMapRecord& record );

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

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

      virtual DetonationMapRecordList& detonationMap();

      virtual DetonationMapRecordList::iterator
         detonationMapFind( DtDetonationSoundMapRecord& record );

      virtual DetonationMapRecordList::const_iterator
         detonationMapFind( const DtDetonationSoundMapRecord& record );

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

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

      virtual void entityMapAdd( const DtEntitySoundMapRecord& record );

      virtual void entityMapRemove( const DtEntitySoundMapRecord& record );

      virtual void weaponFireMapAdd( const DtFireSoundMapRecord& record );

      virtual void weaponFireMapRemove( const DtFireSoundMapRecord& record );

      virtual void
         detonationMapAdd( const DtDetonationSoundMapRecord& record );

      virtual void
         detonationMapRemove( const DtDetonationSoundMapRecord& record );

   protected:

      friend class boost::serialization::access;

      template<class Archive>
      void serialize( Archive& ar, const unsigned int version )
      {
         if(version == 6)
         {
            ar & BOOST_SERIALIZATION_NVP( myAudioPlaybackDevice );
            ar & BOOST_SERIALIZATION_NVP( myAudioCaptureDevice );
            ar & BOOST_SERIALIZATION_NVP( myShowCaptureSettings );
            ar & BOOST_SERIALIZATION_NVP( myAudioEnabled );
            ar & BOOST_SERIALIZATION_NVP( myVolume );
            ar & BOOST_SERIALIZATION_NVP( mySpeedOfSound );
            ar & BOOST_SERIALIZATION_NVP( myMaxVoices );
            ar & BOOST_SERIALIZATION_NVP( myMaximumOutputDecibelCapability );
            ar & BOOST_SERIALIZATION_NVP( myEnvironmentalProcessingEnabled );
            ar & BOOST_SERIALIZATION_NVP( myEntitySounds );
            ar & BOOST_SERIALIZATION_NVP( myWeaponFireSounds );
            ar & BOOST_SERIALIZATION_NVP( myDetonationSounds );
         }
      }

      template<typename MapType>
      typename MapType::iterator
         mapFind( DtEntitySoundMapRecord& record, MapType& sndMap ) const
      {
         typename MapType::iterator iter( sndMap.begin() );
         typename MapType::iterator endr( sndMap.end() );
         for( ; iter != endr; ++iter )
         {
            if ( ( *iter ) == record )
            {
               return iter;
            }
         }
         return endr;
      }

      template<typename MapType>
      typename MapType::const_iterator
         mapFind( const DtEntitySoundMapRecord& record, MapType& sndMap ) const
      {
         typename MapType::const_iterator iter( sndMap.begin() );
         typename MapType::const_iterator endr( sndMap.end() );
         for( ; iter != endr; ++iter )
         {
            if ( ( *iter ) == record )
            {
               return iter;
            }
         }
         return endr;
      }

      template<typename RecType, typename MapType>
      const RecType& at( unsigned int index, MapType& sndMap ) const
      {
         return sndMap.at( index );
      }

      template<typename RecType, typename MapType>
      unsigned int index( const RecType& record, MapType& sndMap ) const
      {
         return static_cast<unsigned int>
            ( std::distance( sndMap.begin(), mapFind( record, sndMap ) ) );
      }

      template<typename MapType>
      void clearMap( MapType& sndMap )
      {
         sndMap.clear();
      }


   protected:
      std::string myAudioPlaybackDevice;
      std::string myAudioCaptureDevice;
      bool myShowCaptureSettings;
      bool myAudioEnabled;
      int myVolume;
      double mySpeedOfSound;
      int myMaxVoices;
      double myMaximumOutputDecibelCapability;
      bool myEnvironmentalProcessingEnabled;
      EntityMapRecordList myEntitySounds;
      FireMapRecordList myWeaponFireSounds;
      DetonationMapRecordList myDetonationSounds;
   };

}

BOOST_CLASS_VERSION( makVrv::DtAudioSettingsRecord, 6 )