AudioSystemImpl_wwise.cpp 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201
  1. /*
  2. * All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
  3. * its licensors.
  4. *
  5. * For complete copyright and license terms please see the LICENSE at the root of this
  6. * distribution (the "License"). All use of this software is governed by the License,
  7. * or, if provided, by the license below or the license accompanying this file. Do not
  8. * remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
  9. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. *
  11. */
  12. // Original file Copyright Crytek GMBH or its affiliates, used under license.
  13. #include <AzCore/PlatformIncl.h>
  14. #include <AudioSystemImpl_wwise.h>
  15. #include <platform.h>
  16. #include <AzCore/AzCore_Traits_Platform.h>
  17. #include <AzCore/std/containers/set.h>
  18. #include <AzCore/std/string/conversions.h>
  19. #include <AzCore/StringFunc/StringFunc.h>
  20. #include <IAudioSystem.h>
  21. #include <AudioAllocators.h>
  22. #include <AudioLogger.h>
  23. #include <AudioSourceManager.h>
  24. #include <AudioSystemImplCVars.h>
  25. #include <Common_wwise.h>
  26. #include <Config_wwise.h>
  27. #include <FileIOHandler_wwise.h>
  28. #include <AK/SoundEngine/Common/AkMemoryMgr.h> // Memory Manager
  29. #include <AK/SoundEngine/Common/AkModule.h> // Memory and Stream Manager interfaces
  30. #include <AK/SoundEngine/Common/AkSoundEngine.h> // Sound Engine
  31. #include <AK/SpatialAudio/Common/AkSpatialAudio.h> // Spatial Audio
  32. #include <AK/MusicEngine/Common/AkMusicEngine.h> // Music Engine
  33. #include <PluginRegistration_wwise.h> // Registration of default set of plugins, customize this header to your needs.
  34. #include <inttypes.h>
  35. #if !defined(WWISE_RELEASE)
  36. #include <AK/Comm/AkCommunication.h> // Communication between Wwise and the game (excluded in release build)
  37. #include <AK/Tools/Common/AkMonitorError.h>
  38. #include <AkPlatformFuncs_Platform.h>
  39. #endif // WWISE_RELEASE
  40. #if defined(AK_MAX_AUX_PER_OBJ)
  41. #define LY_MAX_AUX_PER_OBJ AK_MAX_AUX_PER_OBJ
  42. #else
  43. #define LY_MAX_AUX_PER_OBJ (4)
  44. #endif
  45. namespace Audio
  46. {
  47. namespace Platform
  48. {
  49. void InitializeMemory(CAudioLogger& audioLogger);
  50. void SetupAkSoundEngine(AkPlatformInitSettings& platformInitSettings);
  51. }
  52. /////////////////////////////////////////////////////////////////////////////////
  53. // AK MEMORY HOOKS SETUP
  54. namespace Wwise::MemHooks
  55. {
  56. void* Malloc(AkMemPoolId memId, size_t size)
  57. {
  58. size_t memCategory = memId & AkMemID_MASK;
  59. AZ_Assert(memCategory < AkMemID_NUM, "Wwise::MemHooks::Malloc - Bad AkMemPoolId passed: %zu", memCategory);
  60. return AZ::AllocatorInstance<AudioImplAllocator>::Get().Allocate(size, 0, 0,
  61. (memCategory < AkMemID_NUM) ? MemoryManagerCategories[memCategory] : nullptr);
  62. }
  63. void* Malign(AkMemPoolId memId, size_t size, AkUInt32 alignment)
  64. {
  65. size_t memCategory = memId & AkMemID_MASK;
  66. AZ_Assert(memCategory < AkMemID_NUM, "WWise::MemHooks::Malign - Bad AkMemPoolId passed: %zu", memCategory);
  67. return AZ::AllocatorInstance<AudioImplAllocator>::Get().Allocate(size, alignment, 0,
  68. (memCategory < AkMemID_NUM) ? MemoryManagerCategories[memCategory] : nullptr);
  69. }
  70. void* Realloc([[maybe_unused]] AkMemPoolId memId, void* address, size_t size)
  71. {
  72. return AZ::AllocatorInstance<AudioImplAllocator>::Get().ReAllocate(address, size, 0);
  73. }
  74. void* ReallocAligned([[maybe_unused]] AkMemPoolId memId, void* address, size_t size, AkUInt32 alignment)
  75. {
  76. return AZ::AllocatorInstance<AudioImplAllocator>::Get().ReAllocate(address, size, alignment);
  77. }
  78. void Free([[maybe_unused]] AkMemPoolId memId, void* address)
  79. {
  80. AZ::AllocatorInstance<AudioImplAllocator>::Get().DeAllocate(address);
  81. }
  82. size_t TotalReservedMemorySize()
  83. {
  84. return AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().Capacity();
  85. }
  86. size_t SizeOfMemory([[maybe_unused]] AkMemPoolId memId, void* address)
  87. {
  88. return AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().AllocationSize(address);
  89. }
  90. } // namespace Wwise::MemHooks
  91. extern CAudioLogger g_audioImplLogger_wwise;
  92. const char* const CAudioSystemImpl_wwise::WwiseImplSubPath = "wwise/";
  93. const char* const CAudioSystemImpl_wwise::WwiseGlobalAudioObjectName = "LY-GlobalAudioObject";
  94. const float CAudioSystemImpl_wwise::ObstructionOcclusionMin = 0.0f;
  95. const float CAudioSystemImpl_wwise::ObstructionOcclusionMax = 1.0f;
  96. static bool audioDeviceInitializationEvent = false;
  97. ///////////////////////////////////////////////////////////////////////////////////////////////////
  98. // AK callbacks
  99. void WwiseEventCallback(AkCallbackType callbackType, AkCallbackInfo* callbackInfo)
  100. {
  101. if (callbackType == AK_EndOfEvent)
  102. {
  103. auto const eventData = static_cast<SATLEventData_wwise*>(callbackInfo->pCookie);
  104. if (eventData)
  105. {
  106. SAudioRequest request;
  107. SAudioCallbackManagerRequestData<eACMRT_REPORT_FINISHED_EVENT> requestData(eventData->nATLID, true);
  108. request.nFlags = eARF_THREAD_SAFE_PUSH;
  109. request.pData = &requestData;
  110. AudioSystemThreadSafeRequestBus::Broadcast(&AudioSystemThreadSafeRequestBus::Events::PushRequestThreadSafe, request);
  111. if (eventData->nSourceId != INVALID_AUDIO_SOURCE_ID)
  112. {
  113. AkPlayingID playingId = AudioSourceManager::Get().FindPlayingSource(eventData->nSourceId);
  114. AudioSourceManager::Get().DeactivateSource(playingId);
  115. }
  116. }
  117. }
  118. else if (callbackType == AK_Duration)
  119. {
  120. auto durationInfo = static_cast<AkDurationCallbackInfo*>(callbackInfo);
  121. auto const eventData = static_cast<SATLEventData_wwise*>(callbackInfo->pCookie);
  122. if (durationInfo && eventData)
  123. {
  124. AudioTriggerNotificationBus::QueueEvent(eventData->m_triggerId, &AudioTriggerNotificationBus::Events::ReportDurationInfo,
  125. eventData->nATLID, durationInfo->fDuration, durationInfo->fEstimatedDuration);
  126. }
  127. }
  128. }
  129. ///////////////////////////////////////////////////////////////////////////////////////////////////
  130. void AudioDeviceCallback(
  131. [[maybe_unused]] AK::IAkGlobalPluginContext* context,
  132. [[maybe_unused]] AkUniqueID audioDeviceSharesetId,
  133. [[maybe_unused]] AkUInt32 deviceId,
  134. AK::AkAudioDeviceEvent deviceEvent,
  135. [[maybe_unused]] AKRESULT inAkResult
  136. )
  137. {
  138. if (deviceEvent == AK::AkAudioDeviceEvent_Initialization)
  139. {
  140. audioDeviceInitializationEvent = true;
  141. }
  142. }
  143. ///////////////////////////////////////////////////////////////////////////////////////////////////
  144. void PrepareEventCallback(
  145. AkUniqueID akEventId,
  146. [[maybe_unused]] const void* bankPtr,
  147. AKRESULT loadResult,
  148. [[maybe_unused]] AkMemPoolId memPoolId,
  149. void* cookie)
  150. {
  151. auto const eventData = static_cast<SATLEventData_wwise*>(cookie);
  152. if (eventData)
  153. {
  154. eventData->nAKID = akEventId;
  155. SAudioRequest request;
  156. SAudioCallbackManagerRequestData<eACMRT_REPORT_FINISHED_EVENT> requestData(eventData->nATLID, loadResult == AK_Success);
  157. request.nFlags = eARF_THREAD_SAFE_PUSH;
  158. request.pData = &requestData;
  159. AudioSystemThreadSafeRequestBus::Broadcast(&AudioSystemThreadSafeRequestBus::Events::PushRequestThreadSafe, request);
  160. }
  161. }
  162. ///////////////////////////////////////////////////////////////////////////////////////////////////
  163. #if !defined(WWISE_RELEASE)
  164. static void ErrorMonitorCallback(
  165. AK::Monitor::ErrorCode in_eErrorCode, ///< Error code number value
  166. const AkOSChar* in_pszError, ///< Message or error string to be displayed
  167. AK::Monitor::ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
  168. AkPlayingID in_playingID, ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
  169. AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
  170. )
  171. {
  172. char* errorStr = nullptr;
  173. CONVERT_OSCHAR_TO_CHAR(in_pszError, errorStr);
  174. g_audioImplLogger_wwise.Log(
  175. ((in_eErrorLevel & AK::Monitor::ErrorLevel_Error) != 0) ? eALT_ERROR : eALT_COMMENT,
  176. "<Wwise> %s ErrorCode: %d PlayingID: %u GameObjID: %llu", errorStr, in_eErrorCode, in_playingID, in_gameObjID);
  177. }
  178. #endif // WWISE_RELEASE
  179. ///////////////////////////////////////////////////////////////////////////////////////////////////
  180. static int GetAssetType(const SATLSourceData* sourceData)
  181. {
  182. if (!sourceData)
  183. {
  184. return eAAT_NONE;
  185. }
  186. return sourceData->m_sourceInfo.m_codecType == eACT_STREAM_PCM
  187. ? eAAT_STREAM
  188. : eAAT_SOURCE;
  189. }
  190. ///////////////////////////////////////////////////////////////////////////////////////////////////
  191. static int GetAkCodecID(EAudioCodecType codecType)
  192. {
  193. switch (codecType)
  194. {
  195. case eACT_AAC:
  196. return AKCODECID_AAC;
  197. case eACT_ADPCM:
  198. return AKCODECID_ADPCM;
  199. case eACT_PCM:
  200. return AKCODECID_PCM;
  201. case eACT_VORBIS:
  202. return AKCODECID_VORBIS;
  203. case eACT_XMA:
  204. return AKCODECID_XMA;
  205. case eACT_XWMA:
  206. return AKCODECID_XWMA;
  207. case eACT_STREAM_PCM:
  208. default:
  209. AZ_Assert(codecType, "Codec not supported");
  210. return AKCODECID_VORBIS;
  211. }
  212. }
  213. ///////////////////////////////////////////////////////////////////////////////////////////////////
  214. CAudioSystemImpl_wwise::CAudioSystemImpl_wwise(const char* assetsPlatformName)
  215. : m_globalGameObjectID(static_cast<AkGameObjectID>(GLOBAL_AUDIO_OBJECT_ID))
  216. , m_defaultListenerGameObjectID(AK_INVALID_GAME_OBJECT)
  217. , m_initBankID(AK_INVALID_BANK_ID)
  218. #if !defined(WWISE_RELEASE)
  219. , m_isCommSystemInitialized(false)
  220. #endif // !WWISE_RELEASE
  221. {
  222. if (assetsPlatformName && assetsPlatformName[0] != '\0')
  223. {
  224. m_assetsPlatform = assetsPlatformName;
  225. }
  226. Platform::InitializeMemory(g_audioImplLogger_wwise);
  227. SetBankPaths();
  228. #if !defined(WWISE_RELEASE)
  229. m_fullImplString = AZStd::string::format("%s (%s)", WWISE_IMPL_VERSION_STRING, m_soundbankFolder.c_str());
  230. // Set up memory categories for debug tracking, do this early before initializing Wwise so they are available
  231. // before the any allocations through hooks occur.
  232. g_audioImplLogger_wwise.Log(eALT_COMMENT, "Memory Categories:\n");
  233. m_debugMemoryInfo.reserve(AkMemID_NUM + 1);
  234. for (AZ::u32 memId = 0; memId < AkMemID_NUM; ++memId)
  235. {
  236. AudioImplMemoryPoolInfo memInfo;
  237. azstrcpy(memInfo.m_poolName, sizeof(memInfo.m_poolName), Wwise::MemoryManagerCategories[memId]);
  238. memInfo.m_poolId = memId;
  239. m_debugMemoryInfo.push_back(memInfo);
  240. g_audioImplLogger_wwise.Log(eALT_COMMENT, "Memory category ID: %u - '%s'\n", memId, Wwise::MemoryManagerCategories[memId]);
  241. }
  242. // Add one more category for global stats.
  243. AudioImplMemoryPoolInfo memInfo;
  244. azstrcpy(memInfo.m_poolName, sizeof(memInfo.m_poolName), "Global");
  245. m_debugMemoryInfo.push_back(memInfo);
  246. #endif // !WWISE_RELEASE
  247. AudioSystemImplementationRequestBus::Handler::BusConnect();
  248. AudioSystemImplementationNotificationBus::Handler::BusConnect();
  249. }
  250. ///////////////////////////////////////////////////////////////////////////////////////////////////
  251. CAudioSystemImpl_wwise::~CAudioSystemImpl_wwise()
  252. {
  253. AudioSystemImplementationRequestBus::Handler::BusDisconnect();
  254. AudioSystemImplementationNotificationBus::Handler::BusDisconnect();
  255. }
  256. ///////////////////////////////////////////////////////////////////////////////////////////////////
  257. // AudioSystemImplementationNotificationBus
  258. ///////////////////////////////////////////////////////////////////////////////////////////////////
  259. ///////////////////////////////////////////////////////////////////////////////////////////////////
  260. void CAudioSystemImpl_wwise::OnAudioSystemLoseFocus()
  261. {
  262. #if AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
  263. AKRESULT akResult = AK::SoundEngine::Suspend();
  264. if (!IS_WWISE_OK(akResult))
  265. {
  266. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to Suspend, AKRESULT = %d\n", akResult);
  267. }
  268. #endif // AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
  269. }
  270. ///////////////////////////////////////////////////////////////////////////////////////////////////
  271. void CAudioSystemImpl_wwise::OnAudioSystemGetFocus()
  272. {
  273. #if AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
  274. AKRESULT akResult = AK::SoundEngine::WakeupFromSuspend();
  275. if (!IS_WWISE_OK(akResult))
  276. {
  277. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to WakeupFromSuspend, AKRESULT = %d\n", akResult);
  278. }
  279. #endif // AZ_TRAIT_AUDIOENGINEWWISE_AUDIOSYSTEMIMPL_USE_SUSPEND
  280. }
  281. ///////////////////////////////////////////////////////////////////////////////////////////////////
  282. void CAudioSystemImpl_wwise::OnAudioSystemMuteAll()
  283. {
  284. // With Wwise we drive this via events.
  285. }
  286. ///////////////////////////////////////////////////////////////////////////////////////////////////
  287. void CAudioSystemImpl_wwise::OnAudioSystemUnmuteAll()
  288. {
  289. // With Wwise we drive this via events.
  290. }
  291. ///////////////////////////////////////////////////////////////////////////////////////////////////
  292. void CAudioSystemImpl_wwise::OnAudioSystemRefresh()
  293. {
  294. AKRESULT akResult = AK_Fail;
  295. if (m_initBankID != AK_INVALID_BANK_ID)
  296. {
  297. akResult = AK::SoundEngine::UnloadBank(m_initBankID, nullptr);
  298. if (!IS_WWISE_OK(akResult))
  299. {
  300. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to unload %s, returned the AKRESULT: %d", Wwise::InitBank, akResult);
  301. AZ_Assert(false, "<Wwise> Failed to unload %s!", Wwise::InitBank);
  302. }
  303. }
  304. AkOSChar* initBankName = nullptr;
  305. CONVERT_CHAR_TO_OSCHAR(Wwise::InitBank, initBankName);
  306. akResult = AK::SoundEngine::LoadBank(initBankName, m_initBankID);
  307. if (!IS_WWISE_OK(akResult))
  308. {
  309. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to load %s, returned the AKRESULT: %d", Wwise::InitBank, akResult);
  310. m_initBankID = AK_INVALID_BANK_ID;
  311. AZ_Assert(false, "<Wwise> Failed to load %s!", Wwise::InitBank);
  312. }
  313. }
  314. ///////////////////////////////////////////////////////////////////////////////////////////////////
  315. // AudioSystemImplementationRequestBus
  316. ///////////////////////////////////////////////////////////////////////////////////////////////////
  317. ///////////////////////////////////////////////////////////////////////////////////////////////////
  318. void CAudioSystemImpl_wwise::Update([[maybe_unused]] const float updateIntervalMS)
  319. {
  320. AZ_PROFILE_FUNCTION(AZ::Debug::ProfileCategory::Audio);
  321. if (AK::SoundEngine::IsInitialized())
  322. {
  323. #if !defined(WWISE_RELEASE)
  324. AKRESULT akResult = AK_Fail;
  325. static bool enableOutputCapture = false;
  326. if (Wwise::Cvars::s_EnableOutputCapture && !enableOutputCapture)
  327. {
  328. // This file ends up in the cache folder
  329. // Need to disable this on LTX, it produces garbage output. But there's no way to "IsLTX()" yet.
  330. akResult = AK::SoundEngine::StartOutputCapture(AKTEXT("../wwise_audio_capture.wav"));
  331. AZ_Assert(IS_WWISE_OK(akResult), "AK::SoundEngine::StartOutputCapture failed!");
  332. enableOutputCapture = Wwise::Cvars::s_EnableOutputCapture;
  333. }
  334. else if (!Wwise::Cvars::s_EnableOutputCapture && enableOutputCapture)
  335. {
  336. akResult = AK::SoundEngine::StopOutputCapture();
  337. AZ_Assert(IS_WWISE_OK(akResult), "AK::SoundEngine::StopOutputCapture failed!");
  338. enableOutputCapture = Wwise::Cvars::s_EnableOutputCapture;
  339. }
  340. if (audioDeviceInitializationEvent)
  341. {
  342. AkChannelConfig channelConfig = AK::SoundEngine::GetSpeakerConfiguration();
  343. int surroundSpeakers = channelConfig.uNumChannels;
  344. int lfeSpeakers = 0;
  345. if (AK::HasLFE(channelConfig.uChannelMask))
  346. {
  347. --surroundSpeakers;
  348. ++lfeSpeakers;
  349. }
  350. m_speakerConfigString = AZStd::string::format("Output: %d.%d", surroundSpeakers, lfeSpeakers);
  351. m_fullImplString = AZStd::string::format("%s (%s) %s", WWISE_IMPL_VERSION_STRING, m_soundbankFolder.c_str(), m_speakerConfigString.c_str());
  352. audioDeviceInitializationEvent = false;
  353. }
  354. #endif // !WWISE_RELEASE
  355. AK::SoundEngine::RenderAudio();
  356. }
  357. }
  358. ///////////////////////////////////////////////////////////////////////////////////////////////////
  359. EAudioRequestStatus CAudioSystemImpl_wwise::Initialize()
  360. {
  361. // If something fails so severely during initialization that we need to fall back to a 'Null' implementation
  362. // we will need to shut down what has been initialized so far. Therefore make sure to call Shutdown() before returning eARS_FAILURE!
  363. AkMemSettings akMemSettings;
  364. AK::MemoryMgr::GetDefaultSettings(akMemSettings);
  365. akMemSettings.pfMalloc = Wwise::MemHooks::Malloc;
  366. akMemSettings.pfMalign = Wwise::MemHooks::Malign;
  367. akMemSettings.pfRealloc = Wwise::MemHooks::Realloc;
  368. akMemSettings.pfReallocAligned = Wwise::MemHooks::ReallocAligned;
  369. akMemSettings.pfFree = Wwise::MemHooks::Free;
  370. akMemSettings.pfTotalReservedMemorySize = Wwise::MemHooks::TotalReservedMemorySize;
  371. akMemSettings.pfSizeOfMemory = Wwise::MemHooks::SizeOfMemory;
  372. akMemSettings.uMemAllocationSizeLimit = Wwise::Cvars::s_PrimaryMemorySize << 10;
  373. AKRESULT akResult = AK::MemoryMgr::Init(&akMemSettings);
  374. if (!IS_WWISE_OK(akResult))
  375. {
  376. g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::MemoryMgr::Init() returned AKRESULT %d", akResult);
  377. ShutDown();
  378. return eARS_FAILURE;
  379. }
  380. akResult = AK::SoundEngine::RegisterAudioDeviceStatusCallback(AudioDeviceCallback);
  381. if (!IS_WWISE_OK(akResult))
  382. {
  383. g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::RegisterAudioDeviceStatusCallback failed!\n");
  384. }
  385. AkStreamMgrSettings akStreamSettings;
  386. AK::StreamMgr::GetDefaultSettings(akStreamSettings);
  387. if (AK::StreamMgr::Create(akStreamSettings) == nullptr)
  388. {
  389. g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::StreamMgr::Create() failed!\n");
  390. ShutDown();
  391. return eARS_FAILURE;
  392. }
  393. akResult = m_fileIOHandler.Init(Wwise::Cvars::s_StreamDeviceMemorySize << 10);
  394. if (!IS_WWISE_OK(akResult))
  395. {
  396. g_audioImplLogger_wwise.Log(eALT_ERROR, "m_fileIOHandler.Init() returned AKRESULT %d", akResult);
  397. ShutDown();
  398. return eARS_FAILURE;
  399. }
  400. m_fileIOHandler.SetBankPath(m_soundbankFolder.c_str());
  401. AkInitSettings akInitSettings;
  402. AK::SoundEngine::GetDefaultInitSettings(akInitSettings);
  403. akInitSettings.uCommandQueueSize = aznumeric_cast<AkUInt32>(Wwise::Cvars::s_CommandQueueMemorySize << 10);
  404. #if !defined(WWISE_RELEASE)
  405. akInitSettings.uMonitorQueuePoolSize = aznumeric_cast<AkUInt32>(Wwise::Cvars::s_MonitorQueueMemorySize << 10);
  406. #endif // !WWISE_RELEASE
  407. akInitSettings.bEnableGameSyncPreparation = false;
  408. #if AZ_TRAIT_AUDIOENGINEWWISE_DEFAULT_SPEAKER_CONFIGURATION
  409. akInitSettings.settingsMainOutput.channelConfig.SetStandardOrAnonymous(
  410. AK::ChannelMaskToNumChannels(AZ_TRAIT_AUDIOENGINEWWISE_DEFAULT_SPEAKER_CONFIGURATION),
  411. AZ_TRAIT_AUDIOENGINEWWISE_DEFAULT_SPEAKER_CONFIGURATION);
  412. #endif
  413. AkPlatformInitSettings akPlatformInitSettings;
  414. AK::SoundEngine::GetDefaultPlatformInitSettings(akPlatformInitSettings);
  415. Platform::SetupAkSoundEngine(akPlatformInitSettings);
  416. akResult = AK::SoundEngine::Init(&akInitSettings, &akPlatformInitSettings);
  417. if (!IS_WWISE_OK(akResult))
  418. {
  419. g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::SoundEngine::Init() returned AKRESULT %d", akResult);
  420. ShutDown();
  421. return eARS_FAILURE;
  422. }
  423. AkMusicSettings akMusicSettings;
  424. AK::MusicEngine::GetDefaultInitSettings(akMusicSettings);
  425. akResult = AK::MusicEngine::Init(&akMusicSettings);
  426. if (!IS_WWISE_OK(akResult))
  427. {
  428. g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::MusicEngine::Init() returned AKRESULT %d", akResult);
  429. ShutDown();
  430. return eARS_FAILURE;
  431. }
  432. AkSpatialAudioInitSettings akSpatialAudioSettings;
  433. akResult = AK::SpatialAudio::Init(akSpatialAudioSettings);
  434. if (!IS_WWISE_OK(akResult))
  435. {
  436. g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::SpatialAudio::Init() returned AKRESULT %d", akResult);
  437. ShutDown();
  438. return eARS_FAILURE;
  439. }
  440. #if !defined(WWISE_RELEASE)
  441. if (Audio::Wwise::Cvars::s_EnableCommSystem)
  442. {
  443. m_isCommSystemInitialized = true;
  444. AkCommSettings akCommSettings;
  445. AK::Comm::GetDefaultInitSettings(akCommSettings);
  446. akResult = AK::Comm::Init(akCommSettings);
  447. if (!IS_WWISE_OK(akResult))
  448. {
  449. 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);
  450. m_isCommSystemInitialized = false;
  451. }
  452. akResult = AK::Monitor::SetLocalOutput(AK::Monitor::ErrorLevel_All, ErrorMonitorCallback);
  453. if (!IS_WWISE_OK(akResult))
  454. {
  455. AK::Comm::Term();
  456. g_audioImplLogger_wwise.Log(eALT_ERROR, "AK::Monitor::SetLocalOutput() returned AKRESULT %d", akResult);
  457. m_isCommSystemInitialized = false;
  458. }
  459. }
  460. #endif // !WWISE_RELEASE
  461. // Initialize the AudioSourceManager
  462. AudioSourceManager::Get().Initialize();
  463. // Register the Global Audio Object used for the events that don't need a location in the game world
  464. akResult = AK::SoundEngine::RegisterGameObj(m_globalGameObjectID, WwiseGlobalAudioObjectName);
  465. if (!IS_WWISE_OK(akResult))
  466. {
  467. g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::RegisterGameObject() failed for '%s' with AKRESULT %d", WwiseGlobalAudioObjectName, akResult);
  468. }
  469. // Load init.bnk before making the system available to the users
  470. AkOSChar* initBankName = nullptr;
  471. CONVERT_CHAR_TO_OSCHAR(Wwise::InitBank, initBankName);
  472. akResult = AK::SoundEngine::LoadBank(initBankName, m_initBankID);
  473. if (!IS_WWISE_OK(akResult))
  474. {
  475. // This does not qualify for a fallback to the 'Null' audio implementation!
  476. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to load %s, returned AKRESULT %d", Wwise::InitBank, akResult);
  477. m_initBankID = AK_INVALID_BANK_ID;
  478. }
  479. return eARS_SUCCESS;
  480. }
  481. ///////////////////////////////////////////////////////////////////////////////////////////////////
  482. EAudioRequestStatus CAudioSystemImpl_wwise::ShutDown()
  483. {
  484. AKRESULT akResult = AK_Fail;
  485. #if !defined(WWISE_RELEASE)
  486. if (m_isCommSystemInitialized)
  487. {
  488. AK::Comm::Term();
  489. akResult = AK::Monitor::SetLocalOutput(0, nullptr);
  490. if (!IS_WWISE_OK(akResult))
  491. {
  492. g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::Monitor::SetLocalOutput() returned AKRESULT %d", akResult);
  493. }
  494. m_isCommSystemInitialized = false;
  495. }
  496. #endif // !WWISE_RELEASE
  497. akResult = AK::SoundEngine::UnregisterAudioDeviceStatusCallback();
  498. if (akResult != AK_Success)
  499. {
  500. g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::UnregisterAudioDeviceStatusCallback failed!\n");
  501. }
  502. // Shutdown the AudioSourceManager
  503. AudioSourceManager::Get().Shutdown();
  504. AK::MusicEngine::Term();
  505. if (AK::SoundEngine::IsInitialized())
  506. {
  507. // UnRegister the DummyGameObject
  508. akResult = AK::SoundEngine::UnregisterGameObj(m_globalGameObjectID);
  509. if (!IS_WWISE_OK(akResult))
  510. {
  511. g_audioImplLogger_wwise.Log(eALT_WARNING, "AK::SoundEngine::UnregisterGameObject() failed for '%s' with AKRESULT %d", WwiseGlobalAudioObjectName, akResult);
  512. }
  513. akResult = AK::SoundEngine::ClearBanks();
  514. if (!IS_WWISE_OK(akResult))
  515. {
  516. g_audioImplLogger_wwise.Log(eALT_ERROR, "Failed to clear sound banks!");
  517. }
  518. AK::SoundEngine::Term();
  519. }
  520. // Terminate the streaming device and streaming manager
  521. // CAkFilePackageLowLevelIOBlocking::Term() destroys its associated streaming device
  522. // that lives in the Stream Manager, and unregisters itself as the File Location Resolver.
  523. if (AK::IAkStreamMgr::Get())
  524. {
  525. m_fileIOHandler.ShutDown();
  526. AK::IAkStreamMgr::Get()->Destroy();
  527. }
  528. // Terminate the Memory Manager
  529. if (AK::MemoryMgr::IsInitialized())
  530. {
  531. AK::MemoryMgr::Term();
  532. }
  533. return eARS_SUCCESS;
  534. }
  535. ///////////////////////////////////////////////////////////////////////////////////////////////////
  536. EAudioRequestStatus CAudioSystemImpl_wwise::Release()
  537. {
  538. // Deleting this object and destroying the allocator has been moved to AudioEngineWwiseSystemComponent
  539. return eARS_SUCCESS;
  540. }
  541. ///////////////////////////////////////////////////////////////////////////////////////////////////
  542. EAudioRequestStatus CAudioSystemImpl_wwise::StopAllSounds()
  543. {
  544. AK::SoundEngine::StopAll();
  545. return eARS_SUCCESS;
  546. }
  547. ///////////////////////////////////////////////////////////////////////////////////////////////////
  548. EAudioRequestStatus CAudioSystemImpl_wwise::RegisterAudioObject(
  549. IATLAudioObjectData* const audioObjectData,
  550. const char* const objectName)
  551. {
  552. if (audioObjectData)
  553. {
  554. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  555. const AKRESULT akResult = AK::SoundEngine::RegisterGameObj(implObjectData->nAKID, objectName);
  556. const bool akSuccess = IS_WWISE_OK(akResult);
  557. if (!akSuccess)
  558. {
  559. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise RegisterGameObj failed with AKRESULT: %d", akResult);
  560. }
  561. return BoolToARS(akSuccess);
  562. }
  563. else
  564. {
  565. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise RegisterGameObj failed, audioObjectData was null");
  566. return eARS_FAILURE;
  567. }
  568. }
  569. ///////////////////////////////////////////////////////////////////////////////////////////////////
  570. EAudioRequestStatus CAudioSystemImpl_wwise::UnregisterAudioObject(IATLAudioObjectData* const audioObjectData)
  571. {
  572. if (audioObjectData)
  573. {
  574. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  575. const AKRESULT akResult = AK::SoundEngine::UnregisterGameObj(implObjectData->nAKID);
  576. const bool akSuccess = IS_WWISE_OK(akResult);
  577. if (!akSuccess)
  578. {
  579. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise UnregisterGameObj failed with AKRESULT: %d", akResult);
  580. }
  581. return BoolToARS(akSuccess);
  582. }
  583. else
  584. {
  585. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise UnregisterGameObj failed, audioObjectData was null");
  586. return eARS_FAILURE;
  587. }
  588. }
  589. ///////////////////////////////////////////////////////////////////////////////////////////////////
  590. EAudioRequestStatus CAudioSystemImpl_wwise::ResetAudioObject(IATLAudioObjectData* const audioObjectData)
  591. {
  592. if (audioObjectData)
  593. {
  594. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  595. implObjectData->cEnvironmentImplAmounts.clear();
  596. implObjectData->bNeedsToUpdateEnvironments = false;
  597. return eARS_SUCCESS;
  598. }
  599. else
  600. {
  601. g_audioImplLogger_wwise.Log(eALT_WARNING, "Resetting Audio object failed, audioObjectData was null");
  602. return eARS_FAILURE;
  603. }
  604. }
  605. ///////////////////////////////////////////////////////////////////////////////////////////////////
  606. EAudioRequestStatus CAudioSystemImpl_wwise::UpdateAudioObject(IATLAudioObjectData* const audioObjectData)
  607. {
  608. AZ_PROFILE_FUNCTION(AZ::Debug::ProfileCategory::Audio);
  609. EAudioRequestStatus result = eARS_FAILURE;
  610. if (audioObjectData)
  611. {
  612. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  613. if (implObjectData->bNeedsToUpdateEnvironments)
  614. {
  615. result = PostEnvironmentAmounts(implObjectData);
  616. }
  617. }
  618. return result;
  619. }
  620. ///////////////////////////////////////////////////////////////////////////////////////////////////
  621. EAudioRequestStatus CAudioSystemImpl_wwise::PrepareTriggerSync(
  622. [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
  623. const IATLTriggerImplData* const triggerData)
  624. {
  625. return PrepUnprepTriggerSync(triggerData, true);
  626. }
  627. ///////////////////////////////////////////////////////////////////////////////////////////////////
  628. EAudioRequestStatus CAudioSystemImpl_wwise::UnprepareTriggerSync(
  629. [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
  630. const IATLTriggerImplData* const triggerData)
  631. {
  632. return PrepUnprepTriggerSync(triggerData, false);
  633. }
  634. ///////////////////////////////////////////////////////////////////////////////////////////////////
  635. EAudioRequestStatus CAudioSystemImpl_wwise::PrepareTriggerAsync(
  636. [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
  637. const IATLTriggerImplData* const triggerData,
  638. IATLEventData* const eventData)
  639. {
  640. return PrepUnprepTriggerAsync(triggerData, eventData, true);
  641. }
  642. ///////////////////////////////////////////////////////////////////////////////////////////////////
  643. EAudioRequestStatus CAudioSystemImpl_wwise::UnprepareTriggerAsync(
  644. [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
  645. const IATLTriggerImplData* const triggerData,
  646. IATLEventData* const eventData)
  647. {
  648. return PrepUnprepTriggerAsync(triggerData, eventData, false);
  649. }
  650. ///////////////////////////////////////////////////////////////////////////////////////////////////
  651. EAudioRequestStatus CAudioSystemImpl_wwise::ActivateTrigger(
  652. IATLAudioObjectData* const audioObjectData,
  653. const IATLTriggerImplData* const triggerData,
  654. IATLEventData* const eventData,
  655. const SATLSourceData* const sourceData)
  656. {
  657. EAudioRequestStatus result = eARS_FAILURE;
  658. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  659. auto const implTriggerData = static_cast<const SATLTriggerImplData_wwise*>(triggerData);
  660. auto const implEventData = static_cast<SATLEventData_wwise*>(eventData);
  661. if (implObjectData && implTriggerData && implEventData)
  662. {
  663. AkGameObjectID akObjectId = AK_INVALID_GAME_OBJECT;
  664. if (implObjectData->bHasPosition)
  665. {
  666. akObjectId = implObjectData->nAKID;
  667. PostEnvironmentAmounts(implObjectData);
  668. }
  669. else
  670. {
  671. akObjectId = m_globalGameObjectID;
  672. }
  673. AkPlayingID akPlayingId = AK_INVALID_PLAYING_ID;
  674. switch (GetAssetType(sourceData))
  675. {
  676. case eAAT_SOURCE:
  677. {
  678. AZ_Assert(sourceData, "SourceData not provided for source type!");
  679. // format: "external/{collection_id}/{language_id}/{file_id}.wem"
  680. auto filePath = AZStd::string::format("%s" "/%" PRIu64 "/%" PRIu64 "/%" PRIu64 ".wem",
  681. Audio::Wwise::ExternalSourcesPath,
  682. sourceData->m_sourceInfo.m_collectionId,
  683. sourceData->m_sourceInfo.m_languageId,
  684. sourceData->m_sourceInfo.m_fileId);
  685. AkOSChar* finalFilePath = nullptr;
  686. CONVERT_CHAR_TO_OSCHAR(filePath.c_str(), finalFilePath);
  687. AkExternalSourceInfo sources[1];
  688. sources[0].iExternalSrcCookie = static_cast<AkUInt32>(sourceData->m_sourceInfo.m_sourceId);
  689. sources[0].szFile = finalFilePath;
  690. sources[0].idCodec = GetAkCodecID(sourceData->m_sourceInfo.m_codecType);
  691. akPlayingId = AK::SoundEngine::PostEvent(
  692. implTriggerData->nAKID,
  693. akObjectId,
  694. AK_EndOfEvent | AK_Duration,
  695. &WwiseEventCallback,
  696. implEventData,
  697. 1,
  698. sources);
  699. if (akPlayingId != AK_INVALID_PLAYING_ID)
  700. {
  701. implEventData->audioEventState = eAES_PLAYING;
  702. implEventData->nAKID = akPlayingId;
  703. result = eARS_SUCCESS;
  704. }
  705. else
  706. {
  707. // if Posting an Event failed, try to prepare it, if it isn't prepared already
  708. g_audioImplLogger_wwise.Log(eALT_WARNING, "Failed to Post Wwise event %u with external source '%s'",
  709. implTriggerData->nAKID, filePath.c_str());
  710. }
  711. break;
  712. }
  713. case eAAT_STREAM:
  714. [[fallthrough]];
  715. case eAAT_NONE:
  716. [[fallthrough]];
  717. default:
  718. {
  719. akPlayingId = AK::SoundEngine::PostEvent(
  720. implTriggerData->nAKID,
  721. akObjectId,
  722. AK_EndOfEvent | AK_Duration,
  723. &WwiseEventCallback,
  724. implEventData);
  725. if (akPlayingId != AK_INVALID_PLAYING_ID)
  726. {
  727. if (sourceData)
  728. {
  729. TAudioSourceId sourceId = sourceData->m_sourceInfo.m_sourceId;
  730. if (sourceId != INVALID_AUDIO_SOURCE_ID)
  731. {
  732. // Activate the audio input source (associates sourceId w/ playingId)...
  733. AudioSourceManager::Get().ActivateSource(sourceId, akPlayingId);
  734. implEventData->nSourceId = sourceId;
  735. }
  736. }
  737. implEventData->audioEventState = eAES_PLAYING;
  738. implEventData->nAKID = akPlayingId;
  739. result = eARS_SUCCESS;
  740. }
  741. else
  742. {
  743. // if Posting an Event failed, try to prepare it, if it isn't prepared already
  744. g_audioImplLogger_wwise.Log(eALT_WARNING, "Failed to Post Wwise event %u", implTriggerData->nAKID);
  745. }
  746. break;
  747. }
  748. }
  749. }
  750. else
  751. {
  752. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData, ATLTriggerData or EventData passed to the Wwise implementation of ActivateTrigger.");
  753. }
  754. return result;
  755. }
  756. ///////////////////////////////////////////////////////////////////////////////////////////////////
  757. EAudioRequestStatus CAudioSystemImpl_wwise::StopEvent(
  758. [[maybe_unused]] IATLAudioObjectData* const audioObjectData,
  759. const IATLEventData* const eventData)
  760. {
  761. EAudioRequestStatus result = eARS_FAILURE;
  762. auto const implEventData = static_cast<const SATLEventData_wwise*>(eventData);
  763. if (implEventData)
  764. {
  765. switch (implEventData->audioEventState)
  766. {
  767. case eAES_PLAYING:
  768. {
  769. AK::SoundEngine::StopPlayingID(implEventData->nAKID, 10);
  770. result = eARS_SUCCESS;
  771. break;
  772. }
  773. default:
  774. {
  775. g_audioImplLogger_wwise.Log(eALT_ERROR, "Stopping an event of this type is not supported yet");
  776. break;
  777. }
  778. }
  779. }
  780. else
  781. {
  782. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid EventData passed to the Wwise implementation of StopEvent.");
  783. }
  784. return result;
  785. }
  786. ///////////////////////////////////////////////////////////////////////////////////////////////////
  787. EAudioRequestStatus CAudioSystemImpl_wwise::StopAllEvents(IATLAudioObjectData* const audioObjectData)
  788. {
  789. EAudioRequestStatus result = eARS_FAILURE;
  790. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  791. if (implObjectData)
  792. {
  793. const AkGameObjectID akObjectId = implObjectData->bHasPosition ? implObjectData->nAKID : m_globalGameObjectID;
  794. AK::SoundEngine::StopAll(akObjectId);
  795. result = eARS_SUCCESS;
  796. }
  797. else
  798. {
  799. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of StopAllEvents.");
  800. }
  801. return result;
  802. }
  803. ///////////////////////////////////////////////////////////////////////////////////////////////////
  804. EAudioRequestStatus CAudioSystemImpl_wwise::SetPosition(
  805. IATLAudioObjectData* const audioObjectData,
  806. const SATLWorldPosition& worldPosition)
  807. {
  808. EAudioRequestStatus result = eARS_FAILURE;
  809. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  810. if (implObjectData)
  811. {
  812. AkSoundPosition akSoundPos;
  813. ATLTransformToAkTransform(worldPosition, akSoundPos);
  814. const AKRESULT akResult = AK::SoundEngine::SetPosition(implObjectData->nAKID, akSoundPos);
  815. if (IS_WWISE_OK(akResult))
  816. {
  817. result = eARS_SUCCESS;
  818. }
  819. else
  820. {
  821. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise SetPosition failed with AKRESULT: %d", akResult);
  822. }
  823. }
  824. else
  825. {
  826. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of SetPosition.");
  827. }
  828. return result;
  829. }
  830. ///////////////////////////////////////////////////////////////////////////////////////////////////
  831. EAudioRequestStatus CAudioSystemImpl_wwise::SetMultiplePositions(
  832. IATLAudioObjectData* const audioObjectData,
  833. const MultiPositionParams& multiPositionParams)
  834. {
  835. EAudioRequestStatus result = eARS_FAILURE;
  836. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  837. if (implObjectData)
  838. {
  839. AZStd::vector<AkSoundPosition> akPositions;
  840. AZStd::for_each(multiPositionParams.m_positions.begin(), multiPositionParams.m_positions.end(),
  841. [&akPositions](const auto& position)
  842. {
  843. akPositions.emplace_back(AZVec3ToAkTransform(position));
  844. }
  845. );
  846. AK::SoundEngine::MultiPositionType type = AK::SoundEngine::MultiPositionType_MultiDirections; // default 'Blended'
  847. if (multiPositionParams.m_type == MultiPositionBehaviorType::Separate)
  848. {
  849. type = AK::SoundEngine::MultiPositionType_MultiSources;
  850. }
  851. const AKRESULT akResult = AK::SoundEngine::SetMultiplePositions(implObjectData->nAKID, akPositions.data(), static_cast<AkUInt16>(akPositions.size()), type);
  852. if (IS_WWISE_OK(akResult))
  853. {
  854. result = eARS_SUCCESS;
  855. }
  856. else
  857. {
  858. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise SetMultiplePositions failed with AKRESULT: %d\n", akResult);
  859. }
  860. }
  861. else
  862. {
  863. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of SetMultiplePositions.");
  864. }
  865. return result;
  866. }
  867. ///////////////////////////////////////////////////////////////////////////////////////////////////
  868. EAudioRequestStatus CAudioSystemImpl_wwise::SetEnvironment(
  869. IATLAudioObjectData* const audioObjectData,
  870. const IATLEnvironmentImplData* const environmentData,
  871. const float amount)
  872. {
  873. static const float s_envEpsilon = 0.0001f;
  874. EAudioRequestStatus result = eARS_FAILURE;
  875. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  876. auto const implEnvironmentData = static_cast<const SATLEnvironmentImplData_wwise*>(environmentData);
  877. if (implObjectData && implEnvironmentData)
  878. {
  879. switch (implEnvironmentData->eType)
  880. {
  881. case eWAET_AUX_BUS:
  882. {
  883. float currentAmount = -1.f;
  884. auto it = implObjectData->cEnvironmentImplAmounts.find(implEnvironmentData->nAKBusID);
  885. if (it != implObjectData->cEnvironmentImplAmounts.end())
  886. {
  887. currentAmount = it->second;
  888. }
  889. if (currentAmount == -1.f || !AZ::IsClose(currentAmount, amount, s_envEpsilon))
  890. {
  891. implObjectData->cEnvironmentImplAmounts[implEnvironmentData->nAKBusID] = amount;
  892. implObjectData->bNeedsToUpdateEnvironments = true;
  893. }
  894. result = eARS_SUCCESS;
  895. break;
  896. }
  897. case eWAET_RTPC:
  898. {
  899. auto akRtpcValue = static_cast<AkRtpcValue>(implEnvironmentData->fMult * amount + implEnvironmentData->fShift);
  900. const AKRESULT akResult = AK::SoundEngine::SetRTPCValue(implEnvironmentData->nAKRtpcID, akRtpcValue, implObjectData->nAKID);
  901. if (IS_WWISE_OK(akResult))
  902. {
  903. result = eARS_SUCCESS;
  904. }
  905. else
  906. {
  907. g_audioImplLogger_wwise.Log(
  908. eALT_WARNING,
  909. "Wwise failed to set the Rtpc %u to value %f on object %u in SetEnvironement()",
  910. implEnvironmentData->nAKRtpcID,
  911. akRtpcValue,
  912. implObjectData->nAKID);
  913. }
  914. break;
  915. }
  916. default:
  917. {
  918. AZ_Assert(false, "<Wwise> Unknown AudioEnvironmentImplementation type!");
  919. }
  920. }
  921. }
  922. else
  923. {
  924. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or EnvironmentData passed to the Wwise implementation of SetEnvironment");
  925. }
  926. return result;
  927. }
  928. ///////////////////////////////////////////////////////////////////////////////////////////////////
  929. EAudioRequestStatus CAudioSystemImpl_wwise::SetRtpc(
  930. IATLAudioObjectData* const audioObjectData,
  931. const IATLRtpcImplData* const rtpcData,
  932. const float value)
  933. {
  934. EAudioRequestStatus result = eARS_FAILURE;
  935. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  936. auto const implRtpcData = static_cast<const SATLRtpcImplData_wwise*>(rtpcData);
  937. if (implObjectData && implRtpcData)
  938. {
  939. auto akRtpcValue = static_cast<AkRtpcValue>(implRtpcData->m_fMult * value + implRtpcData->m_fShift);
  940. const AKRESULT akResult = AK::SoundEngine::SetRTPCValue(implRtpcData->nAKID, akRtpcValue, implObjectData->nAKID);
  941. if (IS_WWISE_OK(akResult))
  942. {
  943. result = eARS_SUCCESS;
  944. }
  945. else
  946. {
  947. g_audioImplLogger_wwise.Log(
  948. eALT_WARNING,
  949. "Wwise failed to set the Rtpc %llu to value %f on object %llu",
  950. implRtpcData->nAKID,
  951. static_cast<AkRtpcValue>(value),
  952. implObjectData->nAKID);
  953. }
  954. }
  955. else
  956. {
  957. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or RtpcData passed to the Wwise implementation of SetRtpc");
  958. }
  959. return result;
  960. }
  961. ///////////////////////////////////////////////////////////////////////////////////////////////////
  962. EAudioRequestStatus CAudioSystemImpl_wwise::SetSwitchState(
  963. IATLAudioObjectData* const audioObjectData,
  964. const IATLSwitchStateImplData* const switchStateData)
  965. {
  966. EAudioRequestStatus result = eARS_FAILURE;
  967. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  968. auto const implSwitchStateData = static_cast<const SATLSwitchStateImplData_wwise*>(switchStateData);
  969. if (implObjectData && implSwitchStateData)
  970. {
  971. switch (implSwitchStateData->eType)
  972. {
  973. case eWST_SWITCH:
  974. {
  975. const AkGameObjectID akObjectId = implObjectData->bHasPosition ? implObjectData->nAKID : m_globalGameObjectID;
  976. const AKRESULT akResult = AK::SoundEngine::SetSwitch(
  977. implSwitchStateData->nAKSwitchID,
  978. implSwitchStateData->nAKStateID,
  979. akObjectId);
  980. if (IS_WWISE_OK(akResult))
  981. {
  982. result = eARS_SUCCESS;
  983. }
  984. else
  985. {
  986. g_audioImplLogger_wwise.Log(
  987. eALT_WARNING,
  988. "Wwise failed to set the switch group %u to state %u on object %llu",
  989. implSwitchStateData->nAKSwitchID,
  990. implSwitchStateData->nAKStateID,
  991. akObjectId);
  992. }
  993. break;
  994. }
  995. case eWST_STATE:
  996. {
  997. const AKRESULT akResult = AK::SoundEngine::SetState(
  998. implSwitchStateData->nAKSwitchID,
  999. implSwitchStateData->nAKStateID);
  1000. if (IS_WWISE_OK(akResult))
  1001. {
  1002. result = eARS_SUCCESS;
  1003. }
  1004. else
  1005. {
  1006. g_audioImplLogger_wwise.Log(
  1007. eALT_WARNING,
  1008. "Wwise failed to set the state group %u to state %u",
  1009. implSwitchStateData->nAKSwitchID,
  1010. implSwitchStateData->nAKStateID);
  1011. }
  1012. break;
  1013. }
  1014. case eWST_RTPC:
  1015. {
  1016. const AkGameObjectID akObjectId = implObjectData->nAKID;
  1017. const AKRESULT akResult = AK::SoundEngine::SetRTPCValue(
  1018. implSwitchStateData->nAKSwitchID,
  1019. static_cast<AkRtpcValue>(implSwitchStateData->fRtpcValue),
  1020. akObjectId);
  1021. if (IS_WWISE_OK(akResult))
  1022. {
  1023. result = eARS_SUCCESS;
  1024. }
  1025. else
  1026. {
  1027. g_audioImplLogger_wwise.Log(
  1028. eALT_WARNING,
  1029. "Wwise failed to set the Rtpc %u to value %f on object %llu",
  1030. implSwitchStateData->nAKSwitchID,
  1031. static_cast<AkRtpcValue>(implSwitchStateData->fRtpcValue),
  1032. akObjectId);
  1033. }
  1034. break;
  1035. }
  1036. case eWST_NONE:
  1037. {
  1038. break;
  1039. }
  1040. default:
  1041. {
  1042. g_audioImplLogger_wwise.Log(eALT_WARNING, "Unknown EWwiseSwitchType: %u", implSwitchStateData->eType);
  1043. AZ_Assert(false, "<Wwise> Unknown EWwiseSwitchType");
  1044. break;
  1045. }
  1046. }
  1047. }
  1048. else
  1049. {
  1050. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or RtpcData passed to the Wwise implementation of SetRtpc");
  1051. }
  1052. return result;
  1053. }
  1054. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1055. EAudioRequestStatus CAudioSystemImpl_wwise::SetObstructionOcclusion(
  1056. IATLAudioObjectData* const audioObjectData,
  1057. const float obstruction,
  1058. const float occlusion)
  1059. {
  1060. if (obstruction < ObstructionOcclusionMin || obstruction > ObstructionOcclusionMax)
  1061. {
  1062. g_audioImplLogger_wwise.Log(
  1063. eALT_WARNING,
  1064. "Obstruction value %f is out of range, Obstruction should be between %f and %f.",
  1065. obstruction, ObstructionOcclusionMin, ObstructionOcclusionMax);
  1066. }
  1067. if (occlusion < ObstructionOcclusionMin || occlusion > ObstructionOcclusionMax)
  1068. {
  1069. g_audioImplLogger_wwise.Log(
  1070. eALT_WARNING,
  1071. "Occlusion value %f is out of range, Occlusion should be between %f and %f.",
  1072. occlusion, ObstructionOcclusionMin, ObstructionOcclusionMax);
  1073. }
  1074. EAudioRequestStatus result = eARS_FAILURE;
  1075. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  1076. if (implObjectData)
  1077. {
  1078. const AKRESULT akResult = AK::SoundEngine::SetObjectObstructionAndOcclusion(
  1079. implObjectData->nAKID,
  1080. m_defaultListenerGameObjectID, // only set the obstruction/occlusion for the default listener for now
  1081. static_cast<AkReal32>(obstruction),
  1082. static_cast<AkReal32>(occlusion));
  1083. if (IS_WWISE_OK(akResult))
  1084. {
  1085. result = eARS_SUCCESS;
  1086. }
  1087. else
  1088. {
  1089. g_audioImplLogger_wwise.Log(
  1090. eALT_WARNING,
  1091. "Wwise failed to set Obstruction %f and Occlusion %f on object %llu",
  1092. obstruction,
  1093. occlusion,
  1094. implObjectData->nAKID);
  1095. }
  1096. }
  1097. else
  1098. {
  1099. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData passed to the Wwise implementation of SetObjectObstructionAndOcclusion");
  1100. }
  1101. return result;
  1102. }
  1103. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1104. EAudioRequestStatus CAudioSystemImpl_wwise::SetListenerPosition(
  1105. IATLListenerData* const listenerData,
  1106. const SATLWorldPosition& newPosition)
  1107. {
  1108. EAudioRequestStatus result = eARS_FAILURE;
  1109. auto const implListenerData = static_cast<SATLListenerData_wwise*>(listenerData);
  1110. if (implListenerData)
  1111. {
  1112. AkListenerPosition akListenerPos;
  1113. ATLTransformToAkTransform(newPosition, akListenerPos);
  1114. const AKRESULT akResult = AK::SoundEngine::SetPosition(implListenerData->nAKListenerObjectId, akListenerPos);
  1115. if (IS_WWISE_OK(akResult))
  1116. {
  1117. result = eARS_SUCCESS;
  1118. }
  1119. else
  1120. {
  1121. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise SetListenerPosition failed with AKRESULT: %u", akResult);
  1122. }
  1123. }
  1124. else
  1125. {
  1126. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid ATLListenerData passed to the Wwise implementation of SetListenerPosition");
  1127. }
  1128. return result;
  1129. }
  1130. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1131. EAudioRequestStatus CAudioSystemImpl_wwise::ResetRtpc(IATLAudioObjectData* const audioObjectData, const IATLRtpcImplData* const rtpcData)
  1132. {
  1133. EAudioRequestStatus result = eARS_FAILURE;
  1134. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  1135. auto const implRtpcDat = static_cast<const SATLRtpcImplData_wwise*>(rtpcData);
  1136. if (implObjectData && implRtpcDat)
  1137. {
  1138. const AKRESULT akResult = AK::SoundEngine::ResetRTPCValue(implRtpcDat->nAKID, implObjectData->nAKID);
  1139. if (IS_WWISE_OK(akResult))
  1140. {
  1141. result = eARS_SUCCESS;
  1142. }
  1143. else
  1144. {
  1145. g_audioImplLogger_wwise.Log(
  1146. eALT_WARNING,
  1147. "Wwise failed to reset the Rtpc %u on object %llu",
  1148. implRtpcDat->nAKID,
  1149. implObjectData->nAKID);
  1150. }
  1151. }
  1152. else
  1153. {
  1154. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioObjectData or RtpcData passed to the Wwise implementation of ResetRtpc");
  1155. }
  1156. return result;
  1157. }
  1158. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1159. EAudioRequestStatus CAudioSystemImpl_wwise::RegisterInMemoryFile(SATLAudioFileEntryInfo* const fileEntryInfo)
  1160. {
  1161. EAudioRequestStatus result = eARS_FAILURE;
  1162. if (fileEntryInfo)
  1163. {
  1164. auto const implFileEntryData = static_cast<SATLAudioFileEntryData_wwise*>(fileEntryInfo->pImplData);
  1165. if (implFileEntryData)
  1166. {
  1167. AkBankID akBankId = AK_INVALID_BANK_ID;
  1168. const AKRESULT akResult = AK::SoundEngine::LoadBankMemoryView(
  1169. fileEntryInfo->pFileData,
  1170. aznumeric_cast<AkUInt32>(fileEntryInfo->nSize),
  1171. akBankId);
  1172. if (IS_WWISE_OK(akResult))
  1173. {
  1174. implFileEntryData->nAKBankID = akBankId;
  1175. result = eARS_SUCCESS;
  1176. }
  1177. else
  1178. {
  1179. implFileEntryData->nAKBankID = AK_INVALID_BANK_ID;
  1180. g_audioImplLogger_wwise.Log(eALT_ERROR, "Failed to load file %s\n", fileEntryInfo->sFileName);
  1181. }
  1182. }
  1183. else
  1184. {
  1185. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioFileEntryData passed to the Wwise implementation of RegisterInMemoryFile");
  1186. }
  1187. }
  1188. return result;
  1189. }
  1190. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1191. EAudioRequestStatus CAudioSystemImpl_wwise::UnregisterInMemoryFile(SATLAudioFileEntryInfo* const fileEntryInfo)
  1192. {
  1193. EAudioRequestStatus result = eARS_FAILURE;
  1194. if (fileEntryInfo)
  1195. {
  1196. auto const implFileEntryData = static_cast<SATLAudioFileEntryData_wwise*>(fileEntryInfo->pImplData);
  1197. if (implFileEntryData)
  1198. {
  1199. const AKRESULT akResult = AK::SoundEngine::UnloadBank(implFileEntryData->nAKBankID, fileEntryInfo->pFileData);
  1200. if (IS_WWISE_OK(akResult))
  1201. {
  1202. result = eARS_SUCCESS;
  1203. }
  1204. else
  1205. {
  1206. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise Failed to unregister in memory file %s\n", fileEntryInfo->sFileName);
  1207. }
  1208. }
  1209. else
  1210. {
  1211. g_audioImplLogger_wwise.Log(eALT_ERROR, "Invalid AudioFileEntryData passed to the Wwise implementation of UnregisterInMemoryFile");
  1212. }
  1213. }
  1214. return result;
  1215. }
  1216. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1217. EAudioRequestStatus CAudioSystemImpl_wwise::ParseAudioFileEntry(const AZ::rapidxml::xml_node<char>* audioFileEntryNode, SATLAudioFileEntryInfo* const fileEntryInfo)
  1218. {
  1219. EAudioRequestStatus result = eARS_FAILURE;
  1220. if (audioFileEntryNode && azstricmp(audioFileEntryNode->name(), WwiseXmlTags::WwiseFileTag) == 0 && fileEntryInfo)
  1221. {
  1222. const char* audioFileEntryName = nullptr;
  1223. auto fileEntryNameAttr = audioFileEntryNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1224. if (fileEntryNameAttr)
  1225. {
  1226. audioFileEntryName = fileEntryNameAttr->value();
  1227. }
  1228. bool isLocalized = false;
  1229. auto localizedAttr = audioFileEntryNode->first_attribute(WwiseXmlTags::WwiseLocalizedAttribute, 0, false);
  1230. // Legacy Preload support
  1231. if (!localizedAttr)
  1232. {
  1233. localizedAttr = audioFileEntryNode->first_attribute(WwiseXmlTags::Legacy::WwiseLocalizedAttribute, 0, false);
  1234. }
  1235. if (localizedAttr)
  1236. {
  1237. if (azstricmp(localizedAttr->value(), "true") == 0)
  1238. {
  1239. isLocalized = true;
  1240. }
  1241. }
  1242. if (audioFileEntryName && audioFileEntryName[0] != '\0')
  1243. {
  1244. fileEntryInfo->bLocalized = isLocalized;
  1245. fileEntryInfo->sFileName = audioFileEntryName;
  1246. fileEntryInfo->nMemoryBlockAlignment = AK_BANK_PLATFORM_DATA_ALIGNMENT;
  1247. fileEntryInfo->pImplData = azcreate(SATLAudioFileEntryData_wwise, (), Audio::AudioImplAllocator, "ATLAudioFileEntryData_wwise");
  1248. result = eARS_SUCCESS;
  1249. }
  1250. else
  1251. {
  1252. fileEntryInfo->sFileName = nullptr;
  1253. fileEntryInfo->nMemoryBlockAlignment = 0;
  1254. fileEntryInfo->pImplData = nullptr;
  1255. }
  1256. }
  1257. return result;
  1258. }
  1259. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1260. void CAudioSystemImpl_wwise::DeleteAudioFileEntryData(IATLAudioFileEntryData* const oldAudioFileEntry)
  1261. {
  1262. azdestroy(oldAudioFileEntry, Audio::AudioImplAllocator, SATLAudioFileEntryData_wwise);
  1263. }
  1264. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1265. const char* const CAudioSystemImpl_wwise::GetAudioFileLocation(SATLAudioFileEntryInfo* const fileEntryInfo)
  1266. {
  1267. const char* location = nullptr;
  1268. if (fileEntryInfo)
  1269. {
  1270. location = fileEntryInfo->bLocalized ? m_localizedSoundbankFolder.c_str() : m_soundbankFolder.c_str();
  1271. }
  1272. return location;
  1273. }
  1274. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1275. SATLAudioObjectData_wwise* CAudioSystemImpl_wwise::NewGlobalAudioObjectData(const TAudioObjectID objectId)
  1276. {
  1277. AZ_UNUSED(objectId);
  1278. auto newObjectData = azcreate(SATLAudioObjectData_wwise, (AK_INVALID_GAME_OBJECT, false), Audio::AudioImplAllocator, "ATLAudioObjectData_wwise-Global");
  1279. return newObjectData;
  1280. }
  1281. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1282. SATLAudioObjectData_wwise* CAudioSystemImpl_wwise::NewAudioObjectData(const TAudioObjectID objectId)
  1283. {
  1284. auto newObjectData = azcreate(SATLAudioObjectData_wwise, (static_cast<AkGameObjectID>(objectId), true), Audio::AudioImplAllocator, "ATLAudioObjectData_wwise");
  1285. return newObjectData;
  1286. }
  1287. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1288. void CAudioSystemImpl_wwise::DeleteAudioObjectData(IATLAudioObjectData* const oldObjectData)
  1289. {
  1290. azdestroy(oldObjectData, Audio::AudioImplAllocator, SATLAudioObjectData_wwise);
  1291. }
  1292. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1293. SATLListenerData_wwise* CAudioSystemImpl_wwise::NewDefaultAudioListenerObjectData(const TATLIDType listenerId)
  1294. {
  1295. auto newObjectData = azcreate(SATLListenerData_wwise, (static_cast<AkGameObjectID>(listenerId)), Audio::AudioImplAllocator, "ATLListenerData_wwise-Default");
  1296. if (newObjectData)
  1297. {
  1298. auto listenerName = AZStd::string::format("DefaultAudioListener(%" PRIu64 ")", static_cast<AZ::u64>(newObjectData->nAKListenerObjectId));
  1299. AKRESULT akResult = AK::SoundEngine::RegisterGameObj(newObjectData->nAKListenerObjectId, listenerName.c_str());
  1300. if (IS_WWISE_OK(akResult))
  1301. {
  1302. akResult = AK::SoundEngine::SetDefaultListeners(&newObjectData->nAKListenerObjectId, 1);
  1303. if (IS_WWISE_OK(akResult))
  1304. {
  1305. m_defaultListenerGameObjectID = newObjectData->nAKListenerObjectId;
  1306. }
  1307. else
  1308. {
  1309. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in SetDefaultListeners to set AkGameObjectID %llu as default with AKRESULT: %u", newObjectData->nAKListenerObjectId, akResult);
  1310. }
  1311. }
  1312. else
  1313. {
  1314. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in RegisterGameObj registering a DefaultAudioListener with AKRESULT: %u", akResult);
  1315. }
  1316. }
  1317. return newObjectData;
  1318. }
  1319. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1320. SATLListenerData_wwise* CAudioSystemImpl_wwise::NewAudioListenerObjectData(const TATLIDType listenerId)
  1321. {
  1322. auto newObjectData = azcreate(SATLListenerData_wwise, (static_cast<AkGameObjectID>(listenerId)), Audio::AudioImplAllocator, "ATLListenerData_wwise");
  1323. if (newObjectData)
  1324. {
  1325. auto listenerName = AZStd::string::format("AudioListener(%" PRIu64 ")", static_cast<AZ::u64>(newObjectData->nAKListenerObjectId));
  1326. AKRESULT akResult = AK::SoundEngine::RegisterGameObj(newObjectData->nAKListenerObjectId, listenerName.c_str());
  1327. if (!IS_WWISE_OK(akResult))
  1328. {
  1329. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in RegisterGameObj registering an AudioListener with AKRESULT: %u", akResult);
  1330. }
  1331. }
  1332. return newObjectData;
  1333. }
  1334. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1335. void CAudioSystemImpl_wwise::DeleteAudioListenerObjectData(IATLListenerData* const oldListenerData)
  1336. {
  1337. auto listenerData = static_cast<SATLListenerData_wwise*>(oldListenerData);
  1338. if (listenerData)
  1339. {
  1340. AKRESULT akResult = AK::SoundEngine::UnregisterGameObj(listenerData->nAKListenerObjectId);
  1341. if (IS_WWISE_OK(akResult))
  1342. {
  1343. if (listenerData->nAKListenerObjectId == m_defaultListenerGameObjectID)
  1344. {
  1345. m_defaultListenerGameObjectID = AK_INVALID_GAME_OBJECT;
  1346. }
  1347. }
  1348. else
  1349. {
  1350. g_audioImplLogger_wwise.Log(eALT_WARNING, "Wwise failed in UnregisterGameObj unregistering an AudioListener(%llu) with AKRESULT: %u", listenerData->nAKListenerObjectId, akResult);
  1351. }
  1352. }
  1353. azdestroy(oldListenerData, Audio::AudioImplAllocator, SATLListenerData_wwise);
  1354. }
  1355. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1356. SATLEventData_wwise* CAudioSystemImpl_wwise::NewAudioEventData(const TAudioEventID eventId)
  1357. {
  1358. auto newObjectData = azcreate(SATLEventData_wwise, (eventId), Audio::AudioImplAllocator, "ATLEventData_wwise");
  1359. return newObjectData;
  1360. }
  1361. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1362. void CAudioSystemImpl_wwise::DeleteAudioEventData(IATLEventData* const oldEventData)
  1363. {
  1364. azdestroy(oldEventData, Audio::AudioImplAllocator, SATLEventData_wwise);
  1365. }
  1366. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1367. void CAudioSystemImpl_wwise::ResetAudioEventData(IATLEventData* const eventData)
  1368. {
  1369. auto const implEventData = static_cast<SATLEventData_wwise*>(eventData);
  1370. if (implEventData)
  1371. {
  1372. implEventData->audioEventState = eAES_NONE;
  1373. implEventData->nAKID = AK_INVALID_UNIQUE_ID;
  1374. implEventData->nSourceId = INVALID_AUDIO_SOURCE_ID;
  1375. }
  1376. }
  1377. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1378. IATLTriggerImplData* CAudioSystemImpl_wwise::NewAudioTriggerImplData(const AZ::rapidxml::xml_node<char>* audioTriggerNode)
  1379. {
  1380. SATLTriggerImplData_wwise* newTriggerImpl = nullptr;
  1381. if (audioTriggerNode && azstricmp(audioTriggerNode->name(), WwiseXmlTags::WwiseEventTag) == 0)
  1382. {
  1383. auto eventNameAttr = audioTriggerNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1384. if (eventNameAttr)
  1385. {
  1386. const char* eventName = eventNameAttr->value();
  1387. const AkUniqueID akId = AK::SoundEngine::GetIDFromString(eventName);
  1388. if (akId != AK_INVALID_UNIQUE_ID)
  1389. {
  1390. newTriggerImpl = azcreate(SATLTriggerImplData_wwise, (akId), Audio::AudioImplAllocator, "ATLTriggerImplData_wwise");
  1391. }
  1392. }
  1393. }
  1394. return newTriggerImpl;
  1395. }
  1396. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1397. void CAudioSystemImpl_wwise::DeleteAudioTriggerImplData(IATLTriggerImplData* const oldTriggerImplData)
  1398. {
  1399. azdestroy(oldTriggerImplData, Audio::AudioImplAllocator, SATLTriggerImplData_wwise);
  1400. }
  1401. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1402. IATLRtpcImplData* CAudioSystemImpl_wwise::NewAudioRtpcImplData(const AZ::rapidxml::xml_node<char>* audioRtpcNode)
  1403. {
  1404. SATLRtpcImplData_wwise* newRtpcImpl = nullptr;
  1405. AkRtpcID akRtpcId = AK_INVALID_RTPC_ID;
  1406. float mult = 1.f;
  1407. float shift = 0.f;
  1408. ParseRtpcImpl(audioRtpcNode, akRtpcId, mult, shift);
  1409. if (akRtpcId != AK_INVALID_RTPC_ID)
  1410. {
  1411. newRtpcImpl = azcreate(SATLRtpcImplData_wwise, (akRtpcId, mult, shift), Audio::AudioImplAllocator, "ATLRtpcImplData_wwise");
  1412. }
  1413. return newRtpcImpl;
  1414. }
  1415. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1416. void CAudioSystemImpl_wwise::DeleteAudioRtpcImplData(IATLRtpcImplData* const oldRtpcImplData)
  1417. {
  1418. azdestroy(oldRtpcImplData, Audio::AudioImplAllocator, SATLRtpcImplData_wwise);
  1419. }
  1420. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1421. IATLSwitchStateImplData* CAudioSystemImpl_wwise::NewAudioSwitchStateImplData(const AZ::rapidxml::xml_node<char>* audioSwitchNode)
  1422. {
  1423. SATLSwitchStateImplData_wwise* newSwitchImpl = nullptr;
  1424. const char* nodeName = audioSwitchNode->name();
  1425. if (azstricmp(nodeName, WwiseXmlTags::WwiseSwitchTag) == 0)
  1426. {
  1427. newSwitchImpl = ParseWwiseSwitchOrState(audioSwitchNode, eWST_SWITCH);
  1428. }
  1429. else if (azstricmp(nodeName, WwiseXmlTags::WwiseStateTag) == 0)
  1430. {
  1431. newSwitchImpl = ParseWwiseSwitchOrState(audioSwitchNode, eWST_STATE);
  1432. }
  1433. else if (azstricmp(nodeName, WwiseXmlTags::WwiseRtpcSwitchTag) == 0)
  1434. {
  1435. newSwitchImpl = ParseWwiseRtpcSwitch(audioSwitchNode);
  1436. }
  1437. return newSwitchImpl;
  1438. }
  1439. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1440. void CAudioSystemImpl_wwise::DeleteAudioSwitchStateImplData(IATLSwitchStateImplData* const oldSwitchStateImplData)
  1441. {
  1442. azdestroy(oldSwitchStateImplData, Audio::AudioImplAllocator, SATLSwitchStateImplData_wwise);
  1443. }
  1444. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1445. IATLEnvironmentImplData* CAudioSystemImpl_wwise::NewAudioEnvironmentImplData(const AZ::rapidxml::xml_node<char>* audioEnvironmentNode)
  1446. {
  1447. SATLEnvironmentImplData_wwise* newEnvironmentImpl = nullptr;
  1448. if (azstricmp(audioEnvironmentNode->name(), WwiseXmlTags::WwiseAuxBusTag) == 0)
  1449. {
  1450. auto auxBusNameAttr = audioEnvironmentNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1451. if (auxBusNameAttr)
  1452. {
  1453. const char* auxBusName = auxBusNameAttr->value();
  1454. const AkUniqueID akBusId = AK::SoundEngine::GetIDFromString(auxBusName);
  1455. if (akBusId != AK_INVALID_AUX_ID)
  1456. {
  1457. newEnvironmentImpl = azcreate(SATLEnvironmentImplData_wwise, (eWAET_AUX_BUS, static_cast<AkAuxBusID>(akBusId)), Audio::AudioImplAllocator, "ATLEnvironmentImplData_wwise");
  1458. }
  1459. }
  1460. }
  1461. else if (azstricmp(audioEnvironmentNode->name(), WwiseXmlTags::WwiseRtpcTag) == 0)
  1462. {
  1463. AkRtpcID akRtpcId = AK_INVALID_RTPC_ID;
  1464. float mult = 1.f;
  1465. float shift = 0.f;
  1466. ParseRtpcImpl(audioEnvironmentNode, akRtpcId, mult, shift);
  1467. if (akRtpcId != AK_INVALID_RTPC_ID)
  1468. {
  1469. newEnvironmentImpl = azcreate(SATLEnvironmentImplData_wwise, (eWAET_RTPC, akRtpcId, mult, shift), Audio::AudioImplAllocator, "ATLEnvironmentImplData_wwise");
  1470. }
  1471. }
  1472. return newEnvironmentImpl;
  1473. }
  1474. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1475. void CAudioSystemImpl_wwise::DeleteAudioEnvironmentImplData(IATLEnvironmentImplData* const oldEnvironmentImplData)
  1476. {
  1477. azdestroy(oldEnvironmentImplData, Audio::AudioImplAllocator, SATLEnvironmentImplData_wwise);
  1478. }
  1479. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1480. const char* const CAudioSystemImpl_wwise::GetImplementationNameString() const
  1481. {
  1482. #if !defined(WWISE_RELEASE)
  1483. return m_fullImplString.c_str();
  1484. #else
  1485. return nullptr;
  1486. #endif // !WWISE_RELEASE
  1487. }
  1488. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1489. void CAudioSystemImpl_wwise::GetMemoryInfo(SAudioImplMemoryInfo& memoryInfo) const
  1490. {
  1491. memoryInfo.nPrimaryPoolSize = AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().Capacity();
  1492. memoryInfo.nPrimaryPoolUsedSize = memoryInfo.nPrimaryPoolSize - AZ::AllocatorInstance<Audio::AudioImplAllocator>::Get().GetUnAllocatedMemory();
  1493. memoryInfo.nPrimaryPoolAllocations = 0;
  1494. memoryInfo.nSecondaryPoolSize = 0;
  1495. memoryInfo.nSecondaryPoolUsedSize = 0;
  1496. memoryInfo.nSecondaryPoolAllocations = 0;
  1497. }
  1498. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1499. AZStd::vector<AudioImplMemoryPoolInfo> CAudioSystemImpl_wwise::GetMemoryPoolInfo()
  1500. {
  1501. #if !defined(WWISE_RELEASE)
  1502. // Update memory category info...
  1503. for (auto& memInfo : m_debugMemoryInfo)
  1504. {
  1505. if (memInfo.m_poolId < 0)
  1506. {
  1507. break;
  1508. }
  1509. AK::MemoryMgr::CategoryStats categoryStats;
  1510. AK::MemoryMgr::GetCategoryStats(memInfo.m_poolId, categoryStats);
  1511. memInfo.m_memoryUsed = categoryStats.uUsed;
  1512. memInfo.m_peakUsed = categoryStats.uPeakUsed;
  1513. memInfo.m_numAllocs = categoryStats.uAllocs;
  1514. memInfo.m_numFrees = categoryStats.uFrees;
  1515. }
  1516. AK::MemoryMgr::GlobalStats globalStats;
  1517. AK::MemoryMgr::GetGlobalStats(globalStats);
  1518. auto& memInfo = m_debugMemoryInfo.back();
  1519. memInfo.m_memoryReserved = globalStats.uReserved;
  1520. memInfo.m_memoryUsed = globalStats.uUsed;
  1521. memInfo.m_peakUsed = globalStats.uMax;
  1522. // return the memory infos...
  1523. return m_debugMemoryInfo;
  1524. #else
  1525. return AZStd::vector<AudioImplMemoryPoolInfo>();
  1526. #endif // !WWISE_RELEASE
  1527. }
  1528. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1529. bool CAudioSystemImpl_wwise::CreateAudioSource(const SAudioInputConfig& sourceConfig)
  1530. {
  1531. return AudioSourceManager::Get().CreateSource(sourceConfig);
  1532. }
  1533. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1534. void CAudioSystemImpl_wwise::DestroyAudioSource(TAudioSourceId sourceId)
  1535. {
  1536. AudioSourceManager::Get().DestroySource(sourceId);
  1537. }
  1538. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1539. void CAudioSystemImpl_wwise::SetPanningMode(PanningMode mode)
  1540. {
  1541. AkPanningRule panningRule;
  1542. switch (mode)
  1543. {
  1544. case PanningMode::Speakers:
  1545. panningRule = AkPanningRule_Speakers;
  1546. break;
  1547. case PanningMode::Headphones:
  1548. panningRule = AkPanningRule_Headphones;
  1549. break;
  1550. default:
  1551. return;
  1552. }
  1553. AKRESULT akResult = AK::SoundEngine::SetPanningRule(panningRule);
  1554. if (!IS_WWISE_OK(akResult))
  1555. {
  1556. g_audioImplLogger_wwise.Log(eALT_ERROR, "Wwise failed to set Panning Rule to [%s]\n", panningRule == AkPanningRule_Speakers ? "Speakers" : "Headphones");
  1557. }
  1558. }
  1559. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1560. SATLSwitchStateImplData_wwise* CAudioSystemImpl_wwise::ParseWwiseSwitchOrState(const AZ::rapidxml::xml_node<char>* node, EWwiseSwitchType type)
  1561. {
  1562. SATLSwitchStateImplData_wwise* switchStateImpl = nullptr;
  1563. auto switchNameAttr = node->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1564. if (switchNameAttr)
  1565. {
  1566. const char* switchName = switchNameAttr->value();
  1567. auto valueNode = node->first_node(WwiseXmlTags::WwiseValueTag, 0, false);
  1568. if (valueNode)
  1569. {
  1570. auto valueNameAttr = valueNode->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1571. if (valueNameAttr)
  1572. {
  1573. const char* stateName = valueNameAttr->value();
  1574. const AkUniqueID akSGroupId = AK::SoundEngine::GetIDFromString(switchName);
  1575. const AkUniqueID akSNameId = AK::SoundEngine::GetIDFromString(stateName);
  1576. if (akSGroupId != AK_INVALID_UNIQUE_ID && akSNameId != AK_INVALID_UNIQUE_ID)
  1577. {
  1578. switchStateImpl = azcreate(SATLSwitchStateImplData_wwise, (type, akSGroupId, akSNameId), Audio::AudioImplAllocator, "ATLSwitchStateImplData_wwise");
  1579. }
  1580. }
  1581. }
  1582. }
  1583. return switchStateImpl;
  1584. }
  1585. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1586. SATLSwitchStateImplData_wwise* CAudioSystemImpl_wwise::ParseWwiseRtpcSwitch(const AZ::rapidxml::xml_node<char>* node)
  1587. {
  1588. SATLSwitchStateImplData_wwise* switchStateImpl = nullptr;
  1589. if (node && azstricmp(node->name(), WwiseXmlTags::WwiseRtpcSwitchTag) == 0)
  1590. {
  1591. auto rtpcNameAttr = node->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1592. if (rtpcNameAttr)
  1593. {
  1594. const char* rtpcName = rtpcNameAttr->value();
  1595. float rtpcValue = 0.f;
  1596. auto rtpcValueAttr = node->first_attribute(WwiseXmlTags::WwiseValueAttribute, 0, false);
  1597. if (rtpcValueAttr)
  1598. {
  1599. rtpcValue = AZStd::stof(AZStd::string(rtpcValueAttr->value()));
  1600. const AkUniqueID akRtpcId = AK::SoundEngine::GetIDFromString(rtpcName);
  1601. if (akRtpcId != AK_INVALID_RTPC_ID)
  1602. {
  1603. switchStateImpl = azcreate(SATLSwitchStateImplData_wwise, (eWST_RTPC, akRtpcId, akRtpcId, rtpcValue), Audio::AudioImplAllocator, "ATLSwitchStateImplData_wwise");
  1604. }
  1605. }
  1606. }
  1607. }
  1608. return switchStateImpl;
  1609. }
  1610. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1611. void CAudioSystemImpl_wwise::ParseRtpcImpl(const AZ::rapidxml::xml_node<char>* node, AkRtpcID& akRtpcId, float& mult, float& shift)
  1612. {
  1613. if (node && azstricmp(node->name(), WwiseXmlTags::WwiseRtpcTag) == 0)
  1614. {
  1615. auto rtpcAttr = node->first_attribute(WwiseXmlTags::WwiseNameAttribute, 0, false);
  1616. if (rtpcAttr)
  1617. {
  1618. const char* rtpcName = rtpcAttr->value();
  1619. akRtpcId = static_cast<AkRtpcID>(AK::SoundEngine::GetIDFromString(rtpcName));
  1620. if (akRtpcId != AK_INVALID_RTPC_ID)
  1621. {
  1622. auto multAttr = node->first_attribute(WwiseXmlTags::WwiseMutiplierAttribute, 0, false);
  1623. if (multAttr)
  1624. {
  1625. mult = AZStd::stof(AZStd::string(multAttr->value()));
  1626. }
  1627. auto shiftAttr = node->first_attribute(WwiseXmlTags::WwiseShiftAttribute, 0, false);
  1628. if (shiftAttr)
  1629. {
  1630. shift = AZStd::stof(AZStd::string(shiftAttr->value()));
  1631. }
  1632. }
  1633. }
  1634. }
  1635. }
  1636. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1637. EAudioRequestStatus CAudioSystemImpl_wwise::PrepUnprepTriggerSync(
  1638. const IATLTriggerImplData* const triggerData,
  1639. bool prepare)
  1640. {
  1641. EAudioRequestStatus result = eARS_FAILURE;
  1642. auto const implTriggerData = static_cast<const SATLTriggerImplData_wwise*>(triggerData);
  1643. if (implTriggerData)
  1644. {
  1645. AkUniqueID akUniqueId = implTriggerData->nAKID;
  1646. const AKRESULT akResult = AK::SoundEngine::PrepareEvent(
  1647. prepare ? AK::SoundEngine::Preparation_Load : AK::SoundEngine::Preparation_Unload,
  1648. &akUniqueId,
  1649. 1);
  1650. if (IS_WWISE_OK(akResult))
  1651. {
  1652. result = eARS_SUCCESS;
  1653. }
  1654. else
  1655. {
  1656. g_audioImplLogger_wwise.Log(
  1657. eALT_WARNING,
  1658. "Wwise PrepareEvent with %s failed for Wwise event %u with AKRESULT: %u",
  1659. prepare ? "Preparation_Load" : "Preparation_Unload",
  1660. akUniqueId,
  1661. akResult);
  1662. }
  1663. }
  1664. else
  1665. {
  1666. g_audioImplLogger_wwise.Log(eALT_ERROR,
  1667. "Invalid ATLTriggerData or EventData passed to the Wwise implementation of %sTriggerSync",
  1668. prepare ? "Prepare" : "Unprepare");
  1669. }
  1670. return result;
  1671. }
  1672. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1673. EAudioRequestStatus CAudioSystemImpl_wwise::PrepUnprepTriggerAsync(
  1674. [[maybe_unused]] const IATLTriggerImplData* const triggerData,
  1675. [[maybe_unused]] IATLEventData* const eventData,
  1676. [[maybe_unused]] bool prepare)
  1677. {
  1678. EAudioRequestStatus result = eARS_FAILURE;
  1679. #if 0 // Turned off, PrepareEvent is not supported yet.
  1680. auto const implTriggerData = static_cast<const SATLTriggerImplData_wwise*>(triggerData);
  1681. auto const implEventData = static_cast<SATLEventData_wwise*>(eventData);
  1682. if (implTriggerData && implEventData)
  1683. {
  1684. AkUniqueID akUniqueId = implTriggerData->nAKID;
  1685. const AKRESULT akResult = AK::SoundEngine::PrepareEvent(
  1686. prepare ? AK::SoundEngine::Preparation_Load : AK::SoundEngine::Preparation_Unload,
  1687. &akUniqueId,
  1688. 1,
  1689. &PrepareEventCallback,
  1690. implEventData);
  1691. if (IS_WWISE_OK(akResult))
  1692. {
  1693. implEventData->nAKID = akUniqueId;
  1694. implEventData->audioEventState = eAES_UNLOADING;
  1695. result = eARS_SUCCESS;
  1696. }
  1697. else
  1698. {
  1699. g_audioImplLogger_wwise.Log(
  1700. eALT_WARNING,
  1701. "Wwise PrepareEvent with %s failed for Wwise event %u with AKRESULT: %u",
  1702. prepare ? "Preparation_Load" : "Preparation_Unload",
  1703. akUniqueId,
  1704. akResult);
  1705. }
  1706. }
  1707. else
  1708. {
  1709. g_audioImplLogger_wwise.Log(eALT_ERROR,
  1710. "Invalid ATLTriggerData or EventData passed to the Wwise implementation of %sTriggerAsync",
  1711. prepare ? "Prepare" : "Unprepare");
  1712. }
  1713. #endif
  1714. return result;
  1715. }
  1716. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1717. void CAudioSystemImpl_wwise::SetBankPaths()
  1718. {
  1719. // Default...
  1720. // "sounds/wwise/"
  1721. AZStd::string bankPath = Audio::Wwise::DefaultBanksPath;
  1722. // "sounds/wwise/wwise_config.json"
  1723. AZStd::string configFile = bankPath + Audio::Wwise::ConfigFile;
  1724. if (AZ::IO::FileIOBase::GetInstance()
  1725. && AZ::IO::FileIOBase::GetInstance()->Exists(configFile.c_str()))
  1726. {
  1727. Audio::Wwise::ConfigurationSettings configSettings;
  1728. if (configSettings.Load(configFile))
  1729. {
  1730. for (const auto& platformMap : configSettings.m_platformMappings)
  1731. {
  1732. // May need to do a series of checks compare the data in the config settings to what's actually in the file system.
  1733. // This is the most straightforward platform check.
  1734. if (azstricmp(platformMap.m_enginePlatform.c_str(), AZ_TRAIT_OS_PLATFORM_NAME) == 0)
  1735. {
  1736. AZStd::string platformPath;
  1737. // "sounds/wwise/windows"
  1738. AZ::StringFunc::AssetDatabasePath::Join(bankPath.c_str(), platformMap.m_bankSubPath.c_str(), platformPath);
  1739. AZStd::string initBankPath;
  1740. // "sounds/wwise/windows/init.bnk"
  1741. AZ::StringFunc::AssetDatabasePath::Join(platformPath.c_str(), Audio::Wwise::InitBank, initBankPath);
  1742. if (AZ::IO::FileIOBase::GetInstance()->Exists(initBankPath.c_str()))
  1743. {
  1744. if (!platformPath.ends_with(AZ_CORRECT_DATABASE_SEPARATOR))
  1745. {
  1746. platformPath.push_back(AZ_CORRECT_DATABASE_SEPARATOR);
  1747. }
  1748. bankPath = AZStd::move(platformPath);
  1749. break;
  1750. }
  1751. }
  1752. }
  1753. }
  1754. }
  1755. m_soundbankFolder = bankPath;
  1756. m_localizedSoundbankFolder = bankPath;
  1757. Audio::Wwise::SetBanksRootPath(m_soundbankFolder);
  1758. }
  1759. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1760. bool CAudioSystemImpl_wwise::SEnvPairCompare::operator()(const AZStd::pair<const AkAuxBusID, float>& pair1, const AZStd::pair<const AkAuxBusID, float>& pair2) const
  1761. {
  1762. return (pair1.second > pair2.second);
  1763. }
  1764. ///////////////////////////////////////////////////////////////////////////////////////////////////
  1765. EAudioRequestStatus CAudioSystemImpl_wwise::PostEnvironmentAmounts(IATLAudioObjectData* const audioObjectData)
  1766. {
  1767. EAudioRequestStatus result = eARS_FAILURE;
  1768. auto const implObjectData = static_cast<SATLAudioObjectData_wwise*>(audioObjectData);
  1769. if (implObjectData)
  1770. {
  1771. AkAuxSendValue akAuxSendValues[LY_MAX_AUX_PER_OBJ];
  1772. AZ::u32 auxCount = 0;
  1773. SATLAudioObjectData_wwise::TEnvironmentImplMap::iterator envPair = implObjectData->cEnvironmentImplAmounts.begin();
  1774. const SATLAudioObjectData_wwise::TEnvironmentImplMap::const_iterator envBegin = implObjectData->cEnvironmentImplAmounts.begin();
  1775. const SATLAudioObjectData_wwise::TEnvironmentImplMap::const_iterator envEnd = implObjectData->cEnvironmentImplAmounts.end();
  1776. if (implObjectData->cEnvironmentImplAmounts.size() <= LY_MAX_AUX_PER_OBJ)
  1777. {
  1778. for (; envPair != envEnd; ++auxCount)
  1779. {
  1780. const float amount = envPair->second;
  1781. akAuxSendValues[auxCount].auxBusID = envPair->first;
  1782. akAuxSendValues[auxCount].fControlValue = amount;
  1783. akAuxSendValues[auxCount].listenerID = m_defaultListenerGameObjectID; // TODO: Expand api to allow specify listeners
  1784. // If an amount is zero, we still want to send it to the middleware, but we also want to remove it from the map.
  1785. if (amount == 0.0f)
  1786. {
  1787. envPair = implObjectData->cEnvironmentImplAmounts.erase(envPair);
  1788. }
  1789. else
  1790. {
  1791. ++envPair;
  1792. }
  1793. }
  1794. }
  1795. else
  1796. {
  1797. // sort the environments in order of decreasing amounts and take the first LY_MAX_AUX_PER_OBJ worth
  1798. using TEnvPairSet = AZStd::set<SATLAudioObjectData_wwise::TEnvironmentImplMap::value_type, SEnvPairCompare, Audio::AudioImplStdAllocator>;
  1799. TEnvPairSet envPairs(envBegin, envEnd);
  1800. TEnvPairSet::const_iterator sortedEnvPair = envPairs.begin();
  1801. const TEnvPairSet::const_iterator sortedEnvEnd = envPairs.end();
  1802. for (; (sortedEnvPair != sortedEnvEnd) && (auxCount < LY_MAX_AUX_PER_OBJ); ++sortedEnvPair, ++auxCount)
  1803. {
  1804. akAuxSendValues[auxCount].auxBusID = sortedEnvPair->first;
  1805. akAuxSendValues[auxCount].fControlValue = sortedEnvPair->second;
  1806. akAuxSendValues[auxCount].listenerID = m_defaultListenerGameObjectID; // TODO: Expand api to allow specify listeners
  1807. }
  1808. // remove all Environments with 0.0 amounts
  1809. while (envPair != envEnd)
  1810. {
  1811. if (envPair->second == 0.0f)
  1812. {
  1813. envPair = implObjectData->cEnvironmentImplAmounts.erase(envPair);
  1814. }
  1815. else
  1816. {
  1817. ++envPair;
  1818. }
  1819. }
  1820. }
  1821. AZ_Assert(auxCount <= LY_MAX_AUX_PER_OBJ, "WwiseImpl PostEnvironmentAmounts - Exceeded the allowed number of aux environments that can be set!");
  1822. const AKRESULT akResult = AK::SoundEngine::SetGameObjectAuxSendValues(implObjectData->nAKID, akAuxSendValues, auxCount);
  1823. if (IS_WWISE_OK(akResult))
  1824. {
  1825. result = eARS_SUCCESS;
  1826. }
  1827. else
  1828. {
  1829. g_audioImplLogger_wwise.Log(eALT_WARNING,
  1830. "Wwise SetGameObjectAuxSendValues failed on object %llu with AKRESULT: %u",
  1831. implObjectData->nAKID,
  1832. akResult);
  1833. }
  1834. implObjectData->bNeedsToUpdateEnvironments = false;
  1835. }
  1836. return result;
  1837. }
  1838. //////////////////////////////////////////////////////////////////////////
  1839. const char* const CAudioSystemImpl_wwise::GetImplSubPath() const
  1840. {
  1841. return WwiseImplSubPath;
  1842. }
  1843. //////////////////////////////////////////////////////////////////////////
  1844. void CAudioSystemImpl_wwise::SetLanguage(const char* const language)
  1845. {
  1846. if (language)
  1847. {
  1848. AZStd::string languageSubfolder;
  1849. if (azstricmp(language, "english") == 0)
  1850. {
  1851. languageSubfolder = "english(us)";
  1852. }
  1853. else
  1854. {
  1855. languageSubfolder = language;
  1856. }
  1857. languageSubfolder += "/";
  1858. m_localizedSoundbankFolder = m_soundbankFolder;
  1859. m_localizedSoundbankFolder.append(languageSubfolder);
  1860. m_fileIOHandler.SetLanguageFolder(languageSubfolder.c_str());
  1861. }
  1862. }
  1863. } // namespace Audio