SpectrumAdder.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 _SPECTRUM_ADDER_
#define _SPECTRUM_ADDER_

#include "Processing.hxx"
#include "DynamicType.hxx"
#include "InPort.hxx"
#include "OutPort.hxx"

#include "Spectrum.hxx"

namespace CLAM {


        class SpecAdderConfig: public ProcessingConfig
        {
        public:
                DYNAMIC_TYPE_USING_INTERFACE (SpecAdderConfig, 1,ProcessingConfig);
                DYN_ATTRIBUTE (0, public, int, NInputs);
        protected:
                void DefaultInit();

        };

        class SpectrumAdder: public Processing {
                SpecAdderConfig mConfig;

                int mSize;

                int mNInputs;

                InPort<Spectrum> **mInputs;

                Complex **complex_bufs;
                Polar **polar_bufs;
                TData **mag_bufs;
                TData **phase_bufs;
                bool *remove;

                OutPort<Spectrum> mOut;

                typedef enum {
                        // Type states in with the same attribute is used for all
                        // of the inputs and the outputs (it may or may not be
                        // present; in the second case it will be added at Do(...)
                        // time.
                        SMagPhase, SComplex, SPolar,

                        // State when any of the inputs has only a BPF instantiated.
                        ShasBPF,

                        // State in which nothing is known about prototypes.
                        SOther
                } PrototypeState;

                typedef enum { Slin, Slog} ScaleState;

                PrototypeState mProtoState;
                ScaleState mScaleState;

                std::string NewUniqueName();

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

                bool ConcreteConfigure(const ProcessingConfig&);

        public:
                SpectrumAdder();

                SpectrumAdder(const SpecAdderConfig &c);

                ~SpectrumAdder();

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

                bool Do(void);

                bool Do(Spectrum **inputs, Spectrum& out);



                bool SetPrototypes(Spectrum **inputs,const Spectrum& out);

                bool SetPrototypes();

                bool UnsetPrototypes();

                bool MayDisableExecution() const {return true;}

        private:

                inline void Add(Spectrum **inputs, Spectrum& out);

                // Adder methods for optimized configurations of the inputs/output

                // Direct sums
                inline void AddMagPhase(Spectrum **inputs, Spectrum& out);
                inline void AddMagPhaseLin(Spectrum **inputs, Spectrum& out);
                inline void AddMagPhaseLog(Spectrum **inputs, Spectrum& out);
                inline void AddComplex(Spectrum **inputs, Spectrum& out);
                inline void AddComplexLin(Spectrum **inputs, Spectrum& out);
                inline void AddComplexLog(Spectrum **inputs, Spectrum& out);
                inline void AddPolar(Spectrum **inputs, Spectrum& out);
                inline void AddPolarLin(Spectrum **inputs, Spectrum& out);
                inline void AddPolarLog(Spectrum **inputs, Spectrum& out);
        };

}

#endif // _SPECTRUM_ADDER_