3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_StreamBufferFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 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 General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/intern/AUD_StreamBufferFactory.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_STREAMBUFFERFACTORY
33 #define AUD_STREAMBUFFERFACTORY
34
35 #include "AUD_IFactory.h"
36 #include "AUD_Reference.h"
37 #include "AUD_Buffer.h"
38
39 /**
40  * This factory creates a buffer out of a reader. This way normally streamed
41  * sound sources can be loaded into memory for buffered playback.
42  */
43 class AUD_StreamBufferFactory : public AUD_IFactory
44 {
45 private:
46         /**
47          * The buffer that holds the audio data.
48          */
49         AUD_Reference<AUD_Buffer> m_buffer;
50
51         /**
52          * The specification of the samples.
53          */
54         AUD_Specs m_specs;
55
56         // hide copy constructor and operator=
57         AUD_StreamBufferFactory(const AUD_StreamBufferFactory&);
58         AUD_StreamBufferFactory& operator=(const AUD_StreamBufferFactory&);
59
60 public:
61         /**
62          * Creates the factory and reads the reader created by the factory supplied
63          * to the buffer.
64          * \param factory The factory that creates the reader for buffering.
65          * \exception AUD_Exception Thrown if the reader cannot be created.
66          */
67         AUD_StreamBufferFactory(AUD_Reference<AUD_IFactory> factory);
68
69         virtual AUD_Reference<AUD_IReader> createReader();
70 };
71
72 #endif //AUD_STREAMBUFFERFACTORY