CMS::EmulatedCMS Class Reference

#include <cms.h>

Inheritance diagram for CMS::EmulatedCMS:

Public Member Functions
void	setCallbackFrequency (int timerFrequency) override
int	readBuffer (int16 *buffer, const int numSamples) override
int	getRate () const override
bool	endOfData () const override
bool	isStereo () const override
Public Member Functions inherited from CMS::CMS
virtual bool	init ()=0
virtual void	reset ()=0
virtual void	write (int a, int v)=0
virtual void	writeReg (int r, int v)=0
void	start (TimerCallback *callback, int timerFrequency=DEFAULT_CALLBACK_FREQUENCY)
void	stop ()

Protected Member Functions
void	startCallbacks (int timerFrequency) override
void	stopCallbacks () override
virtual void	generateSamples (int16 *buffer, int numSamples)=0
Protected Member Functions inherited from Audio::AudioStream
virtual bool	endOfStream () const

Static Protected Attributes
static const int	FIXP_SHIFT = 16

Additional Inherited Members
Static Public Attributes inherited from CMS::CMS
static const int	DEFAULT_CALLBACK_FREQUENCY = 250
Protected Attributes inherited from CMS::CMS
Common::ScopedPtr< TimerCallback >	_callback

Detailed Description

A CMS that represents an emulated CMS.

This will send callbacks based on the number of samples decoded in readBuffer().

Member Function Documentation

setCallbackFrequency()

void CMS::EmulatedCMS::setCallbackFrequency ( int  timerFrequency )

overridevirtual

Change the callback frequency. This must only be called from a timer proc.

Implements CMS::CMS.

readBuffer()

int CMS::EmulatedCMS::readBuffer ( int16 *  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.

getRate()

int CMS::EmulatedCMS::getRate ( ) const

overridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool CMS::EmulatedCMS::endOfData ( ) const

overridevirtual

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.

isStereo()

bool CMS::EmulatedCMS::isStereo ( ) const

overridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

startCallbacks()

void CMS::EmulatedCMS::startCallbacks ( int  timerFrequency )

overrideprotectedvirtual

Start the callbacks.

Implements CMS::CMS.

stopCallbacks()

void CMS::EmulatedCMS::stopCallbacks ( )

overrideprotectedvirtual

Stop the callbacks.

Implements CMS::CMS.

generateSamples()

virtual void CMS::EmulatedCMS::generateSamples ( int16 *  buffer, int  numSamples  )

protectedpure virtual

Read up to 'length' samples.

Data will be in native endianess, 16 bit per sample, signed. buffer will be filled with interleaved left and right channel samples, starting with a left sample. The requested number of samples is stereo samples, so if you request 2 samples, you will get a total of two left channel and two right channel samples.

Implemented in DOSBoxCMS.

---

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

• audio/cms.h