ScummVM API documentation
Public Member Functions | Protected Attributes | List of all members
Ultima::Nuvie::FMtownsDecoderStream Class Reference
Inheritance diagram for Ultima::Nuvie::FMtownsDecoderStream:
Audio::RewindableAudioStream Audio::AudioStream

Public Member Functions

 FMtownsDecoderStream (unsigned char *buf, uint32 len)
 
 FMtownsDecoderStream (const Common::Path &filename, uint16 sample_num, bool isCompressed=true)
 
uint32 getLengthInMsec ()
 
int readBuffer (sint16 *buffer, const int numSamples) override
 
bool isStereo () const override
 
int getRate () const override
 
bool endOfData () const override
 
bool rewind () override
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Protected Attributes

bool should_free_raw_data
 
unsigned char * raw_audio_buf
 
uint32 buf_len
 
uint32 buf_pos
 

Member Function Documentation

◆ readBuffer()

int Ultima::Nuvie::FMtownsDecoderStream::readBuffer ( sint16 *  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 Ultima::Nuvie::FMtownsDecoderStream::isStereo ( ) const
inlineoverridevirtual

Is this a stereo stream?

Implements Audio::AudioStream.

◆ getRate()

int Ultima::Nuvie::FMtownsDecoderStream::getRate ( ) const
inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ endOfData()

bool Ultima::Nuvie::FMtownsDecoderStream::endOfData ( ) const
inlineoverridevirtual

End of data reached? If this returns true, it means that at this time there is no data available in the stream. However there may be more data in the future. This is used by e.g. a rate converter to decide whether to keep on converting data or stop.

Implements Audio::AudioStream.

◆ rewind()

bool Ultima::Nuvie::FMtownsDecoderStream::rewind ( )
inlineoverridevirtual

Rewind the stream to its start.

Returns
True on success, false otherwise.

Implements Audio::RewindableAudioStream.

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