[Audio] Instrumented audio features for profiling purposes

include/RaZ/Audio/Microphone.hpp

@@ -17,8 +17,7 @@ class Microphone {
   /// \param duration Amount of time to record, in seconds. This is a minimum; the actual available duration may exceed this value.
   /// \param deviceName Name of the audio capture device to open; if empty, will use the default one.
   /// \see Microphone::recoverDevices()
-  Microphone(AudioFormat format, unsigned int frequency, float duration, const std::string& deviceName = {}) { openDevice(format, frequency,
-                                                                                                                          duration, deviceName); }
+  Microphone(AudioFormat format, unsigned int frequency, float duration, const std::string& deviceName = {});
   Microphone(const Microphone&) = delete;
   Microphone(Microphone&&) = delete;
 

src/RaZ/Audio/AudioSystem.cpp

@@ -6,6 +6,8 @@
 #include "RaZ/Physics/RigidBody.hpp"
 #include "RaZ/Utils/Logger.hpp"
 
+#include "tracy/Tracy.hpp"
+
 #include <AL/al.h>
 #include <AL/alc.h>
 
@@ -37,6 +39,8 @@ inline void checkError(void* device, const std::string& errorMsg) {
 } // namespace
 
 AudioSystem::AudioSystem(const std::string& deviceName) {
+  ZoneScopedN("AudioSystem::AudioSystem");
+
   registerComponents<Sound, Listener>();
   openDevice(deviceName);
 
@@ -63,6 +67,8 @@ std::vector<std::string> AudioSystem::recoverDevices() {
 }
 
 void AudioSystem::openDevice(const std::string& deviceName) {
+  ZoneScopedN("AudioSystem::openDevice");
+
   Logger::debug("[AudioSystem] Opening " + (!deviceName.empty() ? + "device '" + deviceName + '\'' : "default device") + "...");
 
   destroy();
@@ -95,6 +101,8 @@ std::string AudioSystem::recoverCurrentDevice() const {
 }
 
 bool AudioSystem::update(const FrameTimeInfo&) {
+  ZoneScopedN("AudioSystem::update");
+
 #if defined(RAZ_CONFIG_DEBUG)
   // Checking that only one Listener exists
   bool hasOneListener = false;
@@ -147,6 +155,8 @@ bool AudioSystem::update(const FrameTimeInfo&) {
 }
 
 void AudioSystem::destroy() {
+  ZoneScopedN("AudioSystem::destroy");
+
   if (m_context == nullptr && m_device == nullptr)
     return;
 

src/RaZ/Audio/Microphone.cpp

@@ -2,6 +2,8 @@
 #include "RaZ/Audio/Sound.hpp"
 #include "RaZ/Utils/Logger.hpp"
 
+#include "tracy/Tracy.hpp"
+
 #include <AL/al.h>
 #include <AL/alc.h>
 
@@ -83,6 +85,11 @@ constexpr int recoverFrameSize(AudioFormat format) {
 
 } // namespace
 
+Microphone::Microphone(AudioFormat format, unsigned int frequency, float duration, const std::string& deviceName) {
+  ZoneScopedN("Microphone::Microphone");
+  openDevice(format, frequency, duration, deviceName);
+}
+
 std::vector<std::string> Microphone::recoverDevices() {
   if (!alcIsExtensionPresent(nullptr, "ALC_ENUMERATE_ALL_EXT")) // If the needed extension is unsupported, return an empty vector
     return {};
@@ -102,6 +109,8 @@ std::vector<std::string> Microphone::recoverDevices() {
 }
 
 void Microphone::openDevice(AudioFormat format, unsigned int frequency, float duration, const std::string& deviceName) {
+  ZoneScopedN("Microphone::openDevice");
+
   Logger::debug("[Microphone] Opening capture " + (!deviceName.empty() ? + "device '" + deviceName + '\'' : "default device") + "...");
 
   destroy();
@@ -169,6 +178,8 @@ std::vector<uint8_t> Microphone::recoverData(float maxDuration) const {
 }
 
 void Microphone::recoverData(std::vector<uint8_t>& data, float maxDuration) const {
+  ZoneScopedN("Microphone::recoverData");
+
   data.clear();
 
   if (maxDuration == 0.f)
@@ -189,6 +200,8 @@ void Microphone::recoverData(std::vector<uint8_t>& data, float maxDuration) cons
 }
 
 Sound Microphone::recoverSound(float maxDuration) const {
+  ZoneScopedN("Microphone::recoverSound");
+
   Sound sound;
 
   sound.m_format    = m_format;
@@ -200,6 +213,8 @@ Sound Microphone::recoverSound(float maxDuration) const {
 }
 
 void Microphone::destroy() {
+  ZoneScopedN("Microphone::destroy");
+
   if (m_device == nullptr)
     return;
 

src/RaZ/Audio/Sound.cpp

@@ -3,6 +3,8 @@
 #include "RaZ/Math/Vector.hpp"
 #include "RaZ/Utils/Logger.hpp"
 
+#include "tracy/Tracy.hpp"
+
 #include <AL/al.h>
 #if !defined(RAZ_PLATFORM_EMSCRIPTEN)
 #include <AL/efx.h>
@@ -34,6 +36,8 @@ inline void checkError(const std::string& errorMsg) {
 } // namespace
 
 void Sound::init() {
+  ZoneScopedN("Sound::init");
+
   Logger::debug("[Sound] Initializing...");
 
   alGetError(); // Flushing errors
@@ -54,6 +58,8 @@ void Sound::init() {
 }
 
 void Sound::load() {
+  ZoneScopedN("Sound::load");
+
   stop(); // Making sure the sound isn't paused or currently playing
   alSourcei(m_source, AL_BUFFER, 0); // Detaching the previous buffer (if any) from the source
 
@@ -197,6 +203,8 @@ float Sound::recoverElapsedTime() const noexcept {
 }
 
 void Sound::destroy() {
+  ZoneScopedN("Sound::destroy");
+
   if (!m_source.isValid() && !m_buffer.isValid())
     return;
 

src/RaZ/Audio/SoundEffect.cpp

@@ -2,6 +2,8 @@
 #include "RaZ/Utils/CompilerUtils.hpp"
 #include "RaZ/Utils/Logger.hpp"
 
+#include "tracy/Tracy.hpp"
+
 #include <AL/efx.h>
 #include <AL/efx-presets.h>
 
@@ -65,6 +67,8 @@ inline bool loadFunctions() noexcept {
 } // namespace
 
 void SoundEffect::init() {
+  ZoneScopedN("SoundEffect::init");
+
   if (!alcIsExtensionPresent(alcGetContextsDevice(alcGetCurrentContext()), "ALC_EXT_EFX")) {
     Logger::error("[SoundEffect] Sound effects are unavailable.");
     return;
@@ -200,6 +204,8 @@ void SoundEffect::reset() {
 }
 
 void SoundEffect::destroy() {
+  ZoneScopedN("SoundEffect::destroy");
+
   if (!m_index.isValid())
     return;
 

src/RaZ/Audio/SoundEffectSlot.cpp

@@ -3,6 +3,8 @@
 #include "RaZ/Utils/CompilerUtils.hpp"
 #include "RaZ/Utils/Logger.hpp"
 
+#include "tracy/Tracy.hpp"
+
 #include <AL/al.h>
 #if !defined(RAZ_PLATFORM_EMSCRIPTEN)
 #include <AL/efx.h>
@@ -68,6 +70,8 @@ inline bool loadFunctions() noexcept {
 } // namespace
 
 void SoundEffectSlot::init() {
+  ZoneScopedN("SoundEffectSlot::init");
+
   if (!alcIsExtensionPresent(alcGetContextsDevice(alcGetCurrentContext()), "ALC_EXT_EFX")) {
     Logger::error("[SoundEffectSlot] Sound effects are unavailable.");
     return;
@@ -88,11 +92,15 @@ void SoundEffectSlot::init() {
 }
 
 void SoundEffectSlot::loadEffect(const SoundEffect& effect) const noexcept {
+  ZoneScopedN("SoundEffectSlot::loadEffect");
+
   alAuxiliaryEffectSloti(m_index, AL_EFFECTSLOT_EFFECT, static_cast<int>(effect.getIndex()));
   checkError("Failed to load the sound effect");
 }
 
 void SoundEffectSlot::destroy() {
+  ZoneScopedN("SoundEffectSlot::destroy");
+
   if (!m_index.isValid())
     return;