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

Audio::LoopingAudioStream Class Reference

A looping audio stream. More...

#include <audiostream.h>

Inheritance diagram for Audio::LoopingAudioStream:
Collaboration diagram for Audio::LoopingAudioStream:

List of all members.

Public Member Functions

 LoopingAudioStream (RewindableAudioStream *stream, uint loops, DisposeAfterUse::Flag disposeAfterUse=DisposeAfterUse::YES)
 Creates a looping audio stream object.
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.
uint getCompleteIterations () const
 Returns number of loops the stream has played.

Private Attributes

Common::DisposablePtr
< RewindableAudioStream
_parent
uint _loops
uint _completeIterations

Detailed Description

A looping audio stream.

This object does nothing besides using a RewindableAudioStream to play a stream in a loop.

Definition at line 107 of file audiostream.h.


Constructor & Destructor Documentation

Audio::LoopingAudioStream::LoopingAudioStream ( RewindableAudioStream stream,
uint  loops,
DisposeAfterUse::Flag  disposeAfterUse = DisposeAfterUse::YES 
)

Creates a looping audio stream object.

Note that on creation of the LoopingAudioStream object the underlying stream will be rewound.

See also:
makeLoopingAudioStream
Parameters:
stream Stream to loop
loops How often to loop (0 = infinite)
disposeAfterUse Destroy the stream after the LoopingAudioStream has finished playback.

Definition at line 94 of file audiostream.cpp.


Member Function Documentation

bool Audio::LoopingAudioStream::endOfData (  )  const [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 137 of file audiostream.cpp.

bool Audio::LoopingAudioStream::endOfStream (  )  const [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 141 of file audiostream.cpp.

uint Audio::LoopingAudioStream::getCompleteIterations (  )  const [inline]

Returns number of loops the stream has played.

Definition at line 133 of file audiostream.h.

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

Sample rate of the stream.

Implements Audio::AudioStream.

Definition at line 128 of file audiostream.h.

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

Is this a stereo stream?

Implements Audio::AudioStream.

Definition at line 127 of file audiostream.h.

int Audio::LoopingAudioStream::readBuffer ( int16 buffer,
const int  numSamples 
) [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 108 of file audiostream.cpp.


Member Data Documentation

Definition at line 137 of file audiostream.h.


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


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