#include <SoundBuffer.h>

Public Member Functions
	SoundBuffer () throw ()

	SoundBuffer (unsigned int capacity, const Format &format) throw (OutOfMemoryException)

	SoundBuffer (const SoundBuffer &other) throw (OutOfMemoryException)

void	reserve (unsigned int capacity) throw (OutOfMemoryException)

void	reserve (unsigned int capacity, const Format &format) throw (OutOfMemoryException)

unsigned int	getByteCapacity () const throw ()

unsigned int	getSampleCapacity () const throw ()

unsigned int	getUsedBytes () const throw ()

void *	getBuffer () throw ()

const void *	getBuffer () const throw ()

const Format &	getFormat () const

void	setFormat (const Format &newFormat) throw ()

void	setUsedBytes (unsigned int used) throw ()

unsigned int	getSampleCount () const throw ()

void	reformat (const Format &newFormat) throw (Exception)

SoundBuffer &	operator= (const SoundBuffer &other) throw (OutOfMemoryException)

void	swap (SoundBuffer &other) throw ()

void	optimize () throw ()

void	clear ()

Detailed Description

Sound Buffer class

Remarks: This class represents a buffer for sound data. Though codecs usually treat samples as raw bytes in some uninteresting (for the api) format, renderers don't have that luxury.

This class encapsulates buffers and associates a format to them,: allowing for the implementation of format conversion (should it be needed).

At this point no conversion is supported, and requiring such: a conversion would raise a NotImplementedException.

Definition at line 26 of file SoundBuffer.h.

Constructor & Destructor Documentation

Audio::SoundBuffer::SoundBuffer	(	)
throw	(
	)

Create an empty buffer (zero capacity, default format)

Definition at line 14 of file SoundBuffer.cpp.

         : buffer(0),
           byteCapacity(0),
           bytesUsed(0)
     {
     }

Audio::SoundBuffer::SoundBuffer	(	unsigned int	capacity,
		const Format &	format
	)
throw	(	OutOfMemoryException
	)

Create a buffer of specified sample capacity and format

Definition at line 22 of file SoundBuffer.cpp.

         : buffer(0),
           byteCapacity(0),
           bytesUsed(0)
     {
         reserve(capacity, format);
     }

Audio::SoundBuffer::SoundBuffer	(	const SoundBuffer &	other)
throw	(	OutOfMemoryException
	)

Create a copy of the other buffer

Remarks: Only used bytes will be copied.

Definition at line 31 of file SoundBuffer.cpp.

References buffer, and VsnetOSS::memcpy().

     {
         bytesUsed = byteCapacity = other.bytesUsed;
         buffer = malloc(byteCapacity);
         if (buffer == 0)
             throw OutOfMemoryException();
         memcpy(buffer, other.buffer, bytesUsed);
         format = other.format;
     }

Member Function Documentation

void Audio::SoundBuffer::clear ( )

void* Audio::SoundBuffer::getBuffer	(	)
throw	(
	)

inline

Get write access to the buffer

Definition at line 72 of file SoundBuffer.h.

Referenced by Audio::OpenALSimpleSound::loadImpl().

72 { return buffer; }

const void* Audio::SoundBuffer::getBuffer	(	)	const
throw	(
	)

inline

Get read access to the buffer

Definition at line 75 of file SoundBuffer.h.

75 { return buffer; }

unsigned int Audio::SoundBuffer::getByteCapacity	(	)	const
throw	(
	)

inline

Get a buffer's byte capacity

Definition at line 61 of file SoundBuffer.h.

61 { return byteCapacity; }

const Format& Audio::SoundBuffer::getFormat ( ) const

inline

Get the buffer's format

Definition at line 78 of file SoundBuffer.h.

78 { return format; }

unsigned int Audio::SoundBuffer::getSampleCapacity	(	)	const
throw	(
	)

inline

Get a buffer's sample capacity

Remarks: Frame capacity actually, which is not the same for multichannel formats.

Definition at line 66 of file SoundBuffer.h.

References Audio::Format::frameSize().

66 { return byteCapacity / format.frameSize(); }

unsigned int Audio::SoundBuffer::getSampleCount	(	)	const
throw	(
	)

inline

Get a buffer's sample capacity for a certain format

Definition at line 87 of file SoundBuffer.h.

References Audio::Format::frameSize().

87 { return bytesUsed / format.frameSize(); }

unsigned int Audio::SoundBuffer::getUsedBytes	(	)	const
throw	(
	)

inline

Get the portion of the buffer actually used for holding useful data

Definition at line 69 of file SoundBuffer.h.

Referenced by Audio::OpenALSimpleSound::loadImpl().

69 { return bytesUsed; }

SoundBuffer & Audio::SoundBuffer::operator=	(	const SoundBuffer &	other)
throw	(	OutOfMemoryException
	)

Copy the given buffer as if SoundBuffer(buffer) was called

Definition at line 42 of file SoundBuffer.cpp.

References buffer, and VsnetOSS::memcpy().

     {
         bytesUsed = byteCapacity = other.bytesUsed;
         buffer = realloc(buffer, byteCapacity);
         if (buffer == 0)
             throw OutOfMemoryException();
         memcpy(buffer, other.buffer, bytesUsed);
         format = other.format;
         
         return *this;
     }

void Audio::SoundBuffer::optimize	(	)
throw	(
	)

Free extra memory allocated

Definition at line 89 of file SoundBuffer.cpp.

Referenced by Audio::OpenALSimpleSound::loadImpl().

     {
         if (bytesUsed == 0) {
             if (buffer) {
                 free(buffer);
                 buffer = 0;
             }
             bytesUsed = byteCapacity = 0;
         } else {
             if (bytesUsed != byteCapacity)
                 buffer = realloc(buffer, byteCapacity = bytesUsed);
         }
     }

void Audio::SoundBuffer::reformat	(	const Format &	newFormat)
throw	(	Exception
	)

Reformat the samples in the buffer without reallocating if possible (inplace)

Remarks: If the new format requires more bytes than the buffer's byte capacity, reallocation will be unavoidable. However, if the same buffer is used for conversion of several packets, subsequent operations on same-sized packets will not require such a reallocation, since if the new format requires less bytes only the used bytes count will be modified leaving the same byte capacity.

Definition at line 73 of file SoundBuffer.cpp.

     {
         if (newFormat != format)
             throw(NotImplementedException("Format conversion"));
     }

void Audio::SoundBuffer::reserve	(	unsigned int	capacity)
throw	(	OutOfMemoryException
	)

Set a buffer's capacity.

Parameters

capacity The buffer's capacity in bytes

Remarks: Destroys the current data in the buffer.

Definition at line 55 of file SoundBuffer.cpp.

References buffer.

Referenced by Audio::OpenALSimpleSound::loadImpl().

     {
         byteCapacity = capacity;
         bytesUsed = 0;
         
         buffer = realloc(buffer, byteCapacity);
         if (buffer == 0)
             throw OutOfMemoryException();
     }

void Audio::SoundBuffer::reserve	(	unsigned int	capacity,
		const Format &	format
	)
throw	(	OutOfMemoryException
	)

Set a buffer's capacity and format.

Parameters

capacity	The buffer's capacity in samples (or frames) for 'format'
format	The new format associated to the buffer

Remarks: Destroys the current data in the buffer.

Definition at line 66 of file SoundBuffer.cpp.

     {
         format = _format;
         reserve(capacity * _format.frameSize());
     }

void Audio::SoundBuffer::setFormat	(	const Format &	newFormat)
throw	(
	)

inline

Set the format of the stream mantaining the capacity yet destroying all current data

Definition at line 81 of file SoundBuffer.h.

81 { format = newFormat; bytesUsed = 0; }

void Audio::SoundBuffer::setUsedBytes	(	unsigned int	used)
throw	(
	)

inline

Set the portion of the buffer actually used for holding useful data

Definition at line 84 of file SoundBuffer.h.

Referenced by Audio::OpenALSimpleSound::loadImpl().

84 { bytesUsed = used; }

void Audio::SoundBuffer::swap	(	SoundBuffer &	other)
throw	(
	)

Swap buffer contents and format It's an inherently quick operation, since it only swaps pointers and descriptors.

Definition at line 80 of file SoundBuffer.cpp.

References buffer.

Referenced by Audio::OpenALSimpleSound::loadImpl().

     {
         std::swap(buffer, other.buffer);
         std::swap(byteCapacity, other.byteCapacity);
         std::swap(bytesUsed, other.bytesUsed);
         std::swap(format, other.format);
     }

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

src/audio/SoundBuffer.h
src/audio/SoundBuffer.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation