ScummVM API documentation
Public Member Functions | Protected Types | Protected Member Functions | List of all members
AudioCDStream Class Referenceabstract
Inheritance diagram for AudioCDStream:
Audio::SeekableAudioStream Audio::RewindableAudioStream Audio::AudioStream

Public Member Functions

int readBuffer (int16 *buffer, const int numSamples)
 
bool isStereo () const
 
int getRate () const
 
bool endOfData () const
 
bool seek (const Audio::Timestamp &where)
 
Audio::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
 

Protected Types

enum  { kBytesPerFrame = 2352, kSamplesPerFrame = kBytesPerFrame / 2 }
 
enum  { kSecondsPerMinute = 60, kFramesPerSecond = 75 }
 
enum  { kBufferThreshold = kFramesPerSecond }
 

Protected Member Functions

virtual uint getStartFrame () const =0
 
virtual uint getEndFrame () const =0
 
virtual bool readFrame (int frame, int16 *buffer)=0
 
void startTimer (bool fillBuffer=false)
 
void stopTimer ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Audio::SeekableAudioStream
static SeekableAudioStream * openStreamFile (const Common::Path &basename)
 

Member Function Documentation

◆ readBuffer()

int AudioCDStream::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.

◆ isStereo()

bool AudioCDStream::isStereo ( ) const
inlinevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

◆ getRate()

int AudioCDStream::getRate ( ) const
inlinevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

◆ endOfData()

bool AudioCDStream::endOfData ( ) const
virtual

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.

◆ seek()

bool AudioCDStream::seek ( const Audio::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()

Audio::Timestamp AudioCDStream::getLength ( ) const
virtual

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: