Table of Contents

Wwise SDK 2019.1.8
AkBytesMem.h
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 // AkBytesMem.h
29 
30 /// \file
31 /// IReadBytes / IWriteBytes implementation on a growing memory buffer. This
32 /// version uses the AK::MemoryMgr memory pools.
33 
34 #pragma once
35 
36 #include <AK/IBytes.h>
37 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
38 #include <AK/Tools/Common/AkBankReadHelpers.h>
39 
40 namespace AK
41 {
42  class ReadBytesMem
43  : public AK::IReadBytes
44  {
45  public:
46 
47  AKSOUNDENGINE_API ReadBytesMem();
48  AKSOUNDENGINE_API ReadBytesMem(
49  const void * in_pBytes,
50  AkInt32 in_cBytes
51  );
52  AKSOUNDENGINE_API virtual ~ReadBytesMem();
53 
54  // IReadBytes implementation
55 
56  AKSOUNDENGINE_API virtual bool ReadBytes(
57  void * in_pData,
58  AkInt32 in_cBytes,
59  AkInt32 & out_cRead
60  );
61 
62  // Public methods
63 
64  AKSOUNDENGINE_API void Attach(
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 
81  AKSOUNDENGINE_API WriteBytesMem();
82  AKSOUNDENGINE_API virtual ~WriteBytesMem();
83 
84  // IWriteBytes implementation
85 
86  AKSOUNDENGINE_API virtual bool WriteBytes(
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 
99  AKSOUNDENGINE_API virtual void SetCount(
100  AkInt32 in_cBytes
101  );
102 
103  AKSOUNDENGINE_API virtual AkUInt8 * Bytes() const;
104 
105  AKSOUNDENGINE_API virtual AkUInt8 * Detach();
106 
107  AKSOUNDENGINE_API virtual void Clear();
108 
109  // Public methods
110 
111  AKSOUNDENGINE_API void SetMemPool( AkMemPoolId in_pool );
112 
113  template<class T>
114  bool Write(const T & in_data)
115  {
116  AkInt32 cPos = m_cPos;
117  AkInt32 cNewPos = cPos + sizeof(T);
118 
119  if ((m_cBytes >= cNewPos) || Grow(cNewPos))
120  {
121  AK::WriteUnaligned<T>(m_pBytes + cPos, in_data);
122  m_cPos = cNewPos;
123  return true;
124  }
125  else
126  return false;
127  }
128 
129  private:
130  bool Grow(
131  AkInt32 in_cBytes
132  );
133 
134  AkInt32 m_cBytes;
135  AkUInt8 * m_pBytes;
136 
137  AkInt32 m_cPos;
138 
139  AkMemPoolId m_pool;
140  };
141 }
virtual bool Reserve(AkInt32 in_cBytes)
virtual ~WriteBytesMem()
Audiokinetic namespace.
virtual void SetCount(AkInt32 in_cBytes)
Set number of bytes written.
virtual void Clear()
Clear the buffer contents.
virtual bool WriteBytes(const void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cWritten)
virtual ~ReadBytesMem()
virtual bool ReadBytes(void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cRead)
virtual AkUInt8 * Detach()
Return pointer to buffer and clear internal pointer.
virtual AkInt32 Count() const
virtual AkUInt8 * Bytes() const
void Attach(const void *in_pBytes, AkInt32 in_cBytes)
bool Write(const T &in_data)
Definition: AkBytesMem.h:114
void SetMemPool(AkMemPoolId in_pool)