Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/sound/BaseSound.cc @ 9015

Last change on this file since 9015 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 9.4 KB
Line 
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
24 *   Co-authors:
25 *      Reto Grieder
26 *
27 */
28
29#include "BaseSound.h"
30
31#include <cassert>
32#include <vector>
33#include <al.h>
34
35#include "util/Math.h"
36#include "core/CoreIncludes.h"
37#include "core/GameMode.h"
38#include "core/Resource.h"
39#include "core/XMLPort.h"
40#include "SoundBuffer.h"
41#include "SoundManager.h"
42
43namespace orxonox
44{
45    BaseSound::BaseSound()
46        : bPooling_(false)
47        , volume_(1.0)
48        , bLooping_(false)
49        , state_(Stopped)
50        , pitch_ (1.0)
51    {
52        RegisterRootObject(BaseSound);
53
54        // Initialise audioSource_ to a value that is not a source
55        // 0 is unfortunately not guaranteed to be no source ID.
56        // HACK!
57        this->audioSource_ = 0;
58        //while (alIsSource(++this->audioSource_));
59    }
60
61    BaseSound::~BaseSound()
62    {
63        if (this->state_ != Stopped)
64            this->stop();
65        // Release buffer
66        if (this->soundBuffer_ != NULL)
67        {
68            assert(GameMode::playsSound());
69            SoundManager::getInstance().releaseSoundBuffer(this->soundBuffer_, this->bPooling_);
70        }
71    }
72
73    void BaseSound::XMLPortExtern(Element& xmlelement, XMLPort::Mode mode)
74    {
75        XMLPortParam(BaseSound, "volume",  setVolume,  getVolume,  xmlelement, mode);
76        XMLPortParam(BaseSound, "looping", setLooping, getLooping, xmlelement, mode);
77        XMLPortParam(BaseSound, "pitch",   setPitch,   getPitch,   xmlelement, mode);
78        XMLPortParam(BaseSound, "source",  setSource,  getSource,  xmlelement, mode);
79    }
80
81    void BaseSound::doPlay()
82    {
83        this->state_ = Playing;
84        if (GameMode::playsSound() && this->getSourceState() != AL_PLAYING && this->soundBuffer_ != NULL)
85        {
86            if (!alIsSource(this->audioSource_))
87            {
88                this->audioSource_ = SoundManager::getInstance().getSoundSource(this);
89                if (!alIsSource(this->audioSource_))
90                    return;
91                this->initialiseSource();
92            }
93
94            alSourcePlay(this->audioSource_);
95            if (int error = alGetError())
96                orxout(internal_error, context::sound) << "Error playing sound: " << SoundManager::getALErrorString(error) << endl;
97        }
98    }
99
100    bool BaseSound::doStop()
101    {
102        this->state_ = Stopped;
103        if (alIsSource(this->audioSource_))
104        {
105            alSourceStop(this->audioSource_);
106            // Release buffer
107            alSourcei(this->audioSource_, AL_BUFFER, AL_NONE);
108            // Release source again
109            SoundManager::getInstance().releaseSoundSource(this->audioSource_);
110            // Get a no source ID
111            this->audioSource_ += 123455;
112            while (alIsSource(++this->audioSource_));
113
114            return true; // sound source destroyed - return true
115        }
116        return false; // nothing done - return false
117    }
118
119    void BaseSound::doPause()
120    {
121        if (this->isStopped())
122            return;
123        this->state_ = Paused;
124        if (alIsSource(this->audioSource_))
125            alSourcePause(this->audioSource_);
126    }
127
128    ALint BaseSound::getSourceState() const
129    {
130        if (alIsSource(this->audioSource_))
131        {
132            ALint state;
133            alGetSourcei(this->audioSource_, AL_SOURCE_STATE, &state);
134            return state;
135        }
136        else
137            return AL_INITIAL;
138    }
139
140    void BaseSound::initialiseSource()
141    {
142        this->updateVolume();
143        this->setPitch(this->getPitch());
144        this->setLooping(this->getLooping());
145        alSource3f(this->audioSource_, AL_POSITION,  0, 0, 0);
146        alSource3f(this->audioSource_, AL_VELOCITY,  0, 0, 0);
147        alSource3f(this->audioSource_, AL_DIRECTION, 0, 0, 0);
148        if (ALint error = alGetError())
149            orxout(internal_warning, context::sound) << "Setting source parameters to 0 failed: "
150                                                     << SoundManager::getALErrorString(error) << endl;
151        assert(this->soundBuffer_ != NULL);
152        alSourcei(this->audioSource_, AL_BUFFER, this->soundBuffer_->getBuffer());
153        if (ALuint error = alGetError())
154            orxout(internal_error, context::sound) << "Could not set buffer \"" << this->source_ << "\": " << SoundManager::getALErrorString(error) << endl;
155    }
156
157    void BaseSound::setVolume(float vol)
158    {
159        this->volume_ = clamp(vol, 0.0f, 1.0f);
160        if (this->volume_ != vol)
161            orxout(internal_warning, context::sound) << "Volume out of range, clamping value." << endl;
162        this->updateVolume();
163    }
164
165    void BaseSound::updateVolume()
166    {
167        if (alIsSource(this->audioSource_))
168        {
169            float volume = this->volume_ * this->getRealVolume();               
170            alSourcef(this->audioSource_, AL_GAIN, volume);
171            if (int error = alGetError())
172                orxout(internal_error, context::sound) << "Error setting volume to " << volume
173                                                       << ": " << SoundManager::getALErrorString(error) << endl;
174        }
175    }
176
177    void BaseSound::setLooping(bool val)
178    {
179        this->bLooping_ = val;
180        if (alIsSource(this->audioSource_))
181            alSourcei(this->audioSource_, AL_LOOPING, (val ? AL_TRUE : AL_FALSE));
182    }
183
184    void BaseSound::setPitch(float pitch)
185    {
186        if (pitch > 2 || pitch < 0.5f)
187        {
188            orxout(internal_warning, context::sound) << "Pitch out of range, cropping value." << endl;
189            pitch = pitch > 2.0f ? 2.0f : pitch;
190            pitch = pitch < 0.5f ? 0.5f : pitch;
191        }
192        this->pitch_ = pitch;
193        if (alIsSource(this->audioSource_))
194        {
195            alSourcef(this->audioSource_, AL_PITCH, pitch);
196            if (int error = alGetError())
197                orxout(internal_error, context::sound) << "Error setting pitch: " << SoundManager::getALErrorString(error) << endl;
198        }
199    }
200
201    void BaseSound::setSource(const std::string& source)
202    {
203        if (!GameMode::playsSound())
204        {
205            this->source_ = source;
206            return;
207        }
208
209        if (this->soundBuffer_ != NULL)
210        {
211            if (this->soundBuffer_->getFilename() == source)
212            {
213                assert(this->source_ == source_);
214                return;
215            }
216            // Stopping is imperative here!
217            if (alIsSource(this->audioSource_))
218            {
219                alSourceStop(this->audioSource_);
220                alSourcei(this->audioSource_, AL_BUFFER, AL_NONE);
221            }
222            SoundManager::getInstance().releaseSoundBuffer(this->soundBuffer_, this->bPooling_);
223            this->soundBuffer_.reset();
224        }
225
226        this->source_ = source;
227        // Don't load ""
228        if (source_.empty())
229            return;
230
231        // Get new sound buffer
232        this->soundBuffer_ = SoundManager::getInstance().getSoundBuffer(this->source_);
233        if (this->soundBuffer_ == NULL)
234            return;
235
236        if (alIsSource(this->audioSource_)) // already playing or paused
237        {
238            // Set new buffer
239            alSourcei(this->audioSource_, AL_BUFFER, this->soundBuffer_->getBuffer());
240            if (ALuint error = alGetError())
241            {
242                orxout(internal_error, context::sound) << "Could not set buffer \"" << source << "\": " << SoundManager::getALErrorString(error) << endl;
243                return;
244            }
245
246            // Sound was already playing or paused because there was a source acquired
247            assert(this->isPlaying() || this->isPaused());
248            alSourcePlay(this->audioSource_);
249            if (int error = alGetError())
250                orxout(internal_error, context::sound) << "Error playing sound: " << SoundManager::getALErrorString(error) << endl;
251            if (this->isPaused())
252                alSourcePause(this->audioSource_);
253        }
254        else // No source acquired so far, but might be set to playing or paused
255        {
256            State state = static_cast<State>(this->state_); // save
257            if (this->isPlaying() || this->isPaused())
258                doPlay();
259            if (state == Paused)
260            {
261                this->state_ = Paused;
262                doPause();
263            }
264        }
265    }
266
267    void BaseSound::stateChanged()
268    {
269        switch (this->state_)
270        {
271            case Playing:
272                this->play();
273                break;
274            case Paused:
275                this->pause();
276                break;
277            case Stopped:
278            default:
279                this->stop();
280                break;
281        }
282    }
283}
Note: See TracBrowser for help on using the repository browser.