Wwise Version
Wwise SDK 2021.1.6
AkBytesMem.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.6 Build: 7774
25  Copyright (c) 2006-2022 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // AkBytesMem.h
29 
30 /// \file
31 /// IReadBytes / IWriteBytes implementation on a growing memory buffer. This
32 /// version uses the AK::MemoryMgr allocator.
33 
34 #pragma once
35 
36 #include <AK/IBytes.h>
39 
40 namespace AK
41 {
42  class ReadBytesMem
43  : public AK::IReadBytes
44  {
45  public:
46 
49  const void * in_pBytes,
50  AkInt32 in_cBytes
51  );
53 
54  // IReadBytes implementation
55 
57  void * in_pData,
58  AkInt32 in_cBytes,
59  AkInt32 & out_cRead
60  );
61 
62  // Public methods
63 
65  const void * in_pBytes,
66  AkInt32 in_cBytes
67  );
68 
69  private:
70  AkInt32 m_cBytes;
71  const AkUInt8 * m_pBytes;
72 
73  AkInt32 m_cPos;
74  };
75 
77  : public AK::IWriteBuffer
78  {
79  public:
80 
83 
84  // IWriteBytes implementation
85 
87  const void * in_pData,
88  AkInt32 in_cBytes,
89  AkInt32& out_cWritten);
90 
91  // IWriteBuffer implementation
92 
93  AKSOUNDENGINE_API virtual bool Reserve(
94  AkInt32 in_cBytes
95  );
96 
97  AKSOUNDENGINE_API virtual AkInt32 Count() const;
98 
100  AkInt32 in_cBytes
101  );
102 
104 
105  AKSOUNDENGINE_API virtual AkUInt8 * Bytes() const;
106 
108 
109  AKSOUNDENGINE_API virtual void Clear();
110 
111  // Public methods
112 
114 
115  // Reserves space for writing in_cBytes and returns the location, advancing the write pointer.
117  {
118  AkInt32 cPos = m_cPos;
119  AkInt32 cNewPos = cPos + in_cBytes;
120 
121  if ((m_cBytes >= cNewPos) || Grow(cNewPos))
122  {
123  m_cPos = cNewPos;
124  return m_pBytes + cPos;
125  }
126  else
127  return nullptr;
128  }
129 
130  template<class T>
131  bool Write(const T & in_data)
132  {
133  if (AkUInt8* pWrite = GetWritePtr(sizeof(T)))
134  {
135  AK::WriteUnaligned<T>(pWrite, in_data);
136  return true;
137  }
138  else
139  return false;
140  }
141 
142  private:
143  bool Grow(
144  AkInt32 in_cBytes
145  );
146 
147  AkInt32 m_cBytes;
148  AkUInt8 * m_pBytes;
149 
150  AkInt32 m_cPos;
151 
152  AkMemPoolId m_pool;
153  };
154 
156  : public AK::IWriteBytes
157  {
158  public:
159 
161 
163 
164  AKSOUNDENGINE_API void SetBuffer(AkUInt8* in_pBytes, AkInt32 in_cSize);
165 
166  // IWriteBytes implementation
167 
169  const void* in_pData,
170  AkInt32 in_cBytes,
171  AkInt32& out_cWritten);
172 
174 
176 
177  private:
178 
179  AkUInt8* m_pBytes;
180  AkInt32 m_cSize;
181  AkInt32 m_cPos;
182  };
183 }
virtual bool Reserve(AkInt32 in_cBytes)
Audiokinetic namespace.
void Attach(const void *in_pBytes, AkInt32 in_cBytes)
virtual AkUInt8 * Detach()
Return pointer to buffer and clear internal pointer.
virtual ~ReadBytesMem()
uint8_t AkUInt8
Unsigned 8-bit integer.
Definition: AkTypes.h:57
AkInt32 AkMemPoolId
Memory pool ID.
Definition: AkTypes.h:67
virtual bool WriteBytes(const void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cWritten)
#define AKSOUNDENGINE_API
bool Write(const T &in_data)
Definition: AkBytesMem.h:131
virtual ~WriteBytesBuffer()
AkInt32 GetPos() const
void SetBuffer(AkUInt8 *in_pBytes, AkInt32 in_cSize)
ReadBytesMem(const void *in_pBytes, AkInt32 in_cBytes)
virtual void SetCount(AkInt32 in_cBytes)
Set number of bytes written.
AkInt32 Size() const
virtual ~WriteBytesMem()
virtual AkUInt8 * Bytes() const
virtual AkInt32 Count() const
virtual bool ReadBytes(void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cRead)
int32_t AkInt32
Signed 32-bit integer.
Definition: AkTypes.h:64
virtual bool WriteBytes(const void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cWritten)
virtual void Clear()
Clear the buffer contents.
void SetMemPool(AkMemPoolId in_pool)
AkUInt8 * GetWritePtr(AkInt32 in_cBytes)
Definition: AkBytesMem.h:116