ScummVM API documentation
Macs2::MacsAudioStream Class Reference
Inheritance diagram for Macs2::MacsAudioStream:
Audio::SeekableAudioStream Audio::RewindableAudioStream Audio::AudioStream

Public Member Functions

virtual int readBuffer (int16 *buffer, const int numSamples)
 
virtual bool isStereo () const
 
virtual int getRate () const
 
virtual bool endOfData () const
 
virtual bool seek (const Audio::Timestamp &where)
 
virtual Audio::Timestamp getLength () const
 
- Public Member Functions inherited from Audio::SeekableAudioStream
bool seek (uint32 where)
 
bool rewind () override
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Public Attributes

Common::Array< byte > _data
 
int64 _pos
 

Additional Inherited Members

- Static Public Member Functions inherited from Audio::SeekableAudioStream
static SeekableAudioStreamopenStreamFile (const Common::Path &basename)
 

Member Function Documentation

◆ readBuffer()

virtual int Macs2::MacsAudioStream::readBuffer ( int16 *  buffer,
const int  numSamples 
)
virtual

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()

virtual bool Macs2::MacsAudioStream::isStereo ( ) const
virtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ getRate()

virtual int Macs2::MacsAudioStream::getRate ( ) const
virtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ endOfData()

virtual bool Macs2::MacsAudioStream::endOfData ( ) const
virtual

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()

virtual bool Macs2::MacsAudioStream::seek ( const Audio::Timestamp where)
virtual

Seek to a given offset in the stream.

Parameters
whereOffset as a timestamp.
Returns
True on success, false on failure.

Implements Audio::SeekableAudioStream.

◆ getLength()

virtual Audio::Timestamp Macs2::MacsAudioStream::getLength ( ) const
virtual

Return the length of the stream.

Returns
Length as a timestamp.

Implements Audio::SeekableAudioStream.


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