Burger::SoundManager::BufferDecoder Class Reference

Inheritance diagram for Burger::SoundManager::BufferDecoder:

Collaboration diagram for Burger::SoundManager::BufferDecoder:

Public Member Functions
	BufferDecoder ()
	Construct a BufferDecoder.
	~BufferDecoder ()
	Destruct a BufferDecoder.
void	Clear (void)
	Clear out the BufferDecoder.
uint_t	ParseSoundFileImage (const void *pInput, uintptr_t uLength)
	Fill in a BufferDecoder_t from a sound file.
uint_t	Parse (const BufferDescription_t *pInput)
	Fill in a BufferDecoder_t from a description.
DecompressAudio *	GetDecompresser (void) const
uintptr_t	GetCompressedSize (void) const
uintptr_t	GetSampleCount (void) const

Protected Attributes
DecompressAudio *	m_pDecompresser
	Which data conversion function is used.
uintptr_t	m_uCompressedLength
	Actual size of the compressed data.
uintptr_t	m_uSampleCount
	Number of samples in the data.

Additional Inherited Members
Public Attributes inherited from Burger::SoundManager::BufferDescription_t
const uint8_t *	m_pSoundImage
	Pointer to the data.
uintptr_t	m_uSoundLength
	Length of the data in bytes.
uintptr_t	m_uLoopStart
	Sample to start from.
uintptr_t	m_uLoopEnd
	Sample to end the loop (0 for no looping)
uint_t	m_uSampleRate
	Samples per second to play.
eDataType	m_eDataType
	Type of data found.

Constructor & Destructor Documentation

BufferDecoder()

Burger::SoundManager::BufferDecoder::BufferDecoder

(

)

Construct a BufferDecoder.

---

Constructor

~BufferDecoder()

Burger::SoundManager::BufferDecoder::~BufferDecoder

(

)

Destruct a BufferDecoder.

---

Destructor

Member Function Documentation

Clear()

void BURGER_API Burger::SoundManager::BufferDecoder::Clear

(

void

)

Clear out the BufferDecoder.

---

Release any previous data this decoder managed

GetCompressedSize()

uintptr_t Burger::SoundManager::BufferDecoder::GetCompressedSize ( void ) const

inline

GetDecompresser()

DecompressAudio * Burger::SoundManager::BufferDecoder::GetDecompresser ( void ) const

inline

GetSampleCount()

uintptr_t Burger::SoundManager::BufferDecoder::GetSampleCount ( void ) const

inline

Parse()

uint_t BURGER_API Burger::SoundManager::BufferDecoder::Parse

(

const BufferDescription_t *

pInput

)

Fill in a BufferDecoder_t from a description.

---

Given a description to raw data, set up the buffer for uploading.

Parameters

pInput

Pointer to a description of the audio data

Returns

Zero if no error, non-zero on error

ParseSoundFileImage()

uint_t BURGER_API Burger::SoundManager::BufferDecoder::ParseSoundFileImage	(	const void *	pInput,
		uintptr_t	uLength )

Fill in a BufferDecoder_t from a sound file.

---

Given a file image of one of several popular file formats, determine the type of data contained and initialize the structure to point to the data inside the audio file

Parameters

pInput	Pointer to the image to the audio file
uLength	Length of the file image in bytes

Returns

Zero if no error, non-zero on error

Member Data Documentation

m_pDecompresser

DecompressAudio* Burger::SoundManager::BufferDecoder::m_pDecompresser

protected

Which data conversion function is used.

m_uCompressedLength

uintptr_t Burger::SoundManager::BufferDecoder::m_uCompressedLength

protected

Actual size of the compressed data.

m_uSampleCount

uintptr_t Burger::SoundManager::BufferDecoder::m_uSampleCount

protected

Number of samples in the data.