Blender  V2.59
Public Member Functions
AUD_ReverseReader Class Reference

#include <AUD_ReverseReader.h>

Inheritance diagram for AUD_ReverseReader:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 AUD_ReverseReader (AUD_IReader *reader)
virtual void seek (int position)
virtual int getLength () const
virtual int getPosition () const
virtual void read (int &length, sample_t *&buffer)

Detailed Description

This class reads another reader from back to front.

Note:
The underlying reader must be a buffer.

Definition at line 42 of file AUD_ReverseReader.h.


Constructor & Destructor Documentation

AUD_ReverseReader::AUD_ReverseReader ( AUD_IReader reader)

Creates a new reverse reader.

Parameters:
readerThe reader to read from.
Exceptions:
AUD_ExceptionThrown if the reader specified has an undeterminable/infinite length or is not seekable.

Definition at line 39 of file AUD_ReverseReader.cpp.

References AUD_ERROR_PROPS, AUD_THROW, AUD_EffectReader::isSeekable(), and props_error.


Member Function Documentation

int AUD_ReverseReader::getLength ( ) const [virtual]

Returns an approximated length of the source in samples. For readers of the type buffer this has to return a correct value!

Returns:
The length as sample count. May be negative if unknown.
See also:
getType

Reimplemented from AUD_EffectReader.

Definition at line 53 of file AUD_ReverseReader.cpp.

int AUD_ReverseReader::getPosition ( ) const [virtual]

Returns the position of the source as a sample count value.

Returns:
The current position in the source. A negative value indicates that the position is unknown.
Warning:
The value returned doesn't always have to be correct for readers of the stream type, especially after seeking, it must though for the buffer ones.
See also:
getType

Reimplemented from AUD_EffectReader.

Definition at line 58 of file AUD_ReverseReader.cpp.

void AUD_ReverseReader::read ( int &  length,
sample_t *&  buffer 
) [virtual]

Request to read the next length samples out of the source. The buffer for reading has to stay valid until the next call of this method or until the reader is deleted.

Parameters:
[in,out]lengthThe count of samples that should be read. Shall contain the real count of samples after reading, in case there were only fewer samples available. A smaller value also indicates the end of the reader.
[out]bufferThe pointer to the buffer with the samples.

Reimplemented from AUD_EffectReader.

Definition at line 63 of file AUD_ReverseReader.cpp.

References AUD_SAMPLE_SIZE, AUD_Specs::channels, AUD_Buffer::getBuffer(), AUD_Buffer::getSize(), AUD_EffectReader::getSpecs(), i, length(), AUD_EffectReader::m_reader, AUD_IReader::read(), AUD_Buffer::resize(), and AUD_IReader::seek().

void AUD_ReverseReader::seek ( int  position) [virtual]

Seeks to a specific position in the source. This function must work for buffer type readers.

Parameters:
positionThe position to seek for measured in samples. To get from a given time to the samples you simply have to multiply the time value in seconds with the sample rate of the reader.
Warning:
This may work or not, depending on the actual reader.
See also:
getType

Reimplemented from AUD_EffectReader.

Definition at line 48 of file AUD_ReverseReader.cpp.


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