Audaspace 1.5.0
A high level audio library.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CallbackIIRFilterReader Class Reference

This class provides an interface for infinite impulse response filters via a callback filter function. More...

#include <CallbackIIRFilterReader.h>

Inheritance diagram for CallbackIIRFilterReader:
Inheritance graph
[legend]

Public Member Functions

 CallbackIIRFilterReader (std::shared_ptr< IReader > reader, int in, int out, doFilterIIR doFilter, endFilterIIR endFilter=0, void *data=nullptr)
 Creates a new callback IIR filter reader.
 
virtual sample_t filter ()
 Runs the filtering function.
 
- Public Member Functions inherited from BaseIIRFilterReader
sample_t x (int pos)
 Retrieves the last input samples.
 
sample_t y (int pos)
 Retrieves the last output samples.
 
virtual void read (int &length, bool &eos, sample_t *buffer)
 Request to read the next length samples out of the source.
 
virtual void sampleRateChanged (SampleRate rate)
 Notifies the filter about a sample rate change.
 
- Public Member Functions inherited from EffectReader
 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.
 
- Public Member Functions inherited from IReader
virtual ~IReader ()
 Destroys the reader.
 

Additional Inherited Members

- Protected Member Functions inherited from BaseIIRFilterReader
 BaseIIRFilterReader (std::shared_ptr< IReader > reader, int in, int out)
 Creates a new base IIR filter reader.
 
void setLengths (int in, int out)
 Sets the length for the required input and output samples of the IIR filter.
 
- Protected Attributes inherited from EffectReader
std::shared_ptr< IReaderm_reader
 The reader to read from.
 

Detailed Description

This class provides an interface for infinite impulse response filters via a callback filter function.

Constructor & Destructor Documentation

◆ CallbackIIRFilterReader()

CallbackIIRFilterReader::CallbackIIRFilterReader ( std::shared_ptr< IReader > reader,
int in,
int out,
doFilterIIR doFilter,
endFilterIIR endFilter = 0,
void * data = nullptr )

Creates a new callback IIR filter reader.

Parameters
readerThe reader to read from.
inThe count of past input samples needed.
outThe count of past output samples needed.
doFilterThe filter callback.
endFilterThe finishing callback.
dataData pointer for the callbacks.

Member Function Documentation

◆ filter()

virtual sample_t CallbackIIRFilterReader::filter ( )
virtual

Runs the filtering function.

Returns
The current output sample value.

Implements BaseIIRFilterReader.


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