Wwise Version
Wwise SDK 2021.1.2
AkAllocator.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: v2021.1.2 Build: 7629
25  Copyright (c) 2006-2021 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // AkAllocator.h
29 
30 #ifndef _AK_TOOLS_COMMON_AKALLOCATOR_H
31 #define _AK_TOOLS_COMMON_AKALLOCATOR_H
32 
34 #include <AK/AkPlatforms.h>
35 
36 #ifdef AK_WIN
37 #include <cstdlib>
38 #endif
39 
40 namespace AK
41 {
42  // Audiokinetic Wwise namespace
43  namespace Wwise
44  {
45  class Mallocator
46  : public AK::IAkPluginMemAlloc
47  {
48  public:
49  virtual void* Malloc(
50  size_t in_uSize,
51  const char*,
52  AkUInt32
53  ) override
54  {
55  return malloc(in_uSize);
56  }
57 
58  virtual void Free(void* in_pMemAddress) override
59  {
60  free(in_pMemAddress);
61  }
62 
63  virtual void* Malign(
64  size_t in_uSize,
65  size_t in_uAlignment,
66  const char*,
67  AkUInt32
68  ) override
69  {
70  #ifdef AK_WIN
71  return _aligned_malloc(in_uSize, in_uAlignment);
72  #else
73  return aligned_alloc(in_uAlignment, in_uSize);
74  #endif
75  }
76 
77  virtual void* Realloc(
78  void* in_pMemAddress,
79  size_t in_uSize,
80  const char*,
81  AkUInt32
82  ) override
83  {
84  return realloc(in_pMemAddress, in_uSize);
85  }
86 
87  virtual void* ReallocAligned(
88  void* in_pMemAddress,
89  size_t in_uSize,
90  size_t in_uAlignment,
91  const char*,
92  AkUInt32
93  ) override
94  {
95  #ifdef AK_WIN
96  return _aligned_realloc(in_pMemAddress, in_uSize, in_uAlignment);
97  #else
98  AKASSERT(!"ReallocAligned is not supported: using realloc")
99  return realloc(in_pMemAddress, in_uSize);
100  #endif
101  }
102  };
103 
104  template<typename T>
106  {
107  public:
109  : m_pAlloc(in_pAlloc),
110  m_pPtr(nullptr)
111  {
112  }
113 
115  {
116  if (m_pPtr)
117  {
118  m_pAlloc->Free(m_pPtr);
119  }
120  }
121 
122  T* operator->() { return m_pPtr; }
123  T& operator*() { return *m_pPtr; }
124 
125  explicit operator</span> bool() const { return m_pPtr != nullptr; }
126  operator</span> T*&() { return m_pPtr; }
127 
128  private:
129  AK::IAkPluginMemAlloc* m_pAlloc;
130  T* m_pPtr;
131  };
132  }
133 }
134 
135 #endif // _AK_TOOLS_COMMON_AKALLOCATOR_H
Audiokinetic namespace.
virtual void * Malign(size_t in_uSize, size_t in_uAlignment, const char *, AkUInt32) override
Definition: AkAllocator.h:63
SafeAllocator(AK::IAkPluginMemAlloc *in_pAlloc)
Definition: AkAllocator.h:108
virtual void Free(void *in_pMemAddress) override
Definition: AkAllocator.h:58
virtual void * Realloc(void *in_pMemAddress, size_t in_uSize, const char *, AkUInt32) override
Definition: AkAllocator.h:77
virtual void * Malloc(size_t in_uSize, const char *, AkUInt32) override
Definition: AkAllocator.h:49
virtual void * ReallocAligned(void *in_pMemAddress, size_t in_uSize, size_t in_uAlignment, const char *, AkUInt32) override
Definition: AkAllocator.h:87
#define AKASSERT(Condition)
Definition: AkAssert.h:76
virtual void Free(void *in_pMemAddress)=0
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:77