ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Toon::AudioStreamInstance Class Reference
Inheritance diagram for Toon::AudioStreamInstance:
Audio::AudioStream

Public Member Functions

 AudioStreamInstance (AudioManager *man, Audio::Mixer *mixer, Common::SeekableReadStream *stream, bool looping=false, bool deleteFileStreamAtEnd=false)
 
void play (bool fade=false, Audio::Mixer::SoundType soundType=Audio::Mixer::kMusicSoundType)
 
void stop (bool fade=false)
 
bool isPlaying ()
 
bool isLooping ()
 
bool isFading ()
 
int32 getPlayedSampleCount ()
 
void setVolume (int32 volume)
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Protected Member Functions

int readBuffer (int16 *buffer, const int numSamples) override
 
bool isStereo () const override
 
int getRate () const override
 
bool endOfData () const override
 
void handleFade (int32 numSamples)
 
void stopNow ()
 
bool readPacket ()
 
void decodeADPCM (uint8 *comp, int16 *dest, int32 packetSize)
 

Protected Attributes

Common::SeekableReadStream * _file
 
bool _fadingIn
 
bool _fadingOut
 
int32 _fadeTime
 
uint8 * _compBuffer
 
int16 * _buffer
 
int32 _bufferSize
 
int32 _bufferMaxSize
 
int32 _bufferOffset
 
int32 _compBufferSize
 
Audio::SoundHandle _handle
 
Audio::Mixer::SoundType _soundType
 
Audio::Mixer * _mixer
 
int32 _lastSample
 
int32 _lastStepIndex
 
bool _stopped
 
AudioManager * _man
 
int32 _totalSize
 
int32 _currentReadSize
 
bool _looping
 
int32 _volume
 
int32 _musicAttenuation
 
bool _deleteFileStream
 
int32 _playedSamples
 

Member Function Documentation

◆ readBuffer()

int Toon::AudioStreamInstance::readBuffer ( int16 *  buffer,
const int  numSamples 
)
overrideprotectedvirtual

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 Toon::AudioStreamInstance::isStereo ( ) const
inlineoverrideprotectedvirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ getRate()

int Toon::AudioStreamInstance::getRate ( ) const
inlineoverrideprotectedvirtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ endOfData()

bool Toon::AudioStreamInstance::endOfData ( ) const
inlineoverrideprotectedvirtual

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: