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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007 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 3, 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_REGENERATE_BB_H
  24 #define INCLUDED_GR_REGENERATE_BB_H
  25
  26 #include <gr_sync_block.h>
  27
  28 class gr_regenerate_bb;
  29 typedef boost::shared_ptr<gr_regenerate_bb> gr_regenerate_bb_sptr;
  30
  31 gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen=500);
  32
  33 /*!
  34  * \brief Detect the peak of a signal and repeat every period samples
  35  * \ingroup level_blk
  36  *
  37  * If a peak is detected, this block outputs a 1 repeated every period samples
  38  * until reset by detection of another 1 on the input or stopped after max_regen
  39  * regenerations have occurred.
  40  *
  41  * Note that if max_regen=(-1)/ULONG_MAX then the regeneration will run forever.
  42  */
  43 class gr_regenerate_bb : public gr_sync_block
  44 {
  45   /*!
  46    * \brief Make a regenerate block
  47    * \param period The number of samples between regenerations
  48    * \param max_regen The maximum number of regenerations to perform; if set to
  49    * ULONG_MAX, it will regenerate continuously.
  50    */
  51   friend gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen);
  52
  53   gr_regenerate_bb (int period, unsigned int max_regen);
  54
  55  private:
  56   int d_period;
  57   int d_countdown;
  58   unsigned int d_max_regen;
  59   unsigned int d_regen_count;
  60
  61  public:
  62   /*! \brief Reset the maximum regeneration count; this will reset the current regen.
  63    */
  64   void set_max_regen(unsigned int regen);
  65
  66   /*! \brief Reset the period of regenerations; this will reset the current regen.
  67    */
  68   void set_period(int period);
  69
  70   int work (int noutput_items,
  71             gr_vector_const_void_star &input_items,
  72             gr_vector_void_star &output_items);
  73 };
  74
  75 #endif