Distiller.h

#ifndef INCLUDE_DISTILLER_H
#define INCLUDE_DISTILLER_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
 *
 *
 * Distiller.h
 *
 * Definition of class Distiller.
 *
 * Kelly Fitz, 20 Oct 1999
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Partial.h"
#include "PartialList.h"
#include "PartialUtils.h"

#include "Notifier.h"   //  for debugging only

#include <algorithm>

//  begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//  class Distiller
//
//
class Distiller
{
//  -- instance variables --

    double _fadeTime, _gapTime;         // distillation parameters
        
//  -- public interface --
public:

//  -- global defaults and constants --

    static const double DefaultFadeTime;
    
    static const double DefaultSilentTime;

//  -- construction --

    explicit
    Distiller( double partialFadeTime = Distiller::DefaultFadeTime,
               double partialSilentTime = Distiller::DefaultSilentTime );
     
    //  Use compiler-generated copy, assign, and destroy.
    
//  -- distillation --

#if ! defined(NO_TEMPLATE_MEMBERS)
    template< typename Container >
    typename Container::iterator distill( Container & partials );
#else
    inline
    PartialList::iterator distill( PartialList & partials );
#endif

#if ! defined(NO_TEMPLATE_MEMBERS)
    template< typename Container >
    typename Container::iterator operator() ( Container & partials );
#else
    PartialList::iterator operator() ( PartialList & partials );
#endif
    
#if ! defined(NO_TEMPLATE_MEMBERS)
    template< typename Container >
    static typename Container::iterator 
    distill( Container & partials, double partialFadeTime,
             double partialSilentTime = Distiller::DefaultSilentTime );
#else
    static inline PartialList::iterator
    distill( PartialList & partials, double partialFadeTime,
             double partialSilentTime = Distiller::DefaultSilentTime );
#endif

private:

//  -- helpers --

    PartialList::iterator distill_list( PartialList & partials );

    void distillOne( PartialList & partials, Partial::label_type label,
                     PartialList & distilled );
    
};  //  end of class Distiller

// ---------------------------------------------------------------------------
//  distill
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Container >
typename Container::iterator Distiller::distill( Container & partials )
{
    //  This can be done so much more easily and
    //  efficiently on a list than on other containers
    //  that it is worth copying the Partials to a
    //  list for distillation, and then transfering
    //  them back.
    //
    //  See below for a specialization for the case
    //  of the Container being a list, so no copy
    //  is needed.
    PartialList pl( partials.begin(), partials.end() );
    PartialList::iterator it = distill_list( pl );
        
    //  pl has distilled Partials at beginning, and
    //  unlabeled Partials at end:
    typename Container::iterator beginUnlabeled = 
        std::copy( pl.begin(), it, partials.begin() );
    
    typename Container::iterator endUnlabeled = 
        std::copy( it, pl.end(), beginUnlabeled );

    
    partials.erase( endUnlabeled, partials.end() );
    
    return beginUnlabeled;
}

//  specialization for PartialList container
template< >
inline
PartialList::iterator Distiller::distill( PartialList & partials )
{
    debugger << "using PartialList version of distill to avoid copying" << endl;
    return distill_list( partials );
}
#else
inline
PartialList::iterator Distiller::distill( PartialList & partials )
{
    return distill_list( partials );
}
#endif

// ---------------------------------------------------------------------------
//  Function call operator 
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Container >
typename Container::iterator Distiller::operator()( Container & partials )
#else
inline
PartialList::iterator Distiller::operator()( PartialList & partials )
#endif
{ 
    return distill( partials );
}

// ---------------------------------------------------------------------------
//  distill
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Container >
typename Container::iterator 
Distiller::distill( Container & partials, double partialFadeTime,
                                          double partialSilentTime )
#else
inline
PartialList::iterator 
Distiller::distill( PartialList & partials, double partialFadeTime,
                                            double partialSilentTime )
#endif
{
    Distiller instance( partialFadeTime, partialSilentTime );
    return instance.distill( partials );
}

}   //  end of namespace Loris

#endif /* ndef INCLUDE_DISTILLER_H */

---