src/object/ambient_sound.cpp

   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
  20 #include <config.h>
  21
  22 #include <math.h>
  23 #include <stdexcept>
  24 #include <iostream>
  25 #include <limits>
  26
  27 #include "ambient_sound.hpp"
  28 #include "object_factory.hpp"
  29 #include "lisp/lisp.hpp"
  30 #include "sector.hpp"
  31 #include "audio/sound_manager.hpp"
  32 #include "audio/sound_source.hpp"
  33 #include "log.hpp"
  34 #include "scripting/squirrel_util.hpp"
  35 #include "object/camera.hpp"
  36
  37 AmbientSound::AmbientSound(const lisp::Lisp& lisp)
  38 {
  39   name="";
  40   position.x = 0;
  41   position.y = 0;
  42
  43   dimension.x = 0;
  44   dimension.y = 0;
  45
  46   distance_factor = 0;
  47   distance_bias = 0;
  48   maximumvolume = 1;
  49   sample = "";
  50   currentvolume = 0;
  51
  52   if (!(lisp.get("x", position.x)&&lisp.get("y", position.y))) {
  53     log_warning << "No Position in ambient_sound" << std::endl;
  54   }
  55
  56   lisp.get("name" , name);
  57   lisp.get("width" , dimension.x);
  58   lisp.get("height", dimension.y);
  59
  60   lisp.get("distance_factor",distance_factor);
  61   lisp.get("distance_bias"  ,distance_bias  );
  62   lisp.get("sample"         ,sample         );
  63   lisp.get("volume"         ,maximumvolume  );
  64
  65   // set dimension to zero if smaller than 64, which is default size in flexlay
  66
  67   if ((dimension.x <= 64) || (dimension.y <= 64)) {
  68     dimension.x = 0;
  69     dimension.y = 0;
  70   }
  71
  72   // square all distances (saves us a sqrt later)
  73
  74   distance_bias*=distance_bias;
  75   distance_factor*=distance_factor;
  76
  77   // set default silence_distance
  78
  79   if (distance_factor == 0)
  80           silence_distance = std::numeric_limits<float>::max();
  81   else
  82     silence_distance = 1/distance_factor;
  83
  84   lisp.get("silence_distance",silence_distance);
  85
  86   sound_source = 0; // not playing at the beginning
  87   sound_manager->preload(sample);
  88   latency=0;
  89 }
  90
  91 AmbientSound::AmbientSound(Vector pos, float factor, float bias, float vol, std::string file)
  92 {
  93   position.x=pos.x;
  94   position.y=pos.y;
  95
  96   dimension.x=0;
  97   dimension.y=0;
  98
  99   distance_factor=factor*factor;
 100   distance_bias=bias*bias;
 101   maximumvolume=vol;
 102   sample=file;
 103
 104   // set default silence_distance
 105
 106   if (distance_factor == 0)
 107           silence_distance = std::numeric_limits<float>::max();
 108   else
 109     silence_distance = 1/distance_factor;
 110
 111   sound_source = 0; // not playing at the beginning
 112   latency=0;
 113 }
 114
 115 AmbientSound::~AmbientSound() {
 116   stop_playing();
 117 }
 118
 119 void
 120 AmbientSound::hit(Player& )
 121 {
 122 }
 123
 124 void
 125 AmbientSound::stop_playing() {
 126   delete sound_source;
 127   sound_source = 0;
 128 }
 129
 130 void
 131 AmbientSound::start_playing()
 132 {
 133   try {
 134     sound_source = sound_manager->create_sound_source(sample);
 135     if(!sound_source)
 136       throw std::runtime_error("file not found");
 137
 138     sound_source->set_gain(0);
 139     sound_source->set_looping(true);
 140     currentvolume=targetvolume=1e-20f;
 141     sound_source->play();
 142   } catch(std::exception& e) {
 143     log_warning << "Couldn't play '" << sample << "': " << e.what() << "" << std::endl;
 144     delete sound_source;
 145     sound_source = 0;
 146     remove_me();
 147   }
 148 }
 149
 150 void
 151 AmbientSound::update(float deltat)
 152 {
 153   if (latency-- <= 0) {
 154     float px,py;
 155     float rx,ry;
 156
 157     if (!Sector::current() || !Sector::current()->camera) return;
 158     // Camera position
 159     px=Sector::current()->camera->get_center().x;
 160     py=Sector::current()->camera->get_center().y;
 161
 162     // Relate to which point in the area
 163     rx=px<position.x?position.x:
 164       (px<position.x+dimension.x?px:position.x+dimension.x);
 165     ry=py<position.y?position.y:
 166       (py<position.y+dimension.y?py:position.y+dimension.y);
 167
 168     // calculate square of distance
 169     float sqrdistance=(px-rx)*(px-rx)+(py-ry)*(py-ry);
 170     sqrdistance-=distance_bias;
 171
 172     // inside the bias: full volume (distance 0)
 173     if (sqrdistance<0)
 174       sqrdistance=0;
 175
 176     // calculate target volume - will never become 0
 177     targetvolume=1/(1+sqrdistance*distance_factor);
 178     float rise=targetvolume/currentvolume;
 179
 180     // rise/fall half life?
 181     currentvolume*=pow(rise,deltat*10);
 182     currentvolume += 1e-6f; // volume is at least 1e-6 (0 would never rise)
 183
 184     if (sound_source != 0) {
 185
 186       // set the volume
 187       sound_source->set_gain(currentvolume*maximumvolume);
 188
 189       if (sqrdistance>=silence_distance && currentvolume<1e-3)
 190         stop_playing();
 191       latency=0;
 192     } else {
 193       if (sqrdistance<silence_distance) {
 194         start_playing();
 195         latency=0;
 196       }
 197       else // set a reasonable latency
 198         latency=(int)(0.001/distance_factor);
 199       //(int)(10*((sqrdistance-silence_distance)/silence_distance));
 200     }
 201   }
 202
 203   // heuristically measured "good" latency maximum
 204
 205   //  if (latency>0.001/distance_factor)
 206   // latency=
 207 }
 208
 209 void
 210 AmbientSound::draw(DrawingContext &)
 211 {
 212 }
 213
 214 void
 215 AmbientSound::expose(HSQUIRRELVM vm, SQInteger table_idx)
 216 {
 217   Scripting::AmbientSound* interface = static_cast<Scripting::AmbientSound*> (this);
 218   expose_object(vm, table_idx, interface, name, false);
 219 }
 220
 221 void
 222 AmbientSound::unexpose(HSQUIRRELVM vm, SQInteger table_idx)
 223 {
 224   Scripting::unexpose_object(vm, table_idx, name);
 225 }
 226
 227 void
 228 AmbientSound::set_pos(float x, float y)
 229 {
 230   position.x = x;
 231   position.y = y;
 232 }
 233
 234 float
 235 AmbientSound::get_pos_x() const
 236 {
 237   return position.x;
 238 }
 239
 240 float
 241 AmbientSound::get_pos_y() const
 242 {
 243   return position.y;
 244 }
 245
 246 IMPLEMENT_FACTORY(AmbientSound, "ambient_sound");