1 // sample.cxx -- Sound sample encapsulation class
3 // Written by Curtis Olson, started April 2004.
5 // Copyright (C) 2004 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 # include <simgear_config.h>
27 #if defined( __APPLE__ )
28 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
29 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
30 # include <OpenAL/al.h>
31 # include <OpenAL/alut.h>
37 #include <simgear/debug/logstream.hxx>
38 #include <simgear/misc/sg_path.hxx>
39 #include <simgear/structure/exception.hxx>
41 #include "sample_openal.hxx"
49 static bool print_openal_error(const string &s = "unknown") {
50 ALuint error = alGetError();
51 if ( error == AL_NO_ERROR ) {
53 } else if ( error == AL_INVALID_NAME ) {
54 SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_INVALID_NAME): " << s );
55 } else if ( error == AL_ILLEGAL_ENUM ) {
56 SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_ILLEGAL_ENUM): " << s );
57 } else if ( error == AL_INVALID_VALUE ) {
58 SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_INVALID_VALUE): " << s );
59 } else if ( error == AL_ILLEGAL_COMMAND ) {
60 SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_ILLEGAL_COMMAND): " << s );
61 } else if ( error == AL_OUT_OF_MEMORY ) {
62 SG_LOG( SG_GENERAL, SG_ALERT, "OpenAL error (AL_OUT_OF_MEMORY): " << s );
64 SG_LOG( SG_GENERAL, SG_ALERT, "Unhandled error code = " << error );
70 SGSoundSample::SGSoundSample() :
75 reference_dist(500.0),
79 no_Doppler_effect(true)
84 SGSoundSample::SGSoundSample( const char *path, const char *file , bool _no_Doppler_effect ) :
89 reference_dist(500.0),
93 no_Doppler_effect(_no_Doppler_effect)
95 SGPath samplepath( path );
97 samplepath.append( file );
99 sample_name = samplepath.str();
101 SG_LOG( SG_GENERAL, SG_DEBUG, "From file sounds sample = "
102 << samplepath.str() );
104 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
105 offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
106 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
107 direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
108 inner = outer = 360.0; outergain = 0.0;
110 // clear errors from elsewhere?
113 // create an OpenAL buffer handle
114 alGenBuffers(1, &buffer);
115 if ( print_openal_error("constructor (alGenBuffers)") ) {
116 throw sg_exception("Failed to gen OpenAL buffer.");
119 // Load the sample file
120 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
122 buffer = alutCreateBufferFromFile(samplepath.c_str());
123 if (buffer == AL_NONE) {
124 ALenum error = alutGetError ();
125 print_openal_error("constructor (alutCreateBufferFromFile)");
126 throw sg_io_exception("Failed to load wav file: ",
127 sg_location(string(alutGetErrorString (error))));
132 // pre 1.0 alut version
134 ALvoid* data = load_file(path, file);
136 // Copy data to the internal OpenAL buffer
137 alBufferData( buffer, format, data, size, freq );
139 if ( print_openal_error("constructor (alBufferData)") ) {
140 throw sg_exception("Failed to buffer data.");
143 alutUnloadWAV( format, data, size, freq );
146 print_openal_error("constructor return");
150 SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq , bool _no_Doppler_effect ) :
155 reference_dist(500.0),
159 no_Doppler_effect(_no_Doppler_effect)
161 SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
163 sample_name = "unknown, generated from data";
165 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
166 offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
167 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
168 direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
169 inner = outer = 360.0; outergain = 0.0;
171 // clear errors from elsewhere?
174 // Load wav data into a buffer.
175 alGenBuffers(1, &buffer);
176 if ( print_openal_error("constructor (alGenBuffers)") ) {
177 throw sg_exception("Failed to gen buffer." );
180 format = AL_FORMAT_MONO8;
184 alBufferData( buffer, format, _data, size, freq );
185 if ( print_openal_error("constructor (alBufferData)") ) {
186 throw sg_exception("Failed to buffer data.");
189 print_openal_error("constructor return");
194 SGSoundSample::~SGSoundSample() {
195 SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
197 alDeleteBuffers(1, &buffer);
202 void SGSoundSample::play( bool _loop ) {
205 alSourceStop( source );
208 playing = bind_source();
212 alSourcei( source, AL_LOOPING, loop );
213 alSourcePlay( source );
215 print_openal_error("play (alSourcePlay)");
220 // stop playing the sample
221 void SGSoundSample::stop() {
223 alSourceStop( source );
224 alDeleteSources(1, &source);
226 print_openal_error("stop (alDeleteSources)");
231 // Generate sound source
233 SGSoundSample::bind_source() {
242 // Bind buffer with a source.
244 alGenSources(1, &source);
245 if ( print_openal_error("bind_source (alGenSources)") ) {
246 // No biggy, better luck next time.
247 SG_LOG( SG_GENERAL, SG_ALERT, "Failed to generate audio source.");
248 // SG_LOG( SG_GENERAL, SG_ALERT, "Please update your sound driver and try again.");
252 alSourcei( source, AL_BUFFER, buffer );
253 alSourcef( source, AL_PITCH, pitch );
254 alSourcef( source, AL_GAIN, volume );
255 alSourcefv( source, AL_POSITION, source_pos );
256 alSourcefv( source, AL_DIRECTION, direction );
257 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
258 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
259 alSourcef( source, AL_CONE_OUTER_GAIN, outergain);
260 alSourcefv( source, AL_VELOCITY, source_vel );
261 alSourcei( source, AL_LOOPING, loop );
263 alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
264 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
265 alSourcef( source, AL_MAX_DISTANCE, max_dist );
267 print_openal_error("bind_sources return");
273 SGSoundSample::set_pitch( double p ) {
274 // clamp in the range of 0.01 to 2.0
275 if ( p < 0.01 ) { p = 0.01; }
276 if ( p > 2.0 ) { p = 2.0; }
279 alSourcef( source, AL_PITCH, pitch );
280 print_openal_error("set_pitch");
285 SGSoundSample::set_volume( double v ) {
288 alSourcef( source, AL_GAIN, volume );
289 print_openal_error("set_volume");
295 SGSoundSample::is_playing( ) {
298 alGetSourcei( source, AL_SOURCE_STATE, &result );
299 if ( alGetError() != AL_NO_ERROR) {
300 SG_LOG( SG_GENERAL, SG_ALERT,
301 "Oops AL error in sample is_playing(): " << sample_name );
303 return (result == AL_PLAYING) ;
309 SGSoundSample::set_source_pos( ALfloat *pos ) {
310 source_pos[0] = pos[0];
311 source_pos[1] = pos[1];
312 source_pos[2] = pos[2];
316 sgAddVec3( final_pos, source_pos, offset_pos );
318 alSourcefv( source, AL_POSITION, final_pos );
319 print_openal_error("set_source_pos");
324 SGSoundSample::set_offset_pos( ALfloat *pos ) {
325 offset_pos[0] = pos[0];
326 offset_pos[1] = pos[1];
327 offset_pos[2] = pos[2];
331 sgAddVec3( final_pos, source_pos, offset_pos );
333 alSourcefv( source, AL_POSITION, final_pos );
334 print_openal_error("set_offset_pos");
339 SGSoundSample::set_orientation( ALfloat *dir, ALfloat inner_angle,
345 outergain = outer_gain;
346 direction[0] = dir[0];
347 direction[1] = dir[1];
348 direction[2] = dir[2];
350 alSourcefv( source, AL_DIRECTION, dir);
351 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
352 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
353 alSourcef( source, AL_CONE_OUTER_GAIN, outergain );
358 SGSoundSample::set_source_vel( ALfloat *vel , ALfloat *listener_vel ) {
359 if (no_Doppler_effect) {
360 source_vel[0] = listener_vel[0];
361 source_vel[1] = listener_vel[1];
362 source_vel[2] = listener_vel[2];
364 source_vel[0] = vel[0];
365 source_vel[1] = vel[1];
366 source_vel[2] = vel[2];
369 alSourcefv( source, AL_VELOCITY, source_vel );
374 SGSoundSample::set_reference_dist( ALfloat dist ) {
375 reference_dist = dist;
377 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
383 SGSoundSample::set_max_dist( ALfloat dist ) {
386 alSourcef( source, AL_MAX_DISTANCE, max_dist );
391 SGSoundSample::load_file(const char *path, const char *file)
395 SGPath samplepath( path );
396 if ( strlen(file) ) {
397 samplepath.append( file );
400 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
402 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
404 throw sg_io_exception("Failed to load wav file.",
405 sg_location(samplepath.str()));
407 freq = (ALsizei)freqf;
409 # if defined (__APPLE__)
410 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
411 &format, &data, &size, &freq );
413 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
414 &format, &data, &size, &freq, &loop );
416 if ( print_openal_error("constructor (alutLoadWAVFile)") ) {
417 throw sg_io_exception("Failed to load wav file.",
418 sg_location(samplepath.str()));