Developer World
Spresense Arduino Library v3.2.0-77d75a4
IIRClass Class Reference

Biquad IIR filter class. More...

#include <IIR.h>

Public Types

enum  e_format { Interleave , Planar }
 
enum  e_error {
  ERR_OK = 0 , ERR_CH_NUM = -1 , ERR_FORMAT = -2 , ERR_MEMORY = -3 ,
  ERR_FILTER_TYPE = -4 , ERR_FRAME_SIZE = -5 , ERR_BUF_FULL = -6 , ERR_FS = -7
}
 
typedef enum IIRClass::e_format format_t
 
typedef enum IIRClass::e_error error_t
 

Public Member Functions

bool begin (filterType_t type, int channel, int cutoff, float q, int sample=DEFAULT_FRAMESIZE, format_t output=Planar, int fs=48000)
 Initialize the IIR library. More...
 
bool put (q15_t *pSrc, int size)
 Put input data into the IIR library. More...
 
int get (q15_t *pDst, int channel)
 Get the execution data of each channel. More...
 
int get (q15_t *pDsts)
 Get the execution data of all channels. More...
 
void end ()
 Finalize the IIR library. More...
 
bool empty (int channel)
 Is the buffer empty or not of each channel. More...
 
error_t getErrorCause ()
 Get error information. More...
 

Static Public Attributes

static const int BITLEN = 16
 
static const int DEFAULT_FRAMESIZE = 768
 
static const int MIN_FRAMESIZE = 240
 
static const int MAX_CHANNEL_NUM = 8
 
static const int INPUT_BUFFER_SIZE = 4
 

Detailed Description

Biquad IIR filter class.


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