Split Sound into SoundDecoder and Waveform parts

[libs/al.git] / source / streamer.h

diff --git a/source/streamer.h b/source/streamer.h
index eddd49d7a067011b31561acbdd7abe6e904db892..192ede9d68ebc1a8d245b1a559a727c052b91f38 100644 (file)
--- a/source/streamer.h
+++ b/source/streamer.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspal
-Copyright © 2008 Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_AL_STREAMER_H_
 #define MSP_AL_STREAMER_H_
 
@@ -14,21 +7,26 @@ Distributed under the LGPL
 namespace Msp {
 namespace AL {
 
-class Sound;
+class SoundDecoder;
 class Buffer;
 
+/**
+A streamer transfers data from a SoundDecoder to a Source.  It is permanently
+attached to the same Source, but can read from multiple decoders during its
+lifetime.
+*/
 class Streamer
 {
 private:
        Source &src;
-       Sound  *snd;
+       SoundDecoder *decoder;
        std::list<Buffer *> buffers;
 
 public:
        Streamer(Source &);
        ~Streamer();
 
-       void play(Sound &);
+       void play(SoundDecoder &);
        void stop();
        void tick();
 };