Audio Namespace Reference

Namespaces
	__impl
	Test

Classes
class	MappedComparator
class	CodecRegistry
class	CodecRegistration
class	Codec
class	FFCodec
class	OggCodec
class	Exception
class	FileOpenException
class	CodecNotFoundException
class	FileFormatException
class	EndOfStreamException
class	CorruptStreamException
class	ResourceNotLoadedException
class	ResourceAlreadyLoadedException
class	InvalidParametersException
class	DuplicateObjectException
class	NotFoundException
class	NotImplementedException
class	UnsupportedFormatException
class	OutOfMemoryException
struct	Format
class	Listener
class	TMatrix3
class	RenderableListener
class	RenderableSource
class	Renderer
class	BorrowedOpenALRenderer
class	OpenALRenderableListener
class	OpenALRenderableSource
class	OpenALRenderableStreamingSource
class	OpenALRenderer
class	OpenALSimpleSound
class	OpenALStreamingSound
class	Scene
struct	SourcePriorityRef
class	SceneManager
class	SimpleScene
class	SimpleSound
class	SimpleSource
class	Sound
class	SoundBuffer
class	Source
class	SourceListener
class	UpdateSourceListener
class	SourceTemplate
class	Stream
class	TemplateManager
struct	PerFrequency
struct	Range
class	UserData
class	TVector3
class	VirtualIterator
class	VirtualStandardIterator
class	VirtualMappingIterator
class	VirtualValuesIterator
class	VirtualKeysIterator
class	ChainingIterator

Typedefs
typedef float	Scalar
typedef double	LScalar
typedef LScalar	Timestamp
typedef Scalar	Duration
typedef TVector3< Scalar >	Vector3
typedef TVector3< LScalar >	LVector3
typedef TMatrix3< Scalar >	Matrix3
typedef TMatrix3< LScalar >	LMatrix3

Functions
static void	alSource3f (ALuint source, ALenum param, const Vector3 &v)
static void	alSource3f (ALuint source, ALenum param, const LVector3 &v)
static void	alSource3f (ALuint source, ALenum param, const Vector3 &v)
static void	alSource3f (ALuint source, ALenum param, const LVector3 &v)
Timestamp	getGameTime () throw ()
Timestamp	getRealTime () throw ()
Scalar	estimateGain (const Source &src, const Listener &listener) throw ()
void	sleep (unsigned int ms)

Typedef Documentation

typedef Scalar Audio::Duration

Duration type

Definition at line 31 of file Types.h.

typedef TMatrix3<LScalar> Audio::LMatrix3

Long FP 3x3 matrix

Definition at line 43 of file Types.h.

typedef double Audio::LScalar

Long fp scalar type

Definition at line 25 of file Types.h.

typedef TVector3<LScalar> Audio::LVector3

Long FP 3D vector

Definition at line 37 of file Types.h.

typedef TMatrix3<Scalar> Audio::Matrix3

FP 3x3 matrix

Definition at line 40 of file Types.h.

typedef float Audio::Scalar

Generic fp scalar type

Definition at line 22 of file Types.h.

typedef LScalar Audio::Timestamp

Tiemstamp type

Definition at line 28 of file Types.h.

typedef TVector3<Scalar> Audio::Vector3

FP 3D vector

Definition at line 34 of file Types.h.

Function Documentation

static void Audio::alSource3f ( ALuint  source, ALenum  param, const Vector3 &  v  )

inlinestatic

Definition at line 18 of file OpenALRenderableSource.cpp.

References Audio::TVector3< T >::x, Audio::TVector3< T >::y, and Audio::TVector3< T >::z.

Referenced by alSource3f(), AUDStreamingSound(), Audio::OpenALRenderableSource::updateImpl(), and Audio::OpenALRenderableStreamingSource::updateImpl().

    {
        ::alSource3f(source, param, ALfloat(v.x), ALfloat(v.y), ALfloat(v.z));
    }

static void Audio::alSource3f ( ALuint  source, ALenum  param, const Vector3 &  v  )

inlinestatic

Definition at line 18 of file OpenALRenderableStreamingSource.cpp.

References alSource3f(), Audio::TVector3< T >::x, Audio::TVector3< T >::y, and Audio::TVector3< T >::z.

    {
        ::alSource3f(source, param, ALfloat(v.x), ALfloat(v.y), ALfloat(v.z));
    }

static void Audio::alSource3f ( ALuint  source, ALenum  param, const LVector3 &  v  )

inlinestatic

Definition at line 23 of file OpenALRenderableSource.cpp.

References alSource3f(), Audio::TVector3< T >::x, Audio::TVector3< T >::y, and Audio::TVector3< T >::z.

    {
        ::alSource3f(source, param, ALfloat(v.x), ALfloat(v.y), ALfloat(v.z));
    }

static void Audio::alSource3f ( ALuint  source, ALenum  param, const LVector3 &  v  )

inlinestatic

Definition at line 23 of file OpenALRenderableStreamingSource.cpp.

References alSource3f(), Audio::TVector3< T >::x, Audio::TVector3< T >::y, and Audio::TVector3< T >::z.

    {
        ::alSource3f(source, param, ALfloat(v.x), ALfloat(v.y), ALfloat(v.z));
    }

Scalar Audio::estimateGain	(	const Source &	src,
		const Listener &	listener
	)
throw	(
	)

Definition at line 27 of file utils.cpp.

References f.

    {
        // Base priority is source gain
        Scalar gain = src.getGain();
        
        // Account for distance attenuation
        LScalar distance = listener.getPosition().distance(src.getPosition())
                         - listener.getRadius()
                         - src.getRadius();
        LScalar ref = listener.getRadius();
        LScalar rolloff = listener.getRadius() / src.getRadius();
        gain *= (distance <= 0) ? 1.f : float(ref / (ref + rolloff * distance));
        
        // Account for dispersion/sensing angle limitations
        Scalar cosangle = listener.getAtDirection().dot( src.getDirection() );
        if (cosangle < listener.getCosAngleRange().min)
            gain *= listener.getCosAngleRange().phase(cosangle);
        if (cosangle < src.getCosAngleRange().min)
            gain *= src.getCosAngleRange().phase(cosangle);
        
        return gain;
    }

Timestamp Audio::getGameTime	(	)
throw	(
	)

Definition at line 16 of file utils.cpp.

References UniverseUtil::GetGameTime().

    {
        return Timestamp(UniverseUtil::GetGameTime());
    }

Timestamp Audio::getRealTime	(	)
throw	(
	)

Definition at line 21 of file utils.cpp.

References realTime().

Referenced by Audio::SceneManager::commit(), Audio::Source::getWouldbePlayingTime(), Audio::Source::setLastKnownPlayingTime(), Audio::Test::testComplexScene(), Audio::Test::testMultiStreaming(), Audio::Test::testMultiStreaming2(), Audio::Test::testStreaming(), and Audio::__impl::TemplateManagerData::DefinitionFileInfo::touch().

    {
        return Timestamp(realTime());
    }

void Audio::sleep

(

unsigned int

ms)

Definition at line 50 of file utils.cpp.

References micro_sleep.

Referenced by Audio::Test::smQuickTick(), Audio::Test::smTick(), and Audio::Sound::waitLoad().

    {
        micro_sleep(ms * 1000);
    }