ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Audio::LimitingAudioStream Class Reference

An AudioStream wrapper that cuts off the amount of samples read after a given time length is reached. More...

Inheritance diagram for Audio::LimitingAudioStream:
Collaboration diagram for Audio::LimitingAudioStream:

List of all members.

Public Member Functions

 LimitingAudioStream (AudioStream *parentStream, const Audio::Timestamp &length, DisposeAfterUse::Flag disposeAfterUse)
 ~LimitingAudioStream ()
int readBuffer (int16 *buffer, const int numSamples)
 Fill the given buffer with up to numSamples samples.
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.
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.
bool isStereo () const
 Is this a stereo stream?
int getRate () const
 Sample rate of the stream.

Private Member Functions

int getChannels () const
bool reachedLimit () const

Private Attributes

AudioStream_parentStream
DisposeAfterUse::Flag _disposeAfterUse
uint32 _totalSamples
uint32 _samplesRead

Detailed Description

An AudioStream wrapper that cuts off the amount of samples read after a given time length is reached.

Definition at line 433 of file audiostream.cpp.


Constructor & Destructor Documentation

Audio::LimitingAudioStream::LimitingAudioStream ( AudioStream parentStream,
const Audio::Timestamp length,
DisposeAfterUse::Flag  disposeAfterUse 
) [inline]

Definition at line 435 of file audiostream.cpp.

Audio::LimitingAudioStream::~LimitingAudioStream (  )  [inline]

Definition at line 439 of file audiostream.cpp.


Member Function Documentation

bool Audio::LimitingAudioStream::endOfData (  )  const [inline, virtual]

End of data reached? If this returns true, it means that at this time there is no data available in the stream.

However there may be more data in the future. This is used by e.g. a rate converter to decide whether to keep on converting data or stop.

Implements Audio::AudioStream.

Definition at line 451 of file audiostream.cpp.

bool Audio::LimitingAudioStream::endOfStream (  )  const [inline, virtual]

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.

This is used by the mixer to decide whether a given stream shall be removed from the list of active streams (and thus be destroyed). By default this maps to endOfData()

Reimplemented from Audio::AudioStream.

Definition at line 452 of file audiostream.cpp.

int Audio::LimitingAudioStream::getChannels (  )  const [inline, private]

Definition at line 457 of file audiostream.cpp.

int Audio::LimitingAudioStream::getRate (  )  const [inline, virtual]

Sample rate of the stream.

Implements Audio::AudioStream.

Definition at line 454 of file audiostream.cpp.

bool Audio::LimitingAudioStream::isStereo (  )  const [inline, virtual]

Is this a stereo stream?

Implements Audio::AudioStream.

Definition at line 453 of file audiostream.cpp.

bool Audio::LimitingAudioStream::reachedLimit (  )  const [inline, private]

Definition at line 458 of file audiostream.cpp.

int Audio::LimitingAudioStream::readBuffer ( int16 buffer,
const int  numSamples 
) [inline, virtual]

Fill the given buffer with up to numSamples samples.

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

Implements Audio::AudioStream.

Definition at line 444 of file audiostream.cpp.


Member Data Documentation

Definition at line 462 of file audiostream.cpp.


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


Generated on Sat Mar 16 2019 05:05:18 for ResidualVM by doxygen 1.7.1
curved edge   curved edge