BreakpointUtils.h

#ifndef INCLUDE_BREAKPOINTUTILS_H
#define INCLUDE_BREAKPOINTUTILS_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
 *
 *
 * BreakpointUtils.h
 *
 * Breakpoint utility functions collected in namespace BreakpointUtils.
 *
 * Kelly Fitz, 6 July 2000
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Breakpoint.h"
#include <algorithm>
#include <functional>

//  begin namespace
namespace Loris {

namespace BreakpointUtils {

//  -- free functions --

// ---------------------------------------------------------------------------
//  addNoiseEnergy
// ---------------------------------------------------------------------------
//
inline void addNoiseEnergy( Breakpoint & bp, double enoise ) 
{ 
    bp.addNoiseEnergy(enoise); 
}
 
// ---------------------------------------------------------------------------
//  makeNullBefore
// ---------------------------------------------------------------------------
//
Breakpoint makeNullBefore( const Breakpoint & bp, double fadeTime ); // see BreakpointUtils.C


// ---------------------------------------------------------------------------
//  addNoiseEnergy
// ---------------------------------------------------------------------------
//
Breakpoint makeNullAfter( const Breakpoint & bp, double fadeTime ); // see BreakpointUtils.C

//  -- predicates --

// ---------------------------------------------------------------------------
//  isFrequencyBetween
//  
//
class isFrequencyBetween : 
    public std::unary_function< const Breakpoint, bool >
{
public:
    bool operator()( const Breakpoint & b )  const
    { 
        return (b.frequency() > _fmin) && 
               (b.frequency() < _fmax); 
    }
    
//  constructor:

    isFrequencyBetween( double x, double y ) : 
        _fmin( x ), _fmax( y ) 
    { 
        if (x>y) std::swap(x,y); 
    }
        
//  bounds:
private:
    double _fmin, _fmax;
};

typedef isFrequencyBetween frequency_between;

// ---------------------------------------------------------------------------
//  isNonNull
//
//
static bool isNonNull( const Breakpoint & bp )
{
    return bp.amplitude() != 0.;
}

// ---------------------------------------------------------------------------
//  isNull
//
//
static bool isNull( const Breakpoint & bp )
{
    return ! isNonNull( bp );
}

//  -- comparitors --

// ---------------------------------------------------------------------------
//  compareFrequencyLess
//  
//
class compareFrequencyLess : 
    public std::binary_function< const Breakpoint, const Breakpoint, bool >
{
public:
    bool operator()( const Breakpoint & lhs, const Breakpoint & rhs ) const
        { return lhs.frequency() < rhs.frequency(); }
};

typedef compareFrequencyLess less_frequency;

// ---------------------------------------------------------------------------
//  compareAmplitudeGreater
//  
//
class compareAmplitudeGreater : 
    public std::binary_function< const Breakpoint, const Breakpoint, bool >
{
public:
    bool operator()( const Breakpoint & lhs, const Breakpoint & rhs ) const
        { return lhs.amplitude() > rhs.amplitude(); }
};  

typedef compareAmplitudeGreater greater_amplitude;

// ---------------------------------------------------------------------------
//  compareAmplitudeLess
//  
//
class compareAmplitudeLess : 
    public std::binary_function< const Breakpoint, const Breakpoint, bool >
{
public:
    bool operator()( const Breakpoint & lhs, const Breakpoint & rhs ) const
        { return lhs.amplitude() < rhs.amplitude(); }
};  

}   //  end of namespace BreakpointUtils

}   //  end of namespace Loris

#endif /* ndef INCLUDE_BREAKPOINTUTILS_H */

---