12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201 |
- /*
- * All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
- * its licensors.
- *
- * For complete copyright and license terms please see the LICENSE at the root of this
- * distribution (the "License"). All use of this software is governed by the License,
- * or, if provided, by the license below or the license accompanying this file. Do not
- * remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- */
- // Original file Copyright Crytek GMBH or its affiliates, used under license.
- #include <AzCore/PlatformIncl.h>
- #include <AudioSystemImpl_wwise.h>
- #include <platform.h>
- #include <AzCore/AzCore_Traits_Platform.h>
- #include <AzCore/std/containers/set.h>
- #include <AzCore/std/string/conversions.h>
- #include <AzCore/StringFunc/StringFunc.h>
- #include <IAudioSystem.h>
- #include <AudioAllocators.h>
- #include <AudioLogger.h>
- #include <AudioSourceManager.h>
- #include <AudioSystemImplCVars.h>
- #include <Common_wwise.h>
- #include <Config_wwise.h>
- #include <FileIOHandler_wwise.h>
- #include <AK/SoundEngine/Common/AkMemoryMgr.h> // Memory Manager
- #include <AK/SoundEngine/Common/AkModule.h> // Memory and Stream Manager interfaces
- #include <AK/SoundEngine/Common/AkSoundEngine.h> // Sound Engine
- #include <AK/SpatialAudio/Common/AkSpatialAudio.h> // Spatial Audio
- #include <AK/MusicEngine/Common/AkMusicEngine.h> // Music Engine
- #include <PluginRegistration_wwise.h> // Registration of default set of plugins, customize this header to your needs.
- #include <inttypes.h>
- #if !defined(WWISE_RELEASE)
- #include <AK/Comm/AkCommunication.h> // Communication between Wwise and the game (excluded in release build)
- #include <AK/Tools/Common/AkMonitorError.h>
- #include <AkPlatformFuncs_Platform.h>
- #endif // WWISE_RELEASE
- #if defined(AK_MAX_AUX_PER_OBJ)
- #define LY_MAX_AUX_PER_OBJ AK_MAX_AUX_PER_OBJ
- #else
- #define LY_MAX_AUX_PER_OBJ (4)
- #endif
- namespace Audio
- {
- namespace Platform
- {
- void InitializeMemory(CAudioLogger& audioLogger);
- void SetupAkSoundEngine(AkPlatformInitSettings& platformInitSettings);
- }
- /////////////////////////////////////////////////////////////////////////////////
- // AK MEMORY HOOKS SETUP
- namespace Wwise::MemHooks
- {
- void* Malloc(AkMemPoolId memId, size_t size)
- {
- size_t memCategory = memId & AkMemID_MASK;
- AZ_Assert(memCategory < AkMemID_NUM, "Wwise::MemHooks::Malloc - Bad AkMemPoolId passed: %zu", memCategory);
- return AZ::AllocatorInstance<AudioImplAllocator>::Get().Allocate(size, 0, 0,
- (memCategory < AkMemID_NUM) ? MemoryManagerCategories[memCategory] : nullptr);
- }
- void* Malign(AkMemPoolId memId, size_t size, AkUInt32 alignment)
- {
- size_t memCategory = memId & AkMemID_MASK;
- AZ_Assert(memCategory < AkMemID_NUM, "WWise::MemHooks::Malign - Bad AkMemPoolId passed: %zu", memCategory);
- return AZ::AllocatorInstance<AudioImplAllocator>::Get().Allocate(size, alignment, 0,
- (memCategory < AkMemID_NUM) ? MemoryManagerCategories[memCategory] : nullptr);
- }
- void* Realloc([[maybe_unused]] AkMemPoolId memId, void* address, size_t size)
- {
- return AZ::AllocatorInstance<AudioImplAllocator>::Get().ReAllocate(address, size, 0);
- }
- void* ReallocAligned([[maybe_unused]] AkMemPoolId memId, void* address, size_t size, AkUInt32 alignment)
- {
- return AZ::AllocatorInstance<AudioImplAllocator>::Get().ReAllocate(address, size, alignment);
- }
- void Free([[maybe_unused]] AkMemPoolId memId, void* address)
- {
- AZ::AllocatorInstance<AudioImplAllocator>::Get().DeAllocate(address);
- }
- size_t TotalReservedMemorySize()
- {
- return AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().Capacity();
- }
- size_t SizeOfMemory([[maybe_unused]] AkMemPoolId memId, void* address)
- {
- return AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().AllocationSize(address);
- }
- } // namespace Wwise::MemHooks
- extern CAudioLogger g_audioImplLogger_wwise;
- const char* const CAudioSystemImpl_wwise::WwiseImplSubPath = "wwise/";
- const char* const CAudioSystemImpl_wwise::WwiseGlobalAudioObjectName = "LY-GlobalAudioObject";
- const float CAudioSystemImpl_wwise::ObstructionOcclusionMin = 0.0f;
- const float CAudioSystemImpl_wwise::ObstructionOcclusionMax = 1.0f;
- static bool audioDeviceInitializationEvent = false;
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- // AK callbacks
- void WwiseEventCallback(AkCallbackType callbackType, AkCallbackInfo* callbackInfo)
- {
- if (callbackType == AK_EndOfEvent)
- {
- auto const eventData = static_cast<SATLEventData_wwise*>(callbackInfo->pCookie);
- if (eventData)
- {
- SAudioRequest request;
- SAudioCallbackManagerRequestData<eACMRT_REPORT_FINISHED_EVENT> requestData(eventData->nATLID, true);
- request.nFlags = eARF_THREAD_SAFE_PUSH;
- request.pData = &requestData;
- AudioSystemThreadSafeRequestBus::Broadcast(&AudioSystemThreadSafeRequestBus::Events::PushRequestThreadSafe, request);
- if (eventData->nSourceId != INVALID_AUDIO_SOURCE_ID)
- {
- AkPlayingID playingId = AudioSourceManager::Get().FindPlayingSource(eventData->nSourceId);
- AudioSourceManager::Get().DeactivateSource(playingId);
- }
- }
- }
- else if (callbackType == AK_Duration)
- {
- auto durationInfo = static_cast<AkDurationCallbackInfo*>(callbackInfo);
- auto const eventData = static_cast<SATLEventData_wwise*>(callbackInfo->pCookie);
- if (durationInfo && eventData)
- {
- AudioTriggerNotificationBus::QueueEvent(eventData->m_triggerId, &AudioTriggerNotificationBus::Events::ReportDurationInfo,
- eventData->nATLID, durationInfo->fDuration, durationInfo->fEstimatedDuration);
- }
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void AudioDeviceCallback(
- [[maybe_unused]] AK::IAkGlobalPluginContext* context,
- [[maybe_unused]] AkUniqueID audioDeviceSharesetId,
- [[maybe_unused]] AkUInt32 deviceId,
- AK::AkAudioDeviceEvent deviceEvent,
- [[maybe_unused]] AKRESULT inAkResult
- )
- {
- if (deviceEvent == AK::AkAudioDeviceEvent_Initialization)
- {
- audioDeviceInitializationEvent = true;
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void PrepareEventCallback(
- AkUniqueID akEventId,
- [[maybe_unused]] const void* bankPtr,
- AKRESULT loadResult,
- [[maybe_unused]] AkMemPoolId memPoolId,
- void* cookie)
- {
- auto const eventData = static_cast<SATLEventData_wwise*>(cookie);
- if (eventData)
- {
- eventData->nAKID = akEventId;
- SAudioRequest request;
- SAudioCallbackManagerRequestData<eACMRT_REPORT_FINISHED_EVENT> requestData(eventData->nATLID, loadResult == AK_Success);
- request.nFlags = eARF_THREAD_SAFE_PUSH;
- request.pData = &requestData;
- AudioSystemThreadSafeRequestBus::Broadcast(&AudioSystemThreadSafeRequestBus::Events::PushRequestThreadSafe, request);
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- #if !defined(WWISE_RELEASE)
- static void ErrorMonitorCallback(
- AK::Monitor::ErrorCode in_eErrorCode, ///< Error code number value
- const AkOSChar* in_pszError, ///< Message or error string to be displayed
- AK::Monitor::ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
- AkPlayingID in_playingID, ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
- AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
- )
- {
- char* errorStr = nullptr;
- CONVERT_OSCHAR_TO_CHAR(in_pszError, errorStr);
- g_audioImplLogger_wwise.Log(
- ((in_eErrorLevel & AK::Monitor::ErrorLevel_Error) != 0) ? eALT_ERROR : eALT_COMMENT,
- "<Wwise> %s ErrorCode: %d PlayingID: %u GameObjID: %llu", errorStr, in_eErrorCode, in_playingID, in_gameObjID);
- }
- #endif // WWISE_RELEASE
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- static int GetAssetType(const SATLSourceData* sourceData)
- {
- if (!sourceData)
- {
- return eAAT_NONE;
- }
- return sourceData->m_sourceInfo.m_codecType == eACT_STREAM_PCM
- ? eAAT_STREAM
- : eAAT_SOURCE;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- static int GetAkCodecID(EAudioCodecType codecType)
- {
- switch (codecType)
- {
- case eACT_AAC:
- return AKCODECID_AAC;
- case eACT_ADPCM:
- return AKCODECID_ADPCM;
- case eACT_PCM:
- return AKCODECID_PCM;
- case eACT_VORBIS:
- return AKCODECID_VORBIS;
- case eACT_XMA:
- return AKCODECID_XMA;
- case eACT_XWMA:
- return AKCODECID_XWMA;
- case eACT_STREAM_PCM:
- default:
- AZ_Assert(codecType, "Codec not supported");
- return AKCODECID_VORBIS;
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- CAudioSystemImpl_wwise::CAudioSystemImpl_wwise(const char* assetsPlatformName)
- : m_globalGameObjectID(static_cast<AkGameObjectID>(GLOBAL_AUDIO_OBJECT_ID))
- , m_defaultListenerGameObjectID(AK_INVALID_GAME_OBJECT)
- , m_initBankID(AK_INVALID_BANK_ID)
- #if !defined(WWISE_RELEASE)
- , m_isCommSystemInitialized(false)
- #endif // !WWISE_RELEASE
- {
- if (assetsPlatformName && assetsPlatformName[0] != '\0')
- {
- m_assetsPlatform = assetsPlatformName;
- }
- Platform::InitializeMemory(g_audioImplLogger_wwise);
- SetBankPaths();
- #if !defined(WWISE_RELEASE)
- m_fullImplString = AZStd::string::format("%s (%s)", WWISE_IMPL_VERSION_STRING, m_soundbankFolder.c_str());
- // Set up memory categories for debug tracking, do this early before initializing Wwise so they are available
- // before the any allocations through hooks occur.
- g_audioImplLogger_wwise.Log(eALT_COMMENT, "Memory Categories:\n");
- m_debugMemoryInfo.reserve(AkMemID_NUM + 1);
- for (AZ::u32 memId = 0; memId < AkMemID_NUM; ++memId)
- {
- AudioImplMemoryPoolInfo memInfo;
- azstrcpy(memInfo.m_poolName, sizeof(memInfo.m_poolName), Wwise::MemoryManagerCategories[memId]);
- memInfo.m_poolId = memId;
- m_debugMemoryInfo.push_back(memInfo);
- g_audioImplLogger_wwise.Log(eALT_COMMENT, "Memory category ID: %u - '%s'\n", memId, Wwise::MemoryManagerCategories[memId]);
- }
- // Add one more category for global stats.
- AudioImplMemoryPoolInfo memInfo;
- azstrcpy(memInfo.m_poolName, sizeof(memInfo.m_poolName), "Global");
- m_debugMemoryInfo.push_back(memInfo);
- #endif // !WWISE_RELEASE
- AudioSystemImplementationRequestBus::Handler::BusConnect();
- AudioSystemImplementationNotificationBus::Handler::BusConnect();
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- CAudioSystemImpl_wwise::~CAudioSystemImpl_wwise()
- {
- AudioSystemImplementationRequestBus::Handler::BusDisconnect();
- AudioSystemImplementationNotificationBus::Handler::BusDisconnect();
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- // AudioSystemImplementationNotificationBus
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::OnAudioSystemLoseFocus()
- {
- #if AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
- AKRESULT akResult = AK::SoundEngine::Suspend();
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to Suspend, AKRESULT = %d\n", akResult);
- }
- #endif // AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::OnAudioSystemGetFocus()
- {
- #if AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
- AKRESULT akResult = AK::SoundEngine::WakeupFromSuspend();
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to WakeupFromSuspend, AKRESULT = %d\n", akResult);
- }
- #endif // AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::OnAudioSystemMuteAll()
- {
- // With Wwise we drive this via events.
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::OnAudioSystemUnmuteAll()
- {
- // With Wwise we drive this via events.
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::OnAudioSystemRefresh()
- {
- AKRESULT akResult = AK_Fail;
- if (m_initBankID != AK_INVALID_BANK_ID)
- {
- akResult = AK::SoundEngine::UnloadBank(m_initBankID, nullptr);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to unload %s, returned the AKRESULT: %d", Wwise::InitBank, akResult);
- AZ_Assert(false, "<Wwise> Failed to unload %s!", Wwise::InitBank);
- }
- }
- AkOSChar* initBankName = nullptr;
- CONVERT_CHAR_TO_OSCHAR(Wwise::InitBank, initBankName);
- akResult = AK::SoundEngine::LoadBank(initBankName, m_initBankID);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to load %s, returned the AKRESULT: %d", Wwise::InitBank, akResult);
- m_initBankID = AK_INVALID_BANK_ID;
- AZ_Assert(false, "<Wwise> Failed to load %s!", Wwise::InitBank);
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- // AudioSystemImplementationRequestBus
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::Update([[maybe_unused]] const float updateIntervalMS)
- {
- AZ_PROFILE_FUNCTION(AZ::Debug::ProfileCategory::Audio);
- if (AK::SoundEngine::IsInitialized())
- {
- #if !defined(WWISE_RELEASE)
- AKRESULT akResult = AK_Fail;
- static bool enableOutputCapture = false;
- if (Wwise::Cvars::s_EnableOutputCapture && !enableOutputCapture)
- {
- // This file ends up in the cache folder
- // Need to disable this on LTX, it produces garbage output. But there's no way to "IsLTX()" yet.
- akResult = AK::SoundEngine::StartOutputCapture(AKTEXT("../wwise_audio_capture.wav"));
- AZ_Assert(IS_WWISE_OK(akResult), "AK::SoundEngine::StartOutputCapture failed!");
- enableOutputCapture = Wwise::Cvars::s_EnableOutputCapture;
- }
- else if (!Wwise::Cvars::s_EnableOutputCapture && enableOutputCapture)
- {
- akResult = AK::SoundEngine::StopOutputCapture();
- AZ_Assert(IS_WWISE_OK(akResult), "AK::SoundEngine::StopOutputCapture failed!");
- enableOutputCapture = Wwise::Cvars::s_EnableOutputCapture;
- }
- if (audioDeviceInitializationEvent)
- {
- AkChannelConfig channelConfig = AK::SoundEngine::GetSpeakerConfiguration();
- int surroundSpeakers = channelConfig.uNumChannels;
- int lfeSpeakers = 0;
- if (AK::HasLFE(channelConfig.uChannelMask))
- {
- --surroundSpeakers;
- ++lfeSpeakers;
- }
- m_speakerConfigString = AZStd::string::format("Output: %d.%d", surroundSpeakers, lfeSpeakers);
- m_fullImplString = AZStd::string::format("%s (%s) %s", WWISE_IMPL_VERSION_STRING, m_soundbankFolder.c_str(), m_speakerConfigString.c_str());
- audioDeviceInitializationEvent = false;
- }
- #endif // !WWISE_RELEASE
- AK::SoundEngine::RenderAudio();
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::Initialize()
- {
- // If something fails so severely during initialization that we need to fall back to a 'Null' implementation
- // we will need to shut down what has been initialized so far. Therefore make sure to call Shutdown() before returning eARS_FAILURE!
- AkMemSettings akMemSettings;
- AK::MemoryMgr::GetDefaultSettings(akMemSettings);
- akMemSettings.pfMalloc = Wwise::MemHooks::Malloc;
- akMemSettings.pfMalign = Wwise::MemHooks::Malign;
- akMemSettings.pfRealloc = Wwise::MemHooks::Realloc;
- akMemSettings.pfReallocAligned = Wwise::MemHooks::ReallocAligned;
- akMemSettings.pfFree = Wwise::MemHooks::Free;
- akMemSettings.pfTotalReservedMemorySize = Wwise::MemHooks::TotalReservedMemorySize;
- akMemSettings.pfSizeOfMemory = Wwise::MemHooks::SizeOfMemory;
- akMemSettings.uMemAllocationSizeLimit = Wwise::Cvars::s_PrimaryMemorySize << 10;
- AKRESULT akResult = AK::MemoryMgr::Init(&akMemSettings);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::MemoryMgr::Init() returned AKRESULT %d", akResult);
- ShutDown();
- return eARS_FAILURE;
- }
- akResult = AK::SoundEngine::RegisterAudioDeviceStatusCallback(AudioDeviceCallback);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::RegisterAudioDeviceStatusCallback failed!\n");
- }
- AkStreamMgrSettings akStreamSettings;
- AK::StreamMgr::GetDefaultSettings(akStreamSettings);
- if (AK::StreamMgr::Create(akStreamSettings) == nullptr)
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::StreamMgr::Create() failed!\n");
- ShutDown();
- return eARS_FAILURE;
- }
- akResult = m_fileIOHandler.Init(Wwise::Cvars::s_StreamDeviceMemorySize << 10);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "m_fileIOHandler.Init() returned AKRESULT %d", akResult);
- ShutDown();
- return eARS_FAILURE;
- }
- m_fileIOHandler.SetBankPath(m_soundbankFolder.c_str());
- AkInitSettings akInitSettings;
- AK::SoundEngine::GetDefaultInitSettings(akInitSettings);
- akInitSettings.uCommandQueueSize = aznumeric_cast<AkUInt32>(Wwise::Cvars::s_CommandQueueMemorySize << 10);
- #if !defined(WWISE_RELEASE)
- akInitSettings.uMonitorQueuePoolSize = aznumeric_cast<AkUInt32>(Wwise::Cvars::s_MonitorQueueMemorySize << 10);
- #endif // !WWISE_RELEASE
- akInitSettings.bEnableGameSyncPreparation = false;
- #if AZ_TRAIT_AUDIOENGINEWWISE_DEFAULT_SPEAKER_CONFIGURATION
- akInitSettings.settingsMainOutput.channelConfig.SetStandardOrAnonymous(
- AK::ChannelMaskToNumChannels(AZ_TRAIT_AUDIOENGINEWWISE_DEFAULT_SPEAKER_CONFIGURATION),
- AZ_TRAIT_AUDIOENGINEWWISE_DEFAULT_SPEAKER_CONFIGURATION);
- #endif
- AkPlatformInitSettings akPlatformInitSettings;
- AK::SoundEngine::GetDefaultPlatformInitSettings(akPlatformInitSettings);
- Platform::SetupAkSoundEngine(akPlatformInitSettings);
- akResult = AK::SoundEngine::Init(&akInitSettings, &akPlatformInitSettings);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::SoundEngine::Init() returned AKRESULT %d", akResult);
- ShutDown();
- return eARS_FAILURE;
- }
- AkMusicSettings akMusicSettings;
- AK::MusicEngine::GetDefaultInitSettings(akMusicSettings);
- akResult = AK::MusicEngine::Init(&akMusicSettings);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::MusicEngine::Init() returned AKRESULT %d", akResult);
- ShutDown();
- return eARS_FAILURE;
- }
- AkSpatialAudioInitSettings akSpatialAudioSettings;
- akResult = AK::SpatialAudio::Init(akSpatialAudioSettings);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::SpatialAudio::Init() returned AKRESULT %d", akResult);
- ShutDown();
- return eARS_FAILURE;
- }
- #if !defined(WWISE_RELEASE)
- if (Audio::Wwise::Cvars::s_EnableCommSystem)
- {
- m_isCommSystemInitialized = true;
- AkCommSettings akCommSettings;
- AK::Comm::GetDefaultInitSettings(akCommSettings);
- akResult = AK::Comm::Init(akCommSettings);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::Comm::Init() returned AKRESULT %d. Communication between the Wwise authoring application and the game will not be possible\n", akResult);
- m_isCommSystemInitialized = false;
- }
- akResult = AK::Monitor::SetLocalOutput(AK::Monitor::ErrorLevel_All, ErrorMonitorCallback);
- if (!IS_WWISE_OK(akResult))
- {
- AK::Comm::Term();
- g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::Monitor::SetLocalOutput() returned AKRESULT %d", akResult);
- m_isCommSystemInitialized = false;
- }
- }
- #endif // !WWISE_RELEASE
- // Initialize the AudioSourceManager
- AudioSourceManager::Get().Initialize();
- // Register the Global Audio Object used for the events that don't need a location in the game world
- akResult = AK::SoundEngine::RegisterGameObj(m_globalGameObjectID, WwiseGlobalAudioObjectName);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::RegisterGameObject() failed for '%s' with AKRESULT %d", WwiseGlobalAudioObjectName, akResult);
- }
- // Load init.bnk before making the system available to the users
- AkOSChar* initBankName = nullptr;
- CONVERT_CHAR_TO_OSCHAR(Wwise::InitBank, initBankName);
- akResult = AK::SoundEngine::LoadBank(initBankName, m_initBankID);
- if (!IS_WWISE_OK(akResult))
- {
- // This does not qualify for a fallback to the 'Null' audio implementation!
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to load %s, returned AKRESULT %d", Wwise::InitBank, akResult);
- m_initBankID = AK_INVALID_BANK_ID;
- }
- return eARS_SUCCESS;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::ShutDown()
- {
- AKRESULT akResult = AK_Fail;
- #if !defined(WWISE_RELEASE)
- if (m_isCommSystemInitialized)
- {
- AK::Comm::Term();
- akResult = AK::Monitor::SetLocalOutput(0, nullptr);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::Monitor::SetLocalOutput() returned AKRESULT %d", akResult);
- }
- m_isCommSystemInitialized = false;
- }
- #endif // !WWISE_RELEASE
- akResult = AK::SoundEngine::UnregisterAudioDeviceStatusCallback();
- if (akResult != AK_Success)
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::UnregisterAudioDeviceStatusCallback failed!\n");
- }
- // Shutdown the AudioSourceManager
- AudioSourceManager::Get().Shutdown();
- AK::MusicEngine::Term();
- if (AK::SoundEngine::IsInitialized())
- {
- // UnRegister the DummyGameObject
- akResult = AK::SoundEngine::UnregisterGameObj(m_globalGameObjectID);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::UnregisterGameObject() failed for '%s' with AKRESULT %d", WwiseGlobalAudioObjectName, akResult);
- }
- akResult = AK::SoundEngine::ClearBanks();
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Failed to clear sound banks!");
- }
- AK::SoundEngine::Term();
- }
- // Terminate the streaming device and streaming manager
- // CAkFilePackageLowLevelIOBlocking::Term() destroys its associated streaming device
- // that lives in the Stream Manager, and unregisters itself as the File Location Resolver.
- if (AK::IAkStreamMgr::Get())
- {
- m_fileIOHandler.ShutDown();
- AK::IAkStreamMgr::Get()->Destroy();
- }
- // Terminate the Memory Manager
- if (AK::MemoryMgr::IsInitialized())
- {
- AK::MemoryMgr::Term();
- }
- return eARS_SUCCESS;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::Release()
- {
- // Deleting this object and destroying the allocator has been moved to AudioEngineWwiseSystemComponent
- return eARS_SUCCESS;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::StopAllSounds()
- {
- AK::SoundEngine::StopAll();
- return eARS_SUCCESS;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::RegisterAudioObject(
- IATLAudioObjectData* const audioObjectData,
- const char* const objectName)
- {
- if (audioObjectData)
- {
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- const AKRESULT akResult = AK::SoundEngine::RegisterGameObj(implObjectData->nAKID, objectName);
- const bool akSuccess = IS_WWISE_OK(akResult);
- if (!akSuccess)
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise RegisterGameObj failed with AKRESULT: %d", akResult);
- }
- return BoolToARS(akSuccess);
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise RegisterGameObj failed, audioObjectData was null");
- return eARS_FAILURE;
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::UnregisterAudioObject(IATLAudioObjectData* const audioObjectData)
- {
- if (audioObjectData)
- {
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- const AKRESULT akResult = AK::SoundEngine::UnregisterGameObj(implObjectData->nAKID);
- const bool akSuccess = IS_WWISE_OK(akResult);
- if (!akSuccess)
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise UnregisterGameObj failed with AKRESULT: %d", akResult);
- }
- return BoolToARS(akSuccess);
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise UnregisterGameObj failed, audioObjectData was null");
- return eARS_FAILURE;
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::ResetAudioObject(IATLAudioObjectData* const audioObjectData)
- {
- if (audioObjectData)
- {
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- implObjectData->cEnvironmentImplAmounts.clear();
- implObjectData->bNeedsToUpdateEnvironments = false;
- return eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Resetting Audio object failed, audioObjectData was null");
- return eARS_FAILURE;
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::UpdateAudioObject(IATLAudioObjectData* const audioObjectData)
- {
- AZ_PROFILE_FUNCTION(AZ::Debug::ProfileCategory::Audio);
- EAudioRequestStatus result = eARS_FAILURE;
- if (audioObjectData)
- {
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- if (implObjectData->bNeedsToUpdateEnvironments)
- {
- result = PostEnvironmentAmounts(implObjectData);
- }
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::PrepareTriggerSync(
- [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
- const IATLTriggerImplData* const triggerData)
- {
- return PrepUnprepTriggerSync(triggerData, true);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::UnprepareTriggerSync(
- [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
- const IATLTriggerImplData* const triggerData)
- {
- return PrepUnprepTriggerSync(triggerData, false);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::PrepareTriggerAsync(
- [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
- const IATLTriggerImplData* const triggerData,
- IATLEventData* const eventData)
- {
- return PrepUnprepTriggerAsync(triggerData, eventData, true);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::UnprepareTriggerAsync(
- [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
- const IATLTriggerImplData* const triggerData,
- IATLEventData* const eventData)
- {
- return PrepUnprepTriggerAsync(triggerData, eventData, false);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::ActivateTrigger(
- IATLAudioObjectData* const audioObjectData,
- const IATLTriggerImplData* const triggerData,
- IATLEventData* const eventData,
- const SATLSourceData* const sourceData)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- auto const implTriggerData = static_cast<const SATLTriggerImplData_wwise*>(triggerData);
- auto const implEventData = static_cast<SATLEventData_wwise*>(eventData);
- if (implObjectData && implTriggerData && implEventData)
- {
- AkGameObjectID akObjectId = AK_INVALID_GAME_OBJECT;
- if (implObjectData->bHasPosition)
- {
- akObjectId = implObjectData->nAKID;
- PostEnvironmentAmounts(implObjectData);
- }
- else
- {
- akObjectId = m_globalGameObjectID;
- }
- AkPlayingID akPlayingId = AK_INVALID_PLAYING_ID;
- switch (GetAssetType(sourceData))
- {
- case eAAT_SOURCE:
- {
- AZ_Assert(sourceData, "SourceData not provided for source type!");
- // format: "external/{collection_id}/{language_id}/{file_id}.wem"
- auto filePath = AZStd::string::format("%s" "/%" PRIu64 "/%" PRIu64 "/%" PRIu64 ".wem",
- Audio::Wwise::ExternalSourcesPath,
- sourceData->m_sourceInfo.m_collectionId,
- sourceData->m_sourceInfo.m_languageId,
- sourceData->m_sourceInfo.m_fileId);
- AkOSChar* finalFilePath = nullptr;
- CONVERT_CHAR_TO_OSCHAR(filePath.c_str(), finalFilePath);
- AkExternalSourceInfo sources[1];
- sources[0].iExternalSrcCookie = static_cast<AkUInt32>(sourceData->m_sourceInfo.m_sourceId);
- sources[0].szFile = finalFilePath;
- sources[0].idCodec = GetAkCodecID(sourceData->m_sourceInfo.m_codecType);
- akPlayingId = AK::SoundEngine::PostEvent(
- implTriggerData->nAKID,
- akObjectId,
- AK_EndOfEvent | AK_Duration,
- &WwiseEventCallback,
- implEventData,
- 1,
- sources);
- if (akPlayingId != AK_INVALID_PLAYING_ID)
- {
- implEventData->audioEventState = eAES_PLAYING;
- implEventData->nAKID = akPlayingId;
- result = eARS_SUCCESS;
- }
- else
- {
- // if Posting an Event failed, try to prepare it, if it isn't prepared already
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Failed to Post Wwise event %u with external source '%s'",
- implTriggerData->nAKID, filePath.c_str());
- }
- break;
- }
- case eAAT_STREAM:
- [[fallthrough]];
- case eAAT_NONE:
- [[fallthrough]];
- default:
- {
- akPlayingId = AK::SoundEngine::PostEvent(
- implTriggerData->nAKID,
- akObjectId,
- AK_EndOfEvent | AK_Duration,
- &WwiseEventCallback,
- implEventData);
- if (akPlayingId != AK_INVALID_PLAYING_ID)
- {
- if (sourceData)
- {
- TAudioSourceId sourceId = sourceData->m_sourceInfo.m_sourceId;
- if (sourceId != INVALID_AUDIO_SOURCE_ID)
- {
- // Activate the audio input source (associates sourceId w/ playingId)...
- AudioSourceManager::Get().ActivateSource(sourceId, akPlayingId);
- implEventData->nSourceId = sourceId;
- }
- }
- implEventData->audioEventState = eAES_PLAYING;
- implEventData->nAKID = akPlayingId;
- result = eARS_SUCCESS;
- }
- else
- {
- // if Posting an Event failed, try to prepare it, if it isn't prepared already
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Failed to Post Wwise event %u", implTriggerData->nAKID);
- }
- break;
- }
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData, ATLTriggerData or EventData passed to the Wwise implementation of ActivateTrigger.");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::StopEvent(
- [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
- const IATLEventData* const eventData)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implEventData = static_cast<const SATLEventData_wwise*>(eventData);
- if (implEventData)
- {
- switch (implEventData->audioEventState)
- {
- case eAES_PLAYING:
- {
- AK::SoundEngine::StopPlayingID(implEventData->nAKID, 10);
- result = eARS_SUCCESS;
- break;
- }
- default:
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Stopping an event of this type is not supported yet");
- break;
- }
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid EventData passed to the Wwise implementation of StopEvent.");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::StopAllEvents(IATLAudioObjectData* const audioObjectData)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- if (implObjectData)
- {
- const AkGameObjectID akObjectId = implObjectData->bHasPosition ? implObjectData->nAKID : m_globalGameObjectID;
- AK::SoundEngine::StopAll(akObjectId);
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of StopAllEvents.");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetPosition(
- IATLAudioObjectData* const audioObjectData,
- const SATLWorldPosition& worldPosition)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- if (implObjectData)
- {
- AkSoundPosition akSoundPos;
- ATLTransformToAkTransform(worldPosition, akSoundPos);
- const AKRESULT akResult = AK::SoundEngine::SetPosition(implObjectData->nAKID, akSoundPos);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise SetPosition failed with AKRESULT: %d", akResult);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of SetPosition.");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetMultiplePositions(
- IATLAudioObjectData* const audioObjectData,
- const MultiPositionParams& multiPositionParams)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- if (implObjectData)
- {
- AZStd::vector<AkSoundPosition> akPositions;
- AZStd::for_each(multiPositionParams.m_positions.begin(), multiPositionParams.m_positions.end(),
- [&akPositions](const auto& position)
- {
- akPositions.emplace_back(AZVec3ToAkTransform(position));
- }
- );
- AK::SoundEngine::MultiPositionType type = AK::SoundEngine::MultiPositionType_MultiDirections; // default 'Blended'
- if (multiPositionParams.m_type == MultiPositionBehaviorType::Separate)
- {
- type = AK::SoundEngine::MultiPositionType_MultiSources;
- }
- const AKRESULT akResult = AK::SoundEngine::SetMultiplePositions(implObjectData->nAKID, akPositions.data(), static_cast<AkUInt16>(akPositions.size()), type);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise SetMultiplePositions failed with AKRESULT: %d\n", akResult);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of SetMultiplePositions.");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetEnvironment(
- IATLAudioObjectData* const audioObjectData,
- const IATLEnvironmentImplData* const environmentData,
- const float amount)
- {
- static const float s_envEpsilon = 0.0001f;
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- auto const implEnvironmentData = static_cast<const SATLEnvironmentImplData_wwise*>(environmentData);
- if (implObjectData && implEnvironmentData)
- {
- switch (implEnvironmentData->eType)
- {
- case eWAET_AUX_BUS:
- {
- float currentAmount = -1.f;
- auto it = implObjectData->cEnvironmentImplAmounts.find(implEnvironmentData->nAKBusID);
- if (it != implObjectData->cEnvironmentImplAmounts.end())
- {
- currentAmount = it->second;
- }
- if (currentAmount == -1.f || !AZ::IsClose(currentAmount, amount, s_envEpsilon))
- {
- implObjectData->cEnvironmentImplAmounts[implEnvironmentData->nAKBusID] = amount;
- implObjectData->bNeedsToUpdateEnvironments = true;
- }
- result = eARS_SUCCESS;
- break;
- }
- case eWAET_RTPC:
- {
- auto akRtpcValue = static_cast<AkRtpcValue>(implEnvironmentData->fMult * amount + implEnvironmentData->fShift);
- const AKRESULT akResult = AK::SoundEngine::SetRTPCValue(implEnvironmentData->nAKRtpcID, akRtpcValue, implObjectData->nAKID);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to set the Rtpc %u to value %f on object %u in SetEnvironement()",
- implEnvironmentData->nAKRtpcID,
- akRtpcValue,
- implObjectData->nAKID);
- }
- break;
- }
- default:
- {
- AZ_Assert(false, "<Wwise> Unknown AudioEnvironmentImplementation type!");
- }
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or EnvironmentData passed to the Wwise implementation of SetEnvironment");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetRtpc(
- IATLAudioObjectData* const audioObjectData,
- const IATLRtpcImplData* const rtpcData,
- const float value)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- auto const implRtpcData = static_cast<const SATLRtpcImplData_wwise*>(rtpcData);
- if (implObjectData && implRtpcData)
- {
- auto akRtpcValue = static_cast<AkRtpcValue>(implRtpcData->m_fMult * value + implRtpcData->m_fShift);
- const AKRESULT akResult = AK::SoundEngine::SetRTPCValue(implRtpcData->nAKID, akRtpcValue, implObjectData->nAKID);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to set the Rtpc %llu to value %f on object %llu",
- implRtpcData->nAKID,
- static_cast<AkRtpcValue>(value),
- implObjectData->nAKID);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or RtpcData passed to the Wwise implementation of SetRtpc");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetSwitchState(
- IATLAudioObjectData* const audioObjectData,
- const IATLSwitchStateImplData* const switchStateData)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- auto const implSwitchStateData = static_cast<const SATLSwitchStateImplData_wwise*>(switchStateData);
- if (implObjectData && implSwitchStateData)
- {
- switch (implSwitchStateData->eType)
- {
- case eWST_SWITCH:
- {
- const AkGameObjectID akObjectId = implObjectData->bHasPosition ? implObjectData->nAKID : m_globalGameObjectID;
- const AKRESULT akResult = AK::SoundEngine::SetSwitch(
- implSwitchStateData->nAKSwitchID,
- implSwitchStateData->nAKStateID,
- akObjectId);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to set the switch group %u to state %u on object %llu",
- implSwitchStateData->nAKSwitchID,
- implSwitchStateData->nAKStateID,
- akObjectId);
- }
- break;
- }
- case eWST_STATE:
- {
- const AKRESULT akResult = AK::SoundEngine::SetState(
- implSwitchStateData->nAKSwitchID,
- implSwitchStateData->nAKStateID);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to set the state group %u to state %u",
- implSwitchStateData->nAKSwitchID,
- implSwitchStateData->nAKStateID);
- }
- break;
- }
- case eWST_RTPC:
- {
- const AkGameObjectID akObjectId = implObjectData->nAKID;
- const AKRESULT akResult = AK::SoundEngine::SetRTPCValue(
- implSwitchStateData->nAKSwitchID,
- static_cast<AkRtpcValue>(implSwitchStateData->fRtpcValue),
- akObjectId);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to set the Rtpc %u to value %f on object %llu",
- implSwitchStateData->nAKSwitchID,
- static_cast<AkRtpcValue>(implSwitchStateData->fRtpcValue),
- akObjectId);
- }
- break;
- }
- case eWST_NONE:
- {
- break;
- }
- default:
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Unknown EWwiseSwitchType: %u", implSwitchStateData->eType);
- AZ_Assert(false, "<Wwise> Unknown EWwiseSwitchType");
- break;
- }
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or RtpcData passed to the Wwise implementation of SetRtpc");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetObstructionOcclusion(
- IATLAudioObjectData* const audioObjectData,
- const float obstruction,
- const float occlusion)
- {
- if (obstruction < ObstructionOcclusionMin || obstruction > ObstructionOcclusionMax)
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Obstruction value %f is out of range, Obstruction should be between %f and %f.",
- obstruction, ObstructionOcclusionMin, ObstructionOcclusionMax);
- }
- if (occlusion < ObstructionOcclusionMin || occlusion > ObstructionOcclusionMax)
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Occlusion value %f is out of range, Occlusion should be between %f and %f.",
- occlusion, ObstructionOcclusionMin, ObstructionOcclusionMax);
- }
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- if (implObjectData)
- {
- const AKRESULT akResult = AK::SoundEngine::SetObjectObstructionAndOcclusion(
- implObjectData->nAKID,
- m_defaultListenerGameObjectID, // only set the obstruction/occlusion for the default listener for now
- static_cast<AkReal32>(obstruction),
- static_cast<AkReal32>(occlusion));
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to set Obstruction %f and Occlusion %f on object %llu",
- obstruction,
- occlusion,
- implObjectData->nAKID);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of SetObjectObstructionAndOcclusion");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::SetListenerPosition(
- IATLListenerData* const listenerData,
- const SATLWorldPosition& newPosition)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implListenerData = static_cast<SATLListenerData_wwise*>(listenerData);
- if (implListenerData)
- {
- AkListenerPosition akListenerPos;
- ATLTransformToAkTransform(newPosition, akListenerPos);
- const AKRESULT akResult = AK::SoundEngine::SetPosition(implListenerData->nAKListenerObjectId, akListenerPos);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise SetListenerPosition failed with AKRESULT: %u", akResult);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid ATLListenerData passed to the Wwise implementation of SetListenerPosition");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::ResetRtpc(IATLAudioObjectData* const audioObjectData, const IATLRtpcImplData* const rtpcData)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- auto const implRtpcDat = static_cast<const SATLRtpcImplData_wwise*>(rtpcData);
- if (implObjectData && implRtpcDat)
- {
- const AKRESULT akResult = AK::SoundEngine::ResetRTPCValue(implRtpcDat->nAKID, implObjectData->nAKID);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise failed to reset the Rtpc %u on object %llu",
- implRtpcDat->nAKID,
- implObjectData->nAKID);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or RtpcData passed to the Wwise implementation of ResetRtpc");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::RegisterInMemoryFile(SATLAudioFileEntryInfo* const fileEntryInfo)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- if (fileEntryInfo)
- {
- auto const implFileEntryData = static_cast<SATLAudioFileEntryData_wwise*>(fileEntryInfo->pImplData);
- if (implFileEntryData)
- {
- AkBankID akBankId = AK_INVALID_BANK_ID;
- const AKRESULT akResult = AK::SoundEngine::LoadBankMemoryView(
- fileEntryInfo->pFileData,
- aznumeric_cast<AkUInt32>(fileEntryInfo->nSize),
- akBankId);
- if (IS_WWISE_OK(akResult))
- {
- implFileEntryData->nAKBankID = akBankId;
- result = eARS_SUCCESS;
- }
- else
- {
- implFileEntryData->nAKBankID = AK_INVALID_BANK_ID;
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Failed to load file %s\n", fileEntryInfo->sFileName);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioFileEntryData passed to the Wwise implementation of RegisterInMemoryFile");
- }
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::UnregisterInMemoryFile(SATLAudioFileEntryInfo* const fileEntryInfo)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- if (fileEntryInfo)
- {
- auto const implFileEntryData = static_cast<SATLAudioFileEntryData_wwise*>(fileEntryInfo->pImplData);
- if (implFileEntryData)
- {
- const AKRESULT akResult = AK::SoundEngine::UnloadBank(implFileEntryData->nAKBankID, fileEntryInfo->pFileData);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise Failed to unregister in memory file %s\n", fileEntryInfo->sFileName);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioFileEntryData passed to the Wwise implementation of UnregisterInMemoryFile");
- }
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::ParseAudioFileEntry(const AZ::rapidxml::xml_node<char>* audioFileEntryNode, SATLAudioFileEntryInfo* const fileEntryInfo)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- if (audioFileEntryNode && azstricmp(audioFileEntryNode->name(), WwiseXmlTags::WwiseFileTag) == 0 && fileEntryInfo)
- {
- const char* audioFileEntryName = nullptr;
- auto fileEntryNameAttr = audioFileEntryNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (fileEntryNameAttr)
- {
- audioFileEntryName = fileEntryNameAttr->value();
- }
- bool isLocalized = false;
- auto localizedAttr = audioFileEntryNode->first_attribute(WwiseXmlTags::WwiseLocalizedAttribute, 0, false);
- // Legacy Preload support
- if (!localizedAttr)
- {
- localizedAttr = audioFileEntryNode->first_attribute(WwiseXmlTags::Legacy::WwiseLocalizedAttribute, 0, false);
- }
- if (localizedAttr)
- {
- if (azstricmp(localizedAttr->value(), "true") == 0)
- {
- isLocalized = true;
- }
- }
- if (audioFileEntryName && audioFileEntryName[0] != '\0')
- {
- fileEntryInfo->bLocalized = isLocalized;
- fileEntryInfo->sFileName = audioFileEntryName;
- fileEntryInfo->nMemoryBlockAlignment = AK_BANK_PLATFORM_DATA_ALIGNMENT;
- fileEntryInfo->pImplData = azcreate(SATLAudioFileEntryData_wwise, (), Audio::AudioImplAllocator, "ATLAudioFileEntryData_wwise");
- result = eARS_SUCCESS;
- }
- else
- {
- fileEntryInfo->sFileName = nullptr;
- fileEntryInfo->nMemoryBlockAlignment = 0;
- fileEntryInfo->pImplData = nullptr;
- }
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioFileEntryData(IATLAudioFileEntryData* const oldAudioFileEntry)
- {
- azdestroy(oldAudioFileEntry, Audio::AudioImplAllocator, SATLAudioFileEntryData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- const char* const CAudioSystemImpl_wwise::GetAudioFileLocation(SATLAudioFileEntryInfo* const fileEntryInfo)
- {
- const char* location = nullptr;
- if (fileEntryInfo)
- {
- location = fileEntryInfo->bLocalized ? m_localizedSoundbankFolder.c_str() : m_soundbankFolder.c_str();
- }
- return location;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLAudioObjectData_wwise* CAudioSystemImpl_wwise::NewGlobalAudioObjectData(const TAudioObjectID objectId)
- {
- AZ_UNUSED(objectId);
- auto newObjectData = azcreate(SATLAudioObjectData_wwise, (AK_INVALID_GAME_OBJECT, false), Audio::AudioImplAllocator, "ATLAudioObjectData_wwise-Global");
- return newObjectData;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLAudioObjectData_wwise* CAudioSystemImpl_wwise::NewAudioObjectData(const TAudioObjectID objectId)
- {
- auto newObjectData = azcreate(SATLAudioObjectData_wwise, (static_cast<AkGameObjectID>(objectId), true), Audio::AudioImplAllocator, "ATLAudioObjectData_wwise");
- return newObjectData;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioObjectData(IATLAudioObjectData* const oldObjectData)
- {
- azdestroy(oldObjectData, Audio::AudioImplAllocator, SATLAudioObjectData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLListenerData_wwise* CAudioSystemImpl_wwise::NewDefaultAudioListenerObjectData(const TATLIDType listenerId)
- {
- auto newObjectData = azcreate(SATLListenerData_wwise, (static_cast<AkGameObjectID>(listenerId)), Audio::AudioImplAllocator, "ATLListenerData_wwise-Default");
- if (newObjectData)
- {
- auto listenerName = AZStd::string::format("DefaultAudioListener(%" PRIu64 ")", static_cast<AZ::u64>(newObjectData->nAKListenerObjectId));
- AKRESULT akResult = AK::SoundEngine::RegisterGameObj(newObjectData->nAKListenerObjectId, listenerName.c_str());
- if (IS_WWISE_OK(akResult))
- {
- akResult = AK::SoundEngine::SetDefaultListeners(&newObjectData->nAKListenerObjectId, 1);
- if (IS_WWISE_OK(akResult))
- {
- m_defaultListenerGameObjectID = newObjectData->nAKListenerObjectId;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in SetDefaultListeners to set AkGameObjectID %llu as default with AKRESULT: %u", newObjectData->nAKListenerObjectId, akResult);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in RegisterGameObj registering a DefaultAudioListener with AKRESULT: %u", akResult);
- }
- }
- return newObjectData;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLListenerData_wwise* CAudioSystemImpl_wwise::NewAudioListenerObjectData(const TATLIDType listenerId)
- {
- auto newObjectData = azcreate(SATLListenerData_wwise, (static_cast<AkGameObjectID>(listenerId)), Audio::AudioImplAllocator, "ATLListenerData_wwise");
- if (newObjectData)
- {
- auto listenerName = AZStd::string::format("AudioListener(%" PRIu64 ")", static_cast<AZ::u64>(newObjectData->nAKListenerObjectId));
- AKRESULT akResult = AK::SoundEngine::RegisterGameObj(newObjectData->nAKListenerObjectId, listenerName.c_str());
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in RegisterGameObj registering an AudioListener with AKRESULT: %u", akResult);
- }
- }
- return newObjectData;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioListenerObjectData(IATLListenerData* const oldListenerData)
- {
- auto listenerData = static_cast<SATLListenerData_wwise*>(oldListenerData);
- if (listenerData)
- {
- AKRESULT akResult = AK::SoundEngine::UnregisterGameObj(listenerData->nAKListenerObjectId);
- if (IS_WWISE_OK(akResult))
- {
- if (listenerData->nAKListenerObjectId == m_defaultListenerGameObjectID)
- {
- m_defaultListenerGameObjectID = AK_INVALID_GAME_OBJECT;
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in UnregisterGameObj unregistering an AudioListener(%llu) with AKRESULT: %u", listenerData->nAKListenerObjectId, akResult);
- }
- }
- azdestroy(oldListenerData, Audio::AudioImplAllocator, SATLListenerData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLEventData_wwise* CAudioSystemImpl_wwise::NewAudioEventData(const TAudioEventID eventId)
- {
- auto newObjectData = azcreate(SATLEventData_wwise, (eventId), Audio::AudioImplAllocator, "ATLEventData_wwise");
- return newObjectData;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioEventData(IATLEventData* const oldEventData)
- {
- azdestroy(oldEventData, Audio::AudioImplAllocator, SATLEventData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::ResetAudioEventData(IATLEventData* const eventData)
- {
- auto const implEventData = static_cast<SATLEventData_wwise*>(eventData);
- if (implEventData)
- {
- implEventData->audioEventState = eAES_NONE;
- implEventData->nAKID = AK_INVALID_UNIQUE_ID;
- implEventData->nSourceId = INVALID_AUDIO_SOURCE_ID;
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- IATLTriggerImplData* CAudioSystemImpl_wwise::NewAudioTriggerImplData(const AZ::rapidxml::xml_node<char>* audioTriggerNode)
- {
- SATLTriggerImplData_wwise* newTriggerImpl = nullptr;
- if (audioTriggerNode && azstricmp(audioTriggerNode->name(), WwiseXmlTags::WwiseEventTag) == 0)
- {
- auto eventNameAttr = audioTriggerNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (eventNameAttr)
- {
- const char* eventName = eventNameAttr->value();
- const AkUniqueID akId = AK::SoundEngine::GetIDFromString(eventName);
- if (akId != AK_INVALID_UNIQUE_ID)
- {
- newTriggerImpl = azcreate(SATLTriggerImplData_wwise, (akId), Audio::AudioImplAllocator, "ATLTriggerImplData_wwise");
- }
- }
- }
- return newTriggerImpl;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioTriggerImplData(IATLTriggerImplData* const oldTriggerImplData)
- {
- azdestroy(oldTriggerImplData, Audio::AudioImplAllocator, SATLTriggerImplData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- IATLRtpcImplData* CAudioSystemImpl_wwise::NewAudioRtpcImplData(const AZ::rapidxml::xml_node<char>* audioRtpcNode)
- {
- SATLRtpcImplData_wwise* newRtpcImpl = nullptr;
- AkRtpcID akRtpcId = AK_INVALID_RTPC_ID;
- float mult = 1.f;
- float shift = 0.f;
- ParseRtpcImpl(audioRtpcNode, akRtpcId, mult, shift);
- if (akRtpcId != AK_INVALID_RTPC_ID)
- {
- newRtpcImpl = azcreate(SATLRtpcImplData_wwise, (akRtpcId, mult, shift), Audio::AudioImplAllocator, "ATLRtpcImplData_wwise");
- }
- return newRtpcImpl;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioRtpcImplData(IATLRtpcImplData* const oldRtpcImplData)
- {
- azdestroy(oldRtpcImplData, Audio::AudioImplAllocator, SATLRtpcImplData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- IATLSwitchStateImplData* CAudioSystemImpl_wwise::NewAudioSwitchStateImplData(const AZ::rapidxml::xml_node<char>* audioSwitchNode)
- {
- SATLSwitchStateImplData_wwise* newSwitchImpl = nullptr;
- const char* nodeName = audioSwitchNode->name();
- if (azstricmp(nodeName, WwiseXmlTags::WwiseSwitchTag) == 0)
- {
- newSwitchImpl = ParseWwiseSwitchOrState(audioSwitchNode, eWST_SWITCH);
- }
- else if (azstricmp(nodeName, WwiseXmlTags::WwiseStateTag) == 0)
- {
- newSwitchImpl = ParseWwiseSwitchOrState(audioSwitchNode, eWST_STATE);
- }
- else if (azstricmp(nodeName, WwiseXmlTags::WwiseRtpcSwitchTag) == 0)
- {
- newSwitchImpl = ParseWwiseRtpcSwitch(audioSwitchNode);
- }
- return newSwitchImpl;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioSwitchStateImplData(IATLSwitchStateImplData* const oldSwitchStateImplData)
- {
- azdestroy(oldSwitchStateImplData, Audio::AudioImplAllocator, SATLSwitchStateImplData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- IATLEnvironmentImplData* CAudioSystemImpl_wwise::NewAudioEnvironmentImplData(const AZ::rapidxml::xml_node<char>* audioEnvironmentNode)
- {
- SATLEnvironmentImplData_wwise* newEnvironmentImpl = nullptr;
- if (azstricmp(audioEnvironmentNode->name(), WwiseXmlTags::WwiseAuxBusTag) == 0)
- {
- auto auxBusNameAttr = audioEnvironmentNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (auxBusNameAttr)
- {
- const char* auxBusName = auxBusNameAttr->value();
- const AkUniqueID akBusId = AK::SoundEngine::GetIDFromString(auxBusName);
- if (akBusId != AK_INVALID_AUX_ID)
- {
- newEnvironmentImpl = azcreate(SATLEnvironmentImplData_wwise, (eWAET_AUX_BUS, static_cast<AkAuxBusID>(akBusId)), Audio::AudioImplAllocator, "ATLEnvironmentImplData_wwise");
- }
- }
- }
- else if (azstricmp(audioEnvironmentNode->name(), WwiseXmlTags::WwiseRtpcTag) == 0)
- {
- AkRtpcID akRtpcId = AK_INVALID_RTPC_ID;
- float mult = 1.f;
- float shift = 0.f;
- ParseRtpcImpl(audioEnvironmentNode, akRtpcId, mult, shift);
- if (akRtpcId != AK_INVALID_RTPC_ID)
- {
- newEnvironmentImpl = azcreate(SATLEnvironmentImplData_wwise, (eWAET_RTPC, akRtpcId, mult, shift), Audio::AudioImplAllocator, "ATLEnvironmentImplData_wwise");
- }
- }
- return newEnvironmentImpl;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DeleteAudioEnvironmentImplData(IATLEnvironmentImplData* const oldEnvironmentImplData)
- {
- azdestroy(oldEnvironmentImplData, Audio::AudioImplAllocator, SATLEnvironmentImplData_wwise);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- const char* const CAudioSystemImpl_wwise::GetImplementationNameString() const
- {
- #if !defined(WWISE_RELEASE)
- return m_fullImplString.c_str();
- #else
- return nullptr;
- #endif // !WWISE_RELEASE
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::GetMemoryInfo(SAudioImplMemoryInfo& memoryInfo) const
- {
- memoryInfo.nPrimaryPoolSize = AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().Capacity();
- memoryInfo.nPrimaryPoolUsedSize = memoryInfo.nPrimaryPoolSize - AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().GetUnAllocatedMemory();
- memoryInfo.nPrimaryPoolAllocations = 0;
- memoryInfo.nSecondaryPoolSize = 0;
- memoryInfo.nSecondaryPoolUsedSize = 0;
- memoryInfo.nSecondaryPoolAllocations = 0;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- AZStd::vector<AudioImplMemoryPoolInfo> CAudioSystemImpl_wwise::GetMemoryPoolInfo()
- {
- #if !defined(WWISE_RELEASE)
- // Update memory category info...
- for (auto& memInfo : m_debugMemoryInfo)
- {
- if (memInfo.m_poolId < 0)
- {
- break;
- }
- AK::MemoryMgr::CategoryStats categoryStats;
- AK::MemoryMgr::GetCategoryStats(memInfo.m_poolId, categoryStats);
- memInfo.m_memoryUsed = categoryStats.uUsed;
- memInfo.m_peakUsed = categoryStats.uPeakUsed;
- memInfo.m_numAllocs = categoryStats.uAllocs;
- memInfo.m_numFrees = categoryStats.uFrees;
- }
- AK::MemoryMgr::GlobalStats globalStats;
- AK::MemoryMgr::GetGlobalStats(globalStats);
- auto& memInfo = m_debugMemoryInfo.back();
- memInfo.m_memoryReserved = globalStats.uReserved;
- memInfo.m_memoryUsed = globalStats.uUsed;
- memInfo.m_peakUsed = globalStats.uMax;
- // return the memory infos...
- return m_debugMemoryInfo;
- #else
- return AZStd::vector<AudioImplMemoryPoolInfo>();
- #endif // !WWISE_RELEASE
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- bool CAudioSystemImpl_wwise::CreateAudioSource(const SAudioInputConfig& sourceConfig)
- {
- return AudioSourceManager::Get().CreateSource(sourceConfig);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::DestroyAudioSource(TAudioSourceId sourceId)
- {
- AudioSourceManager::Get().DestroySource(sourceId);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::SetPanningMode(PanningMode mode)
- {
- AkPanningRule panningRule;
- switch (mode)
- {
- case PanningMode::Speakers:
- panningRule = AkPanningRule_Speakers;
- break;
- case PanningMode::Headphones:
- panningRule = AkPanningRule_Headphones;
- break;
- default:
- return;
- }
- AKRESULT akResult = AK::SoundEngine::SetPanningRule(panningRule);
- if (!IS_WWISE_OK(akResult))
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to set Panning Rule to [%s]\n", panningRule == AkPanningRule_Speakers ? "Speakers" : "Headphones");
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLSwitchStateImplData_wwise* CAudioSystemImpl_wwise::ParseWwiseSwitchOrState(const AZ::rapidxml::xml_node<char>* node, EWwiseSwitchType type)
- {
- SATLSwitchStateImplData_wwise* switchStateImpl = nullptr;
- auto switchNameAttr = node->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (switchNameAttr)
- {
- const char* switchName = switchNameAttr->value();
- auto valueNode = node->first_node(WwiseXmlTags::WwiseValueTag, 0, false);
- if (valueNode)
- {
- auto valueNameAttr = valueNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (valueNameAttr)
- {
- const char* stateName = valueNameAttr->value();
- const AkUniqueID akSGroupId = AK::SoundEngine::GetIDFromString(switchName);
- const AkUniqueID akSNameId = AK::SoundEngine::GetIDFromString(stateName);
- if (akSGroupId != AK_INVALID_UNIQUE_ID && akSNameId != AK_INVALID_UNIQUE_ID)
- {
- switchStateImpl = azcreate(SATLSwitchStateImplData_wwise, (type, akSGroupId, akSNameId), Audio::AudioImplAllocator, "ATLSwitchStateImplData_wwise");
- }
- }
- }
- }
- return switchStateImpl;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- SATLSwitchStateImplData_wwise* CAudioSystemImpl_wwise::ParseWwiseRtpcSwitch(const AZ::rapidxml::xml_node<char>* node)
- {
- SATLSwitchStateImplData_wwise* switchStateImpl = nullptr;
- if (node && azstricmp(node->name(), WwiseXmlTags::WwiseRtpcSwitchTag) == 0)
- {
- auto rtpcNameAttr = node->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (rtpcNameAttr)
- {
- const char* rtpcName = rtpcNameAttr->value();
- float rtpcValue = 0.f;
- auto rtpcValueAttr = node->first_attribute(WwiseXmlTags::WwiseValueAttribute, 0, false);
- if (rtpcValueAttr)
- {
- rtpcValue = AZStd::stof(AZStd::string(rtpcValueAttr->value()));
- const AkUniqueID akRtpcId = AK::SoundEngine::GetIDFromString(rtpcName);
- if (akRtpcId != AK_INVALID_RTPC_ID)
- {
- switchStateImpl = azcreate(SATLSwitchStateImplData_wwise, (eWST_RTPC, akRtpcId, akRtpcId, rtpcValue), Audio::AudioImplAllocator, "ATLSwitchStateImplData_wwise");
- }
- }
- }
- }
- return switchStateImpl;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::ParseRtpcImpl(const AZ::rapidxml::xml_node<char>* node, AkRtpcID& akRtpcId, float& mult, float& shift)
- {
- if (node && azstricmp(node->name(), WwiseXmlTags::WwiseRtpcTag) == 0)
- {
- auto rtpcAttr = node->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
- if (rtpcAttr)
- {
- const char* rtpcName = rtpcAttr->value();
- akRtpcId = static_cast<AkRtpcID>(AK::SoundEngine::GetIDFromString(rtpcName));
- if (akRtpcId != AK_INVALID_RTPC_ID)
- {
- auto multAttr = node->first_attribute(WwiseXmlTags::WwiseMutiplierAttribute, 0, false);
- if (multAttr)
- {
- mult = AZStd::stof(AZStd::string(multAttr->value()));
- }
- auto shiftAttr = node->first_attribute(WwiseXmlTags::WwiseShiftAttribute, 0, false);
- if (shiftAttr)
- {
- shift = AZStd::stof(AZStd::string(shiftAttr->value()));
- }
- }
- }
- }
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::PrepUnprepTriggerSync(
- const IATLTriggerImplData* const triggerData,
- bool prepare)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implTriggerData = static_cast<const SATLTriggerImplData_wwise*>(triggerData);
- if (implTriggerData)
- {
- AkUniqueID akUniqueId = implTriggerData->nAKID;
- const AKRESULT akResult = AK::SoundEngine::PrepareEvent(
- prepare ? AK::SoundEngine::Preparation_Load : AK::SoundEngine::Preparation_Unload,
- &akUniqueId,
- 1);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise PrepareEvent with %s failed for Wwise event %u with AKRESULT: %u",
- prepare ? "Preparation_Load" : "Preparation_Unload",
- akUniqueId,
- akResult);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR,
- "Invalid ATLTriggerData or EventData passed to the Wwise implementation of %sTriggerSync",
- prepare ? "Prepare" : "Unprepare");
- }
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::PrepUnprepTriggerAsync(
- [[maybe_unused]] const IATLTriggerImplData* const triggerData,
- [[maybe_unused]] IATLEventData* const eventData,
- [[maybe_unused]] bool prepare)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- #if 0 // Turned off, PrepareEvent is not supported yet.
- auto const implTriggerData = static_cast<const SATLTriggerImplData_wwise*>(triggerData);
- auto const implEventData = static_cast<SATLEventData_wwise*>(eventData);
- if (implTriggerData && implEventData)
- {
- AkUniqueID akUniqueId = implTriggerData->nAKID;
- const AKRESULT akResult = AK::SoundEngine::PrepareEvent(
- prepare ? AK::SoundEngine::Preparation_Load : AK::SoundEngine::Preparation_Unload,
- &akUniqueId,
- 1,
- &PrepareEventCallback,
- implEventData);
- if (IS_WWISE_OK(akResult))
- {
- implEventData->nAKID = akUniqueId;
- implEventData->audioEventState = eAES_UNLOADING;
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(
- eALT_WARNING,
- "Wwise PrepareEvent with %s failed for Wwise event %u with AKRESULT: %u",
- prepare ? "Preparation_Load" : "Preparation_Unload",
- akUniqueId,
- akResult);
- }
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_ERROR,
- "Invalid ATLTriggerData or EventData passed to the Wwise implementation of %sTriggerAsync",
- prepare ? "Prepare" : "Unprepare");
- }
- #endif
- return result;
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::SetBankPaths()
- {
- // Default...
- // "sounds/wwise/"
- AZStd::string bankPath = Audio::Wwise::DefaultBanksPath;
- // "sounds/wwise/wwise_config.json"
- AZStd::string configFile = bankPath + Audio::Wwise::ConfigFile;
- if (AZ::IO::FileIOBase::GetInstance()
- && AZ::IO::FileIOBase::GetInstance()->Exists(configFile.c_str()))
- {
- Audio::Wwise::ConfigurationSettings configSettings;
- if (configSettings.Load(configFile))
- {
- for (const auto& platformMap : configSettings.m_platformMappings)
- {
- // May need to do a series of checks compare the data in the config settings to what's actually in the file system.
- // This is the most straightforward platform check.
- if (azstricmp(platformMap.m_enginePlatform.c_str(), AZ_TRAIT_OS_PLATFORM_NAME) == 0)
- {
- AZStd::string platformPath;
- // "sounds/wwise/windows"
- AZ::StringFunc::AssetDatabasePath::Join(bankPath.c_str(), platformMap.m_bankSubPath.c_str(), platformPath);
- AZStd::string initBankPath;
- // "sounds/wwise/windows/init.bnk"
- AZ::StringFunc::AssetDatabasePath::Join(platformPath.c_str(), Audio::Wwise::InitBank, initBankPath);
- if (AZ::IO::FileIOBase::GetInstance()->Exists(initBankPath.c_str()))
- {
- if (!platformPath.ends_with(AZ_CORRECT_DATABASE_SEPARATOR))
- {
- platformPath.push_back(AZ_CORRECT_DATABASE_SEPARATOR);
- }
- bankPath = AZStd::move(platformPath);
- break;
- }
- }
- }
- }
- }
- m_soundbankFolder = bankPath;
- m_localizedSoundbankFolder = bankPath;
- Audio::Wwise::SetBanksRootPath(m_soundbankFolder);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- bool CAudioSystemImpl_wwise::SEnvPairCompare::operator()(const AZStd::pair<const AkAuxBusID, float>& pair1, const AZStd::pair<const AkAuxBusID, float>& pair2) const
- {
- return (pair1.second > pair2.second);
- }
- ///////////////////////////////////////////////////////////////////////////////////////////////////
- EAudioRequestStatus CAudioSystemImpl_wwise::PostEnvironmentAmounts(IATLAudioObjectData* const audioObjectData)
- {
- EAudioRequestStatus result = eARS_FAILURE;
- auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
- if (implObjectData)
- {
- AkAuxSendValue akAuxSendValues[LY_MAX_AUX_PER_OBJ];
- AZ::u32 auxCount = 0;
- SATLAudioObjectData_wwise::TEnvironmentImplMap::iterator envPair = implObjectData->cEnvironmentImplAmounts.begin();
- const SATLAudioObjectData_wwise::TEnvironmentImplMap::const_iterator envBegin = implObjectData->cEnvironmentImplAmounts.begin();
- const SATLAudioObjectData_wwise::TEnvironmentImplMap::const_iterator envEnd = implObjectData->cEnvironmentImplAmounts.end();
- if (implObjectData->cEnvironmentImplAmounts.size() <= LY_MAX_AUX_PER_OBJ)
- {
- for (; envPair != envEnd; ++auxCount)
- {
- const float amount = envPair->second;
- akAuxSendValues[auxCount].auxBusID = envPair->first;
- akAuxSendValues[auxCount].fControlValue = amount;
- akAuxSendValues[auxCount].listenerID = m_defaultListenerGameObjectID; // TODO: Expand api to allow specify listeners
- // If an amount is zero, we still want to send it to the middleware, but we also want to remove it from the map.
- if (amount == 0.0f)
- {
- envPair = implObjectData->cEnvironmentImplAmounts.erase(envPair);
- }
- else
- {
- ++envPair;
- }
- }
- }
- else
- {
- // sort the environments in order of decreasing amounts and take the first LY_MAX_AUX_PER_OBJ worth
- using TEnvPairSet = AZStd::set<SATLAudioObjectData_wwise::TEnvironmentImplMap::value_type, SEnvPairCompare, Audio::AudioImplStdAllocator>;
- TEnvPairSet envPairs(envBegin, envEnd);
- TEnvPairSet::const_iterator sortedEnvPair = envPairs.begin();
- const TEnvPairSet::const_iterator sortedEnvEnd = envPairs.end();
- for (; (sortedEnvPair != sortedEnvEnd) && (auxCount < LY_MAX_AUX_PER_OBJ); ++sortedEnvPair, ++auxCount)
- {
- akAuxSendValues[auxCount].auxBusID = sortedEnvPair->first;
- akAuxSendValues[auxCount].fControlValue = sortedEnvPair->second;
- akAuxSendValues[auxCount].listenerID = m_defaultListenerGameObjectID; // TODO: Expand api to allow specify listeners
- }
- // remove all Environments with 0.0 amounts
- while (envPair != envEnd)
- {
- if (envPair->second == 0.0f)
- {
- envPair = implObjectData->cEnvironmentImplAmounts.erase(envPair);
- }
- else
- {
- ++envPair;
- }
- }
- }
- AZ_Assert(auxCount <= LY_MAX_AUX_PER_OBJ, "WwiseImpl PostEnvironmentAmounts - Exceeded the allowed number of aux environments that can be set!");
- const AKRESULT akResult = AK::SoundEngine::SetGameObjectAuxSendValues(implObjectData->nAKID, akAuxSendValues, auxCount);
- if (IS_WWISE_OK(akResult))
- {
- result = eARS_SUCCESS;
- }
- else
- {
- g_audioImplLogger_wwise.Log(eALT_WARNING,
- "Wwise SetGameObjectAuxSendValues failed on object %llu with AKRESULT: %u",
- implObjectData->nAKID,
- akResult);
- }
- implObjectData->bNeedsToUpdateEnvironments = false;
- }
- return result;
- }
- //////////////////////////////////////////////////////////////////////////
- const char* const CAudioSystemImpl_wwise::GetImplSubPath() const
- {
- return WwiseImplSubPath;
- }
- //////////////////////////////////////////////////////////////////////////
- void CAudioSystemImpl_wwise::SetLanguage(const char* const language)
- {
- if (language)
- {
- AZStd::string languageSubfolder;
- if (azstricmp(language, "english") == 0)
- {
- languageSubfolder = "english(us)";
- }
- else
- {
- languageSubfolder = language;
- }
- languageSubfolder += "/";
- m_localizedSoundbankFolder = m_soundbankFolder;
- m_localizedSoundbankFolder.append(languageSubfolder);
- m_fileIOHandler.SetLanguageFolder(languageSubfolder.c_str());
- }
- }
- } // namespace Audio
|