Engine directory for ticket #1

Engine/source/sfx/sfxMemoryStream.h

@@ -0,0 +1,84 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifndef _SFXMEMORYSTREAM_H_
+#define _SFXMEMORYSTREAM_H_
+
+#ifndef _SFXSTREAM_H_
+   #include "sfx/sfxStream.h"
+#endif
+#ifndef _TSTREAM_H_
+   #include "core/stream/tStream.h"
+#endif
+#ifndef _RAWDATA_H_
+   #include "core/util/rawData.h"
+#endif
+
+
+/// A stream filter that converts sample packets from its source stream
+/// to a continuous sample stream.  Useful for feeding sound from a source
+/// that pushes sample data in discrete packets.
+///
+/// @note For the SFXMemoryStream to allow a reset(), the source input
+///   stream must implement IResettable.
+class SFXMemoryStream : public SFXStream,
+                        public IInputStreamFilter< U8, IInputStream< RawData* >* >
+{
+   public:
+   
+      typedef SFXStream Parent;
+      
+   protected:
+   
+      ///
+      SFXFormat mFormat;
+   
+      /// Total number of samples in the stream.  If this is U32_MAX, the stream
+      /// is considered to be of indefinite size.
+      U32 mNumSamplesTotal;
+      
+      /// Number of samples left to be read from stream.  Locked to U32_MAX for
+      /// stream of indefinite size.
+      U32 mNumSamplesLeft;
+      
+      /// The current sample data packet.
+      RawData* mCurrentPacket;
+      
+      /// Read offset in the current sample data packet.
+      U32 mCurrentPacketOffset;
+         
+   public:
+   
+      ///
+      SFXMemoryStream( const SFXFormat& format, SourceStreamType* stream, U32 numSamples = U32_MAX );
+      
+      // SFXStream.
+      const SFXFormat& getFormat() const { return mFormat; }
+      U32 getSampleCount() const { return mNumSamplesTotal; }
+      U32 getDataLength() const { return ( mNumSamplesTotal == U32_MAX ? U32_MAX : mFormat.getDataLength( getDuration() ) ); }
+      U32 getDuration() const { return ( mNumSamplesTotal == U32_MAX ? U32_MAX : mFormat.getDuration( mNumSamplesTotal ) ); }
+      bool isEOS() const { return ( mNumSamplesLeft != 0 ); }
+      void reset();
+      U32 read( U8 *buffer, U32 length );      
+};
+
+#endif // !_SFXMEMORYSTREAM_H_