OPL::EmulatedOPL Class Reference

#include <fmopl.h>

Inheritance diagram for OPL::EmulatedOPL:

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

Protected Member Functions
void	startCallbacks (int timerFrequency)
void	stopCallbacks ()
virtual void	generateSamples (int16 *buffer, int numSamples)=0
Protected Member Functions inherited from OPL::OPL
void	initDualOpl2OnOpl3 (Config::OplType oplType)
bool	emulateDualOpl2OnOpl3 (int r, int v, Config::OplType oplType)
Protected Member Functions inherited from Audio::AudioStream
virtual bool	isStereo () const =0
virtual bool	endOfStream () const

Additional Inherited Members
Public Types inherited from OPL::OPL
enum	{ kDefaultCallbackFrequency = 250 }
Protected Attributes inherited from OPL::OPL
Common::ScopedPtr< TimerCallback >	_callback
bool	_rhythmMode
int	_connectionFeedbackValues [3]

Detailed Description

An OPL that represents an emulated OPL.

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

Member Function Documentation

setCallbackFrequency()

void OPL::EmulatedOPL::setCallbackFrequency ( int  timerFrequency )

virtual

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

Implements OPL::OPL.

readBuffer()

int OPL::EmulatedOPL::readBuffer ( int16 *  buffer, const int  numSamples  )

virtual

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 OPL::EmulatedOPL::getRate ( ) const

virtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool OPL::EmulatedOPL::endOfData ( ) const

inlinevirtual

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 OPL::EmulatedOPL::startCallbacks ( int  timerFrequency )

protectedvirtual

Start the callbacks.

Implements OPL::OPL.

stopCallbacks()

void OPL::EmulatedOPL::stopCallbacks ( )

protectedvirtual

Stop the callbacks.

Implements OPL::OPL.

generateSamples()

virtual void OPL::EmulatedOPL::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 OPL, 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 OPL, you will get a total of two left channel and two right channel samples.

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

---

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

• audio/fmopl.h