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

#include <ay.music.h>

Inheritance diagram for Freescape::EclipseAYMusicPlayer:
Audio::AY8912Stream Audio::EmulatedChip Audio::Chip Audio::AudioStream

Public Member Functions

 EclipseAYMusicPlayer (Audio::Mixer *mixer)
 
void startMusic ()
 
void stopMusic ()
 
bool isPlaying () const
 
int readBuffer (int16 *buffer, const int numSamples) override
 
bool endOfData () const override
 
bool endOfStream () const override
 
- Public Member Functions inherited from Audio::AY8912Stream
 AY8912Stream (int rate=44100, int chipFreq=1773400)
 
bool isStereo () 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 ()
 

Additional Inherited Members

- Public Types inherited from Audio::AY8912Stream
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
 
- Protected Member Functions inherited from Audio::AY8912Stream
void generateSamples (int16 *buffer, int numSamples) override
 
- Protected Member Functions inherited from Audio::EmulatedChip
void startCallbacks (int timerFrequency) override final
 
void stopCallbacks () override final
 
- Protected Attributes inherited from Audio::Chip
Common::ScopedPtr< TimerCallback > _callback
 
- Static Protected Attributes inherited from Audio::EmulatedChip
static const int FIXP_SHIFT = 16
 

Detailed Description

AY-3-8910 music player for Total Eclipse CPC.

Ports the Wally Beben C64 SID music to the CPC's AY chip by:

  • Reusing the same sequencer format (order lists, patterns, instruments)
  • Converting SID frequencies to AY periods
  • Replacing SID hardware ADSR with a software envelope
  • Dropping SID-specific features (pulse width, filters)

Member Function Documentation

◆ readBuffer()

int Freescape::EclipseAYMusicPlayer::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::EclipseAYMusicPlayer::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::EclipseAYMusicPlayer::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: