ScummVM API documentation
Scumm::Player_V1 Class Reference

#include <player_v1.h>

Inheritance diagram for Scumm::Player_V1:
Scumm::Player_V2 Audio::AudioStream Scumm::Player_V2Base Scumm::MusicEngine Common::Serializable

Public Member Functions

 Player_V1 (ScummEngine *scumm, Audio::Mixer *mixer, bool pcjr)
 
void startSound (int sound) override
 
void stopSound (int sound) override
 
void stopAllSounds () override
 
int getMusicTimer () override
 
- Public Member Functions inherited from Scumm::Player_V2
 Player_V2 (ScummEngine *scumm, Audio::Mixer *mixer, bool pcjr)
 
void setMusicVolume (int vol) override
 
void startSound (int sound) override
 
void stopSound (int sound) override
 
void stopAllSounds () override
 
int getSoundStatus (int sound) const override
 
int readBuffer (int16 *buffer, const int numSamples) override
 
bool isStereo () const override
 
bool endOfData () const override
 
int getRate () const override
 
- Public Member Functions inherited from Audio::AudioStream
virtual int readBuffer (int16 *buffer, const int numSamples)=0
 
virtual bool isStereo () const =0
 
virtual int getRate () const =0
 
virtual bool endOfData () const =0
 
virtual bool endOfStream () const
 
- Public Member Functions inherited from Scumm::Player_V2Base
 Player_V2Base (ScummEngine *scumm, bool pcjr)
 
int getMusicTimer () override
 
- Public Member Functions inherited from Scumm::MusicEngine
virtual void setMusicVolume (int vol)=0
 
virtual void setSfxVolume (int vol)
 
virtual void startSound (int sound)=0
 
virtual void startSoundWithTrackID (int sound, int track)
 
virtual void stopSound (int sound)=0
 
virtual void stopAllSounds ()=0
 
virtual int getSoundStatus (int sound) const =0
 
virtual int getMusicTimer ()
 
virtual void setQuality (int qual)
 
virtual void toggleMusic (bool enable)
 
virtual void toggleSoundEffects (bool enable)
 
void saveLoadWithSerializer (Common::Serializer &ser) override
 
virtual void restoreAfterLoad ()
 
virtual void saveLoadWithSerializer (Serializer &ser)=0
 

Protected Member Functions

void nextTick () override
 
void clear_channel (int i) override
 
void chainSound (int nr, byte *data) override
 
void generateSpkSamples (int16 *data, uint len) override
 
void generatePCjrSamples (int16 *data, uint len) override
 
void set_mplex (uint mplex)
 
void parseSpeakerChunk ()
 
void nextSpeakerCmd ()
 
void parsePCjrChunk ()
 
void nextPCjrCmd ()
 
- Protected Member Functions inherited from Scumm::Player_V2
virtual void generateSpkSamples (int16 *data, uint len)
 
virtual void generatePCjrSamples (int16 *data, uint len)
 
void lowPassFilter (int16 *data, uint len)
 
void squareGenerator (int channel, int freq, int vol, int noiseFeedback, int16 *sample, uint len)
 
- Protected Member Functions inherited from Scumm::Player_V2Base
virtual void nextTick ()
 
virtual void clear_channel (int i)
 
virtual void chainSound (int nr, byte *data)
 
virtual void chainNextSound ()
 
void execute_cmd (ChannelInfo *channel)
 
void next_freqs (ChannelInfo *channel)
 

Additional Inherited Members

- Protected Types inherited from Scumm::Player_V2
enum  { FIXP_SHIFT = 16 }
 
- Protected Attributes inherited from Scumm::Player_V2
unsigned int _update_step
 
unsigned int _decay
 
int _level
 
unsigned int _RNG
 
unsigned int _volumetable [16]
 
int _timer_count [4]
 
int _timer_output
 
Audio::Mixer * _mixer
 
Audio::SoundHandle _soundHandle
 
const uint32 _sampleRate
 
Common::Mutex _mutex
 
uint32 _next_tick
 
uint32 _tick_len
 
- Protected Attributes inherited from Scumm::Player_V2Base
bool _isV3Game
 
ScummEngine * _vm
 
bool _pcjr
 
int _header_len
 
int _current_nr
 
byte * _current_data
 
int _next_nr
 
byte * _next_data
 
byte * _retaddr
 
ChannelInfo _channels [5]
 

Detailed Description

Scumm V1 PC-Speaker player.

Member Function Documentation

◆ startSound()

void Scumm::Player_V1::startSound ( int  sound)
overridevirtual

Start playing the sound with the given id.

Parameters
soundthe sound to start

Implements Scumm::MusicEngine.

◆ stopSound()

void Scumm::Player_V1::stopSound ( int  sound)
overridevirtual

Stop playing the sound with the given id.

Parameters
soundthe sound to stop

Implements Scumm::MusicEngine.

◆ stopAllSounds()

void Scumm::Player_V1::stopAllSounds ( )
overridevirtual

Start playing all currently playing sounds.

Implements Scumm::MusicEngine.

◆ getMusicTimer()

int Scumm::Player_V1::getMusicTimer ( )
overridevirtual

Get the value of the music timer. Used for synchronising scripts with the music/sound.

Returns
the music timer

Reimplemented from Scumm::MusicEngine.

◆ nextTick()

void Scumm::Player_V1::nextTick ( )
overrideprotectedvirtual

Reimplemented from Scumm::Player_V2Base.

◆ clear_channel()

void Scumm::Player_V1::clear_channel ( int  i)
overrideprotectedvirtual

Reimplemented from Scumm::Player_V2Base.

◆ chainSound()

void Scumm::Player_V1::chainSound ( int  nr,
byte *  data 
)
overrideprotectedvirtual

Reimplemented from Scumm::Player_V2Base.

◆ generateSpkSamples()

void Scumm::Player_V1::generateSpkSamples ( int16 *  data,
uint  len 
)
overrideprotectedvirtual

Reimplemented from Scumm::Player_V2.

◆ generatePCjrSamples()

void Scumm::Player_V1::generatePCjrSamples ( int16 *  data,
uint  len 
)
overrideprotectedvirtual

Reimplemented from Scumm::Player_V2.


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