svn merge -r 31145:31210 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / intern / audaspace / intern / AUD_Buffer.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * AudaSpace is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_BUFFER
27 #define AUD_BUFFER
28
29 #include "AUD_Space.h"
30
31 /**
32  * This class is a simple buffer in RAM which is 16 Byte aligned and provides
33  * resize functionality.
34  */
35 class AUD_Buffer
36 {
37 private:
38         /// The size of the buffer in bytes.
39         int m_size;
40
41         /// The pointer to the buffer memory.
42         data_t* m_buffer;
43
44         // hide copy constructor and operator=
45         AUD_Buffer(const AUD_Buffer&);
46         AUD_Buffer& operator=(const AUD_Buffer&);
47
48 public:
49         /**
50          * Creates a new buffer.
51          * \param size The size of the buffer in bytes.
52          */
53         AUD_Buffer(int size = 0);
54
55         /**
56          * Destroys the buffer.
57          */
58         ~AUD_Buffer();
59
60         /**
61          * Returns the pointer to the buffer in memory.
62          */
63         sample_t* getBuffer() const;
64
65         /**
66          * Returns the size of the buffer in bytes.
67          */
68         int getSize() const;
69
70         /**
71          * Resizes the buffer.
72          * \param size The new size of the buffer, measured in bytes.
73          * \param keep Whether to keep the old data. If the new buffer is smaller,
74          *        the data at the end will be lost.
75          */
76         void resize(int size, bool keep = false);
77 };
78
79 #endif //AUD_BUFFER