3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_FileFactory.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_FileFactory.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_FILEFACTORY
33 #define AUD_FILEFACTORY
34
35 #include "AUD_IFactory.h"
36 #include "AUD_Reference.h"
37 class AUD_Buffer;
38
39 #include <string>
40
41 /**
42  * This factory tries to read a sound file via all available file readers.
43  */
44 class AUD_FileFactory : public AUD_IFactory
45 {
46 private:
47         /**
48          * The filename of the sound source file.
49          */
50         std::string m_filename;
51
52         /**
53          * The buffer to read from.
54          */
55         AUD_Reference<AUD_Buffer> m_buffer;
56
57         // hide copy constructor and operator=
58         AUD_FileFactory(const AUD_FileFactory&);
59         AUD_FileFactory& operator=(const AUD_FileFactory&);
60
61 public:
62         /**
63          * Creates a new factory.
64          * \param filename The sound file path.
65          */
66         AUD_FileFactory(std::string filename);
67
68         /**
69          * Creates a new factory.
70          * \param buffer The buffer to read from.
71          * \param size The size of the buffer.
72          */
73         AUD_FileFactory(const data_t* buffer, int size);
74
75         virtual AUD_Reference<AUD_IReader> createReader() const;
76 };
77
78 #endif //AUD_FILEFACTORY