Sci::RobotAudioStream Class Reference

#include <robot_decoder.h>

Inheritance diagram for Sci::RobotAudioStream:

Classes
struct	RobotAudioPacket
struct	StreamState

Public Types
enum	{ kRobotSampleRate = 22050, kEOSExpansion = 2 }

Public Member Functions
	RobotAudioStream (const int32 bufferSize)
bool	addPacket (const RobotAudioPacket &packet)
void	finish ()
StreamState	getStatus () const
int	readBuffer (Audio::st_sample_t *outBuffer, int numSamples) override
bool	isStereo () const override
int	getRate () const override
bool	endOfData () const override
bool	endOfStream () const override

Detailed Description

A Robot audio stream is a simple loop buffer that accepts audio blocks from the Robot engine.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kRobotSampleRate	The sample rate used for all robot audio.
kEOSExpansion	Multiplier for the size of a packet that is being expanded by writing to every other byte of the target buffer.

Member Function Documentation

addPacket()

bool Sci::RobotAudioStream::addPacket

(

const RobotAudioPacket &

packet

)

Adds a new audio packet to the stream.

Returns

true if the audio packet was fully consumed, otherwise false.

finish()

void Sci::RobotAudioStream::finish

(

)

Prevents any additional audio packets from being added to the audio stream.

getStatus()

StreamState Sci::RobotAudioStream::getStatus

(

)

const

Returns the current status of the audio stream.

readBuffer()

int Sci::RobotAudioStream::readBuffer ( Audio::st_sample_t *  buffer, 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 Sci::RobotAudioStream::isStereo ( ) const

inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

getRate()

int Sci::RobotAudioStream::getRate ( ) const

inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool Sci::RobotAudioStream::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.

endOfStream()

bool Sci::RobotAudioStream::endOfStream ( ) const

inlineoverridevirtual

Check whether end of stream has been reached.

If this returns true, it indicates that all data in this stream is used up and no additional data will appear in it in the future.

This is used by the mixer to decide whether a given stream shall be removed from the list of active streams (and thus be destroyed). By default, this maps to endOfData().

Reimplemented from Audio::AudioStream.

---

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

• engines/sci/video/robot_decoder.h