fix: Improve Amplitude integration in other tools.

- Added methods to manually register and unregister default plugins to the engine. - Set the `AM_SDK_PATH` env var to be the direct path to the SDK, and not the parent directory. - Added include files in generated CMake config.
AmplitudeAudio · Mar 6, 2024 · 5ef42f5 · 5ef42f5
1 parent af0cd22
commit 5ef42f5
Show file tree

Hide file tree

Showing 36 changed files with 303 additions and 134 deletions.
diff --git a/.gitignore b/.gitignore
@@ -53,6 +53,7 @@ docs/html/
 docs/linklint_results/
 docs/resources/_gen/
 docs/.hugo_build.lock
+docs/node_modules/
 gen/
 .DS_Store
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -383,8 +383,6 @@ foreach(build_type ${AM_BUILDSYSTEM_TYPE})
     target_link_libraries(${build_type}
         PRIVATE
             flatbuffers::flatbuffers SampleRate::samplerate xsimd
-        PUBLIC
-            mimalloc-static
     )
 
     add_dependencies(${build_type}
@@ -402,6 +400,9 @@ foreach(build_type ${AM_BUILDSYSTEM_TYPE})
     endif()
 endforeach()
 
+target_link_libraries(Static PUBLIC mimalloc-static)
+target_link_libraries(Shared PUBLIC mimalloc)
+
 add_subdirectory(tools/amac)
 
 if(BUILD_SAMPLES)
@@ -415,6 +416,7 @@ install(
     TARGETS Static
     EXPORT AmplitudeAudioSDKConfig
     ARCHIVE DESTINATION ${AM_LIB_DESTINATION}/static
+    INCLUDES DESTINATION ${AM_INC_DESTINATION}
 )
 
 install(
@@ -423,8 +425,14 @@ install(
     ARCHIVE DESTINATION ${AM_LIB_DESTINATION}/shared
     LIBRARY DESTINATION ${AM_LIB_DESTINATION}/shared
     RUNTIME DESTINATION ${AM_LIB_DESTINATION}/shared
+    INCLUDES DESTINATION ${AM_INC_DESTINATION}
 )
 
+install(
+    FILES $<TARGET_RUNTIME_DLLS:Shared>
+    DESTINATION ${AM_LIB_DESTINATION}/shared
+ )
+
 install(
     DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/
     DESTINATION ${AM_INC_DESTINATION}

diff --git a/cmake/FindAmplitudeAudioSDK.cmake b/cmake/FindAmplitudeAudioSDK.cmake
@@ -51,6 +51,7 @@ if(NOT found_sdk)
 endif()
 
 message(STATUS "Using Amplitude Audio SDK at ${AM_SDK_PATH}")
+set(AmplitudeAudioSDK_FOUND TRUE)
 
 set(AMPLITUDE_COMPILE_DEFINITIONS
     $<IF:$<CONFIG:Release>,AMPLITUDE_NO_ASSERTS,>
@@ -91,17 +92,17 @@ endif()
 
 add_library(SparkyStudios::Audio::Amplitude::SDK::Static STATIC IMPORTED GLOBAL)
 set_target_properties(SparkyStudios::Audio::Amplitude::SDK::Static PROPERTIES
-    IMPORTED_LOCATION "${AM_SDK_PATH}/sdk/lib/${AMPLITUDE_LIB_OS}/static/${AMPLITUDE_STATIC_LIB_NAME}"
-    IMPORTED_LOCATION_DEBUG "${AM_SDK_PATH}/sdk/lib/${AMPLITUDE_LIB_OS}/static/${AMPLITUDE_STATIC_LIB_NAME_DEBUG}"
-    INTERFACE_INCLUDE_DIRECTORIES "${AM_SDK_PATH}/sdk/include"
+    IMPORTED_LOCATION "${AM_SDK_PATH}/lib/${AMPLITUDE_LIB_OS}/static/${AMPLITUDE_STATIC_LIB_NAME}"
+    IMPORTED_LOCATION_DEBUG "${AM_SDK_PATH}/lib/${AMPLITUDE_LIB_OS}/static/${AMPLITUDE_STATIC_LIB_NAME_DEBUG}"
+    INTERFACE_INCLUDE_DIRECTORIES "${AM_SDK_PATH}/include"
     INTERFACE_COMPILE_DEFINITIONS "AM_BUILDSYSTEM_STATIC"
 )
 
 add_library(SparkyStudios::Audio::Amplitude::SDK::Shared SHARED IMPORTED GLOBAL)
 set_target_properties(SparkyStudios::Audio::Amplitude::SDK::Shared PROPERTIES
-    IMPORTED_LOCATION "${AM_SDK_PATH}/sdk/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_SHARED_LIB_NAME}"
-    IMPORTED_LOCATION_DEBUG "${AM_SDK_PATH}/sdk/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_SHARED_LIB_NAME_DEBUG}"
-    INTERFACE_INCLUDE_DIRECTORIES "${AM_SDK_PATH}/sdk/include"
+    IMPORTED_LOCATION "${AM_SDK_PATH}/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_SHARED_LIB_NAME}"
+    IMPORTED_LOCATION_DEBUG "${AM_SDK_PATH}/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_SHARED_LIB_NAME_DEBUG}"
+    INTERFACE_INCLUDE_DIRECTORIES "${AM_SDK_PATH}/include"
     INTERFACE_COMPILE_DEFINITIONS "AM_BUILDSYSTEM_SHARED"
 )
 
@@ -112,7 +113,7 @@ if(WIN32)
     endif()
 
     set_target_properties(SparkyStudios::Audio::Amplitude::SDK::Shared PROPERTIES
-        IMPORTED_IMPLIB "${AM_SDK_PATH}/sdk/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_STATIC_LIB_NAME}"
-        IMPORTED_IMPLIB_DEBUG "${AM_SDK_PATH}/sdk/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_STATIC_LIB_NAME_DEBUG}"
+        IMPORTED_IMPLIB "${AM_SDK_PATH}/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_STATIC_LIB_NAME}"
+        IMPORTED_IMPLIB_DEBUG "${AM_SDK_PATH}/lib/${AMPLITUDE_LIB_OS}/shared/${AMPLITUDE_STATIC_LIB_NAME_DEBUG}"
     )
 endif()
diff --git a/include/SparkyStudios/Audio/Amplitude/Core/Engine.h b/include/SparkyStudios/Audio/Amplitude/Core/Engine.h
@@ -1226,6 +1226,16 @@ namespace SparkyStudios::Audio::Amplitude
          */
         static void RemovePluginSearchPath(const AmOsString& path);
 
+        /**
+         * @brief Register all default plugins.
+         */
+        static void RegisterDefaultPlugins();
+
+        /**
+         * @brief Unregister all default plugins.
+         */
+        static void UnregisterDefaultPlugins();
+
 #pragma endregion
 
         /**

diff --git a/scripts/common.py b/scripts/common.py
@@ -28,12 +28,12 @@
 
 # The Amplitude Audio SDK schemas directory.
 SCHEMA_PATHS = [
-    os.path.join(SDK_PATH, "sdk", "schemas")
+    os.path.join(SDK_PATH, "schemas")
 ]
 
 # Name of the flatbuffers executable.
 FLATC = (shutil.which("flatc")
-         or os.path.join(SDK_PATH, "sdk", "bin", os.getenv("AM_SDK_PLATFORM") or "", "flatc"))
+         or os.path.join(SDK_PATH, "bin", os.getenv("AM_SDK_PLATFORM") or "", "flatc"))
 
 # Directory where unprocessed sound flatbuffers data can be found.
 SOUNDS_DIR_NAME = 'sounds'

diff --git a/src/Core/Codecs/AMS/Codec.cpp b/src/Core/Codecs/AMS/Codec.cpp
@@ -16,7 +16,7 @@
 
 using namespace SparkyStudios::Audio::Amplitude::Compression::ADPCM;
 
-namespace SparkyStudios::Audio::Amplitude::Codecs
+namespace SparkyStudios::Audio::Amplitude
 {
     static void little_endian_to_native(void* data, const char* format)
     {
@@ -641,4 +641,4 @@ namespace SparkyStudios::Audio::Amplitude::Codecs
         const auto& path = file->GetPath();
         return path.find(AM_OS_STRING(".ams")) != AmOsString::npos;
     }
-} // namespace SparkyStudios::Audio::Amplitude::Codecs
+} // namespace SparkyStudios::Audio::Amplitude
diff --git a/src/Core/Codecs/AMS/Codec.h b/src/Core/Codecs/AMS/Codec.h
@@ -21,9 +21,9 @@
 
 #include <Utils/Audio/Compression/ADPCM/ADPCM.h>
 
-namespace SparkyStudios::Audio::Amplitude::Codecs
+namespace SparkyStudios::Audio::Amplitude
 {
-    [[maybe_unused]] static class AMSCodec final : public Codec
+    class AMSCodec final : public Codec
     {
     public:
         class AMSDecoder final : public Decoder
@@ -96,7 +96,7 @@ namespace SparkyStudios::Audio::Amplitude::Codecs
         void DestroyEncoder(Encoder* encoder) override;
 
         [[nodiscard]] bool CanHandleFile(std::shared_ptr<File> file) const override;
-    } ams_codec; // NOLINT(cert-err58-cpp)
-} // namespace SparkyStudios::Audio::Amplitude::Codecs
+    };
+} // namespace SparkyStudios::Audio::Amplitude
 
 #endif // SS_AMPLITUDE_AUDIO_AMS_CODEC_H
diff --git a/src/Core/Codecs/MP3/Codec.cpp b/src/Core/Codecs/MP3/Codec.cpp
@@ -17,7 +17,7 @@
 
 #include <Core/Codecs/MP3/Codec.h>
 
-namespace SparkyStudios::Audio::Amplitude::Codecs
+namespace SparkyStudios::Audio::Amplitude
 {
     static void* onMalloc(size_t sz, void* pUserData)
     {
@@ -176,4 +176,4 @@ namespace SparkyStudios::Audio::Amplitude::Codecs
         const auto& path = file->GetPath();
         return path.find(AM_OS_STRING(".mp3")) != AmOsString::npos;
     }
-} // namespace SparkyStudios::Audio::Amplitude::Codecs
+} // namespace SparkyStudios::Audio::Amplitude
diff --git a/src/Core/Codecs/MP3/Codec.h b/src/Core/Codecs/MP3/Codec.h
@@ -21,9 +21,9 @@
 
 #include "dr_mp3.h"
 
-namespace SparkyStudios::Audio::Amplitude::Codecs
+namespace SparkyStudios::Audio::Amplitude
 {
-    [[maybe_unused]] static class MP3Codec final : public Codec
+    class MP3Codec final : public Codec
     {
     public:
         class MP3Decoder final : public Decoder
@@ -86,7 +86,7 @@ namespace SparkyStudios::Audio::Amplitude::Codecs
         [[nodiscard]] bool CanHandleFile(std::shared_ptr<File> file) const override;
 
         drmp3_allocation_callbacks m_allocationCallbacks;
-    } mp3_codec; // NOLINT(cert-err58-cpp)
-} // namespace SparkyStudios::Audio::Amplitude::Codecs
+    };
+} // namespace SparkyStudios::Audio::Amplitude
 
 #endif // SS_AMPLITUDE_AUDIO_MP3_CODEC_H
diff --git a/src/Core/Codecs/WAV/Codec.cpp b/src/Core/Codecs/WAV/Codec.cpp
@@ -17,7 +17,7 @@
 
 #include <Core/Codecs/WAV/Codec.h>
 
-namespace SparkyStudios::Audio::Amplitude::Codecs
+namespace SparkyStudios::Audio::Amplitude
 {
     static void* onMalloc(size_t sz, void* pUserData)
     {
@@ -222,4 +222,4 @@ namespace SparkyStudios::Audio::Amplitude::Codecs
         const auto& path = file->GetPath();
         return path.find(AM_OS_STRING(".wav")) != AmOsString::npos;
     }
-} // namespace SparkyStudios::Audio::Amplitude::Codecs
+} // namespace SparkyStudios::Audio::Amplitude
diff --git a/src/Core/Codecs/WAV/Codec.h b/src/Core/Codecs/WAV/Codec.h
@@ -21,9 +21,9 @@
 
 #include "dr_wav.h"
 
-namespace SparkyStudios::Audio::Amplitude::Codecs
+namespace SparkyStudios::Audio::Amplitude
 {
-    [[maybe_unused]] static class WAVCodec final : public Codec
+    class WAVCodec final : public Codec
     {
     public:
         class WAVDecoder final : public Decoder
@@ -92,7 +92,7 @@ namespace SparkyStudios::Audio::Amplitude::Codecs
         [[nodiscard]] bool CanHandleFile(std::shared_ptr<File> file) const override;
 
         drwav_allocation_callbacks m_allocationCallbacks;
-    } wav_codec; // NOLINT(cert-err58-cpp)
-} // namespace SparkyStudios::Audio::Amplitude::Codecs
+    };
+} // namespace SparkyStudios::Audio::Amplitude
 
 #endif // SS_AMPLITUDE_AUDIO_WAV_CODEC_H
diff --git a/src/Core/DefaultPlugins.h b/src/Core/DefaultPlugins.h
@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#pragma once
+
 #ifndef AMPLITUDE_DEFAULTPLUGINS_H
 #define AMPLITUDE_DEFAULTPLUGINS_H
 
@@ -47,4 +49,17 @@
 
 #pragma endregion
 
+#pragma region Default Codecs
+
+#include <Core/Codecs/AMS/Codec.h>
+
+#pragma endregion
+
+#pragma region Default Drivers
+
+#include <Core/Drivers/MiniAudio/Driver.h>
+#include <Core/Drivers/Null/Driver.h>
+
+#pragma endregion
+
 #endif // AMPLITUDE_DEFAULTPLUGINS_H
diff --git a/src/Core/Drivers/MiniAudio/Driver.cpp b/src/Core/Drivers/MiniAudio/Driver.cpp
@@ -16,7 +16,7 @@
 
 #include <Mixer/Mixer.h>
 
-namespace SparkyStudios::Audio::Amplitude::Drivers
+namespace SparkyStudios::Audio::Amplitude
 {
     static void* ma_malloc(size_t sz, void* pUserData)
     {
@@ -399,4 +399,4 @@ namespace SparkyStudios::Audio::Amplitude::Drivers
 
         return true;
     }
-} // namespace SparkyStudios::Audio::Amplitude::Drivers
+} // namespace SparkyStudios::Audio::Amplitude
diff --git a/src/Core/Drivers/MiniAudio/Driver.h b/src/Core/Drivers/MiniAudio/Driver.h
@@ -21,9 +21,9 @@
 
 #include <Utils/miniaudio/miniaudio_utils.h>
 
-namespace SparkyStudios::Audio::Amplitude::Drivers
+namespace SparkyStudios::Audio::Amplitude
 {
-    [[maybe_unused]] static class MiniAudioDriver final : public Driver
+    class MiniAudioDriver final : public Driver
     {
     public:
         MiniAudioDriver();
@@ -49,7 +49,7 @@ namespace SparkyStudios::Audio::Amplitude::Drivers
         ma_context _context;
 
         std::vector<DeviceDescription> _devices;
-    } g_driver_miniaudio; // NOLINT(cert-err58-cpp)
-} // namespace SparkyStudios::Audio::Amplitude::Drivers
+    };
+} // namespace SparkyStudios::Audio::Amplitude
 
 #endif // SS_AMPLITUDE_AUDIO_MINIAUDIO_DRIVER_H
diff --git a/src/Core/Drivers/Null/Driver.cpp b/src/Core/Drivers/Null/Driver.cpp
@@ -16,7 +16,7 @@
 
 #include <Mixer/Mixer.h>
 
-namespace SparkyStudios::Audio::Amplitude::Drivers
+namespace SparkyStudios::Audio::Amplitude
 {
     static void null_mix(void* param)
     {
@@ -83,4 +83,4 @@ namespace SparkyStudios::Audio::Amplitude::Drivers
     {
         return true;
     }
-} // namespace SparkyStudios::Audio::Amplitude::Drivers
+} // namespace SparkyStudios::Audio::Amplitude
diff --git a/src/Core/Drivers/Null/Driver.h b/src/Core/Drivers/Null/Driver.h
@@ -19,7 +19,7 @@
 
 #include <SparkyStudios/Audio/Amplitude/Amplitude.h>
 
-namespace SparkyStudios::Audio::Amplitude::Drivers
+namespace SparkyStudios::Audio::Amplitude
 {
     struct NullDriverDeviceData
     {
@@ -28,7 +28,7 @@ namespace SparkyStudios::Audio::Amplitude::Drivers
         bool mRunning;
     };
 
-    [[maybe_unused]] static class NullDriver final : public Driver
+    class NullDriver final : public Driver
     {
     public:
         NullDriver();
@@ -47,7 +47,7 @@ namespace SparkyStudios::Audio::Amplitude::Drivers
         AmThreadHandle _thread;
 
         NullDriverDeviceData _deviceData;
-    } g_driver_null; // NOLINT(cert-err58-cpp)
-} // namespace SparkyStudios::Audio::Amplitude::Drivers
+    };
+} // namespace SparkyStudios::Audio::Amplitude
 
 #endif // SS_AMPLITUDE_AUDIO_NULL_DRIVER_H