Nsound::AudioPlayback Class Reference

#include <Nsound/AudioPlayback.h>

Public Member Functions
	AudioPlayback (const float64 &sample_rate=44100.0, const uint32 channels=1, const uint32 bits_per_sample=16)
	~AudioPlayback ()
uint32	getBitsPerSample ()
void	setBitsPerSample (uint32 bits_per_sample)
uint32	getChannels ()
void	setChannels (uint32 channels)
std::string	getError ()
	Returns an error string describing any backend error. More...
std::string	getInfo ()
	Returns information about the backend driver. More...
uint32	getSampleRate ()
void	setSampleRate (uint32 sample_rate)
AudioBackend::State	getState ()
	Returns the backend state. More...
std::string	getStateString ()
	Returns the backend state string. More...
std::string	getStateString (const AudioBackend::State &state)
	Returns the backend state string. More...
void	initialize ()
	Initializes the backend and transitions to the BACKEND_READY state on success. More...
void	play (const AudioStream &a)
	Plays the AudioStream throuh the backend. More...
void	play (const Buffer &b)
	Plays the Buffer through the backend. More...
void	scanDevices ()
	Scans for devices and tries to play a test sound. More...
void	setOption (const std::string &key, const std::string &value)
	Sets an options, must be called before initialize(). More...
void	shutdown ()
	Shuts down the backend. More...

Static Public Member Functions
static void	setBackendType (const AudioBackendType ab)
	Sets the AudioBackendType. More...
static AudioBackendType	getBackendType ()
	Gets the AudioBackendType that is currently set. More...

Private Member Functions
	AudioPlayback (const AudioPlayback &copy)
AudioPlayback &	operator= (const AudioPlayback &rhs)

Private Attributes
uint32	sample_rate_
uint32	channels_
uint32	bits_per_sample_
AudioBackend *	backend_

Static Private Attributes
static AudioBackendType	backend_type_ = BACKEND_TYPE_NONE

Friends
void	operator>> (const AudioStream &lhs, AudioPlayback &rhs)
void	operator>> (const Buffer &lhs, AudioPlayback &rhs)

Detailed Description

Definition at line 50 of file AudioPlayback.h.

Constructor & Destructor Documentation

AudioPlayback::AudioPlayback	(	const float64 &	sample_rate = 44100.0,
		const uint32	channels = 1,
		const uint32	bits_per_sample = 16
	)

Definition at line 115 of file AudioPlayback.cc.

References allocate_backend(), backend_, backend_type_, Nsound::BACKEND_TYPE_NONE, bits_per_sample_, channels_, M_THROW, and sample_rate_.

    :
    sample_rate_(static_cast<uint32>(sample_rate)),
    channels_(channels),
    bits_per_sample_(bits_per_sample),
    backend_(NULL)
{
    backend_ = allocate_backend(
        backend_type_,
        sample_rate_,
        channels_,
        bits_per_sample_);

    if(BACKEND_TYPE_NONE != backend_type_ && backend_ == NULL)
    {
        M_THROW("Nsound::AudioPlayback::AudioPlayback():"
            << ": failed to create AudioBackend!");
    }
};

AudioPlayback::~AudioPlayback

(

)

Definition at line 139 of file AudioPlayback.cc.

References backend_, and Nsound::AudioBackend::shutdown().

{
    if(backend_ != NULL)
    {
        backend_->shutdown();
        delete backend_;
    }
}

Nsound::AudioPlayback::AudioPlayback ( const AudioPlayback &  copy )

inlineprivate

Definition at line 143 of file AudioPlayback.h.

        :
        sample_rate_(copy.sample_rate_),
        channels_(copy.channels_),
        bits_per_sample_(copy.bits_per_sample_),
        backend_(NULL){};

Member Function Documentation

void AudioPlayback::setBackendType ( const AudioBackendType  ab )

static

Sets the AudioBackendType.

Definition at line 102 of file AudioPlayback.cc.

References backend_type_.

Referenced by Nsound::use().

{
    backend_type_ = ab;
}

AudioBackendType AudioPlayback::getBackendType ( )

static

Gets the AudioBackendType that is currently set.

Definition at line 109 of file AudioPlayback.cc.

References backend_type_.

{
    return backend_type_;
}

uint32 AudioPlayback::getBitsPerSample

(

)

Definition at line 150 of file AudioPlayback.cc.

References backend_, bits_per_sample_, and Nsound::AudioBackend::getBitsPerSample().

{
    if(backend_ != NULL)
    {
        return backend_->getBitsPerSample();
    }

    return bits_per_sample_;
}

void Nsound::AudioPlayback::setBitsPerSample ( uint32  bits_per_sample )

inline

Definition at line 75 of file AudioPlayback.h.

References bits_per_sample_.

    {bits_per_sample_ = bits_per_sample;};

uint32 AudioPlayback::getChannels

(

)

Definition at line 162 of file AudioPlayback.cc.

References backend_, channels_, and Nsound::AudioBackend::getChannels().

{
    if(backend_ != NULL)
    {
        return backend_->getChannels();
    }

    return channels_;
}

void Nsound::AudioPlayback::setChannels ( uint32  channels )

inline

Definition at line 82 of file AudioPlayback.h.

References channels_.

    {channels_ = channels;};

std::string AudioPlayback::getError

(

)

Returns an error string describing any backend error.

Definition at line 174 of file AudioPlayback.cc.

References backend_, and Nsound::AudioBackend::getError().

{
    if(backend_ != NULL)
    {
        return backend_->getError();
    }

    std::stringstream ss;

    ss << "Nsound::AudioPlayback::getError():"
        << __LINE__
        << ": backend not initialized"
        << endl;

    return ss.str();
}

std::string AudioPlayback::getInfo

(

)

Returns information about the backend driver.

Definition at line 193 of file AudioPlayback.cc.

References backend_, and Nsound::AudioBackend::getInfo().

{
    if(backend_ != NULL)
    {
        return backend_->getInfo();
    }

    std::stringstream ss;

    ss << "Nsound::AudioPlayback::getInfo():"
        << __LINE__
        << ": backend not initialized"
        << endl;

    return ss.str();
}

uint32 AudioPlayback::getSampleRate

(

)

Definition at line 212 of file AudioPlayback.cc.

References backend_, Nsound::AudioBackend::getSampleRate(), and sample_rate_.

{
    if(backend_ != NULL)
    {
        return backend_->getSampleRate();
    }

    return sample_rate_;
}

void Nsound::AudioPlayback::setSampleRate ( uint32  sample_rate )

inline

Definition at line 97 of file AudioPlayback.h.

References sample_rate_.

    {sample_rate_ = sample_rate;};

AudioBackend::State AudioPlayback::getState

(

)

Returns the backend state.

Definition at line 224 of file AudioPlayback.cc.

References backend_, Nsound::AudioBackend::BACKEND_NOT_INITIALIZED, and Nsound::AudioBackend::getState().

{
    if(backend_ != NULL)
    {
        return backend_->getState();
    }

    return AudioBackend::BACKEND_NOT_INITIALIZED;
}

std::string AudioPlayback::getStateString

(

)

Returns the backend state string.

Definition at line 236 of file AudioPlayback.cc.

References backend_, Nsound::AudioBackend::BACKEND_NOT_INITIALIZED, and Nsound::AudioBackend::getStateString().

{
    if(backend_ != NULL)
    {
        return backend_->getStateString();
    }

    return AudioBackend::getStateString(AudioBackend::BACKEND_NOT_INITIALIZED);
}

std::string AudioPlayback::getStateString

(

const AudioBackend::State &

state

)

Returns the backend state string.

Definition at line 248 of file AudioPlayback.cc.

References Nsound::AudioBackend::getStateString().

{
    return AudioBackend::getStateString(state);
}

void AudioPlayback::initialize

(

)

Initializes the backend and transitions to the BACKEND_READY state on success.

Definition at line 255 of file AudioPlayback.cc.

References allocate_backend(), backend_, Nsound::AudioBackend::BACKEND_READY, backend_type_, Nsound::BACKEND_TYPE_NONE, bits_per_sample_, channels_, Nsound::AudioBackend::getError(), Nsound::AudioBackend::getState(), Nsound::AudioBackend::initialize(), M_THROW, and sample_rate_.

Referenced by _play(), and scanDevices().

{
    if(backend_type_ == BACKEND_TYPE_NONE)
    {
        M_THROW("Nsound::AudioPlayback::initialize():"
            << ": no backend selected or available");
        return;
    }

    // If the backend is currently NULL, recreate it with current settings
    if(backend_ == NULL)
    {
        backend_ = allocate_backend(
            backend_type_,
            sample_rate_,
            channels_,
            bits_per_sample_);
    }

    if(backend_ == NULL)
    {
        M_THROW("Nsound::AudioPlayback::initialize():"
            << ": failed to initialize AudioBackend!");

        return;
    }

    backend_->initialize();

    if(AudioBackend::BACKEND_READY != backend_->getState())
    {
        M_THROW("Nsound::AudioPlayback::initialize():"
            << ": backend faild to initialize\n"
            << "Backend error: "
            << backend_->getError());
    }
}

void AudioPlayback::play

(

const AudioStream &

a

)

Plays the AudioStream throuh the backend.

Definition at line 435 of file AudioPlayback.cc.

References backend_.

Referenced by Nsound::operator>>(), Nsound::AudioBackendLibao::scanDevices(), and Nsound::AudioBackendLibportaudio::scanDevices().

{
    _play<AudioStream>(this, &backend_, a);
}

void AudioPlayback::play

(

const Buffer &

b

)

Plays the Buffer through the backend.

Definition at line 442 of file AudioPlayback.cc.

References backend_.

{
    _play<Buffer>(this, &backend_, b);
}

void AudioPlayback::scanDevices

(

)

Scans for devices and tries to play a test sound.

Definition at line 449 of file AudioPlayback.cc.

References allocate_backend(), backend_, Nsound::AudioBackend::BACKEND_READY, bits_per_sample_, channels_, Nsound::getBackends(), Nsound::getBackendTypes(), Nsound::AudioBackend::getError(), Nsound::AudioBackend::getState(), initialize(), Nsound::GuitarBass::play(), sample_rate_, and Nsound::AudioBackend::scanDevices().

{
    GuitarBass guitar(sample_rate_);

    AudioStream test_clip(sample_rate_, channels_);

    test_clip << guitar.play();

    initialize();

    std::vector< std::string > names = Nsound::getBackends();
    std::vector< AudioBackendType > types = Nsound::getBackendTypes();

    cout << "Nsound::AudioPlayback::scanDevices(): starting\n";
    cout.flush();

    if(types.size() == 0)
    {
        cout << "No backends available\n";
        cout.flush();
    }

    for(uint32 i = 0; i < types.size(); ++i)
    {
        cout << "Selecting backend '"
             << names[i]
             << "'\n";
        cout.flush();

        AudioBackend * orig = backend_;

        backend_ = allocate_backend(
            types[i],
            sample_rate_,
            channels_,
            bits_per_sample_);

        if(backend_->getState() == AudioBackend::BACKEND_READY)
        {
            backend_->scanDevices(*this, test_clip);
        }
        else
        {
            cout << "Backend '"
                 << names[i]
                 << "' failed to initialize\n"
                 << backend_->getError();
            cout.flush();
        }

        delete backend_;

        backend_ = orig;
    }

      cout << "Nsound::AudioPlayback::scanDevices(): finished\n";
      cout.flush();
}

void AudioPlayback::setOption	(	const std::string &	key,
		const std::string &	value
	)

Sets an options, must be called before initialize().

Definition at line 510 of file AudioPlayback.cc.

References backend_, Nsound::AudioBackend::BACKEND_NOT_INITIALIZED, Nsound::AudioBackend::getState(), M_THROW, and Nsound::AudioBackend::setOption().

{
    if(backend_ == NULL)
    {
        M_THROW("Nsound::AudioPlayback::setOption():"
            << ": backend is NULL");
        return;
    }
    else if(AudioBackend::BACKEND_NOT_INITIALIZED != backend_->getState())
    {
        M_THROW("Nsound::AudioPlayback::setOption():"
            << ": backend already initialized");
        return;
    }

    backend_->setOption(key, value);
}

void AudioPlayback::shutdown

(

)

Shuts down the backend.

Definition at line 530 of file AudioPlayback.cc.

References backend_, and Nsound::AudioBackend::shutdown().

{
    if(backend_ != NULL)
    {
        backend_->shutdown();
        delete backend_;
        backend_ = NULL;
    }
}

AudioPlayback& Nsound::AudioPlayback::operator= ( const AudioPlayback &  rhs )

inlineprivate

Definition at line 150 of file AudioPlayback.h.

{return *this;};

Friends And Related Function Documentation

void operator>> ( const AudioStream &  lhs, AudioPlayback &  rhs  )

friend

void operator>> ( const Buffer &  lhs, AudioPlayback &  rhs  )

friend

Member Data Documentation

uint32 Nsound::AudioPlayback::sample_rate_

private

Definition at line 150 of file AudioPlayback.h.

Referenced by AudioPlayback(), getSampleRate(), initialize(), scanDevices(), and setSampleRate().

uint32 Nsound::AudioPlayback::channels_

private

Definition at line 155 of file AudioPlayback.h.

Referenced by AudioPlayback(), getChannels(), initialize(), scanDevices(), and setChannels().

uint32 Nsound::AudioPlayback::bits_per_sample_

private

Definition at line 156 of file AudioPlayback.h.

Referenced by AudioPlayback(), getBitsPerSample(), initialize(), scanDevices(), and setBitsPerSample().

AudioBackend* Nsound::AudioPlayback::backend_

private

Definition at line 158 of file AudioPlayback.h.

Referenced by AudioPlayback(), getBitsPerSample(), getChannels(), getError(), getInfo(), getSampleRate(), getState(), getStateString(), initialize(), play(), scanDevices(), setOption(), shutdown(), and ~AudioPlayback().

AudioBackendType AudioPlayback::backend_type_ = BACKEND_TYPE_NONE

staticprivate

Definition at line 160 of file AudioPlayback.h.

Referenced by AudioPlayback(), getBackendType(), initialize(), and setBackendType().

---

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

• Nsound/AudioPlayback.h
• Nsound/AudioPlayback.cc