Oops, ALUT 1.0 requires a little more work than expected.

[simgear.git] / simgear / sound / sample_openal.hxx

diff --git a/simgear/sound/sample_openal.hxx b/simgear/sound/sample_openal.hxx
index edc61ec8c9efe8cbac44be61a808700c467dfa81..68b7af7aeff01e0951bff9502dc33dfb9dc0243e 100644 (file)
--- a/simgear/sound/sample_openal.hxx
+++ b/simgear/sound/sample_openal.hxx
@@ -2,7 +2,7 @@
 // 
 // Written by Curtis Olson, started April 2004.
 //
-// Copyright (C) 2004  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 2004  Curtis L. Olson - http://www.flightgear.org/~curt
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -36,6 +36,10 @@
 
 #include STL_STRING
 
+#include <simgear/debug/logstream.hxx>
+
+#include <plib/sg.h>
+
 #if defined(__APPLE__)
 # define AL_ILLEGAL_ENUM AL_INVALID_ENUM
 # define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
@@ -46,11 +50,8 @@
 # include <AL/alut.h>
 #endif
 
-#include <simgear/debug/logstream.hxx>
-
 SG_USING_STD(string);
 
-
 /**
  * manages everything we need to know for an individual sound sample
  */
@@ -70,6 +71,13 @@ private:
     // Position of the source sound.
     ALfloat source_pos[3];
 
+    // A constant offset to be applied to the final source_pos
+    ALfloat offset_pos[3];
+
+    // The orientation of the sound (direction and cut-off angles)
+    ALfloat direction[3];
+    ALfloat inner, outer, outergain;
+
     // Velocity of the source sound.
     ALfloat source_vel[3];
 
@@ -81,8 +89,13 @@ private:
 
     double pitch;
     double volume;
+    double reference_dist;
+    double max_dist;
     ALboolean loop;
 
+    bool playing;
+    bool bind_source();
+
 public:
 
     /**
@@ -94,7 +107,18 @@ public:
        later.)
      */
     SGSoundSample( const char *path, const char *file, bool cleanup );
-    SGSoundSample( unsigned char *_data, int len, int _freq );
+
+    /**
+     * Constructor.
+     * @param _data Pointer to a memory buffer containing the sample data
+     * @param len Byte length of array
+     * @param _freq Frequency of the provided data (bytes per second)
+     * @param cleanup Request clean up the intermediate data (this
+       should usually be true unless you want to manipulate the data
+       later.)
+     */
+    SGSoundSample( unsigned char *_data, int len, int _freq, bool cleanup );
+
     ~SGSoundSample();
 
     /**
@@ -127,15 +151,7 @@ public:
      * Test if a sample is curretnly playing.
      * @return true if is is playing, false otherwise.
      */
-    inline bool is_playing( ) {
-        ALint result;
-        alGetSourcei( source, AL_SOURCE_STATE, &result );
-        if ( alGetError() != AL_NO_ERROR) {
-            SG_LOG( SG_GENERAL, SG_ALERT,
-                    "Oops AL error in sample is_playing(): " << sample_name );
-        }
-        return (result == AL_PLAYING) ;
-    }
+    bool is_playing( );
 
     /**
      * Get the current pitch setting of this sample.
@@ -145,18 +161,7 @@ public:
     /**
      * Set the pitch of this sample.
      */
-    inline void set_pitch( double p ) {
-        // clamp in the range of 0.01 to 2.0
-        if ( p < 0.01 ) { p = 0.01; }
-        if ( p > 2.0 ) { p = 2.0; }
-        pitch = p;
-        alSourcef( source, AL_PITCH, pitch );
-        if ( alGetError() != AL_NO_ERROR) {
-            SG_LOG( SG_GENERAL, SG_ALERT,
-                    "Oops AL error in sample set_pitch()! " << p
-                    << " for " << sample_name );
-        }
-    }
+    void set_pitch( double p );
 
     /**
      * Get the current volume setting of this sample.
@@ -166,15 +171,7 @@ public:
     /**
      * Set the volume of this sample.
      */
-    inline void set_volume( double v ) {
-        volume = v;
-        alSourcef( source, AL_GAIN, volume );
-        if ( alGetError() != AL_NO_ERROR) {
-            SG_LOG( SG_GENERAL, SG_ALERT,
-                    "Oops AL error in sample set_volume()! " << v
-                    << " for " << sample_name  );
-        }
-    }
+    void set_volume( double v );
 
     /**
      * Returns the size of the sounds sample
@@ -189,6 +186,44 @@ public:
     inline char *get_data() {
         return (char *)data;
     }
+
+    /**
+     * Set position of sound source (uses same coordinate system as opengl)
+     */
+    void set_source_pos( ALfloat *pos );
+
+    /**
+     * Set "constant" offset position of sound source (uses same
+     * coordinate system as opengl)
+     */
+    void set_offset_pos( ALfloat *pos );
+
+    /**
+     * Set the orientation of the sound source, both for direction
+     * and audio cut-off angles.
+     */
+    void set_orientation( ALfloat *dir, ALfloat inner_angle=360.0,
+                                               ALfloat outer_angle=360.0,
+                                               ALfloat outer_gain=0.0);
+
+    /**
+     * Set velocity of sound source (uses same coordinate system as opengl)
+     */
+    void set_source_vel( ALfloat *vel );
+
+
+    /**
+     * Set reference distance of sound (the distance where the gain
+     * will be half.)
+     */
+    void set_reference_dist( ALfloat dist );
+
+
+    /**
+     * Set maximume distance of sound (the distance where the sound is
+     * no longer audible.
+     */
+    void set_max_dist( ALfloat dist );
 };