Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/sound/SoundManager.h @ 8319

Last change on this file since 8319 was 7858, checked in by landauf, 14 years ago

removed some spaces

  • Property svn:eol-style set to native
File size: 5.2 KB
RevLine 
[3060]1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *       Erwin 'vaiursch' Herrsche
[6417]24 *       Kevin Young
25 *       Reto Grieder
[3060]26 *   Co-authors:
27 *      ...
28 */
[6417]29
[3196]30#ifndef _SoundManager_H__
31#define _SoundManager_H__
[3060]32
33#include "OrxonoxPrereqs.h"
34
[3196]35#include <list>
[6417]36#include <map>
37#include <string>
38#include <boost/shared_ptr.hpp>
39
[3370]40#include "util/Singleton.h"
[6417]41#include "core/OrxonoxClass.h"
42#include "core/SmartPtr.h"
[3196]43
[6417]44// tolua_begin
[3060]45namespace orxonox
46{
[6417]47    //! Enum for the sound type.
48    namespace SoundType
[3060]49    {
[6417]50        enum Value
51        {
52            All     = 0,
53            Music   = 1,
54            Effects = 2
55        };
56    }
57
58    //! The SoundManager class manages the OpenAL device, context and listener position.
59    class _OrxonoxExport SoundManager
60    // tolua_end
61        : public Singleton<SoundManager>, public OrxonoxClass
62    { // tolua_export
[3370]63        friend class Singleton<SoundManager>;
[6417]64
[3060]65    public:
66        SoundManager();
67        ~SoundManager();
68
[6417]69        void preUpdate(const Clock& time);
70        void setConfigValues();
71
72        // tolua_begin
73        static SoundManager& getInstance() { return Singleton<SoundManager>::getInstance(); }
74
75        std::string getDeviceName(unsigned int index) const
76            { return index < this->deviceNames_.size() ? this->deviceNames_[index] : std::string(); }
77        // tolua_end
78
[5929]79        void setListenerPosition(const Vector3& position);
80        void setListenerOrientation(const Quaternion& orientation);
81
[6417]82        void registerAmbientSound(AmbientSound* newAmbient);
83        void unregisterAmbientSound(AmbientSound* oldAmbient);
84        void pauseAmbientSound(AmbientSound* ambient);
85
86        // tolua_begin
87        void setVolume(float vol, SoundType::Value type);
88        float getVolume(SoundType::Value type);
89        float getRealVolume(SoundType::Value type);
90
91        void toggleMute(SoundType::Value type);
92        bool getMute(SoundType::Value type);
93        // tolua_end
94
95        shared_ptr<SoundBuffer> getSoundBuffer(const std::string& filename);
96        void releaseSoundBuffer(const shared_ptr<SoundBuffer>& buffer, bool bPoolBuffer);
97
98        ALuint getSoundSource(BaseSound* object);
99        void releaseSoundSource(ALuint source);
100
101        static std::string getALErrorString(ALenum error);
102
[3060]103    private:
[6417]104        void processCrossFading(float dt);
105        void fadeIn(const SmartPtr<AmbientSound>& sound);
106        void fadeOut(const SmartPtr<AmbientSound>& sound);
107
108        void checkFadeStepValidity();
109
110        void checkVolumeValidity(SoundType::Value type);
111        void checkSoundVolumeValidity()   { this->checkVolumeValidity(SoundType::All); }
112        void checkAmbientVolumeValidity() { this->checkVolumeValidity(SoundType::Music); }
113        void checkEffectsVolumeValidity() { this->checkVolumeValidity(SoundType::Effects); }
114        void updateVolume(SoundType::Value type);
115
116        unsigned int createSoundSources(unsigned int n);
117
118        // OpenAL device/context related
119        std::vector<std::string> deviceNames_;
[3280]120        ALCdevice* device_;
[3060]121        ALCcontext* context_;
122
[6417]123        // Ambient sound related
124        typedef std::list<std::pair<AmbientSound*, bool> > AmbientList;
125        AmbientList                        ambientSounds_;
126        //! Absolute change per second (0.1 means 10% of the nominal volume) for cross fading
127        float                              crossFadeStep_;
128        std::list<SmartPtr<AmbientSound> > fadeInList_;
129        std::list<SmartPtr<AmbientSound> > fadeOutList_;
130
131        // Volume related
132        float volume_[3];
133        float mute_[3];
134
135        // Sound buffer related
136        static const unsigned int maxEffectsPoolSize_s = 40 * 1024 * 1024;
137        unsigned int effectsPoolSize_;
138        typedef std::list<shared_ptr<SoundBuffer> > EffectsPoolList;
139        EffectsPoolList effectsPool_;
140        typedef std::map<std::string, shared_ptr<SoundBuffer> > SoundBufferMap;
141        SoundBufferMap soundBuffers_;
142
143        // Sound source related
144        unsigned int minSources_;
145        unsigned int maxSources_;
146        std::vector<ALuint> availableSoundSources_;
147        std::vector<std::pair<ALuint, BaseSound*> > usedSoundSources_;
[7858]148
[7855]149        bool bDestructorCalled_; ///< Becomes true if the destructor is called - used to prevent ambient sounds from registering after the lists were cleared
[6417]150
[3370]151        static SoundManager* singletonPtr_s;
[6417]152    }; // tolua_export
153} // tolua_export
[3060]154
[3196]155#endif /* _SoundManager_H__ */
Note: See TracBrowser for help on using the repository browser.