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++
40 #include <simgear/compiler.h>
41 #include <simgear/debug/logstream.hxx>
42 #include <simgear/structure/SGReferenced.hxx>
43 #include <simgear/structure/SGSharedPtr.hxx>
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 file File name of sound
63 Buffer data is freed by the sample group
65 SGSoundSample(const char *file, const SGPath& currentDir);
69 * @param data Pointer to a memory buffer containing this audio sample data
70 The application may free the data by calling free_data(), otherwise it
71 will be resident untill the class is destroyed. This pointer will be
72 set to NULL after calling this function.
73 * @param len Byte length of array
74 * @param freq Frequency of the provided data (bytes per second)
75 * @param format OpenAL format id of the data
77 SGSoundSample( void** data, int len, int freq, int format=AL_FORMAT_MONO8 );
78 SGSoundSample( const unsigned char** data, int len, int freq,
79 int format = AL_FORMAT_MONO8 );
84 virtual ~SGSoundSample ();
87 * Detect whether this audio sample holds the information of a sound file.
88 * @return Return true if this audio sample is to be constructed from a file.
90 inline bool is_file() const { return _is_file; }
92 SGPath file_path() const;
95 * Test if this audio sample configuration has changed since the last call.
96 * Calling this function will reset the flag so calling it a second
97 * time in a row will return false.
98 * @return Return true is the configuration has changed in the mean time.
101 bool b = _changed; _changed = false; return b;
105 * Test if static data of audio sample configuration has changed.
106 * Calling this function will reset the flag so calling it a second
107 * time in a row will return false.
108 * @return Return true is the static data has changed in the mean time.
110 bool has_static_data_changed() {
111 bool b = _static_changed; _static_changed = false; return b;
115 * Schedule this audio sample for playing. Actual playing will only start
116 * at the next call op SoundGroup::update()
117 * @param _loop Define whether this sound should be played in a loop.
119 void play( bool loop = false ) {
120 _playing = true; _loop = loop; _changed = true; _static_changed = true;
124 * Check if this audio sample is set to be continuous looping.
125 * @return Return true if this audio sample is set to looping.
127 inline bool is_looping() { return _loop; }
130 * Schedule this audio sample to stop playing.
132 virtual void stop() {
133 _playing = false; _changed = true;
137 * Schedule this audio sample to play once.
140 inline void play_once() { play(false); }
143 * Schedule this audio sample to play looped.
146 inline void play_looped() { play(true); }
149 * Test if a audio sample is scheduled for playing.
150 * @return true if this audio sample is playing, false otherwise.
152 inline bool is_playing() { return _playing; }
156 * Set this sample to out-of-range (or not) and
157 * Schedule this audio sample to stop (or start) playing.
159 inline void set_out_of_range(bool oor = true) {
160 _out_of_range = oor; _playing = (!oor && _loop); _changed = true;
164 * Test if this sample to out-of-range or not.
166 inline bool test_out_of_range() {
167 return _out_of_range;
171 * Set the data associated with this audio sample
172 * @param data Pointer to a memory block containg this audio sample data.
173 This pointer will be set to NULL after calling this function.
175 inline void set_data( const unsigned char **data ) {
176 _data = (unsigned char*)*data; *data = NULL;
178 inline void set_data( const void **data ) {
179 _data = (unsigned char*)*data; *data = NULL;
183 * Return the data associated with this audio sample.
184 * @return A pointer to this sound data of this audio sample.
186 inline void* get_data() const { return _data; }
189 * Free the data associated with this audio sample
192 if ( _data != NULL ) free( _data ); _data = NULL;
196 * Set the source id of this source
197 * @param sid OpenAL source-id
199 virtual inline void set_source(unsigned int sid) {
200 _source = sid; _valid_source = true; _changed = true;
204 * Get the OpenAL source id of this source
205 * @return OpenAL source-id
207 virtual inline unsigned int get_source() { return _source; }
210 * Test if the source-id of this audio sample may be passed to OpenAL.
211 * @return true if the source-id is valid
213 virtual inline bool is_valid_source() const { return _valid_source; }
216 * Set the source-id of this audio sample to invalid.
218 virtual inline void no_valid_source() { _valid_source = false; }
221 * Set the OpenAL buffer-id of this source
222 * @param bid OpenAL buffer-id
224 inline void set_buffer(unsigned int bid) {
225 _buffer = bid; _valid_buffer = true; _changed = true;
229 * Get the OpenAL buffer-id of this source
230 * @return OpenAL buffer-id
232 inline unsigned int get_buffer() { return _buffer; }
235 * Test if the buffer-id of this audio sample may be passed to OpenAL.
236 * @return true if the buffer-id is valid
238 inline bool is_valid_buffer() const { return _valid_buffer; }
241 * Set the buffer-id of this audio sample to invalid.
243 inline void no_valid_buffer() { _valid_buffer = false; }
246 * Set the playback pitch of this audio sample.
247 * Should be between 0.0 and 2.0 for maximum compatibility.
250 inline void set_pitch( float p ) {
251 if (p > 2.0) p = 2.0; else if (p < 0.01) p = 0.01;
252 _pitch = p; _changed = true;
256 * Get the current pitch value of this audio sample.
259 inline float get_pitch() { return _pitch; }
262 * Set the master volume of this sample. Should be between 0.0 and 1.0.
263 * The final volume is calculated by multiplying the master and audio sample
267 inline void set_master_volume( float v ) {
268 if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
269 _master_volume = v; _changed = true;
273 * Set the volume of this audio sample. Should be between 0.0 and 1.0.
274 * The final volume is calculated by multiplying the master and audio sample
278 inline void set_volume( float v ) {
279 if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
280 _volume = v; _changed = true;
284 * Get the final volume value of this audio sample.
287 inline float get_volume() { return _volume * _master_volume; }
290 * Set the OpenAL format of this audio sample.
291 * @param format OpenAL format-id
293 inline void set_format( int format ) { _format = format; }
296 * Returns the format of this audio sample.
297 * @return OpenAL format-id
299 inline int get_format() { return _format; }
302 * Set the frequency (in Herz) of this audio sample.
303 * @param freq Frequency
305 inline void set_frequency( int freq ) { _freq = freq; }
308 * Returns the frequency (in Herz) of this audio sample.
311 inline int get_frequency() { return _freq; }
314 * Sets the size (in bytes) of this audio sample.
315 * @param size Data size
317 inline void set_size( size_t size ) { _size = size; }
320 * Returns the size (in bytes) of this audio sample.
323 inline size_t get_size() const { return _size; }
326 * Set the position of this sound relative to the base position.
327 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
328 * @param pos Relative position of this sound
330 inline void set_relative_position( const SGVec3f& pos ) {
331 _relative_pos = toVec3d(pos); _changed = true;
335 * Set the base position in Cartesian coordinates
336 * @param pos position in Cartesian coordinates
338 inline void set_position( const SGVec3d& pos ) {
339 _base_pos = pos; _changed = true;
343 * Get the absolute position of this sound.
344 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
345 * @return Absolute position
347 SGVec3d& get_position() { return _absolute_pos; }
350 * Set the orientation of this sound.
351 * @param ori Quaternation containing the orientation information
353 inline void set_orientation( const SGQuatd& ori ) {
354 _orientation = ori; _changed = true;
357 inline void set_rotation( const SGQuatd& ec2body ) {
358 _rotation = ec2body; _changed = true;
362 * Set direction of this sound relative to the orientation.
363 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
364 * @param dir Sound emission direction
366 inline void set_direction( const SGVec3f& dir ) {
367 _direction = toVec3d(dir); _static_changed = true;
371 * Define the audio cone parameters for directional audio.
372 * Note: setting it to 2 degree will result in 1 degree to both sides.
373 * @param inner Inner cone angle (0 - 360 degrees)
374 * @param outer Outer cone angle (0 - 360 degrees)
375 * @param gain Remaining gain at the edge of the outer cone (0.0 - 1.0)
377 void set_audio_cone( float inner, float outer, float gain ) {
378 _inner_angle = inner; _outer_angle = outer; _outer_gain = gain;
379 _static_changed = true;
383 * Get the orientation vector of this sound.
384 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
385 * @return Orientaton vector
387 SGVec3f& get_orientation() { return _orivec; }
390 * Get the inner angle of the audio cone.
391 * @return Inner angle in degrees
393 float get_innerangle() { return _inner_angle; }
396 * Get the outer angle of the audio cone.
397 * @return Outer angle in degrees
399 float get_outerangle() { return _outer_angle; }
402 * Get the remaining gain at the edge of the outer cone.
405 float get_outergain() { return _outer_gain; }
408 * Set the velocity vector (in meters per second) of this sound.
409 * This is in the local frame coordinate system; x=north, y=east, z=down
410 * @param Velocity vector
412 inline void set_velocity( const SGVec3f& vel ) {
413 _velocity = vel; _changed = true;
417 * Get velocity vector (in meters per second) of this sound.
418 * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
419 * @return Velocity vector
421 SGVec3f& get_velocity() { return _velocity; }
425 * Set reference distance (in meters) of this sound.
426 * This is the distance where the gain will be half.
427 * @param dist Reference distance
429 inline void set_reference_dist( float dist ) {
430 _reference_dist = dist; _static_changed = true;
434 * Get reference distance ((in meters) of this sound.
435 * This is the distance where the gain will be half.
436 * @return Reference distance
438 inline float get_reference_dist() { return _reference_dist; }
442 * Set maximum distance (in meters) of this sound.
443 * This is the distance where this sound is no longer audible.
444 * @param dist Maximum distance
446 inline void set_max_dist( float dist ) {
447 _max_dist = dist; _static_changed = true;
451 * Get maximum distance (in meters) of this sound.
452 * This is the distance where this sound is no longer audible.
453 * @return dist Maximum distance
455 inline float get_max_dist() { return _max_dist; }
458 * Get the reference name of this audio sample.
459 * @return Sample name
461 inline std::string get_sample_name() const { return _refname; }
463 inline virtual bool is_queue() const { return false; }
465 void update_pos_and_orientation();
469 // Position of the source sound.
470 SGVec3d _absolute_pos; // absolute position
471 SGVec3d _relative_pos; // position relative to the base position
472 SGVec3d _direction; // orientation offset
473 SGVec3f _velocity; // Velocity of the source sound.
475 // The position and orientation of this sound
476 SGQuatd _orientation; // base orientation
477 SGVec3f _orivec; // orientation vector for OpenAL
478 SGVec3d _base_pos; // base position
482 std::string _refname; // name or file path
483 unsigned char* _data;
485 // configuration values
490 // Buffers hold sound data.
492 unsigned int _buffer;
494 // Sources are points emitting sound.
496 unsigned int _source;
498 // The orientation of this sound (direction and cut-off angles)
505 float _master_volume;
506 float _reference_dist;
512 bool _static_changed;
516 std::string random_string();
520 #endif // _SG_SAMPLE_HXX