Libs/SoundSystem/SoundSysFMOD3/StreamingBuffer.hpp

   1 /*
   2 Cafu Engine, http://www.cafu.de/
   3 Copyright (c) Carsten Fuchs and other contributors.
   4 This project is licensed under the terms of the MIT license.
   5 */
   6
   7 #ifndef CAFU_SOUNDSYS_STREAMING_BUFFER_HPP_INCLUDED
   8 #define CAFU_SOUNDSYS_STREAMING_BUFFER_HPP_INCLUDED
   9
  10 #include "Buffer.hpp"
  11
  12
  13 struct FSOUND_STREAM;
  14
  15
  16 /// A streaming buffer created from an audio file.
  17 /// Streaming buffers stream the audio data from a file instead of loading
  18 /// it completely into memory.
  19 /// This class is basically just a wrapper around the FMOD3 sound stream object.
  20 class StreamingBufferT : public BufferT
  21 {
  22     public:
  23
  24     /// Constructor.
  25     /// Creates a streaming buffer from an audio file.
  26     /// @param AudioFile Path to the audio file from which the buffer should be created.
  27     /// @param Is3DSound Whether the buffer is used as a 3D sound object.
  28     StreamingBufferT(const std::string& AudioFile, bool Is3DSound);
  29
  30     /// Destructor.
  31     ~StreamingBufferT();
  32
  33     // BufferT implementation.
  34     int  AttachToChannel(unsigned int Priority);
  35     void Rewind();
  36
  37
  38     private:
  39
  40     FSOUND_STREAM* m_Stream; ///< The FMOD3 sound stream used with this static buffer.
  41
  42     // Don't allow use of copy and assignment constructor.
  43     StreamingBufferT(StreamingBufferT&);
  44     StreamingBufferT& operator=(const StreamingBufferT&);
  45 };
  46
  47 #endif