ScummVM API documentation
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
Sci::Mixer_Mac< T > Class Template Reference
Inheritance diagram for Sci::Mixer_Mac< T >:
Audio::AudioStream

Public Types

enum  { kChannels = 4, kInterruptFreq = 60 }
 
enum  Mode { kModeAuthentic, kModeHq, kModeHqStereo }
 

Public Member Functions

 Mixer_Mac (Mode mode)
 
void startMixer ()
 
void stopMixer ()
 
void setMixerVolume (byte volume)
 
void resetChannel (uint channel)
 
void resetChannels ()
 
void setChannelData (uint channel, const byte *data, uint16 startOffset, uint16 endOffset, uint16 loopLength=0)
 
void setChannelStep (uint channel, ufrac_t step)
 
void setChannelVolume (uint channel, byte volume)
 
void setChannelPan (uint channel, byte pan)
 
bool isStereo () const override
 
int getRate () const override
 
int readBuffer (int16 *data, const int numSamples) override
 
bool endOfData () const override
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Public Attributes

Common::Mutex _mutex
 

Member Function Documentation

◆ isStereo()

template<typename T >
bool Sci::Mixer_Mac< T >::isStereo ( ) const
inlineoverridevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ getRate()

template<typename T >
int Sci::Mixer_Mac< T >::getRate ( ) const
inlineoverridevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ readBuffer()

template<typename T >
int Sci::Mixer_Mac< T >::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.

◆ endOfData()

template<typename T >
bool Sci::Mixer_Mac< T >::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.

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