Table of Contents

Wwise SDK 2019.1.9
AkBytesCount.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 // AkBytesCount.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 {
43  : public AK::IReadBytes
44  {
45  public:
46 
47  AKSOUNDENGINE_API ReadBytesSkip();
48  AKSOUNDENGINE_API ReadBytesSkip(
49  const void * in_pBytes,
50  AkInt32 in_cBytes
51  );
52  AKSOUNDENGINE_API virtual ~ReadBytesSkip();
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  AKSOUNDENGINE_API AkInt32 Count();
70 
71  private:
72  AkInt32 m_cBytes;
73  const AkUInt8 * m_pBytes;
74  AkInt32 m_cPos;
75  };
76 
78  : public AK::IWriteBuffer
79  {
80  public:
81 
82  AKSOUNDENGINE_API WriteBytesCount();
83  AKSOUNDENGINE_API virtual ~WriteBytesCount();
84 
85  // IWriteBytes implementation
86 
87  AKSOUNDENGINE_API virtual bool WriteBytes(
88  const void * in_pData,
89  AkInt32 in_cBytes,
90  AkInt32& out_cWritten);
91 
92  // IWriteBuffer implementation
93 
94  AKSOUNDENGINE_API virtual bool Reserve(
95  AkInt32 in_cBytes
96  );
97 
98  AKSOUNDENGINE_API virtual AkInt32 Count() const;
99 
100  AKSOUNDENGINE_API virtual void SetCount(
101  AkInt32 in_cBytes
102  );
103 
104  AKSOUNDENGINE_API virtual AkUInt8 * Bytes() const;
105 
106  AKSOUNDENGINE_API virtual AkUInt8 * Detach();
107 
108  AKSOUNDENGINE_API virtual void Clear();
109 
110  // Public methods
111 
112  AKSOUNDENGINE_API void SetMemPool( AkMemPoolId in_pool );
113 
114  template<class T>
115  bool Write(const T & in_data)
116  {
117  m_cPos += sizeof(T);
118  return true;
119  }
120 
121  private:
122  bool Grow(
123  AkInt32 in_cBytes
124  );
125 
126  AkInt32 m_cPos;
127  };
128 }
Audiokinetic namespace.
virtual AkUInt8 * Bytes() const
virtual AkUInt8 * Detach()
Return pointer to buffer and clear internal pointer.
virtual void Clear()
Clear the buffer contents.
AkInt32 Count()
virtual ~ReadBytesSkip()
bool Write(const T &in_data)
Definition: AkBytesCount.h:115
virtual ~WriteBytesCount()
virtual bool WriteBytes(const void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cWritten)
virtual void SetCount(AkInt32 in_cBytes)
Set number of bytes written.
virtual bool ReadBytes(void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cRead)
void Attach(const void *in_pBytes, AkInt32 in_cBytes)
virtual AkInt32 Count() const
virtual bool Reserve(AkInt32 in_cBytes)
void SetMemPool(AkMemPoolId in_pool)