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