Sound.h

Go to the documentation of this file.

//
// C++ Interface: Audio::Sound
//
#ifndef __AUDIO_SOUND_H__INCLUDED__
#define __AUDIO_SOUND_H__INCLUDED__

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

namespace Audio {

    // Forward declaration of Streams
    class Stream;

    class Sound
    {
    private:
        std::string name;
        Format format;
    
    protected:
        struct Flags {
            int loaded : 1;
            
            int loading : 1; 
            
            int streaming : 1;
        } flags;
        
    protected:
        Sound(const std::string& name, bool streaming) throw();
        
        Format& getFormat() throw() { return format; };
        
        
    public:
        virtual ~Sound();
        
        const std::string& getName() const throw() { return name; };
        
        const Format& getFormat() const throw() { return format; };
        
        bool isLoaded() const throw() { return flags.loaded; }
        
        bool isLoading() const throw() { return flags.loading; }
        
        bool isStreaming() const throw() { return flags.streaming; }
        
        void load(bool wait = true) throw(Exception);
        
        void unload() throw();
        
        // The following section contains all the virtual functions that need be implemented
        // by a concrete Sound class. All are protected, so the stream interface is independent
        // of implementations.
    protected:
    
        virtual void onLoaded(bool success) throw();
        
        virtual void waitLoad() throw(Exception);
        
        virtual void loadImpl(bool wait) throw(Exception) = 0;
        
        virtual void abortLoad() throw() = 0;
        
        
        virtual void unloadImpl() throw() = 0;
        
    };

};

#endif//__AUDIO_SOUND_H__INCLUDED__