ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Audio::Oki_ADPCMStream Class Reference

#include <adpcm_intern.h>

Inheritance diagram for Audio::Oki_ADPCMStream:
Collaboration diagram for Audio::Oki_ADPCMStream:

List of all members.

Public Member Functions

 Oki_ADPCMStream (Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse, uint32 size, int rate, int channels, uint32 blockAlign)
virtual bool endOfData () const
 End of data reached? If this returns true, it means that at this time there is no data available in the stream.
virtual int readBuffer (int16 *buffer, const int numSamples)
 Fill the given buffer with up to numSamples samples.

Protected Member Functions

int16 decodeOKI (byte)

Private Attributes

uint8 _decodedSampleCount
int16 _decodedSamples [2]

Detailed Description

Definition at line 83 of file adpcm_intern.h.

Constructor & Destructor Documentation

Audio::Oki_ADPCMStream::Oki_ADPCMStream ( Common::SeekableReadStream stream,
DisposeAfterUse::Flag  disposeAfterUse,
uint32  size,
int  rate,
int  channels,
uint32  blockAlign 
) [inline]

Definition at line 85 of file adpcm_intern.h.

Member Function Documentation

int16 Audio::Oki_ADPCMStream::decodeOKI ( byte  code  )  [protected]

Definition at line 101 of file adpcm.cpp.

virtual bool Audio::Oki_ADPCMStream::endOfData (  )  const [inline, virtual]

End of data reached? If this returns true, it means that at this time there is no data available in the stream.

However there may be more data in the future. This is used by e.g. a rate converter to decide whether to keep on converting data or stop.

Reimplemented from Audio::ADPCMStream.

Definition at line 88 of file adpcm_intern.h.

int Audio::Oki_ADPCMStream::readBuffer ( int16 buffer,
const int  numSamples 
) [virtual]

Fill the given buffer with up to numSamples samples.

Returns the actual number of samples read, or -1 if a critical error occurred (note: you *must* check if this value is less than what you requested, this can happen when the stream is fully used up).

Data has to be in native endianess, 16 bit per sample, signed. For stereo stream, buffer will be filled with interleaved left and right channel samples, starting with a 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.

Implements Audio::AudioStream.

Definition at line 70 of file adpcm.cpp.

Member Data Documentation

Definition at line 96 of file adpcm_intern.h.

Definition at line 97 of file adpcm_intern.h.

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

Generated on Sat Aug 8 2020 05:03:01 for ResidualVM by doxygen 1.7.1
curved edge   curved edge