NLSOUND::CSoundDriverDSound Class Reference

#include <sound_driver_dsound.h>

Inheritance diagram for NLSOUND::CSoundDriverDSound:

Public Member Functions
virtual void	commit3DChanges ()
	Commit all the changes made to 3D settings of listener and sources.
uint	countHw2DBuffers ()
	Count the number of available hardware streaming 2D buffers.
uint	countHw3DBuffers ()
	Count the number of available hardware streaming 3D buffers.
virtual uint	countMaxSources ()
	Return the maximum number of sources that can created.
uint	countPlayingSources ()
	Count the number of sources that are actually playing.
virtual IBuffer *	createBuffer ()
	Create a sound buffer.
virtual IListener *	createListener ()
	Create the listener instance.
virtual ISource *	createSource ()
	Create a source.
	CSoundDriverDSound ()
	Constructor.
float	getGain ()
	Get the gain.
IStringMapperProvider *	getStringMapper ()
	Return the string mapper.
virtual bool	init (HWND wnd, bool useEax, IStringMapperProvider *stringMapper)
	Initialization.
virtual bool	readRawBuffer (IBuffer *destbuffer, const std::string &name, uint8 *rawData, uint dataSize, TSampleFormat format, uint32 frequency)
virtual bool	readWavBuffer (IBuffer *destbuffer, const std::string &name, uint8 *wavData, uint dataSize)
	Load a wave file in to the buffer.
void	setGain (float gain)
void	update ()
	Update all the driver and its sources. To be called only by the timer callback.
void	writeProfile (std::ostream &out)
	Write information about the driver to the output stream.
virtual	~CSoundDriverDSound ()
Static Public Member Functions
ISoundDriver *	createDriver (bool useEax, IStringMapperProvider *stringMapper)
CSoundDriverDSound *	instance ()
	Return the instance of the singleton.
Static Public Attributes
const uint32	InterfaceVersion = 0x08
	Version of the driver interface. To increment when the interface change.
Private Member Functions
friend	CBufferDSound::~CBufferDSound ()
friend	CSourceDSound::~CSourceDSound ()
virtual void	displayBench (NLMISC::CLog *log)
virtual void	endBench ()
virtual void	removeBuffer (IBuffer *buffer)
	Remove a buffer (should be called by the friend destructor of the buffer class).
virtual void	removeSource (ISource *source)
	Remove a source (should be called by the friend destructor of the source class).
virtual void	startBench ()
Static Private Member Functions
void CALLBACK	TimerCallback (UINT uID, UINT uMsg, DWORD dwUser, DWORD dw1, DWORD dw2)
Private Attributes
DSCAPS	_Caps
LPDIRECTSOUND8	_DirectSound
LPDIRECTSOUNDBUFFER	_PrimaryBuffer
uint	_SourceCount
std::set< CSourceDSound * >	_Sources
IStringMapperProvider *	_StringMapper
	The string mapper provided by client code.
UINT	_TimerID
uint32	_TimerResolution
bool	_UseEAX
	The EAX support is requested and accepted (ie, there is enougth hardware 3D buffer).
Static Private Attributes
CSoundDriverDSound *	_Instance = NULL
uint32	_TimerPeriod = 100

---

Constructor & Destructor Documentation

NLSOUND::CSoundDriverDSound::CSoundDriverDSound (   )

Constructor.

NLSOUND::CSoundDriverDSound::~CSoundDriverDSound (   )  [virtual]

Definition at line 561 of file sound_driver_dsound.cpp. References _DirectSound, _PrimaryBuffer, _TimerID, _TimerResolution, and nldebug. { nldebug("Destroying DirectSound driver"); if (_TimerID != NULL) { timeKillEvent(_TimerID); timeEndPeriod(_TimerResolution); } // Assure that the remaining sources have released all their DSBuffers // before closing down DirectSound set<CSourceDSound*>::iterator iter; for (iter = _Sources.begin(); iter != _Sources.end(); iter++) { (*iter)->release(); } // Assure that the listener has released all resources before closing // down DirectSound if (CListenerDSound::instance() != 0) { CListenerDSound::instance()->release(); } if (_PrimaryBuffer != NULL) { _PrimaryBuffer->Release(); _PrimaryBuffer = NULL; } if (_DirectSound != NULL) { _DirectSound->Release(); _DirectSound = NULL; } _Instance = 0; // free the enumerated list if (CDeviceDescription::_List) { delete CDeviceDescription::_List; CDeviceDescription::_List = NULL; } }

NLSOUND::CSoundDriverDSound::CBufferDSound::~CBufferDSound (   )  [private]

NLSOUND::CSoundDriverDSound::CSourceDSound::~CSourceDSound (   )  [private]

---

Member Function Documentation

void NLSOUND::CSoundDriverDSound::commit3DChanges (   )  [virtual]

Commit all the changes made to 3D settings of listener and sources. Implements NLSOUND::ISoundDriver. Definition at line 886 of file sound_driver_dsound.cpp. References NLSOUND::CListenerDSound::commit3DChanges(), and NLSOUND::CListenerDSound::getPos(). { CListenerDSound* listener = CListenerDSound::instance(); listener->commit3DChanges(); const CVector &origin = listener->getPos(); set<CSourceDSound*>::iterator iter; // We handle the volume of the source according to the distance // ourselves. Call updateVolume() to, well..., update the volume // according to, euh ..., the new distance! for (iter = _Sources.begin(); iter != _Sources.end(); iter++) { if ((*iter)->isPlaying()) { (*iter)->updateVolume(origin); } } }

uint NLSOUND::CSoundDriverDSound::countHw2DBuffers (   )

Count the number of available hardware streaming 2D buffers. Definition at line 779 of file sound_driver_dsound.cpp. References _DirectSound, and uint. Referenced by countMaxSources(), NLSOUND::CSourceDSound::init(), and init(). { DSCAPS caps; caps.dwSize = sizeof(caps); if (_DirectSound->GetCaps(&caps) != DS_OK) { throw ESoundDriver("Failed to query the sound device caps"); } return caps.dwFreeHwMixingStreamingBuffers; }

uint NLSOUND::CSoundDriverDSound::countHw3DBuffers (   )

Count the number of available hardware streaming 3D buffers. Definition at line 764 of file sound_driver_dsound.cpp. References _DirectSound, and uint. Referenced by countMaxSources(), NLSOUND::CSourceDSound::init(), and init(). { DSCAPS caps; caps.dwSize = sizeof(caps); if (_DirectSound->GetCaps(&caps) != DS_OK) { throw ESoundDriver("Failed to query the sound device caps"); } return caps.dwFreeHw3DStreamingBuffers; }

uint NLSOUND::CSoundDriverDSound::countMaxSources (   )  [virtual]

Return the maximum number of sources that can created. Implements NLSOUND::ISoundDriver. Definition at line 613 of file sound_driver_dsound.cpp. References countHw2DBuffers(), countHw3DBuffers(), and uint. { // Try the hardware 3d buffers first uint n = countHw3DBuffers(); if (n > 0) { return n; } // If not, try the hardware 2d buffers first n = countHw2DBuffers(); if (n > 0) { return n; } // Okay, we'll use 32 software buffers return 32; }

uint NLSOUND::CSoundDriverDSound::countPlayingSources (   )

Count the number of sources that are actually playing. Definition at line 911 of file sound_driver_dsound.cpp. References uint. Referenced by writeProfile(). { uint n = 0; set<CSourceDSound*>::iterator iter; for (iter = _Sources.begin(); iter != _Sources.end(); iter++) { if ((*iter)->isPlaying()) { n++; } } return n; }

IBuffer * NLSOUND::CSoundDriverDSound::createBuffer (   )  [virtual]

Create a sound buffer. Implements NLSOUND::ISoundDriver. Definition at line 820 of file sound_driver_dsound.cpp. References _PrimaryBuffer. { NL_ALLOC_CONTEXT(NLSOUND_CSoundDriverDSound); if (_PrimaryBuffer == 0) { throw ESoundDriver("Corrupt driver"); } // FIXME: set buffer ID return new CBufferDSound(); }

ISoundDriver * NLSOUND::ISoundDriver::createDriver (  bool  useEax, IStringMapperProvider *  stringMapper )  [static, inherited]

The static method which builds the sound driver instance In case of failure, can throw one of these ESoundDriver exception objects: ESoundDriverNotFound, ESoundDriverCorrupted, ESoundDriverOldVersion, ESoundDriverUnknownVersion You can request support for EAX. If EAX is requested and if there is enougth hardware buffer replay, then only hardware buffer are created when calling createBuffer. If the number of available hardware buffer is less than 10, then EAX is ignored. Definition at line 61 of file sound_driver.cpp. References buffer, NLSOUND::ISDRV_CREATE_PROC, NLSOUND::ISDRV_VERSION_PROC, nlinfo, and nlwarning. { ISDRV_CREATE_PROC createSoundDriver = NULL; ISDRV_VERSION_PROC versionDriver = NULL; #ifdef NL_OS_WINDOWS // WINDOWS code. HINSTANCE hInst; hInst = LoadLibrary(NLSOUND_DLL_NAME); if (!hInst) { throw ESoundDriverNotFound(); } char buffer[1024], *ptr; SearchPath (NULL, NLSOUND_DLL_NAME, NULL, 1023, buffer, &ptr); nlinfo ("Using the library '"NLSOUND_DLL_NAME"' that is in the directory: '%s'", buffer); createSoundDriver = (ISDRV_CREATE_PROC) GetProcAddress (hInst, IDRV_CREATE_PROC_NAME); if (createSoundDriver == NULL) { nlinfo( "Error: %u", GetLastError() ); throw ESoundDriverCorrupted(); } versionDriver = (ISDRV_VERSION_PROC) GetProcAddress (hInst, IDRV_VERSION_PROC_NAME); if (versionDriver != NULL) { if (versionDriver()<ISoundDriver::InterfaceVersion) throw ESoundDriverOldVersion(); else if (versionDriver()>ISoundDriver::InterfaceVersion) throw ESoundDriverUnknownVersion(); } #elif defined (NL_OS_UNIX) // Unix code void *handle = dlopen(NLSOUND_DLL_NAME, RTLD_NOW); if (handle == NULL) { nlwarning ("when loading dynamic library '%s': %s", NLSOUND_DLL_NAME, dlerror()); throw ESoundDriverNotFound(); } /* Not ANSI. Might produce a warning */ createSoundDriver = (ISDRV_CREATE_PROC) dlsym (handle, IDRV_CREATE_PROC_NAME); if (createSoundDriver == NULL) { nlwarning ("when getting function in dynamic library '%s': %s", NLSOUND_DLL_NAME, dlerror()); throw ESoundDriverCorrupted(); } versionDriver = (ISDRV_VERSION_PROC) dlsym (handle, IDRV_VERSION_PROC_NAME); if (versionDriver != NULL) { if (versionDriver()<ISoundDriver::InterfaceVersion) throw ESoundDriverOldVersion(); else if (versionDriver()>ISoundDriver::InterfaceVersion) throw ESoundDriverUnknownVersion(); } #else // NL_OS_UNIX #error "Dynamic DLL loading not implemented!" #endif // NL_OS_UNIX ISoundDriver *ret = createSoundDriver(useEax, stringMapper); if ( ret == NULL ) { throw ESoundDriverCantCreateDriver(); } return ret; }

IListener * NLSOUND::CSoundDriverDSound::createListener (   )  [virtual]

Create the listener instance. Implements NLSOUND::ISoundDriver. Definition at line 794 of file sound_driver_dsound.cpp. References _PrimaryBuffer, and nlwarning. { NL_ALLOC_CONTEXT(NLSOUND_CSoundDriverDSound); LPDIRECTSOUND3DLISTENER8 dsoundListener; if (CListenerDSound::instance() != NULL) { return CListenerDSound::instance(); } if (_PrimaryBuffer == 0) { throw ESoundDriver("Corrupt driver"); } if (FAILED(_PrimaryBuffer->QueryInterface(IID_IDirectSound3DListener, (LPVOID *) &dsoundListener))) { nlwarning("The 3D listener interface is not available."); return new CListenerDSound(NULL); } return new CListenerDSound(dsoundListener); }

ISource * NLSOUND::CSoundDriverDSound::createSource (   )  [virtual]

Create a source. Implements NLSOUND::ISoundDriver. Definition at line 860 of file sound_driver_dsound.cpp. References _DirectSound, _PrimaryBuffer, _UseEAX, and src. { NL_ALLOC_CONTEXT(NLSOUND_CSoundDriverDSound); if (_PrimaryBuffer == 0) { throw ESoundDriver("Corrupt driver"); } CSourceDSound* src = new CSourceDSound(0); src->init(_DirectSound, _UseEAX); _Sources.insert(src); return src; }

void NLSOUND::CSoundDriverDSound::displayBench (  NLMISC::CLog *  log  )  [private, virtual]

Implements NLSOUND::ISoundDriver. Definition at line 1064 of file sound_driver_dsound.cpp. References NLMISC::CHTimer::display(), NLMISC::CHTimer::displayByExecutionPath(), NLMISC::CHTimer::displayHierarchical(), and NLMISC::CHTimer::displayHierarchicalByExecutionPathSorted(). { NLMISC::CHTimer::displayHierarchicalByExecutionPathSorted(log, CHTimer::TotalTime, true, 48, 2); NLMISC::CHTimer::displayHierarchical(log, true, 48, 2); NLMISC::CHTimer::displayByExecutionPath(log, CHTimer::TotalTime); NLMISC::CHTimer::display(log, CHTimer::TotalTime); }

void NLSOUND::CSoundDriverDSound::endBench (   )  [private, virtual]

Implements NLSOUND::ISoundDriver. Definition at line 1060 of file sound_driver_dsound.cpp. References NLMISC::CHTimer::endBench(). { NLMISC::CHTimer::endBench(); }

float NLSOUND::CSoundDriverDSound::getGain (   )

Get the gain. Definition at line 962 of file sound_driver_dsound.cpp. References _PrimaryBuffer, and nldebug. { if (_PrimaryBuffer != 0) { /* convert from hundredths of decibels to linear amplitude */ LONG volume; HRESULT hr = _PrimaryBuffer->GetVolume(&volume); if (hr != DS_OK) { nldebug("Failed to get the volume"); return 1.0; } return (float) pow(10, (double) volume / 20.0 / 100.0); } return 1.0; }

IStringMapperProvider* NLSOUND::CSoundDriverDSound::getStringMapper (   )  [inline]

Return the string mapper. Definition at line 112 of file sound_driver_dsound.h. References _StringMapper. {return _StringMapper;}

bool NLSOUND::CSoundDriverDSound::init (  HWND  wnd, bool  useEax, IStringMapperProvider *  stringMapper )  [virtual]

Initialization. Definition at line 318 of file sound_driver_dsound.cpp. References _Caps, _DirectSound, _PrimaryBuffer, _StringMapper, _TimerID, _TimerPeriod, _TimerResolution, _UseEAX, countHw2DBuffers(), countHw3DBuffers(), NLSOUND::CSoundDriverDSoundEnumCallback(), format, nldebug, nlwarning, res, uint, and uint32. { _StringMapper = stringMapper; if (FAILED(DirectSoundEnumerate(CSoundDriverDSoundEnumCallback, this))) { throw ESoundDriver("Failed to enumerate the DirectSound devices"); } // Create a DirectSound object and set the cooperative level. if (useEax) { if (EAXDirectSoundCreate8(NULL, &_DirectSound, NULL) != DS_OK) { throw ESoundDriver("Failed to create the DirectSound object from EAX proxy funtion"); } } else { if (DirectSoundCreate8(NULL, &_DirectSound, NULL) != DS_OK) { throw ESoundDriver("Failed to create the DirectSound object"); } } if (_DirectSound->SetCooperativeLevel(wnd, DSSCL_PRIORITY) != DS_OK) { throw ESoundDriver("Failed to set the cooperative level"); } // Analyse the capabilities of the sound driver/device _Caps.dwSize = sizeof(_Caps); if (_DirectSound->GetCaps(&_Caps) != DS_OK) { throw ESoundDriver("Failed to query the sound device caps"); } // Create primary buffer DSBUFFERDESC desc; ZeroMemory(&desc, sizeof(DSBUFFERDESC)); desc.dwSize = sizeof(DSBUFFERDESC); // First, try to allocate a 3D hardware buffer. // If we can't get a 3D hardware buffer, use a 2D hardware buffer. // As last option, use a 2D software buffer. // check if wa can honor eax request if (countHw3DBuffers() > 10) { _UseEAX = useEax; } else { // not enougth hardware buffer, can't use eax _UseEAX = false; } if (countHw3DBuffers() > 0) { nldebug("Primary buffer: Allocating 3D buffer in hardware"); desc.dwFlags = DSBCAPS_PRIMARYBUFFER | DSBCAPS_LOCHARDWARE | DSBCAPS_CTRL3D | DSBCAPS_CTRLVOLUME; } else { nldebug("Primary buffer: Allocating 3D buffer in software"); desc.dwFlags = DSBCAPS_PRIMARYBUFFER | DSBCAPS_LOCSOFTWARE | DSBCAPS_CTRL3D | DSBCAPS_CTRLVOLUME; // desc.guid3DAlgorithm = DS3DALG_NO_VIRTUALIZATION; } HRESULT res = _DirectSound->CreateSoundBuffer(&desc, &_PrimaryBuffer, NULL); if (res != DS_OK && res != DS_NO_VIRTUALIZATION) { nlwarning("Primary buffer: Failed to create a buffer with 3D capabilities."); ZeroMemory(&desc, sizeof(DSBUFFERDESC)); desc.dwSize = sizeof(DSBUFFERDESC); if (countHw2DBuffers() > 0) { nldebug("Primary buffer: Allocating 2D buffer in hardware"); desc.dwFlags = DSBCAPS_PRIMARYBUFFER | DSBCAPS_LOCHARDWARE | DSBCAPS_CTRLVOLUME; } else { nldebug("Primary buffer: Allocating 2D buffer in software"); desc.dwFlags = DSBCAPS_PRIMARYBUFFER | DSBCAPS_LOCSOFTWARE | DSBCAPS_CTRLVOLUME; } if (_DirectSound->CreateSoundBuffer(&desc, &_PrimaryBuffer, NULL) != DS_OK) { throw ESoundDriver("Failed to create the primary buffer"); } } // Set the format of the primary buffer WAVEFORMATEX format; format.cbSize = sizeof(WAVEFORMATEX); // Make sure the sound card accepts the default settings. // For now, only the default settings are accepted. Fallback // strategy will be handled later. if ((_Caps.dwMinSecondarySampleRate > 22050) && (22050 > _Caps.dwMaxSecondarySampleRate)) { throw ESoundDriver("Unsupported sample rate range"); } if ((_Caps.dwFlags & DSCAPS_PRIMARY16BIT) == 0) { throw ESoundDriver("Unsupported sample size [16bits]"); } format.wBitsPerSample = 16; format.nChannels = 1; format.nSamplesPerSec = 22050; format.nBlockAlign = format.nChannels * format.wBitsPerSample / 8; format.nAvgBytesPerSec = format.nSamplesPerSec * format.nBlockAlign; format.wFormatTag = WAVE_FORMAT_PCM; if (_PrimaryBuffer->SetFormat(&format) != DS_OK) { throw ESoundDriver("Failed to create set the format of the primary buffer"); } // Fill the buffer with silence /* LPVOID ptr; DWORD bytes; HRESULT hr = _PrimaryBuffer->Lock(0, 0, &ptr, &bytes, NULL, NULL, DSBLOCK_ENTIREBUFFER); if (FAILED(hr)) { switch (hr) { case DSERR_BUFFERLOST: throw ESoundDriver("Failed to lock the DirectSound primary buffer : DSERR_BUFFERLOST"); case DSERR_INVALIDCALL: throw ESoundDriver("Failed to lock the DirectSound primary buffer : DSERR_INVALIDCALL"); case DSERR_INVALIDPARAM: throw ESoundDriver("Failed to lock the DirectSound primary buffer : DSERR_INVALIDPARAM"); case DSERR_PRIOLEVELNEEDED: throw ESoundDriver("Failed to lock the DirectSound primary buffer : DSERR_PRIOLEVELNEEDED"); default: throw ESoundDriver("Failed to lock the DirectSound primary buffer : unkown error"); } } memset(ptr, 0, bytes); _PrimaryBuffer->Unlock(ptr, bytes, 0, 0); */ uint32 numBuffers = countHw3DBuffers(); if (numBuffers == 0) { numBuffers = 31; } /* _Sources = new CSourceDSound*[numBuffers]; for (uint i = 0; i < numBuffers; i++) { _Sources[i] = 0; } try { for (i = 0; i < numBuffers; i++) { _Sources[i] = new CSourceDSound(i); _Sources[i]->init(_DirectSound); _SourceCount++; } } catch (ESoundDriver& e) { // Okay, here's the situation: I'm listening to WinAmp while debugging. // The caps told me there were 31 buffers available. In reality, there were // only 30 available because WinAmp was using one. Somehow DirectSound didn't // notice. So when creating buffer 31, an exception was thrown. // If something like this happens, don't bother and go on with the buffers we've // got. If no buffers are created at all, throw the exception again. if (_Sources == 0) { throw e; } } */ TIMECAPS tcaps; timeGetDevCaps(&tcaps, sizeof(TIMECAPS)); _TimerResolution = (tcaps.wPeriodMin > 10)? tcaps.wPeriodMin : 10; timeBeginPeriod(_TimerResolution); #if NLSOUND_PROFILE for (uint i = 0; i < 1024; i++) { _TimerInterval[i] = 0; } _TimerDate = CTime::getPerformanceTime(); #endif _TimerID = timeSetEvent(_TimerPeriod, 0, &CSoundDriverDSound::TimerCallback, (DWORD)this, TIME_CALLBACK_FUNCTION | TIME_PERIODIC); if (_TimerID == NULL) { throw ESoundDriver("Failed to create the timer"); } return true; }

CSoundDriverDSound* NLSOUND::CSoundDriverDSound::instance (   )  [inline, static]

Return the instance of the singleton. Definition at line 55 of file sound_driver_dsound.h. { return _Instance; }

bool NLSOUND::CSoundDriverDSound::readRawBuffer (  IBuffer *  destbuffer, const std::string &  name, uint8 *  rawData, uint  dataSize, TSampleFormat  format, uint32  frequency )  [virtual]

Implements NLSOUND::ISoundDriver. Definition at line 852 of file sound_driver_dsound.cpp. References format, uint, uint32, and uint8. { return ((CBufferDSound*) destbuffer)->readRawBuffer(name, rawData, dataSize, format, frequency); }

bool NLSOUND::CSoundDriverDSound::readWavBuffer (  IBuffer *  destbuffer, const std::string &  name, uint8 *  wavData, uint  dataSize )  [virtual]

Load a wave file in to the buffer. Implements NLSOUND::ISoundDriver. Definition at line 847 of file sound_driver_dsound.cpp. References uint, and uint8. { return ((CBufferDSound*) destbuffer)->readWavBuffer(name, wavData, dataSize); }

void NLSOUND::CSoundDriverDSound::removeBuffer (  IBuffer *  buffer  )  [private, virtual]

Remove a buffer (should be called by the friend destructor of the buffer class). Implements NLSOUND::ISoundDriver. Definition at line 835 of file sound_driver_dsound.cpp. References buffer. { }

void NLSOUND::CSoundDriverDSound::removeSource (  ISource *  source  )  [private, virtual]

Remove a source (should be called by the friend destructor of the source class). Implements NLSOUND::ISoundDriver. Definition at line 879 of file sound_driver_dsound.cpp. { _Sources.erase((CSourceDSound*) source); }

void NLSOUND::CSoundDriverDSound::setGain (  float  gain  )

Set the gain (volume value inside [0 , 1]). (default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers Definition at line 930 of file sound_driver_dsound.cpp. References _PrimaryBuffer, and nldebug. { if (_PrimaryBuffer != 0) { if (gain < 0.00001f) { gain = 0.00001f; } /* convert from linear amplitude to hundredths of decibels */ LONG volume = (LONG)(100.0 * 20.0 * log10(gain)); if (volume < DSBVOLUME_MIN) { volume = DSBVOLUME_MIN; } else if (volume > DSBVOLUME_MAX) { volume = DSBVOLUME_MAX; } HRESULT hr = _PrimaryBuffer->SetVolume(volume); if (hr != DS_OK) { nldebug("Failed to set the volume"); } } }

void NLSOUND::CSoundDriverDSound::startBench (   )  [private, virtual]

Implements NLSOUND::ISoundDriver. Definition at line 1056 of file sound_driver_dsound.cpp. References NLMISC::CHTimer::startBench(). { NLMISC::CHTimer::startBench(); }

void CALLBACK NLSOUND::CSoundDriverDSound::TimerCallback (  UINT  uID, UINT  uMsg, DWORD  dwUser, DWORD  dw1, DWORD  dw2 )  [static, private]

Definition at line 679 of file sound_driver_dsound.cpp. References _TimerPeriod, NLMISC::CTime::getLocalTime(), NLMISC::TTime, and update(). { // a little speed check static NLMISC::TTime lastUpdate = NLMISC::CTime::getLocalTime(); NLMISC::TTime now = NLMISC::CTime::getLocalTime(); if (now - lastUpdate > _TimerPeriod * 2) { // nlwarning("CSoundDriverDSound::TimerCallback : no update since %u millisec (nominal update = %u", uint32(now-lastUpdate), uint32(_TimerPeriod)); } else { // nldebug("Callback delay = %u ms", uint32(now-lastUpdate)); } lastUpdate = now; CSoundDriverDSound* driver = (CSoundDriverDSound*) dwUser; driver->update(); }

void NLSOUND::CSoundDriverDSound::update (   )

Update all the driver and its sources. To be called only by the timer callback. Definition at line 703 of file sound_driver_dsound.cpp. References _TimerPeriod, NLMISC::CTime::getLocalTime(), H_AUTO, nlwarning, NLMISC::TTicks, NLMISC::TTime, and uint32. Referenced by TimerCallback(). { H_AUTO(NLSOUND_DSoundUpdate) #if NLSOUND_PROFILE TTicks tnow = CTime::getPerformanceTime(); #endif NLMISC::TTime now = NLMISC::CTime::getLocalTime(); set<CSourceDSound*>::iterator first(_Sources.begin()), last(_Sources.end()); for (;first != last; ++first) { if ((*first)->needsUpdate()) { if ((*first)->update()) { #if NLSOUND_PROFILE _UpdateSources++; #endif } } } /* set<CSourceDSound*>::iterator iter; iter = _Sources.begin(); if ((iter != _Sources.end()) && (*iter)->needsUpdate()) { while (iter != _Sources.end()) { // if ((*iter)->update2()) { if ((*iter)->update()) { #if NLSOUND_PROFILE _UpdateSources++; #endif } iter++; } } */ { NLMISC::TTime last = CTime::getLocalTime() - now; if (last > _TimerPeriod / 2) { nlwarning("CSoundDriverDSound::TimerCallback : update took %u millisec", (uint32)last); } } #if NLSOUND_PROFILE _TotalUpdateTime += 1000.0 * CTime::ticksToSecond(CTime::getPerformanceTime() - tnow); _UpdateCount++; #endif }

void NLSOUND::CSoundDriverDSound::writeProfile (  std::ostream &  out  )  [virtual]

Write information about the driver to the output stream. Implements NLSOUND::ISoundDriver. Definition at line 635 of file sound_driver_dsound.cpp. References _DirectSound, and countPlayingSources(). { // Write the available sound devices CDeviceDescription* list = CDeviceDescription::_List; while (list) { out << list->_Description << "\n"; list = list->_Next; } out << "\n"; // Write the buffers sizes out << "buffer size: " << (int)CSourceDSound::_SecondaryBufferSize << "\n"; out << "copy size: " << (int)CSourceDSound::_UpdateCopySize << "\n"; out << "swap size: " << (int)CSourceDSound::_SwapCopySize << "\n"; out << "\n"; // Write the number of hardware buffers DSCAPS caps; caps.dwSize = sizeof(caps); _DirectSound->GetCaps(&caps); cout << "3d hw buffers: " << caps.dwMaxHw3DAllBuffers << "\n"; cout << "2d hw buffers: " << caps.dwMaxHwMixingAllBuffers << "\n"; out << "\n"; // Write the number of hardware buffers #if NLSOUND_PROFILE out << "update time total --- " << getAverageUpdateTime()<< "\n"; out << "update time source --- " << CSourceDSound::getAverageUpdateTime() << "\n"; out << "update --- t: " << CSourceDSound::getAverageCumulTime(); out << " - p: " << CSourceDSound::getAveragePosTime(); out << " - l: " << CSourceDSound::getAverageLockTime(); out << " - c: " << CSourceDSound::getAverageCopyTime(); out << " - u: " << CSourceDSound::getAverageUnlockTime() << "\n"; out << "update percentage: --- " << getUpdatePercentage() << "\n"; out << "update num sources --- " << (int)getAverageUpdateSources() << "\n"; out << "update byte size --- " << CSourceDSound::getAverageUpdateSize() << "\n"; out << "swap time --- " << CSourceDSound::getTestAverage() << "\n"; out << "src --- " << countPlayingSources() << "\n"; #endif }

---

Field Documentation

DSCAPS NLSOUND::CSoundDriverDSound::_Caps [private]

Definition at line 151 of file sound_driver_dsound.h. Referenced by init().

LPDIRECTSOUND8 NLSOUND::CSoundDriverDSound::_DirectSound [private]

Definition at line 145 of file sound_driver_dsound.h. Referenced by countHw2DBuffers(), countHw3DBuffers(), createSource(), init(), writeProfile(), and ~CSoundDriverDSound().

CSoundDriverDSound * NLSOUND::CSoundDriverDSound::_Instance = NULL [static, private]

Definition at line 52 of file sound_driver_dsound.cpp.

LPDIRECTSOUNDBUFFER NLSOUND::CSoundDriverDSound::_PrimaryBuffer [private]

Definition at line 148 of file sound_driver_dsound.h. Referenced by createBuffer(), createListener(), createSource(), getGain(), init(), setGain(), and ~CSoundDriverDSound().

uint NLSOUND::CSoundDriverDSound::_SourceCount [private]

Definition at line 158 of file sound_driver_dsound.h.

std::set<CSourceDSound*> NLSOUND::CSoundDriverDSound::_Sources [private]

Definition at line 155 of file sound_driver_dsound.h.

IStringMapperProvider* NLSOUND::CSoundDriverDSound::_StringMapper [private]

The string mapper provided by client code. Definition at line 169 of file sound_driver_dsound.h. Referenced by getStringMapper(), and init().

UINT NLSOUND::CSoundDriverDSound::_TimerID [private]

Definition at line 161 of file sound_driver_dsound.h. Referenced by init(), and ~CSoundDriverDSound().

uint32 NLSOUND::CSoundDriverDSound::_TimerPeriod = 100 [static, private]

Definition at line 53 of file sound_driver_dsound.cpp. Referenced by init(), TimerCallback(), and update().

uint32 NLSOUND::CSoundDriverDSound::_TimerResolution [private]

Definition at line 164 of file sound_driver_dsound.h. Referenced by init(), and ~CSoundDriverDSound().

bool NLSOUND::CSoundDriverDSound::_UseEAX [private]

The EAX support is requested and accepted (ie, there is enougth hardware 3D buffer). Definition at line 167 of file sound_driver_dsound.h. Referenced by createSource(), and init().

const uint32 NLSOUND::ISoundDriver::InterfaceVersion = 0x08 [static, inherited]

Version of the driver interface. To increment when the interface change. Definition at line 48 of file sound_driver.cpp.

---

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

• sound_driver_dsound.h
• sound_driver_dsound.cpp

---