LLAudioSource Class Reference

#include <audioengine.h>

Inheritance diagram for LLAudioSource:

Collaboration diagram for LLAudioSource:

List of all members.

Public Member Functions

LLAudioSource (const LLUUID &id, const LLUUID &owner_id, const F32 gain)

virtual ~LLAudioSource ()

virtual void update ()

void updatePriority ()

void preload (const LLUUID &audio_id)

void addAudioData (LLAudioData *adp, BOOL set_current=TRUE)

void setAmbient (const BOOL ambient)

BOOL isAmbient () const

void setLoop (const BOOL loop)

BOOL isLoop () const

void setSyncMaster (const BOOL master)

BOOL isSyncMaster () const

void setSyncSlave (const BOOL slave)

BOOL isSyncSlave () const

void setQueueSounds (const BOOL queue)

BOOL isQueueSounds () const

void setPlayedOnce (const BOOL played_once)

void setPositionGlobal (const LLVector3d &position_global)

LLVector3d getPositionGlobal () const

LLVector3 getVelocity () const

F32 getPriority () const

F32 getGain () const

virtual void setGain (const F32 gain)

const LLUUID & getID () const

BOOL isDone ()

LLAudioData * getCurrentData ()

LLAudioData * getQueuedData ()

LLAudioBuffer * getCurrentBuffer ()

BOOL setupChannel ()

BOOL play (const LLUUID &audio_id)

BOOL hasPendingPreloads () const

Protected Types

typedef std::map< LLUUID,
LLAudioData * > data_map

Protected Member Functions

void setChannel (LLAudioChannel *channelp)

LLAudioChannel * getChannel () const

Protected Attributes

LLUUID mID

LLUUID mOwnerID

F32 mPriority

F32 mGain

BOOL mAmbient

BOOL mLoop

BOOL mSyncMaster

BOOL mSyncSlave

BOOL mQueueSounds

BOOL mPlayedOnce

LLVector3d mPositionGlobal

LLVector3 mVelocity

LLAudioChannel * mChannelp

LLAudioData * mCurrentDatap

LLAudioData * mQueuedDatap

data_map mPreloadMap

LLFrameTimer mAgeTimer

Friends

class LLAudioEngine

class LLAudioChannel

Detailed Description

Definition at line 249 of file audioengine.h.

Member Typedef Documentation

typedef std::map<LLUUID, LLAudioData *> LLAudioSource::data_map [protected]

Definition at line 327 of file audioengine.h.

Constructor & Destructor Documentation

LLAudioSource::LLAudioSource	(	const LLUUID &	id,
		const LLUUID &	owner_id,
		const F32	gain
	)

Definition at line 1183 of file audioengine.cpp.

LLAudioSource::~LLAudioSource ( ) [virtual]

Definition at line 1201 of file audioengine.cpp.

References mChannelp, NULL, and LLAudioChannel::setSource().

Here is the call graph for this function:

Member Function Documentation

void LLAudioSource::update ( ) [virtual]

Reimplemented in LLAudioSourceVO.

Definition at line 1223 of file audioengine.cpp.

References getCurrentBuffer(), getCurrentData(), getID(), indra::base::config::load(), and play().

Referenced by LLAudioEngine::idle(), and LLAudioSourceVO::update().

Here is the call graph for this function:

Here is the caller graph for this function:

void LLAudioSource::updatePriority ( )

Definition at line 1239 of file audioengine.cpp.

References dist_vec(), LLAudioEngine::getListenerPos(), getPositionGlobal(), isAmbient(), llmax(), LLVector3::magVecSquared(), mGain, mPriority, and LLVector3::setVec().

Referenced by LLAudioEngine::idle(), setupChannel(), and LLAudioEngine::triggerSound().

Here is the call graph for this function:

Here is the caller graph for this function:

void LLAudioSource::preload ( const LLUUID & audio_id )

void LLAudioSource::addAudioData	(	LLAudioData *	adp,
		BOOL	set_current = `TRUE`
	)

Definition at line 1400 of file audioengine.cpp.

References LLAudioData::getID(), isLoop(), mChannelp, mCurrentDatap, mPreloadMap, mQueuedDatap, mQueueSounds, LLAudioChannel::play(), LLAudioEngine::startNextTransfer(), and LLAudioChannel::updateBuffer().

Referenced by play(), and process_preload_sound().

Here is the call graph for this function:

Here is the caller graph for this function:

void LLAudioSource::setAmbient ( const BOOL ambient ) [inline]

Definition at line 264 of file audioengine.h.

References mAmbient.

Referenced by LLAudioSourceVO::LLAudioSourceVO(), and LLAudioEngine::triggerSound().

Here is the caller graph for this function:

BOOL LLAudioSource::isAmbient ( ) const [inline]

Definition at line 265 of file audioengine.h.

References mAmbient.

Referenced by LLAudioChannelFMOD::update3DPosition(), and updatePriority().

Here is the caller graph for this function:

void LLAudioSource::setLoop ( const BOOL loop ) [inline]

Definition at line 267 of file audioengine.h.

References mLoop.

Referenced by LLViewerObject::setAttachedSound().

Here is the caller graph for this function:

BOOL LLAudioSource::isLoop ( ) const [inline]

Definition at line 268 of file audioengine.h.

References mLoop.

Referenced by addAudioData(), LLAudioEngine::idle(), isDone(), LLViewerObject::setAttachedSound(), LLAudioChannelFMOD::updateBuffer(), and LLViewerObject::updateLOD().

Here is the caller graph for this function:

void LLAudioSource::setSyncMaster ( const BOOL master ) [inline]

Definition at line 270 of file audioengine.h.

References mSyncMaster.

Referenced by LLViewerObject::setAttachedSound().

Here is the caller graph for this function:

BOOL LLAudioSource::isSyncMaster ( ) const [inline]

Definition at line 271 of file audioengine.h.

References mSyncMaster.

Referenced by LLAudioEngine::idle().

Here is the caller graph for this function:

void LLAudioSource::setSyncSlave ( const BOOL slave ) [inline]

Definition at line 273 of file audioengine.h.

References mSyncSlave.

Referenced by LLViewerObject::setAttachedSound().

Here is the caller graph for this function:

BOOL LLAudioSource::isSyncSlave ( ) const [inline]

Definition at line 274 of file audioengine.h.

References mSyncSlave.

Referenced by LLAudioEngine::idle(), and play().

Here is the caller graph for this function:

void LLAudioSource::setQueueSounds ( const BOOL queue ) [inline]

Definition at line 276 of file audioengine.h.

References mQueueSounds.

Referenced by LLViewerObject::setAttachedSound().

Here is the caller graph for this function:

BOOL LLAudioSource::isQueueSounds ( ) const [inline]

Definition at line 277 of file audioengine.h.

References mQueueSounds.

void LLAudioSource::setPlayedOnce ( const BOOL played_once ) [inline]

Definition at line 279 of file audioengine.h.

References mPlayedOnce.

Referenced by LLAudioChannelFMOD::play().

Here is the caller graph for this function:

void LLAudioSource::setPositionGlobal ( const LLVector3d & position_global ) [inline]

Definition at line 281 of file audioengine.h.

References mPositionGlobal.

Referenced by LLAudioEngine::triggerSound().

Here is the caller graph for this function:

LLVector3d LLAudioSource::getPositionGlobal ( ) const [inline]

Definition at line 282 of file audioengine.h.

References mPositionGlobal.

Referenced by LLPipeline::postSort(), LLAudioChannelFMOD::update3DPosition(), and updatePriority().

Here is the caller graph for this function:

LLVector3 LLAudioSource::getVelocity ( ) const [inline]

Definition at line 283 of file audioengine.h.

References mVelocity.

Referenced by LLAudioChannelFMOD::update3DPosition().

Here is the caller graph for this function:

F32 LLAudioSource::getPriority ( ) const [inline]

Definition at line 284 of file audioengine.h.

References mPriority.

Referenced by LLAudioEngine::getFreeChannel(), LLAudioEngine::idle(), setupChannel(), and LLAudioEngine::startNextTransfer().

Here is the caller graph for this function:

F32 LLAudioSource::getGain ( ) const [inline]

Definition at line 287 of file audioengine.h.

References mGain.

Referenced by LLAudioChannelFMOD::updateBuffer().

Here is the caller graph for this function:

virtual void LLAudioSource::setGain ( const F32 gain ) [inline, virtual]

Reimplemented in LLAudioSourceVO.

Definition at line 288 of file audioengine.h.

References llclamp(), and mGain.

Here is the call graph for this function:

const LLUUID& LLAudioSource::getID ( ) const [inline]

Definition at line 290 of file audioengine.h.

References mID.

Referenced by LLAudioEngine::addAudioSource(), LLAudioEngine::cleanupAudioSource(), and update().

Here is the caller graph for this function:

BOOL LLAudioSource::isDone ( )

Definition at line 1336 of file audioengine.cpp.

References FALSE, LLFrameTimer::getElapsedTimeF32(), hasPendingPreloads(), isLoop(), LLAudioChannel::isPlaying(), mAgeTimer, mChannelp, mPlayedOnce, mQueuedDatap, and TRUE.

Referenced by LLAudioEngine::idle(), and LLViewerObject::setAttachedSound().

Here is the call graph for this function:

Here is the caller graph for this function:

LLAudioData * LLAudioSource::getCurrentData ( )

Definition at line 1486 of file audioengine.cpp.

References mCurrentDatap.

Referenced by LLViewerObject::setAttachedSound(), setupChannel(), LLAudioEngine::startNextTransfer(), and update().

Here is the caller graph for this function:

LLAudioData * LLAudioSource::getQueuedData ( )

Definition at line 1491 of file audioengine.cpp.

References mQueuedDatap.

Referenced by LLAudioEngine::startNextTransfer().

Here is the caller graph for this function:

LLAudioBuffer * LLAudioSource::getCurrentBuffer ( )

Definition at line 1496 of file audioengine.cpp.

References LLAudioData::getBuffer(), mCurrentDatap, and NULL.

Referenced by LLAudioEngine::idle(), update(), LLAudioChannelFMOD::updateBuffer(), and LLAudioChannel::updateBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

BOOL LLAudioSource::setupChannel ( )

Definition at line 1257 of file audioengine.cpp.

References FALSE, LLAudioData::getBuffer(), getCurrentData(), LLAudioEngine::getFreeChannel(), getPriority(), mChannelp, setChannel(), LLAudioChannel::setSource(), TRUE, and updatePriority().

Referenced by LLAudioEngine::idle(), and play().

Here is the call graph for this function:

Here is the caller graph for this function:

BOOL LLAudioSource::play ( const LLUUID & audio_id )

Definition at line 1291 of file audioengine.cpp.

References addAudioData(), FALSE, LLAudioEngine::getAudioData(), getChannel(), LLUUID::isNull(), isSyncSlave(), mAgeTimer, NULL, LLAudioChannel::play(), LLFrameTimer::reset(), setChannel(), LLAudioChannel::setSource(), setupChannel(), LLAudioChannel::setWaiting(), TRUE, and LLAudioEngine::updateBufferForData().

Referenced by LLViewerObject::setAttachedSound(), LLAudioEngine::triggerSound(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

BOOL LLAudioSource::hasPendingPreloads ( ) const

Definition at line 1468 of file audioengine.cpp.

References FALSE, LLAudioData::hasDecodedData(), mPreloadMap, and TRUE.

Referenced by isDone(), and LLViewerObject::setAttachedSound().

Here is the call graph for this function:

Here is the caller graph for this function:

void LLAudioSource::setChannel ( LLAudioChannel * channelp ) [protected]

Definition at line 1212 of file audioengine.cpp.

References mChannelp.

Referenced by LLAudioEngine::getFreeChannel(), LLAudioEngine::idle(), play(), setupChannel(), and LLAudioChannel::~LLAudioChannel().

Here is the caller graph for this function:

LLAudioChannel* LLAudioSource::getChannel ( ) const [inline, protected]

Definition at line 306 of file audioengine.h.

References mChannelp.

Referenced by LLAudioEngine::idle(), and play().

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class LLAudioEngine [friend]

Definition at line 302 of file audioengine.h.

friend class LLAudioChannel [friend]

Definition at line 303 of file audioengine.h.

Member Data Documentation

LLUUID LLAudioSource::mID [protected]

Definition at line 309 of file audioengine.h.

Referenced by getID().

LLUUID LLAudioSource::mOwnerID [protected]

Definition at line 310 of file audioengine.h.

Referenced by LLAudioSourceVO::updateGain().

F32 LLAudioSource::mPriority [protected]

Definition at line 311 of file audioengine.h.

Referenced by getPriority(), and updatePriority().

F32 LLAudioSource::mGain [protected]

Definition at line 312 of file audioengine.h.

Referenced by getGain(), setGain(), LLAudioSourceVO::updateGain(), and updatePriority().

BOOL LLAudioSource::mAmbient [protected]

Definition at line 313 of file audioengine.h.

Referenced by isAmbient(), and setAmbient().

BOOL LLAudioSource::mLoop [protected]

Definition at line 314 of file audioengine.h.

Referenced by isLoop(), and setLoop().

BOOL LLAudioSource::mSyncMaster [protected]

Definition at line 315 of file audioengine.h.

Referenced by isSyncMaster(), and setSyncMaster().

BOOL LLAudioSource::mSyncSlave [protected]

Definition at line 316 of file audioengine.h.

Referenced by isSyncSlave(), and setSyncSlave().

BOOL LLAudioSource::mQueueSounds [protected]

Definition at line 317 of file audioengine.h.

Referenced by addAudioData(), isQueueSounds(), and setQueueSounds().

BOOL LLAudioSource::mPlayedOnce [protected]

Definition at line 318 of file audioengine.h.

Referenced by isDone(), and setPlayedOnce().

LLVector3d LLAudioSource::mPositionGlobal [protected]

Definition at line 319 of file audioengine.h.

Referenced by getPositionGlobal(), setPositionGlobal(), and LLAudioSourceVO::update().

LLVector3 LLAudioSource::mVelocity [protected]

Definition at line 320 of file audioengine.h.

Referenced by getVelocity(), and LLAudioSourceVO::update().

LLAudioChannel* LLAudioSource::mChannelp [protected]

Definition at line 323 of file audioengine.h.

Referenced by addAudioData(), getChannel(), isDone(), setChannel(), setupChannel(), and ~LLAudioSource().

LLAudioData* LLAudioSource::mCurrentDatap [protected]

Definition at line 324 of file audioengine.h.

Referenced by addAudioData(), getCurrentBuffer(), getCurrentData(), and LLAudioEngine::idle().

LLAudioData* LLAudioSource::mQueuedDatap [protected]

Definition at line 325 of file audioengine.h.

Referenced by addAudioData(), getQueuedData(), LLAudioEngine::idle(), and isDone().

data_map LLAudioSource::mPreloadMap [protected]

Definition at line 328 of file audioengine.h.

Referenced by addAudioData(), hasPendingPreloads(), and LLAudioEngine::startNextTransfer().

LLFrameTimer LLAudioSource::mAgeTimer [protected]

Definition at line 330 of file audioengine.h.

Referenced by LLAudioEngine::idle(), isDone(), and play().

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

llaudio/audioengine.h
llaudio/audioengine.cpp


Public Member Functions
	LLAudioSource (const LLUUID &id, const LLUUID &owner_id, const F32 gain)
virtual	~LLAudioSource ()
virtual void	update ()
void	updatePriority ()
void	preload (const LLUUID &audio_id)
void	addAudioData (LLAudioData *adp, BOOL set_current=TRUE)
void	setAmbient (const BOOL ambient)
BOOL	isAmbient () const
void	setLoop (const BOOL loop)
BOOL	isLoop () const
void	setSyncMaster (const BOOL master)
BOOL	isSyncMaster () const
void	setSyncSlave (const BOOL slave)
BOOL	isSyncSlave () const
void	setQueueSounds (const BOOL queue)
BOOL	isQueueSounds () const
void	setPlayedOnce (const BOOL played_once)
void	setPositionGlobal (const LLVector3d &position_global)
LLVector3d	getPositionGlobal () const
LLVector3	getVelocity () const
F32	getPriority () const
F32	getGain () const
virtual void	setGain (const F32 gain)
const LLUUID &	getID () const
BOOL	isDone ()
LLAudioData *	getCurrentData ()
LLAudioData *	getQueuedData ()
LLAudioBuffer *	getCurrentBuffer ()
BOOL	setupChannel ()
BOOL	play (const LLUUID &audio_id)
BOOL	hasPendingPreloads () const
Protected Types
typedef std::map< LLUUID, LLAudioData * >	data_map
Protected Member Functions
void	setChannel (LLAudioChannel *channelp)
LLAudioChannel *	getChannel () const
Protected Attributes
LLUUID	mID
LLUUID	mOwnerID
F32	mPriority
F32	mGain
BOOL	mAmbient
BOOL	mLoop
BOOL	mSyncMaster
BOOL	mSyncSlave
BOOL	mQueueSounds
BOOL	mPlayedOnce
LLVector3d	mPositionGlobal
LLVector3	mVelocity
LLAudioChannel *	mChannelp
LLAudioData *	mCurrentDatap
LLAudioData *	mQueuedDatap
data_map	mPreloadMap
LLFrameTimer	mAgeTimer
Friends
class	LLAudioEngine
class	LLAudioChannel