CLAM-Development  1.4.0
CircularShift.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 _CIRCULAR_SHIFT_H_
23 #define _CIRCULAR_SHIFT_H_
24 
25 #include "DataTypes.hxx"
26 #include "Processing.hxx"
27 #include "CircularShiftConfig.hxx"
28 #include "InControl.hxx"
29 #include "AudioInPort.hxx"
30 #include "AudioOutPort.hxx"
31 
32 namespace CLAM {
33 
34  class Spectrum;
35  class Audio;
36  class Storage;
37  class ProcessingConfig;
38 
43  : public Processing {
44  protected:
46 
49 
51  protected:
52 
53  const char *GetClassName() const {return "CircularShift";}
54 
58 
59  public:
60  CircularShift();
61 
63 
65 
66  const ProcessingConfig &GetConfig() const { return mConfig;}
67 
68  bool Do(void);
69 
70  bool Do( const DataArray& input, DataArray& out);
71  bool Do(Spectrum& input, Spectrum& out);
72  bool Do( const Audio& input, Audio& out);
73 
74  // Port interfaces.
75 
77  bool SetPrototypes(Spectrum& inputs,const Spectrum& out);
79  bool SetPrototypes();
81  bool UnsetPrototypes();
83  bool MayDisableExecution() const {return true;}
84 
85  void SetAmount(TSize amount) { mSteps.DoControl(TControlData(amount)); }
86  };
87 
88 }
89 
90 #endif // _CIRCULAR_SHIFT_H_
91