ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Gob::SoundMixer Class Reference
Inheritance diagram for Gob::SoundMixer:
Audio::AudioStream Gob::BackgroundAtmosphere Gob::SoundBlaster

Public Member Functions

 SoundMixer (Audio::Mixer &mixer, Audio::Mixer::SoundType type)
 
virtual void play (SoundDesc &sndDesc, int16 repCount, int16 frequency, int16 fadeLength=0)
 
virtual void stop (int16 fadeLength)
 
bool isPlaying () const
 
char getPlayingSound () const
 
void setRepeating (int32 repCount)
 
int readBuffer (int16 *buffer, const int numSamples) override
 
bool isStereo () const override
 
bool endOfData () const override
 
bool endOfStream () const override
 
int getRate () const override
 

Protected Member Functions

virtual void setSample (SoundDesc &sndDesc, int16 repCount, int16 frequency, int16 fadeLength)
 
virtual void checkEndSample ()
 
virtual void endFade ()
 

Protected Attributes

Audio::Mixer * _mixer
 
Audio::SoundHandle _handle
 
Common::Mutex _mutex
 
bool _16bit
 
bool _end
 
byte * _data
 
uint32 _length
 
uint32 _rate
 
int32 _freq
 
int32 _repCount
 
uint32 _offset
 
frac_t _offsetFrac
 
frac_t _offsetInc
 
int16 _cur
 
int16 _last
 
bool _fade
 
int32 _fadeVol
 
int32 _fadeVolStep
 
uint8 _fadeLength
 
uint32 _fadeSamples
 
uint32 _curFadeSamples
 
char _playingSound
 

Member Function Documentation

◆ readBuffer()

int Gob::SoundMixer::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 Gob::SoundMixer::isStereo ( ) const
inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ endOfData()

bool Gob::SoundMixer::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.

◆ endOfStream()

bool Gob::SoundMixer::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 Gob::SoundMixer::getRate ( ) const
inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

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