SoundStream.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_SOUNDSTREAM_HPP
#define SFML_SOUNDSTREAM_HPP

// Headers
#include <SFML/Audio/Sound.hpp>
#include <SFML/System/Thread.hpp>
#include <cstdlib>
 
 
namespace sf
{
class SFML_API SoundStream : private Thread, private Sound
{
public :
 
    using Sound::Status;
    using Sound::Stopped;
    using Sound::Paused;
    using Sound::Playing;
    using Sound::Pause;
    using Sound::SetPitch;
    using Sound::SetVolume;
    using Sound::SetPosition;
    using Sound::SetRelativeToListener;
    using Sound::SetMinDistance;
    using Sound::SetAttenuation;
    using Sound::GetPitch;
    using Sound::GetVolume;
    using Sound::GetPosition;
    using Sound::IsRelativeToListener;
    using Sound::GetMinDistance;
    using Sound::GetAttenuation;

    struct Chunk
    {
        const Int16* Samples;   
        std::size_t  NbSamples; 
    };

    virtual ~SoundStream();

    void Play();

    void Stop();

    unsigned int GetChannelsCount() const;

    unsigned int GetSampleRate() const;

    Status GetStatus() const;

    float GetPlayingOffset() const;

    void SetLoop(bool Loop);

    bool GetLoop() const;
 
protected :

    SoundStream();

    void Initialize(unsigned int ChannelsCount, unsigned int SampleRate);
 
private :

    virtual void Run();

    virtual bool OnStart();

    virtual bool OnGetData(Chunk& Data) = 0;

    bool FillAndPushBuffer(unsigned int BufferNum);

    bool FillQueue();

    void ClearQueue();
 
    enum {BuffersCount = 3};

    // Member data
    bool          myIsStreaming;              
    unsigned int  myBuffers[BuffersCount];    
    unsigned int  myChannelsCount;            
    unsigned int  mySampleRate;               
    unsigned long myFormat;                   
    bool          myLoop;                     
    unsigned int  mySamplesProcessed;         
    bool          myEndBuffers[BuffersCount]; 
};
 
} // namespace sf
 
 
#endif // SFML_SOUNDSTREAM_HPP