simgear/sound/sample_openal.cxx

   1 // sample.cxx -- Sound sample encapsulation class
   2 //
   3 // Written by Curtis Olson, started April 2004.
   4 //
   5 // Copyright (C) 2004  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #if defined( __APPLE__ )
  25 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
  26 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
  27 # include <OpenAL/al.h>
  28 # include <OpenAL/alut.h>
  29 #else
  30 # include <AL/al.h>
  31 # include <AL/alut.h>
  32 #endif
  33
  34 #include <simgear/debug/logstream.hxx>
  35 #include <simgear/misc/sg_path.hxx>
  36 #include <simgear/structure/exception.hxx>
  37
  38 #include "sample_openal.hxx"
  39
  40
  41 //
  42 // SGSoundSample
  43 //
  44
  45
  46 static bool print_openal_error(const string &s = "unknown") {
  47     ALuint error = alGetError();
  48     if ( error == AL_NO_ERROR ) {
  49        return false;
  50     } else if ( error == AL_INVALID_NAME ) {
  51         SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_INVALID_NAME): " << s );
  52     } else if ( error == AL_ILLEGAL_ENUM ) {
  53         SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_ILLEGAL_ENUM): "  << s );
  54     } else if ( error == AL_INVALID_VALUE ) {
  55         SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_INVALID_VALUE): " << s );
  56     } else if ( error == AL_ILLEGAL_COMMAND ) {
  57         SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_ILLEGAL_COMMAND): " << s );
  58     } else if ( error == AL_OUT_OF_MEMORY ) {
  59         SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_OUT_OF_MEMORY): " << s );
  60     } else {
  61         SG_LOG( SG_GENERAL, SG_ALERT, "Unhandled error code = " << error );
  62     }
  63     return error;
  64 }
  65
  66 // empry constructor
  67 SGSoundSample::SGSoundSample() :
  68     buffer(0),
  69     source(0),
  70     pitch(1.0),
  71     volume(1.0),
  72     reference_dist(500.0),
  73     max_dist(3000.),
  74     loop(AL_FALSE),
  75     playing(false)
  76 {
  77 }
  78
  79 // constructor
  80 SGSoundSample::SGSoundSample( const char *path, const char *file) :
  81     buffer(0),
  82     source(0),
  83     pitch(1.0),
  84     volume(1.0),
  85     reference_dist(500.0),
  86     max_dist(3000.),
  87     loop(AL_FALSE),
  88     playing(false)
  89 {
  90     SGPath samplepath( path );
  91     if ( strlen(file) ) {
  92         samplepath.append( file );
  93     }
  94     sample_name = samplepath.str();
  95
  96     SG_LOG( SG_GENERAL, SG_DEBUG, "From file sounds sample = "
  97             << samplepath.str() );
  98
  99     source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
 100     offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
 101     source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
 102     direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
 103     inner = outer = 360.0; outergain = 0.0;
 104
 105     // clear errors from elsewhere?
 106     alGetError();
 107
 108     // create an OpenAL buffer handle
 109     alGenBuffers(1, &buffer);
 110     if ( print_openal_error("constructor (alGenBuffers)") ) {
 111         throw sg_exception("Failed to gen OpenAL buffer.");
 112     }
 113
 114     // Load the sample file
 115 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
 116
 117   buffer = alutCreateBufferFromFile(samplepath.c_str());
 118   if (buffer == AL_NONE) {
 119      ALenum error = alutGetError ();
 120      print_openal_error("constructor (alutCreateBufferFromFile)");
 121      throw sg_exception("Failed to load wav file: "+string(alutGetErrorString (error)));
 122   }
 123
 124 #else
 125         //
 126         // pre 1.0 alut version
 127         //
 128     ALvoid* data = load_file(path, file);
 129
 130     // Copy data to the internal OpenAL buffer
 131     alBufferData( buffer, format, data, size, freq );
 132
 133     if ( print_openal_error("constructor (alBufferData)") ) {
 134         throw sg_exception("Failed to buffer data.");
 135     }
 136
 137     alutUnloadWAV( format, data, size, freq );
 138 #endif
 139
 140     print_openal_error("constructor return");
 141 }
 142
 143 // constructor
 144 SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq ) :
 145     buffer(0),
 146     source(0),
 147     pitch(1.0),
 148     volume(1.0),
 149     reference_dist(500.0),
 150     max_dist(3000.),
 151     loop(AL_FALSE),
 152     playing(false)
 153 {
 154     SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
 155
 156     sample_name = "unknown, generated from data";
 157
 158     source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
 159     offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
 160     source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
 161     direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
 162     inner = outer = 360.0; outergain = 0.0;
 163
 164     // clear errors from elsewhere?
 165     alGetError();
 166
 167     // Load wav data into a buffer.
 168     alGenBuffers(1, &buffer);
 169     if ( print_openal_error("constructor (alGenBuffers)") ) {
 170         throw sg_exception("Failed to gen buffer." );
 171     }
 172
 173     format = AL_FORMAT_MONO8;
 174     size = len;
 175     freq = _freq;
 176
 177     alBufferData( buffer, format, _data, size, freq );
 178     if ( print_openal_error("constructor (alBufferData)") ) {
 179         throw sg_exception("Failed to buffer data.");
 180     }
 181
 182     free(_data);
 183
 184     print_openal_error("constructor return");
 185 }
 186
 187
 188 // destructor
 189 SGSoundSample::~SGSoundSample() {
 190     SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
 191     if (buffer)
 192         alDeleteBuffers(1, &buffer);
 193 }
 194
 195
 196 // play the sample
 197 void SGSoundSample::play( bool _loop ) {
 198
 199     if ( source ) {
 200         alSourceStop( source );
 201     }
 202
 203     playing = bind_source();
 204     if ( playing ) {
 205         loop = _loop;
 206
 207         alSourcei( source, AL_LOOPING, loop );
 208         alSourcePlay( source );
 209
 210         print_openal_error("play (alSourcePlay)");
 211     }
 212 }
 213
 214
 215 // stop playing the sample
 216 void SGSoundSample::stop() {
 217     if (playing) {
 218         alSourceStop( source );
 219         alDeleteSources(1, &source);
 220         source = 0;
 221         print_openal_error("stop (alDeleteSources)");
 222     }
 223     playing = false;
 224 }
 225
 226 // Generate sound source
 227 bool
 228 SGSoundSample::bind_source() {
 229
 230     if ( playing ) {
 231         return true;
 232     }
 233     if ( buffer == 0 ) {
 234         return false;
 235     }
 236
 237     // Bind buffer with a source.
 238     alGetError();
 239     alGenSources(1, &source);
 240     if ( print_openal_error("bind_source (alGenSources)") ) {
 241         // No biggy, better luck next time.
 242         SG_LOG( SG_GENERAL, SG_ALERT, "Failed to generate audio source.");
 243         // SG_LOG( SG_GENERAL, SG_ALERT, "Please update your sound driver and try again.");
 244         return false;
 245     }
 246
 247     alSourcei( source, AL_BUFFER, buffer );
 248     alSourcef( source, AL_PITCH, pitch );
 249     alSourcef( source, AL_GAIN, volume );
 250     alSourcefv( source, AL_POSITION, source_pos );
 251     alSourcefv( source, AL_DIRECTION, direction );
 252     alSourcef( source, AL_CONE_INNER_ANGLE, inner );
 253     alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
 254     alSourcef( source, AL_CONE_OUTER_GAIN, outergain);
 255     alSourcefv( source, AL_VELOCITY, source_vel );
 256     alSourcei( source, AL_LOOPING, loop );
 257
 258     alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
 259     alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
 260     alSourcef( source, AL_MAX_DISTANCE, max_dist );
 261
 262     print_openal_error("bind_sources return");
 263
 264     return true;
 265 }
 266
 267 void
 268 SGSoundSample::set_pitch( double p ) {
 269     // clamp in the range of 0.01 to 2.0
 270     if ( p < 0.01 ) { p = 0.01; }
 271     if ( p > 2.0 ) { p = 2.0; }
 272     pitch = p;
 273     if (playing) {
 274         alSourcef( source, AL_PITCH, pitch );
 275         print_openal_error("set_pitch");
 276     }
 277 }
 278
 279 void
 280 SGSoundSample::set_volume( double v ) {
 281     volume = v;
 282     if (playing) {
 283         alSourcef( source, AL_GAIN, volume );
 284         print_openal_error("set_volume");
 285     }
 286 }
 287
 288
 289 bool
 290 SGSoundSample::is_playing( ) {
 291     if (playing) {
 292         ALint result;
 293         alGetSourcei( source, AL_SOURCE_STATE, &result );
 294         if ( alGetError() != AL_NO_ERROR) {
 295             SG_LOG( SG_GENERAL, SG_ALERT,
 296                 "Oops AL error in sample is_playing(): " << sample_name );
 297         }
 298         return (result == AL_PLAYING) ;
 299     } else
 300         return false;
 301 }
 302
 303 void
 304 SGSoundSample::set_source_pos( ALfloat *pos ) {
 305     source_pos[0] = pos[0];
 306     source_pos[1] = pos[1];
 307     source_pos[2] = pos[2];
 308
 309     if (playing) {
 310         sgVec3 final_pos;
 311         sgAddVec3( final_pos, source_pos, offset_pos );
 312
 313         alSourcefv( source, AL_POSITION, final_pos );
 314     }
 315 }
 316
 317 void
 318 SGSoundSample::set_offset_pos( ALfloat *pos ) {
 319     offset_pos[0] = pos[0];
 320     offset_pos[1] = pos[1];
 321     offset_pos[2] = pos[2];
 322
 323     if (playing) {
 324         sgVec3 final_pos;
 325         sgAddVec3( final_pos, source_pos, offset_pos );
 326
 327         alSourcefv( source, AL_POSITION, final_pos );
 328     }
 329 }
 330
 331 void
 332 SGSoundSample::set_orientation( ALfloat *dir, ALfloat inner_angle,
 333                                            ALfloat outer_angle,
 334                                            ALfloat outer_gain)
 335 {
 336     inner = inner_angle;
 337     outer = outer_angle;
 338     outergain = outer_gain;
 339     if (playing) {
 340         alSourcefv( source, AL_DIRECTION, dir);
 341         alSourcef( source, AL_CONE_INNER_ANGLE, inner );
 342         alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
 343         alSourcef( source, AL_CONE_OUTER_GAIN, outergain );
 344     }
 345 }
 346
 347 void
 348 SGSoundSample::set_source_vel( ALfloat *vel ) {
 349     source_vel[0] = vel[0];
 350     source_vel[1] = vel[1];
 351     source_vel[2] = vel[2];
 352     if (playing) {
 353         alSourcefv( source, AL_VELOCITY, source_vel );
 354     }
 355 }
 356
 357 void
 358 SGSoundSample::set_reference_dist( ALfloat dist ) {
 359     reference_dist = dist;
 360     if (playing) {
 361         alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
 362     }
 363 }
 364
 365
 366 void
 367 SGSoundSample::set_max_dist( ALfloat dist ) {
 368     max_dist = dist;
 369     if (playing) {
 370         alSourcef( source, AL_MAX_DISTANCE, max_dist );
 371     }
 372 }
 373
 374 ALvoid *
 375 SGSoundSample::load_file(const char *path, const char *file)
 376 {
 377     ALvoid* data = 0;
 378
 379     SGPath samplepath( path );
 380     if ( strlen(file) ) {
 381         samplepath.append( file );
 382     }
 383
 384 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
 385     ALfloat freqf;
 386     data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
 387     if (data == NULL) {
 388         throw sg_exception("Failed to load wav file.");
 389     }
 390     freq = (ALsizei)freqf;
 391 #else
 392 # if defined (__APPLE__)
 393     alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
 394                      &format, &data, &size, &freq );
 395 # else
 396     alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
 397                      &format, &data, &size, &freq, &loop );
 398 # endif
 399     if ( print_openal_error("constructor (alutLoadWAVFile)") ) {
 400         throw sg_exception("Failed to load wav file.");
 401     }
 402 #endif
 403
 404     return data;
 405 }
 406