Audaspace Refactor:
[blender.git] / intern / audaspace / intern / AUD_I3DDevice.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_I3DDEVICE
27 #define AUD_I3DDEVICE
28
29 #include "AUD_Space.h"
30
31 /**
32  * This class represents an output device for 3D sound.
33  */
34 class AUD_I3DDevice
35 {
36 public:
37         /**
38          * Plays a 3D sound source.
39          * \param factory The factory to create the reader for the sound source.
40          * \param keep When keep is true the sound source will not be deleted but
41          *             set to paused when its end has been reached.
42          * \return Returns a handle with which the playback can be controlled.
43          *         This is NULL if the sound couldn't be played back.
44          * \exception AUD_Exception Thrown if there's an unexpected (from the
45          *            device side) error during creation of the reader.
46          * \note The factory must provide a mono (single channel) source otherwise
47          *       the sound is played back normally.
48          */
49         virtual AUD_Handle* play3D(AUD_IFactory* factory, bool keep = false)=0;
50
51         /**
52          * Updates a listeners 3D data.
53          * \param data The 3D data.
54          * \return Whether the action succeeded.
55          */
56         virtual bool updateListener(AUD_3DData &data)=0;
57
58         /**
59          * Sets a 3D device setting.
60          * \param setting The setting type.
61          * \param value The new setting value.
62          * \return Whether the action succeeded.
63          */
64         virtual bool setSetting(AUD_3DSetting setting, float value)=0;
65
66         /**
67          * Retrieves a 3D device setting.
68          * \param setting The setting type.
69          * \return The setting value.
70          */
71         virtual float getSetting(AUD_3DSetting setting)=0;
72
73         /**
74          * Updates a listeners 3D data.
75          * \param handle The source handle.
76          * \param data The 3D data.
77          * \return Whether the action succeeded.
78          */
79         virtual bool updateSource(AUD_Handle* handle, AUD_3DData &data)=0;
80
81         /**
82          * Sets a 3D source setting.
83          * \param handle The source handle.
84          * \param setting The setting type.
85          * \param value The new setting value.
86          * \return Whether the action succeeded.
87          */
88         virtual bool setSourceSetting(AUD_Handle* handle,
89                                                                   AUD_3DSourceSetting setting, float value)=0;
90
91         /**
92          * Retrieves a 3D source setting.
93          * \param handle The source handle.
94          * \param setting The setting type.
95          * \return The setting value.
96          */
97         virtual float getSourceSetting(AUD_Handle* handle,
98                                                                    AUD_3DSourceSetting setting)=0;
99 };
100
101 #endif //AUD_I3DDEVICE