GNU Radio 3.5.1 C++ API
gr_squelch_base_ff.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_SQUELCH_BASE_FF_H
00024 #define INCLUDED_GR_SQUELCH_BASE_FF_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_block.h>
00028 
00029 class GR_CORE_API gr_squelch_base_ff : public gr_block
00030 {
00031 private:
00032   int    d_ramp;
00033   int    d_ramped;
00034   bool   d_gate;
00035   double d_envelope;
00036   enum { ST_MUTED, ST_ATTACK, ST_UNMUTED, ST_DECAY } d_state;
00037 
00038 protected:
00039   virtual void update_state(const float &sample) {};
00040   virtual bool mute() const { return false; };
00041 
00042 public:
00043   gr_squelch_base_ff(const char *name, int ramp, bool gate);
00044 
00045   int ramp() const { return d_ramp; }
00046   void set_ramp(int ramp) { d_ramp = ramp; }
00047   bool gate() const { return d_gate; }
00048   void set_gate(bool gate) { d_gate = gate; }
00049   bool unmuted() const { return (d_state == ST_UNMUTED || d_state == ST_ATTACK); }
00050 
00051   virtual std::vector<float> squelch_range() const = 0;
00052 
00053   int general_work (int noutput_items,
00054                     gr_vector_int &ninput_items,
00055                     gr_vector_const_void_star &input_items,
00056                     gr_vector_void_star &output_items);
00057 };
00058 
00059 #endif /* INCLUDED_GR_SQUELCH_BASE_FF_H */