summaryrefslogtreecommitdiff
path: root/gr-analog/include/gnuradio/analog/simple_squelch_cc.h
blob: cd8afdf0f886b24b5211cac9976d16c52ddd4223 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/* -*- c++ -*- */
/*
 * Copyright 2005,2012 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#ifndef INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H
#define INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H

#include <gnuradio/analog/api.h>
#include <gnuradio/sync_block.h>

namespace gr {
namespace analog {

/*!
 * \brief simple squelch block based on average signal power and threshold in dB.
 * \ingroup level_controllers_blk
 */
class ANALOG_API simple_squelch_cc : virtual public sync_block
{
public:
    // gr::analog::simple_squelch_cc::sptr
    typedef boost::shared_ptr<simple_squelch_cc> sptr;

    /*!
     * \brief Make a simple squelch block.
     *
     * \param threshold_db Threshold for muting.
     * \param alpha Gain parameter for the running average filter.
     */
    static sptr make(double threshold_db, double alpha);

    virtual bool unmuted() const = 0;

    virtual void set_alpha(double alpha) = 0;
    virtual void set_threshold(double decibels) = 0;

    virtual double threshold() const = 0;
    virtual std::vector<float> squelch_range() const = 0;
};

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

#endif /* INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H */