gqrx/dsp/rx_filter.h
2011-07-16 20:05:19 +02:00

98 lines
3.2 KiB
C++

/* -*- c++ -*- */
/*
* Copyright 2011 Alexandru Csete OZ9AEC.
*
* Gqrx 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.
*
* Gqrx 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 Gqrx; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef RX_FILTER_H
#define RX_FILTER_H
#include <gr_hier_block2.h>
#include <gr_freq_xlating_fir_filter_ccc.h>
#define RX_FILTER_MIN_WIDTH 100 /*! Minimum width of filter */
class rx_filter;
typedef boost::shared_ptr<rx_filter> rx_filter_sptr;
/*! \brief Return a shared_ptr to a new instance of rx_filter.
* \param sample_rate The sample rate.
* \param offset The filter offset.
* \param low The lower limit of the bandpass filter.
* \param high The upper limit of the filter.
* \param trans_width The width of the transition band from
*
* This is effectively the public constructor. To avoid accidental use
* of raw pointers, rx_filter's constructor is private.
* make_rxfilter is the public interface for creating new instances.
*/
rx_filter_sptr make_rx_filter(double sample_rate, double center=0.0, double low=-5000.0, double high=5000.0, double trans_width=1000.0);
/*! \brief Frequency translating band-pass filter with complex taps.
* \ingroup DSP
*
* This class encapsulates a frequency translating FIR filter and the code
* required to generate complex band pass filter taps. It provides a simple
* interface to set the filter offset and limits and takes care of generating
* the appropriate taps according to the limits.
*
* The filter limits are relative to the filter offset and thanks to the complex taps
* they can be both positive and negative.
*
* The user of this class is expected to provide valid parameters and no checks are
* performed by the accessors (though the taps generator from gr_firdes does perform
* some sanity checks and throws std::out_of_range in case of bad parameter).
*
* \note In order to have proper LSB/USB, we must exchange low and high and reverse their sign?
*/
class rx_filter : public gr_hier_block2
{
public:
rx_filter(double sample_rate=96000.0, double center=0.0, double low=-5000.0, double high=5000.0, double trans_width=1000.0); // FIXME: should be private
~rx_filter();
void set_offset(double center);
void set_low(double low);
void set_high(double high);
void set_trans_width(double trans_width);
void set_param(double low, double high);
void set_param(double low, double high, double trans_width);
void set_param(double center, double low, double high, double trans_width);
private:
std::vector<gr_complex> d_taps;
gr_freq_xlating_fir_filter_ccc_sptr d_bpf;
double d_sample_rate;
double d_center;
double d_low;
double d_high;
double d_trans_width;
};
#endif // RX_FILTER_H