src/audio/sound_source.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_AUDIO_SOUND_SOURCE_HPP
  18 #define HEADER_SUPERTUX_AUDIO_SOUND_SOURCE_HPP
  19
  20 class Vector;
  21
  22 /**
  23  * A sound source represents the source of audio output. You can place
  24  * sources at certain points in your world or set their velocity to produce
  25  * doppler effects
  26  */
  27 class SoundSource
  28 {
  29 public:
  30   virtual ~SoundSource()
  31   { }
  32
  33   virtual void play() = 0;
  34   virtual void stop() = 0;
  35   virtual bool playing() = 0;
  36
  37   virtual void set_looping(bool looping) = 0;
  38   virtual void set_relative(bool relative) = 0;
  39   /// Set volume (0.0 is silent, 1.0 is normal)
  40   virtual void set_gain(float gain) = 0;
  41   virtual void set_pitch(float pitch) = 0;
  42   virtual void set_position(const Vector& position) = 0;
  43   virtual void set_velocity(const Vector& velocity) = 0;
  44   virtual void set_reference_distance(float distance) = 0;
  45 };
  46
  47 #endif
  48
  49 /* EOF */