tomwalters@0: // Copyright 2010, Thomas Walters
tomwalters@0: //
tomwalters@0: // AIM-C: A C++ implementation of the Auditory Image Model
tomwalters@0: // http://www.acousticscale.org/AIMC
tomwalters@0: //
tomwalters@0: // This program is free software: you can redistribute it and/or modify
tomwalters@0: // it under the terms of the GNU General Public License as published by
tomwalters@0: // the Free Software Foundation, either version 3 of the License, or
tomwalters@0: // (at your option) any later version.
tomwalters@0: //
tomwalters@0: // This program is distributed in the hope that it will be useful,
tomwalters@0: // but WITHOUT ANY WARRANTY; without even the implied warranty of
tomwalters@0: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tomwalters@0: // GNU General Public License for more details.
tomwalters@0: //
tomwalters@0: // You should have received a copy of the GNU General Public License
tomwalters@0: // along with this program.  If not, see <http://www.gnu.org/licenses/>.
tomwalters@0: 
tomwalters@0: /*! \file
tomwalters@0:  *  \brief Basic data structure for a bank of signals with a common sample
tomwalters@0:  *  rate (in Hz), a centre frequency (in Hz) for each channel, a start time
tomwalters@0:  *  for the signal (in samples) and optionally, a set of strobe points in each
tomwalters@0:  *  channel (a vector of the indices of certain points). This is a struct
tomwalters@0:  *  rather than a class, and data members are accessed directly. Therefore is
tomwalters@0:  *  is up to the users of this structure to use it properly. Never assume that
tomwalters@0:  *  a SignalBank will be set up correctly when you receive it. A basic
tomwalters@0:  *  constructor and initialisation routines are provided.
tomwalters@0:  */
tomwalters@0: 
tomwalters@0: /*! \author: Thomas Walters <tom@acousticscale.org>
tomwalters@0:  *  \date 2010/01/23
tomwalters@0:  *  \version \$Id: SignalBank.h 4 2010-02-03 18:44:58Z tcw $
tomwalters@0:  */
tomwalters@0: 
tomwalters@0: #ifndef _AIMC_SUPPORT_SIGNALBANK_H_
tomwalters@0: #define _AIMC_SUPPORT_SIGNALBANK_H_
tomwalters@0: 
tomwalters@0: #include <deque>
tomwalters@0: #include <vector>
tomwalters@0: 
tomwalters@0: #include "Support/Common.h"
tomwalters@0: 
tomwalters@0: namespace aimc {
tomwalters@0: using std::deque;
tomwalters@0: using std::vector;
tomwalters@0: class SignalBank {
tomwalters@0:  public:
tomwalters@0:   SignalBank();
tomwalters@0:   ~SignalBank();
tomwalters@0:   bool Initialize(int channel_count, int signal_length, float sample_rate);
tomwalters@0: 
tomwalters@0:   /* \brief Initialize the signal bank with the same parameters, buffer size
tomwalters@0:    * and centre frequencies as the input signal bank
tomwalters@0:    */
tomwalters@0:   bool Initialize(const SignalBank &input);
tomwalters@0:   bool Validate() const;
tomwalters@0:   inline const vector<float> &operator[](int channel) const;
tomwalters@0:   inline float sample(int channel, int index) const;
tomwalters@0:   inline void set_sample(int channel, int index, float value);
tomwalters@0:   const deque<int> &strobes(int channel) const;
tomwalters@0:   float sample_rate() const;
tomwalters@0:   int buffer_length() const;
tomwalters@0:   int start_time() const;
tomwalters@0:   void set_start_time(int start_time);
tomwalters@0:   float get_centre_frequency(int i) const;
tomwalters@0:   void set_centre_frequency(int i, float cf);
tomwalters@0:   bool initialized() const;
tomwalters@0:   int channel_count() const;
tomwalters@0:  private:
tomwalters@0:   int channel_count_;
tomwalters@0:   int buffer_length_;
tomwalters@0:   vector<vector<float> > signals_;
tomwalters@0:   vector<deque<int> > strobes_;
tomwalters@0:   vector<float> centre_frequencies_;
tomwalters@0:   float sample_rate_;
tomwalters@0:   int start_time_;
tomwalters@0:   bool initialized_;
tomwalters@0:   DISALLOW_COPY_AND_ASSIGN(SignalBank);
tomwalters@0: };
tomwalters@0: }
tomwalters@0: 
tomwalters@0: #endif  // _AIMC_SUPPORT_SIGNALBANK_H_