-// sample.cxx -- Sound sample encapsulation class
+// sample_openal.cxx -- Audio sample encapsulation class
//
// Written by Curtis Olson, started April 2004.
+// Modified to match the new SoundSystem by Erik Hofman, October 2009
//
// Copyright (C) 2004 Curtis L. Olson - http://www.flightgear.org/~curt
+// Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the Free Software
-// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+// along with this program; if not, write to the Free Software Foundation,
+// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// $Id$
# include <simgear_config.h>
#endif
-#if defined( __APPLE__ )
-# define AL_ILLEGAL_ENUM AL_INVALID_ENUM
-# define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
-# include <OpenAL/al.h>
-# include <OpenAL/alut.h>
-#else
-# include <AL/al.h>
-# include <AL/alut.h>
-#endif
+#include <stdlib.h> // rand()
#include <simgear/debug/logstream.hxx>
-#include <simgear/misc/sg_path.hxx>
#include <simgear/structure/exception.hxx>
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/math/SGQuat.hxx>
+#include "soundmgr_openal.hxx"
#include "sample_openal.hxx"
// SGSoundSample
//
-
-static bool print_openal_error(const string &s = "unknown") {
- ALuint error = alGetError();
- if ( error == AL_NO_ERROR ) {
- return false;
- } else if ( error == AL_INVALID_NAME ) {
- SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_INVALID_NAME): " << s );
- } else if ( error == AL_ILLEGAL_ENUM ) {
- SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_ILLEGAL_ENUM): " << s );
- } else if ( error == AL_INVALID_VALUE ) {
- SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_INVALID_VALUE): " << s );
- } else if ( error == AL_ILLEGAL_COMMAND ) {
- SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_ILLEGAL_COMMAND): " << s );
- } else if ( error == AL_OUT_OF_MEMORY ) {
- SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_OUT_OF_MEMORY): " << s );
- } else {
- SG_LOG( SG_GENERAL, SG_ALERT, "Unhandled error code = " << error );
- }
- return error != 0;
-}
-
// empty constructor
SGSoundSample::SGSoundSample() :
- buffer(0),
- source(0),
- pitch(1.0),
- volume(1.0),
- reference_dist(500.0),
- max_dist(3000.),
- loop(AL_FALSE),
-#ifdef USE_SOFTWARE_DOPPLER
- doppler_pitch_factor(1),
- doppler_volume_factor(1),
-#endif
- playing(false),
- no_Doppler_effect(true)
+ _absolute_pos(SGVec3d::zeros()),
+ _relative_pos(SGVec3d::zeros()),
+ _direction(SGVec3d::zeros()),
+ _velocity(SGVec3f::zeros()),
+ _orientation(SGQuatd::zeros()),
+ _orivec(SGVec3f::zeros()),
+ _base_pos(SGGeod::fromDeg(0,0)),
+ _refname(random_string()),
+ _data(NULL),
+ _format(AL_FORMAT_MONO8),
+ _size(0),
+ _freq(0),
+ _valid_buffer(false),
+ _buffer(SGSoundMgr::NO_BUFFER),
+ _valid_source(false),
+ _source(SGSoundMgr::NO_SOURCE),
+ _inner_angle(360.0),
+ _outer_angle(360.0),
+ _outer_gain(0.0),
+ _pitch(1.0),
+ _volume(1.0),
+ _master_volume(1.0),
+ _reference_dist(500.0),
+ _max_dist(3000.0),
+ _loop(AL_FALSE),
+ _playing(false),
+ _changed(true),
+ _static_changed(true),
+ _is_file(false)
{
}
// constructor
-SGSoundSample::SGSoundSample( const char *path, const char *file, bool _no_Doppler_effect ) :
- buffer(0),
- source(0),
- pitch(1.0),
- volume(1.0),
- reference_dist(500.0),
- max_dist(3000.),
- loop(AL_FALSE),
-#ifdef USE_SOFTWARE_DOPPLER
- doppler_pitch_factor(1),
- doppler_volume_factor(1),
-#endif
- playing(false),
- no_Doppler_effect(_no_Doppler_effect)
+SGSoundSample::SGSoundSample( const char *path, const char *file ) :
+ _absolute_pos(SGVec3d::zeros()),
+ _relative_pos(SGVec3d::zeros()),
+ _direction(SGVec3d::zeros()),
+ _velocity(SGVec3f::zeros()),
+ _orientation(SGQuatd::zeros()),
+ _orivec(SGVec3f::zeros()),
+ _base_pos(SGGeod::fromDeg(0,0)),
+ _refname(file),
+ _data(NULL),
+ _format(AL_FORMAT_MONO8),
+ _size(0),
+ _freq(0),
+ _valid_buffer(false),
+ _buffer(SGSoundMgr::NO_BUFFER),
+ _valid_source(false),
+ _source(SGSoundMgr::NO_SOURCE),
+ _inner_angle(360.0),
+ _outer_angle(360.0),
+ _outer_gain(0.0),
+ _pitch(1.0),
+ _volume(1.0),
+ _master_volume(1.0),
+ _reference_dist(500.0),
+ _max_dist(3000.0),
+ _loop(AL_FALSE),
+ _playing(false),
+ _changed(true),
+ _static_changed(true),
+ _is_file(true)
{
SGPath samplepath( path );
if ( strlen(file) ) {
samplepath.append( file );
}
- sample_name = samplepath.str();
-
- SG_LOG( SG_GENERAL, SG_DEBUG, "From file sounds sample = "
- << samplepath.str() );
-
- source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
- offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
- source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
- direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
- inner = outer = 360.0; outergain = 0.0;
-
- // clear errors from elsewhere?
- alGetError();
-
- // create an OpenAL buffer handle
- alGenBuffers(1, &buffer);
- if ( print_openal_error("constructor (alGenBuffers)") ) {
- throw sg_exception("Failed to gen OpenAL buffer.");
- }
-
- // Load the sample file
-#if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
-
- buffer = alutCreateBufferFromFile(samplepath.c_str());
- if (buffer == AL_NONE) {
- ALenum error = alutGetError ();
- print_openal_error("constructor (alutCreateBufferFromFile)");
- throw sg_io_exception("Failed to load wav file: ",
- sg_location(string(alutGetErrorString (error))));
- }
-
-#else
- //
- // pre 1.0 alut version
- //
- ALvoid* data = load_file(path, file);
-
- // Copy data to the internal OpenAL buffer
- alBufferData( buffer, format, data, size, freq );
-
- if ( print_openal_error("constructor (alBufferData)") ) {
- SG_LOG( SG_GENERAL, SG_ALERT, "Trying to use file " << file );
- throw sg_exception("Failed to buffer data.");
- }
-
- alutUnloadWAV( format, data, size, freq );
-#endif
-
- print_openal_error("constructor return");
+ _refname = samplepath.str();
}
// constructor
-SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq, bool _no_Doppler_effect ) :
- buffer(0),
- source(0),
- pitch(1.0),
- volume(1.0),
- reference_dist(500.0),
- max_dist(3000.),
- loop(AL_FALSE),
-#ifdef USE_SOFTWARE_DOPPLER
- doppler_pitch_factor(1),
- doppler_volume_factor(1),
-#endif
- playing(false),
- no_Doppler_effect(_no_Doppler_effect)
+SGSoundSample::SGSoundSample( const unsigned char** data,
+ int len, int freq, int format ) :
+ _absolute_pos(SGVec3d::zeros()),
+ _relative_pos(SGVec3d::zeros()),
+ _direction(SGVec3d::zeros()),
+ _velocity(SGVec3f::zeros()),
+ _orientation(SGQuatd::zeros()),
+ _orivec(SGVec3f::zeros()),
+ _base_pos(SGGeod::fromDeg(0,0)),
+ _refname(random_string()),
+ _format(format),
+ _size(len),
+ _freq(freq),
+ _valid_buffer(false),
+ _buffer(SGSoundMgr::NO_BUFFER),
+ _valid_source(false),
+ _source(SGSoundMgr::NO_SOURCE),
+ _inner_angle(360.0),
+ _outer_angle(360.0),
+ _outer_gain(0.0),
+ _pitch(1.0),
+ _volume(1.0),
+ _master_volume(1.0),
+ _reference_dist(500.0),
+ _max_dist(3000.0),
+ _loop(AL_FALSE),
+ _playing(false),
+ _changed(true),
+ _static_changed(true),
+ _is_file(false)
{
SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
+ _data = (unsigned char*)*data; *data = NULL;
+}
- sample_name = "unknown, generated from data";
-
- source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
- offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
- source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
- direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
- inner = outer = 360.0; outergain = 0.0;
-
- // clear errors from elsewhere?
- alGetError();
-
- // Load wav data into a buffer.
- alGenBuffers(1, &buffer);
- if ( print_openal_error("constructor (alGenBuffers)") ) {
- throw sg_exception("Failed to gen buffer." );
- }
-
- format = AL_FORMAT_MONO8;
- size = len;
- freq = _freq;
-
- alBufferData( buffer, format, _data, size, freq );
- if ( print_openal_error("constructor (alBufferData)") ) {
- throw sg_exception("Failed to buffer data.");
- }
-
- print_openal_error("constructor return");
+// constructor
+SGSoundSample::SGSoundSample( void** data, int len, int freq, int format ) :
+ _absolute_pos(SGVec3d::zeros()),
+ _relative_pos(SGVec3d::zeros()),
+ _direction(SGVec3d::zeros()),
+ _velocity(SGVec3f::zeros()),
+ _orientation(SGQuatd::zeros()),
+ _orivec(SGVec3f::zeros()),
+ _base_pos(SGGeod::fromDeg(0,0)),
+ _refname(random_string()),
+ _format(format),
+ _size(len),
+ _freq(freq),
+ _valid_buffer(false),
+ _buffer(SGSoundMgr::NO_BUFFER),
+ _valid_source(false),
+ _source(SGSoundMgr::NO_SOURCE),
+ _inner_angle(360.0),
+ _outer_angle(360.0),
+ _outer_gain(0.0),
+ _pitch(1.0),
+ _volume(1.0),
+ _master_volume(1.0),
+ _reference_dist(500.0),
+ _max_dist(3000.0),
+ _loop(AL_FALSE),
+ _playing(false),
+ _changed(true),
+ _static_changed(true),
+ _is_file(false)
+{
+ SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
+ _data = (unsigned char*)*data; *data = NULL;
}
// destructor
SGSoundSample::~SGSoundSample() {
- SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
- if (buffer)
- alDeleteBuffers(1, &buffer);
-}
-
-
-// play the sample
-void SGSoundSample::play( bool _loop ) {
-
- if ( source ) {
- alSourceStop( source );
- }
-
- playing = bind_source();
- if ( playing ) {
- loop = _loop;
-
- alSourcei( source, AL_LOOPING, loop );
- alSourcePlay( source );
-
- print_openal_error("play (alSourcePlay)");
- }
+ if (_data) free(_data);
}
+void SGSoundSample::update_pos_and_orientation() {
+ // The rotation rotating from the earth centerd frame to
+ // the horizontal local frame
+ SGQuatd hlOr = SGQuatd::fromLonLat(_base_pos);
-// stop playing the sample
-void SGSoundSample::stop() {
- if (playing) {
- alSourceStop( source );
- alDeleteSources(1, &source);
- source = 0;
- print_openal_error("stop (alDeleteSources)");
- }
- playing = false;
-}
+ // Compute the sounds orientation and position
+ // wrt the earth centered frame - that is global coorinates
+ SGQuatd sc2body = hlOr*_orientation;
-// Generate sound source
-bool
-SGSoundSample::bind_source() {
+ // This is rotates the x-forward, y-right, z-down coordinate system where
+ // simulation runs into the OpenGL camera system with x-right, y-up, z-back.
+ SGQuatd q(-0.5, -0.5, 0.5, 0.5);
- if ( playing ) {
- return true;
- }
- if ( buffer == 0 ) {
- return false;
- }
+ // The cartesian position of the sounds base location
+ SGVec3d position = SGVec3d::fromGeod(_base_pos);
- // Bind buffer with a source.
- alGetError();
- alGenSources(1, &source);
- if ( print_openal_error("bind_source (alGenSources)") ) {
- // No biggy, better luck next time.
- SG_LOG( SG_GENERAL, SG_ALERT, "Failed to generate audio source.");
- // SG_LOG( SG_GENERAL, SG_ALERT, "Please update your sound driver and try again.");
- return false;
+ _absolute_pos = position;
+#if 0
+ if ( _relative_pos[0] || _relative_pos[1] || _relative_pos[2] ) {
+ _absolute_pos += (sc2body*q).backTransform(_relative_pos);
}
-
- alSourcei( source, AL_BUFFER, buffer );
-#ifndef USE_SOFTWARE_DOPPLER
- alSourcef( source, AL_PITCH, pitch );
- alSourcef( source, AL_GAIN, volume );
-#else
- print_openal_error("bind_sources return");
- alSourcef( source, AL_PITCH, pitch * doppler_pitch_factor );
- alGetError(); // ignore if the pitch is clamped by the driver
- alSourcef( source, AL_GAIN, volume * doppler_volume_factor );
-#endif
- alSourcefv( source, AL_POSITION, source_pos );
- alSourcefv( source, AL_DIRECTION, direction );
- alSourcef( source, AL_CONE_INNER_ANGLE, inner );
- alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
- alSourcef( source, AL_CONE_OUTER_GAIN, outergain);
-#ifdef USE_OPEN_AL_DOPPLER
- alSourcefv( source, AL_VELOCITY, source_vel );
#endif
- alSourcei( source, AL_LOOPING, loop );
-
- alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
- alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
- alSourcef( source, AL_MAX_DISTANCE, max_dist );
-
- print_openal_error("bind_sources return");
-
- return true;
-}
-
-void
-SGSoundSample::set_pitch( double p ) {
- // clamp in the range of 0.01 to 2.0
- if ( p < 0.01 ) { p = 0.01; }
- if ( p > 2.0 ) { p = 2.0; }
- pitch = p;
- if (playing) {
-#ifndef USE_SOFTWARE_DOPPLER
- alSourcef( source, AL_PITCH, pitch );
- print_openal_error("set_pitch");
-#else
- alSourcef( source, AL_PITCH, pitch * doppler_pitch_factor );
- alGetError(); // ignore if the pitch is clamped by the driver
-#endif
- }
-}
-
-void
-SGSoundSample::set_volume( double v ) {
- volume = v;
- if (playing) {
-#ifndef USE_SOFTWARE_DOPPLER
- alSourcef( source, AL_GAIN, volume );
-#else
- alSourcef( source, AL_GAIN, volume * doppler_volume_factor );
-#endif
- print_openal_error("set_volume");
- }
-}
-
-
-bool
-SGSoundSample::is_playing( ) {
- if (playing) {
- ALint result;
- alGetSourcei( source, AL_SOURCE_STATE, &result );
- if ( alGetError() != AL_NO_ERROR) {
- SG_LOG( SG_GENERAL, SG_ALERT,
- "Oops AL error in sample is_playing(): " << sample_name );
- }
- return (result == AL_PLAYING) ;
- } else
- return false;
-}
-
-void
-SGSoundSample::set_source_pos( ALfloat *pos ) {
- source_pos[0] = pos[0];
- source_pos[1] = pos[1];
- source_pos[2] = pos[2];
-
- if (playing) {
- sgVec3 final_pos;
- sgAddVec3( final_pos, source_pos, offset_pos );
-
- alSourcefv( source, AL_POSITION, final_pos );
- print_openal_error("set_source_pos");
- }
-}
-
-void
-SGSoundSample::set_offset_pos( ALfloat *pos ) {
- offset_pos[0] = pos[0];
- offset_pos[1] = pos[1];
- offset_pos[2] = pos[2];
-
- if (playing) {
- sgVec3 final_pos;
- sgAddVec3( final_pos, source_pos, offset_pos );
-
- alSourcefv( source, AL_POSITION, final_pos );
- print_openal_error("set_offset_pos");
- }
-}
-
-void
-SGSoundSample::set_orientation( ALfloat *dir, ALfloat inner_angle,
- ALfloat outer_angle,
- ALfloat outer_gain)
-{
- inner = inner_angle;
- outer = outer_angle;
- outergain = outer_gain;
- direction[0] = dir[0];
- direction[1] = dir[1];
- direction[2] = dir[2];
- if (playing) {
- alSourcefv( source, AL_DIRECTION, dir);
- alSourcef( source, AL_CONE_INNER_ANGLE, inner );
- alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
- alSourcef( source, AL_CONE_OUTER_GAIN, outergain );
- }
-}
-
-void
-SGSoundSample::set_source_vel( ALfloat *vel, ALfloat *listener_vel ) {
- if (no_Doppler_effect) {
- source_vel[0] = listener_vel[0];
- source_vel[1] = listener_vel[1];
- source_vel[2] = listener_vel[2];
- } else {
- source_vel[0] = vel[0];
- source_vel[1] = vel[1];
- source_vel[2] = vel[2];
- }
-#ifdef USE_OPEN_AL_DOPPLER
- if (playing) {
- alSourcefv( source, AL_VELOCITY, source_vel );
- }
-#elif defined (USE_OPEN_AL_DOPPLER_WITH_FIXED_LISTENER)
- if (playing) {
- sgVec3 relative_vel;
- sgSubVec3( relative_vel, source_vel, listener_vel );
- alSourcefv( source, AL_VELOCITY, relative_vel );
- }
-#else
- if (no_Doppler_effect) {
- doppler_pitch_factor = 1;
- doppler_volume_factor = 1;
- return;
- }
- double doppler, mfp;
- sgVec3 final_pos;
- sgAddVec3( final_pos, source_pos, offset_pos );
- mfp = sgLengthVec3(final_pos);
- if (mfp > 1e-6) {
- double vls = -sgScalarProductVec3( listener_vel, final_pos ) / mfp;
- double vss = -sgScalarProductVec3( source_vel, final_pos ) / mfp;
- if (fabs(340 - vss) > 1e-6)
- {
- doppler = (340 - vls) / (340 - vss);
- doppler = ( doppler > 0) ? ( ( doppler < 10) ? doppler : 10 ) : 0;
- }
- else
- doppler = 0;
- }
- else
- doppler = 1;
- /* the OpenAL documentation of the Doppler calculation
- SS: AL_SPEED_OF_SOUND = speed of sound (default value 343.3)
- DF: AL_DOPPLER_FACTOR = Doppler factor (default 1.0)
- vls: Listener velocity scalar (scalar, projected on source-to-listener vector)
- vss: Source velocity scalar (scalar, projected on source-to-listener vector)
- SL = source to listener vector
- SV = Source Velocity vector
- LV = Listener Velocity vector
- vls = DotProduct(SL, LV) / Mag(SL)
- vss = DotProduct(SL, SV) / Mag(SL)
- Dopper Calculation:
- vss = min(vss, SS/DF)
- vls = min(vls, SS/DF)
- f' = f * (SS - DF*vls) / (SS - DF*vss)
- */
- if (doppler > 0.1) {
- if (doppler < 10) {
- doppler_pitch_factor = doppler;
- doppler_volume_factor = 1;
- }
- else {
- doppler_pitch_factor = (doppler < 11) ? doppler : 11;
- doppler_volume_factor = (doppler < 11) ? 11-doppler : 0;
- }
- }
- else {
- doppler_pitch_factor = 0.1;
- doppler_volume_factor = (doppler > 0) ? doppler * 10 : 0;
- }
- if (playing) {
- alSourcef( source, AL_GAIN, volume * doppler_volume_factor );
- print_openal_error("set_source_vel: volume");
- alSourcef( source, AL_PITCH, pitch * doppler_pitch_factor );
- alGetError(); //ignore if the pitch is clamped
- }
-#endif
-}
-
-void
-SGSoundSample::set_reference_dist( ALfloat dist ) {
- reference_dist = dist;
- if (playing) {
- alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
- }
-}
-
-
-void
-SGSoundSample::set_max_dist( ALfloat dist ) {
- max_dist = dist;
- if (playing) {
- alSourcef( source, AL_MAX_DISTANCE, max_dist );
+ if ( _direction[0] || _direction[1] || _direction[2] ) {
+ _orivec = toVec3f( (sc2body*q).backTransform(_direction) );
}
}
-ALvoid *
-SGSoundSample::load_file(const char *path, const char *file)
-{
- ALvoid* data = 0;
-
- SGPath samplepath( path );
- if ( strlen(file) ) {
- samplepath.append( file );
- }
-
-#if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
- ALfloat freqf;
- data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
- if (data == NULL) {
- throw sg_io_exception("Failed to load wav file.",
- sg_location(samplepath.str()));
- }
- freq = (ALsizei)freqf;
-#else
-# if defined (__APPLE__)
- alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
- &format, &data, &size, &freq );
-# else
- alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
- &format, &data, &size, &freq, &loop );
-# endif
- if ( print_openal_error("constructor (alutLoadWAVFile)") ) {
- throw sg_io_exception("Failed to load wav file.",
- sg_location(samplepath.str()));
- }
-#endif
+string SGSoundSample::random_string() {
+ static const char *r = "0123456789abcdefghijklmnopqrstuvwxyz"
+ "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+ string rstr = "System generated name: ";
+ for (int i=0; i<10; i++) {
+ rstr.push_back( r[rand() % strlen(r)] );
+ }
- return data;
+ return rstr;
}
projects / simgear.git / blobdiff