Audio::SimpleSound Class Reference

#include <SimpleSound.h>

Inheritance diagram for Audio::SimpleSound:

Public Member Functions
virtual	~SimpleSound ()
VSFileSystem::VSFileType	getType () const
Public Member Functions inherited from Audio::Sound
virtual	~Sound ()
const std::string &	getName () const throw ()
const Format &	getFormat () const throw ()
bool	isLoaded () const throw ()
bool	isLoading () const throw ()
bool	isStreaming () const throw ()
void	load (bool wait=true) throw (Exception)
void	unload () throw ()

Protected Member Functions
	SimpleSound (const std::string &name, VSFileSystem::VSFileType type=VSFileSystem::UnknownFile, bool streaming=false) throw ()
bool	isStreamLoaded () const
void	loadStream () throw (Exception)
void	closeStream () throw (ResourceNotLoadedException)
SharedPtr< Stream >	getStream () const throw (ResourceNotLoadedException)
void	readBuffer (SoundBuffer &buffer) throw (Exception)
virtual void	abortLoad () throw ()
Protected Member Functions inherited from Audio::Sound
	Sound (const std::string &name, bool streaming) throw ()
Format &	getFormat () throw ()
virtual void	onLoaded (bool success) throw ()
virtual void	waitLoad () throw (Exception)
virtual void	loadImpl (bool wait)=0 throw (Exception)
virtual void	unloadImpl ()=0 throw ()

Additional Inherited Members
Protected Attributes inherited from Audio::Sound
struct Audio::Sound::Flags	flags

Detailed Description

Simple Sound abstract class

Remarks

This partial implementation implements foreground loading of files using the codec registry.

No background loading is implemented, meaning all requests for load,

even with wait=false, are processed in the foreground.

There's a possibility for streaming given the packetized pulling

architecture. Renderers are not required to pull all packets from the stream, and access to the Stream object is also provided for seeking back and forth.

Renderers still have to override (un)loadImpl() and abortLoad().

This refinement merely adds supporting methods for implementing them.

See Also

Sound, BackgroundLoadingSound

Definition at line 35 of file SimpleSound.h.

Constructor & Destructor Documentation

Audio::SimpleSound::SimpleSound ( const std::string &  name, VSFileSystem::VSFileType  type = VSFileSystem::UnknownFile, bool  streaming = false  ) throw ( )

protected

Internal constructor used by derived classes

Definition at line 13 of file SimpleSound.cpp.

        : Sound(name, streaming),
          type(_type)
    {
    }

Audio::SimpleSound::~SimpleSound ( )

virtual

Definition at line 20 of file SimpleSound.cpp.

    {
    }

Member Function Documentation

void Audio::SimpleSound::abortLoad ( ) throw ( )

protectedvirtual

Abort an in-progress background load procedure

Note

Although no exceptions should be risen, the abort request may not be carried out for various reasons. The caller should check that on return by calling isLoaded() / isLoading().

Implements Audio::Sound.

Definition at line 83 of file SimpleSound.cpp.

    {
        // Intentionally blank
    }

void Audio::SimpleSound::closeStream ( ) throw ( ResourceNotLoadedException )

protected

Uninitialize the stream

Remarks

Calling this when isStreamLoaded() returns false will raise an ResourceNotLoadedException.

Definition at line 42 of file SimpleSound.cpp.

References isStreamLoaded().

    {
        if (!isStreamLoaded())
            throw(ResourceNotLoadedException());
        stream.reset();
    }

SharedPtr< Stream > Audio::SimpleSound::getStream ( ) const throw ( ResourceNotLoadedException )

protected

Get a pointer to the stream

Remarks

Calling this when isStreamLoaded() returns false will raise an ResourceNotLoadedException.

Definition at line 50 of file SimpleSound.cpp.

References isStreamLoaded().

Referenced by loadStream().

    {
        if (!isStreamLoaded())
            throw(ResourceNotLoadedException());
        return stream;
    }

VSFileSystem::VSFileType Audio::SimpleSound::getType ( ) const

inline

VSFileSystem File type

Definition at line 49 of file SimpleSound.h.

Referenced by loadStream().

{ return type; }

bool Audio::SimpleSound::isStreamLoaded ( ) const

inlineprotected

Do we have an open stream?

Definition at line 57 of file SimpleSound.h.

Referenced by closeStream(), getStream(), and loadStream().

{ return stream.get() != 0; }

void Audio::SimpleSound::loadStream ( ) throw ( Exception )

protected

Initialize the stream.

Remarks

Calling this when the stream has already been initialized will raise an ReasourceAlreadyLoadedException.

Definition at line 24 of file SimpleSound.cpp.

References Audio::Sound::getFormat(), Audio::Sound::getName(), Singleton< CodecRegistry >::getSingleton(), getStream(), getType(), and isStreamLoaded().

    {
        if (isStreamLoaded())
            throw(ResourceAlreadyLoadedException());
        
        // Open stream and initialize shared pointer
        stream.reset( 
            CodecRegistry::getSingleton()->open(
                getName(),
                getType()
            )
        );
        
        // Copy format
        getFormat() = getStream()->getFormat();
    }

void Audio::SimpleSound::readBuffer ( SoundBuffer &  buffer) throw ( Exception )

protected

Read from the stream into the buffer

Remarks

Will throw EndOfStreamException when the end of the stream is reached. Any other exception is probably fatal.

Definition at line 58 of file SimpleSound.cpp.

References buffer.

    {
        if (buffer.getFormat() == getFormat()) {
            // Same formats, so all we have to do is read bytes ;)
            buffer.setUsedBytes(
                getStream()->read( buffer.getBuffer(), buffer.getByteCapacity() )
            );
        } else {
            // Save the buffer format, we'll have to reformat to this format
            Format targetFormat = buffer.getFormat();
            
            // Set buffer format to stream format
            buffer.setFormat(getFormat());
            
            // Now read bytes from the stream
            buffer.setUsedBytes(
                getStream()->read( buffer.getBuffer(), buffer.getByteCapacity() )
            );
            
            // Finally we have to reformat the buffer back to the original format
            buffer.reformat(targetFormat);
        }
    }

---

The documentation for this class was generated from the following files:

• src/audio/SimpleSound.h
• src/audio/SimpleSound.cpp