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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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>
40 #include <simgear/structure/SGReferenced.hxx>
41 #include <simgear/structure/SGSharedPtr.hxx>
45 #if defined(__APPLE__)
46 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
47 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
48 # include <OpenAL/al.h>
49 # include <OpenAL/alut.h>
58 * manages everything we need to know for an individual sound sample
61 class SGSoundSample : public SGReferenced {
67 // Buffers hold sound data.
70 // Sources are points emitting sound.
73 // Position of the source sound.
74 ALfloat source_pos[3];
76 // A constant offset to be applied to the final source_pos
77 ALfloat offset_pos[3];
79 // The orientation of the sound (direction and cut-off angles)
81 ALfloat inner, outer, outergain;
83 // Velocity of the source sound.
84 ALfloat source_vel[3];
86 // configuration values
93 double reference_dist;
103 * Empty constructor, can be used to read data to the systems
104 * memory and not to the driver.
110 * @param path Path name to sound
111 * @param file File name of sound
112 should usually be true unless you want to manipulate the data
115 SGSoundSample( const char *path, const char *file );
119 * @param _data Pointer to a memory buffer containing the sample data
120 the application is responsible for freeing the buffer data.
121 * @param len Byte length of array
122 * @param _freq Frequency of the provided data (bytes per second)
123 should usually be true unless you want to manipulate the data
126 SGSoundSample( unsigned char *_data, int len, int _freq );
131 * Start playing this sample.
133 * @param _loop Define wether the sound should be played in a loop.
135 void play( bool _loop );
138 * Stop playing this sample.
140 * @param sched A pointer to the appropriate scheduler.
145 * Play this sample once.
148 inline void play_once() { play(false); }
151 * Play this sample looped.
154 inline void play_looped() { play(true); }
157 * Test if a sample is curretnly playing.
158 * @return true if is is playing, false otherwise.
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 void set_pitch( double p );
173 * Get the current volume setting of this sample.
175 inline double get_volume() const { return volume; }
178 * Set the volume of this sample.
180 void set_volume( double v );
183 * Returns the size of the sounds sample
185 inline int get_size() {
190 * Set position of sound source (uses same coordinate system as opengl)
192 void set_source_pos( ALfloat *pos );
195 * Set "constant" offset position of sound source (uses same
196 * coordinate system as opengl)
198 void set_offset_pos( ALfloat *pos );
201 * Set the orientation of the sound source, both for direction
202 * and audio cut-off angles.
204 void set_orientation( ALfloat *dir, ALfloat inner_angle=360.0,
205 ALfloat outer_angle=360.0,
206 ALfloat outer_gain=0.0);
209 * Set velocity of sound source (uses same coordinate system as opengl)
211 void set_source_vel( ALfloat *vel );
215 * Set reference distance of sound (the distance where the gain
218 void set_reference_dist( ALfloat dist );
222 * Set maximume distance of sound (the distance where the sound is
225 void set_max_dist( ALfloat dist );
228 * Load a sound file into a memory buffer only.
230 ALvoid* load_file(const char *path, const char *file);
234 #endif // _SG_SAMPLE_HXX