Audio::Audio3DO_SDX2_Stream Class Reference

Inheritance diagram for Audio::Audio3DO_SDX2_Stream:

Public Member Functions
	Audio3DO_SDX2_Stream (Common::SeekableReadStream *stream, uint16 sampleRate, bool stereo, DisposeAfterUse::Flag disposeAfterUse, audio_3DO_SDX2_PersistentSpace *persistentSpacePtr)
Public Member Functions inherited from Audio::AudioStream
virtual bool	endOfStream () const

Protected Member Functions
void	reset ()
bool	rewind ()
bool	endOfData () const
bool	isStereo () const
int	getRate () const
int	readBuffer (int16 *buffer, const int numSamples)

Protected Attributes
const uint16	_sampleRate
const bool	_stereo
Common::DisposablePtr< Common::SeekableReadStream >	_stream
int32	_streamBytesLeft
bool	_initialRead
audio_3DO_SDX2_PersistentSpace *	_callerDecoderData
audio_3DO_SDX2_PersistentSpace	_initialDecoderData
audio_3DO_SDX2_PersistentSpace	_curDecoderData

Member Function Documentation

rewind()

bool Audio::Audio3DO_SDX2_Stream::rewind ( )

protectedvirtual

Rewind the stream to its start.

Returns

True on success, false otherwise.

Implements Audio::RewindableAudioStream.

endOfData()

bool Audio::Audio3DO_SDX2_Stream::endOfData ( ) const

inlineprotectedvirtual

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.

isStereo()

bool Audio::Audio3DO_SDX2_Stream::isStereo ( ) const

inlineprotectedvirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

getRate()

int Audio::Audio3DO_SDX2_Stream::getRate ( ) const

inlineprotectedvirtual

Sample rate of the stream.

Implements Audio::AudioStream.

readBuffer()

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

protectedvirtual

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.

---

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

• audio/decoders/3do.h