tomwalters@282: // Copyright 2008-2010, Thomas Walters
tomwalters@268: //
tomwalters@268: // AIM-C: A C++ implementation of the Auditory Image Model
tomwalters@268: // http://www.acousticscale.org/AIMC
tomwalters@268: //
tomwalters@268: // This program is free software: you can redistribute it and/or modify
tomwalters@268: // it under the terms of the GNU General Public License as published by
tomwalters@268: // the Free Software Foundation, either version 3 of the License, or
tomwalters@268: // (at your option) any later version.
tomwalters@268: //
tomwalters@268: // This program is distributed in the hope that it will be useful,
tomwalters@268: // but WITHOUT ANY WARRANTY; without even the implied warranty of
tomwalters@268: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tomwalters@268: // GNU General Public License for more details.
tomwalters@268: //
tomwalters@268: // You should have received a copy of the GNU General Public License
tomwalters@268: // along with this program.  If not, see <http://www.gnu.org/licenses/>.
tomwalters@268: 
tomwalters@280: /*! \file
tomwalters@280:  *  \brief Dick Lyon's Pole-Zero Filter Cascade - implemented in C++ by Tom
tomwalters@280:  *  Walters from the AIM-MAT module based on Dick Lyon's code.
tomwalters@280:  *
tomwalters@280:  *  \author Thomas Walters <tom@acousticscale.org>
tomwalters@280:  *  \date created 2008/02/05
tomwalters@296:  * \version \$Id$
tomwalters@280:  */
tomwalters@280: 
tomwalters@268: #ifndef _AIMC_MODULES_BMM_PZFC_H_
tomwalters@268: #define _AIMC_MODULES_BMM_PZFC_H_
tomwalters@268: 
tomwalters@268: #include <vector>
tomwalters@268: 
tomwalters@268: #include "Support/Module.h"
tomwalters@268: #include "Support/Parameters.h"
tomwalters@268: #include "Support/SignalBank.h"
tomwalters@268: 
tomwalters@268: namespace aimc {
tomwalters@268: using std::vector;
tomwalters@268: class ModulePZFC : public Module {
tomwalters@268:  public:
tomwalters@280:   explicit ModulePZFC(Parameters *pParam);
tomwalters@268:   virtual ~ModulePZFC();
tomwalters@268: 
tomwalters@280:   /*! \brief Process a buffer
tomwalters@280:    */
tomwalters@268:   virtual void Process(const SignalBank &input);
tomwalters@268: 
tomwalters@275:  private:
tomwalters@280:   /*! \brief Reset all internal state variables to their initial values
tomwalters@280:    */
tomwalters@280:   virtual void ResetInternal();
tomwalters@268: 
tomwalters@280:   /*! \brief Prepare the module
tomwalters@280:    *  \param input Input SignalBank
tomwalters@280:    *  \param output true on success false on failure
tomwalters@280:    */
tomwalters@268:   virtual bool InitializeInternal(const SignalBank &input);
tomwalters@268: 
tomwalters@280:   /*! \brief Set the filterbank parameters according to a fit matrix from Unoki
tomwalters@280:    *  and Lyon's fitting routine
tomwalters@280:    */
tomwalters@268:   bool SetPZBankCoeffsERBFitted();
tomwalters@268: 
tomwalters@280:   /*! \brief Sets the general filterbank coefficients
tomwalters@280:    */
tomwalters@268:   bool SetPZBankCoeffs();
tomwalters@268: 
tomwalters@280:   /*! \brief Automatic Gain Control
tomwalters@280:    */
tomwalters@268:   void AGCDampStep();
tomwalters@268: 
tomwalters@280:   /*! \brief Detector function - halfwave rectification etc. Used internally,
tomwalters@280:    *  but not applied to the output.
tomwalters@280:    */
tomwalters@268:   float DetectFun(float fIN);
tomwalters@268: 
tomwalters@280:   /*! \brief Minimum
tomwalters@280:    */
tomwalters@268:   inline float Minimum(float a, float b);
tomwalters@268: 
tomwalters@268:   int channel_count_;
tomwalters@268:   int buffer_length_;
tomwalters@268:   int agc_stage_count_;
tomwalters@268:   float sample_rate_;
tomwalters@268:   float last_input_;
tomwalters@268: 
tomwalters@268:   // Parameters
tomwalters@268:   // User-settable scalars
tomwalters@268:   float pole_damping_;
tomwalters@268:   float zero_damping_;
tomwalters@268:   float zero_factor_;
tomwalters@268:   float step_factor_;
tomwalters@268:   float bandwidth_over_cf_;
tomwalters@268:   float min_bandwidth_hz_;
tomwalters@268:   float agc_factor_;
tomwalters@268:   float cf_max_;
tomwalters@268:   float cf_min_;
tomwalters@268:   float mindamp_;
tomwalters@268:   float maxdamp_;
tomwalters@268:   bool do_agc_step_;
tomwalters@268: 
tomwalters@268:   // Internal Buffers
tomwalters@268:   // Initialised once
tomwalters@268:   vector<float> pole_dampings_;
tomwalters@268:   vector<float> agc_epsilons_;
tomwalters@268:   vector<float> agc_gains_;
tomwalters@268:   vector<float> pole_frequencies_;
tomwalters@268:   vector<float> za0_;
tomwalters@268:   vector<float> za1_;
tomwalters@268:   vector<float> za2_;
tomwalters@268:   vector<float> rmin_;
tomwalters@268:   vector<float> rmax_;
tomwalters@268:   vector<float> xmin_;
tomwalters@268:   vector<float> xmax_;
tomwalters@268: 
tomwalters@268:   // Modified by algorithm at each time step
tomwalters@268:   vector<float> detect_;
tomwalters@268:   vector<vector<float> > agc_state_;
tomwalters@268:   vector<float> state_1_;
tomwalters@268:   vector<float> state_2_;
tomwalters@268:   vector<float> previous_out_;
tomwalters@268:   vector<float> pole_damps_mod_;
tomwalters@268:   vector<float> inputs_;
tomwalters@268: };
tomwalters@268: }
tomwalters@268: 
tomwalters@268: #endif  // _AIMC_MODULES_BMM_PZFC_H_