ScummVM API documentation
Scumm::Player_Mac Class Reference

#include <player_mac.h>

Inheritance diagram for Scumm::Player_Mac:
Audio::AudioStream Scumm::MusicEngine Common::Serializable Scumm::Player_V3M Scumm::Player_V5M

Classes

struct  Channel
 

Public Member Functions

 Player_Mac (ScummEngine *scumm, Audio::Mixer *mixer, int numberOfChannels, int channelMask, bool fadeNoteEnds)
 
void init (const Common::Path &instrumentFile)
 
void setMusicVolume (int vol) override
 
void startSound (int sound) override
 
void stopSound (int sound) override
 
void stopAllSounds () override
 
int getMusicTimer () 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
 
void saveLoadWithSerializer (Common::Serializer &ser) override
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 
- Public Member Functions inherited from Scumm::MusicEngine
virtual void setSfxVolume (int vol)
 
virtual void startSoundWithTrackID (int sound, int track)
 
virtual void setQuality (int qual)
 
virtual void restoreAfterLoad ()
 

Protected Member Functions

uint32 durationToSamples (uint16 duration)
 
int noteToPitchModifier (byte note, Instrument *instrument)
 
void overrideChannelMask (int newMask)
 

Protected Attributes

ScummEngine *const _vm
 
Common::Path _instrumentFile
 
Channel_channel
 
uint32 _lastVersionBeforeSaveFormatChange
 

Friends

void syncWithSerializer (Common::Serializer &, Instrument &)
 
void syncWithSerializer (Common::Serializer &, Channel &)
 

Detailed Description

Scumm Macintosh music driver, base class.

Member Function Documentation

◆ setMusicVolume()

void Scumm::Player_Mac::setMusicVolume ( int  vol)
overridevirtual

Set the output volume for music. Also used, if the inheriting class doesn't distinguish between music and sfx.

Parameters
volthe new output volume

Implements Scumm::MusicEngine.

◆ startSound()

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

Start playing the sound with the given id.

Parameters
soundthe sound to start

Implements Scumm::MusicEngine.

◆ stopSound()

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

Stop playing the sound with the given id.

Parameters
soundthe sound to stop

Implements Scumm::MusicEngine.

◆ stopAllSounds()

void Scumm::Player_Mac::stopAllSounds ( )
overridevirtual

Start playing all currently playing sounds.

Implements Scumm::MusicEngine.

◆ getMusicTimer()

int Scumm::Player_Mac::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.

◆ getSoundStatus()

int Scumm::Player_Mac::getSoundStatus ( int  sound) const
overridevirtual

Query the status of the sound with the given id. Usually this is just a boolean telling us whether the sound is playing or not.

Parameters
soundthe sound to for which we want the status
Returns
the status of the specified sound

Implements Scumm::MusicEngine.

◆ readBuffer()

int Scumm::Player_Mac::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.

Implements Audio::AudioStream.

◆ isStereo()

bool Scumm::Player_Mac::isStereo ( ) const
inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ endOfData()

bool Scumm::Player_Mac::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.

Implements Audio::AudioStream.

◆ getRate()

int Scumm::Player_Mac::getRate ( ) const
inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ saveLoadWithSerializer()

void Scumm::Player_Mac::saveLoadWithSerializer ( Common::Serializer ser)
overridevirtual

Save or load the music state.

Reimplemented from Scumm::MusicEngine.


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