WwiseExternalSourceManagerImpl.h 5.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. /*******************************************************************************
  2. The content of this file includes portions of the proprietary AUDIOKINETIC Wwise
  3. Technology released in source code form as part of the game integration package.
  4. The content of this file may not be used without valid licenses to the
  5. AUDIOKINETIC Wwise Technology.
  6. Note that the use of the game engine is subject to the Unreal(R) Engine End User
  7. License Agreement at https://www.unrealengine.com/en-US/eula/unreal
  8. License Usage
  9. Licensees holding valid licenses to the AUDIOKINETIC Wwise Technology may use
  10. this file in accordance with the end user license agreement provided with the
  11. software or, alternatively, in accordance with the terms contained
  12. in a written agreement between you and Audiokinetic Inc.
  13. Copyright (c) 2023 Audiokinetic Inc.
  14. *******************************************************************************/
  15. #pragma once
  16. #include "Wwise/WwiseExternalSourceManager.h"
  17. #include "Wwise/CookedData/WwiseExternalSourceCookedData.h"
  18. #include "Wwise/WwiseFileState.h"
  19. #include "Wwise/WwiseFileHandlerBase.h"
  20. class FWwiseExternalSourceFileState;
  21. struct WWISEFILEHANDLER_API FWwiseExternalSourceState : public FWwiseExternalSourceCookedData
  22. {
  23. FWwiseExternalSourceState(const FWwiseExternalSourceCookedData& InCookedData);
  24. ~FWwiseExternalSourceState();
  25. TAtomic<int> LoadCount;
  26. void IncrementLoadCount();
  27. bool DecrementLoadCount();
  28. };
  29. using FWwiseExternalSourceStateSharedPtr = TSharedPtr<FWwiseExternalSourceState>;
  30. class WWISEFILEHANDLER_API FWwiseExternalSourceManagerImpl : public IWwiseExternalSourceManager, public FWwiseFileHandlerBase
  31. {
  32. public:
  33. FWwiseExternalSourceManagerImpl();
  34. ~FWwiseExternalSourceManagerImpl();
  35. virtual const TCHAR* GetManagingTypeName() const override { return TEXT("External Source"); }
  36. virtual void LoadExternalSource(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath,
  37. const FWwiseLanguageCookedData& InLanguage, FLoadExternalSourceCallback&& InCallback) override;
  38. virtual void UnloadExternalSource(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath,
  39. const FWwiseLanguageCookedData& InLanguage, FUnloadExternalSourceCallback&& InCallback) override;
  40. virtual void SetGranularity(AkUInt32 InStreamingGranularity) override;
  41. IWwiseStreamingManagerHooks& GetStreamingHooks() override final { return *this; }
  42. virtual TArray<uint32> PrepareExternalSourceInfos(TArray<AkExternalSourceInfo>& OutInfo,
  43. const TArray<FWwiseExternalSourceCookedData>&& InCookedData) override;
  44. virtual void BindPlayingIdToExternalSources(const uint32 InPlayingId, const TArray<uint32>& InMediaIds) override;
  45. virtual void OnEndOfEvent(const uint32 InPlayingID) override;
  46. virtual void SetExternalSourceMediaById(const FName& ExternalSourceName, const int32 MediaId) override;
  47. virtual void SetExternalSourceMediaByName(const FName& ExternalSourceName, const FName& MediaName) override;
  48. virtual void SetExternalSourceMediaWithIds(const int32 ExternalSourceCookie, const int32 MediaId) override;
  49. #if WITH_EDITORONLY_DATA
  50. virtual void Cook(FWwiseResourceCooker& InResourceCooker, const FWwiseExternalSourceCookedData& InCookedData,
  51. TFunctionRef<void(const TCHAR* Filename, void* Data, int64 Size)> WriteAdditionalFile,
  52. const FWwiseSharedPlatformId& InPlatform, const FWwiseSharedLanguageId& InLanguage) override;
  53. #endif
  54. protected:
  55. /**
  56. * @brief Lock on the Cookie to Media Table. Lock as "ReadOnly" for using the tables (Prepare), and as "Write" for modifying the tables.
  57. */
  58. FRWLock CookieToMediaLock;
  59. TMap<uint32, FWwiseExternalSourceFileState*> CookieToMedia;
  60. TMultiMap<uint32, uint32> PlayingIdToMediaIds;
  61. uint32 StreamingGranularity;
  62. TMap<uint32, FWwiseExternalSourceStateSharedPtr> ExternalSourceStatesById;
  63. virtual void LoadExternalSourceImpl(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath,
  64. const FWwiseLanguageCookedData& InLanguage, FLoadExternalSourceCallback&& InCallback);
  65. virtual void UnloadExternalSourceImpl(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath,
  66. const FWwiseLanguageCookedData& InLanguage, FUnloadExternalSourceCallback&& InCallback);
  67. virtual FWwiseExternalSourceStateSharedPtr CreateExternalSourceState(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath);
  68. virtual bool CloseExternalSourceState(FWwiseExternalSourceState& InExternalSourceState);
  69. virtual void LoadExternalSourceMedia(const uint32 InExternalSourceCookie, const FName& InExternalSourceName, const FName& InRootPath, FLoadExternalSourceCallback&& InCallback);
  70. virtual void UnloadExternalSourceMedia(const uint32 InExternalSourceCookie, const FName& InExternalSourceName, const FName& InRootPath, FUnloadExternalSourceCallback&& InCallback);
  71. virtual uint32 PrepareExternalSourceInfo(AkExternalSourceInfo& OutInfo, const FWwiseExternalSourceCookedData& InCookedData);
  72. virtual void OnDeleteState(uint32 InShortId, FWwiseFileState& InFileState, EWwiseFileStateOperationOrigin InOperationOrigin, FDecrementStateCallback&& InCallback) override;
  73. };