EffectReader Class Reference

This reader is a base class for all effect readers that take one other reader as input. More...

#include <EffectReader.h>

Inheritance diagram for EffectReader:

Public Member Functions
	EffectReader (std::shared_ptr< IReader > reader)
	Creates a new effect reader.
virtual	~EffectReader ()
	Destroys the reader.
virtual bool	isSeekable () const
	Tells whether the source provides seeking functionality or not.
virtual void	seek (int position)
	Seeks to a specific position in the source.
virtual int	getLength () const
	Returns an approximated length of the source in samples.
virtual int	getPosition () const
	Returns the position of the source as a sample count value.
virtual Specs	getSpecs () const
	Returns the specification of the reader.
virtual void	read (int &length, bool &eos, sample_t *buffer)
	Request to read the next length samples out of the source.
Public Member Functions inherited from IReader
virtual	~IReader ()
	Destroys the reader.

Protected Attributes
std::shared_ptr< IReader >	m_reader
	The reader to read from.

Detailed Description

This reader is a base class for all effect readers that take one other reader as input.

Constructor & Destructor Documentation

EffectReader()

EffectReader::EffectReader

(

std::shared_ptr< IReader >

reader

)

Creates a new effect reader.

Parameters

reader

The reader to read from.

Member Function Documentation

getLength()

virtual int EffectReader::getLength ( ) const

virtual

Returns an approximated length of the source in samples.

Returns

The length as sample count. May be negative if unknown.

Implements IReader.

Reimplemented in DelayReader, JOSResampleReader, LimiterReader, LinearResampleReader, LoopReader, and ReverseReader.

getPosition()

virtual int EffectReader::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, especially after seeking.

Implements IReader.

Reimplemented in DelayReader, JOSResampleReader, LimiterReader, LinearResampleReader, LoopReader, and ReverseReader.

getSpecs()

virtual Specs EffectReader::getSpecs ( ) const

virtual

Returns the specification of the reader.

Returns

The Specs structure.

Implements IReader.

Reimplemented in ChannelMapperReader, JOSResampleReader, LinearResampleReader, and PitchReader.

isSeekable()

virtual bool EffectReader::isSeekable ( ) const

virtual

Tells whether the source provides seeking functionality or not.

Warning

This doesn't mean that the seeking always has to succeed.

Returns

Always returns true for readers of buffering types.

Implements IReader.

read()

virtual void EffectReader::read ( int & length, bool & eos, sample_t * buffer )

virtual

Request to read the next length samples out of the source.

The buffer supplied has the needed size.

Parameters

[in,out]	length	The 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]	eos	End of stream, whether the end is reached or not.
[in]	buffer	The pointer to the buffer to read into.

Implements IReader.

Reimplemented in ADSRReader, BaseIIRFilterReader, ChannelMapperReader, ConverterReader, DelayReader, FaderReader, JOSResampleReader, LimiterReader, LinearResampleReader, LoopReader, and ReverseReader.

seek()

virtual void EffectReader::seek ( int position )

virtual

Seeks to a specific position in the source.

Parameters

position

The 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.

Implements IReader.

Reimplemented in DelayReader, JOSResampleReader, LimiterReader, LinearResampleReader, LoopReader, and ReverseReader.

---

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

• fx/EffectReader.h