ScummVM API documentation
Audio::Mp3PspStream Class Reference
Inheritance diagram for Audio::Mp3PspStream:
Audio::SeekableAudioStream Audio::RewindableAudioStream Audio::AudioStream

Public Member Functions

 Mp3PspStream (Common::SeekableReadStream *inStream, DisposeAfterUse::Flag dispose)
 
int readBuffer (int16 *buffer, const int numSamples)
 
bool endOfData () const
 
bool isStereo () const
 
int getRate () const
 
bool seek (const Timestamp &where)
 
Timestamp getLength () const
 
- Public Member Functions inherited from Audio::SeekableAudioStream
bool seek (uint32 where)
 
virtual bool rewind ()
 
- Public Member Functions inherited from Audio::AudioStream
virtual bool endOfStream () const
 

Static Public Member Functions

static bool isOkToCreateStream ()
 
- Static Public Member Functions inherited from Audio::SeekableAudioStream
static SeekableAudioStreamopenStreamFile (const Common::Path &basename)
 

Protected Types

enum  State { MP3_STATE_INIT, MP3_STATE_READY, MP3_STATE_EOS }
 
enum  { BUFFER_SIZE = 5 * 8192 }
 

Protected Member Functions

int16 _pcmSamples [1152 *2] __attribute__ ((aligned(64)))
 
byte _codecInBuffer [3072] __attribute__ ((aligned(64)))
 
unsigned long _codecParams [65] __attribute__ ((aligned(64)))
 
void decodeMP3Data ()
 
void readMP3DataIntoBuffer ()
 
int initStream ()
 
void findValidHeader ()
 
void deinitStream ()
 
void updatePcmLength ()
 
bool initStreamME ()
 
void releaseStreamME ()
 

Static Protected Member Functions

static bool loadStartAudioModule (const char *modname, int partition)
 
static bool initDecoder ()
 
static bool stopDecoder ()
 

Protected Attributes

Common::DisposablePtr< Common::SeekableReadStream_inStream
 
uint32 _pcmLength
 
uint _posInFrame
 
State _state
 
Timestamp _length
 
uint32 _sampleRate
 
bool _stereo
 
mad_timer_t _totalTime
 
mad_stream _stream
 
mad_header _header
 
byte _buf [BUFFER_SIZE+MAD_BUFFER_GUARD]
 

Static Protected Attributes

static bool _decoderInit
 
static bool _decoderFail
 

Member Function Documentation

◆ readBuffer()

int Audio::Mp3PspStream::readBuffer ( int16 *  buffer,
const int  numSamples 
)
virtual

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.

◆ endOfData()

bool Audio::Mp3PspStream::endOfData ( ) const
inlinevirtual

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.

◆ isStereo()

bool Audio::Mp3PspStream::isStereo ( ) const
inlinevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ getRate()

int Audio::Mp3PspStream::getRate ( ) const
inlinevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ seek()

bool Audio::Mp3PspStream::seek ( const Timestamp where)
virtual

Seek to a given offset in the stream.

Parameters
whereOffset as a timestamp.
Returns
True on success, false on failure.

Implements Audio::SeekableAudioStream.

◆ getLength()

Timestamp Audio::Mp3PspStream::getLength ( ) const
inlinevirtual

Return the length of the stream.

Returns
Length as a timestamp.

Implements Audio::SeekableAudioStream.


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