om::sound::base Namespace Reference

A namespace containing basic sound classes for samples, buffers, and others types. More...

Classes
class	ChannelInfo
	A class that stores information about the 3D placement and semantic type of a channel's speaker. More...
class	ChannelLayout
	A class that specifies the configuration and usage of a set of channels of audio. More...
class	ChannelLayoutType
	An enum wrapper class that specifies various predefined types of channel layouts. More...
class	ChannelMixMatrix
	A class that holds a matrix of gain coefficients mapping from one channel configuration to another. More...
class	ChannelType
	An enum wrapper class that specifies the semantic usage of a channel of audio. More...
class	Convolution
	A class that implements multi-output dynamic streaming convolution. More...
class	DirectionalIR
	A class that stores a directional transfer function for a linear acoustic system. More...
class	FrequencyData
	A class that stores a sequence of frequency-dependent values in sorted order. More...
class	Int24
	A class used to represent a 24-bit integer number. More...
class	LerpState
	A class that stores the state for a time-domain linear interpolation. More...
class	MIDI
	A class that stores a MIDI sequence. More...
class	MIDIBuffer
	A class that represents a sequence of MIDI events. More...
class	MIDIEvent
	A class that represents a single MIDI message that occurred at an absolute moment in time. More...
class	MIDIInputStream
	A class that represents a streaming input source for MIDI data. More...
class	MIDIMessage
	A class that represents a single MIDI message. More...
class	MIDIOutputStream
	A class that represents a stream-writable destination for MIDI data. More...
class	MIDITime
	A class that represents a musical position within a MIDI sequence. More...
class	PanDirection
	A class that represents a generic panning direction. More...
class	Sample
	A class that represents a template primitive-typed sound sample. More...
class	SampleType
	An enum wrapper class that specifies the type of a sample of audio data. More...
class	SharedBufferInfo
	A class that holds information about a shared sound buffer buffer. More...
class	SharedBufferPool
	A class that provides a pool of thread-safe temporary SoundBuffer objects for efficient DSP processing. More...
class	SharedSoundBuffer
	A class that represents a temporary handle to a shared SoundBuffer. More...
class	Sound
	A class that represents either a streaming or memory-resident sound resource. More...
class	SoundBuffer
	A class representing a buffer of multichannel audio data. More...
class	SoundCallbackStream
	A class that wraps a function callback source of sound samples as a SoundInputStream. More...
class	SoundDataInputStream
	A class that wraps a sound decoder and its data stream source. More...
class	SoundFormat
	An enum class representing the different kinds of sound encoding formats. More...
class	SoundFormatFlags
	A class that stores different boolean parameters for sound formats. More...
class	SoundFormatSettings
	A class that specifies common settings for sound formats. More...
class	SoundFrame
	A class that provides all of the information needed for a SoundFilter to process sound data. More...
class	SoundInputStream
	A class that abstracts a read-only source of sound samples. More...
class	SoundOutputStream
	A class that abstracts a write-only destination of sound samples. More...
class	SoundRegion
	A class that represents a region of a sound resource and its playback parameters. More...
class	SoundResult
	A class that represents the result of a sound frame. More...
class	SoundTrack
	A class that represents a sorted time sequence of sound regions. More...
class	TimeSignature
	A class that represents a standard musical time signature. More...

Typedefs
typedef Float32	Gain
	Define the type to represent a linear gain coefficient. More...
typedef math::Complex< Float32 >	ComplexSample
	Define the type used to represent a sound sample that is a complex number. More...
typedef Function< SoundResult(SoundFrame &outputFrame, Size numSamples) >	SoundCallback
	A function object that handles sound callback events that generated sound samples. More...
typedef Convolution::ID	ConvolutionID
	A type that is used to represent the ID of a convolution instance. More...
typedef DirectionalIR	DTF
	A class that stores a directional transfer function for a linear acoustic system. More...
typedef DirectionalIR	HRTF
	A class that stores a head-related transfer function. More...
typedef Sample< Int8 >	Sample8
	Define the type of a integral sample which uses a signed 8-bit representation. More...
typedef Sample< Int16 >	Sample16
	Define the type of a integral sample which uses a signed 16-bit representation. More...
typedef Sample< Int24 >	Sample24
	Define the type of a integral sample which uses a signed 24-bit representation. More...
typedef Sample< Int32 >	Sample32
	Define the type of a integral sample which uses a signed 32-bit representation. More...
typedef Sample< Int64 >	Sample64
	Define the type of a integral sample which uses a signed 64-bit representation. More...
typedef Float32	Sample32f
	Define the type of a floating-point sample which uses a 32-bit representation. More...
typedef Float64	Sample64f
	Define the type of a floating-point sample which uses a 64-bit representation. More...

Functions
template<typename T >
Sample< T >	operator* (const Float &gain, const Sample< T > &sample)
	Multiply a sample by a linear gain factor and return the resulting sample. More...
template<typename T >
Sample< T >	operator* (const Double &gain, const Sample< T > &sample)
	Multiply a sample by a linear gain factor and return the resulting sample. More...

Detailed Description

A namespace containing basic sound classes for samples, buffers, and others types.

Typedef Documentation

typedef Float32 om::sound::base::Gain

Define the type to represent a linear gain coefficient.

typedef math::Complex<Float32> om::sound::base::ComplexSample

Define the type used to represent a sound sample that is a complex number.

typedef Function< SoundResult ( SoundFrame& outputFrame, Size numSamples ) > om::sound::base::SoundCallback

A function object that handles sound callback events that generated sound samples.

typedef Convolution::ID om::sound::base::ConvolutionID

A type that is used to represent the ID of a convolution instance.

typedef DirectionalIR om::sound::base::DTF

A class that stores a directional transfer function for a linear acoustic system.

typedef DirectionalIR om::sound::base::HRTF

A class that stores a head-related transfer function.

typedef Sample<Int8> om::sound::base::Sample8

Define the type of a integral sample which uses a signed 8-bit representation.

typedef Sample<Int16> om::sound::base::Sample16

Define the type of a integral sample which uses a signed 16-bit representation.

typedef Sample<Int24> om::sound::base::Sample24

Define the type of a integral sample which uses a signed 24-bit representation.

typedef Sample<Int32> om::sound::base::Sample32

Define the type of a integral sample which uses a signed 32-bit representation.

typedef Sample<Int64> om::sound::base::Sample64

Define the type of a integral sample which uses a signed 64-bit representation.

typedef Float32 om::sound::base::Sample32f

Define the type of a floating-point sample which uses a 32-bit representation.

typedef Float64 om::sound::base::Sample64f

Define the type of a floating-point sample which uses a 64-bit representation.

Function Documentation

template<typename T >

Sample<T> om::sound::base::operator* ( const Float &  gain, const Sample< T > &  sample  )

inline

Multiply a sample by a linear gain factor and return the resulting sample.

template<typename T >

Sample<T> om::sound::base::operator* ( const Double &  gain, const Sample< T > &  sample  )

inline

Multiply a sample by a linear gain factor and return the resulting sample.