/Users/kfitz/Projects/Loris/Loris development/src/SpcFile.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
 *
 *
 * SpcFile.h
 *
 * Definition of SpcFile class for Partial import and export for
 * real-time synthesis in Kyma.
 *
 * Spc files always represent a number of Partials that is a power of
 * two. This is not necessary for purely-sinusoidal files, but might be
 * (not clear) for enhanced data to be properly processed in Kyma. 
 *
 * All of this is kind of disgusting right now. This code has evolved 
 * somewhat randomly, and we are awaiting full support for bandwidth-
 * enhanced data in Kyma..
 *
 * Kelly Fitz, 8 Jan 2003 
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */
#include "Marker.h"
#include "Partial.h"

#if defined(NO_TEMPLATE_MEMBERS)
#include "PartialList.h"
#endif
 
#include <string>
#include <vector>

//      begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//      class SpcFile
//
//      
class SpcFile
{
//      -- public interface --
public:

//      -- types --

        typedef std::vector< Marker > markers_type;             
        
        typedef std::vector< Partial > partials_type;   

//      -- construction --

        explicit SpcFile( const std::string & filename );

#if !defined(NO_TEMPLATE_MEMBERS)
        template<typename Iter>
        SpcFile( Iter begin_partials, Iter end_partials, double midiNoteNum = 60  );
#else
        SpcFile( PartialList::const_iterator begin_partials, 
                         PartialList::const_iterator end_partials,
                         double midiNoteNum = 60  );
#endif

        explicit SpcFile( double midiNoteNum = 60 );
         
        //      copy, assign, and delete are compiler-generated
        
//      -- access --

        markers_type & markers( void );
        
        const markers_type & markers( void ) const;
         
        double midiNoteNumber( void ) const;
        
        const partials_type & partials( void ) const;
        
        double sampleRate( void ) const;
        
//      -- mutation --

        void addPartial( const Loris::Partial & p );
         
        void addPartial( const Loris::Partial & p, int label );
         
#if !defined(NO_TEMPLATE_MEMBERS)
        template<typename Iter>
        void addPartials( Iter begin_partials, Iter end_partials  );
#else
        void addPartials( PartialList::const_iterator begin_partials, 
                                          PartialList::const_iterator end_partials  );
#endif

        void setMidiNoteNumber( double nn );

        void setSampleRate( double rate );
                
//      -- export --

        void write( const std::string & filename, double endApproachTime = 0 );

        void writeSinusoidal( const std::string & filename, double endApproachTime = 0 );

        void write( const std::string & filename, bool enhanced,
                                double endApproachTime = 0 );

private:
//      -- implementation --
        partials_type partials_;        
        markers_type markers_;          

        double notenum_;                        
        double rate_;                           

        
        static const int MinNumPartials;        




        static const double DefaultRate;        

//      -- helpers --
        void readSpcData( const std::string & filename );
        void growPartials( partials_type::size_type sz );
        
};      //      end of class SpcFile


// ---------------------------------------------------------------------------
//      constructor from Partial range
// ---------------------------------------------------------------------------
#if !defined(NO_TEMPLATE_MEMBERS)
template< typename Iter >
SpcFile::SpcFile( Iter begin_partials, Iter end_partials, double midiNoteNum  ) :
#else
SpcFile::SpcFile( PartialList::const_iterator begin_partials, 
                                  PartialList::const_iterator end_partials,
                                  double midiNoteNum ) :
#endif
//      initializers:
        notenum_( midiNoteNum ),
        rate_( DefaultRate )
{
        growPartials( MinNumPartials );
        addPartials( begin_partials, end_partials );
}

// ---------------------------------------------------------------------------
//      addPartials 
// ---------------------------------------------------------------------------
#if !defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
void SpcFile::addPartials( Iter begin_partials, Iter end_partials  )
#else
void SpcFile::addPartials( PartialList::const_iterator begin_partials, 
                                                   PartialList::const_iterator end_partials  )
#endif
{
        while ( begin_partials != end_partials )
        {
            // do not try to add unlabeled Partials, or 
            // Partials labeled beyond 256:
            if ( 0 != begin_partials->label() && 257 > begin_partials->label() )
            {
                    addPartial( *begin_partials );
                }
                ++begin_partials;
        }
}

}       //      end of namespace Loris

---