Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

SoundManager Class Reference

Provides sound effects and caching services, as well as mixing buffers for the SoundPlay process. More...

#include <SoundManager.h>


Detailed Description

Provides sound effects and caching services, as well as mixing buffers for the SoundPlay process.

Provides easy methods for playing back sounds, either from files on the memory stick, or from dynamically generated buffers. You can chain playback commands so that when one sound finishes, another picks up automatically. This might be handy if, say, someone wants to write an MP3 player ;) The sounds would be too large to load into memory all at once, but you could load a block at a time and chain them so it seamlessly moves from one to the other.

You can also preload sounds (loadFile()) before playing them (play() / playFile()) so there's no delay between requesting a sound and having it start playing while it is loaded from disk/memory stick. Just be sure to release the file (releaseFile()) again when you're done with it ;)

All functions will attempt to lock the SoundManager. Remember, this is running in a shared memory region, accessible by the SoundPlay process and both the Main and Motion processes (so MotionCommands can play sounds!)

One could be tempted to draw parallels to the MotionManager, and envision a system with SoundCommands that are handed over and can dynamically compute sound buffers as needed. If you have the time and inclination, the job's all yours... (Midi players, speech synthesizer, ...?)

Todo:
Volume control, variable playback speed, support more wav file formats (latter two are the same thing if you think about it - need to be able to resample on the fly)
Todo:
Add functions to hand out regions to be filled out to avoid copying into the buffer.
See also:
David Touretzky's "Playing Sounds" Chapter

Definition at line 58 of file SoundManager.h.

List of all members.

Classes

struct  PlayState
 Holds data about sounds currently being played. More...
struct  SoundData
 Holds data about the loaded sounds. More...

Public Types

enum  MixMode_t { Fast, Quality }
 

Used to set the mode for mixing multiple sound channels.

More...
enum  QueueMode_t { Enqueue, Pause, Stop, Override }
 

indicates how to handle channel overflow (trying to play more sounds than maximum number of mixing channels). See queue_mode

More...
typedef SoundManagerMsg::Snd_ID Snd_ID
 This is used for referring to sound data so you can start playing it or release it.
typedef unsigned short Play_ID
 This is for referring to instances of the play command so you can stop, pause, or monitor progress (later versions will send events upon completion).

Public Member Functions

virtual ~SoundManager ()
 destructor
 SoundManager ()
 constructor, should only be called by the receiving process (SoundPlay)
void InitAccess (MessageQueueBase &sndbufq)
 Each process (except SoundPlay) needs to call this before it can send sounds to the SoundPlay process.
Snd_ID loadFile (std::string const &name)
 loads a wav file (if it matches Config::sound_config settings - can't do resampling yet)
Snd_ID loadBuffer (const char buf[], unsigned int len)
 loads raw samples from a buffer (assumes matches Config::sound_config settings)
void releaseFile (std::string const &name)
 Marks the sound buffer to be released after the last play command completes (or right now if not being played).
void release (Snd_ID id)
 Marks the sound buffer to be released after the last play command completes (or right now if not being played).
Play_ID playFile (std::string const &name)
 play a wav file (if it matches Config::sound_config settings - can't do resampling yet)
Play_ID playBuffer (const char buf[], unsigned int len)
 loads raw samples from a buffer (assumes buffer matches Config::sound_config settings)
Play_ID play (Snd_ID id)
 plays a previously loaded buffer or file
Play_ID chainFile (Play_ID base, std::string const &next)
 allows automatic queuing of sounds - good for dynamic sound sources!
Play_ID chainBuffer (Play_ID base, const char buf[], unsigned int len)
 allows automatic queuing of sounds - good for dynamic sound sources!
Play_ID chain (Play_ID base, Snd_ID next)
 allows automatic queuing of sounds - good for dynamic sound sources!
SoundManager::Play_ID speak (const std::string &text, bool showText=true, const std::string &voice="female")
 Speaks its argument using the Mary text-to-speech system to generate a WAV file.
void stopPlay ()
 Lets you stop playback of all sounds.
void stopPlay (Play_ID id)
 Lets you stop playback of a sound.
void pausePlay (Play_ID id)
 Lets you pause playback.
void resumePlay (Play_ID id)
 Lets you resume playback.
void setMode (unsigned int max_channels, MixMode_t mixer_mode, QueueMode_t queuing_mode)
 Lets you control the maximum number of channels (currently playing sounds), method for mixing (applies when max_chan>1), and queuing method (for when overflow channels).
unsigned int getRemainTime (Play_ID id) const
 Gives the time until the sound finishes, in milliseconds. Subtract 32 to get guarranteed valid time for this ID.
unsigned int CopyTo (void *dest, size_t destSize)
 Copies the sound data to the specified memory buffer, ready to be passed to the system.
void ProcessMsg (RCRegion *rcr)
 updates internal data structures on the SoundPlay side - you shouldn't be calling this
unsigned int getNumPlaying ()
 returns number of sounds currently playing
virtual unsigned int getNextKey ()
 return the next region serial number -- doesn't actually increment it though, repeated calls will return the same value until the value is actually used

Static Public Attributes

static const Snd_ID invalid_Snd_ID = (Snd_ID)-1
 for reporting errors
static const Snd_ID MAX_SND = 50
 the number of sounds that can be loaded at any given time
static const Play_ID invalid_Play_ID = (Play_ID)-1
 for reporting errors
static const Play_ID MAX_PLAY = 256
 the number of sounds that can be enqueued at the same time (see MixMode_t)
static const unsigned int MAX_NAME_LEN = 128
 maximum length of a path

Protected Types

typedef ListMemBuf< SoundData,
MAX_SND, Snd_ID
sndlist_t
 For convenience.
typedef ListMemBuf< PlayState,
MAX_PLAY, Play_ID
playlist_t
 For convenience.
typedef ListMemBuf< Play_ID,
MAX_PLAY, Play_ID
chanlist_t
 For convenience.

Protected Member Functions

void mixChannel (Play_ID channelId, void *buf, size_t size)
 Mixes the channel into the buffer.
void mixChannelAdditively (Play_ID channelId, int bitsPerSample, MixMode_t mode, short scalingFactor, void *buf, size_t size)
 Mixes the channel into the buffer additively.
RCRegioninitRegion (unsigned int size)
 Sets up a shared region to hold a sound - rounds to nearest page size.
Snd_ID lookupPath (std::string const &name) const
 Looks to see if name matches any of the sounds in sndlist (converts to absolute path if not already).
void selectChannels (std::vector< Play_ID > &mix)
 selects which of the channels are actually to be mixed together, depending on queue_mode
void updateChannels (const std::vector< Play_ID > &mixs, size_t used)
 update the offsets of sounds which weren't mixed (when needed depending on queue_mode)
bool endPlay (Play_ID id)
 called when a buffer end is reached, may reset buffer to next in chain, or just stopPlay()

Protected Attributes

int * mixerBuffer
 The intermediate mixer buffer used for Quality mode mixing.
size_t mixerBufferSize
 Size (in bytes) of the intermediate mixer buffer.
sndlist_t sndlist
 Holds a list of all currently loaded sounds.
playlist_t playlist
 Holds a list of all sounds currently enqueued.
chanlist_t chanlist
 Holds a list of all currently playing sounds, ordered newest (front) to oldest(back).
MixMode_t mix_mode
 Current mixing mode, set by setMode();.
QueueMode_t queue_mode
 Current queuing mode, set by setMode();.
unsigned int max_chan
 Current maximum number of sounds to mix together.
MutexLock
< ProcessID::NumProcesses > 
lock
 Prevents multiple processes from accessing at the same time.
unsigned int sn
 A serial number, incremented for each sound which is created.
MessageQueueBasesubjs [ProcessID::NumProcesses]
 Storage of each process's attachment of the message queue, used to internally transmit sound buffers to SoundPlay.

Static Protected Attributes

static const unsigned int MSG_SIZE = ((sizeof(SoundManagerMsg)-1)/8+1)*8
 the size of a SoundManagerMsg, which is prefixed before each region sent/received by SoundManager (rounded up to nearest even word boundary)

Private Member Functions

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

Friends

void speechDoneCleanup (long playid)

Member Typedef Documentation

For convenience.

Definition at line 224 of file SoundManager.h.

typedef unsigned short SoundManager::Play_ID

This is for referring to instances of the play command so you can stop, pause, or monitor progress (later versions will send events upon completion).

Definition at line 35 of file SoundManager.h.

For convenience.

Definition at line 220 of file SoundManager.h.

This is used for referring to sound data so you can start playing it or release it.

Definition at line 30 of file SoundManager.h.

For convenience.

Definition at line 207 of file SoundManager.h.


Member Enumeration Documentation

Used to set the mode for mixing multiple sound channels.

Feel free to add a higher quality mixer if you're an audiophile - I'm pretty new to sound processing

Enumerator:
Fast 

uses real division to maintain volume level, without increasing intermediary precision, which causes low-order bit error in exchange for less CPU usage

Quality 

uses real division to maintain volume level, using an intermediary higher precision buffer for mixing

Definition at line 43 of file SoundManager.h.

indicates how to handle channel overflow (trying to play more sounds than maximum number of mixing channels). See queue_mode

Enumerator:
Enqueue 

newer sounds are played when a channel opens up (when old sound finishes)

Pause 

newer sounds pause oldest sound, which continues when a channel opens

Stop 

newer sounds stop oldest sound

Override 

older sounds have play heads advanced, but don't get mixed until a channel opens

Definition at line 50 of file SoundManager.h.


Constructor & Destructor Documentation

SoundManager::~SoundManager (  )  [virtual]

destructor

Definition at line 96 of file SoundManager.cc.

SoundManager::SoundManager (  ) 

constructor, should only be called by the receiving process (SoundPlay)

Definition at line 79 of file SoundManager.cc.

SoundManager::SoundManager ( const SoundManager  )  [private]

don't call


Member Function Documentation

SoundManager::Play_ID SoundManager::chain ( Play_ID  base,
Snd_ID  next 
)

allows automatic queuing of sounds - good for dynamic sound sources!

if you chain more than once to the same base, the new buffers are appended to the end of the chain - the new buffer doesn't replace the current chain

Returns:
base - just for convenience of multiple calls

Definition at line 410 of file SoundManager.cc.

SoundManager::Play_ID SoundManager::chainBuffer ( Play_ID  base,
const char  buf[],
unsigned int  len 
)

allows automatic queuing of sounds - good for dynamic sound sources!

if you chain more than once to the same base, the new buffers are appended to the end of the chain - the new buffer doesn't replace the current chain

Returns:
base - just for convenience of multiple calls

Definition at line 386 of file SoundManager.cc.

SoundManager::Play_ID SoundManager::chainFile ( Play_ID  base,
std::string const &  next 
)

allows automatic queuing of sounds - good for dynamic sound sources!

if you chain more than once to the same base, the new buffers are appended to the end of the chain - the new buffer doesn't replace the current chain

Returns:
base - just for convenience of multiple calls

Definition at line 362 of file SoundManager.cc.

unsigned int SoundManager::CopyTo ( void *  dest,
size_t  destSize 
)

Copies the sound data to the specified memory buffer, ready to be passed to the system.

Returns:
the number of active sounds

Definition at line 768 of file SoundManager.cc.

bool SoundManager::endPlay ( Play_ID  id  )  [protected]

called when a buffer end is reached, may reset buffer to next in chain, or just stopPlay()

Definition at line 1038 of file SoundManager.cc.

Referenced by mixChannel(), mixChannelAdditively(), selectChannels(), and updateChannels().

virtual unsigned int SoundManager::getNextKey (  )  [virtual]

return the next region serial number -- doesn't actually increment it though, repeated calls will return the same value until the value is actually used

Definition at line 158 of file SoundManager.h.

unsigned int SoundManager::getNumPlaying (  ) 

returns number of sounds currently playing

Definition at line 155 of file SoundManager.h.

unsigned int SoundManager::getRemainTime ( Play_ID  id  )  const

Gives the time until the sound finishes, in milliseconds. Subtract 32 to get guarranteed valid time for this ID.

You should be passing the beginning of a chain to get proper results...
May be slightly conservative (will report too small a time) because this does not account for delay until SoundPlay picks up the message that a sound has been added.
However, it is slighly optimistic (will report too large a time) because it processes a buffer all at one go, so it could mark the sound as finished (and cause the ID to go invalid) up to RobotInfo::SoundBufferTime (32 ms) before the sound finishes. So subtract SoundBufferTime if you want to be absolutely sure the ID will still valid.

Definition at line 640 of file SoundManager.cc.

void SoundManager::InitAccess ( MessageQueueBase sndbufq  ) 

Each process (except SoundPlay) needs to call this before it can send sounds to the SoundPlay process.

Definition at line 91 of file SoundManager.cc.

RCRegion * SoundManager::initRegion ( unsigned int  size  )  [protected]

Sets up a shared region to hold a sound - rounds to nearest page size.

Definition at line 910 of file SoundManager.cc.

Referenced by loadBuffer(), play(), release(), and resumePlay().

SoundManager::Snd_ID SoundManager::loadBuffer ( const char  buf[],
unsigned int  len 
)

loads raw samples from a buffer (assumes matches Config::sound_config settings)

The sound data will be cached until release() is called a matching number of times.
This function is useful for dynamic sound sources. A copy will be made.

Definition at line 159 of file SoundManager.cc.

Referenced by chainBuffer(), loadFile(), and playBuffer().

SoundManager::Snd_ID SoundManager::loadFile ( std::string const &  name  ) 

loads a wav file (if it matches Config::sound_config settings - can't do resampling yet)

Since the SoundManager does the loading, if the same file is being played more than once, only once copy is stored in memory

Parameters:
name can be either a full path, or a partial path relative to Config::sound_config::root
Returns:
ID number for future references (can also use name) The sound data will be cached until releaseFile() or release() is called a matching number of times
Todo:
this does one more copy than it really needs to

Definition at line 115 of file SoundManager.cc.

Referenced by chainFile(), Controller::doStart(), CameraBehavior::doStart(), FlashIPAddrBehavior::loadSounds(), and playFile().

SoundManager::Snd_ID SoundManager::lookupPath ( std::string const &  name  )  const [protected]

Looks to see if name matches any of the sounds in sndlist (converts to absolute path if not already).

Definition at line 929 of file SoundManager.cc.

Referenced by loadFile(), and releaseFile().

void SoundManager::mixChannel ( Play_ID  channelId,
void *  buf,
size_t  size 
) [protected]

Mixes the channel into the buffer.

Definition at line 654 of file SoundManager.cc.

Referenced by CopyTo().

void SoundManager::mixChannelAdditively ( Play_ID  channelId,
int  bitsPerSample,
MixMode_t  mode,
short  scalingFactor,
void *  buf,
size_t  size 
) [protected]

Mixes the channel into the buffer additively.

If mode is Quality, then the size of the buffer should be double the normal size.

Definition at line 684 of file SoundManager.cc.

Referenced by CopyTo().

SoundManager SoundManager::operator= ( const SoundManager  )  [private]

don't call

void SoundManager::pausePlay ( Play_ID  id  ) 

Lets you pause playback.

Definition at line 563 of file SoundManager.cc.

SoundManager::Play_ID SoundManager::play ( Snd_ID  id  ) 

plays a previously loaded buffer or file

Definition at line 294 of file SoundManager.cc.

Referenced by chain(), playBuffer(), and playFile().

SoundManager::Play_ID SoundManager::playBuffer ( const char  buf[],
unsigned int  len 
)

loads raw samples from a buffer (assumes buffer matches Config::sound_config settings)

The sound data will be released after done playing

Definition at line 282 of file SoundManager.cc.

Referenced by chainBuffer().

void SoundManager::ProcessMsg ( RCRegion rcr  ) 

updates internal data structures on the SoundPlay side - you shouldn't be calling this

Definition at line 844 of file SoundManager.cc.

void SoundManager::release ( Snd_ID  id  ) 

Marks the sound buffer to be released after the last play command completes (or right now if not being played).

Definition at line 213 of file SoundManager.cc.

Referenced by endPlay(), play(), releaseFile(), and stopPlay().

void SoundManager::releaseFile ( std::string const &  name  ) 

Marks the sound buffer to be released after the last play command completes (or right now if not being played).

Definition at line 207 of file SoundManager.cc.

Referenced by Controller::doStop(), CameraBehavior::doStop(), and FlashIPAddrBehavior::releaseSounds().

void SoundManager::resumePlay ( Play_ID  id  ) 

Lets you resume playback.

Definition at line 590 of file SoundManager.cc.

Referenced by endPlay().

void SoundManager::selectChannels ( std::vector< Play_ID > &  mix  )  [protected]

selects which of the channels are actually to be mixed together, depending on queue_mode

Definition at line 945 of file SoundManager.cc.

Referenced by CopyTo().

void SoundManager::setMode ( unsigned int  max_channels,
MixMode_t  mixer_mode,
QueueMode_t  queuing_mode 
)

Lets you control the maximum number of channels (currently playing sounds), method for mixing (applies when max_chan>1), and queuing method (for when overflow channels).

Definition at line 632 of file SoundManager.cc.

SoundManager::Play_ID SoundManager::speak ( const std::string &  text,
bool  showText = true,
const std::string &  voice = "female" 
)

Speaks its argument using the Mary text-to-speech system to generate a WAV file.

On Aperios or unsupported platforms, simply displays the text on stdout

Definition at line 472 of file SoundManager.cc.

Referenced by Transition::doFire(), SpeechNode::postStart(), StateNode::start(), and BatteryMonitorBehavior::startWarning().

void SoundManager::stopPlay ( Play_ID  id  ) 

Lets you stop playback of a sound.

Definition at line 521 of file SoundManager.cc.

void SoundManager::stopPlay (  ) 

Lets you stop playback of all sounds.

Definition at line 514 of file SoundManager.cc.

Referenced by endPlay(), PlaySoundControl::selectedFile(), SpeechNode::stopPlay(), SoundNode::stopPlay(), and ~SoundManager().

void SoundManager::updateChannels ( const std::vector< Play_ID > &  mixs,
size_t  used 
) [protected]

update the offsets of sounds which weren't mixed (when needed depending on queue_mode)

Definition at line 990 of file SoundManager.cc.

Referenced by CopyTo().


Friends And Related Function Documentation

void speechDoneCleanup ( long  playid  )  [friend]

Member Data Documentation

Holds a list of all currently playing sounds, ordered newest (front) to oldest(back).

Definition at line 226 of file SoundManager.h.

Referenced by CopyTo(), pausePlay(), play(), resumePlay(), selectChannels(), stopPlay(), and updateChannels().

MutexLock<ProcessID::NumProcesses> SoundManager::lock [mutable, protected]

Prevents multiple processes from accessing at the same time.

Definition at line 239 of file SoundManager.h.

Referenced by CopyTo(), getRemainTime(), loadBuffer(), loadFile(), pausePlay(), play(), playBuffer(), playFile(), release(), releaseFile(), resumePlay(), setMode(), and stopPlay().

unsigned int SoundManager::max_chan [protected]

Current maximum number of sounds to mix together.

Definition at line 235 of file SoundManager.h.

Referenced by selectChannels(), and setMode().

const unsigned int SoundManager::MAX_NAME_LEN = 128 [static]

maximum length of a path

Definition at line 39 of file SoundManager.h.

Referenced by loadFile(), and lookupPath().

const Play_ID SoundManager::MAX_PLAY = 256 [static]

the number of sounds that can be enqueued at the same time (see MixMode_t)

Definition at line 37 of file SoundManager.h.

const Snd_ID SoundManager::MAX_SND = 50 [static]

the number of sounds that can be loaded at any given time

Definition at line 32 of file SoundManager.h.

Current mixing mode, set by setMode();.

Definition at line 229 of file SoundManager.h.

Referenced by CopyTo(), and setMode().

int* SoundManager::mixerBuffer [protected]

The intermediate mixer buffer used for Quality mode mixing.

Definition at line 170 of file SoundManager.h.

Referenced by CopyTo(), and ~SoundManager().

size_t SoundManager::mixerBufferSize [protected]

Size (in bytes) of the intermediate mixer buffer.

Definition at line 173 of file SoundManager.h.

Referenced by CopyTo().

const unsigned int SoundManager::MSG_SIZE = ((sizeof(SoundManagerMsg)-1)/8+1)*8 [static, protected]

the size of a SoundManagerMsg, which is prefixed before each region sent/received by SoundManager (rounded up to nearest even word boundary)

Definition at line 265 of file SoundManager.h.

Referenced by loadBuffer(), play(), ProcessMsg(), release(), and resumePlay().

Current queuing mode, set by setMode();.

Definition at line 232 of file SoundManager.h.

Referenced by selectChannels(), setMode(), and updateChannels().

unsigned int SoundManager::sn [protected]

A serial number, incremented for each sound which is created.

This is used to verify that a sound message from a process refers to a current sound. If you imaging a pathological process, which rapidly creates and releases sounds, it would run through the sndlist ids, possibly before the sound process can process the incoming buffers. So this is used to ensure that a given message refers to the current sound, and not one that was already released and then reassigned.

Definition at line 262 of file SoundManager.h.

Referenced by initRegion(), and loadBuffer().

MessageQueueBase* SoundManager::subjs[ProcessID::NumProcesses] [protected]

Storage of each process's attachment of the message queue, used to internally transmit sound buffers to SoundPlay.

Definition at line 272 of file SoundManager.h.

Referenced by InitAccess(), loadBuffer(), play(), release(), and resumePlay().


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

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:17 2016 by Doxygen 1.6.3