Scumm::Player_MOD Class Reference

#include <player_mod.h>

Inheritance diagram for Scumm::Player_MOD:

Public Types
typedef void	ModUpdateProc(void *param)

Public Member Functions
	Player_MOD (Audio::Mixer *mixer)
virtual void	setMusicVolume (int vol)
virtual void	startChannel (int id, void *data, int size, int rate, uint8 vol, int loopStart=0, int loopEnd=0, int8 pan=0)
virtual void	stopChannel (int id)
virtual void	setChannelVol (int id, uint8 vol)
virtual void	setChannelPan (int id, int8 pan)
virtual void	setChannelFreq (int id, int freq)
virtual void	setUpdateProc (ModUpdateProc *proc, void *param, int freq)
virtual void	clearUpdateProc ()
int	readBuffer (int16 *buffer, const int numSamples) override
bool	isStereo () const override
bool	endOfData () const override
int	getRate () const override
Public Member Functions inherited from Audio::AudioStream
virtual bool	endOfStream () const

Detailed Description

Generic Amiga MOD mixer - provides a 60Hz 'update' routine.

Member Function Documentation

readBuffer()

int Scumm::Player_MOD::readBuffer ( int16 *  buffer, const int  numSamples  )

inlineoverridevirtual

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 Scumm::Player_MOD::isStereo ( ) const

inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

endOfData()

bool Scumm::Player_MOD::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.

getRate()

int Scumm::Player_MOD::getRate ( ) const

inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

---

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

• engines/scumm/players/player_mod.h