_ak_memory_mgr_8h

Wwise SDK 2024.1.0

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the
 "Apache License"); you may not use this file except in compliance with the
 Apache License. You may obtain a copy of the Apache License at
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
  
 /// \file
 /// Memory Manager namespace.
  
 #ifndef _AKMEMORYMGR_H_
 #define _AKMEMORYMGR_H_
  
 #if !defined( AK_OPTIMIZED ) && !( defined AK_DISABLE_MEMDEBUG )
     #ifndef AK_MEMDEBUG
         #define AK_MEMDEBUG
     #endif
 #endif
  
 #include <AK/SoundEngine/Common/AkTypes.h>
 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
  
 struct AkMemSettings;
  
 /// Memory category IDs.
 /// If this is modified, the Comm version should be bumped as well, to keep Authoring in line
 enum AkMemID
 {
     AkMemID_Object,                 ///< Generic placeholder for allocations tied to the Wwise project.
     AkMemID_Event,                  ///< Events from the Wwise project.
     AkMemID_Structure,              ///< Structures from the Wwise project.
     AkMemID_Media,                  ///< Media from the Wwise project.
     AkMemID_GameObject,             ///< Game Objects and related.
     AkMemID_Processing,             ///< Anything tied to instancing and processing of the DSP graph.
     AkMemID_ProcessingPlugin,       ///< Plug-in allocations related to the DSP graph.
     AkMemID_Streaming,              ///< Streaming Manager objects.
     AkMemID_StreamingIO,            ///< Streaming Manager I/O memory.
     AkMemID_SpatialAudio,           ///< Spatial audio.
     AkMemID_SpatialAudioGeometry,   ///< Spatial audio geometry data.
     AkMemID_SpatialAudioPaths,      ///< Spatial audio paths data.
     AkMemID_GameSim,                ///< Game Simulator allocations.
     AkMemID_MonitorQueue,           ///< Monitor Queue.
     AkMemID_Profiler,               ///< Profiler.
     AkMemID_FilePackage,            ///< File packager.
     AkMemID_SoundEngine,            ///< Base sound engine allocations (managers, etc).
     AkMemID_Integration,            ///< Game engine integration allocations.
     AkMemID_JobMgr,                 ///< Allocations for Sound Engine jobs and job dependencies.
     AkMemID_TempAudioRender,        ///< Temporary allocations for audio render.
     AkMemID_BookmarkAlloc,          ///< Allocations serviced by the bookmark allocator
  
     AkMemID_NUM,                    ///< Category count.
     AkMemID_MASK = 0x1FFFFFFF,      ///< Mask for category IDs.
  
     AkMemType_Media = 0x20000000,   ///< Media memory type bit.
     AkMemType_Device = 0x40000000,  ///< Device memory type bit.
     AkMemType_NoTrack = 0x80000000  ///< Do not track this allocation.
 };
  
 namespace AK
 {
     /// Memory Manager namespace.
     /// \remarks The functions in this namespace are thread-safe, unless stated otherwise.
     /// \sa
     /// - \ref memorymanager
     namespace MemoryMgr
     {
         /// Memory category statistics.
         /// \remarks These statistics are not collected in the Release configuration of
         /// the default memory manager implementation.
         /// \sa
         /// - AK::MemoryMgr::GetCategoryStats()
         /// - \ref memorymanager
         struct CategoryStats
         {
             // Current state
             AkUInt64 uUsed;         ///< Used memory (in bytes)
  
             // Statistics
             AkUInt64 uPeakUsed;     ///< Peak used memory (in bytes)
             AkUInt32 uAllocs;       ///< Number of allocation calls since initialization
             AkUInt32 uFrees;        ///< Number of free calls since initialization
         };
  
         /// Memory global statistics.
         /// \remarks These statistics are not collected in the Release configuration of
         /// the default memory manager implementation.
         /// \sa
         /// - AK::MemoryMgr::GetGlobalStats()
         /// - \ref memorymanager
         struct GlobalStats
         {
             AkUInt64 uUsed;       ///< Total memory used including all categories (in bytes)
             AkUInt64 uReserved;   ///< Total reserved memory. (Used and unused). Will return 0 if the reserved memory is not traceable.
         };
  
         ////////////////////////////////////////////////////////////////////////
         /// @name Initialization
         //@{
  
         /// Query whether the Memory Manager has been successfully initialized.
         /// \warning This function is not thread-safe. It should not be called at the same time as MemoryMgr::Init or MemoryMgr::Term.
         /// \return True if the Memory Manager is initialized, False otherwise
         /// \sa
         /// - AK::MemoryMgr::Init()
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( bool, IsInitialized )();
  
         /// Terminate the Memory Manager.
         /// \warning This function is not thread-safe. It is not valid to allocate memory or otherwise interact with the memory manager during or after this call.
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void, Term )();
  
         /// Performs whatever steps are required to initialize a thread for use with the memory manager.
         /// For example initializing thread local storage that the allocator requires to work.
         /// The default implementation of the memory manager performs thread initialization automatically and therefore this call is optional.
         /// For implementations where the cost of automatically initializing a thread for use with an allocator would be prohibitively expensive
         /// this call allows you to perform the initialization once during, for example, thread creation.
         /// \sa
         /// - AkMemInitForThread
         AK_EXTERNAPIFUNC( void, InitForThread )();
  
         /// Allows you to manually terminate a thread for use with the memory manager.
         /// The default implementation of the memory manager requires that all threads that interact with the memory manager call this function prior
         /// to either their termination or the termination of the memory manager. Threads not created by the sound engine itself will not have this
         /// function called for them automatically.
         /// Take care to call this function for any thread, not owned by wwise, that may have interacted with the memory manager. For example job system workers.
         /// \sa
         /// - AkMemTermForThread
         AK_EXTERNAPIFUNC( void, TermForThread )();
  
         /// Allows you to "trim" a thread being used with the memory manager.
         /// This is a function that will be called periodically by some Wwise-owned threads,
         /// so that any thread-local state can be cleaned up in order to return memory for other systems to use.
         /// For example, this can be used to return thread-local heaps to global stores or to finalize other deferred operations.
         /// This function is only required for optimization purposes and does not have to be defined.
         /// Therefore, unlike TermForThread, this is not expected to be called in all scenarios by Wwise.
         /// It is also recommended to be called by game engine integrations in any worker threads that run Wwise jobs.
         /// Refer to \ref eventmgrthread_jobmgr_best_practices for more information.
         /// \sa
         /// - AkMemTrimForThread
         AK_EXTERNAPIFUNC( void, TrimForThread )();
  
         //@}
  
         ////////////////////////////////////////////////////////////////////////
         /// @name Memory Allocation
         //@{
  
 #ifdef AK_MEMDEBUG
         /// Allocate memory: debug version.
         /// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void *, dMalloc )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             size_t      in_uSize,               ///< Number of bytes to allocate
             const char *in_pszFile,             ///< Debug file name
             AkUInt32    in_uLine                ///< Debug line number
             );
 #endif // AK_MEMDEBUG
  
         /// Allocate memory.
         /// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void *, Malloc )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             size_t      in_uSize                ///< Number of bytes to allocate
             );
  
 #ifdef AK_MEMDEBUG
         /// Reallocate memory: debug version.
         /// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void*, dRealloc )(
             AkMemPoolId in_poolId,
             void        *in_pAlloc,
             size_t      in_uSize,
             const char  *in_pszFile,
             AkUInt32    in_uLine
             );
 #endif // AK_MEMDEBUG
  
         /// Reallocate memory.
         /// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void *, Realloc )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             void *      in_pAlloc,              ///< Pointer to the start of the allocated memory
             size_t      in_uSize                ///< Number of bytes to allocate
             );
  
 #ifdef AK_MEMDEBUG
         /// Reallocate memory: debug version.
         /// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void*, dReallocAligned )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             void        *in_pAlloc,             ///< Pointer to the start of the allocated memory
             size_t      in_uSize,               ///< Number of bytes to allocate
             AkUInt32    in_uAlignment,          ///< Alignment (in bytes)
             const char  *in_pszFile,            ///< Debug file name
             AkUInt32    in_uLine                ///< Debug line number
             );
 #endif // AK_MEMDEBUG
  
         /// Reallocate memory.
         /// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void *, ReallocAligned )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             void *      in_pAlloc,              ///< Pointer to the start of the allocated memory
             size_t      in_uSize,               ///< Number of bytes to allocate
             AkUInt32    in_uAlignment           ///< Alignment (in bytes)
             );
  
         /// Free memory allocated with the memory manager.
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void, Free )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             void *      in_pMemAddress          ///< Pointer to the start of memory
             );
  
 #ifdef AK_MEMDEBUG
         /// Allocate memory with a specific alignment. debug version.
         /// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void *, dMalign )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             size_t      in_uSize,               ///< Number of bytes to allocate
             AkUInt32    in_uAlignment,          ///< Alignment (in bytes)
             const char*  in_pszFile,            ///< Debug file name
             AkUInt32    in_uLine                ///< Debug line number
             );
 #endif // AK_MEMDEBUG
  
         /// Allocate memory with a specific alignment.
         /// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
         /// \sa
         /// - \ref memorymanager
         AK_EXTERNAPIFUNC( void *, Malign )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             size_t      in_uSize,               ///< Number of bytes to allocate
             AkUInt32    in_uAlignment           ///< Alignment (in bytes)
             );
  
         //@}
  
         ////////////////////////////////////////////////////////////////////////
         /// @name Memory Profiling
         //@{
  
         /// Get statistics for a given memory category.
         /// \note Be aware of the potentially incoherent nature of reporting such information during concurrent modification by multiple threads.
         AK_EXTERNAPIFUNC( void, GetCategoryStats )(
             AkMemPoolId in_poolId,              ///< ID of the memory category (AkMemID)
             CategoryStats& out_poolStats        ///< Returned statistics.
             );
  
         /// Get statistics for overall memory manager usage.
         /// \note Be aware of the potentially incoherent nature of reporting such information during concurrent modification by multiple threads.
         AK_EXTERNAPIFUNC( void, GetGlobalStats )(
             GlobalStats& out_stats              ///< Returned statistics.
             );
  
         /// Called to start profiling memory usage for one thread (the calling thread).
         /// \note Not implementing this will result in the Soundbank tab of the Wwise Profiler to show 0 bytes for memory usage.
         AK_EXTERNAPIFUNC( void, StartProfileThreadUsage )(
             );
  
         /// Called to stop profiling memory usage for the current thread.
         /// \return The amount of memory allocated by this thread since StartProfileThreadUsage was called.
         /// \note Not implementing this will result in the Soundbank tab of the Wwise Profiler to show 0 bytes for memory usage.
         AK_EXTERNAPIFUNC( AkUInt64, StopProfileThreadUsage )(
             );
  
         /// Dumps the currently tracked allocations to a file
         /// \note AkMemSettings::uMemoryDebugLevel must be enabled and the build must define AK_MEMDEBUG for this to work
         AK_EXTERNAPIFUNC( void, DumpToFile )(
             const AkOSChar* pszFilename         ///< Filename.
             );
  
         //@}
     }
 }
  
 #endif // _AKMEMORYMGR_H_

AkMemID_Processing

@ AkMemID_Processing

Anything tied to instancing and processing of the DSP graph.

Definition: AkMemoryMgr.h:53

AK::MemoryMgr::DumpToFile

AKSOUNDENGINE_API void DumpToFile(const AkOSChar *pszFilename)

AkMemID_SpatialAudioPaths

@ AkMemID_SpatialAudioPaths

Spatial audio paths data.

Definition: AkMemoryMgr.h:59

AkMemID_MonitorQueue

@ AkMemID_MonitorQueue

Monitor Queue.

Definition: AkMemoryMgr.h:61

AkMemID_TempAudioRender

@ AkMemID_TempAudioRender

Temporary allocations for audio render.

Definition: AkMemoryMgr.h:67

AkMemID_FilePackage

@ AkMemID_FilePackage

File packager.

Definition: AkMemoryMgr.h:63

AK::MemoryMgr::TermForThread

AKSOUNDENGINE_API void TermForThread()

AK::MemoryMgr::dRealloc

AKSOUNDENGINE_API void * dRealloc(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize, const char *in_pszFile, AkUInt32 in_uLine)

AK::MemoryMgr::CategoryStats::uPeakUsed

AkUInt64 uPeakUsed

Peak used memory (in bytes)

Definition: AkMemoryMgr.h:98

Definition of data structures for AkAudioObject

Definition: AkWwiseSDKVersion.cs:31

AkMemID_StreamingIO

@ AkMemID_StreamingIO

Streaming Manager I/O memory.

Definition: AkMemoryMgr.h:56

AK::MemoryMgr::dMalloc

AKSOUNDENGINE_API void * dMalloc(AkMemPoolId in_poolId, size_t in_uSize, const char *in_pszFile, AkUInt32 in_uLine)

AkMemID_Media

@ AkMemID_Media

Media from the Wwise project.

Definition: AkMemoryMgr.h:51

AkMemID_Integration

@ AkMemID_Integration

Game engine integration allocations.

Definition: AkMemoryMgr.h:65

AkMemID_Object

@ AkMemID_Object

Generic placeholder for allocations tied to the Wwise project.

Definition: AkMemoryMgr.h:48

AK::MemoryMgr::dMalign

AKSOUNDENGINE_API void * dMalign(AkMemPoolId in_poolId, size_t in_uSize, AkUInt32 in_uAlignment, const char *in_pszFile, AkUInt32 in_uLine)

AK::MemoryMgr::Free

AKSOUNDENGINE_API void Free(AkMemPoolId in_poolId, void *in_pMemAddress)

AK_EXTERNAPIFUNC

#define AK_EXTERNAPIFUNC(_type, _name)

Definition: AkSoundEngineExport.h:81

AK::MemoryMgr::Malloc

AKSOUNDENGINE_API void * Malloc(AkMemPoolId in_poolId, size_t in_uSize)

AK::MemoryMgr::TrimForThread

AKSOUNDENGINE_API void TrimForThread()

AkMemPoolId

AkInt32 AkMemPoolId

Memory pool ID

Definition: AkTypes.h:62

AkMemID_Profiler

@ AkMemID_Profiler

Profiler.

Definition: AkMemoryMgr.h:62

AkMemID

Definition: AkMemoryMgr.h:47

AkOSChar

char AkOSChar

Generic character string

Definition: AkTypes.h:60

AK::MemoryMgr::CategoryStats::uAllocs

AkUInt32 uAllocs

Number of allocation calls since initialization

Definition: AkMemoryMgr.h:99

AK::MemoryMgr::Term

AKSOUNDENGINE_API void Term()

AK::MemoryMgr::GetGlobalStats

AKSOUNDENGINE_API void GetGlobalStats(GlobalStats &out_stats)

AK::MemoryMgr::InitForThread

AKSOUNDENGINE_API void InitForThread()

AkMemID_SpatialAudioGeometry

@ AkMemID_SpatialAudioGeometry

Spatial audio geometry data.

Definition: AkMemoryMgr.h:58

AK::MemoryMgr::GlobalStats::uReserved

AkUInt64 uReserved

Total reserved memory. (Used and unused). Will return 0 if the reserved memory is not traceable.

Definition: AkMemoryMgr.h:112

AkMemID_BookmarkAlloc

@ AkMemID_BookmarkAlloc

Allocations serviced by the bookmark allocator

Definition: AkMemoryMgr.h:68

AK::MemoryMgr::dReallocAligned

AKSOUNDENGINE_API void * dReallocAligned(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize, AkUInt32 in_uAlignment, const char *in_pszFile, AkUInt32 in_uLine)

AkMemID_JobMgr

@ AkMemID_JobMgr

Allocations for Sound Engine jobs and job dependencies.

Definition: AkMemoryMgr.h:66

AK::MemoryMgr::Malign

AKSOUNDENGINE_API void * Malign(AkMemPoolId in_poolId, size_t in_uSize, AkUInt32 in_uAlignment)

AkMemSettings

Definition: AkMemoryMgrModule.h:149

AkMemID_SoundEngine

@ AkMemID_SoundEngine

Base sound engine allocations (managers, etc).

Definition: AkMemoryMgr.h:64