bpmdsp/bpm_dsp.h

Go to the documentation of this file.

/*
  libbpm - BPM signal processing/simulation library
  Copyright (C) 2006-07 Bino Maiheu (bino@hep.ucl.ac.uk)
  
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA 
*/

#ifndef BPMDSP_H__
#define BPMDSP_H__

/* -----------------------------------------------------------------------------
// includes
// -------------------------------------------------------------------------- */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>

#include "bpm/bpm_defs.h"
#include "bpm/bpm_messages.h"
#include "bpm/bpm_alloc.h"
#include "bpm/bpm_nr.h"
#include "bpm/bpm_wf.h"

/* -----------------------------------------------------------------------------
// macro definitions
// -------------------------------------------------------------------------- */
#define BESSEL                 0x0000001 
#define BUTTERWORTH            0x0000002 
#define CHEBYSHEV              0x0000004 
#define RAISEDCOSINE           0x0000008 
#define RESONATOR              0x0000010 
#define GAUSSIAN               0x0000020 
#define BILINEAR_Z_TRANSFORM   0x0000100 
#define MATCHED_Z_TRANSFORM    0x0000200 
#define NO_PREWARP             0x0000400 
#define CAUSAL                 0x0000800 
#define ANTICAUSAL             0x0001000 
#define NONCAUSAL              0x0001800 
#define GAUSSIAN_SIGMA_BW      0x0002000 
#define LOWPASS                0x0010000 
#define HIGHPASS               0x0020000 
#define BANDPASS               0x0040000 
#define BANDSTOP               0x0080000 
#define NOTCH                  0x0080000 
#define ALLPASS                0x0100000 
#define FIR                    0x0200000 
#define IIR                    0x0400000 
#define MAXORDER                   10  
#define MAXPZ                      50  
#define FILT_EPS              1.0e-10  
#define MAX_RESONATOR_ITER         50  
#define FFT_FORWARD                 0  
#define FFT_BACKWARD                1  
/* -----------------------------------------------------------------------------
// typedefs, enums and other declarations
// -------------------------------------------------------------------------- */
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  int        npoles;       
  int        nzeros;       
  complex_t  pole[MAXPZ];  
  complex_t  zero[MAXPZ];  
} filterrep_t;

typedef struct {
  char          name[80];      
  unsigned int  options;       
  int           order;         
  double        fs;            
  double        f1;            
  double        f2;            
  double        alpha1;        
  double        alpha2;        
  double        w_alpha1;      
  double        w_alpha2;      
  double        cheb_ripple;   
  double        Q;             
  double        gauss_cutoff;  
  complex_t     dc_gain;       
  complex_t     fc_gain;       
  complex_t     hf_gain;       
  double        gain;          
  filterrep_t  *cplane;        
  int           nxc;            
  double        xc[MAXPZ+1];    
  int           nxc_ac;         
  double        xc_ac[MAXPZ+1]; 
  int           nyc;            
  double        yc[MAXPZ+1];    
  int           nyc_ac;         
  double        yc_ac[MAXPZ+1]; 
  double        xv[MAXPZ+1];     
  double        xv_ac[MAXPZ+1];  
  double        yv[MAXPZ+1];     
  double        yv_ac[MAXPZ+1];  
  int           ns;            
  double       *wfbuffer;      
} filter_t;

  
/* -----------------------------------------------------------------------------
// function prototypes and declarations
// -------------------------------------------------------------------------- */

  EXTERN filter_t* create_filter( char name[], unsigned int options, int order,
                                  int ns, double fs, double f1, double f2, double par );

  EXTERN int apply_filter( filter_t *f, double *wf );


  EXTERN void print_filter( FILE *of, filter_t *f );

  EXTERN void delete_filter( filter_t *f );


  EXTERN int filter_step_response( filter_t *f, double *wf, int itrig );

  EXTERN int filter_impulse_response( filter_t *f, double *wf, int itrig );
  


  EXTERN filterrep_t* create_splane_representation( filter_t *f );


  EXTERN filterrep_t* create_resonator_representation( filter_t *f );

  EXTERN filterrep_t* zplane_transform( filter_t *f, filterrep_t *s );


  EXTERN void print_filter_representation( FILE* of, filterrep_t *r );

  
  EXTERN int normalise_filter( filter_t *f, filterrep_t *s );


  EXTERN int calculate_filter_coefficients( filter_t *f );
  

  EXTERN int gaussian_filter_coeffs( filter_t *f );


  EXTERN int _expand_complex_polynomial( complex_t *w, int n, complex_t *a );

  EXTERN complex_t _eval_complex_polynomial( complex_t *a, int n, complex_t z );


  // -- DDC routines -----------------------------------------------------

  EXTERN int ddc_initialise( int ns, double fs );

  EXTERN void ddc_cleanup( void );
  
  int ddc( doublewf_t *w, double f, filter_t *filter, complexwf_t *dcw );


  // -- DFT (FFT) routines ---------------------------------------------------

  EXTERN int  fft_gen_tables( void );

  EXTERN int  fft_initialise( int ns );
  
  EXTERN void fft_cleanup( void );
  
  EXTERN int  complexfft( complexwf_t *z, int fft_mode ); 

  EXTERN int  realfft( doublewf_t *y, int fft_mode, complexwf_t *z );


#ifdef __cplusplus
}
#endif

#endif /* #ifndef __BPM_FILTER_H_LOADED */

/* ================================ end of file ============================= */

---