1 // sample.hxx -- 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.
25 * Provides a sound sample encapsulation
28 #ifndef _SG_SAMPLE_HXX
29 #define _SG_SAMPLE_HXX 1
32 # error This library requires C++
35 #include <simgear/compiler.h>
39 #include <simgear/debug/logstream.hxx>
43 #if defined(__APPLE__)
44 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
45 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
46 # include <OpenAL/al.h>
47 # include <OpenAL/alut.h>
56 * manages everything we need to know for an individual sound sample
65 // Buffers hold sound data.
68 // Sources are points emitting sound.
71 // Position of the source sound.
72 ALfloat source_pos[3];
74 // A constant offset to be applied to the final source_pos
75 ALfloat offset_pos[3];
77 // The orientation of the sound (direction and cut-off angles)
79 ALfloat inner, outer, outergain;
81 // Velocity of the source sound.
82 ALfloat source_vel[3];
84 // configuration values
92 double reference_dist;
101 * @param path Path name to sound
102 * @param file File name of sound
103 * @param cleanup Request clean up the intermediate data (this
104 should usually be true unless you want to manipulate the data
107 SGSoundSample( const char *path, const char *file, bool cleanup );
111 * @param _data Pointer to a memory buffer containing the sample data
112 * @param len Byte length of array
113 * @param _freq Frequency of the provided data (bytes per second)
114 * @param cleanup Request clean up the intermediate data (this
115 should usually be true unless you want to manipulate the data
118 SGSoundSample( unsigned char *_data, int len, int _freq, bool cleanup );
123 * Start playing this sample.
125 * @param _loop Define wether the sound should be played in a loop.
127 void play( bool _loop );
130 * Stop playing this sample.
132 * @param sched A pointer to the appropriate scheduler.
137 * Play this sample once.
140 inline void play_once() { play(false); }
143 * Play this sample looped.
146 inline void play_looped() { play(true); }
149 * Test if a sample is curretnly playing.
150 * @return true if is is playing, false otherwise.
152 inline bool is_playing( ) {
154 alGetSourcei( source, AL_SOURCE_STATE, &result );
155 if ( alGetError() != AL_NO_ERROR) {
156 SG_LOG( SG_GENERAL, SG_ALERT,
157 "Oops AL error in sample is_playing(): " << sample_name );
159 return (result == AL_PLAYING) ;
163 * Get the current pitch setting of this sample.
165 inline double get_pitch() const { return pitch; }
168 * Set the pitch of this sample.
170 inline void set_pitch( double p ) {
171 // clamp in the range of 0.01 to 2.0
172 if ( p < 0.01 ) { p = 0.01; }
173 if ( p > 2.0 ) { p = 2.0; }
175 alSourcef( source, AL_PITCH, pitch );
176 if ( alGetError() != AL_NO_ERROR) {
177 SG_LOG( SG_GENERAL, SG_ALERT,
178 "Oops AL error in sample set_pitch()! " << p
179 << " for " << sample_name );
184 * Get the current volume setting of this sample.
186 inline double get_volume() const { return volume; }
189 * Set the volume of this sample.
191 inline void set_volume( double v ) {
193 alSourcef( source, AL_GAIN, volume );
194 if ( alGetError() != AL_NO_ERROR) {
195 SG_LOG( SG_GENERAL, SG_ALERT,
196 "Oops AL error in sample set_volume()! " << v
197 << " for " << sample_name );
202 * Returns the size of the sounds sample
204 inline int get_size() {
209 * Return a pointer to the raw data
211 inline char *get_data() {
216 * Set position of sound source (uses same coordinate system as opengl)
218 inline void set_source_pos( ALfloat *pos ) {
219 source_pos[0] = pos[0];
220 source_pos[1] = pos[1];
221 source_pos[2] = pos[2];
224 sgAddVec3( final_pos, source_pos, offset_pos );
226 alSourcefv( source, AL_POSITION, final_pos );
230 * Set "constant" offset position of sound source (uses same
231 * coordinate system as opengl)
233 inline void set_offset_pos( ALfloat *pos ) {
234 offset_pos[0] = pos[0];
235 offset_pos[1] = pos[1];
236 offset_pos[2] = pos[2];
239 sgAddVec3( final_pos, source_pos, offset_pos );
241 alSourcefv( source, AL_POSITION, final_pos );
245 * Set the orientation of the sound source, both for direction
246 * and audio cut-off angles.
248 inline void set_orientation( ALfloat *dir, ALfloat inner_angle=360.0,
249 ALfloat outer_angle=360.0,
250 ALfloat outer_gain=0.0)
254 outergain = outer_gain;
255 alSourcefv( source, AL_DIRECTION, dir);
256 alSourcef( source, AL_CONE_INNER_ANGLE, inner );
257 alSourcef( source, AL_CONE_OUTER_ANGLE, outer );
258 alSourcef( source, AL_CONE_OUTER_GAIN, outergain );
262 * Set velocity of sound source (uses same coordinate system as opengl)
264 inline void set_source_vel( ALfloat *vel ) {
265 source_vel[0] = vel[0];
266 source_vel[1] = vel[1];
267 source_vel[2] = vel[2];
268 alSourcefv( source, AL_VELOCITY, source_vel );
273 * Set reference distance of sound (the distance where the gain
276 inline void set_reference_dist( ALfloat dist ) {
277 reference_dist = dist;
278 alSourcef( source, AL_REFERENCE_DISTANCE, reference_dist );
283 * Set maximume distance of sound (the distance where the sound is
286 inline void set_max_dist( ALfloat dist ) {
288 alSourcef( source, AL_MAX_DISTANCE, max_dist );
293 #endif // _SG_SAMPLE_HXX