Audio::AY8912Stream Class Reference

Inheritance diagram for Audio::AY8912Stream:

Public Types
enum	ChipType { AY_TYPE_AY, AY_TYPE_YM }
enum	StereoType {   AY_MONO = 0, AY_ABC, AY_ACB, AY_BAC,   AY_BCA, AY_CAB, AY_CBA }
Public Types inherited from Audio::Chip
typedef Common::Functor0< void >	TimerCallback

Public Member Functions
	AY8912Stream (int rate=44100, int chipFreq=1773400)
int	readBuffer (int16 *buffer, const int numSamples) override
bool	isStereo () const override
bool	endOfData () const override
bool	endOfStream () const override
int	getRate () const override
void	setReg (int reg, unsigned char value)
void	setRegs (const unsigned char *regs)
AudioStream *	toAudioStream ()
Public Member Functions inherited from Audio::EmulatedChip
void	setCallbackFrequency (int timerFrequency) override
Public Member Functions inherited from Audio::Chip
void	start (TimerCallback *callback, int timerFrequency)
void	stop ()

Protected Member Functions
void	generateSamples (int16 *buffer, int numSamples) override
Protected Member Functions inherited from Audio::EmulatedChip
void	startCallbacks (int timerFrequency) override final
void	stopCallbacks () override final

Additional Inherited Members
Protected Attributes inherited from Audio::Chip
Common::ScopedPtr< TimerCallback >	_callback
Static Protected Attributes inherited from Audio::EmulatedChip
static const int	FIXP_SHIFT = 16

Member Function Documentation

readBuffer()

int Audio::AY8912Stream::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.

Reimplemented from Audio::EmulatedChip.

isStereo()

bool Audio::AY8912Stream::isStereo ( ) const

inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

endOfData()

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

Reimplemented from Audio::EmulatedChip.

endOfStream()

bool Audio::AY8912Stream::endOfStream ( ) const

inlineoverridevirtual

Check whether end of stream has been reached.

If this returns true, it indicates that all data in this stream is used up and no additional data will appear in it in the future.

This is used by the mixer to decide whether a given stream shall be removed from the list of active streams (and thus be destroyed). By default, this maps to endOfData().

Reimplemented from Audio::AudioStream.

getRate()

int Audio::AY8912Stream::getRate ( ) const

inlineoverridevirtual

Sample rate of the stream.

Reimplemented from Audio::EmulatedChip.

generateSamples()

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

overrideprotectedvirtual

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.

Implements Audio::EmulatedChip.

---

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

• audio/softsynth/ay8912.h