ScummVM API documentation
Classes | Public Member Functions | List of all members
Freescape::CastleAYMusicPlayer Class Reference

#include <ay.music.h>

Inheritance diagram for Freescape::CastleAYMusicPlayer:
Freescape::MusicPlayer Audio::AY8912Stream

Public Member Functions

 CastleAYMusicPlayer (Audio::Mixer *mixer)
 
void startMusic () override
 
void stopMusic () override
 
bool isPlaying () const override
 
int readBuffer (int16 *buffer, const int numSamples) override
 
bool endOfData () const override
 
bool endOfStream () const override
 

Detailed Description

AY-3-8910 music player for Castle Master CPC.

Adapts the Castle Master C64 title music to the CPC AY chip by reusing the Castle order lists and pattern data shared with the AdLib rendition.

Member Function Documentation

◆ readBuffer()

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

◆ endOfData()

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

◆ endOfStream()

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

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