1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
|
#include "ALAudioDevice.h"
#include "AudioBufferPlayer.h"
#include "AudioStreamPlayer.h"
#include "../ServiceLocator.h"
#include <Containers/StringUtils.h>
#if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT)
# include <Environment.h>
# include <Utf8.h>
#endif
using namespace Death;
using namespace Death::Containers::Literals;
namespace nCine
{
ALAudioDevice::ALAudioDevice()
: device_(nullptr), context_(nullptr), gain_(1.0f), sources_ {}, deviceName_(nullptr), nativeFreq_(44100)
#if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT)
, alcReopenDeviceSOFT_(nullptr), pEnumerator_(nullptr), lastDeviceChangeTime_(0), shouldRecreate_(false)
#endif
{
Init();
}
void ALAudioDevice::Init()
{
LOGD("Initializing OpenAL audio device...");
device_ = alcOpenDevice(nullptr);
DEATH_ASSERT(device_ != nullptr, ("alcOpenDevice() failed with error 0x{:x}", alGetError()), );
deviceName_ = alcGetString(device_, ALC_DEVICE_SPECIFIER);
context_ = alcCreateContext(device_, nullptr);
if (context_ == nullptr) {
alcCloseDevice(device_);
LOGE("alcCreateContext() failed with error 0x{:x}", alGetError());
return;
}
#if !defined(DEATH_TARGET_EMSCRIPTEN)
// Try to get native sample rate of default audio device (default is 44100)
ALCint nativeFreq = 0;
alcGetIntegerv(device_, ALC_FREQUENCY, 1, &nativeFreq);
if (nativeFreq >= 44100 && nativeFreq <= 192000) {
nativeFreq_ = nativeFreq;
}
#endif
if (!alcMakeContextCurrent(context_)) {
alcDestroyContext(context_);
alcCloseDevice(device_);
LOGE("alcMakeContextCurrent() failed with error 0x{:x}", alGetError());
return;
}
alGetError();
alGenSources(MaxSources, sources_);
const ALenum error = alGetError();
if (error != AL_NO_ERROR) {
LOGE("alGenSources() failed with error 0x{:x}", error);
} else {
for (std::int32_t i = MaxSources - 1; i >= 0; i--) {
sourcePool_.push_back(sources_[i]);
}
}
alDistanceModel(AL_LINEAR_DISTANCE_CLAMPED);
alDopplerFactor(1.0f);
alSpeedOfSound(360.0f);
alListener3f(AL_POSITION, 0.0f, 0.0f, 0.0f);
alListenerf(AL_GAIN, gain_);
#if defined(AL_STOP_SOURCES_ON_DISCONNECT_SOFT) && !defined(DEATH_TARGET_EMSCRIPTEN)
// Don't stop sources when device is disconnected if supported
alDisable(AL_STOP_SOURCES_ON_DISCONNECT_SOFT);
#endif
#if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT)
// Try to use ALC_SOFT_reopen_device extension to reopen the device
alcReopenDeviceSOFT_ = (LPALCREOPENDEVICESOFT)alGetProcAddress("alcReopenDeviceSOFT");
registerAudioEvents();
#endif
#if defined(DEATH_TRACE)
// Log OpenAL device info
LOGI("--- OpenAL device info ---");
StringView deviceName = alcGetString(device_, ALC_DEVICE_SPECIFIER);
StringView renderer = alGetString(AL_RENDERER);
StringView version = alGetString(AL_VERSION);
LOGI(deviceName != renderer ? "Device Name: {} ({})" : "Device Name: {}", deviceName, renderer);
LOGI("OpenAL Version: {}", version);
ALCint attributesSize = 0;
alcGetIntegerv(device_, ALC_ATTRIBUTES_SIZE, 1, &attributesSize);
if (attributesSize > 0) {
constexpr std::int32_t MaxAttributes = 16;
ALCint attributes[MaxAttributes * 2];
const ALCint numAttributes = (attributesSize < MaxAttributes * 2) ? attributesSize : MaxAttributes * 2;
alcGetIntegerv(device_, ALC_ALL_ATTRIBUTES, numAttributes, attributes);
ALCint monoSources = 0, stereoSources = 0, efxVersionMajor = 0, efxVersionMinor = 0, efxAuxSends = 0;
for (std::int32_t i = 0; i + 1 < numAttributes; i += 2) {
switch (attributes[i]) {
case ALC_MONO_SOURCES: monoSources = attributes[i + 1]; break;
case ALC_STEREO_SOURCES: stereoSources = attributes[i + 1]; break;
#if defined(ALC_EFX_MAJOR_VERSION)
case ALC_EFX_MAJOR_VERSION: efxVersionMajor = attributes[i + 1]; break;
#endif
#if defined(ALC_EFX_MINOR_VERSION)
case ALC_EFX_MINOR_VERSION: efxVersionMinor = attributes[i + 1]; break;
#endif
#if defined(ALC_MAX_AUXILIARY_SENDS)
case ALC_MAX_AUXILIARY_SENDS: efxAuxSends = attributes[i + 1]; break;
#endif
}
}
# if defined(ALC_EXT_EFX_NAME)
bool hasExtEfx = alcIsExtensionPresent(device_, ALC_EXT_EFX_NAME);
# else
bool hasExtEfx = alcIsExtensionPresent(device_, "ALC_EXT_EFX");
# endif
if (hasExtEfx) {
LOGI("ALC_EXT_EFX Version: {}.{} ({} auxiliary sends)", efxVersionMajor, efxVersionMinor, efxAuxSends);
} else {
LOGI("ALC_EXT_EFX Version: unsupported", hasExtEfx);
}
# if defined(AL_DEFAULT_RESAMPLER_SOFT)
bool defaultResamplerOverriden = false;
if (alIsExtensionPresent("AL_SOFT_source_resampler")) {
ALCint defaultResampler = alGetInteger(AL_DEFAULT_RESAMPLER_SOFT);
String resamplerName = alGetStringiSOFT(AL_RESAMPLER_NAME_SOFT, defaultResampler);
if (!resamplerName.empty()) {
LOGI("Resampler: {} ({})", resamplerName, defaultResampler);
StringUtils::lowercaseInPlace(resamplerName);
// "Linear" is default in v1.22.2, "Cubic" is default in v1.23.1 and "Cubic Spline" in v1.24.2
if (resamplerName != "linear"_s && !resamplerName.hasPrefix("cubic"_s)) {
defaultResamplerOverriden = true;
}
}
}
# endif
LOGI("Sources: {} (M) / {} (S)", monoSources, stereoSources);
for (std::int32_t i = 0; i + 1 < numAttributes; i += 2) {
switch (attributes[i]) {
case ALC_FREQUENCY:
LOGI("Output Frequency: {} Hz", attributes[i + 1]);
break;
case ALC_REFRESH:
LOGI("Refresh Rate: {} Hz", attributes[i + 1]);
break;
case ALC_SYNC:
LOGI("Asynchronous: {}", attributes[i + 1] == ALC_FALSE);
break;
# if defined(ALC_SOFT_HRTF)
case ALC_HRTF_STATUS_SOFT:
const char* statusStr;
switch (attributes[i + 1]) {
case ALC_HRTF_DISABLED_SOFT: statusStr = "disabled"; break;
case ALC_HRTF_ENABLED_SOFT: statusStr = "enabled"; break;
case ALC_HRTF_DENIED_SOFT: statusStr = "disabled (denied)"; break;
case ALC_HRTF_HEADPHONES_DETECTED_SOFT: // Not used by OpenAL Soft anymore
case ALC_HRTF_REQUIRED_SOFT: statusStr = "enabled (enforced)"; break;
default: statusStr = "unsupported"; break;
}
LOGI("HRTF: {}", statusStr);
break;
# endif
}
}
# if defined(AL_DEFAULT_RESAMPLER_SOFT)
if (defaultResamplerOverriden) {
LOGW("The default resampler has been overridden on your system, which may result in degraded sound quality");
}
# endif
}
#endif
}
ALAudioDevice::~ALAudioDevice()
{
LOGD("Disposing OpenAL audio device...");
#if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT)
unregisterAudioEvents();
#endif
for (ALuint sourceId : sources_) {
alSourcei(sourceId, AL_BUFFER, AL_NONE);
}
alDeleteSources(MaxSources, sources_);
alcDestroyContext(context_);
if (!alcCloseDevice(device_)) {
LOGW("alcCloseDevice() failed with error 0x{:x}", alGetError());
}
}
bool ALAudioDevice::isValid() const
{
return (device_ != nullptr);
}
const char* ALAudioDevice::name() const
{
return deviceName_;
}
void ALAudioDevice::setGain(ALfloat gain)
{
gain_ = gain;
alListenerf(AL_GAIN, gain_);
}
const IAudioPlayer* ALAudioDevice::player(std::uint32_t index) const
{
if (index < players_.size()) {
return players_[index];
}
return nullptr;
}
void ALAudioDevice::stopPlayers()
{
for (auto& player : players_) {
player->stop();
}
players_.clear();
}
void ALAudioDevice::pausePlayers()
{
for (auto& player : players_) {
player->pause();
}
players_.clear();
}
void ALAudioDevice::stopPlayers(PlayerType playerType)
{
const Object::ObjectType objectType = (playerType == PlayerType::Buffer)
? AudioBufferPlayer::sType()
: AudioStreamPlayer::sType();
auto it = players_.begin();
while (it != players_.end()) {
if ((*it)->type() == objectType) {
(*it)->stop();
it = players_.eraseUnordered(it);
continue;
}
++it;
}
}
void ALAudioDevice::pausePlayers(PlayerType playerType)
{
const Object::ObjectType objectType = (playerType == PlayerType::Buffer)
? AudioBufferPlayer::sType()
: AudioStreamPlayer::sType();
auto it = players_.begin();
while (it != players_.end()) {
if ((*it)->type() == objectType) {
(*it)->pause();
it = players_.eraseUnordered(it);
continue;
}
++it;
}
}
void ALAudioDevice::freezePlayers()
{
for (auto& player : players_) {
player->pause();
}
// The players array is not cleared at this point, it is needed as-is by the unfreeze method
}
void ALAudioDevice::unfreezePlayers()
{
for (auto& player : players_) {
player->play();
}
}
unsigned int ALAudioDevice::registerPlayer(IAudioPlayer* player)
{
if (sourcePool_.empty()) {
return UnavailableSource;
}
ALuint sourceId = sourcePool_.pop_back_val();
if (players_.size() < MaxSources) {
players_.push_back(player);
}
return sourceId;
}
void ALAudioDevice::unregisterPlayer(IAudioPlayer* player)
{
if (player->sourceId_ == UnavailableSource) {
return;
}
sourcePool_.push_back(player->sourceId_);
player->sourceId_ = UnavailableSource;
auto it = players_.begin();
while (it != players_.end()) {
if (*it == player) {
players_.erase(it);
break;
}
++it;
}
}
void ALAudioDevice::updatePlayers()
{
#if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT)
// Audio device cannot be recreated in event callback, so do it here
if (shouldRecreate_) {
shouldRecreate_ = false;
recreateAudioDevice();
}
#endif
for (auto& player : players_) {
player->updateState();
}
}
const Vector3f& ALAudioDevice::getListenerPosition() const
{
return _listenerPos;
}
void ALAudioDevice::updateListener(const Vector3f& position, const Vector3f& velocity)
{
_listenerPos = position;
alListener3f(AL_POSITION, position.X * LengthToPhysical, position.Y * -LengthToPhysical, position.Z * -LengthToPhysical);
alListener3f(AL_VELOCITY, velocity.X * VelocityToPhysical, velocity.Y * -VelocityToPhysical, velocity.Z * -VelocityToPhysical);
}
std::int32_t ALAudioDevice::nativeFrequency()
{
return nativeFreq_;
}
void ALAudioDevice::suspendDevice()
{
#if defined(ALC_SOFT_pause_device)
if (device_ != nullptr) {
alcDevicePauseSOFT(device_);
}
#endif
}
void ALAudioDevice::resumeDevice()
{
#if defined(ALC_SOFT_pause_device)
if (device_ != nullptr) {
alcDeviceResumeSOFT(device_);
}
#endif
}
#if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT)
void ALAudioDevice::recreateAudioDevice()
{
// Try to use ALC_SOFT_reopen_device extension to reopen the device
// TODO: If the extension is not present, the device should be fully recreated
LOGI("Audio device must be recreated due to system changes");
if (alcReopenDeviceSOFT_ != nullptr) {
if (!alcReopenDeviceSOFT_(device_, nullptr, nullptr)) {
LOGE("Cannot recreate audio device - alcReopenDeviceSOFT() failed!");
}
// Try to get native sample rate of new audio device
ALCint nativeFreq = 0;
alcGetIntegerv(device_, ALC_FREQUENCY, 1, &nativeFreq);
if (nativeFreq >= 44100 && nativeFreq <= 192000) {
nativeFreq_ = nativeFreq;
}
# if defined(DEATH_DEBUG) && defined(DEATH_TRACE) && defined(ALC_SOFT_HRTF)
ALCint status;
alcGetIntegerv(device_, ALC_HRTF_STATUS_SOFT, 1, &status);
const char* statusStr;
switch (status) {
case ALC_HRTF_DISABLED_SOFT: statusStr = "disabled"; break;
case ALC_HRTF_ENABLED_SOFT: statusStr = "enabled"; break;
case ALC_HRTF_DENIED_SOFT: statusStr = "disabled (denied)"; break;
case ALC_HRTF_HEADPHONES_DETECTED_SOFT: // Not used by OpenAL Soft anymore
case ALC_HRTF_REQUIRED_SOFT: statusStr = "enabled (enforced)"; break;
default: statusStr = "unknown"; break;
}
LOGD("HRTF: {}", statusStr);
# endif
} else {
LOGE("Cannot recreate audio device - missing extension");
}
}
void ALAudioDevice::registerAudioEvents()
{
HRESULT hr = ::CoCreateInstance(__uuidof(MMDeviceEnumerator), nullptr, CLSCTX_ALL, IID_PPV_ARGS(&pEnumerator_));
if (hr == CO_E_NOTINITIALIZED) {
LOGW("CoCreateInstance() failed with error CO_E_NOTINITIALIZED");
hr = ::CoInitializeEx(nullptr, COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE);
if (FAILED(hr)) {
hr = ::CoCreateInstance(__uuidof(MMDeviceEnumerator), nullptr, CLSCTX_ALL, IID_PPV_ARGS(&pEnumerator_));
if (FAILED(hr)) {
LOGE("CoCreateInstance() failed with error 0x{:.8x}", hr);
}
}
} else if (FAILED(hr)) {
LOGE("CoCreateInstance() failed with error 0x{:.8x}", hr);
}
if (pEnumerator_ != nullptr) {
HRESULT hr = pEnumerator_->RegisterEndpointNotificationCallback(this);
if (FAILED(hr)) {
LOGE("RegisterEndpointNotificationCallback() failed with error 0x{:.8x}", hr);
}
}
}
void ALAudioDevice::unregisterAudioEvents()
{
if (pEnumerator_ == nullptr) {
return;
}
pEnumerator_->UnregisterEndpointNotificationCallback(this);
pEnumerator_->Release();
pEnumerator_ = nullptr;
}
ULONG ALAudioDevice::AddRef()
{
return 1;
}
ULONG ALAudioDevice::Release()
{
return 1;
}
HRESULT ALAudioDevice::QueryInterface(REFIID iid, void** object)
{
if (iid == IID_IUnknown || iid == __uuidof(IMMNotificationClient)) {
*object = static_cast<IMMNotificationClient*>(this);
return S_OK;
}
*object = nullptr;
return E_NOINTERFACE;
}
HRESULT ALAudioDevice::OnPropertyValueChanged(LPCWSTR pwstrDeviceId, const PROPERTYKEY key)
{
return S_OK;
}
HRESULT ALAudioDevice::OnDeviceAdded(LPCWSTR pwstrDeviceId)
{
return S_OK;
}
HRESULT ALAudioDevice::OnDeviceRemoved(LPCWSTR pwstrDeviceId)
{
return S_OK;
}
HRESULT ALAudioDevice::OnDeviceStateChanged(LPCWSTR pwstrDeviceId, DWORD dwNewState)
{
// OnDefaultDeviceChanged() is called afterwards, so no need to handle it here
//shouldRecreate_ = true;
return S_OK;
}
HRESULT ALAudioDevice::OnDefaultDeviceChanged(EDataFlow flow, ERole role, LPCWSTR pwstrDefaultDeviceId)
{
// Only listen for console device changes
if (flow != eRender || role != eConsole) {
return S_OK;
}
// If no device is now available, pwstrDefaultDeviceId will be nullptr
if (pwstrDefaultDeviceId == nullptr) {
return S_OK;
}
std::uint64_t now = Environment::QueryUnbiasedInterruptTimeAsMs();
String newDeviceId = Utf8::FromUtf16(pwstrDefaultDeviceId);
if (now - lastDeviceChangeTime_ > DeviceChangeLimitMs || newDeviceId != lastDeviceId_) {
lastDeviceChangeTime_ = now;
lastDeviceId_ = std::move(newDeviceId);
shouldRecreate_ = true;
}
return S_OK;
}
#endif
}
|