NLSOUND::CClusteredSound Class Reference

#include <clustered_sound.h>

---

Detailed Description

This class will manage the clipping/positioning/occlusion of sound placed inside the cluster/portal system.

Author:

Boris Boucher

Nevrax France

Date:

2002

Definition at line 58 of file clustered_sound.h.

Public Types
typedef std::map< NL3D::CCluster *, CClusterSoundStatus >	TClusterStatusMap
	Container for audible cluster status.
typedef std::map< NL3D::CCluster *, CSoundTravContext >	TClusterTravContextMap
	Container for the next traversal step.
Public Member Functions
	CClusteredSound ()
	Constructor.
const TClusterStatusMap &	getAudibleClusters ()
const std::vector< std::pair< NLMISC::CVector, NLMISC::CVector > > &	getAudioPath ()
const CClusterSoundStatus *	getClusterSoundStatus (NL3D::CCluster *cluster)
NL3D::CCluster *	getRootCluster ()
void	init (NL3D::CScene *scene, float portalInterpolate, float maxEarDistance, float minGain)
void	update (const NLMISC::CVector &listenerPos, const NLMISC::CVector &view, const NLMISC::CVector &up)
Private Member Functions
bool	addAudibleCluster (NL3D::CCluster *cluster, CClusterSoundStatus &soundStatus)
	Add a cluster into the list of audible cluster.
void	addNextTraverse (NL3D::CCluster *cluster, CSoundTravContext &travContext)
	Add a cluster for the next traversal step.
NLMISC::CVector	interpolateSourceDirection (const CSoundTravContext &context, float portalDist, const NLMISC::CVector &nearPoint, const NLMISC::CVector &realListener, NLMISC::CVector &d1, NLMISC::CVector &d2, float &alpha)
	Compute a positional blending depending on context.
void	soundTraverse (const std::vector< NL3D::CCluster * > &clusters, CSoundTravContext &travContext)
	Traverse the cluster system to build/update the audible cluster set and theire respective status.
float	getAABoxNearestPos (const NLMISC::CAABBox &box, const NLMISC::CVector &pos, NLMISC::CVector &nearPos)
float	getPolyNearestPos (const std::vector< NLMISC::CVector > &poly, const NLMISC::CVector &pos, NLMISC::CVector &nearPoint)
Private Attributes
TClusterStatusMap	_AudibleClusters
	The current audible cluster.
std::vector< std::pair< NLMISC::CVector, NLMISC::CVector > >	_AudioPath
	The segment of all the audio path.
std::hash_map< NLMISC::TStringId, uint >	_IdToEaxEnv
	The mapping for env name Id to EAX environement number.
std::hash_map< NLMISC::TStringId, uint >	_IdToMaterial
	The mapping for occlusion material name to material number.
uint	_LastEnv
	The last setted environement.
float	_MaxEarDistance
	Maximum earing distance.
float	_MinGain
	Minimum gain.
TClusterTravContextMap	_NextTraversalStep
	The cluster for the next travesal step.
float	_PortalInterpolate
	Interpolation distance when listener is near a portal.
NL3D::CCluster *	_RootCluster
	The root cluster of the scene.
NL3D::CScene *	_Scene
	The scene of interest.
std::hash_map< NLMISC::TStringId, NLMISC::TStringId >	_SoundGroupToSound
	The sound_group to sound assoc.
std::hash_map< NLMISC::TStringId, CClusterSound >	_Sources
	The current cluster playing source indexed with sound group id.
Static Private Attributes
char *	_EnvironmentNames []
	The environment name table for init.
char *	_MaterialNames []
	The material name table for init.

---

Member Typedef Documentation

typedef std::map<NL3D::CCluster*, CClusterSoundStatus> NLSOUND::CClusteredSound::TClusterStatusMap

Container for audible cluster status. Definition at line 87 of file clustered_sound.h. Referenced by getAudibleClusters().

typedef std::map<NL3D::CCluster*, CSoundTravContext> NLSOUND::CClusteredSound::TClusterTravContextMap

Container for the next traversal step. Definition at line 175 of file clustered_sound.h.

---

Constructor & Destructor Documentation

NLSOUND::CClusteredSound::CClusteredSound (   )

Constructor. Definition at line 222 of file clustered_sound.cpp. References _EnvironmentNames, _IdToEaxEnv, _IdToMaterial, _MaterialNames, and uint. : _Scene(0), _RootCluster(0), _LastEnv(0xffffffff) { // fill the env name table uint i; for (i=0; _EnvironmentNames[i] != 0; ++i) { _IdToEaxEnv.insert(make_pair(CStringMapper::map(string(_EnvironmentNames[i])), i)); } // fill the material name table for (i=0; _MaterialNames[i] != 0; ++i) { _IdToMaterial.insert(make_pair(CStringMapper::map(string(_MaterialNames[i])), i)); } }

---

Member Function Documentation

bool NLSOUND::CClusteredSound::addAudibleCluster (  NL3D::CCluster *  cluster, CClusterSoundStatus &  soundStatus )  [private]

Add a cluster into the list of audible cluster. Definition at line 957 of file clustered_sound.cpp. References _AudibleClusters, _MaxEarDistance, NLSOUND::CClusteredSound::CClusterSoundStatus::Direction, NLSOUND::CClusteredSound::CClusterSoundStatus::Dist, nlassert, and NLMISC::CVector::norm(). Referenced by soundTraverse(). { TClusterStatusMap::iterator it(_AudibleClusters.find(cluster)); nlassert(soundStatus.Dist < _MaxEarDistance); nlassert(soundStatus.Direction.norm() <= 1.01f); if (it != _AudibleClusters.end()) { // get the best one (for now, based on shortest distance) if (soundStatus.Dist < it->second.Dist) { it->second = soundStatus; return true; } } else { _AudibleClusters.insert(make_pair(cluster, soundStatus)); return true; } return false; }

void NLSOUND::CClusteredSound::addNextTraverse (  NL3D::CCluster *  cluster, CSoundTravContext &  travContext )  [private]

Add a cluster for the next traversal step. Definition at line 941 of file clustered_sound.cpp. References _NextTraversalStep, and NLSOUND::CClusteredSound::CSoundTravContext::Dist. Referenced by soundTraverse(). { std::map<CCluster*, CSoundTravContext>::iterator it = _NextTraversalStep.find(cluster); if (it != _NextTraversalStep.end()) { if (it->second.Dist > travContext.Dist) { it->second = travContext; } } else _NextTraversalStep.insert(make_pair(cluster, travContext)); }

float NLSOUND::CClusteredSound::getAABoxNearestPos (  const NLMISC::CAABBox &  box, const NLMISC::CVector &  pos, NLMISC::CVector &  nearPos )  [private]

Compute the point in the bounding box that is the nearest from a given position. This point can be in the volume of the box, on a segment of one of the vertex. In addition, the method also return the distance from the nearest point to the reference position. Parameters: poly  The bounding box description. pos  The reference position. nearPoint  The nearest point (out var). Returns: The distance between pos and nearPoint. Definition at line 1155 of file clustered_sound.cpp. References NLMISC::clamp(), NLMISC::CAABBox::getMax(), NLMISC::CAABBox::getMin(), NLMISC::CVector::x, NLMISC::CVector::y, and NLMISC::CVector::z. Referenced by soundTraverse(). { CVector vMin, vMax; box.getMin(vMin); box.getMax(vMax); nearPos = pos; // X clamp(nearPos.x, vMin.x, vMax.x); // Y clamp(nearPos.y, vMin.y, vMax.y); // Z clamp(nearPos.z, vMin.z, vMax.z); return (pos-nearPos).norm(); }

const TClusterStatusMap& NLSOUND::CClusteredSound::getAudibleClusters (   )  [inline]

Definition at line 198 of file clustered_sound.h. References _AudibleClusters, and TClusterStatusMap. {return _AudibleClusters;}

const std::vector<std::pair<NLMISC::CVector, NLMISC::CVector> >& NLSOUND::CClusteredSound::getAudioPath (   )  [inline]

Definition at line 200 of file clustered_sound.h. References _AudioPath. { return _AudioPath;}

const CClusteredSound::CClusterSoundStatus * NLSOUND::CClusteredSound::getClusterSoundStatus (  NL3D::CCluster *  cluster  )

Definition at line 459 of file clustered_sound.cpp. References _AudibleClusters. Referenced by NLSOUND::CAudioMixerUser::update(), and NLSOUND::CBackgroundSoundManager::updateBackgroundStatus(). { TClusterStatusMap::iterator it(_AudibleClusters.find(cluster)); if (it == _AudibleClusters.end()) { return 0; } else return &(it->second); }

float NLSOUND::CClusteredSound::getPolyNearestPos (  const std::vector< NLMISC::CVector > &  poly, const NLMISC::CVector &  pos, NLMISC::CVector &  nearPoint )  [private]

Compute the point on the poly that is the nearest from a given position. This point can be on the surface of the poly, on a segment or on one of the vertex. In addition, the method also return the distance from the nearest point to the reference position. Parameters: poly  The polygone description. pos  The reference position. nearPoint  The nearest point (out var). Returns: The distance between pos and nearPoint. Definition at line 1098 of file clustered_sound.cpp. References NLMISC::CPlane::getNormal(), NLMISC::CPlane::make(), NLMISC::CVector::norm(), NLMISC::CPlane::project(), NLMISC::CVector::sqrnorm(), and uint. Referenced by soundTraverse(). { CPlane plane; plane.make(poly[0], poly[1], poly[2]); CVector proj = plane.project(pos); float minDist = FLT_MAX; bool projIn = true; uint nbVertex = poly.size(); // loop throw all vertex for (uint j=0; j<nbVertex; ++j) { float d = (pos-poly[j]).sqrnorm(); // check if the vertex is the nearest point if (d < minDist) { nearPoint = poly[j]; minDist = d; } // if (projIn /*&& j<poly.size()-1*/) { // check each segment if (plane.getNormal()*((poly[(j+1)%nbVertex] - poly[j]) ^ (proj - poly[j])) < 0) { // the point is not inside the poly surface ! projIn = false; // check if the nearest point is on this segment CVector v1 = (poly[(j+1)%nbVertex] - poly[j]); float v1Len = v1.norm(); v1 = v1 / v1Len; CVector v2 = proj - poly[j]; // project v2 on v1 float p = v1 * v2; if (p>=0 && p<=v1Len) { // the nearest point is on the segment! nearPoint = poly[j] + v1 * p; minDist = (nearPoint-pos).sqrnorm(); break; } } } } if (projIn) { float d = (proj-pos).sqrnorm(); if (d < minDist) { // the nearest point is on the surface nearPoint = proj; minDist = d; } } return sqrtf(minDist); }

NL3D::CCluster * NLSOUND::CClusteredSound::getRootCluster (   )

Definition at line 472 of file clustered_sound.cpp. References NL3D::CScene::getClipTrav(). Referenced by NLSOUND::CBackgroundSoundManager::updateBackgroundStatus(). { if (_Scene == 0) return 0; return _Scene->getClipTrav().RootCluster; }

void NLSOUND::CClusteredSound::init (  NL3D::CScene *  scene, float  portalInterpolate, float  maxEarDistance, float  minGain )

Initialize the class Parameters: scene  The scene of interest for cluster management. portalInterpolate  Ditance from listener to portal for interpolation. maxEarDist  The maximum traversal distance to limit graph traversal. minGain  The minimun gain to stop traversal. Definition at line 242 of file clustered_sound.cpp. References _MaxEarDistance, _MinGain, _PortalInterpolate, _RootCluster, _SoundGroupToSound, NLSOUND::Container, and NL3D::CScene::getClipTrav(). Referenced by NLSOUND::CAudioMixerUser::initClusteredSound(). { // load the sound_group sheets ::loadForm("sound_group", CAudioMixerUser::instance()->getPackedSheetPath()+"sound_groups.packed_sheets", Container, CAudioMixerUser::instance()->getPackedSheetUpdate(), false); // copy the container data into internal structure std::map<std::string, CSoundGroupSerializer>::iterator first(Container.begin()), last(Container.end()); for (; first != last; ++first) { _SoundGroupToSound.insert(first->second._SoundGroupAssoc.begin(), first->second._SoundGroupAssoc.end()); } // and clear the temporary Container Container.clear(); _Scene = scene; _PortalInterpolate = portalInterpolate; _MaxEarDistance = maxEarDist; _MinGain = minGain; if(scene != 0) { _RootCluster = _Scene->getClipTrav().RootCluster; } else _RootCluster = 0; }

CVector NLSOUND::CClusteredSound::interpolateSourceDirection (  const CSoundTravContext &  context, float  portalDist, const NLMISC::CVector &  nearPoint, const NLMISC::CVector &  realListener, NLMISC::CVector &  d1, NLMISC::CVector &  d2, float &  alpha )  [private]

Compute a positional blending depending on context. Definition at line 982 of file clustered_sound.cpp. References _PortalInterpolate, alpha, NLSOUND::CClusteredSound::CSoundTravContext::NbPortal, nlassert, NLMISC::CVector::norm(), and NLMISC::CVector::normed(). Referenced by soundTraverse(). { CVector direction;// (context.Direction); if (portalDist > _PortalInterpolate || alpha >= 1.0f) { // the portal is too far, no interpolation. if (context.NbPortal == 0) { // it's the first portal, compute the initial virtual sound direction direction = d1 = (nearPoint-realListener).normed(); } else { direction = (nearPoint-realListener).normed(); direction = (direction * (1-alpha) + d1 * (alpha)).normed(); d1 = direction; } alpha = 1; } else { // the portal is near the listener, interpolate the direction if (context.NbPortal == 0) { // It's the first portal, compute the initial direction alpha = (portalDist / _PortalInterpolate); // alpha = alpha*alpha*alpha; direction = d1 = (nearPoint-realListener).normed(); } /* else if (context.NbPortal == 1) { float factor = (1-alpha); // factor = factor*factor*factor; direction = (nearPoint-realListener).normed(); direction = d1 = (direction * factor + d1 * (1-factor)).normed(); // alpha = 1-factor; alpha = factor; } */ else { // two or more portal float factor = (portalDist / _PortalInterpolate) * (1-alpha); // factor = factor*factor*factor; direction = (nearPoint-realListener).normed(); direction = d1 = (direction * factor + d1 * alpha).normed(); // alpha = 1-factor; alpha = factor; } } nlassert(direction.norm() <= 1.01f); return direction; /* CVector direction (context.Direction); d1 = context.Direction1; d2 = context.Direction2; if (portalDist < _PortalInterpolate) { if (context.NbPortal == 0) { alpha = (portalDist / _PortalInterpolate); direction = d1 = (nearPoint-realListener).normed() * alpha; direction.normalize(); } else if (context.NbPortal == 1) { alpha = alpha * (portalDist / _PortalInterpolate); // d2 = (nearPoint-realListener).normed() * alpha; d2 = (nearPoint-context.ListenerPos).normed() * (1-alpha); direction = d1 + d2; direction.normalize(); } else { alpha = alpha * (portalDist / _PortalInterpolate); // d1 = d1+d2; d2 = (nearPoint-context.ListenerPos).normed() * (1-alpha); // direction = d1 + d2 + (nearPoint-context.ListenerPos).normed() * (1-alpha); direction = d1 + d2; direction.normalize(); } } else { // alpha = 0.0f if (context.NbPortal == 0) { direction = d1 = (nearPoint-realListener).normed(); } else if (context.NbPortal == 1) { d2 = (nearPoint-context.ListenerPos).normed() * (1-alpha); // d2 = d1; //(nearPoint-context.ListenerPos).normed(); // * (1-alpha); direction = d1+d2; direction.normalize(); } else { // d2 = (nearPoint-context.ListenerPos).normed() * (1-alpha); d1 = d1+d2; // d2 = (nearPoint-realListener).normed(); // direction = d1+d2+(nearPoint-context.ListenerPos).normed() * (1-alpha); direction.normalize(); } } return direction; */ }

void NLSOUND::CClusteredSound::soundTraverse (  const std::vector< NL3D::CCluster * > &  clusters, CSoundTravContext &  travContext )  [private]

Traverse the cluster system to build/update the audible cluster set and theire respective status. Definition at line 481 of file clustered_sound.cpp. References _AudibleClusters, _AudioPath, _IdToMaterial, _MaxEarDistance, _MinGain, _NextTraversalStep, _PortalInterpolate, _RootCluster, addAudibleCluster(), addNextTraverse(), NLSOUND::CClusteredSound::CSoundTravContext::Alpha, alpha, NLSOUND::CClusteredSound::CSoundTravContext::Direction, NLSOUND::CClusteredSound::CClusterSoundStatus::Direction, NLSOUND::CClusteredSound::CSoundTravContext::Direction1, NLSOUND::CClusteredSound::CSoundTravContext::Direction2, NLSOUND::CClusteredSound::CSoundTravContext::Dist, NLSOUND::CClusteredSound::CClusterSoundStatus::Dist, NLSOUND::CClusteredSound::CClusterSoundStatus::DistFactor, NLSOUND::EAX_MATERIAL_PARAM, NL3D::CCluster::FatherAudible, NLSOUND::CClusteredSound::CSoundTravContext::FilterUnvisibleChild, NLSOUND::CClusteredSound::CSoundTravContext::FilterUnvisibleFather, NLSOUND::CClusteredSound::CSoundTravContext::Gain, NLSOUND::CClusteredSound::CClusterSoundStatus::Gain, getAABoxNearestPos(), getPolyNearestPos(), H_AUTO, interpolateSourceDirection(), NLSOUND::CClusteredSound::CSoundTravContext::ListenerPos, min, NLSOUND::CClusteredSound::CSoundTravContext::NbPortal, nlassert, nlwarning, NLMISC::CVector::normed(), NLSOUND::CClusteredSound::CSoundTravContext::Obstruction, NLSOUND::CClusteredSound::CClusterSoundStatus::Obstruction, NLSOUND::CClusteredSound::CSoundTravContext::Occlusion, NLSOUND::CClusteredSound::CClusterSoundStatus::Occlusion, NLSOUND::CClusteredSound::CSoundTravContext::OcclusionLFFactor, NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionLFFactor, NLSOUND::CClusteredSound::CSoundTravContext::OcclusionRoomRatio, NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionRoomRatio, NLSOUND::CClusteredSound::CClusterSoundStatus::PosAlpha, NLSOUND::CClusteredSound::CClusterSoundStatus::Position, NLSOUND::CClusteredSound::CSoundTravContext::PreviousCluster, NLSOUND::CClusteredSound::CSoundTravContext::PreviousVector, sint32, and uint. Referenced by update(). { H_AUTO(NLSOUND_soundTraverse) // std::map<CCluster*, CSoundTravContext> nextTraverse; std::vector<std::pair<const CCluster*, CSoundTravContext> > curClusters; CVector realListener (travContext.ListenerPos); _AudioPath.clear(); // fill the initial cluster liste CClusterSoundStatus css; css.Direction = CVector::Null; css.DistFactor = 0.0f; css.Dist = 0.0f; css.Gain = 1.0f; css.Occlusion = 0; css.OcclusionLFFactor = 1.0f; css.OcclusionRoomRatio = 1.0f; css.Obstruction = 0; css.PosAlpha = 0; // css.Position = CVector::Null; css.Position = realListener; for (uint i=0; i<clusters.size(); ++i) { bool valid = true; // eliminate cluster when listener is behind their portals AND inside the other cluster for (uint j=0; j<clusters[i]->getNbPortals(); j++) { CPortal *portal = clusters[i]->getPortal(j); const std::vector<CVector> &poly = portal->getPoly(); if (poly.size() < 3) { // only warn once, avoid log flooding ! static std::set<std::string> warned; if (warned.find(clusters[i]->Name) == warned.end()) { nlwarning("Cluster [%s] contains a portal [%s] with less than 3 vertex !", clusters[i]->Name.c_str(), portal->getName().empty() ? "no name" : portal->getName().c_str()); warned.insert(clusters[i]->Name); } valid = false; continue; } CVector normal = (poly[0] - poly[1]) ^ (poly[2] - poly[1]); float dist = (realListener - poly[0]) * normal; float dist2 = (clusters[i]->getBBox().getCenter() - poly[0]) * normal; if ((dist < 0 && dist2 > 0) || (dist > 0 && dist2 < 0)) { if (portal->getCluster(0) == clusters[i]) { if (find(clusters.begin(), clusters.end(), portal->getCluster(1)) != clusters.end()) { valid = false; continue; } } else if (find(clusters.begin(), clusters.end(), portal->getCluster(0)) != clusters.end()) { valid = false; continue; } } /* if (portal->getCluster(0) == clusters[i] && dist > 0) // if (!portal->isInFront(realListener)) { valid = false; continue; } else if (portal->getCluster(1) == clusters[i] && dist < 0) // if (portal->isInFront(realListener)) { valid = false; continue; } */ } if( valid) { curClusters.push_back(make_pair(clusters[i], travContext)); addAudibleCluster(clusters[i], css); } } do { // add the next traverse (if any) std::copy(_NextTraversalStep.begin(), _NextTraversalStep.end(), std::back_inserter(curClusters)); _NextTraversalStep.clear(); while (!curClusters.empty()) { CCluster * cluster = const_cast<CCluster*>(curClusters.back().first); CSoundTravContext &travContext = curClusters.back().second; CClusterSoundStatus css; css.Gain = travContext.Gain; css.Dist = travContext.Dist; css.Direction = travContext.Direction; css.Occlusion = travContext.Occlusion; css.OcclusionLFFactor = travContext.OcclusionLFFactor; css.OcclusionRoomRatio = travContext.OcclusionRoomRatio; css.Obstruction = travContext.Obstruction; // store this cluster and it's parameters _AudibleClusters.insert(make_pair(cluster, css)); // 1st, look each portal uint i; for (i=0; i<cluster->getNbPortals(); ++i) { CPortal *portal = cluster->getPortal(i); // get the other cluster CCluster *otherCluster = portal->getCluster(0); bool clusterInFront = true; if (otherCluster == cluster) { otherCluster = portal->getCluster(1); clusterInFront = false; } nlassert(otherCluster != cluster); if (otherCluster && travContext.PreviousCluster != otherCluster) // && (!travContext.FilterUnvisibleChild || otherCluster->AudibleFromFather)) { const vector<CVector> &poly = portal->getPoly(); // a security test if (poly.size() < 3) { // only warn once, avoid log flooding ! static std::set<std::string> warned; if (warned.find(cluster->Name) == warned.end()) { nlwarning("Cluster [%s] contains a portal [%s] with less than 3 vertex !", cluster->Name.c_str(), portal->getName().empty() ? "no name" : portal->getName().c_str()); warned.insert(cluster->Name); } } else { // Test to skip portal with suface > 40 m2 (aprox) float surface = ((poly[2]-poly[1]) ^ (poly[0]-poly[1])).norm(); if (surface > 340 /* && otherCluster->isIn(travContext.ListenerPos, travContext.MaxDist-travContext.Dist)*/) { float minDist; CVector nearPos; CAABBox box = otherCluster->getBBox(); minDist = getAABoxNearestPos(box, travContext.ListenerPos, nearPos); if (travContext.Dist + minDist < _MaxEarDistance) { CVector soundDir = (nearPos - travContext.ListenerPos).normed(); CClusterSoundStatus css; css.Gain = travContext.Gain; css.Dist = travContext.Dist + minDist; css.Occlusion = travContext.Occlusion; css.OcclusionLFFactor = travContext.OcclusionLFFactor; css.Obstruction = travContext.Obstruction; css.OcclusionRoomRatio = travContext.OcclusionRoomRatio; css.DistFactor = css.Dist / _MaxEarDistance; css.Direction = travContext.Direction; float alpha = travContext.Alpha; CVector d1(travContext.Direction1), d2; css.Direction = interpolateSourceDirection(travContext, css.Dist+travContext.Dist, nearPos, travContext.ListenerPos /*realListener*/, d1, d2, alpha); css.Position = nearPos + css.Dist * css.Direction; css.PosAlpha = min(1.0f, css.Dist / _PortalInterpolate); if (addAudibleCluster(otherCluster, css)) { // debugLines.push_back(CLine(travContext.ListenerPos, nearPos)); CSoundTravContext stc(travContext); stc.FilterUnvisibleChild = true; stc.Direction1 = d1; stc.Direction2 = d2; stc.Direction = css.Direction; stc.PreviousCluster = cluster; stc.Alpha = alpha; stc.PreviousVector = (nearPos - travContext.ListenerPos).normed(); addNextTraverse(otherCluster, stc); _AudioPath.push_back(make_pair(travContext.ListenerPos, nearPos)); } } } else { // find the nearest point of this portal (either on of the perimeter vertex or a point on the portal surface) float minDist; CVector nearPos; minDist = getPolyNearestPos(poly, travContext.ListenerPos, nearPos); if (travContext.Dist+minDist < _MaxEarDistance) { // TODO : compute relative gain according to portal behavior. CClusterSoundStatus css; css.Gain = travContext.Gain; CVector soundDir = (nearPos - travContext.ListenerPos).normed(); uint occId = portal->getOcclusionModelId(); std::hash_map<NLMISC::TStringId, uint>::iterator it(_IdToMaterial.find(occId)); #if EAX_AVAILABLE == 1 if (it != _IdToMaterial.end()) { // found an occlusion material for this portal uint matId = it->second; css.Occlusion = max(sint32(EAXBUFFER_MINOCCLUSION), sint32(travContext.Occlusion + EAX_MATERIAL_PARAM[matId][0])); //- 1800); //EAX_MATERIAL_THINDOOR; css.OcclusionLFFactor = travContext.OcclusionLFFactor * EAX_MATERIAL_PARAM[matId][1]; //EAX_MATERIAL_THICKDOORLF; //0.66f; //0.0f; //min(EAX_MATERIAL_THINDOORLF, travContext.OcclusionLFFactor); css.OcclusionRoomRatio = EAX_MATERIAL_PARAM[matId][2] * travContext.OcclusionRoomRatio; } else { // the id does not match any know material css.Occlusion = travContext.Occlusion; css.OcclusionLFFactor = travContext.OcclusionLFFactor; css.OcclusionRoomRatio = travContext.OcclusionRoomRatio; } #else // EAX_AVAILABLE if (it != _IdToMaterial.end()) { // found an occlusion material for this portal uint matId = it->second; css.Gain *= EAX_MATERIAL_PARAM[matId]; } #endif // EAX_AVAILABLE /* if (portal->getOcclusionModel() == "wood door") { // css.Gain *= 0.5f; #if EAX_AVAILABLE == 1 css.Occlusion = max(EAXBUFFER_MINOCCLUSION, travContext.Occlusion + EAX_MATERIAL_THICKDOOR); //- 1800); //EAX_MATERIAL_THINDOOR; css.OcclusionLFFactor = 0.1f * travContext.OcclusionLFFactor; //EAX_MATERIAL_THICKDOORLF; //0.66f; //0.0f; //min(EAX_MATERIAL_THINDOORLF, travContext.OcclusionLFFactor); css.OcclusionRoomRatio = EAX_MATERIAL_THICKDOORROOMRATION * travContext.OcclusionRoomRatio; #else css.Gain *= 0.5f; #endif } else if (portal->getOcclusionModel() == "brick door") { #if EAX_AVAILABLE == 1 css.Occlusion = max(EAXBUFFER_MINOCCLUSION, travContext.Occlusion + EAX_MATERIAL_BRICKWALL); css.OcclusionLFFactor = min(EAX_MATERIAL_BRICKWALLLF, travContext.OcclusionLFFactor); css.OcclusionRoomRatio = EAX_MATERIAL_BRICKWALLROOMRATIO * travContext.OcclusionRoomRatio; #else css.Gain *= 0.2f; #endif } else { #if EAX_AVAILABLE == 1 css.Occlusion = travContext.Occlusion; css.OcclusionLFFactor = travContext.OcclusionLFFactor; css.OcclusionRoomRatio = travContext.OcclusionRoomRatio; #endif } */ // compute obstruction if (travContext.NbPortal >= 1) { float h = soundDir * travContext.PreviousVector; float obst; if (h < 0) { // obst = float(2000 + asinf(-(soundDir ^ travContext.PreviousVector).norm()) / (Pi/2) * 2000); obst = float(4000 - (soundDir ^ travContext.PreviousVector).norm() * 2000); } else { // obst = float(asinf((soundDir ^ travContext.PreviousVector).norm()) / (Pi/2) * 2000); obst = float((soundDir ^ travContext.PreviousVector).norm() * 2000); } // float sqrdist = (realListener - nearPoint).sqrnorm(); if (travContext.Dist < 2.0f) // interpolate a 2 m obst *= travContext.Dist / 2.0f; #if EAX_AVAILABLE == 1 css.Obstruction = max(sint32(EAXBUFFER_MINOBSTRUCTION), sint32(travContext.Obstruction - sint32(obst))); css.OcclusionLFFactor = 0.50f * travContext.OcclusionLFFactor; #else css.Gain *= float(pow(10, -(obst/4)/2000)); #endif } else css.Obstruction = travContext.Obstruction; // css.Dist = travContext.Dist + float(sqrt(minDist)); css.Dist = travContext.Dist + minDist; css.DistFactor = css.Dist / _MaxEarDistance; float portalDist = css.Dist; float alpha = travContext.Alpha; CVector d1(travContext.Direction1), d2(travContext.Direction2); css.Direction = interpolateSourceDirection(travContext, portalDist+travContext.Dist, nearPos, travContext.ListenerPos /*realListener*/, d1, d2, alpha); css.Position = nearPos + css.Dist * css.Direction; css.PosAlpha = min(1.0f, css.Dist / _PortalInterpolate); if (addAudibleCluster(otherCluster, css)) { // debugLines.push_back(CLine(travContext.ListenerPos, nearPoint)); CSoundTravContext tc(nearPos, travContext.FilterUnvisibleChild, !cluster->AudibleFromFather); tc.Dist = css.Dist; tc.Gain = css.Gain; tc.Occlusion = css.Occlusion; tc.OcclusionLFFactor = css.OcclusionLFFactor; tc.OcclusionRoomRatio = css.OcclusionRoomRatio; tc.Obstruction = css.Obstruction; tc.Direction1 = d1; tc.Direction2 = d2; tc.NbPortal = travContext.NbPortal+1; tc.Direction = css.Direction; tc.PreviousCluster = cluster; tc.Alpha = alpha; tc.PreviousVector = soundDir; addNextTraverse(otherCluster, tc); _AudioPath.push_back(make_pair(travContext.ListenerPos, nearPos)); } } } } } } // 2nd, look each child cluster for (i=0; i<cluster->Children.size(); ++i) { CCluster *c = cluster->Children[i]; // dont redown into an upstream if (c != travContext.PreviousCluster) { // clip on distance. if (c->AudibleFromFather && c->isIn(travContext.ListenerPos, _MaxEarDistance-travContext.Dist)) { float minDist; CVector nearPos; CAABBox box = c->getBBox(); minDist = getAABoxNearestPos(box, travContext.ListenerPos, nearPos); if (travContext.Dist + minDist < _MaxEarDistance) { CClusterSoundStatus css; css.Gain = travContext.Gain; css.Dist = travContext.Dist + minDist; css.DistFactor = css.Dist / _MaxEarDistance; css.Occlusion = travContext.Occlusion; css.OcclusionLFFactor = travContext.OcclusionLFFactor; css.OcclusionRoomRatio = travContext.OcclusionRoomRatio; css.Obstruction = travContext.Obstruction; /* if (travContext.NbPortal == 0) css.Direction = (nearPos - travContext.ListenerPos).normed(); else css.Direction = travContext.Direction1; */ float alpha = travContext.Alpha; CVector d1(travContext.Direction1), d2; css.Direction = interpolateSourceDirection(travContext, css.Dist+travContext.Dist, nearPos, travContext.ListenerPos /*realListener*/, d1, d2, alpha); css.Position = nearPos + css.Dist * css.Direction; css.PosAlpha = min(1.0f, css.Dist / _PortalInterpolate); if (addAudibleCluster(c, css)) { // debugLines.push_back(CLine(travContext.ListenerPos, nearPos)); CSoundTravContext stc(travContext); stc.FilterUnvisibleChild = true; stc.Direction1 = d1; stc.Direction2 = d2; stc.Direction = css.Direction; stc.PreviousCluster = cluster; stc.Alpha = alpha; stc.PreviousVector = (nearPos - travContext.ListenerPos).normed(); addNextTraverse(c, stc); _AudioPath.push_back(make_pair(travContext.ListenerPos, nearPos)); } } } } } // 3nd, look in father cluster if (cluster->Father && cluster->Father != travContext.PreviousCluster && cluster->FatherAudible) { // if (!travContext.FilterUnvisibleFather || ((1.0f-travContext.Alpha) > travContext.MinGain)) { CCluster *c = cluster->Father; float minDist; CVector nearPos; CAABBox box = c->getBBox(); if (c != _RootCluster) minDist = getAABoxNearestPos(box, travContext.ListenerPos, nearPos); else { // special case for root cluster coz it have a zero sized box and a zero position. nearPos = travContext.ListenerPos; minDist = 0; } CClusterSoundStatus css; css.Gain = travContext.Gain; /* if (travContext.FilterUnvisibleFather) { // compute a gain float alpha = 1-(travContext.Dist / _PortalInterpolate); alpha = alpha * alpha * alpha; css.Gain = max(0.0f, alpha); } else css.Gain = travContext.Gain; */ // if (c->Name == "cluster_1") // nldebug("Cluster 1 : gain = %f", css.Gain); float alpha = travContext.Alpha; CVector d1(travContext.Direction1), d2; css.Direction = interpolateSourceDirection(travContext, travContext.Dist, nearPos, travContext.ListenerPos /*realListener*/, d1, d2, alpha); if (css.Gain > _MinGain) { css.Dist = travContext.Dist; // css.Direction = CVector::Null; css.DistFactor = css.Dist / _MaxEarDistance; css.Occlusion = travContext.Occlusion; css.OcclusionLFFactor = travContext.OcclusionLFFactor; css.OcclusionRoomRatio = travContext.OcclusionRoomRatio; css.Obstruction = travContext.Obstruction; css.Position = nearPos + css.Dist * css.Direction; css.PosAlpha = min(1.0f, css.Dist / _PortalInterpolate); if (addAudibleCluster(c, css)) { CSoundTravContext stc(travContext); stc.FilterUnvisibleFather = true; stc.PreviousCluster = cluster; stc.Direction1 = d1; stc.Direction2 = d2; stc.Direction = css.Direction; stc.Alpha = alpha; stc.PreviousVector = (nearPos - travContext.ListenerPos).normed(); _NextTraversalStep.insert(make_pair(c, stc)); } } } } curClusters.pop_back(); } } while (!_NextTraversalStep.empty()); }

void NLSOUND::CClusteredSound::update (  const NLMISC::CVector &  listenerPos, const NLMISC::CVector &  view, const NLMISC::CVector &  up )

Update the cluster sound system. css.DistFactor*css.DistFactor Definition at line 270 of file clustered_sound.cpp. References _AudibleClusters, _IdToEaxEnv, _RootCluster, _SoundGroupToSound, NLSOUND::CClusteredSound::CClusterSoundStatus::Direction, NLSOUND::CClusteredSound::CClusterSoundStatus::Dist, NLSOUND::CClusteredSound::CClusterSound::Distance, NLSOUND::CClusteredSound::CClusterSoundStatus::DistFactor, EAXLISTENER_MAXENVIRONMENTSIZE, NLSOUND::CClusteredSound::CClusterSoundStatus::Gain, NL3D::CScene::getClipTrav(), NLMISC::CAABBox::getHalfSize(), NLSOUND::CAudioMixerUser::getListener(), H_AUTO, min, NLMISC::minof(), nldebug, nlwarning, NLSOUND::IListener::setEnvironment(), NLSOUND::USource::setLooping(), NLSOUND::USource::setPos(), NLSOUND::USource::setRelativeGain(), size, soundTraverse(), NLSOUND::CClusteredSound::CClusterSound::Source, uint, NLMISC::CVector::x, NLMISC::CVector::y, and NLMISC::CVector::z. Referenced by NLSOUND::CAudioMixerUser::update(). { H_AUTO(NLSOUND_ClusteredSoundUpdate) if (_Scene == 0) { // hum... what to do ? static bool bDisplayOnce = false; if (!bDisplayOnce) { nlwarning("CClusteredSound::update : no scene specified !"); bDisplayOnce = true; } return; } CClipTrav &clipTrav = _Scene->getClipTrav (); // Retreive the list of cluster where the listener is vector<CCluster*> vCluster; clipTrav.fullSearch (vCluster, clipTrav.RootCluster->Group, listenerPos); // reset the audible cluster map _AudibleClusters.clear(); // create the initial travesal context CSoundTravContext stc(listenerPos, false, false); // and start the cluster traversal to find out what cluster is audible and how we ear it soundTraverse(vCluster, stc); //----------------------------------------------------- // update the clustered sound (create and stop sound) //----------------------------------------------------- std::hash_map<uint, CClusterSound> newSources; { // fake the distance for all playing source // std::map<std::string, CClusterSound>::iterator first(_Sources.begin()), last(_Sources.end()); std::hash_map<NLMISC::TStringId, CClusterSound>::iterator first(_Sources.begin()), last(_Sources.end()); for (; first != last; ++first) { first->second.Distance = FLT_MAX; } } TClusterStatusMap::const_iterator first(_AudibleClusters.begin()), last(_AudibleClusters.end()); for (; first != last; ++first ) { static NLMISC::TStringId NO_SOUND_GROUP = CStringMapper::emptyId(); const CClusterSoundStatus &css = first->second; CCluster *cluster = first->first; NLMISC::TStringId soundGroup; soundGroup = cluster->getSoundGroupId(); if (soundGroup != NO_SOUND_GROUP) { // search an associated sound name std::hash_map<NLMISC::TStringId, CClusterSound>::iterator it(_Sources.find(soundGroup)); if (it != _Sources.end()) { // the source is already playing, check and replace if needed CClusterSound &cs = it->second; if (cs.Distance >= css.Dist) { // this one is better ! cs.Distance = css.Dist; cs.Source->setPos(listenerPos + css.Direction * css.Dist + CVector(0,0,2)); if (css.DistFactor < 1.0f) cs.Source->setRelativeGain(css.Gain * (1.0f - (css.DistFactor*css.DistFactor*css.DistFactor*css.DistFactor))); else cs.Source->setRelativeGain(css.Gain); } newSources.insert(make_pair(soundGroup, cs)); } else { // create a new source // nldebug("Searching sound assoc for group [%s]", CStringMapper::unmap(soundGroup).c_str()); std::hash_map<NLMISC::TStringId, NLMISC::TStringId>::iterator it2(_SoundGroupToSound.find(soundGroup)); if (it2 != _SoundGroupToSound.end()) { NLMISC::TStringId soundName = it2->second; CClusterSound cs; nldebug("Found the sound [%s] for sound group [%s]", CStringMapper::unmap(soundName).c_str(), CStringMapper::unmap(soundGroup).c_str()); cs.Distance = css.Dist; cs.Source = CAudioMixerUser::instance()->createSource(soundName, false, NULL, NULL, cluster); if (cs.Source != 0) { cs.Source->setPos(listenerPos + css.Direction * css.Dist + CVector(0,0,2)); if (css.DistFactor < 1.0f) cs.Source->setRelativeGain(css.Gain * (1.0f - (css.DistFactor*css.DistFactor))); else cs.Source->setRelativeGain(css.Gain); cs.Source->setLooping(true); newSources.insert(make_pair(soundGroup, cs)); } } } } } // check for source to stop { #if _STLPORT_VERSION >= 0x450 std::hash_map<NLMISC::TStringId, CClusterSound> oldSources; oldSources.swap(_Sources); #else // there is a bug in the swap methode in stlport 4.5, so fallback to a // very less effective create by copy and clear. std::hash_map<NLMISC::TStringId, CClusterSound> oldSources(_Sources); _Sources.clear(); #endif std::hash_map<uint, CClusterSound>::iterator first(newSources.begin()), last(newSources.end()); for (; first != last; ++first) { _Sources.insert(*first); if (!first->second.Source->isPlaying()) first->second.Source->play(); oldSources.erase(first->first); } while (!oldSources.empty()) { CClusterSound &cs = oldSources.begin()->second; delete cs.Source; oldSources.erase(oldSources.begin()); } } // update the environnement effect (if any) if (!vCluster.empty()) { H_AUTO(NLSOUND_ClusteredSound_updateEnvFx) CAudioMixerUser *mixer = CAudioMixerUser::instance(); TStringId fxId = vCluster[0]->getEnvironmentFxId(); IListener *drvListener = static_cast<CListenerUser*>(mixer->getListener())->getListener(); const CAABBox &box = vCluster[0]->getBBox(); CVector vsize = box.getHalfSize(); float size = NLMISC::minof(vsize.x, vsize.y, vsize.z) * 2; // special case for root cluster (ie, external) if (vCluster[0] == _RootCluster) { // this is the root cluster. This cluster have a size of 0 ! size = EAXLISTENER_MAXENVIRONMENTSIZE; } else { // else, clip the env size to max eax supported size size = min(size, EAXLISTENER_MAXENVIRONMENTSIZE); } uint newEnv; // retreive the EAX environment number std::hash_map<NLMISC::TStringId, uint>::iterator it(_IdToEaxEnv.find(fxId)); if (it != _IdToEaxEnv.end()) { // there is an EAX effect newEnv = it->second; } else { // no effect, default to "PLAIN" effect static TStringId plain = CStringMapper::map("PLAIN"); newEnv = _IdToEaxEnv[plain]; } // only update environement if there is some change. if (newEnv != _LastEnv) { drvListener->setEnvironment(newEnv, size); _LastEnv = newEnv; } } }

---

Field Documentation

TClusterStatusMap NLSOUND::CClusteredSound::_AudibleClusters [private]

The current audible cluster. Definition at line 252 of file clustered_sound.h. Referenced by addAudibleCluster(), getAudibleClusters(), getClusterSoundStatus(), soundTraverse(), and update().

std::vector<std::pair<NLMISC::CVector, NLMISC::CVector> > NLSOUND::CClusteredSound::_AudioPath [private]

The segment of all the audio path. Definition at line 258 of file clustered_sound.h. Referenced by getAudioPath(), and soundTraverse().

char * NLSOUND::CClusteredSound::_EnvironmentNames [static, private]

Initial value: { "GENERIC", "PADDEDCELL", "ROOM", "BATHROOM", "LIVINGROOM", "STONEROOM", "AUDITORIUM", "CONCERTHALL", "CAVE", "ARENA", "HANGAR", "CARPETEDHALLWAY", "HALLWAY", "STONECORRIDOR", "ALLEY", "FOREST", "CITY", "MOUNTAINS", "QUARRY", "PLAIN", "PARKINGLOT", "SEWERPIPE", "UNDERWATER", "DRUGGED", "DIZZY", "PSYCHOTIC", NULL } The environment name table for init. Definition at line 51 of file clustered_sound.cpp. Referenced by CClusteredSound().

std::hash_map<NLMISC::TStringId, uint> NLSOUND::CClusteredSound::_IdToEaxEnv [private]

The mapping for env name Id to EAX environement number. Definition at line 267 of file clustered_sound.h. Referenced by CClusteredSound(), and update().

std::hash_map<NLMISC::TStringId, uint> NLSOUND::CClusteredSound::_IdToMaterial [private]

The mapping for occlusion material name to material number. Definition at line 269 of file clustered_sound.h. Referenced by CClusteredSound(), and soundTraverse().

uint NLSOUND::CClusteredSound::_LastEnv [private]

The last setted environement. Definition at line 256 of file clustered_sound.h.

char * NLSOUND::CClusteredSound::_MaterialNames [static, private]

Initial value: { "SINGLEWINDOW", "DOUBLEWINDOW", "THINDOOR", "THICKDOOR", "WOODWALL", "BRICKWALL", "STONEWALL", "CURTAIN", NULL } The material name table for init. Definition at line 81 of file clustered_sound.cpp. Referenced by CClusteredSound().

float NLSOUND::CClusteredSound::_MaxEarDistance [private]

Maximum earing distance. Definition at line 244 of file clustered_sound.h. Referenced by addAudibleCluster(), init(), and soundTraverse().

float NLSOUND::CClusteredSound::_MinGain [private]

Minimum gain. Definition at line 246 of file clustered_sound.h. Referenced by init(), and soundTraverse().

TClusterTravContextMap NLSOUND::CClusteredSound::_NextTraversalStep [private]

The cluster for the next travesal step. Definition at line 254 of file clustered_sound.h. Referenced by addNextTraverse(), and soundTraverse().

float NLSOUND::CClusteredSound::_PortalInterpolate [private]

Interpolation distance when listener is near a portal. Definition at line 242 of file clustered_sound.h. Referenced by init(), interpolateSourceDirection(), and soundTraverse().

NL3D::CCluster* NLSOUND::CClusteredSound::_RootCluster [private]

The root cluster of the scene. Definition at line 248 of file clustered_sound.h. Referenced by init(), soundTraverse(), and update().

NL3D::CScene* NLSOUND::CClusteredSound::_Scene [private]

The scene of interest. Definition at line 240 of file clustered_sound.h.

std::hash_map<NLMISC::TStringId, NLMISC::TStringId> NLSOUND::CClusteredSound::_SoundGroupToSound [private]

The sound_group to sound assoc. Definition at line 264 of file clustered_sound.h. Referenced by init(), and update().

std::hash_map<NLMISC::TStringId, CClusterSound> NLSOUND::CClusteredSound::_Sources [private]

The current cluster playing source indexed with sound group id. Definition at line 261 of file clustered_sound.h.

---

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

• clustered_sound.h
• clustered_sound.cpp

---