Added image source renderer for shoebox rooms

CMakeLists.txt

@@ -171,6 +171,9 @@ endif( )
 if( NOT DEFINED ITA_VACORE_WITH_RENDERER_PROTOTYPE_GENERIC_PATH )
 	set( ITA_VACORE_WITH_RENDERER_PROTOTYPE_GENERIC_PATH ON CACHE BOOL "Build VACore with rendering module: prototype generic path" )
 endif( )
+if( NOT DEFINED ITA_VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE )
+	set( ITA_VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE ON CACHE BOOL "Build VACore with rendering module: prototype image source" )
+endif( )
 
 if( NOT DEFINED ITA_VACORE_WITH_RENDERER_VBAP_FREE_FIELD )
 	set( ITA_VACORE_WITH_RENDERER_VBAP_FREE_FIELD ON CACHE BOOL "Build VACore with rendering module: vector-base amplitude panning free-field" )
@@ -301,6 +304,9 @@ endif( )
 if( ITA_VACORE_WITH_RENDERER_PROTOTYPE_GENERIC_PATH )
 	add_definitions( "-DVACORE_WITH_RENDERER_PROTOTYPE_GENERIC_PATH" )
 endif( )
+if( ITA_VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE )
+	add_definitions( "-DVACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE" )
+endif( )
 if( ITA_VACORE_WITH_RENDERER_VBAP_FREE_FIELD )
 	add_definitions( "-DVACORE_WITH_RENDERER_VBAP_FREE_FIELD" )
 endif( )

conf/VACore.ini.proto

@@ -238,6 +238,29 @@ RecordOutputEnabled = false
 RecordOutputFileName = renderer_out.wav
 RecordOutputBaseFolder = recordings/$(ProjectName)/renderer/MyGenericRenderer
 
+[Renderer:MyImageSourceRenderer]
+Class = PrototypeImageSource
+Enabled = false
+Reproductions = MyTalkthroughHeadphones
+NumChannels = 2
+RoomLength = 5
+RoomWidth = 5
+RoomHeight = 5
+MaxOrder = 2
+Betax1 = 0.1
+Betax2 = 0.1
+Betay1 = 0.1
+Betay2 = 0.1
+Betaz1 = 0.1
+Betaz2 = 0.1
+DirectSound = true
+HRIRFilterLength = 256
+IRFilterLengthSamples = 88200
+OutputMonitoring = true
+RecordOutputEnabled = false
+RecordOutputFileName = renderer_out.wav
+RecordOutputBaseFolder = recordings/$(ProjectName)/renderer/MyImageSourceRenderer
+
 [Renderer:MyAirTrafficNoiseRenderer]
 Class = BinauralAirTrafficNoise
 Enabled = false

src/Rendering/Prototyping/ImageSource/VAPTImageSourceAudioRenderer.h

+/*
+ *  --------------------------------------------------------------------------------------------
+ *
+ *    VVV        VVV A           Virtual Acoustics (VA) | http://www.virtualacoustics.org
+ *     VVV      VVV AAA          Licensed under the Apache License, Version 2.0
+ *      VVV    VVV   AAA
+ *       VVV  VVV     AAA        Copyright 2015-2018
+ *        VVVVVV       AAA       Institute of Technical Acoustics (ITA)
+ *         VVVV         AAA      RWTH Aachen University
+ *
+ *  --------------------------------------------------------------------------------------------
+ */
+
+
+#ifdef VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE
+
+// VA includes
+#include "../../VAAudioRenderer.h"
+#include "../../VAAudioRendererRegistry.h"
+#include "../../../Scene/VAScene.h"
+#include <VA.h>
+#include <VAObjectPool.h>
+#include "../../../core/core.h"
+
+// ITA includes
+#include <ITASampleFrame.h>
+#include <ITASampleBuffer.h>
+#include <ITAStreamInfo.h>
+#include <ITADataSourceRealization.h>
+
+// 3rdParty Includes
+#include <tbb/concurrent_queue.h>
+
+// STL Includes
+#include <list>
+#include <set>
+
+// VA forwards
+class CVASceneState;
+class CVASceneStateDiff;
+class CVASignalSourceManager;
+class CVASoundSourceDesc;
+class ITADatasourceRealization;
+
+// Internal forwards
+class CVAPTImageSourceSoundPath;
+class CVAPTImageSourceSoundPathFactory;
+
+//! Generic sound path audio renderer
+/**
+  * The generic sound path audio renderer is a convolution-only
+  * engine that renders single input multiple channel impulse responses 
+  * using the sound source signals. For each sound path (source -> listener)
+  * a convolution processor is created that can be feeded with an arbitrary IR
+  * by the user, hence the name 'generic'.
+  *
+  */
+class CVAPTImageSourceAudioRenderer : public IVAAudioRenderer, public ITADatasourceRealizationEventHandler
+{
+public:
+	CVAPTImageSourceAudioRenderer( const CVAAudioRendererInitParams& oParams );
+	virtual ~CVAPTImageSourceAudioRenderer();
+	void Reset();
+	inline void LoadScene( const std::string& ) {};
+	void UpdateScene( CVASceneState* );
+	void UpdateGlobalAuralizationMode( int );
+	ITADatasource* GetOutputDatasource();
+
+	void HandleProcessStream( ITADatasourceRealization*, const ITAStreamInfo* );
+	void HandlePostIncrementBlockPointer( ITADatasourceRealization* ) {};
+
+	void SetParameters( const CVAStruct& );
+	CVAStruct GetParameters( const CVAStruct& ) const;
+
+	std::string HelpText() const;
+
+
+
+
+protected:
+
+	//! Internal source representation
+	class CVAPTGPSource : public CVAPoolObject 
+	{
+	public:
+		CVASoundSourceDesc* pData; //!< (Unversioned) Source description
+		bool bDeleted;
+	};
+
+
+	//! Internal listener representation
+	class CVAPTGPListener : public CVAPoolObject 
+	{
+	public:
+		CVACoreImpl* pCore;
+		CVAListenerDesc* pData;				//!< (Unversioned) Listener description
+		bool bDeleted;
+		ITASampleFrame* psfOutput;
+	};
+
+private:
+
+	void UpdateFilter(); //Update the IR filter and sound for changes to the internal IS parameters are made
+
+	void CalculateImageSourceImpulseResponse(ITASampleBuffer& sbIRL, ITASampleBuffer& sbIRR, CVAPTImageSourceSoundPath* pPath);
+	void CartVec2PolarVec(VAVec3 in, VAVec3 *out);
+	void SetIRFilterLength();
+
+	const CVAAudioRendererInitParams m_oParams; //!< Create a const copy of the init params
+
+	CVACoreImpl* m_pCore;					//!< Pointer to VACore
+
+	CVASceneState* m_pCurSceneState;
+	CVASceneState* m_pNewSceneState;
+
+	int m_iCurGlobalAuralizationMode;
+	
+	IVAObjectPool* m_pSoundPathPool;
+	CVAPTImageSourceSoundPathFactory* m_pSoundPathFactory;
+	std::list< CVAPTImageSourceSoundPath* > m_lSoundPaths;	//!< List of sound paths in user context (VACore calls)	
+
+	IVAObjectPool* m_pSourcePool;
+	IVAObjectPool* m_pListenerPool;
+
+	std::map< int, CVAPTGPSource* > m_mSources;	//!< Internal list of sources
+	std::map< int, CVAPTGPListener* > m_mListeners;	//!< Internal list of listener
+		
+	int m_iIRFilterLengthSamples; //!< Length of the HRIR filter DSP module
+	int m_iNumChannels;		      //!< Number of channels per sound path
+	double m_RoomLength, m_RoomWidth, m_RoomHeight;	  //The dimensions of the shoebox room used for the image source IR calculation
+	double m_beta[6];					//room reflection coefficients
+	int m_MaxOrder;				  //The maximum order of image source computed
+	bool m_direct_sound;		//set to true to include 0th order (direct sound) image source, or false to disregard
+	int m_HRIR_length;			//set the the length of the HRTF used
+	int m_iIRFilterLengthSamples_ref; //reference value for user input
+	bool m_bOutputMonitoring;     //!< Shows output infos / warnings if the overall listener output is zero (no filter loaded)
+	ITADatasourceRealization* m_pOutput;
+	ITASampleBuffer m_sfTempBuffer;
+
+	double m_dRoomVolume;
+
+
+	class CVAPTGPUpdateMessage : public CVAPoolObject
+	{
+	public:
+		std::list< CVAPTGPSource* > vNewSources;
+		std::list< CVAPTGPSource* > vDelSources;
+		std::list< CVAPTGPListener* > vNewListeners;
+		std::list< CVAPTGPListener* > vDelListeners;
+		std::list< CVAPTImageSourceSoundPath* > vNewPaths;
+		std::list< CVAPTImageSourceSoundPath* > vDelPaths;
+
+		inline void PreRequest()
+		{
+			vNewSources.clear();
+			vDelSources.clear();
+			vNewListeners.clear();
+			vDelListeners.clear();
+			vNewPaths.clear();
+			vDelPaths.clear();
+		};
+	};
+
+	IVAObjectPool* m_pUpdateMessagePool; // really necessary?
+	CVAPTGPUpdateMessage* m_pUpdateMessage;
+
+	//! Data in context of audio process
+	struct
+	{
+		tbb::concurrent_queue< CVAPTGPUpdateMessage* > m_qpUpdateMessages;	//!< Update messages list
+		std::list< CVAPTImageSourceSoundPath* > m_lSoundPaths;	//!< List of sound paths
+		std::list< CVAPTGPSource* > m_lSources;			//!< List of sources
+		std::list< CVAPTGPListener* > m_lListener;		//!< List of listeners
+		std::atomic< int > m_iResetFlag;	//!< Reset status flag: 0=normal_op, 1=reset_request, 2=reset_ack
+		std::atomic< int > m_iStatus;		//!< Current status flag: 0=stopped, 1=running
+	} ctxAudio;
+
+	void Init( const CVAStruct& );
+
+	void ManageSoundPaths( const CVASceneState* pCurScene,
+		                   const CVASceneState* pNewScene,
+						   const CVASceneStateDiff* pDiff );
+	void UpdateSources();
+	CVAPTGPListener* CreateListener( int iID, const CVAReceiverState* );
+	void DeleteListener( int iID );
+	CVAPTGPSource* CreateSource( int iID, const CVASoundSourceState* );
+	void DeleteSource( int iID );
+	CVAPTImageSourceSoundPath* CreateSoundPath( CVAPTGPSource*, CVAPTGPListener* );
+	void DeleteSoundPath(CVAPTImageSourceSoundPath* );
+	
+	void SyncInternalData();
+	void ResetInternalData();
+
+	void UpdateGenericSoundPath( int iListenerID, int iSourceID, const std::string& sIRFilePath );
+	void UpdateGenericSoundPath( int iListenerID, int iSourceID, int iChannel, const std::string& sIRFilePath );
+	void UpdateGenericSoundPath( int iListenerID, int iSourceID, ITASampleFrame& sfIR );
+	void UpdateGenericSoundPath( int iListenerID, int iSourceID, int iChannel, ITASampleBuffer& sbIR );
+	void UpdateGenericSoundPath( const int iListenerID, const int iSourceID, const double dDelaySeconds );
+
+	friend class CVAPTImageSourceSoundPath;
+	friend class CVAPTISListenerPoolFactory;
+	friend class CVAPTISSourcePoolFactory;
+
+	//! Not for use, avoid C4512
+	inline CVAPTImageSourceAudioRenderer operator=( const CVAPTImageSourceAudioRenderer & ) { VA_EXCEPT_NOT_IMPLEMENTED; };
+};
+
+#endif // VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCES
+

src/Rendering/Prototyping/ImageSource/_SourceFiles.cmake

+# $Id:$
+
+set( RelativeDir "src/Rendering/Prototyping/ImageSource" )
+set( RelativeSourceGroup "src\\Rendering\\Prototyping\\ImageSource" )
+
+set( DirFiles
+	VAPTImageSourceAudioRenderer.cpp
+	VAPTImageSourceAudioRenderer.h
+	_SourceFiles.cmake
+)
+set( DirFiles_SourceGroup "${RelativeSourceGroup}" )
+
+set( LocalSourceGroupFiles  )
+foreach( File ${DirFiles} )
+	list( APPEND LocalSourceGroupFiles "${RelativeDir}/${File}" )
+	list( APPEND ProjectSources "${RelativeDir}/${File}" )
+endforeach()
+source_group( ${DirFiles_SourceGroup} FILES ${LocalSourceGroupFiles} )
+

src/Rendering/Prototyping/_SourceFiles.cmake

@@ -2,7 +2,7 @@
 
 set( RelativeDir "src/Rendering/Prototyping" )
 set( RelativeSourceGroup "src\\Rendering\\Prototyping" )
-set( SubDirs Dummy GenericPath HearingAid FreeField )
+set( SubDirs Dummy GenericPath HearingAid FreeField ImageSource )
 
 set( DirFiles
 	_SourceFiles.cmake

src/Rendering/VAAudioRendererRegistry.cpp

@@ -21,6 +21,7 @@
 #include "Binaural/RoomAcoustics/VARoomAcousticsAudioRenderer.h"
 #include "Prototyping/FreeField/VAPrototypeFreeFieldAudioRenderer.h"
 #include "Prototyping/Dummy/VAPTDummyAudioRenderer.h"
+#include "Prototyping/ImageSource/VAPTImageSourceAudioRenderer.h"
 #include "Prototyping/GenericPath/VAPTGenericPathAudioRenderer.h"
 #include "Prototyping/HearingAid/VAPTHearingAidRenderer.h"
 #include "VBAP/Freefield/VAVBAPFreefieldAudioRenderer.h"
@@ -31,6 +32,7 @@
 
 #include <cassert>
 
+
 static CVAAudioRendererRegistry* g_pInstance;
 
 CVAAudioRendererRegistry* CVAAudioRendererRegistry::GetInstance()
@@ -81,36 +83,44 @@ void CVAAudioRendererRegistry::RegisterInternalCoreFactoryMethods()
 	// Binaural
 #ifdef VACORE_WITH_RENDERER_BINAURAL_FREE_FIELD
 	RegisterRendererDefaultFactory< CVABinauralFreeFieldAudioRenderer >( "BinauralFreeField" );
-#endif
+#endif // VACORE_WITH_RENDERER_BINAURAL_FREE_FIELD
 #ifdef VACORE_WITH_RENDERER_BINAURAL_AIR_TRAFFIC_NOISE
 	RegisterRendererDefaultFactory< CVABinauralAirTrafficNoiseAudioRenderer >( "BinauralAirTrafficNoise" );
-#endif
+#endif // VACORE_WITH_RENDERER_BINAURAL_AIR_TRAFFIC_NOISE
 #ifdef VACORE_WITH_RENDERER_BINAURAL_ARTIFICIAL_REVERB
 	RegisterRendererDefaultFactory< CVABinauralArtificialReverbAudioRenderer >( "BinauralArtificialReverb" );
-#endif
+#endif // VACORE_WITH_RENDERER_BINAURAL_ARTIFICIAL_REVERB
 #ifdef VACORE_WITH_RENDERER_BINAURAL_ROOM_ACOUSTICS
 	RegisterRendererDefaultFactory< CVARoomAcousticsAudioRenderer>( "BinauralRoomAcoustics" );
-#endif 
+#endif // VACORE_WITH_RENDERER_BINAURAL_ROOM_ACOUSTICS 
 
 	// Prototyping
 #ifdef VACORE_WITH_RENDERER_PROTOTYPE_FREE_FIELD
 	RegisterRendererDefaultFactory< CVAPrototypeFreeFieldAudioRenderer >( "PrototypeFreeField" );
-#endif
+#endif // VACORE_WITH_RENDERER_PROTOTYPE_FREE_FIELD
 
 #ifdef VACORE_WITH_RENDERER_PROTOTYPE_DUMMY
 	RegisterRendererDefaultFactory< CVAPTDummyAudioRenderer >( "PrototypeDummy" );
-#endif
+#endif // VACORE_WITH_RENDERER_PROTOTYPE_DUMMY
 #ifdef VACORE_WITH_RENDERER_PROTOTYPE_GENERIC_PATH
+	//VA_REGISTER_AUDIO_RENDERER( CVAPTGenericPathAudioRenderer, "GenericPath" );
 	RegisterRendererDefaultFactory< CVAPTGenericPathAudioRenderer >( "PrototypeGenericPath" );
-#endif
+#endif // VACORE_WITH_RENDERER_PROTOTYPE_GENERIC_PATH
+
+
+#ifdef VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE
+		RegisterRendererDefaultFactory< CVAPTImageSourceAudioRenderer >("PrototypeImageSource");
+#endif // VACORE_WITH_RENDERER_PROTOTYPE_IMAGE_SOURCE
+
+
 #ifdef VACORE_WITH_RENDERER_PROTOTYPE_HEARING_AID
 	RegisterRendererDefaultFactory< CVAPTHearingAidRenderer >( "PrototypeHearingAid" );
-#endif
+#endif // VACORE_WITH_RENDERER_PROTOTYPE_HEARING_AID
 
 	// VBAP
 #ifdef VACORE_WITH_RENDERER_VBAP_FREE_FIELD
 	RegisterRendererDefaultFactory< CVAVBAPFreeFieldAudioRenderer >( "VBAPFreeField" );
-#endif
+#endif // VACORE_WITH_RENDERER_VBAP_FREE_FIELD
 
 	m_bInternalCoreFactoriesRegistered = true;
 }