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., 675 Mass Ave, Cambridge, MA 02139, USA.
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>
34 #include <simgear/debug/logstream.hxx>
35 #include <simgear/misc/sg_path.hxx>
36 #include <simgear/structure/exception.hxx>
38 #include "sample_openal.hxx"
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" );
58 SG_LOG( SG_GENERAL, SG_ALERT, "Unhandled error code = " << error );
64 SGSoundSample::SGSoundSample( const char *path, const char *file,
69 reference_dist(500.0),
73 SGPath samplepath( path );
75 samplepath.append( file );
78 sample_name = samplepath.str();
80 SG_LOG( SG_GENERAL, SG_DEBUG, "From file sounds sample = "
81 << samplepath.str() );
83 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
84 offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
85 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
86 direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
87 inner = outer = 360.0; outergain = 0.0;
89 // clear errors from elsewhere?
92 // create an OpenAL buffer handle
93 alGenBuffers(1, &buffer);
94 ALuint error = alGetError();
95 if ( error != AL_NO_ERROR ) {
96 print_openal_error( error );
97 throw sg_exception("Failed to gen OpenAL buffer.");
100 // Load the sample file
101 #if defined (__APPLE__)
102 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
103 &format, &data, &size, &freq );
105 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
106 &format, &data, &size, &freq, &loop );
108 if (alGetError() != AL_NO_ERROR) {
109 throw sg_exception("Failed to load wav file.");
112 // Copy data to the internal OpenAL buffer
113 alBufferData( buffer, format, data, size, freq );
114 if (alGetError() != AL_NO_ERROR) {
115 throw sg_exception("Failed to buffer data.");
119 alutUnloadWAV( format, data, size, freq );
123 // Bind buffer with a source.
124 alGenSources(1, &source);
125 if (alGetError() != AL_NO_ERROR) {
126 throw sg_exception("Failed to gen source.");
129 alSourcei( source, AL_BUFFER, buffer );
130 alSourcef( source, AL_PITCH, pitch );
131 alSourcef( source, AL_GAIN, volume );
132 alSourcefv( source, AL_POSITION, source_pos );
133 alSourcefv( source, AL_DIRECTION, direction );
134 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
135 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
136 alSourcef( source, AL_CONE_OUTER_GAIN, outergain);
137 alSourcefv( source, AL_VELOCITY, source_vel );
138 alSourcei( source, AL_LOOPING, loop );
140 alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
141 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
142 alSourcef( source, AL_MAX_DISTANCE, max_dist );
147 SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq,
152 reference_dist(500.0),
156 SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
158 sample_name = "unknown, generated from data";
160 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
161 offset_pos[0] = 0.0; offset_pos[1] = 0.0; offset_pos[2] = 0.0;
162 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
163 direction[0] = 0.0; direction[1] = 0.0; direction[2] = 0.0;
164 inner = outer = 360.0; outergain = 0.0;
166 // clear errors from elsewhere?
169 // Load wav data into a buffer.
170 alGenBuffers(1, &buffer);
171 ALuint error = alGetError();
172 if ( error != AL_NO_ERROR ) {
173 print_openal_error( error );
174 throw sg_exception("Failed to gen buffer." );
178 format = AL_FORMAT_MONO8;
183 alBufferData( buffer, format, data, size, freq );
184 if (alGetError() != AL_NO_ERROR) {
185 throw sg_exception("Failed to buffer data.");
189 alutUnloadWAV( format, data, size, freq );
193 // Bind buffer with a source.
194 alGenSources(1, &source);
195 if (alGetError() != AL_NO_ERROR) {
196 throw sg_exception("Failed to gen source.");
199 alSourcei( source, AL_BUFFER, buffer );
200 alSourcef( source, AL_PITCH, pitch );
201 alSourcef( source, AL_GAIN, volume );
202 alSourcefv( source, AL_POSITION, source_pos );
203 alSourcefv( source, AL_DIRECTION, direction );
204 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
205 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
206 alSourcef( source, AL_CONE_OUTER_GAIN, outergain );
207 alSourcefv( source, AL_VELOCITY, source_vel );
208 alSourcei( source, AL_LOOPING, loop );
210 alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
211 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
212 alSourcef( source, AL_MAX_DISTANCE, max_dist );
217 SGSoundSample::~SGSoundSample() {
218 SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
219 alDeleteSources(1, &source);
220 alDeleteBuffers(1, &buffer);
225 void SGSoundSample::play( bool _loop ) {
228 // make sure sound isn't already playing
229 alSourceStop( source );
231 alSourcei( source, AL_LOOPING, loop );
232 alSourcePlay( source );
236 // stop playing the sample
237 void SGSoundSample::stop() {
238 alSourceStop( source );