SdifFile.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-2007 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
 *
 *
 * SdifFile.h
 *
 * Definition of SdifFile class for Partial import and export in Loris.
 *
 * Kelly Fitz, 8 Jan 2003 
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Marker.h"
#include "Partial.h"
#include "PartialList.h"
 
#include <string>
#include <vector>

//  begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//  class SdifFile
//
//
class SdifFile
{
//  -- public interface --
public:

//  -- types --

    typedef std::vector< Marker > markers_type;

    typedef PartialList partials_type;
    
//  -- construction --

    explicit SdifFile( const std::string & filename );
 
#if !defined(NO_TEMPLATE_MEMBERS)
    template<typename Iter>
    SdifFile( Iter begin_partials, Iter end_partials  );
#else
    SdifFile( PartialList::const_iterator begin_partials, 
              PartialList::const_iterator end_partials  );
#endif
 
    SdifFile( void );
    
    //  copy, assign, and delete are compiler-generated
    
//  -- access --

    markers_type & markers( void );

    const markers_type & markers( void ) const;
     
    partials_type & partials( void );

    const partials_type & partials( void ) const;
//  -- mutation --

    void addPartial( const Loris::Partial & p );
     
#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
     
//  -- export --

    void write( const std::string & path );

    void write1TRC( const std::string & path );
    
//  -- legacy export --

    static void Export( const std::string & filename, 
                        const PartialList & plist, 
                        const bool enhanced = true );

private:
//  -- implementation --
    partials_type partials_;        //  Partials to store in SDIF format
    markers_type markers_;      //  AIFF Markers
    
};  //  end of class SdifFile

// -- template members --

// ---------------------------------------------------------------------------
//  constructor from Partial range
// ---------------------------------------------------------------------------
//  Initialize an instance of SdifFile with copies of the Partials
//  on the specified half-open (STL-style) range.
//
//  If compiled with NO_TEMPLATE_MEMBERS defined, this member accepts
//  only PartialList::const_iterator arguments.
//
#if !defined(NO_TEMPLATE_MEMBERS)
template< typename Iter >
SdifFile::SdifFile( Iter begin_partials, Iter end_partials  )
#else
SdifFile::SdifFile( PartialList::const_iterator begin_partials, 
                    PartialList::const_iterator end_partials )
#endif
{
    addPartials( begin_partials, end_partials );
}

// ---------------------------------------------------------------------------
//  addPartials 
// ---------------------------------------------------------------------------
//  Add a copy of each Partial on the specified half-open (STL-style) 
//  range to this SdifFile.
//  
//  If compiled with NO_TEMPLATE_MEMBERS defined, this member accepts
//  only PartialList::const_iterator arguments.
//
#if !defined(NO_TEMPLATE_MEMBERS)
template<typename Iter>
void SdifFile::addPartials( Iter begin_partials, Iter end_partials  )
#else
void SdifFile::addPartials( PartialList::const_iterator begin_partials, 
                            PartialList::const_iterator end_partials  )
#endif
{
    partials_.insert( partials_.end(), begin_partials, end_partials );
}

}   //  end of namespace Loris

---