Audio::EmulatedChip Class Reference

#include <chip.h>

Inheritance diagram for Audio::EmulatedChip:

Public Member Functions
void	setCallbackFrequency (int timerFrequency) override
int	readBuffer (int16 *buffer, const int numSamples) override
int	getRate () const override
bool	endOfData () const override
Public Member Functions inherited from Audio::Chip
void	start (TimerCallback *callback, int timerFrequency)
void	stop ()

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

Static Protected Attributes
static const int	FIXP_SHIFT = 16

Additional Inherited Members
Public Types inherited from Audio::Chip
typedef Common::Functor0< void >	TimerCallback
Protected Attributes inherited from Audio::Chip
Common::ScopedPtr< TimerCallback >	_callback

Detailed Description

A Chip that represents an emulated sound chip.

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

Member Function Documentation

setCallbackFrequency()

void Audio::EmulatedChip::setCallbackFrequency ( int  timerFrequency )

overridevirtual

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

Implements Audio::Chip.

readBuffer()

int Audio::EmulatedChip::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 Audio::EmulatedChip::getRate ( ) const

overridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool Audio::EmulatedChip::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.

startCallbacks()

void Audio::EmulatedChip::startCallbacks ( int  timerFrequency )

finaloverrideprotectedvirtual

Start the callbacks.

Implements Audio::Chip.

stopCallbacks()

void Audio::EmulatedChip::stopCallbacks ( )

finaloverrideprotectedvirtual

Stop the callbacks.

Implements Audio::Chip.

generateSamples()

virtual void Audio::EmulatedChip::generateSamples ( int16 *  buffer, int  numSamples  )

protectedpure virtual

Read up to 'length' samples.

Data will be in native endianess, 16 bit per sample, signed. For stereo chips, buffer will be filled with interleaved left and right channel samples, starting with a left sample. Furthermore, the samples in the left and right are summed up. So if you request 4 samples from a stereo chip, you will get a total of two left channel and two right channel samples.

Implemented in OPL::MAME::OPL, OPL::NUKED::OPL, OPL::DOSBox::OPL, and DOSBoxCMS.

---

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

• audio/chip.h