EnvelopeExtractor.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 _EnvelopeExtractor_
#define _EnvelopeExtractor_

#include "ControlConfig.hxx"
#include "Processing.hxx"
#include "InPort.hxx"
#include "OutPort.hxx"
#include "InControl.hxx"
#include "Envelope.hxx"
#include "Audio.hxx"

namespace CLAM
{

        class IntervalAmplitudeAverages
        {
                Array<TData> mArray;

                int mCurrentPos;

                int mPointsPerFrame;

                int mNMemoryPoints;

                inline TData AcumulationShape(int pos);

                inline TData& Current(int index);

        public:

                inline void  Reconfigure(int PointsPerFrame,int MemoryPoints);

                inline bool  Configured();

                inline void  Clear(void);

                inline void  AdvanceFrame(void);

                inline TData Acumulated(int index);

                inline void  Compute(int interval,
                                     Array<TData> &audio,
                                     int interval_start,
                                     int interval_end);
        };


        class EnvExtractorConfig: public ProcessingConfig
        {
        public:
                DYNAMIC_TYPE_USING_INTERFACE (EnvExtractorConfig, 9, ProcessingConfig);
                DYN_ATTRIBUTE (0, public, TData, SampleRate);

                DYN_ATTRIBUTE (1, public, int, FrameSize);

                DYN_ATTRIBUTE (2, public, ControlConfig, InterpolationPeriod);

                DYN_ATTRIBUTE (3, public, ControlConfig, IntegrationLength);

                DYN_ATTRIBUTE (4, public, int, NInterpPointsPerFrame);

                DYN_ATTRIBUTE (5, public, int, NMemoryPoints);
                
                DYN_ATTRIBUTE (6, public, ControlConfig, NormalLevel);

                DYN_ATTRIBUTE (7, public, ControlConfig, SilenceLevel);

                DYN_ATTRIBUTE (8, public, EInterpolation, InterpolationType);
        protected:

                void DefaultInit(void);
        };
        

        class EnvelopeExtractor: public Processing
        {
                TTime mInterpolationPeriodControl;
                TTime mIntegrationLengthControl;
                TData mNormalLevelControl;
                TData mSilenceLevelControl;

        public:

                FloatInControl cInterpolationPeriod;
                FloatInControl cIntegrationLength;
                FloatInControl cNormalLevel;
                FloatInControl cSilenceLevel;

                InPort<Audio> Input;
                OutPort<Envelope> Output;

                EnvelopeExtractor(const EnvExtractorConfig& c = EnvExtractorConfig());

                const char * GetClassName() const {return "EnvelopeExtractor";}

                const ProcessingConfig &GetConfig() const { return mConfig;}

                void Attach(Audio& inp, Envelope& env);

                bool Do();

                bool Do(const Audio& inp, Envelope& env);

                // Debugging accessors

                int NPoints() const { return mPointsPerFrame; }

                TData NormalLevel() const {return mNormalLevel;}

                TData SilenceLevel() const {return mSilenceLevel;}

                TTime InterpolationPeriod() const {return mInterpolationPeriod;}

                TTime IntegrationLength() const {return mIntegrationLength;}

                TData NormalLevelControl() const {return mNormalLevelControl;}

                TData SilenceLevelControl() const {return mSilenceLevelControl;}

                TTime InterpolationPeriodControl() const {return mInterpolationPeriodControl;}

                TTime IntegrationLengthControl() const {return mIntegrationLengthControl;}

        private:

                EnvExtractorConfig mConfig;
                int mPointsPerFrame;
                int mNMemoryPoints;
                TData mNormalLevel;
                TData mSilenceLevel;
                TTime mDeltaX;
                TTime mFrameTime;
                int mFrameSize;
                TTime mSampleDelta;
                TTime mInterpolationPeriod;
                TTime mIntegrationLength;

                IntervalAmplitudeAverages mAmplitudeAverages;

                Array<TData> mInterpolationPoints;

                bool mIsSpline;

                TData mIpMin, mIpFactor,
                      mIlMin, mIlFactor,
                      mNlMin, mNlFactor,
                      mSlMin, mSlFactor;

                bool SetPointsPerFrame(int npoints);
                bool SetInterpolationPeriod(TTime period);
                void SetNMemoryPoints(int mpoints);
                bool SetIntegrationLength(TTime length);
                void SetNormalLevel(TData nlevel);
                void SetSilenceLevel(TData slevel);

                bool ConcreteConfigure(const ProcessingConfig& c);

                bool ConcreteStart();

                void ConfigureEnvelope(BPFTmpl<TTime,TData> &bpf);

                void WriteEnvelope    (BPFTmpl<TTime,TData> &bpf);

                void StoreInterpolationPoints();

                void CleanSilence();

                void InitializeControls();

                void InterpolationPeriodChange(TControlData val);

                void IntegrationLengthChange(TControlData val);

                void NormalLevelChange(TControlData val);

                void SilenceLevelChange(TControlData val);

        };
        
}

#endif