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

#ifndef INCLUDE_SYNTHESIZER_H
#define INCLUDE_SYNTHESIZER_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
 *
 *
 * Synthesizer.h
 *
 * Definition of class Loris::Synthesizer, a renderer of 
 * bandwidth-enhanced Partials.
 *
 * Kelly Fitz, 16 Aug 1999
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */
 
 
 //     TODO:
 //     Passing the sample vector in to Synthesizer no longer makes any sense,
 //     if the Synthesizer can (must) resize the buffer anyway, it may as well 
 // own it. In a future version, the Synthesizer owns a vector (need to add
 //     a method to clear it), and provides access to it (as it currently does). 
 // When this change is made, it probably makes sense to remove the function
 // call operators.
 

#include "Oscillator.h"
#include "PartialList.h"
#include "PartialUtils.h"

#include <vector>

//      begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//      class Synthesizer
//
//
class Synthesizer
{
//      -- public interface --
public:
//      -- construction --

    struct Parameters;  //  defined below

        Synthesizer( std::vector<double> & buffer );    


        Synthesizer( Parameters params, std::vector<double> & buffer ); 
        
        Synthesizer( double srate, std::vector<double> & buffer );
                     
        Synthesizer( double srate, std::vector<double> & buffer, double fadeTime );
        
        //      Compiler can generate copy, assign, and destroy.
        //      Synthesizer( const Synthesizer & other );
        //      ~Synthesizer( void );
        //      Synthesizer & operator= ( const Synthesizer & other );
         
//      -- synthesis --

        void synthesize( Partial p );   
         
        void operator() ( const Partial & p ) { synthesize( p ) ; }

         
#if ! defined(NO_TEMPLATE_MEMBERS)
        template< typename Iter >
        void synthesize( Iter begin_partials, Iter end_partials );
#else
    inline
        void synthesize( PartialList::iterator begin_partials, 
                                         PartialList::iterator end_partials );  
#endif
         
#if ! defined(NO_TEMPLATE_MEMBERS)
        template< typename Iter >
        void operator() ( Iter begin_partials, Iter end_partials );
#else
    inline
        void operator() ( PartialList::iterator begin_partials, 
                                          PartialList::iterator end_partials );
#endif
        
//      -- sample access --

        const std::vector<double> & samples( void ) const;

        std::vector<double> & samples( void );
        
        
//      -- parameter access and mutation --


        double fadeTime( void ) const;
         
        double sampleRate( void ) const;

        void setFadeTime( double partialFadeTime );

        void setSampleRate( double rate );

        Filter & filter( void );
        

//      -- parameters structure --

    enum
    {
        Default_FadeTime_Ms = 1,
        Default_SampleRate_Hz = 44100
    };
    
    // enum EnhancementFlag { Sinusoidal = 0,  BwEnhanced = 1 };

        struct Parameters
        {
                double fadeTime;
                double sampleRate;
                // EnhancementFlag enhancement;
                
                Filter filter;
                
                //  default constructor
                //
                Parameters( void );
                
                //      copy, assign, and destroy are free
        };              
        
        static const Parameters & DefaultParameters( void );

        static void SetDefaultParameters( const Parameters & params );
        
        static bool IsValidParameters( const Parameters & params );
        

//      -- implementation --
private:

        Oscillator m_osc;       //  the Synthesizer has-a Oscillator that it uses to render
                        //  all the Partials one by one. 
    
        std::vector< double > * m_sampleBuffer; //      samples are computed and stored here, BUT
                                                //  Synthesizer does NOT own this buffer.
        
        double m_fadeTimeSec;                   //  Partial fade in/out time in seconds
        double m_srateHz;                       //      sample rate in Hz
                
};      //      end of class Synthesizer


// ---------------------------------------------------------------------------
//      synthesize 
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
void 
Synthesizer::synthesize( Iter begin_partials, Iter end_partials ) 
#else
inline void 
Synthesizer::synthesize( PartialList::iterator begin_partials, 
                                                 PartialList::iterator end_partials ) 
#endif
{ 
    //  grow the sample buffer, if necessary, to accommodate the latest
    //  Partial, with the fade time tacked on the end
    double duration = 
        PartialUtils::timeSpan( begin_partials, end_partials ).second + 
        m_fadeTimeSec;
    
    typedef std::vector< double >::size_type Sz_Type;
    Sz_Type Nsamps = 1 + Sz_Type( duration * m_srateHz );    
    if ( m_sampleBuffer->size() < Nsamps )
    {
        m_sampleBuffer->resize( Nsamps );
    }
    
    while ( begin_partials != end_partials ) 
    {
        synthesize( *(begin_partials++) ); 
    }
}

// ---------------------------------------------------------------------------
//      operator() 
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
void
Synthesizer::operator() ( Iter begin_partials, Iter end_partials ) 
#else
inline void
Synthesizer::operator() ( PartialList::iterator begin_partials, 
                          PartialList::iterator end_partials ) 
#endif
{ 
        synthesize( begin_partials, end_partials ); 
}

}       //      end of namespace Loris

#endif /* ndef INCLUDE_SYNTHESIZER_H */

---