tmp
[blender.git] / extern / audaspace / include / util / Buffer.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 /**
20  * @file Buffer.h
21  * @ingroup util
22  * The Buffer class.
23  */
24
25 #include "Audaspace.h"
26
27 AUD_NAMESPACE_BEGIN
28
29 /**
30  * This class is a simple buffer in RAM which is 32 Byte aligned and provides
31  * resize functionality.
32  */
33 class AUD_API Buffer
34 {
35 private:
36         /// The size of the buffer in bytes.
37         int m_size;
38
39         /// The pointer to the buffer memory.
40         data_t* m_buffer;
41
42         // delete copy constructor and operator=
43         Buffer(const Buffer&) = delete;
44         Buffer& operator=(const Buffer&) = delete;
45
46 public:
47         /**
48          * Creates a new buffer.
49          * \param size The size of the buffer in bytes.
50          */
51         Buffer(int size = 0);
52
53         /**
54          * Destroys the buffer.
55          */
56         ~Buffer();
57
58         /**
59          * Returns the pointer to the buffer in memory.
60          */
61         sample_t* getBuffer() const;
62
63         /**
64          * Returns the size of the buffer in bytes.
65          */
66         int getSize() const;
67
68         /**
69          * Resizes the buffer.
70          * \param size The new size of the buffer, measured in bytes.
71          * \param keep Whether to keep the old data. If the new buffer is smaller,
72          *        the data at the end will be lost.
73          */
74         void resize(int size, bool keep = false);
75
76         /**
77          * Makes sure the buffer has a minimum size.
78          * If size is >= current size, nothing will happen.
79          * Otherwise the buffer is resized with keep as parameter.
80          * \param size The new minimum size of the buffer, measured in bytes.
81          * \param keep Whether to keep the old data. If the new buffer is smaller,
82          *        the data at the end will be lost.
83          */
84         void assureSize(int size, bool keep = false);
85 };
86
87 AUD_NAMESPACE_END