1 // sample_openal.hxx -- Audio sample encapsulation class
3 // Written by Curtis Olson, started April 2004.
4 // Modified to match the new SoundSystem by Erik Hofman, October 2009
6 // Copyright (C) 2004 Curtis L. Olson - http://www.flightgear.org/~curt
7 // Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
9 // This program is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU General Public License as
11 // published by the Free Software Foundation; either version 2 of the
12 // License, or (at your option) any later version.
14 // This program is distributed in the hope that it will be useful, but
15 // WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software Foundation,
21 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * \file audio sample.hxx
27 * Provides a audio sample encapsulation
30 #ifndef _SG_SAMPLE_HXX
31 #define _SG_SAMPLE_HXX 1
34 # error This library requires C++
39 #include <simgear/compiler.h>
40 #include <simgear/debug/logstream.hxx>
41 #include <simgear/structure/SGReferenced.hxx>
42 #include <simgear/structure/SGSharedPtr.hxx>
43 #include <simgear/math/SGMath.hxx>
45 // #include <plib/sg.h>
48 * manages everything we need to know for an individual audio sample
51 class SGSoundSample : public SGReferenced {
55 * Empty constructor, can be used to read data to the systems
56 * memory and not to the driver.
62 * @param path Path name to sound
63 * @param file File name of sound
64 Buffer data is freed by the sample group
66 SGSoundSample( const char *path, const char *file );
70 * @param data Pointer to a memory buffer containing this audio sample data
71 The application may free the data by calling free_data(), otherwise it
72 will be resident untill the class is destroyed. This pointer will be
73 set to NULL after calling this function.
74 * @param len Byte length of array
75 * @param freq Frequency of the provided data (bytes per second)
76 * @param format OpenAL format id of the data
78 SGSoundSample( void** data, int len, int freq, int format=AL_FORMAT_MONO8 );
79 SGSoundSample( const unsigned char** data, int len, int freq,
80 int format = AL_FORMAT_MONO8 );
88 * Detect wheter this audio sample holds the information of a sound file.
89 * @return Return true if this audio sample is to be constructed from a file.
91 inline bool is_file() const { return _is_file; }
94 * Test if this audio sample configuration has changed since the last call.
95 * Calling this function will reset the flag so calling it a second
96 * time in a row will return false.
97 * @return Return true is the configuration has changed in the mean time.
100 bool b = _changed; _changed = false; return b;
104 * Test if static dataa of audio sample configuration has changed.
105 * Calling this function will reset the flag so calling it a second
106 * time in a row will return false.
107 * @return Return true is the static data has changed in the mean time.
109 bool has_static_data_changed() {
110 bool b = _static_changed; _static_changed = false; return b;
114 * Schedule this audio sample for playing. Actual playing will only start
115 * at the next call op SoundGroup::update()
116 * @param _loop Define whether this sound should be played in a loop.
118 void play( bool loop ) {
119 _playing = true; _loop = loop; _changed = true;
123 * Check if this audio sample is set to be continuous looping.
124 * @return Return true if this audio sample is set to looping.
126 inline bool is_looping() { return _loop; }
129 * Schedule this audio sample to stop playing.
132 _playing = false; _changed = true;
136 * Schedule this audio sample to play once.
139 inline void play_once() { play(false); }
142 * Schedule this audio sample to play looped.
145 inline void play_looped() { play(true); }
148 * Test if a audio sample is scheduled for playing.
149 * @return true if this audio sample is playing, false otherwise.
151 inline bool is_playing() { return _playing; }
154 * Set the data associated with this audio sample
155 * @param data Pointer to a memory block containg this audio sample data.
156 This pointer will be set to NULL after calling this function.
158 inline void set_data( const unsigned char **data ) {
159 _data = (unsigned char*)*data; *data = NULL;
161 inline void set_data( void **data ) {
162 _data = (unsigned char*)*data; *data = NULL;
166 * Return the data associated with this audio sample.
167 * @return A pointer to this sound data of this audio sample.
169 inline void* get_data() const { return _data; }
172 * Free the data associated with this audio sample
175 if ( _data ) free( _data ); _data = NULL;
179 * Set the source id of this source
180 * @param sid OpenAL source-id
182 void set_source(unsigned int sid) {
183 _source = sid; _valid_source = true; _changed = true;
187 * Get the OpenAL source id of this source
188 * @return OpenAL source-id
190 inline unsigned int get_source() { return _source; }
193 * Test if the source-id of this audio sample may be passed to OpenAL.
194 * @return true if the source-id is valid
196 inline bool is_valid_source() const { return _valid_source; }
199 * Set the source-id of this audio sample to invalid.
201 inline void no_valid_source() { _valid_source = false; }
204 * Set the OpenAL buffer-id of this source
205 * @param bid OpenAL buffer-id
207 void set_buffer(unsigned int bid) {
208 _buffer = bid; _valid_buffer = true; _changed = true;
212 * Get the OpenAL buffer-id of this source
213 * @return OpenAL buffer-id
215 inline unsigned int get_buffer() { return _buffer; }
218 * Test if the buffer-id of this audio sample may be passed to OpenAL.
219 * @return true if the buffer-id is valid
221 inline bool is_valid_buffer() const { return _valid_buffer; }
224 * Set the buffer-id of this audio sample to invalid.
226 inline void no_valid_buffer() { _valid_buffer = false; }
229 * Set the playback pitch of this audio sample.
230 * Should be between 0.0 and 2.0 for maximum compatibility.
233 inline void set_pitch( float p ) {
234 if (p > 2.0) p = 2.0; else if (p < 0.01) p = 0.01;
235 _pitch = p; _changed = true;
239 * Get the current pitch value of this audio sample.
242 inline float get_pitch() { return _pitch; }
245 * Set the master volume of this sample. Should be between 0.0 and 1.0.
246 * The final volume is calculated by multiplying the master and audio sample
250 inline void set_master_volume( float v ) {
251 if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
252 _master_volume = v; _changed = true;
256 * Set the volume of this audio sample. Should be between 0.0 and 1.0.
257 * The final volume is calculated by multiplying the master and audio sample
261 inline void set_volume( float v ) {
262 if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
263 _volume = v; _changed = true;
267 * Get the final volume value of this audio sample.
270 inline float get_volume() { return _volume * _master_volume; }
273 * Set the OpenAL format of this audio sample.
274 * @param format OpenAL format-id
276 inline void set_format( int format ) { _format = format; }
279 * Returns the format of this audio sample.
280 * @return OpenAL format-id
282 inline int get_format() { return _format; }
285 * Set the frequency (in Herz) of this audio sample.
286 * @param freq Frequency
288 inline void set_frequency( int freq ) { _freq = freq; }
291 * Returns the frequency (in Herz) of this audio sample.
294 inline int get_frequency() { return _freq; }
297 * Sets the size (in bytes) of this audio sample.
298 * @param size Data size
300 inline void set_size( size_t size ) { _size = size; }
303 * Returns the size (in bytes) of this audio sample.
306 inline size_t get_size() const { return _size; }
309 * Set the position of this sound relative to the base position.
310 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
311 * @param pos Relative position of this sound
313 inline void set_relative_position( const SGVec3f& pos ) {
314 _relative_pos = toVec3d(pos); _changed = true;
318 * Set the base position in Cartesian coordinates
319 * @param pos position in Cartesian coordinates
321 inline void set_position( const SGVec3d& pos ) {
322 _base_pos = pos; _changed = true;
326 * Get the absolute position of this sound.
327 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
328 * @return Absolute position
330 SGVec3d& get_position() { return _absolute_pos; }
333 * Set the orientation of this sound.
334 * @param ori Quaternation containing the orientation information
336 inline void set_orientation( const SGQuatd& ori ) {
337 _orientation = ori; _changed = true;
340 inline void set_rotation( const SGQuatd& ec2body ) {
341 _rotation = ec2body; _changed = true;
345 * Set direction of this sound relative to the orientation.
346 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
347 * @param dir Sound emission direction
349 inline void set_direction( const SGVec3f& dir ) {
350 _direction = toVec3d(dir); _static_changed = true;
354 * Define the audio cone parameters for directional audio.
355 * Note: setting it to 2 degree will result in 1 degree to both sides.
356 * @param inner Inner cone angle (0 - 360 degrees)
357 * @param outer Outer cone angle (0 - 360 degrees)
358 * @param gain Remaining gain at the edge of the outer cone (0.0 - 1.0)
360 void set_audio_cone( float inner, float outer, float gain ) {
361 _inner_angle = inner; _outer_angle = outer; _outer_gain = gain;
362 _static_changed = true;
366 * Get the orientation vector of this sound.
367 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
368 * @return Orientaton vector
370 SGVec3f& get_orientation() { return _orivec; }
373 * Get the inner angle of the audio cone.
374 * @return Inner angle in degrees
376 float get_innerangle() { return _inner_angle; }
379 * Get the outer angle of the audio cone.
380 * @return Outer angle in degrees
382 float get_outerangle() { return _outer_angle; }
385 * Get the remaining gain at the edge of the outer cone.
388 float get_outergain() { return _outer_gain; }
391 * Set the velocity vector (in meters per second) of this sound.
392 * This is in the local frame coordinate system; x=north, y=east, z=down
393 * @param Velocity vector
395 inline void set_velocity( const SGVec3f& vel ) {
396 _velocity = vel; _changed = true;
400 * Get velocity vector (in meters per second) of this sound.
401 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
402 * @return Velocity vector
404 SGVec3f& get_velocity() { return _velocity; }
408 * Set reference distance (in meters) of this sound.
409 * This is the distance where the gain will be half.
410 * @param dist Reference distance
412 inline void set_reference_dist( float dist ) {
413 _reference_dist = dist; _static_changed = true;
417 * Get reference distance ((in meters) of this sound.
418 * This is the distance where the gain will be half.
419 * @return Reference distance
421 inline float get_reference_dist() { return _reference_dist; }
425 * Set maximum distance (in meters) of this sound.
426 * This is the distance where this sound is no longer audible.
427 * @param dist Maximum distance
429 inline void set_max_dist( float dist ) {
430 _max_dist = dist; _static_changed = true;
434 * Get maximum distance (in meters) of this sound.
435 * This is the distance where this sound is no longer audible.
436 * @return dist Maximum distance
438 inline float get_max_dist() { return _max_dist; }
441 * Get the reference name of this audio sample.
442 * @return Sample name
444 inline std::string get_sample_name() const { return _refname; }
446 void update_pos_and_orientation();
450 // Position of the source sound.
451 SGVec3d _absolute_pos; // absolute position
452 SGVec3d _relative_pos; // position relative to the base position
453 SGVec3d _direction; // orientation offset
454 SGVec3f _velocity; // Velocity of the source sound.
456 // The position and orientation of this sound
457 SGQuatd _orientation; // base orientation
458 SGVec3f _orivec; // orientation vector for OpenAL
459 SGVec3d _base_pos; // base position
463 std::string _refname; // name or file path
464 unsigned char* _data;
466 // configuration values
471 // Buffers hold sound data.
473 unsigned int _buffer;
475 // Sources are points emitting sound.
477 unsigned int _source;
479 // The orientation of this sound (direction and cut-off angles)
486 float _master_volume;
487 float _reference_dist;
493 bool _static_changed;
496 string random_string();
500 #endif // _SG_SAMPLE_HXX