Frame.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * 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
 *
 */

#ifndef _Frame_
#define _Frame_

#include "DynamicType.hxx"
#include "Spectrum.hxx"
#include "Array.hxx"
#include "IndexArray.hxx"
#include "DataTypes.hxx"
#include "OSDefines.hxx"
#include "Err.hxx"
#include "ProcessingData.hxx"
#include "Fundamental.hxx"
#include "SpectralPeakArray.hxx"
#include "Audio.hxx"

namespace CLAM {


class Frame : public ProcessingData
{
public:
        DYNAMIC_TYPE_USING_INTERFACE (Frame, 14, ProcessingData);
        DYN_ATTRIBUTE (0, public, TData, CenterTime);
        DYN_ATTRIBUTE (1, public, TData, Duration);
        DYN_ATTRIBUTE (2, public, Spectrum, Spectrum);
        DYN_ATTRIBUTE (3, public, Spectrum, SinusoidalAnalSpectrum);
        DYN_ATTRIBUTE (4, public, SpectralPeakArray, SpectralPeakArray);
        DYN_ATTRIBUTE (5, public, Fundamental, Fundamental);
        DYN_ATTRIBUTE (6, public, Spectrum, OutSpec);
        DYN_ATTRIBUTE (7, public, Spectrum, ResidualSpec);
        DYN_ATTRIBUTE (8, public, Spectrum, SinusoidalSpec);
        /*Audio chunk that has been used for generating spectral data, will usually be
        a previously windowed audio chunk*/
        DYN_ATTRIBUTE (9, public, Audio, AudioFrame);
        DYN_ATTRIBUTE (10, public, Audio, SinusoidalAudioFrame);
        DYN_ATTRIBUTE (11, public, Audio, ResidualAudioFrame);
        DYN_ATTRIBUTE (12, public, Audio, SynthAudioFrame);
        DYN_ATTRIBUTE (13, public, bool, IsHarmonic);

protected:
        void DefaultInit();

public:
        //Accessory getters and setters. Note: for efficiency you need to work directly on the dynamic attributes

        //For Spectrum
        TData GetMag(TData freq) const;

        TData GetMag(TIndex pos) const ;

        TData GetPhase(TData freq) const ;

        TData GetPhase(TIndex pos) const ;



        void SetMag(TData freq, TData newMag);

        void SetMag(TIndex pos, TData newMag);

        void SetPhase(TData freq, TData newPhase);

        void SetPhase(TIndex pos, TData newPhase);

        //For Peak Array

        SpectralPeak GetSpectralPeak(TIndex pos) const;

        SpectralPeak GetThruIndexSpectralPeak(TIndex pos) const ;

        void SetSpectralPeak(TIndex pos,const SpectralPeak& spectralPeak,TIndex index=-1);

        void InsertSpectralPeak(TIndex pos,const SpectralPeak& spectralPeak,
        bool insertIndex=false,TIndex index=-1);

        void AddSpectralPeak(const SpectralPeak& spectralPeak,bool addIndex=false,TIndex index=-1);

        void DeleteSpectralPeak(TIndex pos,bool deleteIndex=false);

        //For Residual

        TData GetResMag(TData freq) const;

        TData GetResMag(TIndex pos) const ;

        TData GetResPhase(TData freq) const ;

        TData GetResPhase(TIndex pos) const ;


        void SetResMag(TData freq, TData newMag);

        void SetResMag(TIndex pos, TData newMag);

        void SetResPhase(TData freq, TData newPhase);

        void SetResPhase(TIndex pos, TData newPhase);

        //For Fundamental

        TData GetFundamentalFreq(TIndex pos=0)const;

        TData GetFundamentalErr(TIndex pos=0);

        void SetFundamentalFreq(TIndex pos,TData newFreq)const;

        void SetFundamentalErr(TIndex pos,TData newErr)const;

        /*Comparison Operators*/

        bool operator ==(const Frame& newFrame) const ;

        bool operator !=(const Frame& newFrame) const ;

        bool operator <(const Frame& newFrame) const ;

        bool operator <=(const Frame& newFrame) const ;

        bool operator >(const Frame& newFrame) const ;

        bool operator >=(const Frame& newFrame) const ;

};

};//namespace

#endif