simgear/sound/sample_openal.hxx

   1 // sample_openal.hxx -- Audio sample encapsulation class
   2 //
   3 // Written by Curtis Olson, started April 2004.
   4 // Modified to match the new SoundSystem by Erik Hofman, October 2009
   5 //
   6 // Copyright (C) 2004  Curtis L. Olson - http://www.flightgear.org/~curt
   7 // Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
   8 //
   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.
  13 //
  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.
  18 //
  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.
  22 //
  23 // $Id$
  24
  25 /**
  26  * \file audio sample.hxx
  27  * Provides a audio sample encapsulation
  28  */
  29
  30 #ifndef _SG_SAMPLE_HXX
  31 #define _SG_SAMPLE_HXX 1
  32
  33 #ifndef __cplusplus
  34 # error This library requires C++
  35 #endif
  36
  37 #include <string>
  38 #include <cstdlib>
  39
  40 #include <simgear/compiler.h>
  41 #include <simgear/debug/logstream.hxx>
  42 #include <simgear/structure/SGReferenced.hxx>
  43 #include <simgear/structure/SGSharedPtr.hxx>
  44 #include <simgear/math/SGMath.hxx>
  45
  46 /**
  47  * manages everything we need to know for an individual audio sample
  48  */
  49
  50 class SGSoundSample : public SGReferenced {
  51 public:
  52
  53      /**
  54       * Empty constructor, can be used to read data to the systems
  55       * memory and not to the driver.
  56       */
  57     SGSoundSample();
  58
  59     /**
  60      * Constructor
  61      * @param path Path name to sound
  62      * @param file File name of sound
  63        Buffer data is freed by the sample group
  64      */
  65     SGSoundSample( const char *path, const char *file );
  66
  67     /**
  68      * Constructor.
  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
  76      */
  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 );
  80
  81     /**
  82      * Destructor
  83      */
  84     ~SGSoundSample ();
  85
  86     /**
  87      * Detect wheter 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.
  89      */
  90     inline bool is_file() const { return _is_file; }
  91
  92     /**
  93      * Test if this audio sample configuration has changed since the last call.
  94      * Calling this function will reset the flag so calling it a second
  95      * time in a row will return false.
  96      * @return Return true is the configuration has changed in the mean time.
  97      */
  98     bool has_changed() {
  99         bool b = _changed; _changed = false; return b;
 100     }
 101
 102     /**
 103      * Test if static dataa of audio sample configuration has changed.
 104      * Calling this function will reset the flag so calling it a second
 105      * time in a row will return false.
 106      * @return Return true is the static data has changed in the mean time.
 107      */
 108     bool has_static_data_changed() {
 109         bool b = _static_changed; _static_changed = false; return b;
 110     }
 111
 112     /**
 113      * Schedule this audio sample for playing. Actual playing will only start
 114      * at the next call op SoundGroup::update()
 115      * @param _loop Define whether this sound should be played in a loop.
 116      */
 117     void play( bool loop = false ) {
 118         _playing = true; _loop = loop; _changed = true;
 119     }
 120
 121     /**
 122      * Check if this audio sample is set to be continuous looping.
 123      * @return Return true if this audio sample is set to looping.
 124      */
 125     inline bool is_looping() { return _loop; }
 126
 127     /**
 128      * Schedule this audio sample to stop playing.
 129      */
 130     virtual void stop() {
 131         _playing = false; _changed = true;
 132     }
 133
 134     /**
 135      * Schedule this audio sample to play once.
 136      * @see #play
 137      */
 138     inline void play_once() { play(false); }
 139
 140     /**
 141      * Schedule this audio sample to play looped.
 142      * @see #play
 143      */
 144     inline void play_looped() { play(true); }
 145
 146     /**
 147      * Test if a audio sample is scheduled for playing.
 148      * @return true if this audio sample is playing, false otherwise.
 149      */
 150     inline bool is_playing() { return _playing; }
 151
 152     /**
 153      * Set the data associated with this audio sample
 154      * @param data Pointer to a memory block containg this audio sample data.
 155        This pointer will be set to NULL after calling this function.
 156      */
 157     inline void set_data( const unsigned char **data ) {
 158         _data = (unsigned char*)*data; *data = NULL;
 159     }
 160     inline void set_data( const void **data ) {
 161         _data = (unsigned char*)*data; *data = NULL;
 162     }
 163
 164     /**
 165      * Return the data associated with this audio sample.
 166      * @return A pointer to this sound data of this audio sample.
 167      */
 168     inline void* get_data() const { return _data; }
 169
 170     /**
 171      * Free the data associated with this audio sample
 172      */
 173     void free_data() {
 174         if ( _data != NULL ) free( _data ); _data = NULL;
 175     }
 176
 177     /**
 178      * Set the source id of this source
 179      * @param sid OpenAL source-id
 180      */
 181     virtual inline void set_source(unsigned int sid) {
 182         _source = sid; _valid_source = true; _changed = true;
 183     }
 184
 185     /**
 186      * Get the OpenAL source id of this source
 187      * @return OpenAL source-id
 188      */
 189     virtual inline unsigned int get_source() { return _source; }
 190
 191     /**
 192      * Test if the source-id of this audio sample may be passed to OpenAL.
 193      * @return true if the source-id is valid
 194      */
 195     virtual inline bool is_valid_source() const { return _valid_source; }
 196
 197     /**
 198      * Set the source-id of this audio sample to invalid.
 199      */
 200     virtual inline void no_valid_source() { _valid_source = false; }
 201
 202     /**
 203      * Set the OpenAL buffer-id of this source
 204      * @param bid OpenAL buffer-id
 205      */
 206     inline void set_buffer(unsigned int bid) {
 207         _buffer = bid; _valid_buffer = true; _changed = true;
 208     }
 209
 210     /**
 211      * Get the OpenAL buffer-id of this source
 212      * @return OpenAL buffer-id
 213      */
 214     inline unsigned int get_buffer() { return _buffer; }
 215
 216     /**
 217      * Test if the buffer-id of this audio sample may be passed to OpenAL.
 218      * @return true if the buffer-id is valid
 219      */
 220     inline bool is_valid_buffer() const { return _valid_buffer; }
 221
 222     /**
 223      * Set the buffer-id of this audio sample to invalid.
 224      */
 225     inline void no_valid_buffer() { _valid_buffer = false; }
 226
 227     /**
 228      * Set the playback pitch of this audio sample.
 229      * Should be between 0.0 and 2.0 for maximum compatibility.
 230      * @param p Pitch
 231      */
 232     inline void set_pitch( float p ) {
 233         if (p > 2.0) p = 2.0; else if (p < 0.01) p = 0.01;
 234         _pitch = p; _changed = true;
 235     }
 236
 237     /**
 238      * Get the current pitch value of this audio sample.
 239      * @return Pitch
 240      */
 241     inline float get_pitch() { return _pitch; }
 242
 243     /**
 244      * Set the master volume of this sample. Should be between 0.0 and 1.0.
 245      * The final volume is calculated by multiplying the master and audio sample
 246      * volume.
 247      * @param v Volume
 248      */
 249     inline void set_master_volume( float v ) {
 250         if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
 251         _master_volume = v; _changed = true;
 252     }
 253
 254     /**
 255      * Set the volume of this audio sample. Should be between 0.0 and 1.0.
 256      * The final volume is calculated by multiplying the master and audio sample
 257      * volume.
 258      * @param v Volume
 259      */
 260     inline void set_volume( float v ) {
 261         if (v > 1.0) v = 1.0; else if (v < 0.0) v = 0.0;
 262         _volume = v; _changed = true;
 263     }
 264
 265     /**
 266      * Get the final volume value of this audio sample.
 267      * @return Volume
 268      */
 269     inline float get_volume() { return _volume * _master_volume; }
 270
 271     /**
 272      * Set the OpenAL format of this audio sample.
 273      * @param format OpenAL format-id
 274      */
 275     inline void set_format( int format ) { _format = format; }
 276
 277     /**
 278      * Returns the format of this audio sample.
 279      * @return OpenAL format-id
 280      */
 281     inline int get_format() { return _format; }
 282
 283     /**
 284      * Set the frequency (in Herz) of this audio sample.
 285      * @param freq Frequency
 286      */
 287     inline void set_frequency( int freq ) { _freq = freq; }
 288
 289     /**
 290      * Returns the frequency (in Herz) of this audio sample.
 291      * @return Frequency
 292      */
 293     inline int get_frequency() { return _freq; }
 294
 295     /**
 296      * Sets the size (in bytes) of this audio sample.
 297      * @param size Data size
 298      */
 299     inline void set_size( size_t size ) { _size = size; }
 300
 301     /**
 302      * Returns the size (in bytes) of this audio sample.
 303      * @return Data size
 304      */
 305     inline size_t get_size() const { return _size; }
 306
 307     /**
 308      * Set the position of this sound relative to the base position.
 309      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 310      * @param pos Relative position of this sound
 311      */
 312     inline void set_relative_position( const SGVec3f& pos ) {
 313         _relative_pos = toVec3d(pos); _changed = true;
 314     }
 315
 316     /**
 317      * Set the base position in Cartesian coordinates
 318      * @param pos position in Cartesian coordinates
 319      */
 320     inline void set_position( const SGVec3d& pos ) {
 321        _base_pos = pos; _changed = true;
 322     }
 323
 324     /**
 325      * Get the absolute position of this sound.
 326      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
 327      * @return Absolute position
 328      */
 329     SGVec3d& get_position() { return _absolute_pos; }
 330
 331     /**
 332      * Set the orientation of this sound.
 333      * @param ori Quaternation containing the orientation information
 334      */
 335     inline void set_orientation( const SGQuatd& ori ) {
 336         _orientation = ori; _changed = true;
 337     }
 338
 339     inline void set_rotation( const SGQuatd& ec2body ) {
 340         _rotation = ec2body; _changed = true;
 341     }
 342
 343     /**
 344      * Set direction of this sound relative to the orientation.
 345      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
 346      * @param dir Sound emission direction
 347      */
 348     inline void set_direction( const SGVec3f& dir ) {
 349         _direction = toVec3d(dir); _static_changed = true;
 350     }
 351
 352     /**
 353      * Define the audio cone parameters for directional audio.
 354      * Note: setting it to 2 degree will result in 1 degree to both sides.
 355      * @param inner Inner cone angle (0 - 360 degrees)
 356      * @param outer Outer cone angle (0 - 360 degrees)
 357      * @param gain Remaining gain at the edge of the outer cone (0.0 - 1.0)
 358      */
 359     void set_audio_cone( float inner, float outer, float gain ) {
 360         _inner_angle = inner; _outer_angle = outer; _outer_gain = gain;
 361         _static_changed = true;
 362     }
 363
 364     /**
 365      * Get the orientation vector of this sound.
 366      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
 367      * @return Orientaton vector
 368      */
 369     SGVec3f& get_orientation() { return _orivec; }
 370
 371     /**
 372      * Get the inner angle of the audio cone.
 373      * @return Inner angle in degrees
 374      */
 375     float get_innerangle() { return _inner_angle; }
 376
 377     /**
 378      * Get the outer angle of the audio cone.
 379      * @return Outer angle in degrees
 380      */
 381     float get_outerangle() { return _outer_angle; }
 382
 383     /**
 384      * Get the remaining gain at the edge of the outer cone.
 385      * @return Gain
 386      */
 387     float get_outergain() { return _outer_gain; }
 388
 389     /**
 390      * Set the velocity vector (in meters per second) of this sound.
 391      * This is in the local frame coordinate system; x=north, y=east, z=down
 392      * @param Velocity vector
 393      */
 394     inline void set_velocity( const SGVec3f& vel ) {
 395         _velocity = vel; _changed = true;
 396     }
 397
 398     /**
 399      * Get velocity vector (in meters per second) of this sound.
 400      * This is in the same coordinate system as OpenGL; y=up, z=back, x=right
 401      * @return Velocity vector
 402      */
 403     SGVec3f& get_velocity() { return _velocity; }
 404
 405
 406     /**
 407      * Set reference distance (in meters) of this sound.
 408      * This is the distance where the gain will be half.
 409      * @param dist Reference distance
 410      */
 411     inline void set_reference_dist( float dist ) {
 412         _reference_dist = dist; _static_changed = true;
 413     }
 414
 415     /**
 416      * Get reference distance ((in meters) of this sound.
 417      * This is the distance where the gain will be half.
 418      * @return Reference distance
 419      */
 420     inline float get_reference_dist() { return _reference_dist; }
 421
 422
 423     /**
 424      * Set maximum distance (in meters) of this sound.
 425      * This is the distance where this sound is no longer audible.
 426      * @param dist Maximum distance
 427      */
 428     inline void set_max_dist( float dist ) {
 429         _max_dist = dist; _static_changed = true;
 430     }
 431
 432     /**
 433      * Get maximum distance (in meters) of this sound.
 434      * This is the distance where this sound is no longer audible.
 435      * @return dist Maximum distance
 436      */
 437     inline float get_max_dist() { return _max_dist; }
 438
 439     /**
 440      * Get the reference name of this audio sample.
 441      * @return Sample name
 442      */
 443     inline std::string get_sample_name() const { return _refname; }
 444
 445     inline virtual bool is_queue() const { return false; }
 446
 447     void update_pos_and_orientation();
 448
 449 private:
 450
 451     // Position of the source sound.
 452     SGVec3d _absolute_pos;      // absolute position
 453     SGVec3d _relative_pos;      // position relative to the base position
 454     SGVec3d _direction;         // orientation offset
 455     SGVec3f _velocity;          // Velocity of the source sound.
 456
 457     // The position and orientation of this sound
 458     SGQuatd _orientation;       // base orientation
 459     SGVec3f _orivec;            // orientation vector for OpenAL
 460     SGVec3d _base_pos;          // base position
 461
 462     SGQuatd _rotation;
 463
 464     std::string _refname;       // name or file path
 465     unsigned char* _data;
 466
 467     // configuration values
 468     int _format;
 469     size_t _size;
 470     int _freq;
 471
 472     // Buffers hold sound data.
 473     bool _valid_buffer;
 474     unsigned int _buffer;
 475
 476     // Sources are points emitting sound.
 477     bool _valid_source;
 478     unsigned int _source;
 479
 480     // The orientation of this sound (direction and cut-off angles)
 481     float _inner_angle;
 482     float _outer_angle;
 483     float _outer_gain;
 484
 485     float _pitch;
 486     float _volume;
 487     float _master_volume;
 488     float _reference_dist;
 489     float _max_dist;
 490     bool _loop;
 491
 492     bool _playing;
 493     bool _changed;
 494     bool _static_changed;
 495     bool _is_file;
 496
 497     string random_string();
 498 };
 499
 500
 501 #endif // _SG_SAMPLE_HXX
 502
 503