Wwise Version
Wwise SDK 2019.2.13
AkRingBuffer.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: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 #pragma once
29 
33 
34 template <AkMemID T_MEMID>
36 {
37  static AkForceInline void* Alloc(size_t in_uSize)
38  {
39  return AkAlloc(T_MEMID, in_uSize);
40  }
41 
42  static AkForceInline void Free(void * in_pAddress)
43  {
44  AkFree(T_MEMID, in_pAddress);
45  }
46 };
47 
48 template <AkMemID T_MEMID>
50 {
51  static AkForceInline void* Alloc(size_t in_uSize)
52  {
53  return AkMalign(T_MEMID, in_uSize, AK_SIMD_ALIGNMENT);
54  }
55 
56  static AkForceInline void Free(void * in_pAddress)
57  {
58  AkFalign(T_MEMID, in_pAddress);
59  }
60 };
61 
65 
66 template <class T, class TAlloc = AkRingBufferAllocatorDefault>
67 
69 {
70 public:
72  : m_nbItems(0)
73  , m_readIndex(0)
74  , m_writeIndex(0)
75  , m_nbReadableItems(0)
76  {
77  }
78 
80  {
81  m_nbItems = nbItems;
82  m_readIndex = 0;
83  m_writeIndex = 0;
84  m_nbReadableItems = 0;
85 
86  m_data = reinterpret_cast<T*>(TAlloc::Alloc(m_nbItems * sizeof(T)));
87  if (m_data == NULL)
88  {
89  return AK_InsufficientMemory;
90  }
91  return AK_Success;
92  }
93 
94  void Term()
95  {
96  m_nbItems = 0;
97  m_readIndex = 0;
98  m_writeIndex = 0;
99  m_nbReadableItems = 0;
100 
101  if (m_data != NULL)
102  {
103  TAlloc::Free(reinterpret_cast<void*>(m_data));
104  m_data = NULL;
105  }
106  }
107 
108  // ---- Producer ---- //
109 
111  {
112  return m_writeIndex;
113  }
114 
116  {
117  return &m_data[m_writeIndex];
118  }
119 
121  {
122  AKASSERT(GetNbWritableItems() >= nbItems);
123 
124  m_writeIndex = (m_writeIndex + nbItems) % m_nbItems;
125 
126  AkAtomicAdd32(&m_nbReadableItems, nbItems);
127  }
128 
129  // ---- Consumer ----
130 
132  {
133  return m_readIndex;
134  }
135 
136  const T* GetReadPtr() const
137  {
138  return &m_data[m_readIndex];
139  }
140 
142  {
143  AKASSERT((AkUInt32)m_nbReadableItems >= nbItems);
144 
145  m_readIndex = (m_readIndex + nbItems) % m_nbItems;
146 
147  AkAtomicSub32(&m_nbReadableItems, nbItems);
148  }
149 
151  {
152  return m_nbReadableItems;
153  }
154 
156  {
157  return m_nbItems - m_nbReadableItems;
158  }
159 
160  AkUInt32 Size() const
161  {
162  return m_nbItems;
163  }
164 
165 private:
166  T* m_data{nullptr};
167 
168  AkUInt32 m_nbItems;
169  AkUInt32 m_readIndex;
170  AkUInt32 m_writeIndex;
171  AkAtomic32 m_nbReadableItems;
172 };
__forceinline long AkAtomicAdd32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:59
AkRingBuffer()
Definition: AkRingBuffer.h:71
#define AkForceInline
Force inlining.
Definition: AkTypes.h:66
AkUInt32 GetReadIndex() const
Definition: AkRingBuffer.h:131
const T * GetReadPtr() const
Definition: AkRingBuffer.h:136
AkUInt32 GetWriteIndex() const
Definition: AkRingBuffer.h:110
#define AkFree(_pool, _pvmem)
Definition: AkObject.h:82
static AkForceInline void Free(void *in_pAddress)
Definition: AkRingBuffer.h:56
AKSOUNDENGINE_API void Free(AkMemPoolId in_poolId, void *in_pMemAddress)
static AkForceInline void * Alloc(size_t in_uSize)
Definition: AkRingBuffer.h:37
AKRESULT
Standard function call result.
Definition: AkTypes.h:122
AkRingBufferAllocatorAligned< AkMemID_Processing > AkRingBufferAllocatorLEngineAligned
Definition: AkRingBuffer.h:64
void Term()
Definition: AkRingBuffer.h:94
static AkForceInline void * Alloc(size_t in_uSize)
Definition: AkRingBuffer.h:51
AkRingBufferAllocatorNoAlign< AkMemID_Object > AkRingBufferAllocatorDefault
Definition: AkRingBuffer.h:62
#define AkAlloc(_pool, _size)
Definition: AkObject.h:76
#define NULL
Definition: AkTypes.h:49
@ AK_Success
The operation was successful.
Definition: AkTypes.h:124
static AkForceInline void Free(void *in_pAddress)
Definition: AkRingBuffer.h:42
void IncrementReadIndex(AkUInt32 nbItems)
Definition: AkRingBuffer.h:141
#define AK_SIMD_ALIGNMENT
Platform-specific alignment requirement for SIMD data.
Definition: AkTypes.h:69
AkUInt32 GetNbReadableItems() const
Definition: AkRingBuffer.h:150
AkUInt32 Size() const
Definition: AkRingBuffer.h:160
AkUInt32 GetNbWritableItems() const
Definition: AkRingBuffer.h:155
#define AKASSERT(Condition)
Definition: AkAssert.h:76
AKRESULT Init(AkUInt32 nbItems)
Definition: AkRingBuffer.h:79
T * GetWritePtr()
Definition: AkRingBuffer.h:115
#define AkMalign(_pool, _size, _align)
Definition: AkObject.h:77
#define AkFalign(_pool, _pvmem)
Definition: AkObject.h:83
volatile long AkAtomic32
Definition: AkAtomic.h:38
void IncrementWriteIndex(AkUInt32 nbItems)
Definition: AkRingBuffer.h:120
__forceinline long AkAtomicSub32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:60
@ AK_InsufficientMemory
Memory error.
Definition: AkTypes.h:152
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:85
AkRingBufferAllocatorNoAlign< AkMemID_Processing > AkRingBufferAllocatorLEngine
Definition: AkRingBuffer.h:63