Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
SoundManager Class ReferenceProvides sound effects and caching services, as well as mixing buffers for the SoundPlay process. More...
Detailed DescriptionProvides 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, ...?)
Definition at line 58 of file SoundManager.h.
Member Typedef Documentation
For convenience. Definition at line 224 of file SoundManager.h.
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 DocumentationUsed 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
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
Definition at line 50 of file SoundManager.h. Constructor & Destructor Documentation
destructor Definition at line 96 of file SoundManager.cc.
constructor, should only be called by the receiving process (SoundPlay) Definition at line 79 of file SoundManager.cc.
don't call Member Function Documentation
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
Definition at line 410 of file SoundManager.cc.
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
Definition at line 386 of file SoundManager.cc.
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
Definition at line 362 of file SoundManager.cc.
Copies the sound data to the specified memory buffer, ready to be passed to the system.
Definition at line 768 of file SoundManager.cc.
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().
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.
returns number of sounds currently playing Definition at line 155 of file SoundManager.h.
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... Definition at line 640 of file SoundManager.cc.
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.
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().
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. Definition at line 159 of file SoundManager.cc. Referenced by chainBuffer(), loadFile(), and playBuffer().
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
Definition at line 115 of file SoundManager.cc. Referenced by chainFile(), Controller::doStart(), CameraBehavior::doStart(), FlashIPAddrBehavior::loadSounds(), and playFile().
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().
Mixes the channel into the buffer. Definition at line 654 of file SoundManager.cc. Referenced by CopyTo().
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().
don't call
Lets you pause playback. Definition at line 563 of file SoundManager.cc.
plays a previously loaded buffer or file Definition at line 294 of file SoundManager.cc. Referenced by chain(), playBuffer(), and playFile().
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().
play a wav file (if it matches Config::sound_config settings - can't do resampling yet) Will do a call to loadFile() first, and then automatically release the sound again when complete.
Definition at line 268 of file SoundManager.cc. Referenced by chainFile(), ControlBase::doCancel(), FlashIPAddrBehavior::doEvent(), CameraBehavior::doEvent(), Transition::doFire(), ControlBase::doNextItem(), ControlBase::doPrevItem(), ControlBase::doReadStdIn(), WaypointWalkControl::WaypointEditControl::doSelect(), WaypointWalkControl::doSelect(), WalkCalibration::doSelect(), SensorObserverControl::doSelect(), EventLogger::doSelect(), ControlBase::doSelect(), WalkCalibration::err(), RandomTrans::fire(), CameraBehavior::openNextFile(), WalkCalibration::processEvent(), TorqueCalibrate::record(), RunSequenceControl< SequenceSize >::selectedFile(), PlaySoundControl::selectedFile(), LoadPostureControl::selectedFile(), ControlBase::setHilights(), EmergencyStopMC::setStopped(), speak(), SoundNode::startPlaying(), WalkCalibration::takeInput(), TorqueCalibrate::TakeMeasurementControl::takeInput(), and TorqueCalibrate::TakeMeasurementControl::transition().
updates internal data structures on the SoundPlay side - you shouldn't be calling this Definition at line 844 of file SoundManager.cc.
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().
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().
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().
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.
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().
Lets you stop playback of a sound. Definition at line 521 of file SoundManager.cc.
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().
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
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().
for reporting errors Definition at line 36 of file SoundManager.h. Referenced by chain(), chainBuffer(), chainFile(), SpeechNode::doEvent(), SoundNode::doEvent(), endPlay(), getRemainTime(), pausePlay(), play(), playBuffer(), playFile(), SpeechNode::postStart(), resumePlay(), speak(), SpeechNode::stopPlay(), SoundNode::stopPlay(), and stopPlay().
for reporting errors Definition at line 31 of file SoundManager.h. Referenced by chain(), chainBuffer(), chainFile(), endPlay(), getRemainTime(), loadBuffer(), loadFile(), lookupPath(), pausePlay(), play(), playBuffer(), playFile(), release(), resumePlay(), and stopPlay().
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().
Current maximum number of sounds to mix together. Definition at line 235 of file SoundManager.h. Referenced by selectChannels(), and setMode().
maximum length of a path Definition at line 39 of file SoundManager.h. Referenced by loadFile(), and lookupPath().
the number of sounds that can be enqueued at the same time (see MixMode_t) Definition at line 37 of file SoundManager.h.
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.
The intermediate mixer buffer used for Quality mode mixing. Definition at line 170 of file SoundManager.h. Referenced by CopyTo(), and ~SoundManager().
Size (in bytes) of the intermediate mixer buffer. Definition at line 173 of file SoundManager.h. Referenced by CopyTo().
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().
Holds a list of all sounds currently enqueued. Definition at line 222 of file SoundManager.h. Referenced by chain(), chainBuffer(), chainFile(), endPlay(), getRemainTime(), mixChannel(), mixChannelAdditively(), pausePlay(), play(), playBuffer(), playFile(), ProcessMsg(), resumePlay(), selectChannels(), stopPlay(), and updateChannels().
Current queuing mode, set by setMode();. Definition at line 232 of file SoundManager.h. Referenced by selectChannels(), setMode(), and updateChannels().
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().
Holds a list of all currently loaded sounds. Definition at line 209 of file SoundManager.h. Referenced by endPlay(), getRemainTime(), loadBuffer(), loadFile(), lookupPath(), mixChannel(), mixChannelAdditively(), pausePlay(), play(), playBuffer(), playFile(), ProcessMsg(), release(), resumePlay(), selectChannels(), stopPlay(), updateChannels(), and ~SoundManager().
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 |