PartialUtils.h

#ifndef INCLUDE_PARTIALUTILS_H
#define INCLUDE_PARTIALUTILS_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
 *
 *
 * PartialUtils.h
 *
 *  A group of Partial utility function objects for use with STL 
 *  searching and sorting algorithms. PartialUtils is a namespace
 *  within the Loris namespace.
 *
 * This file defines three kinds of functors:
 * - Partial mutators
 * - predicates on Partials
 * - Partial comparitors
 *
 * Kelly Fitz, 6 July 2000
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Envelope.h"
#include "Partial.h"

#include <functional>
#include <utility>

//  begin namespace
namespace Loris {

namespace PartialUtils {

//  -- Partial mutating functors --

// ---------------------------------------------------------------------------
//  PartialMutator
//  
class PartialMutator : public std::unary_function< Partial, void >
{
public:

    PartialMutator( double x );

    PartialMutator( const Envelope & e );

    PartialMutator( const PartialMutator & rhs );

    virtual ~PartialMutator( void );
    
    PartialMutator & operator=( const PartialMutator & rhs );
    
    virtual void operator()( Partial & p ) const = 0;

protected:

    Envelope * env;     
};

// ---------------------------------------------------------------------------
//  AmplitudeScaler
//  
//
class AmplitudeScaler : public PartialMutator
{
public:

    AmplitudeScaler( double x ) : PartialMutator( x ) {}
    
    AmplitudeScaler( const Envelope & e ) : PartialMutator( e ) {}
    
    void operator()( Partial & p ) const;
};

// ---------------------------------------------------------------------------
//  scaleAmplitude
// ---------------------------------------------------------------------------
//
template< class Arg >
void scaleAmplitude( Partial & p, const Arg & arg )
{
    AmplitudeScaler scaler( arg );
    scaler( p );
}

// ---------------------------------------------------------------------------
//  scaleAmplitude
// ---------------------------------------------------------------------------
//
template< class Iter, class Arg >
void scaleAmplitude( Iter b, Iter e, const Arg & arg )
{
    AmplitudeScaler scaler( arg );
    while ( b != e )
    {
        scaler( *b++ );
    }
}

// ---------------------------------------------------------------------------
//  BandwidthScaler
//  
//
class BandwidthScaler : public PartialMutator
{
public:

    BandwidthScaler( double x ) : PartialMutator( x ) {}

    BandwidthScaler( const Envelope & e ) : PartialMutator( e ) {}
    
    void operator()( Partial & p ) const;
};

// ---------------------------------------------------------------------------
//  scaleBandwidth
// ---------------------------------------------------------------------------
//
template< class Arg >
void scaleBandwidth( Partial & p, const Arg & arg )
{
    BandwidthScaler scaler( arg );
    scaler( p );
}

// ---------------------------------------------------------------------------
//  scaleBandwidth
// ---------------------------------------------------------------------------
//
template< class Iter, class Arg >
void scaleBandwidth( Iter b, Iter e, const Arg & arg )
{
    BandwidthScaler scaler( arg );
    while ( b != e )
    {
        scaler( *b++ );
    }
}

// ---------------------------------------------------------------------------
//  BandwidthSetter
//  
//
class BandwidthSetter : public PartialMutator
{
public:

    BandwidthSetter( double x ) : PartialMutator( x ) {}

    BandwidthSetter( const Envelope & e ) : PartialMutator( e ) {}
    
    void operator()( Partial & p ) const;
};

// ---------------------------------------------------------------------------
//  setBandwidth
// ---------------------------------------------------------------------------
//
template< class Arg >
void setBandwidth( Partial & p, const Arg & arg )
{
    BandwidthSetter setter( arg );
    setter( p );
}

// ---------------------------------------------------------------------------
//  setBandwidth
// ---------------------------------------------------------------------------
//
template< class Iter, class Arg >
void setBandwidth( Iter b, Iter e, const Arg & arg )
{
    BandwidthSetter setter( arg );
    while ( b != e )
    {
        setter( *b++ );
    }
}

// ---------------------------------------------------------------------------
//  FrequencyScaler
//  
//
class FrequencyScaler : public PartialMutator
{
public:

    FrequencyScaler( double x ) : PartialMutator( x ) {}
    
    FrequencyScaler( const Envelope & e ) : PartialMutator( e ) {}
    
    void operator()( Partial & p ) const;
};

// ---------------------------------------------------------------------------
//  scaleFrequency
// ---------------------------------------------------------------------------
//
template< class Arg >
void scaleFrequency( Partial & p, const Arg & arg )
{
    FrequencyScaler scaler( arg );
    scaler( p );
}

// ---------------------------------------------------------------------------
//  scaleFrequency
// ---------------------------------------------------------------------------
//
template< class Iter, class Arg >
void scaleFrequency( Iter b, Iter e, const Arg & arg )
{
    FrequencyScaler scaler( arg );
    while ( b != e )
    {
        scaler( *b++ );
    }
}

// ---------------------------------------------------------------------------
//  NoiseRatioScaler
//  
//
class NoiseRatioScaler : public PartialMutator
{
public:

    NoiseRatioScaler( double x ) : PartialMutator( x ) {}

    NoiseRatioScaler( const Envelope & e ) : PartialMutator( e ) {}
    
    void operator()( Partial & p ) const;
};

// ---------------------------------------------------------------------------
//  scaleNoiseRatio
// ---------------------------------------------------------------------------
//
template< class Arg >
void scaleNoiseRatio( Partial & p, const Arg & arg )
{
    NoiseRatioScaler scaler( arg );
    scaler( p );
}

// ---------------------------------------------------------------------------
//  scaleNoiseRatio
// ---------------------------------------------------------------------------
//
template< class Iter, class Arg >
void scaleNoiseRatio( Iter b, Iter e, const Arg & arg )
{
    NoiseRatioScaler scaler( arg );
    while ( b != e )
    {
        scaler( *b++ );
    }
}

// ---------------------------------------------------------------------------
//  PitchShifter
//  
//
class PitchShifter : public PartialMutator
{
public:

    PitchShifter( double x ) : PartialMutator( x ) {}

    PitchShifter( const Envelope & e ) : PartialMutator( e ) {}
    
    void operator()( Partial & p ) const;
};

// ---------------------------------------------------------------------------
//  shiftPitch
// ---------------------------------------------------------------------------
//
template< class Arg >
void shiftPitch( Partial & p, const Arg & arg )
{
    PitchShifter shifter( arg );
    shifter( p );
}

// ---------------------------------------------------------------------------
//  shiftPitch
// ---------------------------------------------------------------------------
//
template< class Iter, class Arg >
void shiftPitch( Iter b, Iter e, const Arg & arg )
{
    PitchShifter shifter( arg );
    while ( b != e )
    {
        shifter( *b++ );
    }
}

//  These ones are not derived from PartialMutator, because
//  they don't use an Envelope and cannot be time-varying.

// ---------------------------------------------------------------------------
//  Cropper
//  
class Cropper
{
public:

    Cropper( double t1, double t2 ) : 
        minTime( std::min( t1, t2 ) ),
        maxTime( std::max( t1, t2 ) )
    {
    }
    
    void operator()( Partial & p ) const;
    
private:
    double minTime, maxTime;
};

// ---------------------------------------------------------------------------
//  crop
// ---------------------------------------------------------------------------
//
inline
void crop( Partial & p, double t1, double t2 )
{
    Cropper cropper( t1, t2 );
    cropper( p );
}

// ---------------------------------------------------------------------------
//  crop
// ---------------------------------------------------------------------------
//
template< class Iter >
void crop( Iter b, Iter e, double t1, double t2 )
{
    Cropper cropper( t1, t2 );
    while ( b != e )
    {
        cropper( *b++ );
    }
}

// ---------------------------------------------------------------------------
//  TimeShifter
//  
//
class TimeShifter
{
public:

    TimeShifter( double x ) : offset( x ) {}
    
    void operator()( Partial & p ) const;
    
private:
    double offset;
};

// ---------------------------------------------------------------------------
//  shiftTime
// ---------------------------------------------------------------------------
//
inline
void shiftTime( Partial & p, double offset )
{
    TimeShifter shifter( offset );
    shifter( p );
}

// ---------------------------------------------------------------------------
//  shiftTime
// ---------------------------------------------------------------------------
//
template< class Iter >
void shiftTime( Iter b, Iter e, double offset )
{
    TimeShifter shifter( offset );
    while ( b != e )
    {
        shifter( *b++ );
    }
}
    
// ---------------------------------------------------------------------------
//  timeSpan
// ---------------------------------------------------------------------------
//
template < typename Iterator >
std::pair< double, double > 
timeSpan( Iterator begin, Iterator end ) 
{
    double tmin = 0., tmax = 0.;
    if ( begin != end )
    {
        Iterator it = begin;
        tmin = it->startTime();
        tmax = it->endTime();
        while( it != end )
        {
            tmin = std::min( tmin, it->startTime() );
            tmax = std::max( tmax, it->endTime() );
            ++it;
        }
    }
    return std::make_pair( tmin, tmax );
}

// ---------------------------------------------------------------------------
//  peakAmplitude
// ---------------------------------------------------------------------------
//
double peakAmplitude( const Partial & p );

// ---------------------------------------------------------------------------
//  avgAmplitude
// ---------------------------------------------------------------------------
//
double avgAmplitude( const Partial & p );

// ---------------------------------------------------------------------------
//  avgFrequency
// ---------------------------------------------------------------------------
//
double avgFrequency( const Partial & p );

// ---------------------------------------------------------------------------
//  weightedAvgFrequency
// ---------------------------------------------------------------------------
//
double weightedAvgFrequency( const Partial & p );

//  -- phase maintenance functions --

// ---------------------------------------------------------------------------
//  fixPhaseBefore
// ---------------------------------------------------------------------------
//
void fixPhaseBefore( Partial & p, double t );

// ---------------------------------------------------------------------------
//  fixPhaseBefore (range)
// ---------------------------------------------------------------------------
//
template < class Iter >
void fixPhaseBefore( Iter b, Iter e, double t )
{
    while ( b != e )
    {
        fixPhaseBefore( *b, t );
        ++b;
    }
}

// ---------------------------------------------------------------------------
//  fixPhaseAfter
// ---------------------------------------------------------------------------
//
void fixPhaseAfter( Partial & p, double t );

// ---------------------------------------------------------------------------
//  fixPhaseAfter (range)
// ---------------------------------------------------------------------------
//
template < class Iter >
void fixPhaseAfter( Iter b, Iter e, double t )
{
    while ( b != e )
    {
        fixPhaseAfter( *b, t );
        ++b;
    }
}

// ---------------------------------------------------------------------------
//  fixPhaseForward
// ---------------------------------------------------------------------------
//
void fixPhaseForward( Partial & p, double tbeg, double tend );

// ---------------------------------------------------------------------------
//  fixPhaseForward (range)
// ---------------------------------------------------------------------------
//
template < class Iter >
void fixPhaseForward( Iter b, Iter e, double tbeg, double tend )
{
    while ( b != e )
    {
        fixPhaseForward( *b, tbeg, tend );
        ++b;
    }
}


// ---------------------------------------------------------------------------
//  fixPhaseAt
// ---------------------------------------------------------------------------
//
void fixPhaseAt( Partial & p, double t );

// ---------------------------------------------------------------------------
//  fixPhaseAt (range)
// ---------------------------------------------------------------------------
//
template < class Iter >
void fixPhaseAt( Iter b, Iter e, double t )
{
    while ( b != e )
    {
        fixPhaseAt( *b, t );
        ++b;
    }
}

// ---------------------------------------------------------------------------
//  fixPhaseBetween
// ---------------------------------------------------------------------------
//
void fixPhaseBetween( Partial & p, double t1, double t2 );

// ---------------------------------------------------------------------------
//  fixPhaseBetween (range)
// ---------------------------------------------------------------------------
//
template < class Iter >
void fixPhaseBetween( Iter b, Iter e, double t1, double t2 )
{
    while ( b != e )
    {
        fixPhaseBetween( *b, t1, t2 );
        ++b;
    }
}
    
//  -- predicates --

// ---------------------------------------------------------------------------
//  isDurationLess
//  
//
class isDurationLess : public std::unary_function< const Partial, bool >
{
public:
    isDurationLess( double x ) : mDurationSecs(x) {}

    bool operator()( const Partial & p ) const 
        { return p.duration() < mDurationSecs; }
        
    bool operator()( const Partial * p ) const 
        { return p->duration() < mDurationSecs; }
        
private:    
    double mDurationSecs;
};

// ---------------------------------------------------------------------------
//  isLabelEqual
//  
//
class isLabelEqual : public std::unary_function< const Partial, bool >
{
public:
    isLabelEqual( int l ) : label(l) {}
    
    bool operator()( const Partial & p ) const 
        { return p.label() == label; }
        
    bool operator()( const Partial * p ) const 
        { return p->label() == label; }

private:    
    int label;
};
    
// ---------------------------------------------------------------------------
//  isLabelGreater
//  
//
class isLabelGreater : public std::unary_function< const Partial, bool >
{
public:
    isLabelGreater( int l ) : label(l) {}
    
    bool operator()( const Partial & p ) const 
        { return p.label() > label; }
        
    bool operator()( const Partial * p ) const 
        { return p->label() > label; }

private:    
    int label;
};
        
// ---------------------------------------------------------------------------
//  isLabelLess
//  
//
class isLabelLess : public std::unary_function< const Partial, bool >
{
public:
    isLabelLess( int l ) : label(l) {}
    
    bool operator()( const Partial & p ) const 
        { return p.label() < label; }
        
    bool operator()( const Partial * p ) const 
        { return p->label() < label; }

private:    
    int label;
};
        
// ---------------------------------------------------------------------------
//  isPeakLess
//  
//
class isPeakLess : public std::unary_function< const Partial, bool >
{
public:
    isPeakLess( double x ) : thresh(x) {}

    bool operator()( const Partial & p ) const 
        { return peakAmplitude( p ) < thresh; }
        
    bool operator()( const Partial * p ) const 
        { return peakAmplitude( *p ) < thresh; }

private:    
    double thresh;
};

//  -- comparitors --

// ---------------------------------------------------------------------------
//  compareLabelLess
//  
//
class compareLabelLess : 
    public std::binary_function< const Partial, const Partial, bool >
{
public:
    bool operator()( const Partial & lhs, const Partial & rhs ) const 
        { return lhs.label() < rhs.label(); }

    bool operator()( const Partial * lhs, const Partial * rhs ) const 
        { return lhs->label() < rhs->label(); }
};

// ---------------------------------------------------------------------------
//  compareDurationLess
//  
//
class compareDurationLess : 
    public std::binary_function< const Partial, const Partial, bool >
{
public:
    bool operator()( const Partial & lhs, const Partial & rhs ) const 
        { return lhs.duration() < rhs.duration(); }

    bool operator()( const Partial * lhs, const Partial * rhs ) const 
        { return lhs->duration() < rhs->duration(); }
};

// ---------------------------------------------------------------------------
//  compareDurationGreater
//  
//
class compareDurationGreater : 
    public std::binary_function< const Partial, const Partial, bool >
{
public:
    bool operator()( const Partial & lhs, const Partial & rhs ) const 
        { return lhs.duration() > rhs.duration(); }

    bool operator()( const Partial * lhs, const Partial * rhs ) const 
        { return lhs->duration() > rhs->duration(); }
};

// ---------------------------------------------------------------------------
//  compareStartTimeLess
//  
//
class compareStartTimeLess : 
    public std::binary_function< const Partial, const Partial, bool >
{
public:
    bool operator()( const Partial & lhs, const Partial & rhs ) const 
        { return lhs.startTime() < rhs.startTime(); }

    bool operator()( const Partial * lhs, const Partial * rhs ) const 
        { return lhs->startTime() < rhs->startTime(); }
};



}   //  end of namespace PartialUtils

}   //  end of namespace Loris

#endif /* ndef INCLUDE_PARTIALUTILS_H */

---