spcap test and some comments;

optionally build pimpl in cmake

Author: TobiasKozel

CMakeLists.txt

@@ -10,7 +10,8 @@ project(
 	LANGUAGES CXX
 )
 
-option(BUILD_SHARED_LIBS "Build shared lib" OFF) # broken in subproject but works with pimpl
+option(BUILD_SHARED_LIBS "Build shared lib" OFF)
+option(VAE_BUILD_PIMPL "Build PIMPL API" OFF)
 option(VAE_PROFILER "Use profiler" OFF)
 option(VAE_BACKEND_PORTAUDIO "Compile with port audio" OFF)
 option(VAE_BACKEND_RTAUDIO "Compile with RtAudio" ON)
@@ -25,7 +26,9 @@ list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake)
 
 #################            add main lib             #################
 
-file(GLOB PUBLIC_API "src/api/*.cpp")
+if (VAE_BUILD_PIMPL)
+	file(GLOB PIMPL_API "src/api/*.cpp")
+endif()
 file(GLOB SRC_CORE "src/core/*.hpp")
 file(GLOB SRC_WRAPPED "src/wrapped/*.cpp")
 file(GLOB SRC_DEVICE "src/core/device/*.hpp")
@@ -37,7 +40,7 @@ if (BUILD_SHARED_LIBS)
 			${SRC_CORE}
 			${SRC_WRAPPED}
 			${SRC_DEVICE}
-			${PUBLIC_API}
+			${PIMPL_API}
 	)
 	target_compile_definitions(
 		vae
@@ -51,11 +54,10 @@ else()
 			${SRC_CORE}
 			${SRC_WRAPPED}
 			${SRC_DEVICE}
-			${PUBLIC_API}
+			${PIMPL_API}
 	)
 endif()
 
-source_group("api" FILES ${PUBLIC_API})
 source_group("core" FILES ${SRC_CORE})
 
 #Add an alias so that library can be used inside the build tree, e.g. when testing

example/pimpl/compiletime.cpp

@@ -1,11 +1,12 @@
 #include "../../include/vae/vae_pimpl.hpp"
 #include <chrono>
 #include <thread>
+
 int main() {
 	auto e = vae::EnginePimpl::create();
 	e->start();
 	std::this_thread::sleep_for(std::chrono::duration<double, std::milli>(4000));
-	e->stop();
+	e->stop(); // stopping is optional
 	e->destroy();
 	return 0;
 }

src/core/algo/vae_spcap.hpp

@@ -6,25 +6,38 @@
 
 namespace vae { namespace core {
 	/**
-	 * @brief Struct providing SPCAP configurations hard coded
+	 * @brief Struct containing SPCAP and preconfigured speaker setups
 	 */
 	struct SPCAP {
+		/**
+		 * @brief Class handling SPCAP for arbitrary speaker setups
+		 * @tparam N Amount of speakers. Does not include LFE.
+		 */
 		template <int N>
 		class SPCAPConfig {
 			struct Speaker {
-				Vec3 dir;
-				Sample effective;
+				Vec3 dir;			// Position of the speaker on a unit sphere
+				Sample effective;	//
 			};
 			Speaker mSpeakers[N];
 		public:
-			SPCAPConfig(const std::initializer_list<Vec3>& directions) {
+			/**
+			 * @brief Construct a new SPCAPConfig object
+			 * Implemented according to
+			 * https://www.researchgate.net/publication/235080603_A_Novel_Multichannel_Panning_Method_for_Standard_and_Arbitrary_Loudspeaker_Configurations
+			 * @param positions Speaker positions, will be normalized.
+			 */
+			SPCAPConfig(const std::initializer_list<Vec3>& positions) {
 				int i = 0;
-				for (const auto& speaker : directions) {
+				for (const auto& speaker : positions) {
 					mSpeakers[i] = { glm::normalize(speaker), Sample(0) };
 					i++;
 				}
 				for (i = 0; i < N; i++) {
 					for (int j = 0; j < N; j++) {
+						// Calculate the effective number of speakers according to (2)
+						// Can be done in adavnce and ideally at compiletime
+						// since the positions of the speakers will not change
 						mSpeakers[i].effective +=
 							Sample(0.5) * (Sample(1.0) + glm::dot(mSpeakers[i].dir, mSpeakers[j].dir));
 					}
@@ -41,32 +54,38 @@ namespace vae { namespace core {
 			 * @param attenuation Distance attenuation multiplied on the result
 			 * @param spread Value from 0-1 controlling "wideness" of the sound
 			 */
-			void pan(const Vec3& direction, Sample* result, Sample attenuation, Sample spread) const {
+			void pan(const Vec3& direction, Sample result[N], Sample attenuation, Sample spread) const {
 				VAE_PROFILER_SCOPE
 				// TODO make spread change based on distance and use something like radius instead
-				Sample sumSquaredGains = 0.0;
-				const Sample tightness = (Sample(1) - spread) * Sample(10) + Sample(0.05);
+				Sample sumGains = 0.0;
+				// const Sample tightness = (Sample(1) - spread) * Sample(10) + Sample(0.05);
+				const Sample tightness = 1.0;
 				std::fill_n(result, N, Sample(0));
 				for (int i = 0; i < N; i++) {
-					Sample gain = Sample(0.5) * powf(Sample(1.0) + glm::dot(mSpeakers[i].dir, direction), tightness);
-					gain /= mSpeakers[i].effective;
-					gain = gain * gain;
+					Sample gain = glm::dot(mSpeakers[i].dir, direction) + Sample(1.0); // (1)
+					gain  = powf(gain, tightness);	// (9)
+					gain *= Sample(0.5);			// (1)
+					gain /= mSpeakers[i].effective;	// (3)
+					gain  = gain * gain;			// (4)
 					result[i] = gain;
-					sumSquaredGains += gain;
+					sumGains += gain;				// (4)
 				}
 
 				for (int i = 0; i < N; i++) {
-					result[i] = sqrtf(result[i] / sumSquaredGains) * attenuation;
+					result[i] = sqrtf(result[i] / sumGains) * attenuation; // (8)
 				}
 			}
 		};
-		// Initialized below because c++
+		// Initialized below because c++ 14
 		static const SPCAPConfig<2> HeadphoneSPCAP;
 		static const SPCAPConfig<2> StereroSPCAP;
 		static const SPCAPConfig<4> QuadSPCAP;
 		static const SPCAPConfig<5> SuroundSPCAP;
 	}; // SPCAP
 
+	/**
+	 * TODO there's probably a smart  way to make this all constexpr
+	 */
 	const SPCAP::SPCAPConfig<2> SPCAP::HeadphoneSPCAP = {
 		{ -1, 0, 0}, { +1, 0, 0}		// LR Side
 	};

src/core/device/vae_portaudio.hpp

@@ -7,7 +7,6 @@
 
 #include "../../../external/portaudio/include/portaudio.h"
 #include "../../../external/portaudio/src/common/pa_debugprint.h"
-#include "util/TMath.hpp"
 
 namespace vae { namespace core {
 	/**

src/core/vae_util.hpp

@@ -3,16 +3,16 @@
 
 #include "../wrapped/vae_profiler.hpp"
 #include "../../external/tklb/src/util/TAssert.h"
+#include "../../external/tklb/src/util/TMath.hpp"
 #include "./vae_logger.hpp"
 #include "../../include/vae/vae.hpp"
 
 #define VAE_ASSERT(condition) TKLB_ASSERT(condition)
 namespace vae { namespace core {
-	void splitGlobalEventHandle(
+	inline void splitGlobalEventHandle(
 		const GlobalEventHandle& handle,
 		BankHandle& bank, EventHandle& event
 	) {
-
 		bank = handle >> (sizeof(EventHandle) * 8);
 		event = (handle & InvalidEventHandle);
 	}

tests/tvae_spcap.cpp

@@ -0,0 +1,20 @@
+#include <stdio.h>
+#include <cmath>
+#include "../src/core/algo/vae_spcap.hpp"
+
+
+/**
+ * @brief Test 5.1 panning setup and print volumes for each degree
+ */
+int main() {
+	printf("deg,s1,s2,s3,s4,s5\n");
+	for (int i = 0; i < 360; i++) {
+		float t = i / float(180) * 3.14159265358979323846;
+		vae::core::Sample p[5];
+		vae::core::SPCAP::SuroundSPCAP.pan({
+			sin(t), cos(t), 0
+		}, p, 1, 0.5);
+		printf("%i,%f,%f,%f,%f,%f\n", i, p[0], p[1], p[2], p[3], p[4]);
+	}
+	return 0;
+}