settings subsystem now using lua
[chaz/yoink] / src / Moof / Sound.hh
1
2 /*******************************************************************************
3
4 Copyright (c) 2009, Charles McGarvey
5 All rights reserved.
6
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9
10 * Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright notice,
13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution.
15
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27 *******************************************************************************/
28
29 #ifndef _MOOF_SOUND_HH_
30 #define _MOOF_SOUND_HH_
31
32 /**
33 * @file Sound.hh
34 * Load and play sounds, current supports ogg vorbis.
35 */
36
37 #include <boost/shared_ptr.hpp>
38
39 #include <Moof/Exception.hh>
40 #include <Moof/Math.hh>
41 #include <Moof/Resource.hh>
42
43
44 namespace Mf {
45
46
47 class Sound;
48 typedef boost::shared_ptr<Sound> SoundP;
49
50
51 class Sound : public Resource
52 {
53 class Impl;
54 boost::shared_ptr<Impl> impl_;
55
56 public:
57
58 static SoundP alloc(const std::string& name)
59 {
60 return SoundP(new Sound(name));
61 }
62
63 explicit Sound(const std::string& name);
64
65
66 void play();
67 void stream();
68
69 // TODO - i don't like how there are two different methods that essentially
70 // do the same thing; the API should be exactly the same for both types of
71 // sounds; need a different way to distinguish how to handle the sound
72
73 void stop();
74 void pause();
75 void resume();
76 void toggle();
77
78 void setSample(const std::string& name);
79 void enqueue(const std::string& name);
80
81 bool isPlaying() const;
82
83 void setPosition(const Vector3& position);
84 void setVelocity(const Vector3& velocity);
85 void setGain(Scalar gain);
86 void setPitch(Scalar pitch);
87 void setLooping(bool looping);
88
89 static void setListenerPosition(const Vector3& position);
90 static void setListenerVelocity(const Vector3& velocity);
91 static void setListenerOrientation(const Vector3& forward,
92 const Vector3& up);
93
94 static std::string getPath(const std::string& name);
95
96
97 struct Exception : public Mf::Exception
98 {
99 enum
100 {
101 BAD_AUDIO_FORMAT = 1024
102 };
103
104 explicit Exception(unsigned error) :
105 Mf::Exception(error) {}
106
107 void raise()
108 {
109 throw *this;
110 }
111
112 const char* what() const throw()
113 {
114 switch (code)
115 {
116 case BAD_AUDIO_FORMAT:
117 return "unknown audio format";
118 }
119 return Mf::Exception::what();
120 }
121 };
122 };
123
124
125 } // namespace Mf
126
127 #endif // _MOOF_SOUND_HH_
128
129 /** vim: set ts=4 sw=4 tw=80: *************************************************/
130
This page took 0.032607 seconds and 4 git commands to generate.