FrequencyReference.h

#ifndef INCLUDE_FREQUENCYREFERENCE_H
#define INCLUDE_FREQUENCYREFERENCE_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-2004 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
 *
 *
 * FrequencyReference.h
 *
 * Definition of class FrequencyReference.
 *
 * Kelly Fitz, 3 Dec 2001
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Envelope.h"
#include "PartialList.h"
#include <memory>

//  begin namespace
namespace Loris {

class BreakpointEnvelope;

// ---------------------------------------------------------------------------
//  class FrequencyReference
//
//  Class FrequencyReference represents a reference frequency envelope
//  derived from the longest Partial found in a given range of Partials,
//  and in a specified (average) frequency range. This reference envelope
//  can be used for channelizing the Partials in preparation for morphing
//  (see Channelizer.h).
//  
//  FrequencyReference implements the Envelope interface (see
//  Envelope.h).
//
class FrequencyReference : public Envelope
{
//  -- instance variables --
    std::auto_ptr< BreakpointEnvelope > _env;
    
//  -- public interface --
public:
//  -- construction --
    FrequencyReference( PartialList::const_iterator begin, 
                        PartialList::const_iterator end, 
                        double minFreq, double maxFreq, long numSamps );
    /*  Construct a new FrequencyReference derived from the longest Partial
        in the specified half-open (STL-style) range of Partials that lies
        within the speficied average frequency range. Sample that longest
        Partial at numSamps points to construct the reference envelope.
     */
     
    FrequencyReference( PartialList::const_iterator begin, 
                        PartialList::const_iterator end, 
                        double minFreq, double maxFreq );
    /*  Construct a new FrequencyReference derived from the longest Partial
        in the specified half-open (STL-style) range of Partials that lies
        within the speficied average frequency range. Sample that longest
        Partial at every Breakpoint to construct the reference envelope.
     */
     
    FrequencyReference( const FrequencyReference & other );
    /*  Construct a new FrequencyReference that is an exact copy of the
        specified FrequencyReference.
     */
     
    FrequencyReference & operator= ( const FrequencyReference & other );
    /*  Assignment operator: make this FrequencyReference an exact copy 
    of the specified FrequencyReference.
     */
     
    ~FrequencyReference();
    /*  Destroy this FrequencyReference.
     */
     
//  -- conversion to BreakpointEnvelope --
    BreakpointEnvelope envelope( void ) const;
    /*  Return a BreakpointEnvelope that evaluates indentically to this
        FrequencyReference at all time.
     */
     
//  -- Envelope interface --
    virtual FrequencyReference * clone( void ) const;
    /*  Return an exact copy of this FrequencyReference (following the
        Prototype pattern).
     */
    
    virtual double valueAt( double x ) const;   
    /*  Return the frequency value (in Hz) of this FrequencyReference at the
        specified time.
     */

};  // end of class FrequencyReference

}   //  end of namespace Loris

#endif  // ndef INCLUDE_FREQUENCYREFERENCE_H

---