ctcss_squelch_ff.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2006,2012 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_ANALOG_CTCSS_SQUELCH_FF_H
#define INCLUDED_ANALOG_CTCSS_SQUELCH_FF_H

#include <gnuradio/analog/api.h>
#include <gnuradio/analog/squelch_base_ff.h>
#include <gnuradio/block.h>

namespace gr {
namespace analog {

/*!
 * \brief gate or zero output if CTCSS tone not present
 * \ingroup level_controllers_blk
 */
class ANALOG_API ctcss_squelch_ff : public squelch_base_ff, virtual public block
{
protected:
    virtual void update_state(const float& in) = 0;
    virtual bool mute() const = 0;

public:
    // gr::analog::ctcss_squelch_ff::sptr
    typedef boost::shared_ptr<ctcss_squelch_ff> sptr;

    /*!
     * \brief Make CTCSS tone squelch block.
     *
     * \param rate gain of the internal frequency filters.
     * \param freq frequency value to use as the squelch tone.
     * \param level threshold level for the squelch tone.
     * \param len length of the frequency filters.
     * \param ramp attack / release time in samples; a sinusodial ramp
     *             is used. set to 0 to disable.
     * \param gate if true, no output if no squelch tone.
     *             if false, output 0's if no squelch tone.
     */
    static sptr make(int rate, float freq, float level, int len, int ramp, bool gate);

    virtual std::vector<float> squelch_range() const = 0;
    virtual float level() const = 0;
    virtual void set_level(float level) = 0;
    virtual int len() const = 0;
    virtual float frequency() const = 0;
    virtual void set_frequency(float frequency) = 0;

    virtual int ramp() const = 0;
    virtual void set_ramp(int ramp) = 0;
    virtual bool gate() const = 0;
    virtual void set_gate(bool gate) = 0;
    virtual bool unmuted() const = 0;
};

} /* namespace analog */
} /* namespace gr */

#endif /* INCLUDED_ANALOG_CTCSS_SQUELCH_FF_H */