sound Namespace Reference

Namespaces
namespace	sound_manager_messages_to_mgr
namespace	sound_manager_messages_to_proxy

Classes
struct	ALExtensions
	Struct for AL and ALC extensions. More...
struct	ISoundDataOpen
	Stores sound pcm data buffers. More...
struct	ISoundDataUnopen
	Will be opened lazily when first used. More...
struct	OggFileDecodeInfo
	Metadata of an Ogg-Vorbis file, used for decoding. More...
struct	OggVorbisBufferSource
	For vorbisfile to read from our buffer instead of from a file. More...
class	OpenALSoundManager
class	PlayingSound
	A sound that is currently played. More...
class	ProxySoundManager
struct	RAIIALSoundBuffer
	RAII wrapper for openal sound buffers. More...
struct	RAIIOggFile
	RAII wrapper for OggVorbis_File. More...
struct	SoundDataOpenBuffer
	Non-streaming opened sound data. More...
struct	SoundDataOpenStream
	Streaming opened sound data. More...
struct	SoundDataUnopenBuffer
	Sound file is in a memory buffer. More...
struct	SoundDataUnopenFile
	Sound file is in file system. More...
class	SoundManagerSingleton
	Class for the openal device and context. More...

Typedefs
using	SoundManagerMsgToMgr = std::variant< std::monostate, sound_manager_messages_to_mgr::PauseAll, sound_manager_messages_to_mgr::ResumeAll, sound_manager_messages_to_mgr::UpdateListener, sound_manager_messages_to_mgr::SetListenerGain, sound_manager_messages_to_mgr::LoadSoundFile, sound_manager_messages_to_mgr::LoadSoundData, sound_manager_messages_to_mgr::AddSoundToGroup, sound_manager_messages_to_mgr::PlaySound, sound_manager_messages_to_mgr::PlaySoundAt, sound_manager_messages_to_mgr::StopSound, sound_manager_messages_to_mgr::FadeSound, sound_manager_messages_to_mgr::UpdateSoundPosVel, sound_manager_messages_to_mgr::PleaseStop >
using	SoundManagerMsgToProxy = std::variant< std::monostate, sound_manager_messages_to_proxy::ReportRemovedSound, sound_manager_messages_to_proxy::Stopped >

Functions
const char *	getAlErrorString (ALenum err) noexcept
ALenum	warn_if_al_error (const char *desc)
v3f	swap_handedness (v3f v) noexcept
	Transforms vectors from a left-handed coordinate system to a right-handed one and vice-versa.

Variables
constexpr f32	REMOVE_DEAD_SOUNDS_INTERVAL = 2.0f
constexpr f32	SOUND_DURATION_MAX_SINGLE = 3.0f
constexpr f32	MIN_STREAM_BUFFER_LENGTH = 1.0f
constexpr f32	STREAM_BIGSTEP_TIME = 0.3f
constexpr f32	SOUNDTHREAD_DTIME = 0.016f

Typedef Documentation

SoundManagerMsgToMgr

using sound::SoundManagerMsgToMgr = typedef std::variant< std::monostate, sound_manager_messages_to_mgr::PauseAll, sound_manager_messages_to_mgr::ResumeAll, sound_manager_messages_to_mgr::UpdateListener, sound_manager_messages_to_mgr::SetListenerGain, sound_manager_messages_to_mgr::LoadSoundFile, sound_manager_messages_to_mgr::LoadSoundData, sound_manager_messages_to_mgr::AddSoundToGroup, sound_manager_messages_to_mgr::PlaySound, sound_manager_messages_to_mgr::PlaySoundAt, sound_manager_messages_to_mgr::StopSound, sound_manager_messages_to_mgr::FadeSound, sound_manager_messages_to_mgr::UpdateSoundPosVel, sound_manager_messages_to_mgr::PleaseStop >

SoundManagerMsgToProxy

using sound::SoundManagerMsgToProxy = typedef std::variant< std::monostate, sound_manager_messages_to_proxy::ReportRemovedSound, sound_manager_messages_to_proxy::Stopped >

Function Documentation

getAlErrorString()

const char * sound::getAlErrorString ( ALenum  err )

inlinenoexcept

Referenced by sound::RAIIOggFile::loadBuffer(), and warn_if_al_error().

Here is the caller graph for this function:

swap_handedness()

v3f sound::swap_handedness ( v3f  v )

inlinenoexcept

Transforms vectors from a left-handed coordinate system to a right-handed one and vice-versa.

(Needed because Minetest uses a left-handed one and OpenAL a right-handed one.)

Referenced by sound::OpenALSoundManager::playSoundAt(), sound::OpenALSoundManager::updateListener(), and sound::OpenALSoundManager::updateSoundPosVel().

Here is the caller graph for this function:

warn_if_al_error()

ALenum sound::warn_if_al_error ( const char *  desc )

inline

References getAlErrorString(), and warningstream.

Referenced by sound::PlayingSound::PlayingSound(), sound::OpenALSoundManager::createPlayingSound(), sound::RAIIALSoundBuffer::reset(), sound::OpenALSoundManager::updateListener(), and sound::PlayingSound::updatePosVel().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MIN_STREAM_BUFFER_LENGTH

constexpr f32 sound::MIN_STREAM_BUFFER_LENGTH = 1.0f

constexpr

Referenced by sound::SoundDataOpenStream::loadBufferAt(), and sound::PlayingSound::stepStream().

REMOVE_DEAD_SOUNDS_INTERVAL

constexpr f32 sound::REMOVE_DEAD_SOUNDS_INTERVAL = 2.0f

constexpr

Referenced by sound::OpenALSoundManager::step().

SOUND_DURATION_MAX_SINGLE

constexpr f32 sound::SOUND_DURATION_MAX_SINGLE = 3.0f

constexpr

Referenced by sound::ISoundDataOpen::fromOggFile().

SOUNDTHREAD_DTIME

constexpr f32 sound::SOUNDTHREAD_DTIME = 0.016f

constexpr

Referenced by sound::OpenALSoundManager::run().

STREAM_BIGSTEP_TIME

constexpr f32 sound::STREAM_BIGSTEP_TIME = 0.3f

constexpr

Referenced by sound::PlayingSound::stepStream(), and sound::OpenALSoundManager::stepStreams().