xoreos  0.0.5
Public Member Functions | Protected Member Functions | List of all members
Sound::Ima_ADPCMStream Class Reference
Inheritance diagram for Sound::Ima_ADPCMStream:
Inheritance graph
[legend]
Collaboration diagram for Sound::Ima_ADPCMStream:
Collaboration graph
[legend]

Public Member Functions

 Ima_ADPCMStream (Common::SeekableReadStream *stream, bool disposeAfterUse, uint32 size, int rate, int channels, uint32 blockAlign)
 
virtual size_t readBuffer (int16 *buffer, const size_t numSamples)
 Fill the given buffer with up to numSamples samples. More...
 
- Public Member Functions inherited from Sound::ADPCMStream
 ADPCMStream (Common::SeekableReadStream *stream, bool disposeAfterUse, size_t size, int rate, int channels, uint32 blockAlign)
 
 ~ADPCMStream ()
 
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. More...
 
virtual int getChannels () const
 Return the number channels in this stream. More...
 
virtual int getRate () const
 Sample rate of the stream. More...
 
virtual uint64 getLength () const
 Estimate the total number of samples per channel in this stream. More...
 
virtual bool rewind ()
 Rewinds the stream to its start. More...
 
- Public Member Functions inherited from Sound::RewindableAudioStream
virtual uint64 getDuration () const
 Estimate the total duration of the stream in milliseconds. More...
 
- Public Member Functions inherited from Sound::AudioStream
virtual ~AudioStream ()
 
virtual bool endOfStream () const
 End of stream reached? If this returns true, it means that all data in this stream is used up and no additional data will appear in it in the future. More...
 

Protected Member Functions

int16 decodeIMA (byte code, int channel=0)
 
- Protected Member Functions inherited from Sound::ADPCMStream
virtual void reset ()
 
int16 stepAdjust (byte)
 

Additional Inherited Members

- Static Public Attributes inherited from Sound::RewindableAudioStream
static const uint64 kInvalidLength = UINT64_C(0xFFFFFFFFFFFFFFFF)
 
- Static Public Attributes inherited from Sound::AudioStream
static const size_t kSizeInvalid = SIZE_MAX
 
- Protected Attributes inherited from Sound::ADPCMStream
Common::DisposablePtr< Common::SeekableReadStream_stream
 
const size_t _size
 
const size_t _startpos
 
const size_t _endpos
 
const int _channels
 
const uint32 _blockAlign
 
uint32 _blockPos [2]
 
const int _rate
 
uint64 _length
 
struct {
   struct {
      int32   last
 
      int32   stepIndex
 
   }   ima_ch [2]
 
_status
 

Detailed Description

Definition at line 132 of file adpcm.cpp.

Constructor & Destructor Documentation

◆ Ima_ADPCMStream()

Sound::Ima_ADPCMStream::Ima_ADPCMStream ( Common::SeekableReadStream stream,
bool  disposeAfterUse,
uint32  size,
int  rate,
int  channels,
uint32  blockAlign 
)
inline

Member Function Documentation

◆ decodeIMA()

int16 Sound::Ima_ADPCMStream::decodeIMA ( byte  code,
int  channel = 0 
)
protected

Definition at line 466 of file adpcm.cpp.

References Sound::ADPCMStream::_status, ARRAYSIZE, Sound::imaStepTable, and Sound::ADPCMStream::stepAdjust().

Referenced by readBuffer(), Sound::Apple_ADPCMStream::readBuffer(), and Sound::MSIma_ADPCMStream::readBuffer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readBuffer()

size_t Sound::Ima_ADPCMStream::readBuffer ( int16 buffer,
const size_t  numSamples 
)
virtual

Fill the given buffer with up to numSamples samples.

Returns the actual number of samples read, or kSizeInvalid 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 endianness, 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.

The same holds true for more channels. Channel configurations recognized:

  • 5.1: front left, front right, front center, low frequency rear left, rear right

Implements Sound::AudioStream.

Reimplemented in Sound::MSIma_ADPCMStream, and Sound::Apple_ADPCMStream.

Definition at line 148 of file adpcm.cpp.

References Sound::ADPCMStream::_channels, Sound::ADPCMStream::_endpos, Sound::ADPCMStream::_stream, and decodeIMA().

Here is the call graph for this function:

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