/home/breidi/Dropbox/signalserver/include/sampleblock/sample_block.h

Go to the documentation of this file.

/*
    This file is part of the TOBI SignalServer.

    Commercial Usage
    Licensees holding valid Graz University of Technology Commercial
    licenses may use this file in accordance with the Graz University
    of Technology Commercial License Agreement provided with the
    Software or, alternatively, in accordance with the terms contained in
    a written agreement between you and Graz University of Technology.

    --------------------------------------------------

    GNU General Public License Usage
    Alternatively, this file may be used under the terms of the GNU
    General Public License version 3.0 as published by the Free Software
    Foundation and appearing in the file gpl.txt included in the
    packaging of this file.  Please review the following information to
    ensure the GNU General Public License version 3.0 requirements will be
    met: http://www.gnu.org/copyleft/gpl.html.

    In case of GNU General Public License Usage ,the TOBI SignalServer
    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 the TOBI SignalServer. If not, see <http://www.gnu.org/licenses/>.

    Copyright 2010 Graz University of Technology
    Contact: SignalServer@tobi-project.org
*/

#ifndef SAMPLEBLOCK_H
#define SAMPLEBLOCK_H

#include <map>
#include <string>
#include <vector>
#include <stdexcept>

#include <boost/cstdint.hpp>
#include <boost/lexical_cast.hpp>

#ifdef DEBUG
  #include <iostream>
#endif

namespace tobiss
{

//-----------------------------------------------------------------------------
template<class T> class SampleBlock
{
  public:
    SampleBlock()
      : blocks_ (0), channels_(0), homogenous_(1),curr_block_(0) { }

    virtual ~SampleBlock()    {  }

    boost::uint16_t getNrOfBlocks()    {  return(blocks_ );  }
    boost::uint16_t getNrOfChannels()    {  return(channels_);  }
    boost::uint16_t getNrOfSamples()    {  return(samples_.size());  }
    boost::uint16_t getNrOfSignalTypes()     { return(block_info_.size());  }
    void deleteSamples()    {  samples_.clear();  }
    void reset()     { curr_block_ = 0;  }

    T at(boost::uint32_t n)    {  return(samples_.at(n));  }
    T operator[](boost::uint32_t n)    {  return(samples_[n]);  }

    //-------------------------------------------

    void init(boost::uint16_t blocksize, boost::uint16_t nr_ch, std::vector<boost::uint32_t> sig_types);




    std::vector<boost::uint32_t> getTypes();

    std::vector<T> getSamples();

    boost::uint32_t getFlagByNr(boost::uint32_t nr);

    std::vector<T> getSignalByFlag(boost::uint32_t flag);

    void getSignalByFlag(boost::uint32_t flag, std::vector<T>& v);

    std::vector<T> getSignalByNr(boost::uint32_t nr);

    void getSignalByNr(boost::uint32_t nr, std::vector<T>& v);

    void appendBlock(std::vector<T> v, boost::uint16_t nr_blocks);

    void setSamples(std::vector<T> v);

//-----------------------------------------------------------------------------

  private:
    void sort(std::vector<T>& v, std::vector<boost::uint32_t> order, boost::uint32_t nr_blocks);

    void checkBlockIntegrity();

//-----------------------------------------------

  private:
    boost::uint16_t blocks_ ;    
    boost::uint16_t channels_;  
    bool homogenous_;    
    boost::uint16_t curr_block_;    

    //vector<uint32_t> types_ordered_;   //< Signal types in an ordered manner (and how samples are stored)
    std::vector<boost::uint32_t> types_input_;   

    std::map<boost::uint32_t, std::pair<boost::uint16_t, boost::uint16_t> > block_info_;  // flag ... identifier, offset & nr_values as data
    std::vector<T> samples_;    
};

//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::init(boost::uint16_t blocksize, boost::uint16_t nr_ch, std::vector<boost::uint32_t> sig_types)
{
  #ifdef DEBUG
    //std::cout << "SampleBlock: init" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  if(nr_ch != sig_types.size())
    throw(std::logic_error("SampleBlock::init -- sig_types.size() differs from number of channels given!"));

  blocks_  = blocksize;
  channels_ = nr_ch;
  types_input_ = sig_types;

  if(nr_ch == 0)
    return;

  if(!samples_.size() )
    samples_.reserve( 4 * samples_.size() );

  samples_.resize(blocks_ *channels_);

  uint32_t o_tmp;
  for(unsigned int i=0; i < sig_types.size(); i++)
    for(unsigned int x=0; x < sig_types.size()-1-i; x++)
      if(sig_types[x] > sig_types[x+1])
      {
        o_tmp = sig_types[x];
        sig_types[x] =sig_types[x+1];
        sig_types[x+1] = o_tmp;
      }
  //       types_ordered_ = sig_types;

  std::pair<uint16_t, uint16_t> pi;   //  ... pos. information (offset, nr_values)
  std::pair<uint32_t, std::pair<uint16_t, uint16_t> > si; // samples info (flag)
  uint16_t pos = 0;
  for(unsigned int n = 1; n < sig_types.size(); n++)
    if(sig_types[n-1] != sig_types[n])
    {
      homogenous_ = 0;
      pi = std::make_pair(pos*blocks_ ,(n-pos)*blocks_ );   // (n - pos)
      si = std::make_pair(sig_types[n-1], pi);
      block_info_.insert(si);
      pos = n;
    }
  pi = std::make_pair(pos*blocks_ , (channels_-pos)*blocks_ );
  si = std::make_pair(sig_types[pos], pi);
  block_info_.insert(si);
}

//-----------------------------------------------------------------------------

template<class T> std::vector<boost::uint32_t> SampleBlock<T>::getTypes()
{
  #ifdef DEBUG
    std::cout << "SampleBlock: getTypes" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  std::vector<uint32_t> v;
  for(std::map<uint32_t, std::pair<uint16_t, uint16_t> >::iterator it = block_info_.begin();
      it != block_info_.end(); it++)
    v.push_back(it->first);
  return(v);
}

//-----------------------------------------------------------------------------

template<class T> std::vector<T> SampleBlock<T>::getSamples()
{
  #ifdef DEBUG
    std::cout << "SampleBlock: getSamples" << std::endl;
  #endif

  checkBlockIntegrity();
  return(samples_);
}

//-----------------------------------------------------------------------------

template<class T> boost::uint32_t SampleBlock<T>::getFlagByNr(boost::uint32_t nr)
{
  #ifdef DEBUG
    //std::cout << "SampleBlock: getFlagByNr" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  if(nr > block_info_.size())
    throw(std::invalid_argument("getFlagByNr -- Signal number higher than nr. of different signals available!"));

  std::map<uint32_t, std::pair<uint16_t, uint16_t> >::iterator m_it(block_info_.begin());
  for(uint32_t n = 0; n < nr; n++)
    m_it++;

  return(m_it->first);
}

//-----------------------------------------------------------------------------

template<class T> std::vector<T> SampleBlock<T>::getSignalByFlag(boost::uint32_t flag)
{
  #ifdef DEBUG
    std::cout << "SampleBlock: getSignalByFlag" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  std::map<uint32_t, std::pair<uint16_t, uint16_t> >::iterator m_it(block_info_.find(flag));
  if(m_it != block_info_.end())
  {
    checkBlockIntegrity();
    typename std::vector<T>::iterator v_it(samples_.begin() + m_it->second.first);
    std::vector<T> v(v_it, v_it + m_it->second.second);
    return(v);
  }
  else
    throw(std::invalid_argument("getSinalByFlag -- FLAG not set in SampleBlock!"));
}

//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::getSignalByFlag(boost::uint32_t flag, std::vector<T>& v)
{
  #ifdef DEBUG
    std::cout << "SampleBlock: getSignalByFlag" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  std::map<uint32_t, std::pair<uint16_t, uint16_t> >::iterator m_it(block_info_.find(flag));
  if(m_it != block_info_.end())
  {
    checkBlockIntegrity();
    typename std::vector<T>::iterator v_it(samples_.begin() + m_it->second.first);

    v.assign(v_it, v_it + m_it->second.second);
  }
  else
    throw(std::invalid_argument("getSinalByFlag -- FLAG not set in SampleBlock!"));
}

//-----------------------------------------------------------------------------

template<class T> std::vector<T> SampleBlock<T>::getSignalByNr(boost::uint32_t nr)
{
  #ifdef DEBUG
   // std::cout << "SampleBlock: getSignalByNr" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  if(nr > block_info_.size())
    throw(std::invalid_argument("getSinalByNr -- Signal number higher than nr. \
      of different signals available!"));
  checkBlockIntegrity();

  std::map<uint32_t, std::pair<uint16_t, uint16_t> >::iterator m_it(block_info_.begin());
  for(uint32_t n = 0; n < nr; n++)
    m_it++;
  typename std::vector<T>::iterator v_it(samples_.begin() + m_it->second.first);
  std::vector<T> v(v_it, v_it + m_it->second.second);
  return(v);
}

//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::getSignalByNr(boost::uint32_t nr, std::vector<T>& v)
{
  #ifdef DEBUG
    //std::cout << "SampleBlock: getSignalByNr" << std::endl;
  #endif

  using boost::uint16_t;
  using boost::uint32_t;

  if(nr > block_info_.size())
    throw(std::invalid_argument("getSinalByNr -- Signal number higher than nr. \
    of different signals available!"));
  checkBlockIntegrity();

  std::map<uint32_t, std::pair<uint16_t, uint16_t> >::iterator m_it(block_info_.begin());
  for(uint32_t n = 0; n < nr; n++)
    m_it++;
  typename std::vector<T>::iterator v_it(samples_.begin() + m_it->second.first);

  v.assign(v_it, v_it + m_it->second.second);
}

//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::appendBlock(std::vector<T> v, boost::uint16_t nr_blocks)
{
  #ifdef DEBUG
    //std::cout << "SampleBlock: appendBlock" << std::endl;
  #endif

  if(v.size() != channels_)
    throw(std::length_error("appendBlock: Appended Block contains more values than sampled channels!"));

  if(nr_blocks == 1)
  {
    if(blocks_  < curr_block_)
      throw(std::length_error("SampleBlock<T>::appendBlock: Tried to append more blocks than specified!"));

    sort(v,types_input_,nr_blocks);

    for(unsigned int n = 0; n < channels_; n++)
      samples_[ (n*blocks_ ) + curr_block_ ] = v[n];

    curr_block_++;
  }
  else
  {

     throw(std::length_error("SampleBlock<T>::appendBlock: Operation not supported yet"));

    if(blocks_  < curr_block_ + nr_blocks -1)
      throw(std::length_error("SampleBlock<T>::appendBlock: Tried to append more blocks than specified!"));

    sort(v,types_input_, nr_blocks);

//    for(unsigned int n = 0; n < channels_; n++)
//      for(unsigned int m = 0; n < nr_blocks; m++)
        //samples_[ (n*blocks_ ) + curr_block_ ] = v[n];

    curr_block_+= nr_blocks;
  }
}

//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::setSamples(std::vector<T> v)
{
  #ifdef DEBUG
    //std::cout << "SampleBlock: setSamples" << std::endl;
  #endif

  if(v.size() != static_cast<boost::uint32_t>(blocks_ *channels_))
  {
    std::string ex_str;
    std::string nr_samples(boost::lexical_cast<std::string>(v.size()));
    std::string available(boost::lexical_cast<std::string>(blocks_ *channels_));
    ex_str = "Values in vector: " + nr_samples + " -- awaiting: " + available;
      throw(std::length_error("Sample Block contains a different amount of values than sampled channels! -- " +ex_str ));
  }
  if(homogenous_)
    samples_.assign(v.begin(),v.end());
  else
  {
    sort(v,types_input_, blocks_);
    samples_.assign(v.begin(),v.end());
  }
}
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::sort(std::vector<T>& v,
    std::vector<boost::uint32_t> order, boost::uint32_t nr_blocks)
{
  //#ifdef DEBUG
  //  std::cout << "SampleBlock: sort" << std::endl;
  //#endif

  double v_tmp;
  boost::uint32_t o_tmp;

  for(unsigned int i=0; i < order.size(); i++)
    for(unsigned int x=0; x < order.size()-1-i; x++)
      if(order[x] > order[x+1])
      {
        o_tmp = order[x];
        order[x] =order[x+1];
        order[x+1] = o_tmp;

        for(unsigned int n = 0; n < nr_blocks; n++)
        {
          v_tmp = v[nr_blocks * x +n];
          v[(nr_blocks * x) +n] = v[nr_blocks * x +n +nr_blocks];
          v[(nr_blocks * x) +n +nr_blocks] = v_tmp;
        }
      }
}

//-----------------------------------------------------------------------------

template<class T> void SampleBlock<T>::checkBlockIntegrity()
{
  #ifdef DEBUG
    //std::cout << "SampleBlock: checkBlockIntegrity" << std::endl;
  #endif

  if(samples_.size() != static_cast<boost::uint32_t>(channels_*blocks_ ))
  {
    std::string ex_str;
    std::string n(boost::lexical_cast<std::string>(samples_.size()));
    std::string c(boost::lexical_cast<std::string>(channels_));
    std::string b(boost::lexical_cast<std::string>(blocks_ ));
    ex_str = "("+n+ ") different to channels_ ("+c+ ") * blocks_  ("+b+ ")!";
    throw(std::length_error("Inconsistent sample block -- nr of samples" + ex_str));
  }
}

//-----------------------------------------------------------------------------

} // Namespace tobiss

#endif // SAMPLEBLOCK_H