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

Public Member Functions

 MSIma_ADPCMStream (Common::SeekableReadStream *stream, bool disposeAfterUse, uint32 size, int rate, int channels, uint32 blockAlign)
 
size_t readBuffer (int16 *buffer, const size_t numSamples)
 Fill the given buffer with up to numSamples samples. More...
 
void reset ()
 
- Public Member Functions inherited from Sound::Ima_ADPCMStream
 Ima_ADPCMStream (Common::SeekableReadStream *stream, bool disposeAfterUse, uint32 size, int rate, int channels, uint32 blockAlign)
 
- 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...
 

Private Attributes

int16 _buffer [2][8]
 
int _samplesLeft [2]
 

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 Member Functions inherited from Sound::Ima_ADPCMStream
int16 decodeIMA (byte code, int channel=0)
 
- Protected Member Functions inherited from Sound::ADPCMStream
int16 stepAdjust (byte)
 
- 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 256 of file adpcm.cpp.

Constructor & Destructor Documentation

◆ MSIma_ADPCMStream()

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

Definition at line 258 of file adpcm.cpp.

References Sound::ADPCMStream::_blockAlign, Sound::ADPCMStream::_channels, Sound::ADPCMStream::_length, _samplesLeft, Sound::ADPCMStream::_size, and error().

Here is the call graph for this function:

Member Function Documentation

◆ readBuffer()

size_t Sound::MSIma_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

Reimplemented from Sound::Ima_ADPCMStream.

Definition at line 288 of file adpcm.cpp.

References Sound::ADPCMStream::_blockAlign, Sound::ADPCMStream::_blockPos, _buffer, Sound::ADPCMStream::_channels, Sound::ADPCMStream::_endpos, _samplesLeft, Sound::ADPCMStream::_status, Sound::ADPCMStream::_stream, and Sound::Ima_ADPCMStream::decodeIMA().

Here is the call graph for this function:

◆ reset()

void Sound::MSIma_ADPCMStream::reset ( )
inlinevirtual

Reimplemented from Sound::ADPCMStream.

Definition at line 277 of file adpcm.cpp.

References _samplesLeft, and Sound::ADPCMStream::reset().

Here is the call graph for this function:

Member Data Documentation

◆ _buffer

int16 Sound::MSIma_ADPCMStream::_buffer[2][8]
private

Definition at line 284 of file adpcm.cpp.

Referenced by readBuffer().

◆ _samplesLeft

int Sound::MSIma_ADPCMStream::_samplesLeft[2]
private

Definition at line 285 of file adpcm.cpp.

Referenced by MSIma_ADPCMStream(), readBuffer(), and reset().


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