git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_sync_decimator.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2004 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_GR_SYNC_DECIMATOR_H
  24 #define INCLUDED_GR_SYNC_DECIMATOR_H
  25
  26 #include <gr_sync_block.h>
  27
  28 /*!
  29  * \brief synchronous N:1 input to output with history
  30  * \ingroup block
  31  *
  32  * Override work to provide the signal processing implementation.
  33  */
  34 class gr_sync_decimator : public gr_sync_block
  35 {
  36  private:
  37   unsigned      d_decimation;
  38
  39  protected:
  40
  41   gr_sync_decimator (const std::string &name,
  42                      gr_io_signature_sptr input_signature,
  43                      gr_io_signature_sptr output_signature,
  44                      unsigned decimation);
  45  public:
  46
  47   unsigned decimation () const { return d_decimation; }
  48   void set_decimation (unsigned decimation)
  49   {
  50     d_decimation = decimation;
  51     set_relative_rate (1.0 / decimation);
  52   }
  53
  54   // gr_sync_decimator overrides these to assist work
  55   void forecast (int noutput_items, gr_vector_int &ninput_items_required);
  56   int  general_work (int noutput_items,
  57                      gr_vector_int &ninput_items,
  58                      gr_vector_const_void_star &input_items,
  59                      gr_vector_void_star &output_items);
  60
  61   // derived classes should override work
  62
  63   int fixed_rate_ninput_to_noutput(int ninput);
  64   int fixed_rate_noutput_to_ninput(int noutput);
  65 };
  66
  67
  68 #endif /* INCLUDED_GR_SYNC_DECIMATOR_H */