view libaf/filter.h @ 14269:718ec28220d6

Doxygen comments improved

+
鐃緒申/*=============================================================================
+
鐃緒申//	
+
鐃緒申//  This software has been released under the terms of the GNU General Public
+
鐃緒申//  license. See http://www.gnu.org/copyleft/gpl.html for details.
+
鐃緒申//
+
鐃緒申//  Copyright 2001 Anders Johansson [e-mail]
+
鐃緒申//
+
鐃緒申//=============================================================================
+
鐃緒申*/
+
鐃緒申
+
鐃緒申#if !defined _DSP_H
+
鐃緒申# error "Never use <filter.h> directly; include <dsp.h> instead"
+
鐃緒申#endif
+
鐃緒申
+
鐃緒申#ifndef _FILTER_H
+
鐃緒申#define _FILTER_H	1
+
鐃緒申
+
鐃緒申
+
鐃緒申// Design and implementation of different types of digital filters 
+
鐃緒申
+
鐃緒申
+
鐃緒申// Flags used for filter design
+
鐃緒申
+
鐃緒申// Filter characteristics
+
鐃緒申#define LP          0x00010000 // Low pass
+
鐃緒申#define HP          0x00020000 // High pass
+
鐃緒申#define BP          0x00040000 // Band pass
+
鐃緒申#define BS          0x00080000 // Band stop
+
鐃緒申#define TYPE_MASK   0x000F0000
+
鐃緒申
+
鐃緒申// Window types
+
鐃緒申#define BOXCAR      0x00000001
+
鐃緒申#define TRIANG      0x00000002
+
鐃緒申#define HAMMING     0x00000004
+
鐃緒申#define HANNING     0x00000008
+
鐃緒申#define BLACKMAN    0x00000010
+
鐃緒申#define FLATTOP     0x00000011
+
鐃緒申#define KAISER      0x00000012
+
鐃緒申#define WINDOW_MASK 0x0000001F
+
鐃緒申
+
鐃緒申// Parallel filter design
+
鐃緒申#define	FWD   	    0x00000001 // Forward indexing of polyphase filter
+
鐃緒申#define REW         0x00000002 // Reverse indexing of polyphase filter
+
鐃緒申#define ODD         0x00000010 // Make filter HP
+
鐃緒申
+
鐃緒申// Exported functions
+
鐃緒申extern _ftype_t fir(unsigned int n, _ftype_t* w, _ftype_t* x);
+
鐃緒申
+
鐃緒申extern _ftype_t* pfir(unsigned int n, unsigned int k, unsigned int xi, _ftype_t** w, _ftype_t** x, _ftype_t* y, unsigned int s);
+
鐃緒申
+
鐃緒申extern int updateq(unsigned int n, unsigned int xi, _ftype_t* xq, _ftype_t* in);
+
鐃緒申extern int updatepq(unsigned int n, unsigned int k, unsigned int xi, _ftype_t** xq, _ftype_t* in, unsigned int s);
+
鐃緒申
+
鐃緒申extern int design_fir(unsigned int n, _ftype_t* w, _ftype_t* fc, unsigned int flags, _ftype_t opt);
+
鐃緒申
+
鐃緒申extern int design_pfir(unsigned int n, unsigned int k, _ftype_t* w, _ftype_t** pw, _ftype_t g, unsigned int flags);
+
鐃緒申
+
鐃緒申extern int szxform(_ftype_t* a, _ftype_t* b, _ftype_t Q, _ftype_t fc, _ftype_t fs, _ftype_t *k, _ftype_t *coef);
+
鐃緒申
+
鐃緒申/* Add new data to circular queue designed to be used with a FIR
+
鐃緒申   filter. xq is the circular queue, in pointing at the new sample, xi
+
鐃緒申   current index for xq and n the length of the filter. xq must be n*2
+
鐃緒申   long. 
+
鐃緒申*/
+
鐃緒申#define updateq(n,xi,xq,in)\
+
鐃緒申  xq[xi]=(xq)[(xi)+(n)]=*(in);\
+
鐃緒申  xi=(++(xi))&((n)-1);
+
鐃緒申
+
鐃緒申#endif