-/*******************************************************************************
-
- Copyright (c) 2009, Charles McGarvey
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
-
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-*******************************************************************************/
+/*] Copyright (c) 2009-2010, Charles McGarvey [**************************
+**] All rights reserved.
+*
+* vi:ts=4 sw=4 tw=75
+*
+* Distributable under the terms and conditions of the 2-clause BSD license;
+* see the file COPYING for a complete text of the license.
+*
+**************************************************************************/
#ifndef _MOOF_SOUND_HH_
#define _MOOF_SOUND_HH_
* Load and play sounds, current supports ogg vorbis.
*/
+#include <string>
+
#include <boost/shared_ptr.hpp>
-#include <Moof/Exception.hh>
#include <Moof/Math.hh>
#include <Moof/Resource.hh>
class Sound;
typedef boost::shared_ptr<Sound> SoundP;
+class SoundStream;
+typedef boost::shared_ptr<SoundStream> SoundStreamP;
+
class Sound : public Resource
{
- class Impl;
- boost::shared_ptr<Impl> impl_;
-
public:
static SoundP alloc(const std::string& name)
return SoundP(new Sound(name));
}
+ Sound();
explicit Sound(const std::string& name);
+ virtual ~Sound() {}
- void play();
- void stream();
+ // this implicitly stops the sound if it is playing
+ void setSample(const std::string& name);
+ virtual void play();
void stop();
void pause();
- void resume();
- void toggle();
-
- void setSample(const std::string& name);
- void enqueue(const std::string& name);
+ void toggle();
bool isPlaying() const;
- void setPosition(Vector3 position);
- void setVelocity(Vector3 velocity);
+ void setPosition(const Vector3& position);
+ void setVelocity(const Vector3& velocity);
void setGain(Scalar gain);
void setPitch(Scalar pitch);
void setLooping(bool looping);
- static std::string getPath(const std::string& name);
+ static void setListenerPosition(const Vector3& position);
+ static void setListenerVelocity(const Vector3& velocity);
+ static void setListenerOrientation(const Vector3& forward,
+ const Vector3& up);
+
+ static bool getPath(std::string& name);
+
+protected:
+ class Impl;
+ boost::shared_ptr<Impl> mImpl;
+};
- struct Exception : public Mf::Exception
+
+class SoundStream : public Sound
+{
+public:
+
+ static SoundStreamP alloc(const std::string& name)
{
- enum
- {
- BAD_AUDIO_FORMAT = 1024
- };
-
- explicit Exception(unsigned error) :
- Mf::Exception(error) {}
-
- void raise()
- {
- throw *this;
- }
-
- const char* what() const throw()
- {
- switch (code)
- {
- case BAD_AUDIO_FORMAT:
- return "unknown audio format";
- }
- return Mf::Exception::what();
- }
- };
+ return SoundStreamP(new SoundStream(name));
+ }
+
+ SoundStream();
+ explicit SoundStream(const std::string& name) :
+ Sound(name) {}
+
+ void enqueue(const std::string& name);
+
+ void play();
};
#endif // _MOOF_SOUND_HH_
-/** vim: set ts=4 sw=4 tw=80: *************************************************/
-