Audio::VocStream Class Reference

Inheritance diagram for Audio::VocStream:

Classes
struct	Block

Public Member Functions
	VocStream (Common::SeekableReadStream *stream, bool isUnsigned, DisposeAfterUse::Flag disposeAfterUse)
int	readBuffer (int16 *buffer, const int numSamples) override
bool	isStereo () const override
int	getRate () const override
bool	endOfData () const override
bool	seek (const Timestamp &where) override
Timestamp	getLength () const override
Public Member Functions inherited from Audio::SeekableAudioStream
bool	seek (uint32 where)
virtual bool	rewind ()
Public Member Functions inherited from Audio::AudioStream
virtual bool	endOfStream () const

Protected Types
enum	{ kSampleBufferLength = 2048 }
typedef Common::List< Block >	BlockList

Protected Member Functions
void	preProcess ()
void	updateBlockIfNeeded ()
int	fillBuffer (int maxSamples)

Protected Attributes
Common::SeekableReadStream *const	_stream
const DisposeAfterUse::Flag	_disposeAfterUse
const bool	_isUnsigned
int	_rate
Timestamp	_length
BlockList	_blocks
BlockList::const_iterator	_curBlock
uint32	_blockLeft
byte	_buffer [kSampleBufferLength]

Additional Inherited Members
Static Public Member Functions inherited from Audio::SeekableAudioStream
static SeekableAudioStream *	openStreamFile (const Common::Path &basename)

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
kSampleBufferLength	How many samples we can buffer at once. TODO: Check whether this size suffices for systems with slow disk I/O.

Member Function Documentation

readBuffer()

int Audio::VocStream::readBuffer ( int16 *  buffer, const int  numSamples  )

overridevirtual

Fill the given buffer with up to numSamples samples.

Data must be in native endianness, 16 bits per sample, signed. For stereo stream, the buffer will be filled with interleaved left and right channel samples, starting with the left sample. Furthermore, the samples in the left and right are summed up. So if you request 4 samples from a stereo stream, you will get a total of two left channel and two right channel samples.

Returns

The actual number of samples read, or -1 if a critical error occurred.

Note

You must check whether the returned value is less than what you requested. This indicates that the stream is fully used up.

Implements Audio::AudioStream.

isStereo()

bool Audio::VocStream::isStereo ( ) const

inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

getRate()

int Audio::VocStream::getRate ( ) const

inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool Audio::VocStream::endOfData ( ) const

inlineoverridevirtual

Check whether end of data has been reached.

If this returns true, it indicates that at this time there is no data available in the stream. However, there might be more data in the future.

This is used by e.g. a rate converter to decide whether to keep on converting data or to stop.

Implements Audio::AudioStream.

seek()

bool Audio::VocStream::seek ( const Timestamp &  where )

overridevirtual

Seek to a given offset in the stream.

Parameters

where

Offset as a timestamp.

Returns

True on success, false on failure.

Implements Audio::SeekableAudioStream.

getLength()

Timestamp Audio::VocStream::getLength ( ) const

inlineoverridevirtual

Return the length of the stream.

Returns

Length as a timestamp.

Implements Audio::SeekableAudioStream.

updateBlockIfNeeded()

void Audio::VocStream::updateBlockIfNeeded ( )

protected

Advance one block in the stream in case the current one is empty.

fillBuffer()

int Audio::VocStream::fillBuffer ( int  maxSamples )

protected

Fill the temporary sample buffer used in readBuffer.

Parameters

maxSamples

Maximum samples to read.

Returns

actual count of samples read.

---

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

• audio/decoders/voc.h