src/audio/sound_source.hpp

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