OpenALStreamingSound.h

Go to the documentation of this file.

//
// C++ Interface: Audio::OpenALSimpleSound
//
#ifndef __AUDIO_OPENALSTREAMINGSOUND_H__INCLUDED__
#define __AUDIO_OPENALSTREAMINGSOUND_H__INCLUDED__

#include "../../Exceptions.h"
#include "../../Types.h"
#include "../../Format.h"
#include "../../SimpleSound.h"
#include "../../SoundBuffer.h"

#include "al.h"

namespace Audio {
    
    class OpenALRenderableSource;

    class OpenALStreamingSound : public SimpleSound
    {
        ALBufferHandle bufferHandles[2];
        Timestamp bufferStarts[2];
        
        SoundBuffer buffer;
        
        Format targetFormat;
        
        size_t bufferSamples;
        
        unsigned char readBufferIndex;
        unsigned char playBufferIndex;
        
    public:
        OpenALStreamingSound(const std::string& name, VSFileSystem::VSFileType type = VSFileSystem::UnknownFile,
            unsigned int bufferSamples = 0) throw();
        
    public:
        virtual ~OpenALStreamingSound();
        
        // The following section contains supporting methods for accessing the stream.
        // Subclasses need not bother with actual stream management, they need only worry
        // about sending the samples to where they're needed.
    protected:
        virtual void loadImpl(bool wait) throw(Exception);
        
        virtual void unloadImpl() throw();
        
        // The following section contains package-private methods.
        // Only OpenAL renderer classes should access them, NOT YOU
    public:
        ALBufferHandle readAndFlip() throw(Exception);
        
        void unqueueBuffer(ALBufferHandle buffer) throw(Exception);
        
        void flushBuffers() throw();
        
        Timestamp getTimeBase() const throw();
        
        void seek(double position) throw(Exception);
    };

};

#endif//__AUDIO_OPENALSTREAMINGSOUND_H__INCLUDED__