/Users/kfitz/Projects/Loris/Loris development/src/Analyzer.h

#ifndef INCLUDE_ANALYZER_H
#define INCLUDE_ANALYZER_H
/*
 * This is the Loris C++ Class Library, implementing analysis, 
 * manipulation, and synthesis of digitized sounds using the Reassigned 
 * Bandwidth-Enhanced Additive Sound Model.
 *
 * Loris is Copyright (c) 1999-2010 by Kelly Fitz and Lippold Haken
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * Analyzer.h
 *
 * Definition of class Loris::Analyzer.
 *
 * Kelly Fitz, 5 Dec 99
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */
#include <memory>
#include <vector>
#include "LinearEnvelope.h"
#include "Partial.h"
#include "PartialList.h"
// #include "SpectralPeaks.h"

//  begin namespace
namespace Loris {

class Envelope;
class LinearEnvelopeBuilder;
// class Peaks;
// class Peaks::iterator;
//  oooo, this is nasty, need to fix it!
class SpectralPeak;
typedef std::vector< SpectralPeak > Peaks;

// ---------------------------------------------------------------------------
//  class Analyzer
//
//
class Analyzer
{
//  -- public interface --
public:

//  -- construction --

    explicit Analyzer( double resolutionHz );
    
    Analyzer( double resolutionHz, double windowWidthHz );

    Analyzer( const Envelope & resolutionEnv, double windowWidthHz );

    Analyzer( const Analyzer & other );

    ~Analyzer( void );

    Analyzer & operator=( const Analyzer & rhs );

//  -- configuration --

    void configure( double resolutionHz );

    void configure( double resolutionHz, double windowWidthHz );

        //
        void configure( const Envelope & resolutionEnv, double windowWidthHz );    
    
//  -- analysis --

    void analyze( const std::vector<double> & vec, double srate );
    
    void analyze( const double * bufBegin, const double * bufEnd, double srate );
    
//  -- tracking analysis --

    void analyze( const std::vector<double> & vec, double srate, 
                  const Envelope & reference );
    
    void analyze( const double * bufBegin, const double * bufEnd, double srate,
                  const Envelope & reference );
    
//  -- parameter access --

    double ampFloor( void ) const;

    double cropTime( void ) const;

    double freqDrift( void ) const;

    double freqFloor( void ) const;
        
        double freqResolution( double time = 0.0 ) const; 

    double hopTime( void ) const;

    double sidelobeLevel( void ) const;

    double windowWidth( void ) const;
     
    bool phaseCorrect( void ) const;


//  -- parameter mutation --

    void setAmpFloor( double x );

    void setCropTime( double x );

    void setFreqDrift( double x );

    void setFreqFloor( double x );

    void setFreqResolution( double x );
    
        void setFreqResolution( const Envelope & e );    

    void setHopTime( double x );

    void setSidelobeLevel( double x );

    void setWindowWidth( double x );

    void setPhaseCorrect( bool TF = true );
    
    
//  -- bandwidth envelope specification --

    enum { Default_ResidueBandwidth_RegionWidth = 2000,
           Default_ConvergenceBandwidth_TolerancePct = 10 };
           
    void storeResidueBandwidth( double regionWidth = Default_ResidueBandwidth_RegionWidth );
    
    void storeConvergenceBandwidth( double tolerancePct = 
                0.01 * (double)Default_ConvergenceBandwidth_TolerancePct );
    
    void storeNoBandwidth( void );
    
    bool bandwidthIsResidue( void ) const;
    
    bool bandwidthIsConvergence( void ) const;
    
    double bwRegionWidth( void ) const;

    double bwConvergenceTolerance( void ) const;

    bool associateBandwidth( void ) const
        { return bandwidthIsResidue() || bandwidthIsConvergence(); }

    void setBwRegionWidth( double x ) 
        { 
            if ( x != 0 )
            {
                storeResidueBandwidth( x ); 
            }
            else
            {
                storeNoBandwidth();
            }
        }
           

//  -- PartialList access --

    PartialList & partials( void );

    const PartialList & partials( void ) const;

//  -- envelope access --

    enum { Default_FundamentalEnv_ThreshDb = -60, 
           Default_FundamentalEnv_ThreshHz = 8000 };

    void buildFundamentalEnv( double fmin, double fmax, 
                              double threshDb = Default_FundamentalEnv_ThreshDb, 
                              double threshHz = Default_FundamentalEnv_ThreshHz );                                     


    const LinearEnvelope & fundamentalEnv( void ) const;

    const LinearEnvelope & ampEnv( void ) const;
    
    
//  -- legacy support --
    
    //  Fundamental and amplitude envelopes are always constructed during
    //  analysis, these members do nothing, and are retained for backwards
    //  compatibility.
    void buildAmpEnv( bool TF = true ) { TF = TF; }
    void buildFundamentalEnv( bool TF = true ) { TF = TF; }

//  -- private member variables --

private:

    std::auto_ptr< Envelope > m_freqResolutionEnv;    
    
    double m_ampFloor;          

    
    double m_windowWidth;       



    
    // std::auto_ptr< Envelope > m_freqFloorEnv; 
    double m_freqFloor;         

    
    double m_freqDrift;         


    
    double m_hopTime;           

    
    double m_cropTime;          


    
    double m_bwAssocParam;      





                                                        
    double m_sidelobeLevel;     

                                
    bool m_phaseCorrect;        

                            
    PartialList m_partials;     
        
    std::auto_ptr< LinearEnvelopeBuilder > m_f0Builder;

    std::auto_ptr< LinearEnvelopeBuilder > m_ampEnvBuilder;

//  -- private auxiliary functions --
//      future development
/*

        //      These members make up the sequence of operations in an
        //      analysis. If analysis were ever to be made into a 
        //      template method, these would be the operations that
        //      derived classes could override. Or each of these could
        //      be represented by a strategy class.

        void computeSpectrum( void );
        
        void selectPeaks( void );
        
        void associateBandwidth( void );
        
        void formPartials( Peaks & peaks );
*/
    //  Reject peaks that are too close in frequency to a louder peak that is
    //  being retained, and peaks that are too quiet. Peaks that are retained,
    //  but are quiet enough to be in the specified fadeRange should be faded.
    //  
    //  Rejected peaks are placed at the end of the peak collection.
    //  Return the first position in the collection containing a rejected peak,
    //  or the end of the collection if no peaks are rejected.
    Peaks::iterator thinPeaks( Peaks & peaks, double frameTime  );
                
    //  Fix the bandwidth value stored in the specified Peaks. 
    //  This function is invoked if the spectral residue method is
    //  not used to compute bandwidth (that method overwrites the
    //  bandwidth already). If the convergence method is used to 
    //  compute bandwidth, the appropriate scaling is applied
    //  to the stored mixed phase derivative. Otherwise, the
    //  Peak bandwidth is set to zero.
    void fixBandwidth( Peaks & peaks );
                    
};  //  end of class Analyzer

}   //  end of namespace Loris

#endif /* ndef INCLUDE_ANALYZER_H */

---