-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(audio): replace OpenAL audio backend for Miniaudio backend (#1005)
Co-Authored-By: João Miguel Nogueira <[email protected]>
- Loading branch information
1 parent
7205c59
commit 3499340
Showing
11 changed files
with
615 additions
and
231 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| /// @file | ||
| /// @brief Class @ref cubos::core::al::AudioContext and related types. | ||
| /// @ingroup core-al | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <memory> | ||
| #include <string> | ||
| #include <vector> | ||
|
|
||
| #include <glm/glm.hpp> | ||
|
|
||
| #include <cubos/core/api.hpp> | ||
|
|
||
| namespace cubos::core::al | ||
| { | ||
| namespace impl | ||
| { | ||
| class Buffer; | ||
| class Source; | ||
| class Listener; | ||
| class AudioDevice; | ||
| } // namespace impl | ||
|
|
||
| /// @brief Handle to an audio buffer. | ||
| /// @see impl::Buffer - audio buffer interface. | ||
| /// @see AudioContext::createBuffer() | ||
| /// @ingroup core-al | ||
| using Buffer = std::shared_ptr<impl::Buffer>; | ||
|
|
||
| /// @brief Handle to an audio source. | ||
| /// @see impl::Source - audio source interface. | ||
| /// @see AudioDevice::createSource() | ||
| /// @ingroup core-al | ||
| using Source = std::shared_ptr<impl::Source>; | ||
|
|
||
| /// @brief Handle to an audio listener. | ||
| /// @see impl::Listener - audio listener interface. | ||
| /// @see AudioDevice::createListener() | ||
| /// @ingroup core-al | ||
| using Listener = std::shared_ptr<impl::Listener>; | ||
|
|
||
| /// @brief Handle to an audio device. | ||
| /// @see impl::AudioDevice - audio device interface. | ||
| /// @see AudioContext::createDevice() | ||
| /// @ingroup core-al | ||
| using AudioDevice = std::shared_ptr<impl::AudioDevice>; | ||
|
|
||
| /// @brief Audio context that contains audio devices; | ||
| class CUBOS_CORE_API AudioContext | ||
| { | ||
| public: | ||
| AudioContext() = default; | ||
| virtual ~AudioContext() = default; | ||
|
|
||
| /// @brief Creates an audio context. | ||
| /// @return AudioContext, or nullptr on failure. | ||
| static std::shared_ptr<AudioContext> create(); | ||
|
|
||
| /// @brief Enumerates the available devices. | ||
| /// @param[out] devices Vector to fill with the available devices. | ||
| virtual void enumerateDevices(std::vector<std::string>& devices) = 0; | ||
|
|
||
| /// @brief Creates a new audio device | ||
| /// @param specifier The specifier of the audio device, used to identify it | ||
| /// @param listenerCount The number of audio listener to be created by the device's engine. | ||
| /// @return Handle of the new device | ||
| virtual AudioDevice createDevice(unsigned int listenerCount, | ||
| const std::string& specifier = "MiniaudioDevice") = 0; | ||
|
|
||
| /// @brief Creates a new audio buffer. | ||
| /// @param data Data to be written to the buffer, either .wav, .mp3 or .flac. | ||
| /// @param datSize Size of the data to be written. | ||
| /// @return Handle of the new buffer. | ||
| virtual Buffer createBuffer(const void* data, size_t dataSize) = 0; | ||
| }; | ||
|
|
||
| /// @brief Namespace to store the abstract types implemented by the audio device implementations. | ||
| namespace impl | ||
| { | ||
| /// @brief Abstract audio buffer. | ||
| class CUBOS_CORE_API Buffer | ||
| { | ||
| public: | ||
| virtual ~Buffer() = default; | ||
|
|
||
| /// @brief Gets the length in seconds of the audio buffer. | ||
| /// @return Length in seconds of the audio buffer. | ||
| virtual size_t length() = 0; | ||
|
|
||
| protected: | ||
| Buffer() = default; | ||
| }; | ||
|
|
||
| /// @brief Abstract audio source. | ||
| class CUBOS_CORE_API Source | ||
| { | ||
| public: | ||
| virtual ~Source() = default; | ||
|
|
||
| /// @brief Sets the buffer to be played by the source. | ||
| /// @param buffer Buffer. | ||
| virtual void setBuffer(cubos::core::al::Buffer buffer) = 0; | ||
|
|
||
| /// @brief Sets the position of the source, by default, in the world space. | ||
| /// @see setRelative() to change this behavior. | ||
| /// @param position Position. | ||
| virtual void setPosition(const glm::vec3& position) = 0; | ||
|
|
||
| /// @brief Sets the velocity of the source, by default, in the world space. | ||
| /// @param velocity Velocity. | ||
| virtual void setVelocity(const glm::vec3& velocity) = 0; | ||
|
|
||
| /// @brief Sets the gain of the source. | ||
| /// @param gain Gain. | ||
| virtual void setGain(float gain) = 0; | ||
|
|
||
| /// @brief Sets the pitch of the source. | ||
| /// @param pitch Pitch. | ||
| virtual void setPitch(float pitch) = 0; | ||
|
|
||
| /// @brief Sets whether the source plays in a loop. | ||
| /// @param looping Looping flag. | ||
| virtual void setLooping(bool looping) = 0; | ||
|
|
||
| /// @brief Sets whether the source position and velocity is relative to the listener or | ||
| /// not. | ||
| /// @param relative Relative flag. | ||
| virtual void setRelative(bool relative) = 0; | ||
|
|
||
| /// @brief Sets the maximum distance at which the source is audible. | ||
| /// @param maxDistance Maximum distance. | ||
| virtual void setMaxDistance(float maxDistance) = 0; | ||
|
|
||
| /// @brief Sets the minimum distance at which the source starts to attenuate. | ||
| /// @param minDistance Minimum distance. | ||
| virtual void setMinDistance(float minDistance) = 0; | ||
|
|
||
| /// @brief Sets the cone angle, in degrees. While also setting the outerGain. | ||
| /// @param innerAngle Outer angle, in degrees. | ||
| /// @param outerAngle Inner angle, in degrees. | ||
| /// @param coneGain Gain. | ||
| virtual void setCone(float innerAngle, float outerAngle, float outerGain) = 0; | ||
|
|
||
| /// @brief Sets the cone direction of the source. | ||
| /// @param direction Direction. | ||
| virtual void setConeDirection(const glm::vec3& direction) = 0; | ||
|
|
||
| /// @brief Plays the source. | ||
| virtual void play() = 0; | ||
|
|
||
| protected: | ||
| Source() = default; | ||
| }; | ||
|
|
||
| // Abstract audio listener. | ||
| class CUBOS_CORE_API Listener | ||
| { | ||
| public: | ||
| virtual ~Listener() = default; | ||
|
|
||
| /// @brief Sets the velocity of the listener. Used to implement the doppler effect. | ||
| /// @param velocity Velocity of the listener. | ||
| virtual void setVelocity(const glm::vec3& velocity) = 0; | ||
|
|
||
| /// @brief Sets the position of the listener. | ||
| /// @param position Position. | ||
| virtual void setPosition(const glm::vec3& position) = 0; | ||
|
|
||
| /// @brief Sets the orientation of the listener. | ||
| /// @param forward Forward direction of the listener. | ||
| /// @param up Up direction of the listener. | ||
| virtual void setOrientation(const glm::vec3& forward, const glm::vec3& up) = 0; | ||
|
|
||
| protected: | ||
| Listener() = default; | ||
| }; | ||
|
|
||
| /// @brief Audio device interface used to wrap low-level audio rendering APIs. | ||
| class CUBOS_CORE_API AudioDevice | ||
| { | ||
| public: | ||
| virtual ~AudioDevice() = default; | ||
|
|
||
| /// @brief Forbid copy construction. | ||
| AudioDevice(const AudioDevice&) = delete; | ||
|
|
||
| /// @brief Creates a new audio source. | ||
| /// @return Handle of the new source. | ||
| virtual std::shared_ptr<impl::Source> createSource() = 0; | ||
|
|
||
| /// @brief Creates a new audio listener. | ||
| /// @return Handle of the new listener. | ||
| virtual std::shared_ptr<impl::Listener> listener(size_t index) = 0; | ||
|
|
||
| protected: | ||
| AudioDevice() = default; | ||
| }; | ||
| } // namespace impl | ||
| } // namespace cubos::core::al |
Oops, something went wrong.