* First commit merging 2.4-based sim_physics in to volume25 branch.
[blender.git] / intern / audaspace / intern / AUD_SoftwareDevice.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_SOFTWAREDEVICE
27 #define AUD_SOFTWAREDEVICE
28
29 #include "AUD_IDevice.h"
30 struct AUD_SoftwareHandle;
31 class AUD_IMixer;
32
33 #include <list>
34 #include <pthread.h>
35
36 /**
37  * This device plays is a generic device with software mixing.
38  * Classes implementing this have to:
39  *  - Implement the playing function.
40  *  - Prepare the m_specs, m_mixer variables.
41  *  - Call the create and destroy functions.
42  *  - Call the mix function to retrieve their audio data.
43  */
44 class AUD_SoftwareDevice : public AUD_IDevice
45 {
46 protected:
47         /**
48          * The specification of the device.
49          */
50         AUD_Specs m_specs;
51
52         /**
53          * The mixer. Will be deleted by the destroy function.
54          */
55         AUD_IMixer* m_mixer;
56
57         /**
58          * Initializes member variables.
59          */
60         void create();
61
62         /**
63          * Uninitializes member variables.
64          */
65         void destroy();
66
67         /**
68          * Mixes the next samples into the buffer.
69          * \param buffer The target buffer.
70          * \param length The length in samples to be filled.
71          */
72         void mix(sample_t* buffer, int length);
73
74         /**
75          * This function tells the device, to start or pause playback.
76          * \param playing True if device should playback.
77          */
78         virtual void playing(bool playing)=0;
79
80 private:
81         /**
82          * The list of sounds that are currently playing.
83          */
84         std::list<AUD_SoftwareHandle*>* m_playingSounds;
85
86         /**
87          * The list of sounds that are currently paused.
88          */
89         std::list<AUD_SoftwareHandle*>* m_pausedSounds;
90
91         /**
92          * Whether there is currently playback.
93          */
94         bool m_playback;
95
96         /**
97          * The mutex for locking.
98          */
99         pthread_mutex_t m_mutex;
100
101         /**
102          * The overall volume of the device.
103          */
104         float m_volume;
105
106         /**
107          * Checks if a handle is valid.
108          * \param handle The handle to check.
109          * \return Whether the handle is valid.
110          */
111         bool isValid(AUD_Handle* handle);
112
113 public:
114         /**
115          * Sets a new mixer.
116          * \param mixer The new mixer.
117          */
118         void setMixer(AUD_IMixer* mixer);
119
120         virtual AUD_Specs getSpecs();
121         virtual AUD_Handle* play(AUD_IFactory* factory, bool keep = false);
122         virtual bool pause(AUD_Handle* handle);
123         virtual bool resume(AUD_Handle* handle);
124         virtual bool stop(AUD_Handle* handle);
125         virtual bool setKeep(AUD_Handle* handle, bool keep);
126         virtual bool sendMessage(AUD_Handle* handle, AUD_Message &message);
127         virtual bool seek(AUD_Handle* handle, float position);
128         virtual float getPosition(AUD_Handle* handle);
129         virtual AUD_Status getStatus(AUD_Handle* handle);
130         virtual void lock();
131         virtual void unlock();
132         virtual bool checkCapability(int capability);
133         virtual bool setCapability(int capability, void *value);
134         virtual bool getCapability(int capability, void *value);
135 };
136
137 #endif //AUD_SOFTWAREDEVICE