Added two missing files from JSBSim.org that were missing in the last sync.

[flightgear.git] / src / Sound / fg_fx.hxx

diff --git a/src/Sound/fg_fx.hxx b/src/Sound/fg_fx.hxx
index 2c80d1c04bf112e6174a5b81793d4d5ac5ec900e..864a898bb07219e5b7064dcb77ed6501de9171c0 100644 (file)
--- a/src/Sound/fg_fx.hxx
+++ b/src/Sound/fg_fx.hxx
@@ -17,15 +17,24 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #ifndef __FGFX_HXX
 #define __FGFX_HXX 1
 
+#include <simgear/compiler.h>
+
+#include <queue>
+#include <vector>
+
+#include <simgear/sound/sample_openal.hxx>
 #include <simgear/structure/subsystem_mgr.hxx>
 
+using std::queue;
+using std::vector;
+
 class SGXmlSound;
 
 /**
@@ -34,31 +43,51 @@ class SGXmlSound;
  * This module uses FGSoundMgr to generate sound effects based
  * on current flight conditions.  The sound manager must be initialized
  * before this object is.
+ *
+ * Note: this module supports two separate sound mechanisms concurrently.
+ *
+ * 1. This module will load and play a set of sound effects defined in an
+ *    xml file and tie them to various property states.
+ * 2. This modules also maintains a queue of 'message' audio files.  These
+ *    are played sequentially with no overlap until the queue is finished.
+ *    This second mechanims is useful for things like tutorial messages or
+ *    background atc chatter.
  */
 class FGFX : public SGSubsystem
 {
 
 public:
 
-  FGFX ();
-  virtual ~FGFX ();
+    FGFX ();
+    virtual ~FGFX ();
+
+    virtual void init ();
+    virtual void reinit ();
+    virtual void bind ();
+    virtual void unbind ();
+    virtual void update (double dt);
 
-  virtual void init ();
-  virtual void reinit ();
-  virtual void bind ();
-  virtual void unbind ();
-  virtual void update (double dt);
+    /**
+     * add a sound sample to the message queue which is played sequentially
+     * in order.
+     */
+    void play_message( SGSoundSample *_sample );
+    void play_message( const string path, const string fname, double volume );
 
 private:
 
-  vector<SGXmlSound *> _sound;
+    void update_pos_and_orientation(SGSoundMgr *smgr, double dt);
+    sgdVec3 last_visitor_pos;
+    sgdVec3 last_model_pos;
 
-  bool last_pause;
-  double last_volume;
+    vector<SGXmlSound *> _sound;
+    queue<SGSoundSample *> _samplequeue;
 
-  SGPropertyNode *_pause;
-  SGPropertyNode *_volume;
+    bool last_pause;
+    double last_volume;
 
+    SGPropertyNode_ptr _pause;
+    SGPropertyNode_ptr _volume;
 };