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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005 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 #ifndef INCLUDED_GR_THROTTLE_H
  23 #define INCLUDED_GR_THROTTLE_H
  24
  25 #include <gr_sync_block.h>
  26 #ifdef HAVE_SYS_TIME_H
  27 #include <sys/time.h>
  28 #endif
  29
  30 class gr_throttle;
  31 typedef boost::shared_ptr<gr_throttle> gr_throttle_sptr;
  32
  33
  34 gr_throttle_sptr gr_make_throttle(size_t itemsize, double samples_per_sec);
  35
  36 /*!
  37  * \brief throttle flow of samples such that the average rate does not exceed samples_per_sec.
  38  * \ingroup misc_blk
  39  *
  40  * input: one stream of itemsize; output: one stream of itemsize
  41  *
  42  * N.B. this should only be used in GUI apps where there is no other
  43  * rate limiting block.  It is not intended nor effective at precisely
  44  * controlling the rate of samples.  That should be controlled by a
  45  * source or sink tied to sample clock.  E.g., a USRP or audio card.
  46  */
  47 class gr_throttle : public gr_sync_block
  48 {
  49   friend gr_throttle_sptr gr_make_throttle(size_t itemsize, double samples_per_sec);
  50   size_t                d_itemsize;
  51   double                d_samples_per_sec;
  52   double                d_total_samples;
  53 #ifdef HAVE_SYS_TIME_H
  54   struct timeval        d_start;
  55 #endif
  56
  57   gr_throttle(size_t itemsize, double samples_per_sec);
  58
  59 public:
  60   ~gr_throttle();
  61
  62   int work (int noutput_items,
  63             gr_vector_const_void_star &input_items,
  64             gr_vector_void_star &output_items);
  65 };
  66
  67
  68 #endif /* INCLUDED_GR_THROTTLE_H */