Dogcows Code - chaz/yoink/blob - 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 class SoundStream;
  51 typedef boost::shared_ptr<SoundStream> SoundStreamP;
  52
  53
  54 class Sound : public Resource
  55 {
  56 public:
  57
  58         static SoundP alloc(const std::string& name)
  59         {
  60                 return SoundP(new Sound(name));
  61         }
  62
  63         Sound();
  64         explicit Sound(const std::string& name);
  65
  66         virtual ~Sound() {}
  67
  68         // this implicitly stops the sound if it is playing
  69         void setSample(const std::string& name);
  70
  71         virtual void play();
  72         void stop();
  73         void pause();
  74
  75         void toggle();
  76         bool isPlaying() const;
  77
  78         void setPosition(const Vector3& position);
  79         void setVelocity(const Vector3& velocity);
  80         void setGain(Scalar gain);
  81         void setPitch(Scalar pitch);
  82         void setLooping(bool looping);
  83
  84         static void setListenerPosition(const Vector3& position);
  85         static void setListenerVelocity(const Vector3& velocity);
  86         static void setListenerOrientation(const Vector3& forward,
  87                         const Vector3& up);
  88
  89         static std::string getPath(const std::string& name);
  90
  91 protected:
  92
  93         class Impl;
  94         boost::shared_ptr<Impl> mImpl;
  95 };
  96
  97
  98 class SoundStream : public Sound
  99 {
 100 public:
 101
 102         static SoundStreamP alloc(const std::string& name)
 103         {
 104                 return SoundStreamP(new SoundStream(name));
 105         }
 106
 107         SoundStream();
 108         explicit SoundStream(const std::string& name) :
 109                 Sound(name) {}
 110
 111         void enqueue(const std::string& name);
 112
 113         void play();
 114 };
 115
 116
 117 } // namespace Mf
 118
 119 #endif // _MOOF_SOUND_HH_
 120
 121 /** vim: set ts=4 sw=4 tw=80: *************************************************/
 122