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

#ifndef INCLUDE_HARMONIFIER_H
#define INCLUDE_HARMONIFIER_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
 *
 *
 * Harmonifier.h
 *
 * Definition of class Harmonifier.
 *
 * Kelly Fitz, 26 Oct 2005
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */
#include "Envelope.h" 
#include "LorisExceptions.h" 
#include "Partial.h"
#include "PartialUtils.h"

#include <algorithm>    // for find
#include <memory>       // for auto_ptr

//      begin namespace
namespace Loris {


// ---------------------------------------------------------------------------
//      Class Harmonifier
//
//
class Harmonifier
{
//      -- instance variables --

        Partial _refPartial;                            

                                                                                
        double _freqFixThresholdDb;                 



        std::auto_ptr< Envelope > _weight;  


    
//      -- public interface --
public:

//      -- lifecycle --

        Harmonifier( const Partial & ref, double threshold_dB = 0 );

        Harmonifier( const Partial & ref, const Envelope & env, 
                     double threshold_dB = 0 );

    //
    //
#if ! defined(NO_TEMPLATE_MEMBERS)
        template<typename Iter>
        Harmonifier( Iter b, Iter e, Partial::label_type refLabel, 
                    double threshold_dB = 0 );
#else
   inline
        Harmonifier( PartialList::iterator b, PartialList::iterator e, 
                     Partial::label_type refLabel, double threshold_dB = 0 );
#endif

    //
    //
#if ! defined(NO_TEMPLATE_MEMBERS)
        template<typename Iter>
        Harmonifier( Iter b, Iter e, Partial::label_type refLabel, 
                     const Envelope & env, double threshold_dB = 0 );
#else
   inline
        Harmonifier( PartialList::iterator b, PartialList::iterator e, 
                     Partial::label_type refLabel, const Envelope & env,
                     double threshold_dB = 0 );
#endif

    ~Harmonifier( void );

    // use compiler-generated copy and assign.

//      -- operation --

    void harmonify( Partial & p ) const;
    
#if ! defined(NO_TEMPLATE_MEMBERS)
        template<typename Iter>
        void harmonify( Iter b, Iter e  );
#else
    inline
    void harmonify( PartialList::iterator b, PartialList::iterator e  );
#endif

// -- static members --

#if ! defined(NO_TEMPLATE_MEMBERS)
        template< typename Iter >
        static 
        void harmonify( Iter b, Iter e, 
                        Partial::label_type refLabel,
                    double threshold_dB = 0 );
#else
        static inline 
        void harmonify( PartialList::iterator b, PartialList::iterator e,
                        Partial::label_type refLabel,
                    double threshold_dB = 0 );
#endif   

#if ! defined(NO_TEMPLATE_MEMBERS)
        template< typename Iter >
        static 
        void harmonify( Iter b, Iter e, 
                        Partial::label_type refLabel,
                    const Envelope & env, double threshold_dB = 0 );
#else
        static inline 
        void harmonify( PartialList::iterator b, PartialList::iterator e,
                        Partial::label_type refLabel,
                    const Envelope & env, double threshold_dB = 0 );
#endif   

private:

//      -- helpers --

    static Envelope * createDefaultEnvelope( void );
    
};

// ---------------------------------------------------------------------------
//      constructor
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
Harmonifier::Harmonifier( Iter b, Iter e, Partial::label_type refLabel, 
                          double threshold_dB ) :
#else
inline
Harmonifier::Harmonifier( PartialList::iterator b, PartialList::iterator e, 
                          Partial::label_type refLabel, double threshold_dB ) :
#endif
    _freqFixThresholdDb( threshold_dB ),
    _weight( createDefaultEnvelope() )
{
    if ( 1 > refLabel )
    {
        Throw( InvalidArgument, "The reference label must be positive." );
    }

    b = std::find_if( b, e, PartialUtils::isLabelEqual( refLabel ) );
    if ( b == e )
        {
                Throw( InvalidArgument, "no Partial has the specified reference label" );
        }

    if ( 0 == b->numBreakpoints() )
    {
        Throw( InvalidArgument, 
               "Cannot use an empty reference Partial in Harmonizer" );
    }
    _refPartial = *b;
}

// ---------------------------------------------------------------------------
//      constructor
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
Harmonifier::Harmonifier( Iter b, Iter e, Partial::label_type refLabel, 
                          const Envelope & env, double threshold_dB ) :
#else
inline
Harmonifier::Harmonifier( PartialList::iterator b, PartialList::iterator e, 
                          Partial::label_type refLabel, const Envelope & env,
                          double threshold_dB ) :
#endif
    _freqFixThresholdDb( threshold_dB ),
    _weight( env.clone() )
{
    if ( 1 > refLabel )
    {
        Throw( InvalidArgument, "The reference label must be positive." );
    }

    b = std::find_if( b, e, PartialUtils::isLabelEqual( refLabel ) );
    if ( b == e )
        {
                Throw( InvalidArgument, "no Partial has the specified reference label" );
        }

    if ( 0 == b->numBreakpoints() )
    {
        Throw( InvalidArgument, 
               "Cannot use an empty reference Partial in Harmonizer" );
    }
    _refPartial = *b;
}

// ---------------------------------------------------------------------------
//      harmonify
// ---------------------------------------------------------------------------
#if ! defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
void Harmonifier::harmonify( Iter b, Iter e  )
#else
inline
void Harmonifier::harmonify( PartialList::iterator b, PartialList::iterator e  )
#endif
{
    while ( b != e )
    {
        harmonify( *b );
        ++b;
    }
}    

// ---------------------------------------------------------------------------
//      harmonify (STATIC)
// ---------------------------------------------------------------------------
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Iter >
void Harmonifier::harmonify( Iter b, Iter e, 
                             Partial::label_type refLabel,
                             double threshold_dB )
#else
inline 
void Harmonifier::harmonify( PartialList::iterator b, PartialList::iterator e,
                             Partial::label_type refLabel,
                             double threshold_dB )
#endif   
{
    Harmonifier instance( b, e, refLabel, threshold_dB );
    instance.harmonify( b, e );
}

// ---------------------------------------------------------------------------
//      harmonify (STATIC)
// ---------------------------------------------------------------------------
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Iter >
void Harmonifier::harmonify( Iter b, Iter e, 
                             Partial::label_type refLabel,
                             const Envelope & env, double threshold_dB )
#else
inline 
void Harmonifier::harmonify( PartialList::iterator b, PartialList::iterator e,
                             Partial::label_type refLabel,
                             const Envelope & env, double threshold_dB )
#endif   
{
    Harmonifier instance( b, e, refLabel, env, threshold_dB );
    instance.harmonify( b, e );
}

}       // namespace Loris

#endif  /* ndef INCLUDE_HARMONIFIER_H */

---