1 // sample.cxx -- Sound sample encapsulation class
3 // Written by Curtis Olson, started April 2004.
5 // Copyright (C) 2004 Curtis L. Olson - curt@flightgear.org
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() );
85 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
86 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
88 // clear errors from elsewhere?
91 // create an OpenAL buffer handle
92 alGenBuffers(1, &buffer);
94 if ( error != AL_NO_ERROR ) {
95 print_openal_error( error );
96 throw sg_exception("Failed to gen OpenAL buffer.");
99 // Load the sample file
100 #if defined (__APPLE__)
101 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
102 &format, &data, &size, &freq );
104 alutLoadWAVFile( (ALbyte *)samplepath.c_str(),
105 &format, &data, &size, &freq, &loop );
107 if (alGetError() != AL_NO_ERROR) {
108 throw sg_exception("Failed to load wav file.");
111 // Copy data to the internal OpenAL buffer
112 alBufferData( buffer, format, data, size, freq );
113 if (alGetError() != AL_NO_ERROR) {
114 throw sg_exception("Failed to buffer data.");
118 alutUnloadWAV( format, data, size, freq );
122 // Bind buffer with a source.
123 alGenSources(1, &source);
124 if (alGetError() != AL_NO_ERROR) {
125 throw sg_exception("Failed to gen source.");
128 alSourcei( source, AL_BUFFER, buffer );
129 alSourcef( source, AL_PITCH, pitch );
130 alSourcef( source, AL_GAIN, volume );
131 alSourcefv( source, AL_POSITION, source_pos );
132 alSourcefv( source, AL_VELOCITY, source_vel );
133 alSourcei( source, AL_LOOPING, loop );
135 alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
136 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
137 alSourcef( source, AL_MAX_DISTANCE, max_dist );
142 SGSoundSample::SGSoundSample( unsigned char *_data, int len, int _freq ) :
146 reference_dist(500.0),
150 SG_LOG( SG_GENERAL, SG_DEBUG, "In memory sounds sample" );
152 sample_name = "unknown, generated from data";
154 source_pos[0] = 0.0; source_pos[1] = 0.0; source_pos[2] = 0.0;
155 source_vel[0] = 0.0; source_vel[1] = 0.0; source_vel[2] = 0.0;
157 // Load wav data into a buffer.
158 alGenBuffers(1, &buffer);
159 if (alGetError() != AL_NO_ERROR) {
160 throw sg_exception("Failed to gen buffer." );
164 format = AL_FORMAT_MONO8;
169 alBufferData( buffer, format, data, size, freq );
171 // Bind buffer with a source.
172 alGenSources(1, &source);
173 if (alGetError() != AL_NO_ERROR) {
174 throw sg_exception("Failed to gen source.");
177 alSourcei( source, AL_BUFFER, buffer );
178 alSourcef( source, AL_PITCH, pitch );
179 alSourcef( source, AL_GAIN, volume );
180 alSourcefv( source, AL_POSITION, source_pos );
181 alSourcefv( source, AL_VELOCITY, source_vel );
182 alSourcei( source, AL_LOOPING, loop );
184 alSourcei( source, AL_SOURCE_RELATIVE, AL_TRUE );
185 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
186 alSourcef( source, AL_MAX_DISTANCE, max_dist );
191 SGSoundSample::~SGSoundSample() {
192 SG_LOG( SG_GENERAL, SG_INFO, "Deleting a sample" );
193 if ( data != NULL ) {
196 alDeleteSources(1, &source);
197 alDeleteBuffers(1, &buffer);
202 void SGSoundSample::play( bool _loop ) {
205 // make sure sound isn't already playing
206 alSourceStop( source );
208 alSourcei( source, AL_LOOPING, loop );
209 alSourcePlay( source );
213 // stop playing the sample
214 void SGSoundSample::stop() {
215 alSourceStop( source );