Dogcows Code - chaz/yoink/blob - src/moof/sound.hh

   1
   2 /*]  Copyright (c) 2009-2010, Charles McGarvey  [**************************
   3 **]  All rights reserved.
   4 *
   5 * vi:ts=4 sw=4 tw=75
   6 *
   7 * Distributable under the terms and conditions of the 2-clause BSD license;
   8 * see the file COPYING for a complete text of the license.
   9 *
  10 **************************************************************************/
  11
  12 #ifndef _MOOF_SOUND_HH_
  13 #define _MOOF_SOUND_HH_
  14
  15 /**
  16  * \file sound.hh
  17  * Load and play sounds, current supports ogg vorbis.
  18  */
  19
  20 #include <string>
  21
  22 #include <boost/shared_ptr.hpp>
  23
  24 #include <moof/math.hh>
  25
  26
  27 namespace moof {
  28
  29
  30 class script;
  31
  32
  33 class sound
  34 {
  35 public:
  36
  37         sound();
  38         explicit sound(const std::string& name);
  39
  40         void sample(const std::string& name);
  41         void enqueue(const std::string& name);
  42
  43         void play();
  44         void stop();
  45         void pause();
  46         void rewind();
  47
  48         void toggle();
  49         bool is_playing() const;
  50
  51         void position(const vector3& position);
  52         void velocity(const vector3& velocity);
  53         void gain(scalar gain);
  54         void pitch(scalar pitch);
  55         void loop(bool looping);
  56
  57
  58         static void listener_position(const vector3& position);
  59         static void listener_velocity(const vector3& velocity);
  60         static void listener_orientation(const vector3& forward,
  61                                                                          const vector3& up);
  62
  63         static void import(script& script, const std::string& nspace = "");
  64
  65 private:
  66
  67         class impl;
  68         boost::shared_ptr<impl> impl_;
  69 };
  70
  71
  72 } // namespace moof
  73
  74 #endif // _MOOF_SOUND_HH_
  75