SoundStream.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
//
// 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/Export.hpp>
#include <SFML/Audio/SoundSource.hpp>
#include <SFML/System/Thread.hpp>
#include <SFML/System/Time.hpp>
#include <SFML/System/Mutex.hpp>
#include <cstdlib>


namespace sf
{
class SFML_AUDIO_API SoundStream : public SoundSource
{
public:

    struct Chunk
    {
        const Int16* samples;     
        std::size_t  sampleCount; 
    };

    virtual ~SoundStream();

    void play();

    void pause();

    void stop();

    unsigned int getChannelCount() const;

    unsigned int getSampleRate() const;

    Status getStatus() const;

    void setPlayingOffset(Time timeOffset);

    Time getPlayingOffset() const;

    void setLoop(bool loop);

    bool getLoop() const;

protected:

    enum
    {
        NoLoop = -1 
    };

    SoundStream();

    void initialize(unsigned int channelCount, unsigned int sampleRate);

    virtual bool onGetData(Chunk& data) = 0;

    virtual void onSeek(Time timeOffset) = 0;

    virtual Int64 onLoop();

private:

    void streamData();

    bool fillAndPushBuffer(unsigned int bufferNum, bool immediateLoop = false);

    bool fillQueue();

    void clearQueue();

    enum
    {
        BufferCount = 3,    
        BufferRetries = 2   
    };

    // Member data
    Thread        m_thread;                   
    mutable Mutex m_threadMutex;              
    Status        m_threadStartState;         
    bool          m_isStreaming;              
    unsigned int  m_buffers[BufferCount];     
    unsigned int  m_channelCount;             
    unsigned int  m_sampleRate;               
    Uint32        m_format;                   
    bool          m_loop;                     
    Uint64        m_samplesProcessed;         
    Int64         m_bufferSeeks[BufferCount]; 
};

} // namespace sf


#endif // SFML_SOUNDSTREAM_HPP