blockdelayline.h

Go to the documentation of this file.

/******************************************************************************
 Copyright (c) 2012-2016 Institut für Nachrichtentechnik, Universität Rostock
 Copyright (c) 2006-2012 Quality & Usability Lab
                         Deutsche Telekom Laboratories, TU Berlin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
*******************************************************************************/
 
// https://AudioProcessingFramework.github.io/
 
 
#ifndef APF_BLOCKDELAYLINE_H
#define APF_BLOCKDELAYLINE_H
 
#include <algorithm>  // for std::max()
#include <vector>  // default container
 
#include "apf/iterator.h"  // for circular_iterator, stride_iterator
 
namespace apf
{
 
template<typename T, typename Container = std::vector<T>>
class BlockDelayLine
{
  public:
    using size_type = typename Container::size_type;
    using difference_type = typename Container::difference_type;
    using pointer = typename Container::pointer;
    using circulator = apf::circular_iterator<typename Container::iterator>;
 
    BlockDelayLine(size_type block_size, size_type max_delay);
 
    bool delay_is_valid(size_type delay, size_type& corrected) const
    {
      bool valid = (delay <= _max_delay);
      corrected = valid ? delay : _max_delay;
      return valid;
    }
 
    bool delay_is_valid(size_type delay) const
    {
      size_type dummy;  // dummy variable as default parameter
      return delay_is_valid(delay, dummy);
    }
 
    void advance()
    {
      ++_block_circulator;
      _data_circulator += static_cast<difference_type>(_block_size);
    }
 
    template<typename Iterator>
    void write_block(Iterator source);
 
    template<typename Iterator>
    bool read_block(Iterator destination, size_type delay) const;
 
    template<typename Iterator>
    bool read_block(Iterator destination, size_type delay, T weight) const;
 
    pointer get_write_pointer() const;
 
    circulator get_read_circulator(size_type delay = 0) const;
 
  protected:
    circulator _get_data_circulator() const { return _data_circulator; }
 
    const size_type _block_size;  
 
  private:
    const size_type _max_delay;  
 
    const size_type _number_of_blocks; 
 
    Container _data;  
 
    circulator _data_circulator;
 
    apf::stride_iterator<circulator> _block_circulator;
};
 
template<typename T, typename Container>
BlockDelayLine<T, Container>::BlockDelayLine(size_type block_size
    , size_type max_delay)
  : _block_size(block_size)
  , _max_delay(max_delay)
  // Minimum number of blocks is 2, even if _max_delay is 0.
  // With only one block the circular iterators r and (r + _block_size) would be
  // equal and the read...() functions wouldn't work.
  // But anyway, who wants a delay line with no delay? Kind of useless ...
  , _number_of_blocks(
      std::max(size_type(2), (_max_delay + 2 * _block_size - 1) / _block_size))
  , _data(_number_of_blocks * _block_size)  // initialized with default ctor T()
  , _data_circulator(_data.begin(), _data.end())
  , _block_circulator(
      _data_circulator, static_cast<difference_type>(_block_size))
{
  assert(_block_size >= 1);
}
 
template<typename T, typename Container>
template<typename Iterator>
void
BlockDelayLine<T, Container>::write_block(Iterator source)
{
  this->advance();
  // Ignore return value, next time get_write_pointer() has to be used again!
  std::copy(source, source + _block_size, this->get_write_pointer());
}
 
template<typename T, typename Container>
template<typename Iterator>
bool
BlockDelayLine<T, Container>::read_block(Iterator destination, size_type delay)
  const
{
  // TODO: try to get a more meaningful error message if source is not a random
  // access iterator (e.g. when using a std::list)
  if (!this->delay_is_valid(delay)) return false;
  circulator source = this->get_read_circulator(delay);
  std::copy(source, source + static_cast<difference_type>(_block_size)
      , destination);
  return true;
}
 
template<typename T, typename Container>
template<typename Iterator>
bool
BlockDelayLine<T, Container>::read_block(Iterator destination
    , size_type delay, T weight) const
{
  if (!this->delay_is_valid(delay)) return false;
  circulator source = this->get_read_circulator(delay);
  std::transform(source, source + static_cast<difference_type>(_block_size)
      , destination, [weight] (T in) { return in * weight; });
  return true;
}
 
template<typename T, typename Container>
typename BlockDelayLine<T, Container>::pointer
BlockDelayLine<T, Container>::get_write_pointer() const
{
  return &*_block_circulator.base().base();
}
 
template<typename T, typename Container>
typename BlockDelayLine<T, Container>::circulator
BlockDelayLine<T, Container>::get_read_circulator(size_type delay) const
{
  return _get_data_circulator() - static_cast<difference_type>(delay);
}
 
template<typename T, typename Container = std::vector<T>>
class NonCausalBlockDelayLine : private BlockDelayLine<T, Container>
{
  private:
    using _base = BlockDelayLine<T, Container>;
 
  public:
    using typename _base::size_type;
    using typename _base::circulator;
    using difference_type = typename _base::circulator::difference_type;
 
    NonCausalBlockDelayLine(size_type block_size, size_type max_delay
        , size_type initial_delay)
      : _base(block_size, max_delay + initial_delay)
      , _initial_delay(static_cast<difference_type>(initial_delay))
    {}
 
#ifdef APF_DOXYGEN_HACK
    // This is just for Doxygen documentation:
    void advance();
    template<typename Iterator> void write_block(Iterator source);
    pointer get_write_pointer() const;
#else
    // This is the real thing:
    using _base::advance;
    using _base::write_block;
    using _base::get_write_pointer;
#endif
 
    bool delay_is_valid(difference_type delay, difference_type& corrected) const
    {
      if (delay < -_initial_delay)
      {
        corrected = -_initial_delay;
        return false;
      }
      size_type tmp;
      bool valid = _base::delay_is_valid(
          static_cast<size_type>(delay + _initial_delay), tmp);
      corrected = static_cast<difference_type>(tmp) - _initial_delay;
      return valid;
    }
 
    bool delay_is_valid(difference_type delay) const
    {
      difference_type dummy;  // dummy variable as default parameter
      return delay_is_valid(delay, dummy);
    }
 
    template<typename Iterator>
    bool read_block(Iterator destination, difference_type delay) const
    {
      if (delay < -_initial_delay) return false;
      return _base::read_block(destination
          , static_cast<size_type>(delay + _initial_delay));
    }
 
    template<typename Iterator>
    bool read_block(Iterator destination, difference_type delay, T weight) const
    {
      if (delay < -_initial_delay) return false;
      return _base::read_block(destination
          , static_cast<size_type>(delay + _initial_delay), weight);
    }
 
    circulator get_read_circulator(difference_type delay = 0) const
    {
      return _base::get_read_circulator(delay + _initial_delay);
    }
 
  private:
    const difference_type _initial_delay;
};
 
}  // namespace apf
 
#endif