Ultima::Nuvie::AdLibSfxStream Class Reference

Inheritance diagram for Ultima::Nuvie::AdLibSfxStream:

Public Member Functions
	AdLibSfxStream (const Configuration *cfg, int rate, uint8 channel, sint8 note, uint8 velocity, uint8 program_number, uint32 d)
int	readBuffer (sint16 *buffer, const int numSamples) override
bool	isStereo () const override
int	getRate () const override
bool	rewind () override
bool	endOfData () const override
uint32	getLengthInMsec ()
Public Member Functions inherited from Audio::AudioStream
virtual bool	endOfStream () const

Protected Attributes
OplClass *	opl
OriginFXAdLibDriver *	driver
uint32	duration
int	interrupt_samples_left
int	interrupt_rate
uint32	total_samples_played

Member Function Documentation

readBuffer()

int Ultima::Nuvie::AdLibSfxStream::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::AdLibSfxStream::isStereo ( ) const

inlineoverridevirtual

Is this a stereo stream?

Implements Audio::AudioStream.

getRate()

int Ultima::Nuvie::AdLibSfxStream::getRate ( ) const

inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

rewind()

bool Ultima::Nuvie::AdLibSfxStream::rewind ( )

inlineoverridevirtual

Rewind the stream to its start.

Returns

True on success, false otherwise.

Implements Audio::RewindableAudioStream.

endOfData()

bool Ultima::Nuvie::AdLibSfxStream::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.

---

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

• engines/ultima/nuvie/sound/decoder/adlib_sfx_stream.h