Split up FGFX into a dedicated effects class (FGFX) and a sample queue class. Registe...

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

diff --git a/src/Sound/fg_fx.hxx b/src/Sound/fg_fx.hxx
index 61aee36ec7d4e3fd6c4ea85c6efff65289ea2691..62e111076ba3fb06671acc30e4ed12f4f42d900d 100644 (file)
--- a/src/Sound/fg_fx.hxx
+++ b/src/Sound/fg_fx.hxx
@@ -17,7 +17,7 @@
 //
 // 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$
 
@@ -26,65 +26,44 @@
 
 #include <simgear/compiler.h>
 
-#include <queue>
 #include <vector>
 
-#include <simgear/sound/sample_openal.hxx>
 #include <simgear/structure/subsystem_mgr.hxx>
-
-SG_USING_STD(queue);
-SG_USING_STD(vector);
+#include <simgear/sound/sample_group.hxx>
 
 class SGXmlSound;
 
 /**
  * Generator for FlightGear sound effects.
  *
- * This module uses FGSoundMgr to generate sound effects based
- * on current flight conditions.  The sound manager must be initialized
+ * This module uses a FGSampleGroup class 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
+ *    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
+class FGFX : public SGSampleGroup
 {
 
 public:
 
-    FGFX ();
+    FGFX ( SGSoundMgr *smgr, const string &refname );
     virtual ~FGFX ();
 
     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 );
-
 private:
 
-    vector<SGXmlSound *> _sound;
-    queue<SGSoundSample *> _samplequeue;
+    std::vector<SGXmlSound *> _sound;
 
     bool last_pause;
     double last_volume;
 
-    SGPropertyNode *_pause;
-    SGPropertyNode *_volume;
-
+    SGPropertyNode_ptr _pause;
+    SGPropertyNode_ptr _volume;
 };