3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_IFactory.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_IFactory.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_IFACTORY
33 #define AUD_IFACTORY
34
35 #include "AUD_Space.h"
36 #include "AUD_Reference.h"
37 class AUD_IReader;
38
39 /**
40  * This class represents a type of sound source and saves the necessary values
41  * for it. It is able to create a reader that is actually usable for playback
42  * of the respective sound source through the factory method createReader.
43  */
44 class AUD_IFactory
45 {
46 public:
47         /**
48          * Destroys the factory.
49          */
50         virtual ~AUD_IFactory(){}
51
52         /**
53          * Creates a reader for playback of the sound source.
54          * \return A pointer to an AUD_IReader object or NULL if there has been an
55          *         error.
56          * \exception AUD_Exception An exception may be thrown if there has been
57          *            a more unexpected error during reader creation.
58          */
59         virtual AUD_Reference<AUD_IReader> createReader() const=0;
60 };
61
62 #endif //AUD_IFACTORY