Wt::NullAudio Class Reference

#include <audio.h>

Inheritance diagram for Wt::NullAudio:

[legend]Collaboration diagram for Wt::NullAudio:

[legend]List of all members.

Public Types
typedef BaseFactory< Audio >	AudioBaseFactory
Public Member Functions
virtual Audio::Chunk *	loadChunk (const std::string &) const
virtual void	playMusic (Music &)
virtual void	fadeInMusic (Music &, int ms)
	~NullAudio ()
int	numChannels () const
Channel *	operator[] (int i) const
virtual int	allocateChannels (int num_channels)
virtual void	pause ()
	pause all channels
virtual void	resume ()
	resume all channels
virtual void	stop (int ms=0)
	stop all channels
virtual void	fadeOut (int)
virtual int	playingChannels () const
virtual int	pausedChannels () const
virtual bool	isAvailable () const
virtual Music *	loadMusic (const std::string &filename)
virtual void	playMusic (Music &)
virtual void	fadeInMusic (Music &, int ms)
virtual void	fadeOutMusic (int ms)
virtual void	setMusicVolume (int volume)
virtual void	pauseMusic ()
virtual void	rewindMusic ()
virtual bool	setMusicPosition (double start_sec)
virtual void	stopMusic ()
virtual bool	playingMusic () const
virtual bool	pausedMusic () const
virtual int	musicFading () const
Static Public Member Functions
static DERIVED *	instance ()
template<class GRANDCHILD>
static DERIVED *	instance ()
	instantiates the pointer compatible child of DERIVED aka grandchild
static DERIVED *	existingInstance ()
static void	init ()
static void	quit ()
Public Attributes
Signal01< void, Channel * >	finished
WVar< int >	musicLoops
sigc::signal< void >	musicFinished
Static Public Attributes
static Factory< Audio, NullAudio >	factory
Protected Member Functions
	NullAudio ()
virtual int	minHWVolume () const
virtual int	maxHWVolume () const
int	HWVolume (int volume) const
template<typename CHILD>
void	adjustAllocatedChannels (int oldnum, int newnum)
Static Protected Member Functions
static Audio *	load ()
	try to load the instance
static void	onChannelFinish (int channel_id)
	callback called when a channel finishes
static void	onMusicFinish ()
static void	handleAudioEvent (const SDL_Event *event)
	SDLEvent::Audio handler.
Protected Attributes
std::vector< Channel * >	channels
Static Protected Attributes
static const int	minVolume = 0
static const int	maxVolume = 1000
static DERIVED *	instance_ = 0
Friends
class	Singleton< Audio >
Classes
class	Channel
class	Chunk

---

Detailed Description

Definition at line 267 of file audio.h.

---

Member Typedef Documentation

typedef BaseFactory<Audio> Wt::Audio::AudioBaseFactory [inherited]

Definition at line 86 of file audio.h.

---

Constructor & Destructor Documentation

Wt::NullAudio::~NullAudio

(

)

Definition at line 321 of file audio.cpp.

References Wt::Audio::allocateChannels().

                      {
    allocateChannels(0);
}

Here is the call graph for this function:

Wt::NullAudio::NullAudio

(

)

[protected]

Definition at line 316 of file audio.cpp.

                     {
    // allocate one channel so we don't crash
    adjustAllocatedChannels<NullAudio>(0, 1);
}

---

Member Function Documentation

template<typename CHILD>

void Wt::Audio::adjustAllocatedChannels	(	int	oldnum,
		int	newnum
	)			[inline, protected, inherited]

Definition at line 241 of file audio.h.

References Wt::Audio::Audio(), and Wt::Audio::channels.

                                                         {
        if (oldnum < newnum) {
            for (int i = oldnum; i < newnum; i++) {
                channels.push_back(new typename CHILD::Channel(i));
            }
        } else { // newnum < oldnum
            Audio& self = *this;
            for (int i = newnum; i < oldnum; i++) {
                delete self[i];
            }
            self.channels.resize(newnum);
        }
    }

Here is the call graph for this function:

int Wt::Audio::allocateChannels

(

int

num_channels

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 90 of file audio.cpp.

References Wt::Audio::channels.

Referenced by ~NullAudio().

                               {
    return channels.size();
}

template<class DERIVED>

static DERIVED* Wt::Singleton< DERIVED >::existingInstance

(

)

[inline, static, inherited]

Definition at line 36 of file singleton.h.

Referenced by Wt::Application::exit(), Wt::Application::postEvent(), Wt::Application::sendEvent(), and Wt::Application::sendPostedEvents().

                                       {
        return instance_;
    }

void Wt::Audio::fadeInMusic	(	Music &	,
		int	ms
	)			[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 129 of file audio.cpp.

{}

void Wt::NullAudio::fadeInMusic	(	Music &	,
		int	ms
	)			[virtual]

Definition at line 385 of file audio.cpp.

References Wt::Audio::onMusicFinish().

                                       {
    onMusicFinish();
}

Here is the call graph for this function:

void Wt::Audio::fadeOut

(

int

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 103 of file audio.cpp.

{}

void Wt::Audio::fadeOutMusic

(

int

ms

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 131 of file audio.cpp.

{}

void Wt::Audio::handleAudioEvent

(

const SDL_Event *

event

)

[static, protected, inherited]

SDLEvent::Audio handler.

it emits the required signal to all interested parties

Definition at line 213 of file audio.cpp.

References Wt::Audio::Event::channel(), Wt::Audio::Event::chunk(), Wt::Audio::Channel::finished, Wt::Singleton< DERIVED >::instance(), and trace.

Referenced by Wt::Audio::Audio().

                                                   {
    trace("audio", "audio event delivered\n");
    Event *sdl_audio_event = static_cast<Event *>(event->user.data1);
    Chunk *chunk = sdl_audio_event->chunk();
    Channel *channel = sdl_audio_event->channel();
    if (chunk && channel) {
        chunk->finished(chunk);
        channel->finished(channel);
        instance()->finished(channel);
    } else {
        instance()->musicFinished();
    }
    delete sdl_audio_event;
}

Here is the call graph for this function:

int Wt::Audio::HWVolume

(

int

volume

)

const [protected, inherited]

Definition at line 169 of file audio.cpp.

References Wt::Audio::maxHWVolume(), Wt::Audio::maxVolume, Wt::Audio::minHWVolume(), and Wt::Audio::minVolume.

                                    {
    return (maxHWVolume() - minHWVolume()) *  volume /
           (maxVolume - minVolume);
}

Here is the call graph for this function:

template<class DERIVED>

static void Wt::Singleton< DERIVED >::init

(

)

[inline, static, inherited]

Note:

cannot fail

Reimplemented in Wt::Application.

Definition at line 49 of file singleton.h.

Referenced by Wt::Application::Application().

                       {
        if (!instance()) {
            assert(0);
        }
    }

template<class DERIVED>

template<class GRANDCHILD>

static DERIVED* Wt::Singleton< DERIVED >::instance

(

)

[inline, static, inherited]

instantiates the pointer compatible child of DERIVED aka grandchild

it is handy in driver like situations

Definition at line 43 of file singleton.h.

                               {
        return (instance_) ? instance_ : GRANDCHILD::load();
    }

template<class DERIVED>

static DERIVED* Wt::Singleton< DERIVED >::instance

(

)

[inline, static, inherited]

Definition at line 32 of file singleton.h.

Referenced by Wt::Audio::Audio(), Wt::Sound::available(), Wt::SDLMixer::Chunk::channel(), Wt::NullAudio::Chunk::channel(), Wt::SDLSurface::defaultDepth(), Wt::SDLInput::EventInfo::EventInfo(), Wt::Dialog::exec(), Wt::Widget::grabKeyboard(), Wt::Widget::grabMouse(), Wt::Audio::handleAudioEvent(), Wt::SDLInput::handleKeyEvent(), Wt::Singleton< Wt::Audio >::init(), Wt::SDLTimer::init(), Wt::Sound::isAvailable(), Wt::Widget::keyboardGrabber(), Wt::Audio::load(), Wt::Widget::mouseGrabber(), Wt::SDLMixer::onChannelFinish(), Wt::Audio::onChannelFinish(), Wt::Sound::play(), Wt::Singleton< Wt::Audio >::quit(), Wt::Widget::releaseKeyboard(), Wt::Widget::releaseMouse(), Wt::SDLInput::SDLInput(), Wt::SDLMixer::setMusicVolume(), Wt::SDLMixer::Channel::setVolume(), and Wt::SDLMixer::Chunk::setVolume().

                               {
        return (instance_) ? instance_ : DERIVED::load();
    }

bool Wt::Audio::isAvailable

(

)

const [virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 113 of file audio.cpp.

                              {
    return false;
}

Audio * Wt::NullAudio::load

(

)

[static, protected]

try to load the instance

if it fails return NULL if it succeeds must return the newly created object

Reimplemented from Wt::Audio.

Definition at line 325 of file audio.cpp.

References trace.

                       {
    trace("audio", "NullAudio initialization...ok\n");
    return new NullAudio;
}

Audio::Chunk * Wt::NullAudio::loadChunk

(

const std::string &

)

const [virtual]

Reimplemented from Wt::Audio.

Definition at line 330 of file audio.cpp.

                                                       {
    return new Chunk;
}

Audio::Music * Wt::Audio::loadMusic

(

const std::string &

filename

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 118 of file audio.cpp.

                                             {
    return new Music;
}

int Wt::Audio::maxHWVolume

(

)

const [protected, virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 165 of file audio.cpp.

Referenced by Wt::Audio::HWVolume().

                             {
    return 1;
}

int Wt::Audio::minHWVolume

(

)

const [protected, virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 161 of file audio.cpp.

Referenced by Wt::Audio::HWVolume().

                             {
    return 0;
}

int Wt::Audio::musicFading

(

)

const [virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 153 of file audio.cpp.

                             {
    return 0;
}

int Wt::Audio::numChannels

(

)

const [inherited]

Definition at line 82 of file audio.cpp.

References Wt::Audio::channels.

Referenced by Wt::SDLMixer::allocateChannels().

                             {
    return channels.size();
}

void Wt::Audio::onChannelFinish

(

int

channel_id

)

[static, protected, inherited]

callback called when a channel finishes

posts a SDL type event (SDLEvent::Audio) in the SDL event queue. By the time the event it is dispatched all SDL actions are allowed.

Reimplemented in Wt::SDLMixer.

Definition at line 178 of file audio.cpp.

References Wt::SDLEvent::Audio, Wt::Audio::Channel::chunk(), Wt::Singleton< DERIVED >::instance(), Wt::SDLEvent::push(), and trace.

Referenced by Wt::NullAudio::Channel::fadeIn(), Wt::SDLMixer::onChannelFinish(), and Wt::NullAudio::Channel::play().

                                          {
    Audio& self = *instance();
    Channel *channel = self.channels[channel_id];
    Chunk *chunk = channel->chunk();

    SDL_Event event;

    event.type = SDLEvent::Audio;
    event.user.code = 0;
    event.user.data1 = new Event(channel, chunk);
    event.user.data2 = 0;

    trace("audio", "channelFinished callback called %d\n", channel_id);
    SDLEvent::push(&event);
}

Here is the call graph for this function:

void Wt::Audio::onMusicFinish

(

)

[static, protected, inherited]

posts a SDL type event (SDLEvent::Audio) in the SDL event queue. By the time the event it is dispatched all SDL actions are allowed.

Definition at line 198 of file audio.cpp.

References Wt::SDLEvent::Audio, Wt::SDLEvent::push(), and trace.

Referenced by fadeInMusic(), playMusic(), and Wt::SDLMixer::SDLMixer().

                          {
    SDL_Event event;

    event.type = SDLEvent::Audio;
    event.user.code = 0;
    event.user.data1 = new Event(0, 0);
    event.user.data2 = 0;

    trace("audio", "musicFinished callback called\n");

    SDLEvent::push(&event);
}

Here is the call graph for this function:

Audio::Channel * Wt::Audio::operator[]

(

int

i

)

const [inherited]

Definition at line 86 of file audio.cpp.

References Wt::Audio::channels.

                                           {
    return channels[i];
}

void Wt::Audio::pause

(

)

[virtual, inherited]

pause all channels

Reimplemented in Wt::SDLMixer.

Definition at line 95 of file audio.cpp.

{}

int Wt::Audio::pausedChannels

(

)

const [virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 109 of file audio.cpp.

                                {
    return 0;
}

bool Wt::Audio::pausedMusic

(

)

const [virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 149 of file audio.cpp.

                              {
    return false;
}

void Wt::Audio::pauseMusic

(

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 135 of file audio.cpp.

{}

int Wt::Audio::playingChannels

(

)

const [virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 105 of file audio.cpp.

                                 {
    return 0;
}

bool Wt::Audio::playingMusic

(

)

const [virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 145 of file audio.cpp.

                               {
    return false;
}

void Wt::Audio::playMusic

(

Music &

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 125 of file audio.cpp.

References trace.

                            {
    trace("audio", "Audio::playMusic() called\n");
}

void Wt::NullAudio::playMusic

(

Music &

)

[virtual]

Definition at line 380 of file audio.cpp.

References Wt::Audio::onMusicFinish(), and trace.

                                {
    trace("audio", "NullAudio::playMusic() called\n");
    onMusicFinish();
}

Here is the call graph for this function:

template<class DERIVED>

static void Wt::Singleton< DERIVED >::quit

(

)

[inline, static, inherited]

Reimplemented in Wt::Application.

Definition at line 55 of file singleton.h.

Referenced by Wt::Application::~Application().

                       {
        delete instance();
    }

void Wt::Audio::resume

(

)

[virtual, inherited]

resume all channels

Reimplemented in Wt::SDLMixer.

Definition at line 98 of file audio.cpp.

{}

void Wt::Audio::rewindMusic

(

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 137 of file audio.cpp.

{}

bool Wt::Audio::setMusicPosition

(

double

start_sec

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 139 of file audio.cpp.

                                   {
    return false;
}

void Wt::Audio::setMusicVolume

(

int

volume

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 133 of file audio.cpp.

{}

void Wt::Audio::stop

(

int

ms = 0

)

[virtual, inherited]

stop all channels

Reimplemented in Wt::SDLMixer.

Definition at line 101 of file audio.cpp.

{}

void Wt::Audio::stopMusic

(

)

[virtual, inherited]

Reimplemented in Wt::SDLMixer.

Definition at line 143 of file audio.cpp.

{}

---

Friends And Related Function Documentation

friend class Singleton< Audio > [friend]

Reimplemented from Wt::Audio.

Definition at line 268 of file audio.h.

---

Member Data Documentation

std::vector<Channel *> Wt::Audio::channels [protected, inherited]

Definition at line 260 of file audio.h.

Referenced by Wt::Audio::adjustAllocatedChannels(), Wt::Audio::allocateChannels(), Wt::Audio::numChannels(), and Wt::Audio::operator[]().

Factory< Audio, NullAudio > Wt::NullAudio::factory [static]

Reimplemented from Wt::Audio.

Definition at line 270 of file audio.h.

Signal01<void, Channel *> Wt::Audio::finished [inherited]

Definition at line 198 of file audio.h.

template<class DERIVED>

DERIVED * Wt::Singleton< DERIVED >::instance_ = 0 [static, protected, inherited]

Definition at line 91 of file singleton.h.

Referenced by Wt::Singleton< Wt::Audio >::existingInstance(), Wt::Singleton< Wt::Audio >::instance(), Wt::Singleton< Wt::Audio >::load(), Wt::SDLDisplay::load(), Wt::Audio::load(), Wt::Singleton< Wt::Audio >::Singleton(), and Wt::Singleton< Wt::Audio >::~Singleton().

const int Wt::Audio::maxVolume = 1000 [static, protected, inherited]

Definition at line 238 of file audio.h.

Referenced by Wt::SDLMixer::Chunk::Chunk(), and Wt::Audio::HWVolume().

const int Wt::Audio::minVolume = 0 [static, protected, inherited]

Definition at line 237 of file audio.h.

Referenced by Wt::Audio::HWVolume().

sigc::signal<void> Wt::Audio::musicFinished [inherited]

Definition at line 226 of file audio.h.

WVar<int> Wt::Audio::musicLoops [inherited]

Definition at line 224 of file audio.h.

Referenced by Wt::SDLMixer::fadeInMusic(), and Wt::SDLMixer::playMusic().

---

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

• audio.h
• audio.cpp

---

Generated Fri Jul 28 19:25:55 2006.
Copyright © 1998-2003 by the respective authors.

This document is licensed under the terms of the GNU Free Documentation License and may be freely distributed under the conditions given by this license.