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),
83 SGSoundSample::SGSoundSample( const char *path, const char *file) :
88 reference_dist(500.0),
93 SGPath samplepath( path );
95 samplepath.append( file );
97 sample_name = samplepath.str();
99 SG_LOG( SG_GENERAL, SG_DEBUG, "From file sounds sample = "
100 << samplepath.str() );
102 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
103 offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
104 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
105 direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
106 inner = outer = 360.0; outergain = 0.0;
108 // clear errors from elsewhere?
111 // create an OpenAL buffer handle
112 alGenBuffers(1, &buffer);
113 if ( print_openal_error("constructor (alGenBuffers)") ) {
114 throw sg_exception("Failed to gen OpenAL buffer.");
117 // Load the sample file
118 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
120 buffer = alutCreateBufferFromFile(samplepath.c_str());
121 if (buffer == AL_NONE) {
122 ALenum error = alutGetError ();
123 print_openal_error("constructor (alutCreateBufferFromFile)");
124 throw sg_io_exception("Failed to load wav file: ",
125 sg_location(string(alutGetErrorString (error))));
130 // pre 1.0 alut version
132 ALvoid* data = load_file(path, file);
134 // Copy data to the internal OpenAL buffer
135 alBufferData( buffer, format, data, size, freq );
137 if ( print_openal_error("constructor (alBufferData)") ) {
138 throw sg_exception("Failed to buffer data.");
141 alutUnloadWAV( format, data, size, freq );
144 print_openal_error("constructor return");
148 SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq ) :
153 reference_dist(500.0),
158 SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
160 sample_name = "unknown, generated from data";
162 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
163 offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
164 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
165 direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
166 inner = outer = 360.0; outergain = 0.0;
168 // clear errors from elsewhere?
171 // Load wav data into a buffer.
172 alGenBuffers(1, &buffer);
173 if ( print_openal_error("constructor (alGenBuffers)") ) {
174 throw sg_exception("Failed to gen buffer." );
177 format = AL_FORMAT_MONO8;
181 alBufferData( buffer, format, _data, size, freq );
182 if ( print_openal_error("constructor (alBufferData)") ) {
183 throw sg_exception("Failed to buffer data.");
186 print_openal_error("constructor return");
191 SGSoundSample::~SGSoundSample() {
192 SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
194 alDeleteBuffers(1, &buffer);
199 void SGSoundSample::play( bool _loop ) {
202 alSourceStop( source );
205 playing = bind_source();
209 alSourcei( source, AL_LOOPING, loop );
210 alSourcePlay( source );
212 print_openal_error("play (alSourcePlay)");
217 // stop playing the sample
218 void SGSoundSample::stop() {
220 alSourceStop( source );
221 alDeleteSources(1, &source);
223 print_openal_error("stop (alDeleteSources)");
228 // Generate sound source
230 SGSoundSample::bind_source() {
239 // Bind buffer with a source.
241 alGenSources(1, &source);
242 if ( print_openal_error("bind_source (alGenSources)") ) {
243 // No biggy, better luck next time.
244 SG_LOG( SG_GENERAL, SG_ALERT, "Failed to generate audio source.");
245 // SG_LOG( SG_GENERAL, SG_ALERT, "Please update your sound driver and try again.");
249 alSourcei( source, AL_BUFFER, buffer );
250 alSourcef( source, AL_PITCH, pitch );
251 alSourcef( source, AL_GAIN, volume );
252 alSourcefv( source, AL_POSITION, source_pos );
253 alSourcefv( source, AL_DIRECTION, direction );
254 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
255 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
256 alSourcef( source, AL_CONE_OUTER_GAIN, outergain);
257 alSourcefv( source, AL_VELOCITY, source_vel );
258 alSourcei( source, AL_LOOPING, loop );
260 alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
261 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
262 alSourcef( source, AL_MAX_DISTANCE, max_dist );
264 print_openal_error("bind_sources return");
270 SGSoundSample::set_pitch( double p ) {
271 // clamp in the range of 0.01 to 2.0
272 if ( p < 0.01 ) { p = 0.01; }
273 if ( p > 2.0 ) { p = 2.0; }
276 alSourcef( source, AL_PITCH, pitch );
277 print_openal_error("set_pitch");
282 SGSoundSample::set_volume( double v ) {
285 alSourcef( source, AL_GAIN, volume );
286 print_openal_error("set_volume");
292 SGSoundSample::is_playing( ) {
295 alGetSourcei( source, AL_SOURCE_STATE, &result );
296 if ( alGetError() != AL_NO_ERROR) {
297 SG_LOG( SG_GENERAL, SG_ALERT,
298 "Oops AL error in sample is_playing(): " << sample_name );
300 return (result == AL_PLAYING) ;
306 SGSoundSample::set_source_pos( ALfloat *pos ) {
307 source_pos[0] = pos[0];
308 source_pos[1] = pos[1];
309 source_pos[2] = pos[2];
313 sgAddVec3( final_pos, source_pos, offset_pos );
315 alSourcefv( source, AL_POSITION, final_pos );
320 SGSoundSample::set_offset_pos( ALfloat *pos ) {
321 offset_pos[0] = pos[0];
322 offset_pos[1] = pos[1];
323 offset_pos[2] = pos[2];
327 sgAddVec3( final_pos, source_pos, offset_pos );
329 alSourcefv( source, AL_POSITION, final_pos );
334 SGSoundSample::set_orientation( ALfloat *dir, ALfloat inner_angle,
340 outergain = outer_gain;
342 alSourcefv( source, AL_DIRECTION, dir);
343 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
344 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
345 alSourcef( source, AL_CONE_OUTER_GAIN, outergain );
350 SGSoundSample::set_source_vel( ALfloat *vel ) {
351 source_vel[0] = vel[0];
352 source_vel[1] = vel[1];
353 source_vel[2] = vel[2];
355 alSourcefv( source, AL_VELOCITY, source_vel );
360 SGSoundSample::set_reference_dist( ALfloat dist ) {
361 reference_dist = dist;
363 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
369 SGSoundSample::set_max_dist( ALfloat dist ) {
372 alSourcef( source, AL_MAX_DISTANCE, max_dist );
377 SGSoundSample::load_file(const char *path, const char *file)
381 SGPath samplepath( path );
382 if ( strlen(file) ) {
383 samplepath.append( file );
386 #if defined(ALUT_API_MAJOR_VERSION) && ALUT_API_MAJOR_VERSION >= 1
388 data = alutLoadMemoryFromFile(samplepath.c_str(), &format, &size, &freqf );
390 throw sg_io_exception("Failed to load wav file.",
391 sg_location(samplepath.str()));
393 freq = (ALsizei)freqf;
395 # if defined (__APPLE__)
396 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
397 &format, &data, &size, &freq );
399 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
400 &format, &data, &size, &freq, &loop );
402 if ( print_openal_error("constructor (alutLoadWAVFile)") ) {
403 throw sg_io_exception("Failed to load wav file.",
404 sg_location(samplepath.str()));