CBFormat Class Reference

Storage for BFormat signals. More...

#include <BFormat.h>

Inherits CAmbisonicBase.

Inheritance diagram for CBFormat:

[legend]Collaboration diagram for CBFormat:

[legend]List of all members.

Public Member Functions
	CBFormat (AmbInt nOrder=DEFAULT_ORDER, AmbInt b3D=DEFAULT_HEIGHT, AmbInt nSampleCount=DEFAULT_BFORMAT_SAMPLECOUNT)
	~CBFormat ()
AmbInt	GetSampleCount ()
void	Create (AmbInt nOrder, AmbInt b3D, AmbInt nSampleCount)
void	Reset ()
void	Refresh ()
void	InsertStream (AmbFloat *pfData, AmbInt nChannel, AmbInt nSamples)
void	ExtractStream (AmbFloat *pfData, AmbInt nChannel, AmbInt nSamples)
void	operator= (const CBFormat &bf)
AmbInt	operator== (const CBFormat &bf)
AmbInt	operator!= (const CBFormat &bf)
CBFormat &	operator+= (const CBFormat &bf)
CBFormat &	operator-= (const CBFormat &bf)
CBFormat &	operator *= (const CBFormat &bf)
CBFormat &	operator/= (const CBFormat &bf)
CBFormat &	operator+= (const AmbFloat &fValue)
CBFormat &	operator-= (const AmbFloat &fValue)
CBFormat &	operator *= (const AmbFloat &fValue)
CBFormat &	operator/= (const AmbFloat &fValue)
Protected Attributes
AmbInt	m_nSamples
AmbInt	m_nDataLength
AmbFloat *	m_pfData
AmbFloat **	m_ppfChannels
Friends
class	CAmbisonicEncoder
class	CAmbisonicEncoderDist
class	CAmbisonicDecoder
class	CAmbisonicSpeaker
class	CAmbisonicMicrophone
class	CAmbisonicProcessor
class	CAmbisonicBinauralizer
class	CAmbisonicZoomer

---

Detailed Description

Storage for BFormat signals.

This object is used to store and transfer BFormat signals. Memory is allocated for the number of channels needed for the given Ambisonic configuration (order and 2D/3D) and the number of samples.

---

Constructor & Destructor Documentation

CBFormat::CBFormat	(	AmbInt	nOrder = DEFAULT_ORDER,
		AmbInt	b3D = DEFAULT_HEIGHT,
		AmbInt	nSampleCount = DEFAULT_BFORMAT_SAMPLECOUNT
	)

Constructor that allows for the format to be specified. If the format arguments are not specified, the values set for DEFAULT_ORDER, DEFAULT_HEIGHT, and DEFAULT_BFORMAT_SAMPLECOUNT will be used instead.

CBFormat::~CBFormat

(

)

---

Member Function Documentation

AmbInt CBFormat::GetSampleCount

(

)

Returns the number of samples.

void CBFormat::Create	(	AmbInt	nOrder,
		AmbInt	b3D,
		AmbInt	nSampleCount
	)			[virtual]

Re-create the buffers needed for the given configuration. Previous buffer contents are lost.

Reimplemented from CAmbisonicBase.

void CBFormat::Reset

(

)

[virtual]

Fill the buffer with zeros.

Implements CAmbisonicBase.

void CBFormat::Refresh

(

)

[virtual]

Not implemented.

Implements CAmbisonicBase.

void CBFormat::InsertStream	(	AmbFloat *	pfData,
		AmbInt	nChannel,
		AmbInt	nSamples
	)

Copy a number of samples to a specific channel of the BFormat.

void CBFormat::ExtractStream	(	AmbFloat *	pfData,
		AmbInt	nChannel,
		AmbInt	nSamples
	)

Copy a number of samples from a specific channel of the BFormat.

void CBFormat::operator=

(

const CBFormat &

bf

)

Copy the content of the buffer. It is assumed that the two objects are of the same configuration.

AmbInt CBFormat::operator==

(

const CBFormat &

bf

)

Returns true if the configuration of the two objects match.

AmbInt CBFormat::operator!=

(

const CBFormat &

bf

)

Returns true if the configuration of the two objects don't match.

CBFormat & CBFormat::operator+=

(

const CBFormat &

bf

)

CBFormat & CBFormat::operator-=

(

const CBFormat &

bf

)

CBFormat & CBFormat::operator *=

(

const CBFormat &

bf

)

CBFormat & CBFormat::operator/=

(

const CBFormat &

bf

)

CBFormat & CBFormat::operator+=

(

const AmbFloat &

fValue

)

CBFormat & CBFormat::operator-=

(

const AmbFloat &

fValue

)

CBFormat & CBFormat::operator *=

(

const AmbFloat &

fValue

)

CBFormat & CBFormat::operator/=

(

const AmbFloat &

fValue

)

---

Friends And Related Function Documentation

friend class CAmbisonicEncoder [friend]

friend class CAmbisonicEncoderDist [friend]

friend class CAmbisonicDecoder [friend]

friend class CAmbisonicSpeaker [friend]

friend class CAmbisonicMicrophone [friend]

friend class CAmbisonicProcessor [friend]

friend class CAmbisonicBinauralizer [friend]

friend class CAmbisonicZoomer [friend]

---

Member Data Documentation

AmbInt CBFormat::m_nSamples [protected]

AmbInt CBFormat::m_nDataLength [protected]

AmbFloat* CBFormat::m_pfData [protected]

AmbFloat** CBFormat::m_ppfChannels [protected]

---

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

• C:/dev/amblib/source/BFormat.h
• C:/dev/amblib/source/BFormat.cpp

---