simgear/sound/sample_openal.hxx

   1 // sample.hxx -- Sound sample encapsulation class
   2 //
   3 // Written by Curtis Olson, started April 2004.
   4 //
   5 // Copyright (C) 2004  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23 /**
  24  * \file sample.hxx
  25  * Provides a sound sample encapsulation
  26  */
  27
  28 #ifndef _SG_SAMPLE_HXX
  29 #define _SG_SAMPLE_HXX 1
  30
  31 #ifndef __cplusplus
  32 # error This library requires C++
  33 #endif
  34
  35 #include <simgear/compiler.h>
  36
  37 #include STL_STRING
  38
  39 #include <simgear/debug/logstream.hxx>
  40
  41 #include <plib/sg.h>
  42
  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>
  48 #else
  49 # include <AL/al.h>
  50 # include <AL/alut.h>
  51 #endif
  52
  53 SG_USING_STD(string);
  54
  55 /**
  56  * manages everything we need to know for an individual sound sample
  57  */
  58
  59 class SGSoundSample {
  60
  61 private:
  62
  63     string sample_name;
  64
  65     // Buffers hold sound data.
  66     ALuint buffer;
  67
  68     // Sources are points emitting sound.
  69     ALuint source;
  70
  71     // Position of the source sound.
  72     ALfloat source_pos[3];
  73
  74     // A constant offset to be applied to the final source_pos
  75     ALfloat offset_pos[3];
  76
  77     // The orientation of the sound (direction and cut-off angles)
  78     ALfloat direction[3];
  79     ALfloat inner, outer, outergain;
  80
  81     // Velocity of the source sound.
  82     ALfloat source_vel[3];
  83
  84     // configuration values
  85     ALenum format;
  86     ALsizei size;
  87     ALvoid* data;
  88     ALsizei freq;
  89
  90     double pitch;
  91     double volume;
  92     double reference_dist;
  93     double max_dist;
  94     ALboolean loop;
  95
  96     bool playing;
  97     bool bind_source();
  98
  99 public:
 100
 101     /**
 102      * Constructor
 103      * @param path Path name to sound
 104      * @param file File name of sound
 105      * @param cleanup Request clean up the intermediate data (this
 106        should usually be true unless you want to manipulate the data
 107        later.)
 108      */
 109     SGSoundSample( const char *path, const char *file, bool cleanup );
 110
 111     /**
 112      * Constructor.
 113      * @param _data Pointer to a memory buffer containing the sample data
 114      * @param len Byte length of array
 115      * @param _freq Frequency of the provided data (bytes per second)
 116      * @param cleanup Request clean up the intermediate data (this
 117        should usually be true unless you want to manipulate the data
 118        later.)
 119      */
 120     SGSoundSample( unsigned char *_data, int len, int _freq, bool cleanup );
 121
 122     ~SGSoundSample();
 123
 124     /**
 125      * Start playing this sample.
 126      *
 127      * @param _loop Define wether the sound should be played in a loop.
 128      */
 129     void play( bool _loop );
 130
 131     /**
 132      * Stop playing this sample.
 133      *
 134      * @param sched A pointer to the appropriate scheduler.
 135      */
 136     void stop();
 137
 138     /**
 139      * Play this sample once.
 140      * @see #play
 141      */
 142     inline void play_once() { play(false); }
 143
 144     /**
 145      * Play this sample looped.
 146      * @see #play
 147      */
 148     inline void play_looped() { play(true); }
 149
 150     /**
 151      * Test if a sample is curretnly playing.
 152      * @return true if is is playing, false otherwise.
 153      */
 154     bool is_playing( );
 155
 156     /**
 157      * Get the current pitch setting of this sample.
 158      */
 159     inline double get_pitch() const { return pitch; }
 160
 161     /**
 162      * Set the pitch of this sample.
 163      */
 164     void set_pitch( double p );
 165
 166     /**
 167      * Get the current volume setting of this sample.
 168      */
 169     inline double get_volume() const { return volume; }
 170
 171     /**
 172      * Set the volume of this sample.
 173      */
 174     void set_volume( double v );
 175
 176     /**
 177      * Returns the size of the sounds sample
 178      */
 179     inline int get_size() {
 180         return size;
 181     }
 182
 183     /**
 184      * Return a pointer to the raw data
 185      */
 186     inline char *get_data() {
 187         return (char *)data;
 188     }
 189
 190     /**
 191      * Set position of sound source (uses same coordinate system as opengl)
 192      */
 193     void set_source_pos( ALfloat *pos );
 194
 195     /**
 196      * Set "constant" offset position of sound source (uses same
 197      * coordinate system as opengl)
 198      */
 199     void set_offset_pos( ALfloat *pos );
 200
 201     /**
 202      * Set the orientation of the sound source, both for direction
 203      * and audio cut-off angles.
 204      */
 205     void set_orientation( ALfloat *dir, ALfloat inner_angle=360.0,
 206                                                ALfloat outer_angle=360.0,
 207                                                ALfloat outer_gain=0.0);
 208
 209     /**
 210      * Set velocity of sound source (uses same coordinate system as opengl)
 211      */
 212     void set_source_vel( ALfloat *vel );
 213
 214
 215     /**
 216      * Set reference distance of sound (the distance where the gain
 217      * will be half.)
 218      */
 219     void set_reference_dist( ALfloat dist );
 220
 221
 222     /**
 223      * Set maximume distance of sound (the distance where the sound is
 224      * no longer audible.
 225      */
 226     void set_max_dist( ALfloat dist );
 227 };
 228
 229
 230 #endif // _SG_SAMPLE_HXX
 231
 232