CLAM-Development  1.4.0
SpectrumProduct.hxx
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
3  * UNIVERSITAT POMPEU FABRA
4  *
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  */
21 
22 #ifndef _SPECTRUM_PRODUCT_
23 #define _SPECTRUM_PRODUCT_
24 
25 #include "Processing.hxx"
26 #include "DynamicType.hxx"
27 #include "InPort.hxx"
28 #include "OutPort.hxx"
29 #include "Spectrum.hxx"
30 
31 namespace CLAM {
32 
69  class SpectrumProduct: public Processing
70  {
72  int mSize;
73 
75  typedef enum {
76  // Type states in with the same attribute is used for all
77  // of the inputs and the outputs (it may or may not be
78  // present; in the second case it will be added at Do(...)
79  // time.
80  SMagPhase, SComplex, SPolar,
81 
82  // BPF output product
83  SBPF,
84 
85  // Type states with only a BPF attribute in one of the
86  // inputs, other type in the other input and the
87  // output. The non-BPF attribute may or may not be
88  // instantiated. In the second case it will be added at
89  // Do(...) time.
90 
91  SBPFMagPhase, SBPFComplex, SBPFPolar, SMagPhaseBPF,
92  SComplexBPF, SPolarBPF,
93 
94  // State in which nothing is known about prototypes.
95  SOther
96  } PrototypeState;
97 
99  typedef enum { Slinlin, Sloglog, Slinlog, Sloglin} ScaleState;
100 
102  PrototypeState mProtoState;
104  ScaleState mScaleState;
105 
106  const char *GetClassName() const {return "SpectrumProduct";}
107 
108  public:
109 
113 
114  SpectrumProduct(const Config &c=Config());
115  virtual ~SpectrumProduct();
116 
117 
118  bool Do();
119 
120  bool Do(Spectrum& in1, Spectrum& in2, Spectrum& out);
121 
122  // Port interfaces.
123 
130  bool SetPrototypes(const Spectrum& in1,const Spectrum& in2,const Spectrum& out);
131 
132  bool SetPrototypes();
133 
134  bool UnsetPrototypes();
135 
136  bool MayDisableExecution() const {return true;}
137 
138  private:
139 
143  inline void Multiply(Spectrum& in1, Spectrum& in2, Spectrum& out);
144 
145  // Product methods for optimized configurations of the inputs/output
146 
147  // Direct products
148  inline void MultiplyMagPhase(Spectrum& in1, Spectrum& in2, Spectrum& out);
149  inline void MultiplyMagPhaseLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
150  inline void MultiplyMagPhaseLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
151  inline void MultiplyMagPhaseLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
152  inline void MultiplyComplex(Spectrum& in1, Spectrum& in2, Spectrum& out);
153  inline void MultiplyComplexLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
154  inline void MultiplyComplexLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
155  inline void MultiplyComplexLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
156  inline void MultiplyPolar(Spectrum& in1, Spectrum& in2, Spectrum& out);
157  inline void MultiplyPolarLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
158  inline void MultiplyPolarLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
159  inline void MultiplyPolarLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
160  // BPF Product
161  inline void MultiplyBPF(Spectrum& in1, Spectrum& in2, Spectrum& out);
162  // BPF filters application
163  inline void MultiplyBPFLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
164  inline void MultiplyBPFLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
165  inline void MultiplyBPFLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
166  inline void MultiplyBPFMagPhase(Spectrum& in1, Spectrum& in2, Spectrum& out);
167  inline void MultiplyMagPhaseBPF(Spectrum& in1, Spectrum& in2, Spectrum& out);
168  inline void MultiplyBPFMagPhaseLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
169  inline void MultiplyBPFMagPhaseLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
170  inline void MultiplyBPFMagPhaseLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
171  inline void MultiplyBPFMagPhaseLogLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
172  inline void MultiplyBPFComplex(Spectrum& in1, Spectrum& in2, Spectrum& out);
173  inline void MultiplyComplexBPF(Spectrum& in1, Spectrum& in2, Spectrum& out);
174  inline void MultiplyBPFComplexLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
175  inline void MultiplyBPFComplexLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
176  inline void MultiplyBPFComplexLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
177  inline void MultiplyBPFComplexLogLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
178  inline void MultiplyBPFPolar(Spectrum& in1, Spectrum& in2, Spectrum& out);
179  inline void MultiplyPolarBPF(Spectrum& in1, Spectrum& in2, Spectrum& out);
180  inline void MultiplyBPFPolarLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
181  inline void MultiplyBPFPolarLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
182  inline void MultiplyBPFPolarLinLog(Spectrum& in1, Spectrum& in2, Spectrum& out);
183  inline void MultiplyBPFPolarLogLin(Spectrum& in1, Spectrum& in2, Spectrum& out);
184 
185  };
186 
187 }
188 
189 #endif // _SPECTRUM_PRODUCT_
190