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 - curt@flightgear.org
   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 void print_openal_error( ALuint error ) {
  47     if ( error == AL_INVALID_NAME ) {
  48         SG_LOG( SG_GENERAL, SG_ALERT, "AL_INVALID_NAME" );
  49     } else if ( error == AL_ILLEGAL_ENUM ) {
  50         SG_LOG( SG_GENERAL, SG_ALERT, "AL_ILLEGAL_ENUM" );
  51     } else if ( error == AL_INVALID_VALUE ) {
  52         SG_LOG( SG_GENERAL, SG_ALERT, "AL_INVALID_VALUE" );
  53     } else if ( error == AL_ILLEGAL_COMMAND ) {
  54         SG_LOG( SG_GENERAL, SG_ALERT, "AL_ILLEGAL_COMMAND" );
  55     } else if ( error == AL_OUT_OF_MEMORY ) {
  56         SG_LOG( SG_GENERAL, SG_ALERT, "AL_OUT_OF_MEMORY" );
  57     } else {
  58         SG_LOG( SG_GENERAL, SG_ALERT, "Unhandled error code = " << error );
  59     }
  60 }
  61
  62
  63 // constructor
  64 SGSoundSample::SGSoundSample( const char *path, const char *file ) :
  65     pitch(1.0),
  66     volume(1.0),
  67     loop(AL_FALSE)
  68 {
  69     SGPath samplepath( path );
  70     if ( strlen(file) ) {
  71         samplepath.append( file );
  72     }
  73
  74     SG_LOG( SG_GENERAL, SG_DEBUG, "From file sounds sample = "
  75             << samplepath.str() );
  76
  77     ALuint error;
  78
  79     source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
  80     source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
  81
  82     // clear errors from elsewhere?
  83     alGetError();
  84
  85     // create an OpenAL buffer handle
  86     alGenBuffers(1, &buffer);
  87     error = alGetError();
  88     if ( error != AL_NO_ERROR ) {
  89         print_openal_error( error );
  90         throw sg_exception("Failed to gen OpenAL buffer.");
  91     }
  92
  93     // Load the sample file
  94 #if defined (__APPLE__)
  95     alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
  96                      &format, &data, &size, &freq );
  97 #else
  98     alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
  99                      &format, &data, &size, &freq, &loop );
 100 #endif
 101     if (alGetError() != AL_NO_ERROR) {
 102         throw sg_exception("Failed to load wav file.");
 103     }
 104
 105     // Copy data to the internal OpenAL buffer
 106     alBufferData( buffer, format, data, size, freq );
 107     if (alGetError() != AL_NO_ERROR) {
 108         throw sg_exception("Failed to buffer data.");
 109     }
 110
 111     alutUnloadWAV( format, data, size, freq );
 112
 113     // Bind buffer with a source.
 114     alGenSources(1, &source);
 115     if (alGetError() != AL_NO_ERROR) {
 116         throw sg_exception("Failed to gen source.");
 117     }
 118
 119     alSourcei( source, AL_BUFFER, buffer );
 120     alSourcef( source, AL_PITCH, pitch );
 121     alSourcef( source, AL_GAIN, volume );
 122     alSourcefv( source, AL_POSITION, source_pos );
 123     alSourcefv( source, AL_VELOCITY, source_vel );
 124     alSourcei( source, AL_LOOPING, loop );
 125 }
 126
 127
 128 // constructor
 129 SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq ) :
 130     pitch(1.0),
 131     volume(1.0),
 132     loop(AL_FALSE)
 133 {
 134     SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
 135
 136     source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
 137     source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
 138
 139     // Load wav data into a buffer.
 140     alGenBuffers(1, &buffer);
 141     if (alGetError() != AL_NO_ERROR) {
 142         SG_LOG( SG_GENERAL, SG_ALERT, "Error in alGenBuffers()" );
 143         return;
 144     }
 145
 146     format = AL_FORMAT_MONO8;
 147     size = len;
 148     data = _data;
 149     freq = _freq;
 150
 151     alBufferData( buffer, format, data, size, freq );
 152
 153     // Bind buffer with a source.
 154     alGenSources(1, &source);
 155     if (alGetError() != AL_NO_ERROR) {
 156         throw sg_exception("Failed to gen source.");
 157     }
 158
 159     alSourcei( source, AL_BUFFER, buffer );
 160     alSourcef( source, AL_PITCH, pitch );
 161     alSourcef( source, AL_GAIN, volume );
 162     alSourcefv( source, AL_POSITION, source_pos );
 163     alSourcefv( source, AL_VELOCITY, source_vel );
 164     alSourcei( source, AL_LOOPING, loop );
 165 }
 166
 167
 168 // destructor
 169 SGSoundSample::~SGSoundSample() {
 170     SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
 171     alDeleteSources(1, &source);
 172     alDeleteBuffers(1, &buffer);
 173 }
 174
 175
 176 // play the sample
 177 void SGSoundSample::play( bool _loop ) {
 178     loop = _loop;
 179
 180     // make sure sound isn't already playing
 181     alSourceStop( source );
 182
 183     alSourcei( source, AL_LOOPING, loop );
 184     alSourcePlay( source );
 185 }
 186
 187
 188 // stop playing the sample
 189 void SGSoundSample::stop() {
 190     alSourceStop( source );
 191 }