NLSOUND::CSourceDSound Class Reference

Keep trace of following states of the DirectSound buffer:

the buffer is being filled with samples (filling),
the buffer still contains samples but silence is being written (silencing),
the buffer contains no samples but only silence (silenced).

#include <source_dsound.h>

Classes
struct	TCursors
	The play and write cursors. More...
struct	TLockedBufferInfo
	A locked buffer info. More...
Public Member Functions
	CSourceDSound (uint sourcename=0)
	Constructor.
virtual	~CSourceDSound ()
	Destructor.
void	init (LPDIRECTSOUND directSound, bool useEax)
	Initialize the DirectSound buffers. Called by the sound driver only.
uint	sourceName ()
	Return the OpenAL source name.
IBuffer *	getBuffer ()
	Returns the buffer associated with this source.
void	reset ()
	Reset the source before reuse.
bool	update ()
	Update the source (e.g. continue to stream the data in).
void	updateVolume (const NLMISC::CVector &listener)
	Update the source's volume according to its distance and fade out curve.
Initialization

virtual void	setStreaming (bool streaming)
	Enable or disable streaming mode. Source must be stopped to call this.
virtual void	setStaticBuffer (IBuffer *buffer)
	Set the buffer that will be played (no streaming) If the buffer is stereo, the source mode becomes stereo and the source relative mode is on, otherwise the source is considered as a 3D source.
virtual IBuffer *	getStaticBuffer ()
	Return the buffer, or NULL if streaming is used. Not available for streaming.
virtual void	submitStreamingBuffer (IBuffer *buffer)
	Add a buffer to the streaming queue.
virtual uint	countStreamingBuffers () const
	Return the amount of buffers in the queue (playing and waiting). 3 buffers is optimal.
Playback control

virtual void	setLooping (bool l)
	Set looping on/off for future playbacks (default: off), not available for streaming.
virtual bool	getLooping () const
	Return the looping state.
virtual bool	play ()
	Play the static buffer (or stream in and play).
virtual void	stop ()
	Stop playing.
virtual void	pause ()
	Pause. Call play() to resume.
virtual bool	isPlaying () const
	Return true if play() or pause(), false if stop().
virtual bool	isStopped () const
	Return true if playing is finished or stop() has been called.
virtual bool	isPaused () const
	Return true if the playing source is paused.
virtual uint32	getTime ()
	Returns the number of milliseconds the source has been playing.
Source properties

virtual void	setPos (const NLMISC::CVector &pos, bool deffered=true)
	Set the position vector (default: (0,0,0)).
virtual const NLMISC::CVector &	getPos () const
	Get the position vector.
virtual void	setVelocity (const NLMISC::CVector &vel, bool deferred=true)
	Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).
virtual void	getVelocity (NLMISC::CVector &vel) const
	Get the velocity vector.
virtual void	setDirection (const NLMISC::CVector &dir)
	Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional).
virtual void	getDirection (NLMISC::CVector &dir) const
	Get the direction vector.
virtual void	setGain (float gain)
	Set the gain (volume value inside [0 , 1]).
virtual float	getGain () const
	Get the gain.
virtual void	setPitch (float pitch)
	Shift the frequency.
virtual float	getPitch () const
	Get the pitch.
virtual void	setSourceRelativeMode (bool mode)
	Set the source relative mode. If true, positions are interpreted relative to the listener position.
virtual bool	getSourceRelativeMode () const
	Get the source relative mode.
virtual void	setMinMaxDistances (float mindist, float maxdist, bool deferred=true)
	Set the min and max distances (default: 1, MAX_FLOAT) (3D mode only).
virtual void	getMinMaxDistances (float &mindist, float &maxdist) const
	Get the min and max distances.
virtual void	setCone (float innerAngle, float outerAngle, float outerGain)
	Set the cone angles (in radian) and gain (in [0 , 1]) (default: 2PI, 2PI, 0).
virtual void	getCone (float &innerAngle, float &outerAngle, float &outerGain) const
	Get the cone angles (in radian).
virtual void	setAlpha (double a)
	Set the alpha value for the volume-distance curve.
Direct output

virtual void	setDirect (bool enable=true)
	Enable or disable direct output [true/false], default: true.
virtual bool	getDirect () const
	Return if the direct output is enabled.
virtual void	setDirectGain (float gain)
	Set the gain for the direct path.
virtual float	getDirectGain () const
	Get the gain for the direct path.
virtual void	enableDirectFilter (bool enable=true)
	Enable or disable the filter for the direct channel.
virtual bool	isDirectFilterEnabled () const
	Check if the filter on the direct channel is enabled.
virtual void	setDirectFilter (TFilter filter, float lowFrequency, float highFrequency, float passGain)
	Set the filter parameters for the direct channel.
virtual void	getDirectFilter (TFilter &filterType, float &lowFrequency, float &highFrequency, float &passGain) const
	Get the filter parameters for the direct channel.
virtual void	setDirectFilterPassGain (float passGain)
	Set the direct filter gain.
virtual float	getDirectFilterPassGain () const
	Get the direct filter gain.
Effect output

virtual void	setEffect (IReverbEffect *reverbEffect)
	Set the effect send for this source, NULL to disable. [IEffect], default: NULL.
virtual IEffect *	getEffect () const
	Get the effect send for this source.
virtual void	setEffectGain (float gain)
	Set the gain for the effect path.
virtual float	getEffectGain () const
	Get the gain for the effect path.
virtual void	enableEffectFilter (bool enable=true)
	Enable or disable the filter for the effect channel.
virtual bool	isEffectFilterEnabled () const
	Check if the filter on the effect channel is enabled.
virtual void	setEffectFilter (TFilter filter, float lowFrequency, float highFrequency, float passGain)
	Set the filter parameters for the effect channel.
virtual void	getEffectFilter (TFilter &filterType, float &lowFrequency, float &highFrequency, float &passGain) const
	Get the filter parameters for the effect channel.
virtual void	setEffectFilterPassGain (float passGain)
	Set the effect filter gain.
virtual float	getEffectFilterPassGain () const
	Get the effect filter gain.
Static Public Member Functions
static double	getTestLast ()
static double	getTestMax ()
static double	getTestMin ()
static double	getTestAverage ()
static double	getAveragePosTime ()
static double	getAverageLockTime ()
static double	getAverageCopyTime ()
static double	getAverageUnlockTime ()
static double	getAverageCumulTime ()
static uint	getAverageUpdateSize ()
static double	getMaxUpdateTime ()
static double	getMinUpdateTime ()
static double	getAverageUpdateTime ()
static double	getTotalUpdateTime ()
static double	getUpdateBytesPerMsec ()
Static Public Attributes
static double	_LastSwapTime
static double	_TotalSwapTime
static double	_MaxSwapTime
static double	_MinSwapTime
static uint32	_SwapCount
static double	_TotalUpdateTime
static double	_MaxUpdateTime
static double	_MinUpdateTime
static uint32	_UpdateCount
static uint32	_TotalUpdateSize
static double	_PosTime
static double	_LockTime
static double	_CopyTime
static double	_UnlockTime
static uint32	_CopyCount
Private Types
enum	TSourceState { source_stoped, source_playing, source_silencing, source_swap_pending }
Private Member Functions
void	copySampleTo16BitsTrack (void dst, void src, uint nbSample, TSampleFormat sourceFormat)
void	release ()
	Release all DirectSound resources.
bool	lock (uint32 writePos, uint32 size, TLockedBufferInfo &lockedInfo)
bool	unlock (const TLockedBufferInfo &lockedInfo)
void	getCursors (TCursors &cursors)
uint32	checkFillCursor ()
void	fillData (const TLockedBufferInfo &lbi, int nbSample)
void	fillData (sint16 *dst, uint nbSample)
void	fillSilence (const TLockedBufferInfo &lbi, int nbSample)
void	xfade (const TLockedBufferInfo &lbi, sint16 *src)
void	fadeOut (const TLockedBufferInfo &lbi)
void	fadeIn (const TLockedBufferInfo &lbi)
void	advanceFill (TLockedBufferInfo &lbi, uint nbSample)
void	swap ()
bool	fill ()
bool	silence ()
void	crossFade ()
void	fadeOut ()
void	fadeIn ()
bool	needsUpdate ()
	Check whether the play position has advanced enough to require an update.
Private Attributes
uint	_SourceName
TSourceState	_State
IBuffer *	_Sample
uint	_SampleSize
uint	_SampleOffset
uint32	_PlayOffset
TSampleFormat	_Format
uint	_SampleFreq
float	_Freq
uint32	_SampleRate
IBuffer *	_NextSample
uint32	_LastPlayPos
uint32	_FillOffset
uint32	_SilenceWriten
bool	_Loop
LPDIRECTSOUNDBUFFER	_SecondaryBuffer
LPDIRECTSOUND3DBUFFER	_3DBuffer
CRITICAL_SECTION	_CriticalSection
IBuffer::TADPCMState	_ADPCMState
sint32	_Volume
float	_Gain
double	_Alpha
NLMISC::CVector	_Pos
bool	_PosRelative
LPKSPROPERTYSET	_EAXSource
Static Private Attributes
static const uint32	_UpdateCopySize = 0x4000
static const uint32	_SwapCopySize = 0x8000
static const uint	_DefaultChannels = 1
static const uint	_DefaultSampleRate = 22050
static const uint	_DefaultSampleSize = 16
static const uint32	_XFadeSize = 64
static const uint32	_SecondaryBufferSize = 0x10000
static const uint32	_SizeMask = 0xffff
Friends
class	CSoundDriverDSound

Detailed Description

Keep trace of following states of the DirectSound buffer:

the buffer is being filled with samples (filling),
the buffer still contains samples but silence is being written (silencing),
the buffer contains no samples but only silence (silenced).

To figger out whether the sound device has played all the samples in the buffer, the position of the play cursor is traced relatively to the position of the last sample in the buffer. DirectSound sound source For arguments as 3D vectors, use the NeL vector coordinate system

Author:: Peter Hanappe; Nevrax France

Date:: 2002

Definition at line 89 of file source_dsound.h.

Member Enumeration Documentation

enum NLSOUND::CSourceDSound::TSourceState [private]

Enumerator:

source_stoped
source_playing
source_silencing
source_swap_pending

Definition at line 277 of file source_dsound.h.

Constructor & Destructor Documentation

NLSOUND::CSourceDSound::CSourceDSound ( uint sourcename = 0 )

Constructor.

Definition at line 103 of file source_dsound.cpp.

References _3DBuffer, _Alpha, _CriticalSection, _DefaultSampleRate, _EAXSource, _FillOffset, _Format, _Freq, _Gain, _LastPlayPos, _Loop, _PlayOffset, _PosRelative, _Sample, _SampleFreq, _SampleOffset, _SampleRate, _SampleSize, _SecondaryBuffer, _State, _Volume, NLSOUND::Mono8, and source_stoped.

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

Destructor.

Definition at line 145 of file source_dsound.cpp.

References _CriticalSection, NLSOUND::CSoundDriverDSound::instance(), nldebug, release(), and NLSOUND::CSoundDriverDSound::removeSource().

Member Function Documentation

void NLSOUND::CSourceDSound::advanceFill	(	TLockedBufferInfo &	lbi,
		uint	nbSample
	)			`[private]`

Definition at line 674 of file source_dsound.cpp.

References _FillOffset, _SecondaryBufferSize, _SizeMask, nlassert, NLSOUND::CSourceDSound::TLockedBufferInfo::Ptr1, NLSOUND::CSourceDSound::TLockedBufferInfo::Ptr2, NLSOUND::CSourceDSound::TLockedBufferInfo::Size1, and NLSOUND::CSourceDSound::TLockedBufferInfo::Size2.

Referenced by play(), stop(), and update().

uint32 NLSOUND::CSourceDSound::checkFillCursor ( ) [private]

void NLSOUND::CSourceDSound::copySampleTo16BitsTrack	(	void *	dst,
		void *	src,
		uint	nbSample,
		TSampleFormat	sourceFormat
	)			`[private]`

uint NLSOUND::CSourceDSound::countStreamingBuffers ( ) const [virtual]

Return the amount of buffers in the queue (playing and waiting). 3 buffers is optimal.

void NLSOUND::CSourceDSound::fillData	(	sint16 *	dst,
		uint	nbSample
	)			`[private]`

void NLSOUND::CSourceDSound::fillData	(	const TLockedBufferInfo &	lbi,
		int	nbSample
	)			`[private]`

void NLSOUND::CSourceDSound::fillSilence	(	const TLockedBufferInfo &	lbi,
		int	nbSample
	)			`[private]`

void NLSOUND::CSourceDSound::getCone	(	float &	innerAngle,
		float &	outerAngle,
		float &	outerGain
	)			const `[virtual]`

void NLSOUND::CSourceDSound::getDirectFilter	(	TFilter &	filterType,
		float &	lowFrequency,
		float &	highFrequency,
		float &	passGain
	)			const `[virtual]`

void NLSOUND::CSourceDSound::getEffectFilter	(	TFilter &	filterType,
		float &	lowFrequency,
		float &	highFrequency,
		float &	passGain
	)			const `[virtual]`

void NLSOUND::CSourceDSound::getMinMaxDistances	(	float &	mindist,
		float &	maxdist
	)			const `[virtual]`

void NLSOUND::CSourceDSound::init	(	LPDIRECTSOUND	directSound,
		bool	useEax
	)

bool NLSOUND::CSourceDSound::lock	(	uint32	writePos,
		uint32	size,
		TLockedBufferInfo &	lockedInfo
	)			`[private]`

void NLSOUND::CSourceDSound::setCone	(	float	innerAngle,
		float	outerAngle,
		float	outerGain
	)			`[virtual]`

void NLSOUND::CSourceDSound::setDirectFilter	(	TFilter	filter,
		float	lowFrequency,
		float	highFrequency,
		float	passGain
	)			`[virtual]`

void NLSOUND::CSourceDSound::setEffectFilter	(	TFilter	filter,
		float	lowFrequency,
		float	highFrequency,
		float	passGain
	)			`[virtual]`

void NLSOUND::CSourceDSound::setMinMaxDistances	(	float	mindist,
		float	maxdist,
		bool	deferred = `true`
	)			`[virtual]`

void NLSOUND::CSourceDSound::setPos	(	const NLMISC::CVector &	pos,
		bool	deffered = `true`
	)			`[virtual]`

void NLSOUND::CSourceDSound::setVelocity	(	const NLMISC::CVector &	vel,
		bool	deferred = `true`
	)			`[virtual]`

void NLSOUND::CSourceDSound::xfade	(	const TLockedBufferInfo &	lbi,
		sint16 *	src
	)			`[private]`

NLSOUND::CSourceDSound Class Reference

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation