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

Classes

struct  ADPCMChannelStatus
 

Public Member Functions

 MS_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

void reset ()
 
int16 decodeMS (ADPCMChannelStatus *c, byte)
 
- Protected Member Functions inherited from Sound::ADPCMStream
int16 stepAdjust (byte)
 

Protected Attributes

struct {
   ADPCMChannelStatus   ch [2]
 
_status
 
- 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
 

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
 

Detailed Description

Definition at line 346 of file adpcm.cpp.

Constructor & Destructor Documentation

◆ MS_ADPCMStream()

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

Definition at line 368 of file adpcm.cpp.

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

Here is the call graph for this function:

Member Function Documentation

◆ decodeMS()

int16 Sound::MS_ADPCMStream::decodeMS ( ADPCMChannelStatus c,
byte  code 
)
protected

◆ readBuffer()

size_t Sound::MS_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.

Definition at line 402 of file adpcm.cpp.

References Sound::ADPCMStream::_blockAlign, Sound::ADPCMStream::_blockPos, Sound::ADPCMStream::_channels, Sound::ADPCMStream::_endpos, _status, Sound::ADPCMStream::_stream, CLIP(), decodeMS(), Sound::MSADPCMAdaptCoeff1, and Sound::MSADPCMAdaptCoeff2.

Here is the call graph for this function:

◆ reset()

void Sound::MS_ADPCMStream::reset ( )
inlineprotectedvirtual

Reimplemented from Sound::ADPCMStream.

Definition at line 362 of file adpcm.cpp.

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

Here is the call graph for this function:

Member Data Documentation

◆ _status

struct { ... } Sound::MS_ADPCMStream::_status

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

◆ ch

ADPCMChannelStatus Sound::MS_ADPCMStream::ch[2]

Definition at line 359 of file adpcm.cpp.


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