SimpleSound.h

Go to the documentation of this file.

//
// C++ Interface: Audio::SimpleSound
//
#ifndef __AUDIO_SIMPLESOUND_H__INCLUDED__
#define __AUDIO_SIMPLESOUND_H__INCLUDED__

#include "Exceptions.h"
#include "Types.h"
#include "Format.h"
#include "Sound.h"
#include "SoundBuffer.h"

#include "vsfilesystem.h"

namespace Audio {

    // Forward definitions
    class Stream;

    class SimpleSound : public Sound
    {
    private:
        SharedPtr<Stream> stream;
        VSFileSystem::VSFileType type;
        
    protected:
        SimpleSound(const std::string& name, VSFileSystem::VSFileType type = VSFileSystem::UnknownFile, bool streaming = false) throw();
        
    public:
        virtual ~SimpleSound();
        
        VSFileSystem::VSFileType getType() const { return type; }
        
        // 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:
        
        bool isStreamLoaded() const { return stream.get() != 0; }
        
        void loadStream() throw(Exception);
        
        void closeStream() throw(ResourceNotLoadedException);
        
        SharedPtr<Stream> getStream() const throw(ResourceNotLoadedException);
        
        void readBuffer(SoundBuffer &buffer) throw(Exception);
        
        // The following section contains basic Sound interface implementation 
        // functions provided by SimpleSound.
    protected:
        virtual void abortLoad() throw();

    };

};

#endif//__AUDIO_SIMPLESOUND_H__INCLUDED__