Marsyas  0.6.0-alpha
/usr/src/RPM/BUILD/marsyas-0.6.0/src/marsyas/marsystems/AimSSI.h
Go to the documentation of this file.
00001 /*
00002 ** Copyright (C) 1998-2006 George Tzanetakis <gtzan@cs.uvic.ca>
00003 **
00004 ** This program is free software; you can redistribute it and/or modify
00005 ** it under the terms of the GNU General Public License as published by
00006 ** the Free Software Foundation; either version 2 of the License, or
00007 ** (at your option) any later version.
00008 **
00009 ** This program is distributed in the hope that it will be useful,
00010 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 ** GNU General Public License for more details.
00013 **
00014 ** You should have received a copy of the GNU General Public License
00015 ** along with this program; if not, write to the Free Software
00016 ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00017 */
00018 
00019 #ifndef MARSYAS_AIMSSI_H
00020 #define MARSYAS_AIMSSI_H
00021 
00022 #include <marsyas/system/MarSystem.h>
00023 
00024 // sness - TODO - Eventually make these realvecs.  However, in the
00025 // existing code there is quite a bit of stuff that involves STL
00026 // methods, so I thought it would be safer to use STL for now.
00027 #include <vector>
00028 
00029 namespace Marsyas
00030 {
00046 class marsyas_EXPORT AimSSI: public MarSystem
00047 {
00048 private:
00049   void myUpdate(MarControlPtr sender);
00050 
00051   // Reset all internal state variables to their initial values
00052   void ResetInternal();
00053 
00054   // Prepare the module
00055   bool InitializeInternal();
00056 
00057   // Does the MarSystem need initialization?
00058   bool is_initialized;
00059 
00060   // What changes cause it to need initialization?
00061   mrs_real initialized_israte;
00062 
00063   // Does the MarSystem need reset?
00064   bool is_reset;
00065 
00066   // What changes cause it to need a reset?
00067   mrs_natural reset_inobservations;
00068 
00069   int ExtractPitchIndex(realvec& in) const;
00070 
00071   // The MarControls
00072   MarControlPtr ctrl_do_pitch_cutoff_;
00073   MarControlPtr ctrl_weight_by_cutoff_;
00074   MarControlPtr ctrl_weight_by_scaling_;
00075   MarControlPtr ctrl_log_cycles_axis_;
00076   MarControlPtr ctrl_pitch_search_start_ms_;
00077   MarControlPtr ctrl_ssi_width_cycles_;
00078   MarControlPtr ctrl_pivot_cf_;
00079 
00080   // sness - From AimGammatone.  We need these in order to calculate
00081   // the centre frequencies.
00082   MarControlPtr ctrl_max_frequency_;
00083   MarControlPtr ctrl_min_frequency_;
00084   bool is_centre_frequencies_calculated;
00085   std::vector<double> centre_frequencies_;
00086   void CalculateCentreFrequencies();
00087 
00088   // double sample_rate_;
00089   // int buffer_length_;
00090   // int channel_count_;
00091   int ssi_width_samples_;
00092 
00093   double Log2( double n );
00094 
00095 public:
00096   AimSSI(std::string name);
00097 
00098   ~AimSSI();
00099   MarSystem* clone() const;
00100   void addControls();
00101 
00102   void myProcess(realvec& in, realvec& out);
00103 };
00104 
00105 }//namespace marsyas
00106 
00107 #endif