Audaspace 1.5.0
A high level audio library.
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
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:
Inheritance graph
[legend]

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< IReaderm_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
readerThe 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, LimiterReader, LoopReader, ReverseReader, JOSResampleReader, and LinearResampleReader.

◆ 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, LimiterReader, LoopReader, ReverseReader, JOSResampleReader, and LinearResampleReader.

◆ getSpecs()

virtual Specs EffectReader::getSpecs ( ) const
virtual

Returns the specification of the reader.

Returns
The Specs structure.

Implements IReader.

Reimplemented in PitchReader, ChannelMapperReader, JOSResampleReader, and LinearResampleReader.

◆ 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]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]eosEnd of stream, whether the end is reached or not.
[in]bufferThe pointer to the buffer to read into.

Implements IReader.

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

◆ seek()

virtual void EffectReader::seek ( int position)
virtual

Seeks to a specific position in the source.

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.

Implements IReader.

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


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