Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

SoundPlay Class Reference

#include <SoundPlay.h>

Inheritance diagram for SoundPlay:

Inheritance graph
[legend]
List of all members.

Detailed Description

The process (a.k.a. OObject), which is responsible for sending sound buffers to the system to play.

This sound process will purposely starve the system of sound buffers when nothing is playing, both to eliminate needless zeroing of entire buffers, as well as to reduce system overhead of playing empty buffers.

If you want to know how to play sounds, you should be looking at SoundManager's documentation.

Basically a slightly modified version of the SoundPlay example code from Sony. Here's their license: Copyright 2002,2003 Sony Corporation

Permission to use, copy, modify, and redistribute this software for non-commercial use is hereby granted.

This software is provided "as is" without warranty of any kind, either expressed or implied, including but not limited to the implied warranties of fitness for a particular purpose.

Definition at line 28 of file SoundPlay.h.

Public Member Functions

 SoundPlay ()
 constructor

virtual ~SoundPlay ()
 destructor

virtual OStatus DoInit (const OSystemEvent &event)
 called by system when time to do init

virtual OStatus DoStart (const OSystemEvent &event)
 called by system when time to start running

virtual OStatus DoStop (const OSystemEvent &event)
 called by system when time to stop running

virtual OStatus DoDestroy (const OSystemEvent &event)
 called by system when time to free

void ReadySendSound (const OReadyEvent &event)
 called by system when it's ready for another sound buffer

void ReadyRegisterSoundManager (const OReadyEvent &event)
 called by system when observers are ready to receive the SoundManager

void GotEventTranslatorQueue (const ONotifyEvent &event)
 called by system when the queue for sending events to Main is being published

void GotSoundMsg (const ONotifyEvent &event)
 called by system when SoundManager has sent itself a message on a different process (either to add or remove sounds from memory)


Public Attributes

OSubject * subject [numOfSubject]
 array of subject IDs, used to identify outgoing data

OObserver * observer [numOfObserver]
 array of observer IDs, used to identify what's ready


Private Member Functions

void doSendSound ()
 called to send sound buffer(s) to system

void OpenSpeaker ()
 initializes speaker

void NewSoundVectorData ()
 sets up sound buffers

void SetPowerAndVolume ()
 sets volume to max

RCRegion * InitRegion (unsigned int size)
 inits each buffer

RCRegion * FindFreeRegion ()
 finds the first sound buffer which system isn't using (buffers are recycled)

 SoundPlay (const SoundPlay &)
 don't call

SoundPlay & operator= (const SoundPlay &)
 don't call


Private Attributes

unsigned int active
 number of active sound channels - if it's 0, we'll purposely starve system of sound buffers

RCRegion * soundManagerMemRgn
 SoundPlay creates, Main & Motion receive - Shared region used by SoundManager.

RCRegion * eventTranslatorQueueMemRgn
 Main creates, Motion (& SoundPlay) receive.

EventTranslator etrans
 will be given all events created by SoundManager to be forwarded to Main

OPrimitiveID speakerID
 ID returned to system after opening SPEAKER_LOCATOR.

RCRegion * region [SOUND_NUM_BUFFER]
 holds references to shared regions holding sound clips


Static Private Attributes

const char *const  SPEAKER_LOCATOR = "PRM:/r1/c1/c2/c3/s1-Speaker:S1"
 ID for speaker in system.

const size_t SOUND_NUM_BUFFER = 2
 number of buffers to use

Constructor & Destructor Documentation

SoundPlay::SoundPlay (   ) 
 

constructor

Definition at line 27 of file SoundPlay.cc.

References region, and SOUND_NUM_BUFFER.

virtual SoundPlay::~SoundPlay (   )  [inline, virtual]
 

destructor

Definition at line 31 of file SoundPlay.h.

SoundPlay::SoundPlay (  const SoundPlay &   )  [private]
 

don't call

Member Function Documentation

OStatus SoundPlay::DoDestroy (  const OSystemEvent &  event  )  [virtual]
 

called by system when time to free

Definition at line 93 of file SoundPlay.cc.

References config, erouter, eventTranslatorQueueMemRgn, Config::sound_config::preload, SoundManager::ReleaseFile(), sndman, and Config::sound.

Here is the call graph for this function:

OStatus SoundPlay::DoInit (  const OSystemEvent &  event  )  [virtual]
 

called by system when time to do init

Definition at line 35 of file SoundPlay.cc.

References config, erouter, SoundManager::InitAccess(), InitRegion(), SoundManager::LoadFile(), SoundManager::MAX_SND, NewSoundVectorData(), observer, OpenSpeaker(), Config::sound_config::preload, ProcessID::setID(), SetPowerAndVolume(), sndman, Config::sound, soundManagerMemRgn, ProcessID::SoundProcess, and subject.

Here is the call graph for this function:

void SoundPlay::doSendSound (   )  [private]
 

called to send sound buffer(s) to system

Definition at line 147 of file SoundPlay.cc.

References active, SoundManager::CopyTo(), FindFreeRegion(), SoundManager::GetNumPlaying(), sndman, SOUND_NUM_BUFFER, and subject.

Here is the call graph for this function:

OStatus SoundPlay::DoStart (  const OSystemEvent &  event  )  [virtual]
 

called by system when time to start running

Definition at line 69 of file SoundPlay.cc.

OStatus SoundPlay::DoStop (  const OSystemEvent &  event  )  [virtual]
 

called by system when time to stop running

Definition at line 80 of file SoundPlay.cc.

References sndman, and SoundManager::StopPlay().

Here is the call graph for this function:

RCRegion * SoundPlay::FindFreeRegion (   )  [private]
 

finds the first sound buffer which system isn't using (buffers are recycled)

Definition at line 247 of file SoundPlay.cc.

References region, and SOUND_NUM_BUFFER.

void SoundPlay::GotEventTranslatorQueue (  const ONotifyEvent &  event  ) 
 

called by system when the queue for sending events to Main is being published

Definition at line 122 of file SoundPlay.cc.

References EventRouter::addTrapper(), ASSERT, erouter, etrans, eventTranslatorQueueMemRgn, observer, and EventTranslator::setQueue().

Here is the call graph for this function:

void SoundPlay::GotSoundMsg (  const ONotifyEvent &  event  ) 
 

called by system when SoundManager has sent itself a message on a different process (either to add or remove sounds from memory)

Definition at line 134 of file SoundPlay.cc.

References active, doSendSound(), SoundManager::GetNumPlaying(), observer, SoundManager::ReceivedMsg(), and sndman.

Here is the call graph for this function:

RCRegion * SoundPlay::InitRegion (  unsigned int  size  )  [private]
 

inits each buffer

Will round up size to the nearest page

Definition at line 238 of file SoundPlay.cc.

References ASSERT.

void SoundPlay::NewSoundVectorData (   )  [private]
 

sets up sound buffers

Definition at line 180 of file SoundPlay.cc.

References config, region, Config::sound_config::sample_bits, Config::sound_config::sample_rate, Config::sound, SOUND_NUM_BUFFER, ERS210Info::SoundBufferTime, and speakerID.

void SoundPlay::OpenSpeaker (   )  [private]
 

initializes speaker

Definition at line 172 of file SoundPlay.cc.

References SPEAKER_LOCATOR, and speakerID.

SoundPlay& SoundPlay::operator= (  const SoundPlay &   )  [private]
 

don't call

void SoundPlay::ReadyRegisterSoundManager (  const OReadyEvent &  event  ) 
 

called by system when observers are ready to receive the SoundManager

Definition at line 111 of file SoundPlay.cc.

References soundManagerMemRgn, and subject.

void SoundPlay::ReadySendSound (  const OReadyEvent &  event  ) 
 

called by system when it's ready for another sound buffer

Definition at line 104 of file SoundPlay.cc.

References doSendSound().

Here is the call graph for this function:

void SoundPlay::SetPowerAndVolume (   )  [private]
 

sets volume to max

Definition at line 215 of file SoundPlay.cc.

References config, Config::sound_config::sample_bits, Config::sound_config::sample_rate, Config::sound, and speakerID.

Member Data Documentation

unsigned int SoundPlay::active [private]
 

number of active sound channels - if it's 0, we'll purposely starve system of sound buffers

Definition at line 58 of file SoundPlay.h.

EventTranslator SoundPlay::etrans [private]
 

will be given all events created by SoundManager to be forwarded to Main

Definition at line 62 of file SoundPlay.h.

RCRegion* SoundPlay::eventTranslatorQueueMemRgn [private]
 

Main creates, Motion (& SoundPlay) receive.

Definition at line 61 of file SoundPlay.h.

OObserver* SoundPlay::observer[numOfObserver]
 

array of observer IDs, used to identify what's ready

Definition at line 45 of file SoundPlay.h.

RCRegion* SoundPlay::region[SOUND_NUM_BUFFER] [private]
 

holds references to shared regions holding sound clips

Definition at line 65 of file SoundPlay.h.

const size_t SoundPlay::SOUND_NUM_BUFFER = 2 [static, private]
 

number of buffers to use

Definition at line 56 of file SoundPlay.h.

RCRegion* SoundPlay::soundManagerMemRgn [private]
 

SoundPlay creates, Main & Motion receive - Shared region used by SoundManager.

Definition at line 60 of file SoundPlay.h.

const char* const SoundPlay::SPEAKER_LOCATOR = "PRM:/r1/c1/c2/c3/s1-Speaker:S1" [static, private]
 

ID for speaker in system.

Definition at line 55 of file SoundPlay.h.

OPrimitiveID SoundPlay::speakerID [private]
 

ID returned to system after opening SPEAKER_LOCATOR.

Definition at line 64 of file SoundPlay.h.

OSubject* SoundPlay::subject[numOfSubject]
 

array of subject IDs, used to identify outgoing data

Definition at line 44 of file SoundPlay.h.

The documentation for this class was generated from the following files:
Tekkotsu v1.5
 		Generated Fri Oct 10 15:57:43 2003 by Doxygen 1.3.4